Package google.shopping.merchant.reviews.v1beta

Index

MerchantReviewsService

Service permettant de gérer les avis des marchands.

DeleteMerchantReview

rpc DeleteMerchantReview(DeleteMerchantReviewRequest) returns (Empty)

Supprime l'avis sur le marchand.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/content

Pour en savoir plus, consultez OAuth 2.0 Overview.

GetMerchantReview

rpc GetMerchantReview(GetMerchantReviewRequest) returns (MerchantReview)

Récupère un avis sur un marchand.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/content

Pour en savoir plus, consultez OAuth 2.0 Overview.

InsertMerchantReview

rpc InsertMerchantReview(InsertMerchantReviewRequest) returns (MerchantReview)

Insère un avis dans votre compte Merchant Center. Si l'avis existe déjà, il est remplacé par la nouvelle instance.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/content

Pour en savoir plus, consultez OAuth 2.0 Overview.

ListMerchantReviews

rpc ListMerchantReviews(ListMerchantReviewsRequest) returns (ListMerchantReviewsResponse)

Répertorie les avis sur les marchands.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/content

Pour en savoir plus, consultez OAuth 2.0 Overview.

ProductReviewsService

Service permettant de gérer les avis sur les produits.

DeleteProductReview

rpc DeleteProductReview(DeleteProductReviewRequest) returns (Empty)

Supprime un avis sur un produit.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/content

Pour en savoir plus, consultez OAuth 2.0 Overview.

GetProductReview

rpc GetProductReview(GetProductReviewRequest) returns (ProductReview)

Permet d'obtenir un avis sur un produit.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/content

Pour en savoir plus, consultez OAuth 2.0 Overview.

InsertProductReview

rpc InsertProductReview(InsertProductReviewRequest) returns (ProductReview)

Insère un avis sur un produit.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/content

Pour en savoir plus, consultez OAuth 2.0 Overview.

ListProductReviews

rpc ListProductReviews(ListProductReviewsRequest) returns (ListProductReviewsResponse)

Répertorie les avis sur les produits.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/content

Pour en savoir plus, consultez OAuth 2.0 Overview.

DeleteMerchantReviewRequest

Message de requête pour la méthode DeleteMerchantReview.

Champs
name

string

Obligatoire. ID de l'avis sur le marchand. Format: accounts/{account}/merchantReviews/{merchantReview}

DeleteProductReviewRequest

Message de requête pour la méthode DeleteProductReview.

Champs
name

string

Obligatoire. ID de l'avis sur le produit. Format: accounts/{account}/productReviews/{productReview}

GetMerchantReviewRequest

Message de requête pour la méthode GetMerchantReview.

Champs
name

string

Obligatoire. ID de l'avis sur le marchand. Format: accounts/{account}/merchantReviews/{merchantReview}

GetProductReviewRequest

Message de requête pour la méthode GetProductReview.

Champs
name

string

Obligatoire. ID de l'avis sur le marchand. Format: accounts/{account}/productReviews/{productReview}

InsertMerchantReviewRequest

Message de requête pour la méthode InsertMerchantReview.

Champs
parent

string

Obligatoire. Compte dans lequel l'avis sur le marchand sera inséré. Format: accounts/{account}

merchant_review

MerchantReview

Obligatoire. Avis sur le marchand à insérer.

data_source

string

Obligatoire. Source de données du format merchantreview: accounts/{account}/dataSources/{datasource}.

InsertProductReviewRequest

Message de requête pour la méthode InsertProductReview.

Champs
parent

string

Obligatoire. Compte dans lequel l'avis sur le produit sera inséré. Format: accounts/{account}

product_review

ProductReview

Obligatoire. Avis sur le produit à insérer.

data_source

string

Obligatoire. Format : accounts/{account}/dataSources/{datasource}.

ListMerchantReviewsRequest

Message de requête pour la méthode ListMerchantsReview.

Champs
parent

string

Obligatoire. Compte pour lequel afficher les avis sur les marchands. Format: accounts/{account}

page_size

int32

Facultatif. Nombre maximal d'avis sur le marchand à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. La valeur maximale est 1 000. Les valeurs supérieures sont réduites à 1 000. Si aucune valeur n'est spécifiée, le nombre maximal d'avis est renvoyé.

