Referenz der Interaktionsattribute

Feldreferenz für die Interaktions- und Antwortobjekte, die von den Interaktionsendpunkten zurückgegeben werden.

Interaktionsobjekte werden von Interaktionen für einen Standort auflisten, Zusammengefasste Interaktionen abrufen und Interaktionen anhand von IDs abrufen zurückgegeben. Die beiden paginierten Endpunkte betten sie in eine Verbindung im Relay-Stil ein: data.interactions (pro Standort) und data.rollupInteractions (kontoweite Zusammenfassung) enthalten jeweils edges[].node, pageInfo und totalCount. Beim Abrufen anhand von IDs erfolgt keine Paginierung; data.interactionDetails ist ein einfaches { "interactions": [ ... ] }-Objekt ohne edges, pageInfo oder totalCount.

Interaktionsfelder

FeldTypBeschreibung
idStringDie UUID der Interaktion. Übergeben Sie sie beim Antworten als interactionId
interactionIdStringDieselbe UUID wie id
sourceStringHostname der Bewertungswebsite oder des sozialen Netzwerks (e.g, maps.google.com, yelp.com)
titleStringTitel der Interaktion, sofern die Quelle einen bereitstellt
contentStringText der Bewertung oder des Beitrags
authorNameStringAnzeigename des Verfassers
ratingIntegerSternebewertung, 1–5 (nur bei Bewertungen)
dateStringZeitstempel der Interaktion im Format ISO 8601
permalinkStringDirekter Link zur Interaktion auf der Quellwebsite
categoryStringÜbergeordnete Kategorie, e.g, Review oder Social
typeStringSpezifischer Interaktionstyp, Review, Question, Comment, Recommendation, Post, Photo, Message, Response
respondedBooleanGibt an, ob eine Antwort des Inhabers vorhanden ist
notesStringPrivate Notizen des Kontoinhabers
responsesArrayDieser Interaktion zugeordnete Antworten des Inhabers (siehe unten)
responseCountIntegerAnzahl der zugeordneten Antworten
canRespondBooleanGibt an, ob für diese Quelle eine Antwort über Listings API veröffentlicht werden kann
locationIdIntegerNumerische Datenbank-ID des Standorts, zu dem die Interaktion gehört
flaggedReasonStringGrund für die Markierung der Interaktion, falls vorhanden

Felder des Antwortobjekts

Jedes Element im responses-Array einer Interaktion (und das von Auf eine Interaktion antworten zurückgegebene Objekt):

FeldTypBeschreibung
idStringEindeutige Antwort-ID (beim Bearbeiten oder Archivieren als responseId übergeben)
interactionIdStringID der Interaktion, zu der diese Antwort gehört
contentStringText der Antwort
authorNameStringName, der als Verfasser der Antwort angezeigt wird
dateStringZeitstempel der Erstellung der Antwort
respondedWithStringID der verwendeten Antwortvorlage, falls vorhanden
respondedByIntegerListings API-Benutzer-ID des Benutzers, der die Antwort übermittelt hat
interactionStatusStringLebenszyklusstatus, CREATED, FAILED, COMPLETED oder CONFIRMED
editedResponseBooleanGibt an, ob diese Antwort seit ihrer ersten Veröffentlichung bearbeitet wurde
remarksStringSystemanmerkungen (e.g, Fehlerdetails)

Statusablauf einer Antwort

Das Feld interactionStatus verfolgt den Status einer Antwort bei ihrer Veröffentlichung auf der Quellwebsite:

  • CREATED → COMPLETED: auf der Plattform veröffentlicht; auf dieser Plattform ist keine zusätzliche Bestätigung verfügbar
  • CREATED → COMPLETED → CONFIRMED: veröffentlicht und anschließend von der Plattform bestätigt
  • CREATED → FAILED: Übermittlung an die Plattform war nicht erfolgreich; siehe remarks

Enum-Werte für Filter

Die paginierten Endpunkte akzeptieren diese Enum-Werte als Filter:

  • responseStatus: RESPONDED, PENDING
  • sortOrder: NEWEST_FIRST, OLDEST_FIRST, LAST_RESPONDED
  • category: REVIEW (und weitere übergeordnete Kategorien, die pro Konto bereitgestellt werden)