Method: projects.list

呼び出し元がアクセスできる各FirebaseProjectをリストします。

要素は特定の順序で返されませんが、 pageTokenを使用して追加のリクエストが行われたときに、プロジェクトの一貫したビューになります。

この方法は最終的にプロジェクトの変更と一致します。つまり、新しくプロビジョニングされたプロジェクトや既存のプロジェクトに対する最近の変更がプロジェクトのセットに反映されない可能性があります。リストにはアクティブなプロジェクトのみが含まれます。

一貫した読み取りと追加のプロジェクトの詳細には、 projects.get使用します。

HTTPリクエスト

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

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

クエリパラメータ

パラメーター
pageToken

string

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

pageSize

integer

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

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

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

showDeleted

boolean

オプション。 DELETED状態のプロジェクトを応答で返すかどうかを制御します。

指定しない場合は、 ACTIVEプロジェクトのみが返されます。

リクエストボディ

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

レスポンスボディ

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

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

object ( FirebaseProject )

呼び出し元がアクセスできるプロジェクトのリストの 1 ページ。

nextPageToken

string

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

このトークンは、プロジェクトの次のグループを見つけるために、 projects.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

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