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 |
Wajib diisi. 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 |
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 |
Opsional. Jika ditentukan, fungsi ini mengambil |
filter |
Opsional. Filter yang membatasi lokasi yang akan ditampilkan. Respons hanya menyertakan entri yang cocok dengan filter. Jika Untuk informasi lebih lanjut tentang kolom yang valid dan contoh penggunaan, lihat Menggunakan Panduan Data Lokasi. |
orderBy |
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 |
Wajib diisi. 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: |
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 ( |
Kolom | |
---|---|
locations[] |
Lokasi. |
nextPageToken |
Jika jumlah lokasi melebihi ukuran halaman yang diminta, kolom ini diisi dengan token untuk mengambil halaman lokasi berikutnya pada panggilan selanjutnya ke |
totalSize |
Perkiraan jumlah Lokasi dalam daftar terlepas dari penomoran halaman. Kolom ini hanya akan ditampilkan jika |
Cakupan otorisasi
Memerlukan cakupan OAuth berikut:
https://www.googleapis.com/auth/business.manage
Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.