XML スキーマ リファレンス

書籍: /product-review-feeds/_book.yaml

タイトル: XML スキーマ リファレンス

Google 商品レビュー フィードの XML スキーマは、XML フィードの有効な構造を定義します。XML スキーマはファイル拡張子 .xsd を使用します。DTD ファイルと同様に、XML スキーマは、XML ドキュメントに含めることができる要素と属性を定義します。

XML スキーマの詳細については、こちらの XML スキーマ プライマーをご覧ください。

商品レビュー フィードの XML スキーマは http://www.google.com/shopping/reviews/schema/product/2.3/product_reviews.xsd に公開されています。

以下は、このスキーマで定義されているフィード構造についての説明です。この説明では、接頭辞が xs: の型名は、XML 名前空間 http://www.w3.org/2001/XMLSchema にある組み込みの XML スキーマ型を指します。

Google のシステムは常に完全なフィードを想定しています。以前に送信したが、次の完全なフィードに含まれていないレビューは削除されます。そのため、フィードを送信する場合は、必ずすべてのレビューを送信する必要があります。

最上位の <feed> 要素

<feed> 要素には、リストされた順序で要素が含まれます。

要素 オカレンス Type 説明
<version> 必須(1) xs:string 使用されている商品レビュー フィード スキーマのバージョンを示します。現時点では、<version>2.3</version> のみがサポートされています。
<aggregator> 任意(1) aggregatorType レビュー アグリゲータを利用してレビューを管理し、フィードを提供する場合があります。この要素は、アグリゲータが使用されていることを示し、アグリゲータに関する情報を含みます。
<publisher> 必須(1) publisherType パブリッシャーに関する情報。小売店、メーカー、レビュー サービス会社、または商品レビューを公開するエンティティなどです。
<reviews> 省略可(1) xs:sequence 商品レビューが含まれます。

<feed> は、フィードで使用される要素の一意性の制約を定義します。

子要素

<aggregator>

レビュー アグリゲータを利用してレビューを管理し、フィードを提供することができます。この要素は、アグリゲータが使用されていることを示し、アグリゲータに関する情報を含みます。<aggregator> 要素には、リストされた順序で要素が含まれます。

要素 オカレンス Type 説明
<name> 必須(1) nonEmptyStringType 商品レビューのアグリゲータの名前。

<publisher>

パブリッシャー(販売店、メーカー、レビュー サービス会社、商品レビューを公開するエンティティなど)に関する情報。<publisher> 要素には、記載されている順序で要素が含まれます。

要素 オカレンス Type 説明
<name> 必須(1) nonEmptyStringType 商品レビューのパブリッシャーの名前。
<favicon> 任意(1) httpUrlType パブリッシャーの会社のファビコンへのリンク。画像サイズはファビコンのサイズ: 16x16 ピクセルである必要があります。画像形式は GIF、JPG、PNG のいずれかである必要があります。

<reviews>

商品レビューが含まれている。<reviews> 要素には、リストされた順序で要素が含まれます。

要素 オカレンス Type 説明
<review> 必須(1 つの制限なし) reviewType 個別の商品レビュー。レビューがパブリッシャーの広告枠で複数の商品に関する場合は、レビューを 1 回指定し、<products> 要素に複数の <product> 要素を含めます。

<review>

個別の商品レビュー。レビューがパブリッシャーの広告枠内の複数の商品に関する場合は、レビューを 1 回指定し、<products> 要素に複数の <product> 要素を含めます。<review> 要素には、記載されている順序で要素を含めます。

要素 オカレンス Type 説明
<review_id> 任意(1) nonEmptyStringType パブリッシャーのシステムでの商品レビューの永続的な一意の識別子。
<reviewer> 必須(1) reviewerType 商品レビュー投稿者。
<review_timestamp> 必須(1) xs:dateTime

クチコミが投稿された日時を示すタイムスタンプ。

例:

