Dokumentacja schematu XML

Książka: /product-review-feeds/_book.yaml

Title: Opis schematu XML

Schemat XML dla plików danych z opiniami o produktach Google określa dopuszczalną strukturę pliku XML. Schematy XML korzystają z rozszerzenia pliku .xsd. Podobnie jak pliki DTD, schemat XML definiuje elementy i atrybuty, które mogą występować w dokumencie XML.

Więcej informacji o schematach XML znajdziesz w tym artykule dotyczącym schematu XML.

Schemat XML dla plików danych z opiniami o produktach znajdziesz tutaj: http://www.google.com/shopping/reviews/schema/product/2.3/product_reviews.xsd

Poniżej znajdziesz opis struktury pliku danych zdefiniowanej przez ten schemat. W tym opisie nazwy typów z prefiksem xs: odnoszą się do wbudowanych typów schematów XML, które znajdują się w przestrzeni nazw XML http://www.w3.org/2001/XMLSchema.

Nasz system zawsze czeka na pełny plik danych. Wszystkie wcześniejsze opinie, które nie zostaną uwzględnione w następnym pełnym pliku danych, zostaną usunięte. Dlatego podczas przesyłania pliku danych zawsze przesyłaj wszystkie opinie.

Element <feed> najwyższego poziomu

Element <feed> zawiera te elementy w określonej kolejności.

Element Wystąpienie Typ Opis
<version> Wymagane (1) xs:string Wskazuje, która wersja schematu pliku danych z opiniami o produktach jest używana. Obecnie obsługiwany jest tylko typ <version>2.3</version>.
<aggregator> Opcjonalnie (1) aggregatorType Wydawca może zarządzać agregacjami opinii i udostępniać im pliki danych za pomocą agregatora opinii. Ten element pokazuje użycie agregatora i zawiera informacje o tym agregatorze.
<publisher> Wymagane (1) publisherType Informacje o wydawcy, czyli np. sprzedawca, producent, firma oferująca opinie lub dowolny podmiot, który publikuje opinie o produktach.
<reviews> Opcjonalnie (1) xs:sequence Zawiera opinie o produktach.

Pole <feed> określa ograniczenia niepowtarzalności elementów używanych w pliku danych.

Elementy podrzędne

<aggregator>

Wydawca może zarządzać agregacjami opinii i udostępniać im pliki danych za pomocą agregatora opinii. Ten element opisuje użycie agregatora i zawiera informacje o agregatorze. Element <aggregator> zawiera te elementy w określonej kolejności.

Element Wystąpienie Typ Opis
<name> Wymagany (1) nonEmptyStringType Nazwa agregatora opinii o produktach.

<publisher>

Informacje o wydawcy, np. sprzedawca, producent, firma świadcząca usługi opinii lub dowolny podmiot, który publikuje opinie o produktach. Element <publisher> zawiera te elementy w podanej kolejności.

Element Wystąpienie Typ Opis
<name> Wymagany (1) nonEmptyStringType Nazwa wydawcy opinii o produktach.
<favicon> Opcjonalnie (1) httpUrlType Link do favikony firmy wydawcy. Rozmiar obrazu powinien wynosić 16 x 16 pikseli. Powinien mieć format GIF, JPG lub PNG.

<reviews>

Zawiera opinie o produktach. Element <reviews> zawiera te elementy w określonej kolejności.

Element Wystąpienie Typ Opis
<review> Wymagane (1 miejsce) reviewType Indywidualna opinia o produkcie. Jeśli opinia dotyczy wielu produktów w zasobach reklamowych wydawcy, należy ją określić raz i umieścić w elemencie <products> wiele elementów <product>.

<review>

Indywidualna opinia o produkcie. Jeśli opinia dotyczy wielu produktów w zasobach reklamowych wydawcy, określ ją raz i uwzględnij w elemencie <products> wiele elementów <product>.Element <review> zawiera te elementy w podanej kolejności.

Element Wystąpienie Typ Opis
<review_id> Opcjonalnie (1) nonEmptyStringType Stały, unikalny identyfikator opinii o produkcie w systemie wydawcy.
<reviewer> Wymagany (1) reviewerType Autor opinii o produkcie.
<review_timestamp> Wymagany (1) xs:dateTime

Sygnatura czasowa wskazująca, kiedy opinia została napisana.

Przykłady:

