Method: projects.locations.list

Mencantumkan informasi tentang lokasi yang didukung untuk layanan ini.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
name

string

Resource yang memiliki kumpulan lokasi, jika berlaku.

Parameter kueri

Parameter
filter

string

Filter untuk mempersempit hasil ke subset yang lebih disukai. Bahasa pemfilteran menerima string seperti "displayName=tokyo", dan didokumentasikan secara lebih mendetail di AIP-160.

pageSize

integer

Jumlah hasil maksimum yang akan ditampilkan. Jika tidak disetel, layanan akan memilih default.

pageToken

string

Token halaman yang diterima dari kolom nextPageToken dalam respons. Kirim token halaman tersebut untuk menerima halaman berikutnya.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Pesan respons untuk Locations.ListLocations.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
Kolom
locations[]

object (Location)

Daftar lokasi yang cocok dengan filter yang ditentukan dalam permintaan.

nextPageToken

string

Daftar standar token halaman berikutnya.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.