REST Resource: accounts.merchantReviews

Ressource: MerchantReview

Avis concernant un marchand. Pour en savoir plus, consultez la section Présentation des flux d'avis sur les marchands.

Représentation JSON
{
  "name": string,
  "merchantReviewId": string,
  "attributes": {
    object (MerchantReviewAttributes)
  },
  "customAttributes": [
    {
      object (CustomAttribute)
    }
  ],
  "dataSource": string,
  "merchantReviewStatus": {
    object (MerchantReviewStatus)
  }
}
Champs
name

string

Identifiant. Nom de l'avis sur le marchand. Format : "{merchantreview.name=accounts/{account}/merchantReviews/{merchantReview}}"

merchantReviewId

string

Obligatoire. L'utilisateur a fourni l'ID de l'avis sur le marchand pour l'identifier de manière unique.

attributes

object (MerchantReviewAttributes)

Facultatif. Liste des attributs des avis sur les marchands.

customAttributes[]

object (CustomAttribute)

Obligatoire. Liste d'attributs personnalisés (fournis par le marchand). Vous pouvez également l'utiliser pour envoyer tout attribut des spécifications des données sous sa forme générique (par exemple, { "name": "size type", "value": "regular" }). Cela est utile pour l'envoi d'attributs qui ne sont pas explicitement indiqués par l'API, tels que les attributs expérimentaux. Le nombre maximal de caractères autorisés pour chaque attribut personnalisé est de 10 240 (correspond à la somme des caractères du nom et de la valeur). Vous pouvez définir jusqu'à 2 500 attributs personnalisés par produit, d'une taille totale de 102,4 ko. Les traits de soulignement dans les noms d'attributs personnalisés sont remplacés par des espaces lors de l'insertion.

dataSource

string

Uniquement en sortie. Source de données principale de l'avis sur le marchand.

merchantReviewStatus

object (MerchantReviewStatus)

Uniquement en sortie. État d'un avis sur un marchand, problèmes de validation des données (informations sur un avis sur un marchand calculé de manière asynchrone).

MerchantReviewAttributes

Attributs.

Représentation JSON
{
  "merchantId": string,
  "merchantDisplayName": string,
  "merchantLink": string,
  "merchantRatingLink": string,
  "minRating": string,
  "maxRating": string,
  "rating": number,
  "title": string,
  "content": string,
  "reviewerId": string,
  "reviewerUsername": string,
  "isAnonymous": boolean,
  "collectionMethod": enum (CollectionMethod),
  "reviewTime": string,
  "reviewLanguage": string,
  "reviewCountry": string
}
Champs
merchantId

string

Obligatoire. Il doit être unique et stable pour toutes les requêtes. En d'autres termes, si une requête envoyée aujourd'hui et une autre envoyée il y a 90 jours font référence au même marchand, elles doivent avoir le même ID.

merchantDisplayName

string

Facultatif. Nom à afficher lisible pour le marchand.

minRating

string (int64 format)

Facultatif. Nombre minimal possible pour la note. Il doit s'agir de la note la plus basse possible et ne pas correspondre à une valeur indiquant l'absence de note.

maxRating

string (int64 format)

Facultatif. Nombre maximal possible pour la note. La valeur de la note maximale doit être supérieure à celle de la note minimale.

rating

number

Facultatif. Note globale attribuée par l'auteur de l'avis au marchand.

title

string

Facultatif. Titre de l'avis.

content

string

Obligatoire. Il s'agit de tout texte libre fourni par l'utilisateur et qui ne doit pas être tronqué. Si plusieurs réponses sont fournies à différentes questions, toutes doivent être incluses, avec le contexte minimal nécessaire pour qu'elles aient du sens. Le contexte ne doit pas être fourni si des questions sont restées sans réponse.

reviewerId

string

Facultatif. Identifiant unique et permanent de l'auteur de l'avis dans le système de l'éditeur.

reviewerUsername

string

Facultatif. Nom à afficher de l'auteur de l'avis.

isAnonymous

boolean

Facultatif. Définissez cette valeur sur "true" si l'auteur de l'avis doit rester anonyme.

