Method: projects.sites.customDomains.list

指定された親 Hosting サイトに関連付けられている各 CustomDomain を一覧表示します。

ページ分割を容易にするために、一貫した未定義の CustomDomain を返します。

HTTP リクエスト

GET https://firebasehosting.googleapis.com/v1beta1/{parent=projects/*/sites/*}/customDomains

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。リストする CustomDomain エンティティを含む Firebase Hosting Site。

クエリ パラメータ

パラメータ
pageSize

integer

リクエストで返す CustomDomain エンティティの最大数。デフォルトは 10 です。
pageToken

string

前回の customDomains.list 呼び出しからのトークン。一覧表示の再開先をサーバーに指示します。
showDeleted

boolean

true の場合、リクエストは、まだ完全に削除されていない、削除済み（復元可能）の CustomDomain を返します。削除された CustomDomain を復元するには、customDomains.undelete リクエストを行います。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

customDomains.list からのレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "customDomains": [
    {
      object (CustomDomain)
    }
  ],
  "nextPageToken": string
}
フィールド
customDomains[]

object (CustomDomain)

指定された Firebase Site に関連付けられている CustomDomain エンティティのリスト。
nextPageToken

string

ページ設定トークン（このレスポンス以外に結果が存在する場合）。

このトークンを次の customDomains.list の呼び出しに含めます。ページトークンは有効期間が短いため、保存しないでください。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/firebase.hosting.readonly
  • https://www.googleapis.com/auth/firebase.hosting
  • https://www.googleapis.com/auth/firebase.readonly
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。