2014-04-21T11:07:07-06:00
2014-04-21T18:00:00+01:00
2014-04-21T00:00:00Z
<title> Opcjonalnie (1) nonEmptyStringType Tytuł opinii.
<content> Wymagany (1) nonEmptyStringType Treść opinii.
<pros> Opcjonalnie (1) xs:sequence Zawiera opinie specjalistów na podstawie opinii recenzenta. Pomiń schematyczny tekst, taki jak "pro:" chyba że został napisany przez recenzenta.
<cons> Opcjonalnie (1) xs:sequence Zawiera wady wynikające z opinii recenzenta. Pomiń schematyczny tekst, taki jak "con:" chyba że został napisany przez recenzenta.
<reviewer_images> Opcjonalnie (1) xs:sequence Zawiera linki do zdjęć produktu przekazanych przez recenzenta.
<review_url> Wymagany (1) reviewUrlType Adres URL strony docelowej opinii.
<ratings> Wymagany (1) xs:sequence Zawiera oceny powiązane z opinią.
<products> Wymagany (1) xs:sequence Zawiera produkty powiązane z opinią.
<is_spam> Opcjonalnie (1) xs:boolean Wskazuje, czy opinia jest oznaczona w systemie wydawcy jako spam.
<collection_method> Opcjonalnie (1) collectionMethodType

Metoda użyta do zebrania opinii. Musi mieć jedną z tych wartości:

unsolicited
Użytkownik nie przesłał konkretnej odpowiedzi na prośbę o opinię.
post_fulfillment
Użytkownik przesłał opinię w odpowiedzi na zapytanie po realizacji zamówienia użytkownika.
<transaction_id> Opcjonalnie (1) nonEmptyStringType Stały, unikalny identyfikator transakcji powiązanej z opinią w systemie wydawcy. Ten identyfikator może służyć do wskazania, że z tą samą transakcją jest powiązanych wiele opinii.

<reviewer>

Autor opinii o produkcie. Element <reviewer> zawiera te elementy w określonej kolejności.

Element Wystąpienie Typ Opis
<name> Wymagany (1) reviewerNameType

Imię i nazwisko autora opinii.

Przykład:

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

Stały, unikalny identyfikator autora opinii w systemie wydawcy.

Przykład:

<reviewer_id>14295</reviewer_id>

<name>

Imię i nazwisko autora opinii. Element <name> jest rozszerzeniem elementu nonEmptyStringType i zawiera imię lub alias autora opinii. Element <name> zawiera te atrybuty.

Atrybut Wystąpienie Typ Opis
is_anonymous Opcjonalny xs:boolean

Wskazuje, czy autor opinii jest anonimowy.

Przykład:

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

<pros>

Zawiera opinie specjalistów na podstawie opinii recenzenta. Element <pros> zawiera te elementy w określonej kolejności.

Element Wystąpienie Typ Opis
<pro> Wymagane (1 miejsce) nonEmptyStringType

Pojedynczy specjalista na podstawie opinii recenzenta. Dostawcy powinni znajdować się w tej samej kolejności, w jakiej są wyświetlani. Pomiń schematyczny tekst, np. "pro:" chyba że został napisany przez recenzenta.

Przykład:

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

<cons>

Zawiera wady wynikające z opinii recenzenta. Element <cons> zawiera te elementy w określonej kolejności.

Element Wystąpienie Typ Opis
<con> Wymagane (1 miejsce) nonEmptyStringType

Indywidualna ustalona na podstawie opinii recenzenta. Wady należy podać w takiej samej kolejności, w jakiej są widoczne. Pomiń schematyczny tekst, taki jak "con:" chyba że został napisany przez recenzenta.

Przykład:

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

<review_url>

Adres URL strony docelowej opinii. Element <review_url> jest rozszerzeniem elementu httpUrlType i zawiera link do strony docelowej z opinią. Element <review_url> zawiera te atrybuty.

Atrybut Wystąpienie Typ Opis
type Wymagany xs:string

Musi to być jeden z tych typów:

singleton
Strona opinii zawiera tylko jedną opinię.
group
Strona opinii zawiera grupę opinii, w tym tę.

Przykład:

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

<reviewer_images>

Zawiera zdjęcia produktu dostarczone przez recenzenta. Tag <reviewer_images> zawiera wiele elementów <reviewer_image>.

Element Wystąpienie Typ Opis
<reviewer_image> Wymagane (1 miejsce) reviewImageType

Zdjęcie recenzowanego produktu utworzonego przez autora opinii.

<reviewer_image>

Pojedynczy element graficzny.

Element Wystąpienie Typ Opis
<url> Wymagany (1) httpUrlType

Adres URL obrazu recenzowanego produktu utworzonego przez autora opinii. Adres URL nie musi kończyć się rozszerzeniem pliku graficznego.

Przykład:

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

Zawiera oceny powiązane z opinią. Element <ratings> zawiera te elementy w określonej kolejności.

Element Wystąpienie Typ Opis
<overall> Wymagany (1) ratingType Ogólna ocena produktu oceniająca.

<overall>

