Listings APIListings API
Anmelden

Bewertungen beantworten, Antwort bearbeiten oder archivieren

Suchen Sie Bewertungen mit Antwortoption für Inhaber, antworten Sie, prüfen Sie den Eingang bei der Plattform und ändern oder archivieren Sie die Antwort.

Eine Antwort des Inhabers wird in Ihrem Namen auf der Plattform veröffentlicht. Die API nimmt sie sofort an und übermittelt sie asynchron; die Reihenfolge lautet: Wählen Sie eine Bewertung aus, die beantwortet werden kann, veröffentlichen Sie die Antwort und bestätigen Sie anschließend die Übermittlung durch erneutes Abrufen.

1. Bewertungen auswählen, die beantwortet werden können

Listen Sie die Bewertungen des Standorts auf und behalten Sie diejenigen, bei denen canRespond den Wert true und responded den Wert false hat. Der Filter responseStatus=["PENDING"] führt die zweite Prüfung serverseitig durch; der JSON-Wert muss URL-kodiert sein, was --data-urlencode übernimmt.

Answerable reviews
curl -G "https://listingsapi.com/api/v4/locations/TG9jYXRpb246MTgwMDI4OQ==/reviews" \-H "Authorization: API $LISTINGSAPI_KEY" \--data-urlencode 'responseStatus=["PENDING"]' \--data-urlencode 'first=25'
JSON
{  "node": {    "id": "9e26d2a8-a6ed-42ea-8454-47d1c92ea841",    "source": "maps.google.com",    "rating": 5,    "content": "nice place for family together",    "responded": false,    "responseCount": 0,    "canRespond": true  }}

canRespond hat bei Quellen, die keine Antworten des Inhabers über die API annehmen, den Wert false. Überspringen Sie diese; ein Antwortversuch erreicht die Plattform nicht. Beim Entwerfen einer Antwort zeigt Ihnen Formulierungen aus Bewertungen auflisten, was Kunden am häufigsten erwähnen, damit die Antwort darauf eingehen kann.

2. Eine Antwort veröffentlichen

POST /locations/reviews/respond nimmt die Felder direkt im Body entgegen, nicht in input eingebettet. interactionId ist id der Bewertung. respondedWith ist optional und benennt eine Antwortvorlage, falls Sie eine verwendet haben.

Respond
curl -X POST https://listingsapi.com/api/v4/locations/reviews/respond \-H "Authorization: API $LISTINGSAPI_KEY" \-H "Content-Type: application/json" \-d '{  "interactionId": "9e26d2a8-a6ed-42ea-8454-47d1c92ea841",  "responseContent": "Thank you for visiting Jenny Home: we are glad you enjoyed your experience!"}'
JSON
{  "data": {    "respondToInteraction": {      "interaction": {        "id": "2090753a-ece6-4837-8336-8494ad308523",        "interactionId": "9e26d2a8-a6ed-42ea-8454-47d1c92ea841",        "content": "Thank you for visiting Jenny Home: we are glad you enjoyed your experience!",        "interactionStatus": "CREATED",        "editedResponse": false      },      "errors": null    }  }}

Bewahren Sie interaction.id auf: Dies ist responseId, den Sie benötigen, um die Antwort später zu bearbeiten oder zu archivieren. Bei einer abgelehnten Antwort wird 200 zurückgegeben, wobei errors innerhalb von data.respondToInteraction ausgefüllt ist; lesen Sie daher den Body. Die SDKs lösen in diesem Fall ValidationError aus.

3. Bestätigen, dass die Antwort die Plattform erreicht hat

interactionStatus hat zunächst den Wert CREATED und entwickelt sich ohne weitere Aufrufe weiter. Rufen Sie die Bewertung nach einer kurzen Wartezeit anhand ihrer ID erneut ab und prüfen Sie responded, responseCount sowie den Status der Antwort innerhalb von responses[].

