GET/api/v4/locations/{locationId}/reviews/settings

Daftar sumber ulasan untuk suatu lokasi

Mengembalikan sumber ulasan yang dikonfigurasi untuk satu lokasi, beserta URL koneksinya.

Memerlukan kunci API. Lihat Autentikasi untuk format header dan rotasi kunci.

Parameter

Path

NamaTipeWajibDeskripsi
locationIdstringwajibLocation to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID.

Respons

200Review-source sites and their configured URLs for the location.
Response
{  "data": {    "interactionsSetting": {      "siteSettings": [        { "name": "maps.google.com", "url": null },        { "name": "facebook.com", "url": null },        { "name": "yelp.com", "url": null }      ]    }  }}
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

Mengembalikan pengaturan sumber ulasan untuk satu lokasi. Setiap entri dalam siteSettings adalah platform yang didukung oleh paket akun tersebut. Nilai url yang bukan null berarti platform tersebut terhubung dan Listings API sedang mengambil ulasan dari URL tersebut; null url (seperti yang ditunjukkan di atas untuk lokasi aktif Jenny Home, yang belum memiliki sumber pihak ketiga yang terhubung) berarti platform tersebut tersedia tetapi belum dikonfigurasi.

Kasus penggunaan: menemukan sumber yang masih memerlukan URL

Ambil daftar ini dan filter berdasarkan url: null untuk menyusun daftar platform yang masih perlu dihubungkan oleh pemilik lokasi. Sumber ulasan ditambahkan secara otomatis setelah profil Google dan Facebook lokasi tersebut terhubung; hubungkan akun-akun tersebut untuk mengisi URL yang belum tersedia:

JSON
{ "name": "yelp.com", "url": "https://www.yelp.com/biz/your-listing" }

Setelah pengeditan, platform yang sama dikembalikan dengan url yang telah terisi, bukan lagi null.

Kasus penggunaan: mengaudit sumber yang terhubung di seluruh kumpulan lokasi

Lakukan iterasi pada lokasi Anda (dari Daftar semua lokasi) dan panggil endpoint ini untuk setiap lokasi guna melaporkan cakupan sumber ulasan. Karena diperlukan satu permintaan per lokasi, patuhi batas laju permintaan akun, beri jeda antar-panggilan, dan saat menerima 429, coba lagi setelah waktu tunggu yang ditentukan dalam header Retry-After, alih-alih terus mengirim permintaan secara bertubi-tubi.

Google dan Facebook yang dihubungkan melalui OAuth secara otomatis ditampilkan sebagai terhubung dan tidak dapat ditimpa melalui endpoint pengeditan. Gunakan Daftar sumber ulasan untuk suatu akun yang mencakup seluruh akun untuk melihat semua platform yang dapat didukung oleh paket tersebut.

Request
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/reviews/settings' \  -H "Authorization: API $LISTINGSAPI_KEY"