Referencia de atributos de interacción

Referencia de los campos de los objetos de interacción y respuesta devueltos por los endpoints de interacciones.

Los objetos de interacción se devuelven mediante Listar interacciones de una ubicación, Obtener interacciones agregadas y Obtener interacciones por ID. Los dos endpoints paginados los envuelven en una conexión de estilo Relay: tanto data.interactions (por ubicación) como data.rollupInteractions (agregación de la cuenta) contienen edges[].node, pageInfo y totalCount. La consulta por ID no utiliza paginación; data.interactionDetails es un objeto { "interactions": [ ... ] } simple sin edges, pageInfo ni totalCount.

Campos de interacción

CampoTipoDescripción
idStringUUID de la interacción. Pásalo como interactionId al responder
interactionIdStringEl mismo UUID que id
sourceStringNombre de host del sitio de reseñas o de la red social (e.g, maps.google.com, yelp.com)
titleStringTítulo de la interacción, cuando el origen proporciona uno
contentStringTexto del cuerpo de la reseña o publicación
authorNameStringNombre visible del autor
ratingIntegerValoración en estrellas, de 1 a 5 (solo reseñas)
dateStringMarca de tiempo de la interacción en formato ISO 8601
permalinkStringEnlace directo a la interacción en el sitio de origen
categoryStringCategoría general: e.g, Review o Social
typeStringTipo específico de interacción: Review, Question, Comment, Recommendation, Post, Photo, Message, Response
respondedBooleanIndica si existe una respuesta del propietario
notesStringNotas privadas del propietario de la cuenta
responsesArrayRespuestas del propietario asociadas a esta interacción (consulta más abajo)
responseCountIntegerNúmero de respuestas asociadas
canRespondBooleanIndica si se puede publicar una respuesta desde Listings API para este origen
locationIdIntegerID numérico en la base de datos de la ubicación a la que pertenece la interacción
flaggedReasonStringMotivo por el que se marcó la interacción, si lo hay

Campos del objeto de respuesta

Cada elemento del array responses de una interacción (y el objeto devuelto por Responder a una interacción):

CampoTipoDescripción
idStringID único de la respuesta (pásalo como responseId al editarla o archivarla)
interactionIdStringID de la interacción a la que pertenece esta respuesta
contentStringTexto de la respuesta
authorNameStringNombre mostrado como autor de la respuesta
dateStringMarca de tiempo de creación de la respuesta
respondedWithStringID de la plantilla de respuesta utilizada, si la hay
respondedByIntegerID del usuario de Listings API que envió la respuesta
interactionStatusStringEstado del ciclo de vida: CREATED, FAILED, COMPLETED o CONFIRMED
editedResponseBooleanIndica si esta respuesta se ha editado desde su publicación inicial
remarksStringObservaciones del sistema (e.g, detalles del fallo)

Flujo de estados de la respuesta

El campo interactionStatus permite seguir el progreso de una respuesta durante su publicación en el sitio de origen:

  • CREATED → COMPLETED: publicada en la plataforma de publicación; esa plataforma no ofrece doble confirmación
  • CREATED → COMPLETED → CONFIRMED: publicada y posteriormente confirmada por la plataforma de publicación
  • CREATED → FAILED: el envío a la plataforma de publicación no se completó correctamente; consulta remarks

Valores enumerados de los filtros

Los endpoints paginados aceptan estos valores enumerados como filtros:

  • responseStatus: RESPONDED, PENDING
  • sortOrder: NEWEST_FIRST, OLDEST_FIRST, LAST_RESPONDED
  • category: REVIEW (y otras categorías generales disponibles por cuenta)