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

Elenca le fonti delle recensioni per una sede

Restituisce le fonti delle recensioni configurate per una singola sede, con i relativi URL di connessione.

Richiede una chiave API. Consulta Autenticazione per il formato dell’header e la rotazione delle chiavi.

Parametri

Percorso

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

Risposte

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.

Restituisce le impostazioni delle fonti delle recensioni per una sede. Ogni voce in siteSettings è una piattaforma supportata dal piano dell'account. Un valore di url diverso da null indica che la piattaforma è connessa e che Listings API sta recuperando le recensioni da quell'URL; null url (come mostrato sopra per la sede attiva Jenny Home, a cui non sono ancora associate fonti di terze parti) indica che la piattaforma è disponibile ma non ancora configurata.

Caso d'uso: individuare le fonti per cui manca ancora un URL

Recupera questo elenco e filtra per url: null per creare la lista delle piattaforme che il proprietario di una sede deve ancora connettere. Le fonti delle recensioni vengono associate automaticamente una volta connessi i profili Google e Facebook della sede; connetti questi account per compilare gli URL mancanti:

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

Dopo la modifica, la stessa piattaforma viene restituita con il campo url compilato anziché impostato su null.

Caso d'uso: verificare le fonti connesse per un insieme di sedi

Scorri le tue sedi (ottenute da Elenca tutte le sedi) e chiama questo endpoint per ciascuna sede per produrre un report sulla copertura delle fonti delle recensioni. Poiché è necessaria una richiesta per sede, rispetta il limite di frequenza delle richieste dell'account, distribuisci le chiamate nel tempo e, in caso di 429, riprova dopo l'intervallo indicato nell'header Retry-After anziché inviare richieste a raffica.

Google e Facebook connessi tramite OAuth risultano automaticamente connessi e non possono essere sovrascritti tramite l'endpoint di modifica. Usa Elenca le fonti delle recensioni per un account, che opera a livello dell'intero account, per vedere l'insieme completo delle piattaforme che il piano potrebbe supportare.

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