page_token

string

Facultatif. Jeton de page reçu d'un appel ListMerchantReviews précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à ListMerchantReviews doivent correspondre à l'appel ayant fourni le jeton de page.

ListMerchantReviewsResponse

Message de réponse pour la méthode ListMerchantsReview.

Champs
merchant_reviews[]

MerchantReview

Avis sur le marchand.

next_page_token

string

Jeton permettant de récupérer la page de résultats suivante.

ListProductReviewsRequest

Message de requête pour la méthode ListProductReviews.

Champs
parent

string

Obligatoire. Compte pour lequel lister les avis sur les produits. Format: accounts/{account}

page_size

int32

Facultatif. Nombre maximal de produits à afficher. Le service peut renvoyer un nombre inférieur à cette valeur.

page_token

string

Facultatif. Jeton de page reçu d'un appel ListProductReviews précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à ListProductReviews doivent correspondre à l'appel ayant fourni le jeton de page.

ListProductReviewsResponse

Message de réponse pour la méthode ListProductReviews.

Champs
product_reviews[]

ProductReview

Avis sur le produit.

next_page_token

string

Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

MerchantReview

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

Champs
name

string

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

merchant_review_id

string

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

attributes

MerchantReviewAttributes

Facultatif. Liste des attributs des avis sur les marchands.

custom_attributes[]

CustomAttribute

Obligatoire. Liste d'attributs personnalisés (fournis par le marchand). Elle peut également être utilisée pour envoyer n'importe quel attribut des spécifications des données sous sa forme générique (par exemple, { "name": "size type", "value": "regular" }). Cela est utile pour envoyer des attributs non 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 2 500 attributs personnalisés au maximum par produit, avec 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.

data_source

string

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

merchant_review_status

MerchantReviewStatus

Uniquement en sortie. É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.

MerchantReviewAttributes

Attributs.

Champs
merchant_id

string

Obligatoire. 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.

merchant_display_name

string

Facultatif. Nom à afficher lisible pour le marchand.

min_rating

int64

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.

max_rating

int64

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

rating

double

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.

reviewer_id

string

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

reviewer_username

string

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

is_anonymous

bool

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

collection_method

CollectionMethod

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

review_time

Timestamp

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

review_language

string

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

review_country

string

Facultatif. Pays dans lequel l'utilisateur a passé la commande, défini 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'avis envoyé par l'utilisateur ne correspondait pas à une sollicitation spécifique.
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.

Champs
destination_statuses[]

MerchantReviewDestinationStatus

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

item_level_issues[]

MerchantReviewItemLevelIssue

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

create_time

Timestamp

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

last_update_time

Timestamp

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.

Champs
reporting_context

ReportingContextEnum

Uniquement en sortie. Nom du contexte de création de rapports.

MerchantReviewItemLevelIssue

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

Champs
code

string

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

severity

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

reporting_context

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é

Indique comment le problème affecte 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.

ProductReview

Avis sur un produit. Pour en savoir plus, consultez Présentation des flux d'avis sur les produits.

Champs
name

string

Identifiant. Nom de l'avis sur le produit. Format : "{productreview.name=accounts/{account}/productReviews/{productReview}}"

product_review_id

string

Obligatoire. Identifiant unique et permanent de l'avis sur le produit dans le système de l'éditeur.

attributes

ProductReviewAttributes

Facultatif. Liste des attributs des avis sur les produits.

custom_attributes[]

CustomAttribute

Facultatif. Liste d'attributs personnalisés (fournis par le marchand).

data_source

string

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

product_review_status

ProductReviewStatus

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

ProductReviewAttributes

Attributs.

Champs
review_time

Timestamp

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

pros[]

string

Facultatif. Contient les avantages selon l'avis de l'auteur de l'avis. Omettez les formules types telles que "Avantages:", sauf si elles ont été rédigées par l'auteur de l'avis.

cons[]

string

Facultatif. Indique les inconvénients selon l'avis de l'auteur de l'avis. Supprimez les formules types telles que "Inconvénient:", sauf si elles ont été rédigées par l'auteur de l'avis.

