XML 架构

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

顶级元素：<feed>

说明

用于存放 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 非空字符串 必需 (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) 此评价所针对的商家的标识符。

包含

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

名称 格式 出现次数 说明
reviewer_name 非空字符串 可选 (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 国家/地区代码 必需 (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>