XML 架构

本部分介绍了用于商家评价数据 Feed 的 XML 架构。

顶级元素：<feed>

说明

用于存放信息流中所有其他元素的最顶层容器元素。

属性

名称 格式 出现次数 说明
xmlns xs:string 必需 (1) 请对以下值进行硬编码：
http://schemas.google.com/merchant_reviews/5.0
xmlns:xsi xs:string 必需 (1) 请对以下值进行硬编码：
http://www.w3.org/2001/XMLSchema-instance
xsi:schemaLocation xs:string 必需 (1) 请对以下值进行硬编码，并在网址之间留出一个空格：
http://schemas.google.com/merchant_reviews/5.0 http://www.gstatic.com/productsearch/static/reviews/5.0/merchant_reviews.xsd

示例

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

包含

名称 格式 出现次数 说明
merchants       -- 可选 (0‑1) <merchant> 元素的容器元素。
deleted_merchants       -- 可选 (0‑1) <deleted_merchant> 元素的容器元素。
reviews       -- 可选 (0‑1) <review> 元素的容器元素。
deleted_reviews       -- 可选 (0‑1) <deleted_review> 元素的容器元素。

<merchants>

说明

<merchant> 元素的容器。

包含

名称 格式 出现次数 说明
merchant       -- 必需（1-n） 针对每个商家重复的元素。

<merchant>

说明

每个 <merchant> 元素都包含一个商家的信息和评价。

属性

名称 格式 出现次数 说明
id ID 必需 (1) 在所有 Feed 中必须是唯一且稳定的。换句话说，如果今天的 Feed 和 90 天前的 Feed 指的是同一商家，则它们必须具有相同的 ID。

示例

<merchant id="2739">

包含

请在商家元素中添加以下元素。

名称 格式 出现次数 说明
name NonEmptyString 必需 (1) 商家的人类可读显示名称。
merchant_url xs:anyURI 必需 (1) 指向商家主要网站的网址。
请勿为此值使用重定向网址。换句话说，该值应直接指向商家的网站。

例如： 

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

rating_url xs:anyURI 必需 (1) 指向托管相应商家评价的着陆页的网址。
请勿使用重定向网址。

例如： 

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

create_timestamp DateTimeWithTimeZone 必需 (1) 商家的创建时间/日期。此值不得发生更改。
last_update_timestamp DateTimeWithTimeZone 必需 (1) 商家上次更新的时间/日期。如果针对特定商家 ID 更新了 <merchant> 元素中的任何字段，此值也必须随之更改。

<deleted_merchants>

说明

已删除商家的容器。

包含

名称 格式 出现次数 说明
deleted_merchant       -- 必需（1-n） 包含与单个已删除商家相关的元素。

<deleted_merchant>

说明

已删除的商家。

属性

名称 格式 出现次数 说明
id ID 必需 (1) 指定应从 Feed 中删除的商家的 ID。该 ID 必须与任何之前的 Feed 文件中 <merchant> 元素的 id 属性相匹配。

包含

名称 格式 出现次数 说明
last_update_timestamp DateTimeWithTimeZone 必需 (1) 商家从系统中移除的时间/日期。

例如： 

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

示例

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

<reviews>

说明

<review> 元素的容器。

包含

名称 格式 出现次数 说明
review       -- 必需（1-n） 针对每条评价重复的元素。

<review>

说明

用于存放与评价相关的详细信息的容器。

属性

名称 格式 出现次数 说明
id ID 必需 (1) 您系统中的评价标识符。在所有 Feed 中必须是唯一且稳定的。

例如： 

<review id=132739 mid=1234>

mid ID 必需 (1) 相应评价所针对的商家的标识符。

包含

请在 review 元素中添加以下元素。

名称 格式 出现次数 说明
reviewer_name NonEmptyString 可选（0-1） 评价作者的显示名称，前提是评价应有具名作者。 匿名评价不应包含此字段。

例如： 

<reviewer_name>
  Joel
</reviewer_name>

create_timestamp DateTimeWithTimeZone 必需 (1) 用户提交评价的时间/日期。此值不得发生更改。

例如： 

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

last_update_timestamp DateTimeWithTimeZone 必需 (1) <review> 元素中的信息上次更改的时间/日期。如果针对给定评价 ID 更新了 <review> 元素中的任何字段，此值也必须更改。

例如： 

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

country_code CountryCode 必需 (1) 评价者的国家/地区。如果提供，此值应为商品配送到的国家/地区或提供服务的国家/地区。若未提供具体的值，请使用评价者撰写该评价时所在的国家/地区。国家/地区代码必须采用 ISO 3166-1 alpha-2 格式。

例如： 

  <country_code>
    US
  </country_code>

title xs:string 可选（0-1） 评价的标题。标题应为纯文本，不包含任何 HTML 标记。

例如： 

  <title>
    Great prices
  </title>

content xs:string 必需 (1) 评价的内容。这应该是用户提供的任意自由格式文本，不应截断。内容应为纯文本，不包含任何 HTML 标记。例如，换行符应由换行符表示，而不是 <br> 标记。 如果针对不同问题提供了多个回答，则应包含所有回答，并提供最少的上下文信息，以便理解这些回答。如果问题未得到解答，则不应提供上下文。

例如： 

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

例如： 

  <content>
    Positives: Great prices.
    Suggestions: Selection could be better.
  </content>
ratings           -- 必需 (1) 用于存放评价者对商家的评分的容器元素。如果 <overall> 元素没有评分，则应从 Feed 中排除整个关联的评价，因为 <overall> 元素是必需的，没有该元素的评价将不被接受。
collection_method CollectionMethodType 必需 (1) 用于收集评价的方法。该值必须是以下值之一：
  • 主动提供：用户并非因为回应邀请而提交评价。
  • point_of_sale：用户在下单时应邀请提交评价。
  • after_fulfillment：用户在订单完成履单后，应邀请提交评价。

例如： 

  <collection_method>
    after_fulfillment
  </collection_method>

<ratings>

说明

包含评价者对商家的评分。如果 <overall> 元素没有评分，则应从 Feed 中排除整个关联的评价，因为 <overall> 元素是必需的，如果没有该元素，系统将不会接受相应评价。

包含

请在评分元素中添加以下元素。

名称 格式 出现次数 说明
overall RatingRange 必需 (1) 评价者对商家的总体评分。

例如： 

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

customer_service RatingRange 可选（0-1） 评价者对此商家的客户服务质量的评分。

例如： 

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

<deleted_reviews>

说明

已删除评价的容器。

包含

名称 格式 出现次数 说明
deleted_review       -- 必需（1-n） 包含与单个已删除评价相关的元素。

<deleted_review>

说明

已删除的评价。

属性

名称 格式 出现次数 说明
id ID 必需 (1) 指定应从 Feed 中删除的评价的 ID。该 ID 必须与任何 Feed 文件中 <review> 元素的 id 属性相匹配。

包含

名称 格式 出现次数 说明
last_update_timestamp DateTimeWithTimeZone 必需 (1) 评价从系统中移除的时间。

例如： 

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

示例

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