StatusBedeutung
CREATEDAngenommen und zur Übermittlung an die Plattform in die Warteschlange gestellt.
COMPLETEDAuf der Plattform veröffentlicht. Bei einigen Plattformen endet der Ablauf hier.
CONFIRMEDVeröffentlicht und von der Plattform bestätigt.
FAILEDDie Plattform hat die Antwort abgelehnt. remarks in der Antwort gibt den Grund an.
Re-read
curl -G "https://listingsapi.com/api/v4/reviewDetails" \-H "Authorization: API $LISTINGSAPI_KEY" \--data-urlencode 'interactionIds=["9e26d2a8-a6ed-42ea-8454-47d1c92ea841"]'
JSON
{  "id": "9e26d2a8-a6ed-42ea-8454-47d1c92ea841",  "responded": true,  "responseCount": 1,  "responses": [    {      "id": "2090753a-ece6-4837-8336-8494ad308523",      "content": "Thank you for visiting Jenny Home: we are glad you enjoyed your experience!",      "interactionStatus": "CONFIRMED",      "editedResponse": false    }  ]}

responded: true mit einer Antwort im Status CONFIRMED oder COMPLETED bedeutet, dass der Kunde sie sehen kann. Wenn Sie FAILED sehen, lesen Sie vor einem erneuten Versuch remarks in der Antwort, um den von der Plattform angegebenen Grund zu erfahren.

4. Eine Antwort bearbeiten

POST /locations/reviews/respond/edit benötigt beide IDs: reviewId bezeichnet die Bewertung, responseId die Antwort aus Schritt 2. Die Bearbeitung wird erneut übermittelt, daher wird interactionStatus der Antwort auf CREATED zurückgesetzt und editedResponse wird zu true, sobald die bearbeitete Antwort auf der Plattform angekommen ist.

Edit reply
curl -X POST https://listingsapi.com/api/v4/locations/reviews/respond/edit \-H "Authorization: API $LISTINGSAPI_KEY" \-H "Content-Type: application/json" \-d '{  "reviewId": "9e26d2a8-a6ed-42ea-8454-47d1c92ea841",  "responseId": "2090753a-ece6-4837-8336-8494ad308523",  "responseContent": "Thank you again: we have updated our reply to include our new store hours."}'
JSON
{  "data": {    "editResponse": {      "status": "true",      "reviewId": "9e26d2a8-a6ed-42ea-8454-47d1c92ea841",      "responseId": "2090753a-ece6-4837-8336-8494ad308523"    }  }}

status ist die Zeichenfolge "true", wenn die Bearbeitung angenommen wurde. Bestätigen Sie den neuen Wortlaut auf dieselbe Weise wie in Schritt 3.

5. Eine Antwort archivieren

POST /locations/reviews/respond/archive nimmt nur responseId entgegen. Durch das Archivieren wird die Antwort aus responses der Interaktion in Listings API entfernt. Eine bereits auf Google oder Facebook veröffentlichte Antwort wird dadurch nicht zurückgezogen; verwenden Sie die Archivierung daher, um einen Entwurf zu entfernen, dessen Veröffentlichung fehlgeschlagen ist oder der ersetzt wurde, und bearbeiten Sie bereits veröffentlichte Antworten.

Archive reply
curl -X POST https://listingsapi.com/api/v4/locations/reviews/respond/archive \-H "Authorization: API $LISTINGSAPI_KEY" \-H "Content-Type: application/json" \-d '{ "responseId": "2090753a-ece6-4837-8336-8494ad308523" }'
JSON
{  "data": {    "archiveResponse": {      "status": "true"    }  }}

Nach dem Archivieren sinkt responseCount der Bewertung und responded spiegelt die verbleibenden Antworten wider.

6. Antwortereignisse per Webhook empfangen

Ein interaction.response-Ereignis wird ausgelöst, wenn eine Antwort veröffentlicht, bearbeitet oder archiviert wird. Die Nutzdaten befinden sich unter data.interaction, wobei type: "Response" und parent_id auf die ID der Bewertung gesetzt sind, sodass Sie das Ereignis ohne einen weiteren Aufruf Ihrem eigenen Datensatz zuordnen können. Wie bei interaction.review ist das zugehörige location_id nicht normalisiert und kann null sein. Die Einrichtung wird unter Mit Webhooks auf Ereignisse reagieren beschrieben.

Nächste Schritte