Esquema XML

En esta sección, se describe el esquema XML que se usa para el feed de datos de opiniones sobre comercios.

Elemento de nivel superior: <feed>

Descripción

Es el elemento contenedor de nivel superior que incluye todos los demás elementos del feed.

Atributos

Nombre Formato Casos Descripción
xmlns xs:string Obligatorio (1) Codifica de forma rígida el siguiente valor:
http://schemas.google.com/merchant_reviews/5.0
xmlns:xsi xs:string Obligatorio (1) Codifica de forma rígida el siguiente valor:
http://www.w3.org/2001/XMLSchema-instance
xsi:schemaLocation xs:string Obligatorio (1) Codifica de forma rígida el siguiente valor y deja un solo espacio en blanco entre las URLs:
http://schemas.google.com/merchant_reviews/5.0 http://www.gstatic.com/productsearch/static/reviews/5.0/merchant_reviews.xsd

Ejemplo

<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">

Contiene

Nombre Formato Casos Descripción
merchants       -- Opcional (0-1) Elemento contenedor para elementos <merchant>.
deleted_merchants       -- Opcional (0-1) Elemento contenedor para elementos <deleted_merchant>.
reviews       -- Opcional (0-1) Elemento contenedor para elementos <review>.
deleted_reviews       -- Opcional (0-1) Elemento contenedor para elementos <deleted_review>.

<merchants>

Descripción

Contenedor para elementos <merchant>.

Contiene

Nombre Formato Casos Descripción
merchant       -- Obligatorio (de 1 a n) Elemento que se repite para cada comercio.

<merchant>

Descripción

Cada elemento <merchant> contiene información y opiniones sobre un comercio.

Atributos

Nombre Formato Casos Descripción
id Id Obligatorio (1) Debe ser único y estable en todos los feeds. En otras palabras, si un feed de hoy y un feed de hace 90 días hacen referencia al mismo comercio, deben tener el mismo ID.

Ejemplo

<merchant id="2739">

Contiene

Incluye los siguientes elementos dentro del elemento merchant.

Nombre Formato Casos Descripción
name NonEmptyString Obligatorio (1) Nombre visible del comercio legible por humanos.
merchant_url xs:anyURI Obligatorio (1) Es la URL del sitio web principal del comercio.
No uses una URL de redireccionamiento para este valor. En otras palabras, el valor debe apuntar directamente al sitio del comercio.

Ejemplo:

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

rating_url xs:anyURI Obligatorio (1) Es la URL de la página de destino que aloja las opiniones sobre este comercio.
No uses una URL de redireccionamiento.

Ejemplo:

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

create_timestamp DateTimeWithTimeZone Obligatorio (1) Fecha y hora en que se creó el comercio. Esta información nunca debería cambiar.
last_update_timestamp DateTimeWithTimeZone Obligatorio (1) Fecha y hora en que se actualizó el comercio por última vez. Si se actualiza alguno de los campos del elemento <merchant> para un ID de comercio determinado, también debe cambiar este valor.

<deleted_merchants>

Descripción

Es un contenedor para los comercios que se borraron.

Contiene

Nombre Formato Casos Descripción
deleted_merchant       -- Obligatorio (de 1 a n) Contiene elementos relacionados con un solo comercio borrado.

<deleted_merchant>

Descripción

Es el comercio que se borró.

Atributos

Nombre Formato Casos Descripción
id Id Obligatorio (1) Especifica el ID de un comercio que se debe borrar del feed. El ID debe coincidir con el atributo id de un elemento <merchant> en cualquier archivo de feed anterior.

Contiene

Nombre Formato Casos Descripción
last_update_timestamp DateTimeWithTimeZone Obligatorio (1) Fecha y hora en que se quitó un comercio del sistema.

Ejemplo:

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

Ejemplo

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

<reviews>

Descripción

Contenedor para elementos <review>.

Contiene

Nombre Formato Casos Descripción
review       -- Obligatorio (de 1 a n) Elemento que se repite para cada opinión.

<review>

Descripción

Es un contenedor para los detalles relacionados con una revisión.

Atributos

Nombre Formato Casos Descripción
id Id Obligatorio (1) Es el identificador de una opinión en tu sistema. Debe ser único y estable en todos los feeds.

Ejemplo:

<review id=132739 mid=1234>

mid Id Obligatorio (1) Es el identificador del comercio para el que se escribió esta opinión.

