Schéma XML

Cette section décrit le schéma XML utilisé pour le flux de données des avis sur les marchands.

Élément de premier niveau : <feed>

Description

Élément de conteneur de premier niveau qui contient tous les autres éléments du flux.

Attributs

Nom Format Occurrences Description
xmlns xs:string Obligatoire (1) Veuillez coder en dur la valeur suivante :
http://schemas.google.com/merchant_reviews/5.0
xmlns:xsi xs:string Obligatoire (1) Veuillez coder en dur la valeur suivante :
http://www.w3.org/2001/XMLSchema-instance
xsi:schemaLocation xs:string Obligatoire (1) Veuillez coder en dur la valeur suivante, en laissant un seul espace vide entre les URL :
http://schemas.google.com/merchant_reviews/5.0 http://www.gstatic.com/productsearch/static/reviews/5.0/merchant_reviews.xsd

Exemple

<feed xmlns="http://schemas.google.com/merchant_reviews/5.0"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://schemas.google.com/merchant_reviews/5.0 https://www.gstatic.com/productsearch/static/reviews/5.0/merchant_reviews.xsd">

Contient

Nom Format Occurrences Description
merchants       -- Facultatif (0 à 1) Élément conteneur pour les éléments <merchant>.
deleted_merchants       -- Facultatif (0 à 1) Élément conteneur pour les éléments <deleted_merchant>.
reviews       -- Facultatif (0 à 1) Élément conteneur pour les éléments <review>.
deleted_reviews       -- Facultatif (0 à 1) Élément conteneur pour les éléments <deleted_review>.

<merchants>

Description

Conteneur pour les éléments <merchant>.

Contient

Nom Format Occurrences Description
merchant       -- Obligatoire (1 à n) Élément répété pour chaque marchand.

<merchant>

Description

Chaque élément <merchant> contient des informations et des avis pour un marchand.

Attributs

Nom Format Occurrences Description
id Id Obligatoire (1) Doit être unique et stable dans tous les flux. En d'autres termes, si un flux actuel et un flux datant de 90 jours font référence au même marchand, ils doivent avoir le même ID.

Exemple

<merchant id="2739">

Contient

Veuillez inclure les éléments suivants dans l'élément "merchant".

Nom Format Occurrences Description
name NonEmptyString Obligatoire (1) Nom à afficher du marchand, lisible par l'utilisateur.
merchant_url xs:anyURI Obligatoire (1) URL du site Web principal du marchand.
N'utilisez pas d'URL de redirection pour cette valeur. En d'autres termes, la valeur doit pointer directement vers le site du marchand.

Exemple : 

<merchant_url>
  http://store.google.com
</merchant_url>

rating_url xs:anyURI Obligatoire (1) URL de la page de destination qui héberge les avis sur ce marchand.
N'utilisez pas d'URL de redirection.

Exemple : 

<rating_url>
  http://merchant_url.com/reviews/
</rating_url>

create_timestamp DateTimeWithTimeZone Obligatoire (1) Date et heure de création du marchand. Elle ne devrait jamais changer.
last_update_timestamp DateTimeWithTimeZone Obligatoire (1) Date et heure de la dernière mise à jour du marchand. Si l'un des champs de l'élément <merchant> est modifié pour un ID de marchand donné, cette valeur doit également changer.

<deleted_merchants>

Description

Conteneur pour les marchands qui ont été supprimés.

Contient

Nom Format Occurrences Description
deleted_merchant       -- Obligatoire (1 à n) Contient un ou plusieurs éléments liés à un seul marchand supprimé.

<deleted_merchant>

Description

Marchand supprimé.

Attributs

Nom Format Occurrences Description
id Id Obligatoire (1) Spécifie l'ID d'un marchand à supprimer du flux. L'ID doit correspondre à l'attribut id d'un élément <merchant> dans un fichier de flux précédent.

Contient

Nom Format Occurrences Description
last_update_timestamp DateTimeWithTimeZone Obligatoire (1) Date et heure auxquelles un marchand a été supprimé du système.

Exemple : 

<last_update_timestamp>
  2016-04-03T18:37:32Z
</last_update_timestamp>

Exemple

<deleted_merchant id="10">
  <last_update_timestamp>2014-07-12T07:55:06Z</last_update_timestamp>
</deleted_merchant>

<reviews>

Description

Conteneur pour les éléments <review>.

Contient

Nom Format Occurrences Description
review       -- Obligatoire (1 à n) Élément répété pour chaque avis.

<review>

Description

Conteneur d'informations liées à un avis.

Attributs

Nom Format Occurrences Description
id Id Obligatoire (1) Identifiant d'un avis dans votre système. Doit être unique et stable dans tous les flux.

Exemple : 

<review id=132739 mid=1234>

