Method: projects.availableLocations.list

指定されたプロジェクトの有効な Google Cloud Platform（GCP）リソース ロケーションを一覧表示します（FirebaseProject を含む）。

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

この呼び出しは、指定されたプロジェクトに考えられるロケーション制限をチェックするため、考えられるすべての GCP リソース ロケーションのサブセットを返すことがあります。制限に関係なく、すべての GCP リソース ロケーションを一覧表示するには、一意のプロジェクト ID（/v1beta1/{parent=projects/-}/listAvailableLocations）を指定せずにエンドポイントを呼び出します。

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

GCP リソースのロケーションを一覧表示する FirebaseProject。次の形式で指定します。

projects/PROJECT_IDENTIFIER

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

一意のプロジェクト ID（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 リソース ロケーションの一つになります。
type

enum (LocationType)

GCP リソース ロケーションが、データ レプリケーション用のリージョン ロケーションまたはマルチリージョン ロケーションのどちらであるかを示します。
features[]

enum (LocationFeature)

GCP リソース ロケーションで利用可能なプロダクトとサービス。

LocationType

GCP リソース ロケーション内でデータを複製する方法を指定します。GCP リソース ロケーションのタイプについて学習する。

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

ロケーションはリージョン ロケーションです。

リージョン ロケーションのデータは、リージョン内の複数のゾーンに複製されます。
MULTI_REGIONAL

ロケーションがマルチリージョン ロケーションである。

マルチリージョン ロケーションのデータは、複数のリージョンに複製されます。各リージョン内では、データは複数のゾーンに複製されます。

LocationFeature

GCP リソース ロケーションで利用可能なプロダクトとサービス。

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

このロケーションは、Cloud Firestore データベース インスタンスをサポートしています。

App Engine はこのロケーションで使用できるため、プロジェクトのデフォルトの GCP リソース ロケーションにすることができます。
DEFAULT_STORAGE

このロケーションは、デフォルトの Cloud Storage バケットをサポートしています。

App Engine はこのロケーションで使用できるため、プロジェクトのデフォルトの GCP リソース ロケーションにすることができます。
FUNCTIONS Cloud Functions for Firebase はこのロケーションで使用できます。