Contiene

Incluye los siguientes elementos dentro del elemento de revisión.

Nombre Formato Casos Descripción
reviewer_name NonEmptyString Opcional (0-1) Es el nombre visible del autor de la opinión, siempre que la opinión deba tener un autor con nombre. Las opiniones anónimas no deben incluir este campo.

Ejemplo:

<reviewer_name>
  Joel
</reviewer_name>

create_timestamp DateTimeWithTimeZone Obligatorio (1) Fecha y hora en que el usuario envió la opinión. Esta información nunca debería cambiar.

Ejemplo:

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

last_update_timestamp DateTimeWithTimeZone Obligatorio (1) Fecha y hora en que cambió por última vez la información del elemento <review>. Si se actualiza alguno de los campos del elemento <review> para un ID de revisión determinado, este valor también debe cambiar.

Ejemplo:

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

country_code CountryCode Obligatorio (1) País del usuario que deja la opinión. Si está disponible, este es el país al que se envió el producto o en el que se prestó el servicio. De lo contrario, usa el país en el que se encontraba el revisor cuando creó la opinión. El código de país debe estar en formato ISO 3166-1 alpha-2.

Ejemplo:

  <country_code>
    US
  </country_code>

title xs:string Opcional (0-1) Es el título de la opinión. El título debe ser texto sin formato, sin etiquetas HTML.

Ejemplo:

  <title>
    Great prices
  </title>

content xs:string Obligatorio (1) Es el contenido de la opinión. Debe ser cualquier texto de formato libre proporcionado por el usuario y no debe truncarse. El contenido debe ser texto sin formato y no debe contener etiquetas HTML. Por ejemplo, un salto de línea se debe representar con un carácter de avance de línea, no con una etiqueta <br>. Si se proporcionan varias respuestas a diferentes preguntas, se deben incluir todas las respuestas, con el contexto mínimo para que tengan sentido. No se debe proporcionar contexto si quedaron preguntas sin responder.

Ejemplo:

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

Ejemplo:

  <content>
    Positives: Great prices.
    Suggestions: Selection could be better.
  </content>
ratings           -- Obligatorio (1) Es el elemento contenedor de las calificaciones del comercio por parte del revisor. Si no hay una calificación disponible para el elemento <overall>, se debe excluir toda la opinión asociada del feed, ya que el elemento <overall> es obligatorio y la opinión no se aceptará sin él.
collection_method CollectionMethodType Obligatorio (1) Es el método que se usó para recopilar la opinión. El valor debe ser uno de los siguientes:
  • no solicitada: El usuario no respondió a una solicitud específica cuando envió la opinión.
  • point_of_sale: El usuario envió la opinión en respuesta a una solicitud cuando realizó un pedido.
  • after_fulfillment: El usuario envió la opinión en respuesta a una solicitud después de la entrega del pedido del usuario.

Ejemplo:

  <collection_method>
    after_fulfillment
  </collection_method>

<ratings>

Descripción

Contiene las calificaciones del comercio que otorgó el usuario. Si no hay una calificación disponible para el elemento <overall>, se debe excluir toda la opinión asociada del feed, ya que el elemento <overall> es obligatorio y la opinión no se aceptará sin él.

Contiene

Incluye los siguientes elementos dentro del elemento de calificaciones.

Nombre Formato Casos Descripción
overall RatingRange Obligatorio (1) Es la calificación general que le otorga el revisor a un comercio.

Ejemplo:

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

customer_service RatingRange Opcional (0-1) Es la calificación del revisor sobre la calidad del servicio al cliente de este comercio.

Ejemplo:

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

<deleted_reviews>

Descripción

Es un contenedor para las opiniones que se borraron.

Contiene

Nombre Formato Casos Descripción
deleted_review       -- Obligatorio (de 1 a n) Contiene elementos relacionados con una sola opinión borrada.

<deleted_review>

Descripción

Es la opinión que se borró.

Atributos

Nombre Formato Casos Descripción
id Id Obligatorio (1) Especifica el ID de una opinión que se debe borrar del feed. El ID debe coincidir con el atributo id de un elemento <review> en cualquier archivo de feed.

Contiene

Nombre Formato Casos Descripción
last_update_timestamp DateTimeWithTimeZone Obligatorio (1) Fecha y hora en que se quitó una opinión del sistema.

Ejemplo:

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

Ejemplo

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