/api/v4/locations/{locationId}/reviews/settingsBewertungsquellen für einen Standort auflisten
Gibt die für einen einzelnen Standort konfigurierten Bewertungsquellen mit ihren Verbindungs-URLs zurück.
Parameter
Pfad
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| locationId | string | erforderlich | Location to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID. |
Antworten
200Review-source sites and their configured URLs for the location.
{ "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.
Gibt die Einstellungen der Bewertungsquellen für einen Standort zurück. Jeder Eintrag in siteSettings ist eine Plattform, die vom Tarif des Kontos unterstützt wird. Ein Wert ungleich null für url bedeutet, dass diese Plattform verbunden ist und Listings API Bewertungen von dieser URL abruft; null url (wie oben für den produktiven Standort Jenny Home gezeigt, mit dem noch keine Drittanbieterquellen verknüpft sind) bedeutet, dass die Plattform verfügbar, aber noch nicht konfiguriert ist.
Anwendungsfall: Quellen ermitteln, für die noch eine URL fehlt
Rufen Sie diese Liste ab und filtern Sie nach url: null, um eine Aufgabenliste der Plattformen zu erstellen, die ein Standortinhaber noch verbinden muss. Bewertungsquellen werden automatisch verknüpft, sobald die Google- und Facebook-Profile des Standorts verbunden sind; verbinden Sie diese Konten, um die fehlenden URLs einzutragen:
{ "name": "yelp.com", "url": "https://www.yelp.com/biz/your-listing" }Nach der Bearbeitung wird dieselbe Plattform mit einem ausgefüllten url anstelle von null zurückgegeben.
Anwendungsfall: verbundene Quellen über einen Standortbestand hinweg prüfen
Durchlaufen Sie Ihre Standorte (aus Alle Standorte auflisten) und rufen Sie diesen Endpunkt für jeden Standort auf, um einen Bericht zur Abdeckung durch Bewertungsquellen zu erstellen. Da pro Standort eine Anfrage erforderlich ist, beachten Sie das Anfragelimit des Kontos, verteilen Sie die Aufrufe zeitlich und wiederholen Sie bei 429 die Anfrage erst nach der im Header Retry-After angegebenen Wartezeit, statt fortlaufend weitere Anfragen zu senden.
Über OAuth verbundene Google- und Facebook-Konten werden automatisch als verbunden angezeigt und können nicht über den Bearbeitungsendpunkt überschrieben werden. Verwenden Sie die kontoweite Funktion Bewertungsquellen für ein Konto auflisten, um alle Plattformen anzuzeigen, die der Tarif unterstützen könnte.
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/reviews/settings' \ -H "Authorization: API $LISTINGSAPI_KEY"