/api/v4/locations/reviews/settings/editModifica le impostazioni delle recensioni per una sede
Imposta le fonti di recensioni monitorate per una sede e la relativa soglia per le recensioni positive.
Parametri
Corpo
Un campo annidato contrassegnato come obbligatorio si applica solo quando invii il campo padre. Se il padre è facoltativo e lo ometti, i suoi campi figli obbligatori non si applicano.
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| locationId | string | obbligatorio | 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 | facoltativo | 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 | facoltativo | Site key, as returned in `siteSettings[].name` (e.g. `maps.google.com`, `yelp.com`). |
| siteUrls[].url | string | facoltativo | The location's page URL on that site. Send `null` or omit to stop monitoring a source that needs an explicit URL. |
| positiveInteractionThreshold | integer | facoltativo | Star rating at or above which a review counts as positive. Sent on its own, it leaves the source selection untouched. |
Richiesta di esempio
Corpo pronto da incollare. Sostituisci gli ID e i valori segnaposto con i tuoi.
{ "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "positiveInteractionThreshold": 4, "siteUrls": [ { "name": "maps.google.com", "url": null }, { "name": "yelp.com", "url": "https://www.yelp.com/biz/blue-bottle-coffee-oakland" } ]}Risposte
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`).
Aggiorna le fonti di recensioni monitorate per una sede e la valutazione che fa considerare positiva una recensione. Per leggere le stesse impostazioni, consulta Elenca le fonti di recensioni per una sede.
siteUrls è una sostituzione, non una modifica parziale. L'array che invii diventa la selezione delle fonti della sede. Per aggiungere una fonte, leggi prima il valore attuale di siteSettings e invia nuovamente le voci esistenti insieme a quella nuova; l'invio di un array con un solo elemento elimina tutte le altre fonti senza alcun avviso.
I due campi sono indipendenti. Invia solo positiveInteractionThreshold per modificare la soglia senza toccare le fonti, oppure solo siteUrls per modificare le fonti senza toccare la soglia.
L'aggiunta di una fonte pianifica un'operazione di scraping per quella fonte, quindi le recensioni di un sito appena aggiunto arrivano in modo asincrono anziché in questa risposta. Una fonte rifiutata dalla validazione (un URL non raggiungibile o una fonte non inclusa nel piano dell'account) viene restituita in errors lasciando invariata l'impostazione, quindi controlla errors anche in caso di 200.
Caso d'uso: configurazione della pagina Yelp di una sede
Subito dopo la creazione di una sede, le sue fonti Google e Facebook vengono monitorate automaticamente, ma una pagina Yelp deve essere indicata esplicitamente. Leggi la selezione attuale dall'endpoint delle impostazioni, aggiungi { "name": "yelp.com", "url": "<the location's Yelp URL>" } in fondo e invia nuovamente l'intero array con l'ID della sede. L'operazione di scraping viene messa in coda immediatamente e le prime recensioni Yelp compaiono in Elenca le interazioni una volta completata.
Questo endpoint modifica le impostazioni effettive di monitoraggio. La richiesta e la risposta di esempio riportate sopra sono esempi.
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" } ] }'