/api/v4/locations/reviews/settings/editModifier les paramètres des avis pour un établissement
Définit les sources d'avis surveillées pour un établissement et le seuil à partir duquel un avis est considéré comme positif.
Paramètres
Corps
Un champ imbriqué marqué comme obligatoire ne s’applique que si vous envoyez son parent. Si le parent est facultatif et que vous l’omettez, ses champs enfants obligatoires ne s’appliquent pas.
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
| locationId | string | obligatoire | 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 | facultatif | 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 | facultatif | Site key, as returned in `siteSettings[].name` (e.g. `maps.google.com`, `yelp.com`). |
| siteUrls[].url | string | facultatif | The location's page URL on that site. Send `null` or omit to stop monitoring a source that needs an explicit URL. |
| positiveInteractionThreshold | integer | facultatif | Star rating at or above which a review counts as positive. Sent on its own, it leaves the source selection untouched. |
Exemple de requête
Corps prêt à coller. Remplacez les identifiants et valeurs d’exemple par les vôtres.
{ "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "positiveInteractionThreshold": 4, "siteUrls": [ { "name": "maps.google.com", "url": null }, { "name": "yelp.com", "url": "https://www.yelp.com/biz/blue-bottle-coffee-oakland" } ]}Réponses
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`).
Met à jour les sources d'avis surveillées pour un établissement et la note à partir de laquelle un avis est considéré comme positif. Pour consulter ces mêmes paramètres, utilisez Répertorier les sources d'avis pour un établissement.
siteUrls effectue un remplacement, et non une mise à jour partielle. Le tableau que vous envoyez devient la sélection de sources de l'établissement. Pour ajouter une source, lisez d'abord la valeur actuelle de siteSettings et renvoyez les entrées existantes avec la nouvelle ; l'envoi d'un tableau contenant un seul élément supprime toutes les autres sources sans avertissement.
Les deux champs sont indépendants. Envoyez uniquement positiveInteractionThreshold pour modifier le seuil sans toucher aux sources, ou uniquement siteUrls pour modifier les sources sans toucher au seuil.
L'ajout d'une source programme une extraction de ses données ; les avis d'un site nouvellement ajouté arrivent donc de manière asynchrone, plutôt que dans cette réponse. Une source rejetée lors de la validation (une URL inaccessible ou une source non incluse dans l'abonnement du compte) est renvoyée dans errors sans modification du paramètre ; vérifiez donc errors même en cas de 200.
Cas d'utilisation : intégration de la page Yelp d'un établissement
Dès qu'un établissement est créé, ses sources Google et Facebook sont surveillées automatiquement, mais une page Yelp doit être indiquée explicitement. Lisez la sélection actuelle depuis la route des paramètres, ajoutez { "name": "yelp.com", "url": "<the location's Yelp URL>" }, puis renvoyez le tableau complet avec l'ID de l'établissement. L'extraction est immédiatement mise en file d'attente et les premiers avis Yelp apparaissent dans Répertorier les interactions une fois l'extraction terminée.
Ce point de terminaison modifie les paramètres de surveillance en vigueur. La requête et la réponse présentées ci-dessus sont des exemples.
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" } ] }'