/api/v4/connected-accounts/connected-account-listingsAmbil profil bisnis dari akun yang terhubung
Mengembalikan profil bisnis Google Business Profile atau Facebook yang dapat diakses oleh akun yang terhubung, dengan pemfilteran dan paginasi opsional.
Parameter
Body
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| connectedAccountId | string | wajib | UUID of the connected account whose listings to fetch. Send this in the JSON body: as a query parameter it is ignored. |
| page | integer | opsional | Page number to fetch. Defaults to 1. |
| perPage | integer | opsional | Records per page. Defaults to 500, which is also the maximum. |
| locationInfo | string | opsional | Free-text search within the account's listings. Matches business name, address lines, locality, postal code, store code, and phone. |
Contoh permintaan
Body siap tempel. Ganti ID dan nilai placeholder dengan milik Anda.
{ "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5", "perPage": 50}Respons
200List of listings accessible to the account, with pagination metadata.
{ "data": { "connectedAccountListings": { "pageInfo": { "hasNextPage": false, "hasPreviousPage": false, "totalPages": 1, "totalRecords": 60 }, "records": [ { "accountTypeName": "Google", "address": "123 William St, NY 10038, Manhattan, US", "id": "R21iQnVsa0RhdGFMYWtlOjA2MDQ4NmExLTA0NzQtNDc4NS1iMjNhLTBkOGM4MzhmNGQ5OA==", "liveLink": null, "locationName": "Trial", "phone": "(718) 667-7787" } ] } }}401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.
Mengembalikan profil bisnis Google Business Profile atau Facebook yang dapat diakses oleh akun yang terhubung. Setiap rekaman mencakup id profil bisnis (ID base64), locationName, address, phone, dan liveLink. Meskipun menggunakan POST, operasi ini merupakan operasi baca, tetapi opsi akun dan paginasi harus dikirim dalam badan JSON.
Kasus penggunaan: buat pemilih profil bisnis. Setelah pelanggan menghubungkan akun Google yang memiliki puluhan profil bisnis, panggil operasi ini untuk menampilkan daftar yang dapat ditelusuri. Masukkan istilah pencarian yang diketik pelanggan ke dalam locationInfo (pencocokan dilakukan dalam nama, alamat, nomor telepon, kode pos, dan kode toko) agar mereka dapat menemukan toko yang tepat dengan cepat.
Kasus penggunaan: sediakan masukan untuk connect-listing. id pada setiap rekaman sama persis dengan connectedAccountListingId yang diharapkan oleh connect-listing. Ambil profil bisnis, biarkan pelanggan (atau logika pencocokan Anda) memilih salah satunya, lalu teruskan id profil bisnis tersebut beserta locationId Listings API tujuan ke connect-listing untuk menautkan keduanya.
Lakukan paginasi dengan kunci page dan perPage langsung di dalam badan; nilai default perPage adalah 500, yang juga merupakan nilai maksimum. Baca pageInfo.hasNextPage dan pageInfo.totalPages dari respons untuk menelusuri seluruh kumpulan hasil halaman demi halaman. Endpoint ini diperhitungkan dalam batas laju permintaan akun; respons 429 menyertakan header Retry-After.
Struktur permintaan di atas telah diverifikasi terhadap API yang aktif. Contoh respons hanya bersifat ilustratif.
curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/connected-account-listings' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5", "perPage": 50 }'