Referência do esquema XML

O esquema XML para feeds de avaliações de produtos do Google define a estrutura aceitável do seu feed XML. Os esquemas XML usam a extensão de arquivo .xsd. Assim como os arquivos DTD, um esquema XML define os elementos e atributos que podem aparecer em um documento XML.

Saiba mais sobre esquemas XML neste Guia de conceitos básicos de esquema XML.

O esquema XML para feeds de avaliações de produtos está publicado aqui: http://www.google.com/shopping/reviews/schema/product/2.4/product_reviews.xsd

Confira a seguir uma descrição da estrutura do feed definida por esse esquema. Nesta descrição, os nomes de tipo com o prefixo xs: se referem a tipos de esquema XML integrados que estão no namespace XML http://www.w3.org/2001/XMLSchema.

Nosso sistema sempre espera um feed completo. Todas as avaliações enviadas anteriormente, mas não incluídas no próximo feed completo, serão excluídas. Portanto, sempre envie todas as suas avaliações ao enviar o feed.

Elemento <feed> de nível superior

O elemento <feed> contém estes elementos na ordem listada.

Elemento Ocorrência Tipo Descrição
<version> Obrigatório (1) xs:string Indica qual versão do esquema de feed de avaliações de produtos está sendo usada. No momento, só há suporte para <version>2.4</version>.
<aggregator> Opcional (1) aggregatorType Um editor pode usar um agregador de avaliações para gerenciar as avaliações e fornecer os feeds. Esse elemento indica o uso de um agregador e contém informações sobre ele.
<publisher> Obrigatório (1) publisherType As informações sobre o editor, que pode ser um varejista, fabricante, empresa de serviços de avaliações ou qualquer entidade que publique avaliações de produtos.
<reviews> Opcional (1) xs:sequence Contém as avaliações de produtos.

O <feed> define restrições de exclusividade nos elementos usados no feed.

Elementos filhos

<aggregator>

Um publisher pode usar um agregador de avaliações para gerenciar as avaliações e fornecer os feeds. Esse elemento indica o uso de um agregador e contém informações sobre ele. O elemento <aggregator> contém estes elementos na ordem listada.

Elemento Ocorrência Tipo Descrição
<name> Obrigatório (1) nonEmptyStringType O nome do agregador das avaliações do produto.

<publisher>

As informações sobre o editor, que pode ser um varejista, fabricante, empresa de serviços de avaliação ou qualquer entidade que publique avaliações de produtos.O elemento <publisher> contém esses elementos na ordem listada.

Elemento Ocorrência Tipo Descrição
<name> Obrigatório (1) nonEmptyStringType O nome do editor das avaliações do produto.
<favicon> Opcional (1) httpUrlType Um link para o favicon da empresa do editor. As dimensões da imagem precisam ser de 16 x 16 pixels. O formato da imagem precisa ser GIF, JPG ou PNG.

<reviews>

Contém as avaliações do produto. O elemento <reviews> contém esses elementos na ordem listada.

Elemento Ocorrência Tipo Descrição
<review> Obrigatório (1-ilimitado) reviewType Uma avaliação de produto exclusiva. Se uma avaliação se referir a vários produtos no inventário do editor, especifique a avaliação uma vez e inclua vários elementos <product> no elemento <products>.

<review>

Uma avaliação de produto exclusiva. Se uma avaliação se referir a vários produtos no inventário do editor, especifique a avaliação uma vez e inclua vários elementos <product> no elemento <products>.O elemento <review> contém esses elementos na ordem listada.

Elemento Ocorrência Tipo Descrição
<review_id> Obrigatório (1) nonEmptyStringType O identificador permanente e exclusivo da avaliação do produto no sistema do editor.
<reviewer> Obrigatório (1) reviewerType O autor da avaliação do produto.
<is_verified_purchase> Opcional (1) xs:boolean Indica se foi verificado que o avaliador comprou o produto.
<is_incentivized_review> Opcional (1) xs:boolean Indica se o avaliador recebeu incentivo para avaliar o produto.
<review_timestamp> Obrigatório (1) xs:dateTime

O carimbo de data/hora que indica quando a avaliação foi escrita.

Exemplos:

