Esquema XML

Esta seção descreve o esquema XML usado para o feed de dados de avaliações do comerciante.

Elemento de nível superior: <feed>

Descrição

O elemento contêiner principal que contém todos os outros elementos no feed.

Atributos

Nome Formato Ocorrências Descrição
xmlns xs:string Obrigatório (1) Codifique o seguinte valor:
http://schemas.google.com/merchant_reviews/5.0
xmlns:xsi xs:string Obrigatório (1) Codifique o seguinte valor:
http://www.w3.org/2001/XMLSchema-instance
xsi:schemaLocation xs:string Obrigatório (1) Codifique o seguinte valor, deixando um único espaço em branco entre os URLs:
http://schemas.google.com/merchant_reviews/5.0 http://www.gstatic.com/productsearch/static/reviews/5.0/merchant_reviews.xsd

Exemplo

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

Contém

Nome Formato Ocorrências Descrição
merchants       -- Opcional (0 a 1) Elemento de contêiner para elementos <merchant>.
deleted_merchants       -- Opcional (0 a 1) Elemento de contêiner para elementos <deleted_merchant>.
reviews       -- Opcional (0 a 1) Elemento de contêiner para elementos <review>.
deleted_reviews       -- Opcional (0 a 1) Elemento de contêiner para elementos <deleted_review>.

<merchants>

Descrição

Contêiner para elementos <merchant>.

Contém

Nome Formato Ocorrências Descrição
merchant       -- Obrigatório (1 a n) Elemento repetido para cada comerciante.

<merchant>

Descrição

Cada elemento <merchant> contém informações e avaliações de um comerciante.

Atributos

Nome Formato Ocorrências Descrição
id ID Obrigatório (1) Precisa ser único e estável em todos os feeds. Em outras palavras, se um feed de hoje e um de 90 dias atrás se referem ao mesmo comerciante, eles precisam ter o mesmo ID.

Exemplo

<merchant id="2739">

Contém

Inclua os seguintes elementos no elemento "merchant".

Nome Formato Ocorrências Descrição
name NonEmptyString Obrigatório (1) Nome de exibição legível para o comerciante.
merchant_url xs:anyURI Obrigatório (1) URL do site principal do comerciante.
Não use um URL de redirecionamento para esse valor. Em outras palavras, o valor precisa apontar diretamente para o site do comerciante.

Exemplo: 

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

rating_url xs:anyURI Obrigatório (1) URL da página de destino que hospeda as avaliações desse comerciante.
Não use um URL de redirecionamento.

Exemplo: 

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

create_timestamp DateTimeWithTimeZone Obrigatório (1) Hora/data em que o comerciante foi criado. Isso nunca deve mudar.
last_update_timestamp DateTimeWithTimeZone Obrigatório (1) Data e hora da última atualização do comerciante. Se algum dos campos no elemento <merchant> for atualizado para um determinado ID do comerciante, esse valor também precisará mudar.

<deleted_merchants>

Descrição

Contêiner para comerciantes que foram excluídos.

Contém

Nome Formato Ocorrências Descrição
deleted_merchant       -- Obrigatório (1 a n) Contém elementos relacionados a um único comerciante excluído.

<deleted_merchant>

Descrição

Comerciante que foi excluído.

Atributos

Nome Formato Ocorrências Descrição
id ID Obrigatório (1) Especifica o ID de um comerciante que deve ser excluído do feed. O ID precisa corresponder ao atributo id de um elemento <merchant> em qualquer arquivo de feed anterior.

Contém

Nome Formato Ocorrências Descrição
last_update_timestamp DateTimeWithTimeZone Obrigatório (1) Data e hora em que um comerciante foi removido do sistema.

Exemplo: 

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

Exemplo

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

<reviews>

Descrição

Contêiner para elementos <review>.

Contém

Nome Formato Ocorrências Descrição
review       -- Obrigatório (1 a n) Elemento repetido para cada avaliação.

<review>

Descrição

Contêiner para detalhes relacionados a uma avaliação.

Atributos

Nome Formato Ocorrências Descrição
id ID Obrigatório (1) O identificador de uma avaliação no seu sistema. Precisa ser único e estável em todos os feeds.

Exemplo: 

<review id=132739 mid=1234>

mid ID Obrigatório (1) O identificador do comerciante a que esta avaliação se refere.

