Method: projects.sites.customDomains.list

指定された親ホスティング サイトに関連付けられた各CustomDomainを一覧表示します。

ページネーションを容易にするために、一貫した、ただし未定義の順序でCustomDomainを返します。

HTTPリクエスト

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

URL はgRPC トランスコーディング構文を使用します。

パスパラメータ

パラメーター
parent

string

必須。リストするCustomDomainエンティティを含む Firebase ホスティング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

詳細については、 「認証の概要」を参照してください。