2014-04-21T11:07:07-06:00
2014-04-21T18:00:00+01:00
2014-04-21T00:00:00Z
<title> Opcional (1) nonEmptyStringType O título da avaliação.
<content> Obrigatório (1) nonEmptyStringType O conteúdo da avaliação.
<review_language> Opcional (1) xs:string O idioma da avaliação (BCP 47).
<review_country> Opcional (1) xs:string O código do país (ISO 3166-1) do avaliador.
<pros> Opcional (1) xs:sequence Contém os prós com base na opinião do revisor. Omita textos padrão, como "prós:", a menos que tenham sido escritos pelo avaliador.
<cons> Opcional (1) xs:sequence Contém os contras com base na opinião do revisor. Omita textos padrão, como "con:", a menos que tenham sido escritos pelo avaliador.
<reviewer_images> Opcional (1) xs:sequence Contém links para imagens do produto fornecidas pelo avaliador.
<review_url> Obrigatório (1) reviewUrlType O URL da página de destino da avaliação.
<ratings> Obrigatório (1) xs:sequence Contém as classificações associadas à avaliação.
<products> Obrigatório (1) xs:sequence Contém os produtos associados à avaliação.
<is_spam> Opcional (1) xs:boolean Indica se a avaliação foi marcada como spam no sistema do editor.
<collection_method> Opcional (1) collectionMethodType

O método usado para coletar a avaliação. O valor precisa ser um dos seguintes:

unsolicited
O usuário não estava respondendo a uma solicitação específica quando enviou a avaliação.
post_fulfillment
O usuário enviou a avaliação em resposta a uma solicitação após o atendimento do pedido.
<transaction_id> Opcional (1) nonEmptyStringType Um identificador exclusivo e permanente da transação associada à avaliação no sistema do editor. Esse ID pode ser usado para indicar que várias avaliações estão associadas à mesma transação.

<reviewer>

O autor da avaliação do produto. O elemento <reviewer> contém estes elementos na ordem listada.

Elemento Ocorrência Tipo Descrição
<name> Obrigatório (1) reviewerNameType

O nome do autor da avaliação.

Exemplo:

<name>Jane</name>
<reviewer_id> Opcional (1) nonEmptyStringType

Um identificador permanente e exclusivo do autor da avaliação no sistema do editor.

Exemplo:

<reviewer_id>14295</reviewer_id>

<name>

O nome do autor da avaliação. O elemento <name> é uma extensão do nonEmptyStringType e contém o nome ou alias do avaliador. O elemento <name> contém estes atributos.

Atributo Ocorrência Tipo Descrição
is_anonymous Opcional xs:boolean

Indica se o avaliador é anônimo.

Exemplo:

<name is_anonymous="true">Anonymous</name>

<pros>

Contém os prós com base na opinião do revisor. O elemento <pros> contém estes elementos na ordem listada.

Elemento Ocorrência Tipo Descrição
<pro> Obrigatório (1-ilimitado) nonEmptyStringType

Um ponto positivo individual com base na opinião do avaliador. Os prós precisam ser listados na mesma ordem em que aparecem. Omita textos padrão, como "prós:", a menos que tenham sido escritos pelo avaliador.

Exemplo:

<pros>
  <pro>Sleek design</pro>
</pros>

<cons>

Contém os contras com base na opinião do revisor. O elemento <cons> contém estes elementos na ordem listada.

Elemento Ocorrência Tipo Descrição
<con> Obrigatório (1-ilimitado) nonEmptyStringType

Um ponto negativo individual com base na opinião do avaliador. Os contras precisam ser listados na mesma ordem em que aparecem. Omita textos padrão, como "con:", a menos que tenham sido escritos pelo avaliador.

Exemplo:

<cons>
  <con>Pricey</con>
</cons>

<review_url>

O URL da página de destino da avaliação. O elemento <review_url> é uma extensão do httpUrlType e contém o link para a página de destino da avaliação. O elemento <review_url> contém estes atributos.

Atributo Ocorrência Tipo Descrição
type Obrigatório xs:string

O tipo precisa ser um dos seguintes:

singleton
A página de avaliação contém apenas essa avaliação.
group
A página de avaliações contém um grupo de avaliações, incluindo esta.

Exemplo:

<review_url type="singleton">http://www.example.com/review_5.html</review_url>

<reviewer_images>

Contém imagens do produto fornecidas pelo avaliador. A tag <reviewer_images> contém muitos elementos <reviewer_image>.

Elemento Ocorrência Tipo Descrição
<reviewer_image> Obrigatório (1-ilimitado) reviewImageType

Uma imagem do produto avaliado criada pelo autor da avaliação.

<reviewer_image>

Um único elemento de imagem de avaliação.

Elemento Ocorrência Tipo Descrição
<url> Obrigatório (1) httpUrlType

Um URL para uma imagem do produto avaliado criada pelo autor da avaliação. O URL não precisa terminar com uma extensão de arquivo de imagem.

Exemplo:

<reviewer_images>
  <reviewer_image>
    <url>https://example.com/test.jpg</url>
  </reviewer_image>
  <reviewer_image>
    <url>https://example.com/test.gif</url>
  </reviewer_image>
