Method: projects.locations.list

このサービスでサポートされているロケーションに関する情報をリストします。

HTTP リクエスト

GET https://firestore.googleapis.com/v1/{name=projects/*}/locations

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

パスパラメータ

パラメータ
name

string

ロケーションのコレクションを所有するリソース（該当する場合）。

クエリ パラメータ

パラメータ
filter

string

結果を絞り込んで、目的のサブセットに限定するフィルタ。フィルタリング言語は "displayName=tokyo" のような文字列を受け入れます。詳細については AIP-160 をご覧ください。
pageSize

integer

返される結果の最大件数です。設定されていない場合、サービスはデフォルトを選択します。
pageToken

string

レスポンスの nextPageToken フィールドから受け取ったページトークン。そのページトークンを送信して、後続のページを受け取ります。

リクエストの本文

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

レスポンスの本文

Locations.ListLocations に対するレスポンス メッセージ。

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

JSON 表現 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
フィールド
locations[]

object (Location)

リクエストで指定したフィルタに一致するロケーションのリスト。
nextPageToken

string

標準的なリストの次ページのトークン。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

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