Referência do esquema XML

Livro: /product-review-feeds/_book.yaml

Título: Referência do esquema XML

O esquema XML dos feeds de avaliação 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 Primer de esquema XML.

Veja o esquema XML dos feeds de avaliações do produto aqui: http://www.google.com/shopping/reviews/schema/product/2.3/product_reviews.xsd

Veja a seguir uma descrição da estrutura do feed definida por este esquema. Nesta descrição, os nomes de tipo com o prefixo xs: se referem aos 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 que não estiverem incluídas no próximo feed serão excluídas. Por isso, sempre envie todas as suas avaliações ao enviar o feed.

Elemento <feed> de nível superior

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

Elemento Ocorrência Tipo Descrição
<version> Obrigatório (1) xs:string Indica qual versão do esquema do feed de avaliações do produto está sendo usada. No momento, apenas <version>2.3</version> é compatível.
<aggregator> Opcional (1) aggregatorType Um editor pode usar um agregador de avaliações para gerenciar 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 São informações sobre o editor, que podem ser um varejista, um fabricante, uma 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 do produto.

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

Elementos filhos

<aggregator>

Um editor pode usar um agregador de avaliações para gerenciar 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 esses 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>

São informações sobre o editor, que podem ser um varejista, um fabricante, uma empresa de serviços de avaliações 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 devem ser do tamanho de favicon: 16 x 16 pixels. O formato da imagem deve 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 (ilimitado) reviewType Uma avaliação exclusiva de um produto. Se uma avaliação pertence a vários produtos no inventário do editor, especifique-a uma vez e inclua vários elementos <product> no elemento <products>.

<review>

Uma avaliação exclusiva de um produto. Se uma avaliação pertencer a vários produtos no inventário do editor, especifique-a 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> Opcional (1) nonEmptyStringType É o identificador exclusivo e permanente para a avaliação do produto no sistema do editor.
<reviewer> Obrigatório (1) reviewerType É o autor da avaliação do 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 Conteúdo da avaliação.
<pros> Opcional (1) xs:sequence Contém os prós, com base na opinião do avaliador. Omita texto boilerplate como "pro:" a menos que ele tenha sido escrito pelo revisor.
<cons> Opcional (1) xs:sequence Contém os contras com base na opinião do avaliador. Omita texto boilerplate como "con:" a menos que tenha sido escrito pelo revisor.
<reviewer_images> Opcional (1) xs:sequence Contém links para imagens do produto fornecido pelo revisor.
<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 é 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 destes:

unsolicited
O usuário não respondeu 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 do usuário.
<transaction_id> Opcional (1) nonEmptyStringType Um identificador permanente e exclusivo para a 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 esses 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 o alias do avaliador. O elemento <name> contém esses 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 avaliador. O elemento <pros> contém esses elementos na ordem listada.

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

Um profissional com base na opinião do avaliador Os profissionais devem ser listados na mesma ordem em que são exibidos. Omita texto boilerplate como "pro:" a menos que tenha sido escrito pelo revisor.

Exemplo:

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

<cons>

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

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

Um problema individual com base na opinião do avaliador. Os contras precisam ser listados na mesma ordem em que são exibidos. Omita texto boilerplate como "con:" a menos que tenha sido escrito pelo revisor.

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 esses atributos.

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

O tipo precisa ser um dos seguintes:

singleton
A página da avaliação contém apenas essa avaliação.
group
A página contém uma série de avaliações, incluindo esta avaliação.

Exemplo:

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

<reviewer_images>

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

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

Uma imagem do produto avaliado criado 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 criado 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 esses elementos na ordem listada.

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

<overall>

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

Atributo Ocorrência Tipo Descrição
min Obrigatório xs:integer O número mínimo possível de classificação. Essa precisa ser a pior avaliaçã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 de 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 esses elementos na ordem listada.

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

<product>

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

Elemento Ocorrência Tipo Descrição
<product_ids> Opcional (1) productIdsType 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 poderá ter o mesmo valor do elemento <review_url> se o URL da avaliação e do produto forem iguais.

<product_ids>

Identificadores associados a um produto. O elemento <product_ids> contém esses 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 para permitir a correspondência completa de avaliações)

Opcional (altamente recomendado) para todas as outras avaliações (1)		 gtinsType Contém GTINs (números globais de itens comerciais) associados a um produto.
<mpns> Obrigatório (selecione o MPN para facilitar a correspondência de avaliação caso o produto associado à avaliação não tenha um GTIN atribuído. Precisa ser enviado com a marca.

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 (inclua a SKU para facilitar a correspondência da avaliação se o produto associado à avaliação não tiver um GTIN ou um MPN atribuído. Deve ser enviado com a marca)

Opcional para todas as outras avaliações (1)		 skusType Contém SKUs (unidades de manutenção de estoque) associadas a um produto. Geralmente, isso corresponde ao ID da oferta do produto no feed de produtos.
<brands> Obrigatório (a marca deve ser incluída para facilitar a correspondência de avaliação se o produto associado à avaliação não tiver um GTIN atribuído. Precisa ser enviado com MPN)

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 (números de identificação padrão da Amazon) associados a um produto.

<gtins>

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

Elemento Ocorrência Tipo Descrição
<gtin> Obrigatório (ilimitado) nonEmptyStringType O número de item de comércio global do produto.

<mpns>

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

Elemento Ocorrência Tipo Descrição
<mpn> Obrigatório (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 esses elementos na ordem listada.

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

<brands>

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

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

<asins>

Contém ASINs (números de identificação padrão da Amazon) associados a um produto. O elemento contém esses elementos na ordem listada.

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