Contém

Inclua os seguintes elementos no elemento de avaliação.

Nome Formato Ocorrências Descrição
reviewer_name NonEmptyString Opcional (0 a 1) Nome de exibição do autor da avaliação, desde que ela tenha um autor nomeado. As avaliações anônimas não devem incluir esse campo.

Exemplo: 

<reviewer_name>
  Joel
</reviewer_name>

create_timestamp DateTimeWithTimeZone Obrigatório (1) Data e hora em que a avaliação foi enviada pelo usuário. Isso nunca deve mudar.

Exemplo: 

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

last_update_timestamp DateTimeWithTimeZone Obrigatório (1) Data/hora em que as informações no elemento <review> foram alteradas pela última vez. Se algum dos campos no elemento <review> for atualizado para um determinado ID de avaliação, esse valor também precisará mudar.

Exemplo: 

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

country_code CountryCode Obrigatório (1) País do avaliador. Se disponível, esse é o país para onde o produto foi enviado ou onde o serviço foi prestado. Caso contrário, use o país em que o avaliador estava no momento em que criou a avaliação. O código do país precisa estar no formato ISO 3166-1 alfa-2.

Exemplo: 

  <country_code>
    US
  </country_code>

title xs:string Opcional (0 a 1) O título da avaliação. O título precisa ser um texto simples, sem tags HTML.

Exemplo: 

  <title>
    Great prices
  </title>

content xs:string Obrigatório (1) O conteúdo da avaliação. Esse texto livre fornecido pelo usuário não pode ser truncado. O conteúdo precisa ser texto simples, sem tags HTML. Por exemplo, uma quebra de linha deve ser representada por um caractere de avanço de linha, não por uma tag <br>. Se forem fornecidas várias respostas a perguntas diferentes, todas elas deverão ser incluídas, com o contexto mínimo para que façam sentido. O contexto não deve ser fornecido se houver perguntas sem resposta.

Exemplo: 

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

Exemplo: 

  <content>
    Positives: Great prices.
    Suggestions: Selection could be better.
  </content>
ratings           -- Obrigatório (1) Elemento contêiner para as classificações do comerciante feitas pelo avaliador. Se não houver uma classificação disponível para o elemento <overall>, toda a avaliação associada deverá ser excluída do feed, porque o elemento <overall> é obrigatório e a avaliação não será aceita sem ele.
collection_method CollectionMethodType Obrigatório (1) O método usado para coletar a avaliação. O valor precisa ser um dos seguintes:
  • não solicitada: o usuário não estava respondendo a uma solicitação específica quando enviou a avaliação.
  • point_of_sale: o usuário enviou a avaliação em resposta a uma solicitação quando fez um pedido.
  • after_fulfillment: o usuário enviou a avaliação em resposta a uma solicitação após o atendimento do pedido.

Exemplo: 

  <collection_method>
    after_fulfillment
  </collection_method>

<ratings>

Descrição

Contém as classificações do comerciante feitas pelo avaliador. Se não houver uma classificação disponível para o elemento <overall>, toda a avaliação associada deverá ser excluída do feed, porque o elemento <overall> é obrigatório e a avaliação não será aceita sem ele.

Contém

Inclua os seguintes elementos no elemento "ratings".

Nome Formato Ocorrências Descrição
overall RatingRange Obrigatório (1) Classificação geral de um comerciante feita por um avaliador.

Exemplo: 

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

customer_service RatingRange Opcional (0 a 1) Classificação do revisor sobre a qualidade do atendimento ao cliente para este comerciante.

Exemplo: 

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

<deleted_reviews>

Descrição

Contêiner para avaliações excluídas.

Contém

Nome Formato Ocorrências Descrição
deleted_review       -- Obrigatório (1 a n) Contém elementos relacionados a uma única avaliação excluída.

<deleted_review>

Descrição

Avaliação excluída.

Atributos

Nome Formato Ocorrências Descrição
id ID Obrigatório (1) Especifica o ID de uma avaliação que deve ser excluída do feed. O ID precisa corresponder ao atributo id de um elemento <review> em qualquer arquivo de feed.

Contém

Nome Formato Ocorrências Descrição
last_update_timestamp DateTimeWithTimeZone Obrigatório (1) Horário em que uma avaliação foi removida do sistema.

Exemplo: 

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

Exemplo

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