Method: projects.availableLocations.list

指定されたプロジェクト ( FirebaseProjectを含む) の有効な Google Cloud Platform (GCP) リソースの場所を一覧表示します。

これらの場所の 1 つをプロジェクトのデフォルトのGCP リソースの場所として選択できます。これは、Cloud Firestore などのプロジェクトのリソースがデフォルトでプロビジョニングされる地理的な場所です。ただし、デフォルトの GCP リソースの場所がプロジェクトにすでに設定されている場合、この設定は変更できません。

この呼び出しでは、指定されたプロジェクトで考えられる場所の制限がチェックされるため、考えられるすべての GCP リソースの場所のサブセットが返される可能性があります。すべての GCP リソースの場所を (制限に関係なく) 一覧表示するには、一意のプロジェクト識別子 (つまり、 /v1beta1/{parent=projects/-}/listAvailableLocations ) を指定せずにエンドポイントを呼び出します。

指定したプロジェクトでavailableLocations.listを呼び出すには、メンバーは少なくともプロジェクトの閲覧者である必要があります。プロジェクトを指定しない呼び出しには、特定のプロジェクト権限は必要ありません。

HTTPリクエスト

GET https://firebase.googleapis.com/v1beta1/{parent=projects/*}/availableLocations

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

パスパラメータ

パラメーター
parent

string

GCP リソースの場所をリストするFirebaseProject (次の形式)。

projects/ PROJECT_IDENTIFIER

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

一意のプロジェクト識別子が指定されていない場合 (つまり、 projects/- )、返されるリストには組織固有またはプロジェクト固有の場所制限が考慮されません。

クエリパラメータ

パラメーター
pageToken

string

availableLocations.listへの前回の呼び出しから返されたトークンで、場所のリスト内のどこからリストを再開するかを示します。

pageSize

integer

応答で返される場所の最大数。

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

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

リクエストボディ

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

レスポンスボディ

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

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

object ( Location )

availableLocations.listの呼び出しからの結果の 1 ページ。

nextPageToken

string

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

このトークンは、その後のavailableLocations.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

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

位置

FirebaseProjectに対して選択できる GCP リソースの場所。

JSON表現
{
  "locationId": string,
  "type": enum (LocationType),
  "features": [
    enum (LocationFeature)
  ]
}
田畑
locationId

string

GCP リソースの場所の ID。これは、利用可能なGCP リソースの場所の 1 つになります。

type

enum ( LocationType )

GCP リソースの場所がデータ レプリケーションのリージョン ロケーションであるかマルチリージョン ロケーションであるかを示します。

features[]

enum ( LocationFeature )

GCP リソースの場所で利用できる製品とサービス。

場所の種類

GCP リソースの場所内でデータをレプリケートする方法を指定します。 GCP リソースの場所の種類について詳しくは、こちらをご覧ください。

列挙型
LOCATION_TYPE_UNSPECIFIED未設定の値を区別するために内部で使用され、外部での使用を目的としていません。
REGIONAL

場所は地方の場所です。

リージョン内のデータは、リージョン内の複数のゾーンにレプリケートされます。

MULTI_REGIONAL

場所は複数地域にまたがる場所です。

マルチリージョンの場所にあるデータは、複数のリージョンにレプリケートされます。各リージョン内で、データは複数のゾーンにレプリケートされます。

場所の特徴

GCP リソースの場所で利用できる製品とサービス。

列挙型
LOCATION_FEATURE_UNSPECIFIED未設定の値を区別するために内部で使用され、外部での使用を目的としていません。
FIRESTORE

この場所は Cloud Firestore データベース インスタンスをサポートします。

App Engine はこの場所で利用できるため、プロジェクトのデフォルトの GCP リソースの場所にすることができます。

DEFAULT_STORAGE

この場所は、デフォルトの Cloud Storage バケットをサポートします。

App Engine はこの場所で利用できるため、プロジェクトのデフォルトの GCP リソースの場所にすることができます。

FUNCTIONS Cloud Functions for Firebase はこの場所で利用できます。