2014-04-21T11:07:07-06:00
2014-04-21T18:00:00+01:00
2014-04-21T00:00:00Z
<title> 任意(1) nonEmptyStringType クチコミのタイトル。
<content> 必須(1) nonEmptyStringType クチコミの内容です。
<pros> 任意(1) xs:sequence 審査担当者の意見に基づくプロフェッショナルが含まれている。レビュー担当者によって作成されたボイラープレート テキストは省略します(例: "pro:")。
<cons> 任意(1) xs:sequence クチコミ投稿者の意見に基づく短所を示します。レビュー担当者が作成していない限り、ボイラープレート テキストは省略できます。
<reviewer_images> 任意(1) xs:sequence レビュアーから提供された商品の画像へのリンクが含まれています。
<review_url> 必須(1) reviewUrlType クチコミのランディング ページの URL です。
<ratings> 必須(1) xs:sequence クチコミに関連付けられている評価が表示されます。
<products> 必須(1) xs:sequence レビューに関連付けられている商品が含まれます。
<is_spam> 任意(1) xs:boolean パブリッシャーのシステムでクチコミが迷惑メールに分類されているかどうかを示します。
<collection_method> 任意(1) collectionMethodType

レビューの収集に使用された方法。値は次のいずれかにする必要があります。

unsolicited
ユーザーは、レビューが送信された際に、特定の勧誘に応答しませんでした。
post_fulfillment
ユーザーは、注文を満たした後、勧誘に応じてレビューを提出しました。
<transaction_id> 任意(1) nonEmptyStringType パブリッシャーのシステムでのクチコミに関連付けられている、取引の永続的な一意の識別子。この ID は、複数のクチコミが同じ取引に関連付けられていることを示します。

<reviewer>

商品レビュー投稿者。<reviewer> 要素には、リストされた順序で要素が含まれます。

要素 オカレンス Type 説明
<name> 必須(1) reviewerNameType

クチコミの投稿者の名前。

例:

<name>Jane</name>
<reviewer_id> 任意(1) nonEmptyStringType

パブリッシャーのシステムでレビューが執筆される一意の永続的な識別子。

例:

<reviewer_id>14295</reviewer_id>

<name>

クチコミの投稿者の名前。<name> 要素は、nonEmptyStringType の拡張であり、審査担当者の名前またはエイリアスを含みます。<name> 要素にはこれらの属性が含まれます。

属性 オカレンス Type 説明
is_anonymous 任意 xs:boolean

クチコミ投稿者が匿名かどうかを示します。

例:

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

<pros>

審査担当者の意見に基づくプロフェッショナルが含まれている。<pros> 要素には、リストされた順序で要素が含まれます。

要素 オカレンス Type 説明
<pro> 必須(1 つの制限なし) nonEmptyStringType

審査担当者の意見に基づく個々のプロフェッショナル。表示されるリストは、表示される順序と同じ順序で表示されます。レビュアーが書かれているものを除き、ボイラープレート テキストは "pro:" のように省略します。

例:

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

<cons>

クチコミ投稿者の意見に基づく短所を示します。<cons> 要素には、リストされた順序で要素が含まれます。

要素 オカレンス Type 説明
<con> 必須(1 つの制限なし) nonEmptyStringType

審査担当者の意見に基づく個々の非難デメリットは表示される順序と同じ順序で列挙する必要があります。レビュアーが書かれているものを除き、ボイラープレート テキストは "con:" のように省略します。

例:

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

<review_url>

クチコミのランディング ページの URL です。<review_url> 要素は、httpUrlType の拡張であり、クチコミのランディング ページへのリンクを含みます。 <review_url> 要素にはこれらの属性が含まれます。

属性 オカレンス Type 説明
type 必須 xs:string

タイプは次のいずれかにする必要があります。

singleton
レビューページにはこのレビューが 1 件のみ含まれます。
group
レビューページには、このレビューを含むクチコミのグループが表示されます。

例:

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

<reviewer_images>

クチコミ投稿者から提供された商品の画像が含まれています。<reviewer_images> タグには、多くの <reviewer_image> 要素が含まれています。

要素 オカレンス Type 説明
<reviewer_image> 必須(1 つの制限なし) reviewImageType

レビュー投稿者によって作成された、レビュー対象の商品の画像。

<reviewer_image>

単一のレビュー画像要素。

要素 オカレンス Type 説明
<url> 必須(1) httpUrlType

レビュー投稿者によって作成された、レビュー対象の商品の画像の URL。URL の末尾を画像ファイルの拡張子にする必要はありません。

例:

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

クチコミに関連付けられている評価が表示されます。<ratings> 要素には、リストされた順序で要素が含まれます。

要素 オカレンス Type 説明
<overall> 必須(1) ratingType 商品に対するレビュー担当者の総合評価。

