Method: accounts.locations.list

Menampilkan daftar lokasi untuk akun yang ditentukan.

Permintaan HTTP

GET https://mybusinessbusinessinformation.googleapis.com/v1/{parent=accounts/*}/locations

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama akun tempat mengambil lokasi. Jika orang tua [Account] [google.mybusiness.accountmanagement.v1.Account] berasal dari [AccountType] [google.mybusiness.accountmanagement.v1.Account.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

Opsional. Berapa banyak lokasi yang akan diambil per halaman. Nilai defaultnya adalah 10 jika tidak ditetapkan. Ukuran halaman minimum adalah 1, dan maksimum 100.
pageToken

string

Opsional. 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

Opsional. 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.
orderBy

string

Opsional. 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 title dan storeCode. Misalnya: "judul, storeCode desc" atau "title" atau "storeCode desc"
readMask

string (FieldMask format)

Wajib. Baca mask untuk menentukan kolom yang akan ditampilkan dalam respons.

Ini adalah daftar yang dipisahkan koma yang berisi nama kolom yang sepenuhnya memenuhi syarat. Contoh: "user.displayName,photo".

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,
  "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. Kolom ini hanya akan ditampilkan jika filter digunakan sebagai parameter kueri.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.