Référence des attributs d’interaction

Les objets d’interaction sont renvoyés par Lister les interactions d’un établissement, Obtenir les interactions agrégées et Obtenir les interactions par ID. Les deux endpoints paginés les encapsulent dans une connexion de type Relay : data.interactions (par établissement) et data.rollupInteractions (agrégation au sein du compte) contiennent chacun edges[].node, pageInfo et totalCount. La récupération par ID n’utilise pas de pagination : data.interactionDetails est un simple objet { "interactions": [ ... ] } sans edges, pageInfo ni totalCount.

Champs d’interaction

Champ	Type	Description
id	String	UUID de l’interaction. Transmettez-le comme `interactionId` lorsque vous répondez
interactionId	String	Même UUID que `id`
source	String	Nom d’hôte du site d’avis ou du réseau social (e.g, `maps.google.com`, `yelp.com`)
title	String	Titre de l’interaction, lorsque la source en fournit un
content	String	Texte de l’avis ou de la publication
authorName	String	Nom d’affichage de l’auteur
rating	Integer	Note en étoiles, de 1 à 5 (avis uniquement)
date	String	Horodatage de l’interaction au format ISO 8601
permalink	String	Lien direct vers l’interaction sur le site source
category	String	Catégorie générale, e.g, `Review` ou `Social`
type	String	Type précis d’interaction, `Review`, `Question`, `Comment`, `Recommendation`, `Post`, `Photo`, `Message`, `Response`
responded	Boolean	Indique s’il existe une réponse du propriétaire
notes	String	Notes privées du propriétaire du compte
responses	Array	Réponses du propriétaire associées à cette interaction (voir ci-dessous)
responseCount	Integer	Nombre de réponses associées
canRespond	Boolean	Indique si une réponse peut être publiée depuis Listings API pour cette source
locationId	Integer	ID numérique, dans la base de données, de l’établissement auquel appartient l’interaction
flaggedReason	String	Motif du signalement de l’interaction, le cas échéant

Champs de l’objet de réponse

Chaque élément du tableau responses d’une interaction (ainsi que l’objet renvoyé par Répondre à une interaction) :

Champ	Type	Description
id	String	ID unique de la réponse (à transmettre comme `responseId` lors de la modification ou de l’archivage)
interactionId	String	ID de l’interaction à laquelle cette réponse appartient
content	String	Texte de la réponse
authorName	String	Nom affiché comme auteur de la réponse
date	String	Horodatage de la création de la réponse
respondedWith	String	ID du modèle de réponse utilisé, le cas échéant
respondedBy	Integer	ID de l’utilisateur Listings API qui a soumis la réponse
interactionStatus	String	État du cycle de vie, `CREATED`, `FAILED`, `COMPLETED` ou `CONFIRMED`
editedResponse	Boolean	Indique si cette réponse a été modifiée depuis sa publication initiale
remarks	String	Remarques du système (e.g, détail de l’échec)

Évolution du statut de la réponse

Le champ interactionStatus suit la réponse au cours de sa publication sur le site source :

CREATED → COMPLETED : publiée sur la plateforme de publication ; aucune double confirmation n’est disponible sur cette plateforme
CREATED → COMPLETED → CONFIRMED : publiée, puis confirmée par la plateforme de publication
CREATED → FAILED : la soumission à la plateforme de publication a échoué ; voir remarks

Énumérations des filtres

Les endpoints paginés acceptent ces valeurs d’énumération comme filtres :

responseStatus: RESPONDED, PENDING
sortOrder: NEWEST_FIRST, OLDEST_FIRST, LAST_RESPONDED
category : REVIEW (et d’autres catégories générales exposées par compte)