/api/v4/locations/reviews/settings/editEdit pengaturan ulasan untuk suatu lokasi
Menetapkan sumber ulasan yang dipantau untuk suatu lokasi dan ambang batas ulasan positifnya.
Parameter
Body
Field bersarang yang ditandai wajib hanya berlaku jika Anda mengirim induknya. Jika induknya opsional dan Anda menghilangkannya, field turunan yang wajib tidak berlaku.
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| locationId | string | wajib | Location to update, as its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`). This is a body field, so unlike path parameters a raw numeric ID is not converted and fails with `SY90002: Invalid Id`. |
| siteUrls | array | opsional | The complete set of review sources for the location. This REPLACES the current selection, so send every source you want kept, not just the additions. |
| siteUrls[].name | string | opsional | Site key, as returned in `siteSettings[].name` (e.g. `maps.google.com`, `yelp.com`). |
| siteUrls[].url | string | opsional | The location's page URL on that site. Send `null` or omit to stop monitoring a source that needs an explicit URL. |
| positiveInteractionThreshold | integer | opsional | Star rating at or above which a review counts as positive. Sent on its own, it leaves the source selection untouched. |
Contoh permintaan
Body siap tempel. Ganti ID dan nilai placeholder dengan milik Anda.
{ "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "positiveInteractionThreshold": 4, "siteUrls": [ { "name": "maps.google.com", "url": null }, { "name": "yelp.com", "url": "https://www.yelp.com/biz/blue-bottle-coffee-oakland" } ]}Respons
200Settings applied. `data.editInteractionsSetting.interactionSetting` returns the stored settings; `errors` is `null` on success.
{ "data": { "editInteractionsSetting": { "errors": null, "interactionSetting": { "id": "1800289", "locationId": "1800289", "positiveInteractionThreshold": 4, "siteSettings": [ { "name": "maps.google.com", "url": null, "monitored": true, "canRespond": true }, { "name": "yelp.com", "url": "https://www.yelp.com/biz/blue-bottle-coffee-oakland", "monitored": true, "canRespond": false } ] } } }}401Unauthenticated, missing or invalid API key.
403The key is valid but not permitted to change review settings for this location (`SY90003`).
Memperbarui sumber ulasan yang dipantau untuk suatu lokasi dan nilai yang dianggap sebagai ulasan positif. Untuk membaca pengaturan yang sama, gunakan Daftar sumber ulasan untuk suatu lokasi.
siteUrls menggantikan seluruh pilihan, bukan memperbarui sebagian. Array yang Anda kirim menjadi pilihan sumber untuk lokasi tersebut. Untuk menambahkan satu sumber, baca siteSettings saat ini terlebih dahulu dan kirim kembali entri yang sudah ada beserta entri baru; mengirim array dengan satu elemen akan menghapus semua sumber lainnya tanpa pemberitahuan.
Kedua field tersebut tidak saling bergantung. Kirim hanya positiveInteractionThreshold untuk mengubah ambang batas tanpa mengubah sumber, atau hanya siteUrls untuk mengubah sumber tanpa mengubah ambang batas.
Menambahkan sumber akan menjadwalkan pengambilan data untuk sumber tersebut, sehingga ulasan dari situs yang baru ditambahkan akan diterima secara asinkron, bukan dalam respons ini. Sumber yang ditolak oleh validasi (URL yang tidak dapat diakses atau sumber yang tidak tercakup dalam paket akun) dikembalikan dalam errors tanpa perubahan pada pengaturan, jadi periksa errors bahkan pada 200.
Contoh penggunaan: menyiapkan halaman Yelp suatu lokasi
Segera setelah lokasi dibuat, sumber Google dan Facebook-nya dipantau secara otomatis, tetapi halaman Yelp harus ditentukan secara eksplisit. Baca pilihan saat ini dari rute pengaturan, tambahkan { "name": "yelp.com", "url": "<the location's Yelp URL>" }, lalu kirim kembali seluruh array beserta ID lokasi tersebut. Pengambilan data langsung dimasukkan ke antrean, dan ulasan Yelp pertama muncul di Daftar interaksi setelah pengambilan data selesai.
Endpoint ini mengubah pengaturan pemantauan yang aktif. Permintaan dan respons contoh di atas merupakan contoh.
curl -X POST 'https://listingsapi.com/api/v4/locations/reviews/settings/edit' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "positiveInteractionThreshold": 4, "siteUrls": [ { "name": "maps.google.com", "url": null }, { "name": "yelp.com", "url": "https://www.yelp.com/biz/blue-bottle-coffee-oakland" } ] }'