/api/v4/locations/reviews/settings/editBewertungseinstellungen für einen Standort bearbeiten
Legt fest, auf welchen Bewertungsquellen ein Standort überwacht wird und ab welchem Schwellenwert eine Bewertung als positiv gilt.
Parameter
Body
Ein als erforderlich markiertes verschachteltes Feld gilt nur, wenn Sie das übergeordnete Feld senden. Ist das übergeordnete Feld optional und lassen Sie es weg, gelten seine erforderlichen Unterfelder nicht.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| locationId | string | erforderlich | 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 | optional | 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 | optional | Site key, as returned in `siteSettings[].name` (e.g. `maps.google.com`, `yelp.com`). |
| siteUrls[].url | string | optional | The location's page URL on that site. Send `null` or omit to stop monitoring a source that needs an explicit URL. |
| positiveInteractionThreshold | integer | optional | Star rating at or above which a review counts as positive. Sent on its own, it leaves the source selection untouched. |
Beispielanfrage
Body zum direkten Einfügen. Ersetzen Sie Platzhalter-IDs und -Werte durch Ihre eigenen.
{ "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "positiveInteractionThreshold": 4, "siteUrls": [ { "name": "maps.google.com", "url": null }, { "name": "yelp.com", "url": "https://www.yelp.com/biz/blue-bottle-coffee-oakland" } ]}Antworten
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`).
Aktualisiert die Bewertungsquellen, auf denen ein Standort überwacht wird, und die Punktzahl, ab der eine Bewertung als positiv gilt. Dieselben Einstellungen können über Bewertungsquellen für einen Standort auflisten abgerufen werden.
siteUrls ersetzt die Auswahl vollständig und ist kein Patch. Das von Ihnen gesendete Array wird zur Quellenauswahl des Standorts. Um eine Quelle hinzuzufügen, lesen Sie zuerst den aktuellen Wert von siteSettings aus und senden Sie die vorhandenen Einträge zusammen mit dem neuen Eintrag zurück; wenn Sie ein Array mit nur einem Element senden, werden alle anderen Quellen ohne Hinweis entfernt.
Die beiden Felder sind voneinander unabhängig. Senden Sie nur positiveInteractionThreshold, um den Schwellenwert zu ändern, ohne die Quellen zu verändern, oder nur siteUrls, um die Quellen zu ändern, ohne den Schwellenwert zu verändern.
Wenn Sie eine Quelle hinzufügen, wird ein Scraping-Vorgang dafür eingeplant, sodass die Bewertungen einer neu hinzugefügten Website asynchron eintreffen und nicht in dieser Antwort enthalten sind. Eine Quelle, die bei der Validierung abgelehnt wird (wegen einer nicht erreichbaren URL oder weil sie nicht im Tarif des Kontos enthalten ist), wird in errors zurückgegeben, wobei die Einstellung unverändert bleibt. Prüfen Sie daher errors auch bei 200.
Anwendungsfall: Yelp-Seite eines Standorts einrichten
Direkt nach dem Erstellen eines Standorts werden dessen Google- und Facebook-Quellen automatisch überwacht, eine Yelp-Seite muss jedoch ausdrücklich angegeben werden. Lesen Sie die aktuelle Auswahl über die Einstellungsroute aus, fügen Sie { "name": "yelp.com", "url": "<the location's Yelp URL>" } hinzu und senden Sie das gesamte Array zusammen mit der ID des Standorts zurück. Der Scraping-Vorgang wird sofort in die Warteschlange eingereiht, und die ersten Yelp-Bewertungen erscheinen nach dessen Abschluss unter Interaktionen auflisten.
Dieser Endpunkt ändert die aktiven Überwachungseinstellungen. Die oben gezeigte Anfrage und Antwort dienen als Beispiele.
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" } ] }'