Method: availableProjects.list

Firebase リソースを追加できる各Google Cloud Platform (GCP) Projectリストします。

プロジェクトは、次の場合にのみリストされます。

  • 呼び出し元には、 projects.addFirebaseを呼び出すための十分なGoogle IAM権限があります。
  • プロジェクトはまだFirebaseProjectではありません。
  • プロジェクトは、Firebase リソースの追加を禁止するポリシーを持つ組織に属していません。

HTTPリクエスト

GET https://firebase.googleapis.com/v1beta1/availableProjects

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

クエリパラメータ

パラメーター
pageToken

string

availableProjects.listへの以前の呼び出しから返されたトークン。プロジェクト セット内のどこでリストを再開するかを示します。

pageSize

integer

応答で返されるプロジェクトの最大数。

サーバーはその裁量により、この値よりも少ない値を返す場合があります。値が指定されていない場合 (または大きすぎる値が指定されている場合)、サーバーは独自の制限を課します。

この値を負にすることはできません。

リクエストボディ

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

レスポンスボディ

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

JSON表現
{
  "projectInfo": [
    {
      object (ProjectInfo)
    }
  ],
  "nextPageToken": string
}
田畑
projectInfo[]

object ( ProjectInfo )

Firebase リソースを追加できる GCP Projectsのリスト。

nextPageToken

string

結果リストが大きすぎて 1 つの応答に収まらない場合は、トークンが返されます。文字列が空の場合、この応答は結果の最後のページになります。

このトークンは、その後のavailableProjects.listの呼び出しで使用して、プロジェクトの次のグループを検索できます。

ページ トークンの有効期間は短いため、永続化しないでください。

認可の範囲

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

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

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

プロジェクト情報

Google Cloud Platform (GCP) Projectへの参照。

JSON表現
{
  "project": string,
  "displayName": string,
  "locationId": string
}
田畑
project

string

Firebase リソースを追加できる GCP Projectのリソース名。次の形式です。

projects/ PROJECT_IDENTIFIER

PROJECT_IDENTIFIER値の詳細については、 FirebaseProject nameフィールドを参照してください。

displayName

string

ユーザーが割り当てた GCP Projectの表示名 (例: My App

locationId

string

プロジェクトのデフォルトの GCP リソースの場所の ID。この場所は、利用可能なGCP リソースの場所の 1 つです。

すべてのプロジェクトにこのフィールドが入力されるわけではありません。値が設定されていない場合は、プロジェクトにデフォルトの GCP リソースの場所がまだないことを意味します。プロジェクトのデフォルトの GCP リソースの場所を設定するには、Firebase リソースをプロジェクトに追加した後、 defaultLocation.finalizeを呼び出します。