Menemukan semua kemungkinan lokasi yang cocok dengan lokasi yang ditentukan. Operasi ini hanya valid jika lokasi belum diverifikasi.
Permintaan HTTP
POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:findMatches
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
Parameter | |
---|---|
name |
Nama resource lokasi yang kecocokannya akan ditemukan. |
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON | |
---|---|
{ "languageCode": string, "numResults": integer, "maxCacheDuration": string } |
Kolom | |
---|---|
languageCode |
Bahasa pilihan untuk lokasi yang cocok (dalam format BCP-47). |
numResults |
Jumlah kecocokan untuk ditampilkan. Nilai defaultnya adalah 3, dengan maksimum 10. Perlu diketahui bahwa latensi dapat meningkat jika permintaan lebih banyak. Tidak ada penomoran halaman. |
maxCacheDuration |
Tidak digunakan lagi. Kolom ini diabaikan untuk semua permintaan. Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan ' |
Isi respons
Jika berhasil, isi respons memuat data dengan struktur berikut:
Pesan respons untuk locations.FindMatchingLocations.
Representasi JSON | |
---|---|
{
"matchedLocations": [
{
object ( |
Kolom | |
---|---|
matchedLocations[] |
Kumpulan lokasi yang berpotensi cocok dengan lokasi yang ditentukan, yang tercantum dalam urutan dari yang paling cocok hingga yang paling tidak cocok. Jika ada kecocokan persis, maka akan ada di posisi pertama. |
matchTime |
Saat algoritma pencocokan terakhir kali dijalankan untuk lokasi ini. Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: |
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.
MatchedLocation
Merepresentasikan kemungkinan kecocokan dengan lokasi.
Representasi JSON | |
---|---|
{
"location": {
object ( |
Kolom | |
---|---|
location |
Lokasi yang sedikit penduduknya yang berpotensi cocok. Kolom yang tidak diisi mencakup, tetapi tidak terbatas pada: nama (lokasi yang cocok tidak dapat diambil melalui |
isExactMatch |
Apakah ini pencocokan persis? |