Method: accounts.locations.list

Mencantumkan lokasi untuk akun yang ditentukan.

Permintaan HTTP

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

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama akun yang akan diambil lokasinya.

  • ID Akun Tertentu: Jika akun berjenis AccountType.PERSONAL, respons hanya akan menampilkan lokasi yang dimiliki langsung oleh akun tersebut. Untuk semua jenis lainnya (misalnya, AccountType.LOCATION_GROUP), metode ini akan menampilkan semua lokasi yang dapat diakses.

  • Karakter pengganti (-): Menggunakan accounts/- akan mengidentifikasi pengguna yang diautentikasi. Cakupan ini ditetapkan secara default ke AccountType.PERSONAL, tetapi mencakup lokasi yang dimiliki secara langsung dan tidak langsung (misalnya, yang dapat diakses melalui grup anggota).

Parameter kueri

Parameter
pageSize

integer

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

string

Opsional. Jika ditentukan, parameter ini akan mengambil page lokasi berikutnya. Token halaman ditampilkan oleh panggilan sebelumnya ke locations.list jika ada lebih banyak lokasi daripada yang dapat dimuat 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, batasan akan diterapkan dan semua lokasi (diberi nomor halaman) akan diambil untuk akun yang diminta.

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

string

Opsional. Urutan pengurutan untuk permintaan. Beberapa kolom harus dipisahkan koma, sesuai dengan sintaksis SQL. Urutan pengurutan default 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. Masker baca untuk menentukan kolom yang akan ditampilkan dalam respons.

Ini adalah daftar dipisahkan koma yang berisi nama-nama kolom yang sepenuhnya valid. 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 akan diisi dengan token untuk mengambil halaman lokasi berikutnya pada panggilan berikutnya ke locations.list. Jika tidak ada lokasi lain, 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 mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.