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 Transcoding gRPC .

Parameter jalur

Parameter
name

string

Sumber daya yang memiliki kumpulan lokasi, jika ada.

Parameter kueri

Parameter
filter

string

Filter untuk mempersempit hasil ke subkumpulan pilihan. Bahasa pemfilteran menerima string seperti "displayName=tokyo" , dan didokumentasikan secara lebih rinci di AIP-160 .

pageSize

integer

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

pageToken

string

Token halaman diterima dari bidang nextPageToken dalam respons. Kirim token halaman itu untuk menerima halaman berikutnya.

Permintaan tubuh

Badan permintaan harus kosong.

Badan respons

Pesan respons untuk Locations.ListLocations .

Jika berhasil, isi respons berisi data dengan struktur berikut:

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

object ( Location )

Daftar lokasi yang cocok dengan filter yang ditentukan dalam permintaan.

nextPageToken

string

Token Daftar halaman berikutnya standar.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk informasi lebih lanjut, lihat Ikhtisar Otentikasi .