Riferimento degli attributi delle interazioni

Gli oggetti interazione sono restituiti da Elenca le interazioni per una sede, Ottieni le interazioni aggregate e Ottieni le interazioni per ID. I due endpoint con paginazione li racchiudono in una connessione in stile Relay: data.interactions (per sede) e data.rollupInteractions (aggregazione a livello di account) contengono ciascuno edges[].node, pageInfo e totalCount. Il recupero per ID non prevede la paginazione: data.interactionDetails è un semplice oggetto { "interactions": [ ... ] } senza edges, pageInfo o totalCount.

Campi dell'interazione

Campo	Tipo	Descrizione
id	String	UUID dell'interazione. Passalo come `interactionId` quando rispondi
interactionId	String	Lo stesso UUID di `id`
source	String	Nome host del sito di recensioni o del social network (e.g, `maps.google.com`, `yelp.com`)
title	String	Titolo dell'interazione, quando la fonte ne fornisce uno
content	String	Testo della recensione o del post
authorName	String	Nome visualizzato dell'autore
rating	Integer	Valutazione in stelle, da 1 a 5 (solo per le recensioni)
date	String	Timestamp dell'interazione in formato ISO 8601
permalink	String	Link diretto all'interazione sul sito di origine
category	String	Categoria generale, e.g, `Review` o `Social`
type	String	Tipo specifico di interazione, `Review`, `Question`, `Comment`, `Recommendation`, `Post`, `Photo`, `Message`, `Response`
responded	Boolean	Indica se esiste una risposta del proprietario
notes	String	Note private del proprietario dell'account
responses	Array	Risposte del proprietario associate a questa interazione (vedi sotto)
responseCount	Integer	Numero di risposte associate
canRespond	Boolean	Indica se è possibile pubblicare una risposta tramite Listings API per questa fonte
locationId	Integer	ID numerico nel database della sede a cui appartiene l'interazione
flaggedReason	String	Motivo per cui l'interazione è stata segnalata, se presente

Campi dell'oggetto risposta

Ogni elemento dell'array responses di un'interazione (e l'oggetto restituito da Rispondi a un'interazione):

Campo	Tipo	Descrizione
id	String	ID univoco della risposta (passalo come `responseId` quando la modifichi o la archivi)
interactionId	String	ID dell'interazione a cui appartiene questa risposta
content	String	Testo della risposta
authorName	String	Nome visualizzato come autore della risposta
date	String	Timestamp di creazione della risposta
respondedWith	String	ID del modello di risposta utilizzato, se presente
respondedBy	Integer	ID dell'utente di Listings API che ha inviato la risposta
interactionStatus	String	Stato del ciclo di vita, `CREATED`, `FAILED`, `COMPLETED` o `CONFIRMED`
editedResponse	Boolean	Indica se questa risposta è stata modificata dopo la prima pubblicazione
remarks	String	Note di sistema (e.g, dettagli dell'errore)

Flusso degli stati della risposta

Il campo interactionStatus tiene traccia della risposta durante la pubblicazione sul sito di origine:

CREATED → COMPLETED: pubblicata sulla piattaforma di pubblicazione; su tale piattaforma non è disponibile una doppia conferma
CREATED → COMPLETED → CONFIRMED: pubblicata e poi confermata dalla piattaforma di pubblicazione
CREATED → FAILED: l'invio alla piattaforma di pubblicazione non è riuscito; vedi remarks

Valori enumerati per i filtri

Gli endpoint con paginazione accettano questi valori enumerati come filtri:

responseStatus: RESPONDED, PENDING
sortOrder: NEWEST_FIRST, OLDEST_FIRST, LAST_RESPONDED
category: REVIEW (e altre categorie generali esposte per ciascun account)