<overall>

商品に対するレビュー担当者の総合評価。<overall> 要素は、xs:decimal simpleType を拡張して、レビュー担当者が割り当てた評価をキャプチャします。この値は、min 属性と max 属性で定義された包含範囲内の値にする必要があります。<overall> 要素にはこれらの属性が含まれます。

属性 オカレンス Type 説明
min 必須 xs:integer 評価の最小値。これは最低の評価でなければならず、評価なしの値は設定できません。
max 必須 xs:integer 評価の最大許容数。max 属性の値は、min 属性の値よりも大きくする必要があります。

<products>

レビューに関連付けられている商品が含まれます。<products> 要素には、リストされた順序で要素が含まれます。

要素 オカレンス Type 説明
<product> 必須(1 つの制限なし) productType レビューに関連付けられた商品。

<product>

レビューに関連付けられた商品。<product> 要素には、リストされた順序で要素が含まれます。

要素 オカレンス Type 説明
<product_ids> 任意(1) productIdsType 商品に関連付けられた識別子。
<product_name> 任意(1) nonEmptyStringType 商品のわかりやすい名前。
<product_url> 必須(1) httpUrlType 商品の URL。レビュー URL と商品 URL が同じ場合は、<review_url> 要素と同じ値を指定できます。

<product_ids>

商品に関連付けられた識別子。<product_ids> 要素には、リストされた順序で要素が含まれます。

要素 オカレンス Type 説明
<gtins> 必須(既知の GTIN がある商品に関連付けられたすべてのレビューで、完全なレビューの一致を有効にするには)

(省略可)その他のすべてのレビューで(1)
gtinsType 商品に関連付けられた GTIN(国際取引商品番号)が含まれます。
<mpns> 必須(レビューに関連する商品に GTIN が割り当てられていない場合、レビューを照合しやすくするために MPN を含める必要があります。ブランドとともに送信することが必要)

上記以外のすべてのクチコミでは省略可(1)
mpnsType 商品に関連付けられた MPN(メーカー部品番号)が含まれます。
<skus> 必須(レビューに関連付けられている商品に GTIN または MPN が割り当てられていない場合、レビューの照合を容易にするために SKU を含める必要があります。ブランドとともに提出する必要があります)

その他のすべてのレビューは省略可(1)
skusType 商品に関連付けられた SKU(在庫管理単位)が含まれます。多くの場合、商品フィードの商品 ID と一致します。
<brands> 必須(レビューに関連する商品に GTIN が割り当てられていない場合、レビューを照合しやすくするためにブランドを含める必要があります。(製品番号は MPN で指定)

省略可: 上記以外のすべてのクチコミ(1)
brandsType 商品に関連付けられたブランド名が含まれます。
<asins> 任意(1) asinsType 商品に関連付けられた ASIN(Amazon Standard Identification Number)が含まれます。

<gtins>

商品に関連付けられた GTIN(国際取引商品番号)が含まれます。<gtins> 要素には、リストされた順序で要素が含まれます。

要素 オカレンス Type 説明
<gtin> 必須(1 つの制限なし) nonEmptyStringType 商品の国際取引商品番号。

<mpns>

商品に関連付けられた MPN(メーカー部品番号)が含まれます。<mpns> 要素には、リストされた順序で要素が含まれます。

要素 オカレンス Type 説明
<mpn> 必須(1 つの制限なし) nonEmptyStringType 商品のメーカー部品番号。

<skus>

商品に関連付けられた SKU(在庫管理単位)が含まれます。<skus> 要素には、リストされた順序で要素が含まれます。

要素 オカレンス Type 説明
<sku> 必須(1 つの制限なし) nonEmptyStringType パブリッシャーの広告枠での商品のの最小管理単位。

<brands>

商品に関連付けられたブランド名が含まれます。<brands> 要素には、リストされた順序で要素が含まれます。

要素 オカレンス Type 説明
<brand> 必須(1 つの制限なし) nonEmptyStringType 商品のブランド名。

<asins>

商品に関連付けられた ASIN(Amazon Standard Identification Number)が含まれます。要素には、記載されている順序で要素が含まれます。

要素 オカレンス Type 説明
<asin> 必須(1 つの制限なし) nonEmptyStringType 商品の Amazon 標準識別番号。各 ASIN は 10 文字の英数字です。