collectionMethod

enum (CollectionMethod)

Facultatif. Méthode utilisée pour collecter l'avis.

reviewTime

string (Timestamp format)

Obligatoire. Code temporel indiquant la date de rédaction de l'avis.

reviewLanguage

string

Obligatoire. Langue de l'avis définie par le code de langue BCP-47.

reviewCountry

string

Facultatif. Pays dans lequel l'auteur de l'avis a effectué la commande définie par le code pays ISO 3166-1 Alpha-2.

CollectionMethod

Méthode utilisée pour collecter l'avis.

Enums
COLLECTION_METHOD_UNSPECIFIED Méthode de collecte non spécifiée.
MERCHANT_UNSOLICITED L'utilisateur ne répondait pas à une sollicitation spécifique lorsqu'il a envoyé l'avis.
POINT_OF_SALE L'utilisateur a envoyé l'avis en réponse à une sollicitation lorsqu'il a passé une commande.
AFTER_FULFILLMENT L'utilisateur a envoyé l'avis en réponse à une sollicitation après la livraison de sa commande.

MerchantReviewStatus

État d'un avis sur un marchand, problèmes de validation des données, c'est-à-dire informations sur un avis sur un marchand calculées de manière asynchrone.

Représentation JSON
{
  "destinationStatuses": [
    {
      object (MerchantReviewDestinationStatus)
    }
  ],
  "itemLevelIssues": [
    {
      object (MerchantReviewItemLevelIssue)
    }
  ],
  "createTime": string,
  "lastUpdateTime": string
}
Champs
destinationStatuses[]

object (MerchantReviewDestinationStatus)

Uniquement en sortie. Destinations prévues pour l'avis sur le marchand

itemLevelIssues[]

object (MerchantReviewItemLevelIssue)

Uniquement en sortie. Liste de tous les problèmes associés à l'avis sur le marchand.

createTime

string (Timestamp format)

Uniquement en sortie. Date de création de l'article, au format ISO 8601.

lastUpdateTime

string (Timestamp format)

Uniquement en sortie. Date de la dernière mise à jour de l'article, au format ISO 8601.

MerchantReviewDestinationStatus

État de destination de l'état des avis sur le marchand.

Représentation JSON
{
  "reportingContext": enum (ReportingContextEnum)
}
Champs
reportingContext

enum (ReportingContextEnum)

Uniquement en sortie. Nom du contexte du rapport.

MerchantReviewItemLevelIssue

ItemLevelIssue de l'état de l'examen du marchand.

Représentation JSON
{
  "code": string,
  "severity": enum (Severity),
  "resolution": string,
  "attribute": string,
  "reportingContext": enum (ReportingContextEnum),
  "description": string,
  "detail": string,
  "documentation": string
}
Champs
code

string

Uniquement en sortie. Code d'erreur du problème

severity

enum (Severity)

Uniquement en sortie. Indique comment ce problème affecte la diffusion de l'avis sur le marchand

resolution

string

Uniquement en sortie. Indique si le problème peut être résolu par le marchand

attribute

string

Uniquement en sortie. Si le problème est causé par un attribut unique, nom de cet attribut

reportingContext

enum (ReportingContextEnum)

Uniquement en sortie. Contexte des rapports auquel le problème s'applique.

description

string

Uniquement en sortie. Description courte du problème en anglais

detail

string

Uniquement en sortie. Description détaillée du problème en anglais

documentation

string

Uniquement en sortie. URL d'une page Web d'aide pour résoudre ce problème

Gravité

Impact du problème sur la diffusion de l'avis sur le marchand

Enums
SEVERITY_UNSPECIFIED Non spécifié.
NOT_IMPACTED Il s'agit d'un avertissement qui n'a pas d'incidence directe sur l'avis sur le marchand.
DISAPPROVED Le problème entraîne le refus de l'avis sur le marchand.

Méthodes

delete

Supprime l'avis sur le marchand.

get

Récupère un avis sur un marchand.

insert

Insère un avis pour votre compte Merchant Center.

list

Répertorie les avis sur les marchands.