/api/v4/locations/reviews/settings/editEditar la configuración de reseñas de una ubicación
Establece las fuentes de reseñas que se supervisan para una ubicación y su umbral de reseñas positivas.
Parámetros
Cuerpo
Un campo anidado marcado como obligatorio solo se aplica cuando envías su campo principal. Si el campo principal es opcional y lo omites, sus campos hijos obligatorios no se aplican.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| locationId | string | obligatorio | 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 | opcional | 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 | opcional | Site key, as returned in `siteSettings[].name` (e.g. `maps.google.com`, `yelp.com`). |
| siteUrls[].url | string | opcional | The location's page URL on that site. Send `null` or omit to stop monitoring a source that needs an explicit URL. |
| positiveInteractionThreshold | integer | opcional | Star rating at or above which a review counts as positive. Sent on its own, it leaves the source selection untouched. |
Solicitud de ejemplo
Cuerpo listo para pegar. Sustituye los ID y valores de ejemplo por los tuyos.
{ "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "positiveInteractionThreshold": 4, "siteUrls": [ { "name": "maps.google.com", "url": null }, { "name": "yelp.com", "url": "https://www.yelp.com/biz/blue-bottle-coffee-oakland" } ]}Respuestas
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`).
Actualiza las fuentes de reseñas que se supervisan para una ubicación y la puntuación que se considera una reseña positiva. Para consultar estos mismos ajustes, usa Listar las fuentes de reseñas de una ubicación.
siteUrls es un reemplazo, no una actualización parcial. El array que envías pasa a ser la selección de fuentes de la ubicación. Para añadir una fuente, lee primero el siteSettings actual y vuelve a enviar las entradas existentes junto con la nueva; enviar un array de un solo elemento elimina todas las demás fuentes sin avisar.
Los dos campos son independientes. Envía solo positiveInteractionThreshold para cambiar el umbral sin modificar las fuentes, o solo siteUrls para cambiar las fuentes sin modificar el umbral.
Añadir una fuente programa un rastreo de esa fuente, por lo que las reseñas de un sitio recién añadido llegan de forma asíncrona y no en esta respuesta. Una fuente rechazada por la validación (una URL inaccesible o una fuente que el plan de la cuenta no incluye) se devuelve en errors sin que se modifique la configuración, así que comprueba errors incluso si recibes un 200.
Caso de uso: incorporar la página de Yelp de una ubicación
Justo después de crear una ubicación, sus fuentes de Google y Facebook se supervisan automáticamente, pero hay que especificar explícitamente una página de Yelp. Lee la selección actual desde la ruta de configuración, añade { "name": "yelp.com", "url": "<the location's Yelp URL>" } y vuelve a enviar el array completo con el ID de la ubicación. El rastreo se pone en cola inmediatamente y las primeras reseñas de Yelp aparecen en Listar interacciones una vez que se completa.
Este endpoint modifica la configuración de supervisión activa. La solicitud y la respuesta de muestra anteriores son ejemplos.
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" } ] }'