Ogólna ocena produktu oceniająca. Element <overall> rozszerza właściwość xs:decimal simpleType i pobiera ocenę przypisaną przez weryfikatora. Wartość powinna mieścić się w zakresie określonym w atrybutach min i max. Element <overall> zawiera te atrybuty.

Atrybut Wystąpienie Typ Opis
min Wymagany xs:integer Minimalna możliwa liczba ocen. Powinna to być najniższa możliwa ocena i nie powinna być wartością bez oceny.
max Wymagany xs:integer Maksymalna liczba ocen. Wartość atrybutu max musi być większa niż wartość atrybutu min.

<products>

Zawiera produkty powiązane z opinią. Element <products> zawiera te elementy w określonej kolejności.

Element Wystąpienie Typ Opis
<product> Wymagane (1 miejsce) productType Produkt powiązany z opinią.

<product>

Produkt powiązany z opinią. Element <product> zawiera te elementy w określonej kolejności.

Element Wystąpienie Typ Opis
<product_ids> Opcjonalnie (1) productIdsType Identyfikatory powiązane z produktem.
<product_name> Opcjonalnie (1) nonEmptyStringType Opisowa nazwa produktu.
<product_url> Wymagany (1) httpUrlType Adres URL produktu. Adres URL może mieć taką samą wartość jak element <review_url>, jeśli adres URL opinii jest identyczny z adresem URL produktu.

<product_ids>

Identyfikatory powiązane z produktem. Element <product_ids> zawiera te elementy w określonej kolejności.

Element Wystąpienie Typ Opis
<gtins> Wymagany (dotyczy wszystkich opinii powiązanych z produktami o znanym numerze GTIN, aby umożliwić pełne dopasowywanie opinii)

Opcjonalne (zdecydowanie zalecane) w przypadku wszystkich innych opinii (1)		 gtinsType Zawiera numery GTIN (globalne numery jednostki handlowej) powiązane z produktem.
<mpns> Wymagany (numer MPN powinien być włączony, aby ułatwić dopasowanie opinii, jeśli produkt powiązany z opinią nie ma przypisanego numeru GTIN). Musi być przesłany wraz z marką)

Opcjonalny w przypadku wszystkich innych opinii (1)		 mpnsType Zawiera numery MPN (numery katalogowe producenta) powiązane z produktem.
<skus> Wymagany (kod SKU powinien być dołączony do opinii, jeśli produkt powiązany z opinią nie ma przypisanego numeru GTIN ani numeru MPN). należy przesłać razem z marką)

Opcjonalny w przypadku wszystkich innych opinii (1)		 skusType Zawiera kody SKU (jednostki magazynowe) powiązane z produktem. Często odpowiada to identyfikatorowi produktu w pliku danych o produktach.
<brands> Wymagany (podaj markę, aby ułatwić dopasowywanie opinii, jeśli produkt powiązany z opinią nie ma przypisanego numeru GTIN). Należy przesłać z numerem MPN)

Opcjonalny w przypadku wszystkich innych opinii (1)		 brandsType Zawiera nazwy marek powiązane z produktem.
<asins> Opcjonalnie (1) asinsType Zawiera numery ASIN (Amazon Standard Identification Number) powiązane z produktem.

<gtins>

Zawiera numery GTIN (globalne numery jednostki handlowej) powiązane z produktem. Element <gtins> zawiera te elementy w określonej kolejności.

Element Wystąpienie Typ Opis
<gtin> Wymagane (1 miejsce) nonEmptyStringType Globalny numer jednostki handlowej usługi.

<mpns>

Zawiera numery MPN (numery katalogowe producenta) powiązane z produktem. Element <mpns> zawiera te elementy w określonej kolejności.

Element Wystąpienie Typ Opis
<mpn> Wymagane (1 miejsce) nonEmptyStringType Numer katalogowy producenta produktu.

<skus>

Zawiera kody SKU (jednostki magazynowe) powiązane z produktem. Element <skus> zawiera te elementy w określonej kolejności.

Element Wystąpienie Typ Opis
<sku> Wymagane (1 miejsce) nonEmptyStringType Jednostka magazynowa produktu w zasobach reklamowych wydawcy.

<brands>

Zawiera nazwy marek powiązane z produktem. Element <brands> zawiera te elementy w określonej kolejności.

Element Wystąpienie Typ Opis
<brand> Wymagane (1 miejsce) nonEmptyStringType Marka produktu.

<asins>

Zawiera numery ASIN (Amazon Standard Identification Numbers) powiązane z produktem. Element zawiera te elementy w określonej kolejności.

Element Wystąpienie Typ Opis
<asin> Wymagane (1 miejsce) nonEmptyStringType Standardowy numer identyfikacyjny Amazona odpowiadający produktowi. Każdy ASIN ma 10 znaków alfanumerycznych.