/api/v4/connected-accounts/{connectedAccountId}/connection-suggestionsTampilkan daftar saran koneksi
Mengembalikan saran kecocokan antara lokasi Listings API dan profil bisnis Google Business Profile atau Facebook untuk akun yang terhubung.
Parameter
Path
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| connectedAccountId | string | wajib | UUID of the connected account to list suggestions for. |
Query
| Nama | Tipe | Wajib | Deskripsi | Default |
|---|---|---|---|---|
| page | integer | opsional | 1-based page number. | 1 |
| perPage | integer | opsional | Records per page. | 20 |
Respons
200Paginated list of connection suggestions.
{ "data": { "connectionSuggestionsForAccount": { "pageInfo": { "hasNextPage": false, "hasPreviousPage": false, "totalPages": 1, "totalRecords": 2 }, "records": [ { "accountEmail": "contact@brightsmile-dental.com", "accountType": "GMB", "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5", "locationId": "73415", "matchedDataDatabaseId": "0d5e306f-0da0-46e3-929f-fd3c67ccd8cc", "locationInfo": { "name": "My Business", "city": "Lincoln", "stateIso": "NE" }, "suggestedLocationInfo": { "locationInfo": { "name": "My Business", "city": "Lincoln" } } } ] } }}401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.
Mengembalikan saran pasangan antara lokasi Listings API dan profil bisnis Google Business Profile atau Facebook yang terdeteksi dengan menjalankan pemicu pencocokan pada akun yang terhubung. Setiap rekaman menampilkan detail lokasi Listings API dan profil bisnis platform publikasi yang cocok agar operator dapat membandingkannya sebelum mengonfirmasi.
Saran dihasilkan secara asinkron oleh POST /connected-accounts/trigger-matches. Jika Anda baru saja menghubungkan akun, panggil trigger-matches terlebih dahulu; jika tidak, records akan kosong dan pageInfo.totalRecords bernilai 0. (Saat dijalankan secara langsung pada akun yang baru terhubung dan belum memiliki kecocokan, endpoint ini mengembalikan {"data":{"connectionSuggestionsForAccount":{"pageInfo":{"hasNextPage":false,"hasPreviousPage":false,"totalPages":0,"totalRecords":0},"records":[]}}}.) Contoh di atas menunjukkan struktur rekaman yang sudah terisi.
Kasus penggunaan: alur kerja ulasan sebelum konfirmasi. Setelah mengimpor akun Google klien, lakukan polling pada endpoint ini untuk menampilkan setiap saran kecocokan di antarmuka ulasan Anda sendiri. Operator menyetujui pasangan yang benar, lalu Anda meneruskan ID rekaman yang disetujui ke POST /connected-accounts/confirm-matches.
Mengidentifikasi rekaman. Rekaman saran tidak memiliki field id. Pengidentifikasinya adalah matchedDataDatabaseId, kunci utama dari rekaman kecocokan yang mendasarinya; accountType menunjukkan jenis rekaman kecocokan tersebut (GMB, FB, atau APPLE). Konfirmasi kecocokan memerlukan kedua nilai tersebut untuk membentuk id yang diterimanya, jadi simpan kedua nilai tersebut bersama-sama saat Anda menyiapkan saran untuk diulas.
Paginasi dan batas laju. Lakukan paginasi menggunakan parameter kueri page dan perPage yang tidak bersarang (misalnya ?page=2&perPage=50) dan pantau pageInfo.hasNextPage. Tidak ada parameter pageInfo, filters, sortBy, atau accountId: akun yang terhubung ditentukan dari path, pengurutan ditetapkan berdasarkan informasi lokasi secara menaik, dan parameter lain yang Anda kirim akan diabaikan, bukan ditolak. Endpoint ini memiliki batas laju seperti endpoint daftar lainnya; saat menerima 429, beri jeda dan coba lagi setelah waktu yang ditentukan oleh nilai header Retry-After, alih-alih memperpendek interval polling.
curl -X GET 'https://listingsapi.com/api/v4/connected-accounts/<connectedAccountId>/connection-suggestions' \ -H "Authorization: API $LISTINGSAPI_KEY"