Method: projects.list

呼び出し元がアクセスできる各 FirebaseProject を一覧表示します。

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

このメソッドは結局のところ、プロジェクトのミューテーションと一致します。つまり、新しくプロビジョニングされたプロジェクトや、既存のプロジェクトに最近加えられた変更は、プロジェクトのセットに反映されない場合があります。このリストには、アクティブなプロジェクトのみが含まれます。

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

HTTP リクエスト

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

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

クエリ パラメータ

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

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