product_names[]

string

Facultatif. Nom descriptif d'un produit.

asins[]

string

Facultatif. Contient les ASIN (Amazon Standard Identification Numbers) associés à un produit.

gtins[]

string

Facultatif. Indique les codes GTIN (code article international) associés à un produit. Les sous-types de codes GTIN (par exemple, UPC, EAN, ISBN, JAN) sont acceptés.

mpns[]

string

Facultatif. Indique les références fabricant associées à un produit.

skus[]

string

Facultatif. Contient les codes SKU (unités de gestion des stocks) associés à un produit. Il s'agit souvent de l'ID de l'offre produit dans le flux de produits.

brands[]

string

Facultatif. Contient les noms de marques associés à un produit.

collection_method

CollectionMethod

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

transaction_id

string

Facultatif. Identifiant unique et permanent de la transaction associée à l'avis dans le système de l'éditeur. Cet ID peut être utilisé pour indiquer que plusieurs avis sont associés à la même transaction.

aggregator_name

string

Facultatif. Nom de l'agrégateur des avis sur les produits.

Un éditeur peut utiliser un agrégateur d'avis pour gérer les avis et fournir les flux. Cet élément indique l'utilisation d'un agrégateur et contient des informations à son sujet.

subclient_name

string

Facultatif. Nom du sous-client des avis sur les produits.

Le sous-client est un identifiant de la source des avis sur les produits. Il doit être équivalent au répertoire indiqué dans le chemin d'accès de la source de données de fichier.

publisher_name

string

Facultatif. Nom de l'éditeur des avis sur les produits.

Informations sur l'éditeur, qui peut être un marchand, un fabricant, une société de services d'avis ou toute entité qui publie des avis sur des produits.

publisher_favicon

string

Facultatif. Lien vers la favicon de l'entreprise de l'éditeur. Les dimensions de l'image doivent correspondre à la taille de la favicon: 16 x 16 pixels. L'image doit être au format GIF, JPG ou PNG.

reviewer_id

string

Facultatif. Auteur de l'avis sur le produit.

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

reviewer_is_anonymous

bool

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

reviewer_username

string

Facultatif. Nom de l'auteur de l'avis sur le produit.

review_language

string

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

review_country

string

Facultatif. Pays de l'avis, défini par le code pays ISO 3166-1 alpha-2.

title

string

Facultatif. Titre de l'avis.

content

string

Obligatoire. Contenu de l'avis.

min_rating

int64

Facultatif. Inclut les notes associées à l'avis. 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.

max_rating

int64

Facultatif. Nombre maximal possible pour la note. La valeur de l'attribut "maxRating" doit être supérieure à celle de l'attribut "minRating".

rating

double

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

is_spam

bool

Facultatif. Indique si l'avis est marqué comme spam dans le système de l'éditeur.

CollectionMethod

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

Enums
COLLECTION_METHOD_UNSPECIFIED Méthode de collecte non spécifiée.
UNSOLICITED L'avis envoyé par l'utilisateur ne correspondait pas à une sollicitation spécifique.
POST_FULFILLMENT L'utilisateur a envoyé l'avis en réponse à une sollicitation après l'exécution de sa commande.

Type

Type de l'URI de l'avis.

Enums
TYPE_UNSPECIFIED Type non spécifié
SINGLETON La page des avis ne contient qu'un seul avis.
GROUP La page des avis contient un groupe d'avis, dont celui-ci.

ProductReviewStatus

État de l'examen du produit.

Champs
destination_statuses[]

ProductReviewDestinationStatus

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

item_level_issues[]

ProductReviewItemLevelIssue

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

create_time

Timestamp

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

last_update_time

Timestamp

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

ProductReviewDestinationStatus

État de destination de l'état de l'avis sur le produit.

Champs
reporting_context

ReportingContextEnum

Uniquement en sortie. Nom du contexte de création de rapports.

ProductReviewItemLevelIssue

État de l'examen du produit (ItemLevelIssue)

Champs
code

string

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

severity

Severity

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

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

reporting_context

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é

Indique comment le problème affecte la diffusion de l'avis sur le produit.

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