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 yang lokasinya akan diambil. Jika [Akun] [google.mybusiness.accountmanagement.v1.Account] induk adalah [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType] PERSONAL, hanya Lokasi yang secara langsung dimiliki oleh Akun yang ditampilkan, jika tidak, semua lokasi yang dapat diakses dari Akun akan ditampilkan, 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, metode ini akan mengambil page lokasi berikutnya. Token halaman ditampilkan oleh panggilan sebelumnya ke locations.list jika ada lebih banyak lokasi daripada yang dapat ditampung dalam ukuran halaman yang diminta.
filter

string

Opsional. Filter yang membatasi lokasi yang akan ditampilkan. Responsnya hanya menyertakan entri yang cocok dengan filter. Jika filter kosong, maka batasan akan diterapkan dan semua lokasi (dengan penomoran halaman) diambil untuk akun yang diminta.

Untuk informasi selengkapnya tentang kolom valid dan contoh penggunaan, lihat Menggunakan Panduan Data Lokasi.
orderBy

string

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

string (FieldMask format)

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

Ini adalah daftar yang dipisahkan koma yang berisi nama-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 ini:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.