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 Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
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

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

ProjectInfo

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 リソース ロケーションのいずれかです。

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