Method: accounts.locations.list

Menampilkan daftar lokasi untuk akun yang ditentukan.

Permintaan HTTP

GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/locations

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Nama akun tempat mengambil lokasi. Jika Account adalah AccountType PERSONAL, hanya Lokasi yang dimiliki secara langsung oleh Akun yang ditampilkan. Jika tidak, kolom ini akan menampilkan semua lokasi yang dapat diakses dari Akun, baik secara langsung maupun tidak langsung.

Parameter kueri

Parameter
pageSize

integer

Berapa banyak lokasi yang akan diambil per halaman. Ukuran halaman default adalah 100, minimum 1, dan maksimum 100.
pageToken

string

Jika ditentukan, fungsi ini mengambil page lokasi berikutnya. Token halaman ditampilkan oleh panggilan sebelumnya ke locations.list jika lokasi lebih banyak daripada yang bisa ditampung dalam ukuran halaman yang diminta.
filter

string

Filter yang membatasi lokasi yang akan ditampilkan. Respons hanya menyertakan entri yang cocok dengan filter. Jika filter kosong, berarti batasan diterapkan dan semua lokasi (bernomor halaman) diambil untuk akun yang diminta.

Untuk informasi lebih lanjut tentang kolom yang valid dan contoh penggunaan, lihat Menggunakan Panduan Data Lokasi.
languageCode
(deprecated)

string

Kode bahasa BCP 47 untuk mendapatkan properti lokasi tampilan. Jika bahasa ini tidak tersedia, lokasi akan diberikan dalam bahasa lokasi. Jika keduanya tidak tersedia, keduanya akan diberikan dalam bahasa Inggris.

Tidak digunakan lagi. Setelah 15 Agustus 2020, kolom ini tidak akan diterapkan lagi. Sebagai gantinya, bahasa lokasi akan selalu digunakan.
orderBy

string

Urutan penyortiran untuk permintaan. Beberapa {i>field<i} harus dipisahkan koma, sesuai dengan sintaks SQL. Tata urutan default adalah menaik. Untuk menentukan urutan menurun, akhiran " {i>desc"<i} harus ditambahkan. Kolom yang valid untuk orderBy adalah locationName dan storeCode. Misalnya: "locationName, storeCode desc" atau "locationName" atau "storeCode desc"

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Pesan respons untuk Locations.ListLocations.

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

object (Location)

Lokasi.
nextPageToken

string

Jika jumlah lokasi melebihi ukuran halaman yang diminta, kolom ini diisi dengan token untuk mengambil halaman lokasi berikutnya pada panggilan selanjutnya ke locations.list. Jika tidak ada lagi lokasi, kolom ini tidak ada dalam respons.
totalSize

integer

Perkiraan jumlah Lokasi dalam daftar terlepas dari penomoran halaman.

Cakupan Otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.