mid Id Obligatoire (1) Identifiant du marchand pour lequel cet avis a été rédigé.

Contient

Veuillez inclure les éléments suivants dans l'élément "review" (avis).

Nom Format Occurrences Description
reviewer_name NonEmptyString Facultatif (0 à 1) Nom à afficher de l'auteur de l'avis, à condition que l'avis doive avoir un auteur nommé. Les avis anonymes ne doivent pas inclure ce champ.

Exemple : 

<reviewer_name>
  Joel
</reviewer_name>

create_timestamp DateTimeWithTimeZone Obligatoire (1) Heure/date à laquelle l'avis a été envoyé par l'utilisateur. Elle ne devrait jamais changer.

Exemple : 

<create_timestamp>
  2016-04-03T18:37:32Z
</create_timestamp>

last_update_timestamp DateTimeWithTimeZone Obligatoire (1) Date et heure de la dernière modification des informations dans l'élément <review>. Si l'un des champs de l'élément <review> est modifié pour un ID d'avis donné, cette valeur doit également changer.

Exemple : 

<last_update_timestamp>
  2016-04-03T18:37:32Z
</last_update_timestamp>

country_code CountryCode Obligatoire (1) Pays de l'auteur de l'avis. Le cas échéant, il s'agit du pays dans lequel le produit a été livré ou le service fourni. Sinon, utilisez le pays dans lequel se trouve l'auteur de l'avis au moment de sa création. Le code pays doit être au format ISO 3166-1 alpha-2.

Exemple : 

  <country_code>
    US
  </country_code>

title xs:string Facultatif (0 à 1) Titre de l'avis. Le titre doit être du texte brut, sans balise HTML.

Exemple : 

  <title>
    Great prices
  </title>

content xs:string Obligatoire (1) Contenu de l'avis. Il doit s'agir d'un texte libre fourni par l'utilisateur, qui ne doit pas être tronqué. Le contenu doit être du texte brut, sans balise HTML. Par exemple, un saut de ligne doit être représenté par un caractère de saut de ligne, et non par une balise <br>. Si plusieurs réponses à différentes questions sont fournies, elles doivent toutes être incluses, avec le contexte minimal pour que les réponses aient un sens. Vous ne devez pas fournir de contexte si des questions sont restées sans réponse.

Exemple : 

  <content>
    I like this store!
    My order arrived on time and I got
    a great price.
  </content>

Exemple : 

  <content>
    Positives: Great prices.
    Suggestions: Selection could be better.
  </content>
ratings           -- Obligatoire (1) Élément conteneur pour les notes attribuées par l'évaluateur au marchand. Si aucune note n'est disponible pour l'élément <overall>, l'intégralité de l'avis associé doit être exclue du flux, car l'élément <overall> est obligatoire et l'avis ne sera pas accepté sans lui.
collection_method CollectionMethodType Obligatoire (1) Méthode utilisée pour collecter l'avis. La valeur doit être l'une des suivantes :
  • non sollicité : 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 l'exécution de sa commande.

Exemple : 

  <collection_method>
    after_fulfillment
  </collection_method>

<ratings>

Description

Contient les notes attribuées par le contributeur au marchand. Si aucune note n'est disponible pour l'élément <overall>, l'intégralité de l'avis associé doit être exclue du flux, car l'élément <overall> est obligatoire et l'avis ne sera pas accepté sans lui.

Contient

Veuillez inclure les éléments suivants dans l'élément "ratings" (notes).

Nom Format Occurrences Description
overall RatingRange Obligatoire (1) Note globale attribuée par l'auteur de l'avis à un marchand.

Exemple : 

  <overall min="1" max="10">9</overall>

customer_service RatingRange Facultatif (0 à 1) Note attribuée par le réviseur à la qualité du service client de ce marchand.

Exemple : 

  <customer_service min="1" max="5">3</customer_service>

<deleted_reviews>

Description

Conteneur pour les avis supprimés.

Contient

Nom Format Occurrences Description
deleted_review       -- Obligatoire (1 à n) Contient un ou plusieurs éléments liés à un seul avis supprimé.

<deleted_review>

Description

Avis supprimé.

Attributs

Nom Format Occurrences Description
id Id Obligatoire (1) Spécifie l'ID d'un avis à supprimer du flux. L'ID doit correspondre à l'attribut id d'un élément <review> dans n'importe quel fichier de flux.

Contient

Nom Format Occurrences Description
last_update_timestamp DateTimeWithTimeZone Obligatoire (1) Heure à laquelle un avis a été supprimé du système.

Exemple : 

  <last_update_timestamp>
    2016-04-03T18:37:32Z
  </last_update_timestamp>

Exemple

<deleted_review id="10">
  <last_update_timestamp>2014-07-12T07:55:06Z<last_update_timestamp>
</deleted_review>