</reviewer_images>

<ratings>

Contém as classificações associadas à avaliação. O elemento <ratings> contém estes elementos na ordem listada.

Elemento Ocorrência Tipo Descrição
<overall> Obrigatório (1) ratingType A classificação geral do produto feita pelo avaliador.

<overall>

A classificação geral do produto feita pelo avaliador. O elemento <overall> estende um xs:decimal simpleType e captura a classificação atribuída pelo autor da avaliação. O valor precisa estar dentro do intervalo inclusivo definido pelos atributos min e max. O elemento <overall> contém estes atributos.

Atributo Ocorrência Tipo Descrição
min Obrigatório xs:integer O menor número possível para a classificação. Esse valor precisa ser a pior classificação possível e não pode ser um valor para nenhuma classificação.
max Obrigatório xs:integer O número máximo possível para a classificação. O valor do atributo max precisa ser maior que o valor do atributo min.

<products>

Contém os produtos associados à avaliação. O elemento <products> contém estes elementos na ordem listada.

Elemento Ocorrência Tipo Descrição
<product> Obrigatório (1-ilimitado) productType Um produto associado à avaliação.

<product>

Um produto associado à avaliação. O elemento <product> contém estes elementos na ordem listada.

Elemento Ocorrência Tipo Descrição
<product_ids> Opcional (1) productIdsType Os identificadores associados a um produto.
<product_name> Opcional (1) nonEmptyStringType Nome descritivo de um produto.
<product_url> Obrigatório (1) httpUrlType O URL do produto. Esse URL pode ter o mesmo valor do elemento <review_url> se os URLs da avaliação e do produto forem iguais.

<product_ids>

Os identificadores associados a um produto. O elemento <product_ids> contém estes elementos na ordem listada.

Elemento Ocorrência Tipo Descrição
<gtins> Obrigatório para todas as avaliações associadas a produtos com um GTIN conhecido.

Opcional para todas as outras avaliações. (1)		 gtinsType Contém GTINs (números globais de item comercial) associados a um produto. Subtipos de GTINs (por exemplo, UPC, EAN, ISBN, JAN) são aceitos.
<mpns> Obrigatório para todas as avaliações associadas a produtos com um MPN conhecido.

Opcional para todas as outras avaliações. (1)		 mpnsType Contém MPNs (números de peça do fabricante) associados a um produto.
<skus> Obrigatório para todas as avaliações associadas a produtos com um SKU conhecido

Opcional para todas as outras avaliações (1)		 skusType Contém SKUs (unidades de manutenção de estoque) associadas a um produto. Muitas vezes, ele corresponde ao ID da oferta de produto no feed de produtos.
<brands> Obrigatório para todas as avaliações associadas a produtos com uma marca conhecida

Opcional para todas as outras avaliações (1)		 brandsType Contém nomes de marcas associados a um produto.
<asins> Opcional (1) asinsType Contém ASINs (Amazon Standard Identification Numbers) associados a um produto.

<gtins>

Contém GTINs (números globais de item comercial) associados a um produto. O elemento <gtins> contém estes elementos na ordem listada.

Elemento Ocorrência Tipo Descrição
<gtin> Obrigatório (1-ilimitado) nonEmptyStringType O número global do item comercial do produto. Subtipos de GTINs (por exemplo, UPC, EAN, ISBN, JAN) são aceitos.

<mpns>

Contém MPNs (números de peça do fabricante) associados a um produto. O elemento <mpns> contém estes elementos na ordem listada.

Elemento Ocorrência Tipo Descrição
<mpn> Obrigatório (1-ilimitado) nonEmptyStringType O número de peça do fabricante do produto.

<skus>

Contém SKUs (unidades de manutenção de estoque) associadas a um produto. O elemento <skus> contém estes elementos na ordem listada.

Elemento Ocorrência Tipo Descrição
<sku> Obrigatório (1-ilimitado) nonEmptyStringType A unidade de manutenção de estoque do produto no inventário do editor.

<brands>

Contém nomes de marcas associados a um produto. O elemento <brands> contém estes elementos na ordem listada.

Elemento Ocorrência Tipo Descrição
<brand> Obrigatório (1-ilimitado) nonEmptyStringType O nome da marca do produto.

<asins>

Contém ASINs (Amazon Standard Identification Numbers) associados a um produto. O elemento <asins> contém estes elementos na ordem listada.

Elemento Ocorrência Tipo Descrição
<asin> Obrigatório (1-ilimitado) nonEmptyStringType O número de identificação padrão da Amazon do produto. Cada ASIN tem 10 caracteres alfanuméricos.