Referência de atributos de interação

Os objetos de interação são retornados por Listar interações de um local, Obter interações consolidadas e Obter interações por IDs. Os dois endpoints paginados os encapsulam em uma conexão no estilo Relay: data.interactions (por local) e data.rollupInteractions (consolidado da conta) contêm, cada um, edges[].node, pageInfo e totalCount. A busca por IDs não usa paginação; data.interactionDetails é um objeto { "interactions": [ ... ] } simples, sem edges, pageInfo ou totalCount.

Campos de interação

Campo	Tipo	Descrição
id	String	UUID da interação. Passe-o como `interactionId` ao responder
interactionId	String	O mesmo UUID de `id`
source	String	Nome do host do site de avaliações ou da rede social (e.g, `maps.google.com`, `yelp.com`)
title	String	Título da interação, quando fornecido pela origem
content	String	Texto do corpo da avaliação ou publicação
authorName	String	Nome de exibição do autor
rating	Integer	Nota em estrelas, de 1 a 5 (somente avaliações)
date	String	Data e hora da interação no formato ISO 8601
permalink	String	Link direto para a interação no site de origem
category	String	Categoria geral: e.g, `Review` ou `Social`
type	String	Tipo específico de interação: `Review`, `Question`, `Comment`, `Recommendation`, `Post`, `Photo`, `Message`, `Response`
responded	Boolean	Indica se existe uma resposta do proprietário
notes	String	Notas privadas do proprietário da conta
responses	Array	Respostas do proprietário vinculadas a esta interação (veja abaixo)
responseCount	Integer	Número de respostas vinculadas
canRespond	Boolean	Indica se é possível publicar uma resposta pela Listings API para esta origem
locationId	Integer	ID numérico no banco de dados do local ao qual a interação pertence
flaggedReason	String	Motivo pelo qual a interação foi sinalizada, se houver

Campos do objeto de resposta

Cada item no array responses de uma interação (e o objeto retornado por Responder a uma interação):

Campo	Tipo	Descrição
id	String	ID exclusivo da resposta (passe-o como `responseId` ao editar ou arquivar)
interactionId	String	ID da interação à qual esta resposta pertence
content	String	Texto da resposta
authorName	String	Nome exibido como autor da resposta
date	String	Data e hora de criação da resposta
respondedWith	String	ID do modelo de resposta utilizado, se houver
respondedBy	Integer	ID do usuário da Listings API que enviou a resposta
interactionStatus	String	Estado do ciclo de vida: `CREATED`, `FAILED`, `COMPLETED` ou `CONFIRMED`
editedResponse	Boolean	Indica se esta resposta foi editada desde a primeira publicação
remarks	String	Observações do sistema (e.g, detalhes da falha)

Fluxo de status da resposta

O campo interactionStatus acompanha uma resposta durante sua publicação no site de origem:

CREATED → COMPLETED: publicada na plataforma de publicação; nenhuma confirmação adicional está disponível nessa plataforma
CREATED → COMPLETED → CONFIRMED: publicada e depois confirmada pela plataforma de publicação
CREATED → FAILED: o envio à plataforma de publicação não foi bem-sucedido; veja remarks

Enumerações de filtros

Os endpoints paginados aceitam estes valores de enumeração como filtros:

responseStatus: RESPONDED, PENDING
sortOrder: NEWEST_FIRST, OLDEST_FIRST, LAST_RESPONDED
category: REVIEW (e outras categorias gerais disponibilizadas por conta)