XML 架构参考

图书:/product-review-feed/_book.yaml

标题:XML 架构参考

Google 商品评价 Feed 的 XML 架构定义了 XML Feed 的可接受结构。XML 架构使用 .xsd 文件扩展名。与 DTD 文件一样,XML 架构定义了可在 XML 文档中显示的元素和属性。

如需详细了解 XML 架构,请参阅 XML 架构入门

商品评价 Feed 的 XML 架构发布在此处:http://www.google.com/shopping/reviews/schema/product/2.3/product_reviews.xsd

对该架构定义的 Feed 结构的说明如下。在本说明中,前缀为 xs: 的类型名称是指 XML 命名空间 http://www.w3.org/2001/XMLSchema 中的内置 XML 架构类型。

我们的系统始终希望获得完整的 Feed。之前提交但未包含在下一个完整 Feed 中的任何评价都将被删除。因此,您应始终在提交 Feed 时提交所有评价。

顶级 <feed> 元素

<feed> 元素会按照列出的顺序包含这些元素。

元素 出现 类型 说明
<version> 必需 (1) xs:string 指明正在使用的商品评价 Feed 架构版本。目前仅支持 <version>2.3</version>
<aggregator> 可选 (1) aggregatorType 发布商可以使用评价集合商家来管理评价和提供 Feed。此元素用于指明聚合器的用途,并包含聚合器的相关信息。
<publisher> 必需 (1) publisherType 与发布商相关的信息,可以是零售商、制造商、评价服务公司或任何发布商品评价的实体。
<reviews> 可选 (1) xs:sequence 包含商品评价。

<feed> 定义了对 Feed 中使用的元素的唯一性限制。

子元素

<aggregator>

发布商可以使用评价集合商家来管理评价和提供 Feed。此元素用于指明聚合器的用途,并包含聚合器的相关信息。<aggregator> 元素按列出的顺序包含这些元素。

元素 出现 类型 说明
<name> 必需 (1) nonEmptyStringType 商品评价集合商家的名称。

<publisher>

与发布商(可以是零售商、制造商、评价服务公司)或任何发布商品评价的实体有关的信息。<publisher> 元素按所示顺序包含这些元素。

元素 出现 类型 说明
<name> 必需 (1) nonEmptyStringType 商品评价的发布商名称。
<favicon> 可选 (1) httpUrlType 指向发布商公司网站的链接。图片尺寸应为网站图标大小:16x16 像素。图片格式应为 GIF、JPG 或 PNG。

<reviews>

包含商品评价。<reviews> 元素会按照列出的顺序包含这些元素。

元素 出现 类型 说明
<review> 必需 (1 - 无限制) reviewType 单独的商品评价。如果评价与发布商广告资源中的多个产品相关,请指定一次评价,并在 <products> 元素中添加多个 <product> 元素。

<review>

单独的商品评价。如果评价与发布商产品目录中的多个产品相关,则指定一次该评价,并在 <products> 元素中添加多个 <product> 元素。<review> 元素会按照列出的顺序包含这些元素。

元素 出现 类型 说明
<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 包含评价者意见的缺点。省略“con:”等样板文本,除非评价者编写。
<reviewer_images> 可选 (1) xs:sequence 包含评价者提供的商品图片的链接。
<review_url> 必需 (1) reviewUrlType 评价着陆页的网址。
<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> 元素会按照列出的顺序包含这些元素。

元素 出现 类型 说明
<name> 必需 (1) reviewerNameType

评价作者的姓名。

示例

<name>Jane</name>
<reviewer_id> 可选 (1) nonEmptyStringType

评价者在发布商系统中永久的专属标识码。

示例

<reviewer_id>14295</reviewer_id>

<name>

评价作者的姓名。<name> 元素是 nonEmptyStringType 的扩展,包含评价者的姓名或别名。<name> 元素包含这些属性。

属性 出现 类型 说明
is_anonymous 选填 xs:boolean

指明评价者是否匿名。

示例

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

<pros>

包含评价者的专业意见。<pros> 元素会按照列出的顺序包含这些元素。

元素 出现 类型 说明
<pro> 必需 (1 - 无限制) nonEmptyStringType

根据审核者的意见得出的个人专业人士。职业信息的排列顺序应与显示时相同。省略类似于“pro:”的样板文字,除非评价者编写。

示例

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

<cons>

包含评价者意见的缺点。<cons> 元素会按照列出的顺序包含这些元素。

元素 出现 类型 说明
<con> 必需 (1 - 无限制) nonEmptyStringType

基于审核者意见的单个个人决定。排列顺序应与其显示顺序相同。省略类似于“con:”的样板文字,除非评价者编写。

示例

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

<review_url>

评价着陆页的网址。<review_url> 元素是 httpUrlType 的扩展,包含指向评价着陆页的链接。<review_url> 元素包含这些属性。

属性 出现 类型 说明
type 必需 xs:string

类型必须是以下某一项:

singleton
评价页面仅包含这条评价。
group
评价页面包含一组评价,包括此评价。

示例

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

<reviewer_images>

包含评价者提供的商品的图片。<reviewer_images> 标记包含许多 <reviewer_image> 元素。

元素 出现 类型 说明
<reviewer_image> 必需 (1 - 无限制) reviewImageType

评价作者创建的评价商品的图片。

<reviewer_image>

单个评价图片元素。

元素 出现 类型 说明
<url> 必需 (1) httpUrlType

指向评价作者所创建商品图片的网址。该网址无需以文件扩展名结尾。

示例

<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> 元素会按照列出的顺序包含这些元素。

元素 出现 类型 说明
<overall> 必需 (1) ratingType 评价者对商品的总体评分。

<overall>

评价者对商品的总体评分。<overall> 元素会扩展 xs:decimal simpleType 并捕获评价者分配的评分。该值应在 minmax 属性定义的范围内。<overall> 元素包含这些属性。

属性 出现 类型 说明
min 必需 xs:integer 评分的可能数值下限。此评分应为最低评分,不应为没有评分的值。
max 必需 xs:integer 可能的评分数量上限。max 属性的值必须大于 min 属性的值。

<products>

包含与评价关联的商品。<products> 元素会按照列出的顺序包含这些元素。

元素 出现 类型 说明
<product> 必需 (1 - 无限制) productType 与评价关联的商品。

<product>

与评价关联的商品。<product> 元素会按照列出的顺序包含这些元素。

元素 出现 类型 说明
<product_ids> 可选 (1) productIdsType 与商品相关联的标识符。
<product_name> 可选 (1) nonEmptyStringType 商品的描述性名称。
<product_url> 必需 (1) httpUrlType 商品的网址。如果评价网址和商品网址相同,则此网址可以与 <review_url> 元素的值相同。

<product_ids>

与商品相关联的标识符。<product_ids> 元素会按照列出的顺序包含这些元素。

元素 出现 类型 说明
<gtins> 必需属性(对于所有与已知 GTIN 的商品相关联的评价,可启用完整的评价匹配功能)

可选属性(强烈建议提供)对于所有其他评价(1)
gtinsType 包含与商品相关联的 GTIN(全球贸易项目代码)。
<mpns> 必需属性(如果与评价关联的商品没有指定的 GTIN,则应添加 MPN,以方便评价匹配)。与品牌一起提交时必须提交的内容

对于所有其他评价,则为可选(1)
mpnsType 包含与商品相关的 MPN(制造商部件号)。
<skus> 必需属性(如果与评价关联的商品没有指定的 GTIN 或 MPN,则应添加 SKU 以方便进行评价匹配)。应与品牌一起提交)

对于所有其他评价,则为可选(1)
skusType 包含与产品相关联的 SKU(库存单元)。通常,此 ID 与商品 Feed 中的商品优惠 ID 一致。
<brands> 必需属性(如果与评价关联的商品没有指定的 GTIN,则应添加品牌,以方便进行评价匹配)。必须与 MPN 一起提交

对于所有其他评价都是可选的(1)
brandsType 包含与商品相关联的品牌名称。
<asins> 可选 (1) asinsType 包含与商品关联的 ASIN(亚马逊标准标识号)。

<gtins>

包含与商品相关联的 GTIN(全球贸易项目代码)。<gtins> 元素会按照列出的顺序包含这些元素。

元素 出现 类型 说明
<gtin> 必需 (1 - 无限制) nonEmptyStringType 商品的全球贸易项目代码。

<mpns>

包含与商品相关的 MPN(制造商部件号)。<mpns> 元素会按照列出的顺序包含这些元素。

元素 出现 类型 说明
<mpn> 必需 (1 - 无限制) nonEmptyStringType 产品的制造商部件号。

<skus>

包含与产品相关联的 SKU(库存单元)。<skus> 元素会按照列出的顺序包含这些元素。

元素 出现 类型 说明
<sku> 必需 (1 - 无限制) nonEmptyStringType 发布商的库存中的产品库存单位。

<brands>

包含与商品相关联的品牌名称。<brands> 元素会按照列出的顺序包含这些元素。

元素 出现 类型 说明
<brand> 必需 (1 - 无限制) nonEmptyStringType 商品的品牌名称。

<asins>

包含与商品关联的 ASIN(亚马逊标准标识号)。 元素包含这些元素(按列出的顺序排列)。

元素 出现 类型 说明
<asin> 必需 (1 - 无限制) nonEmptyStringType 商品的 Amazon 标准标识号。每个 ASIN 的长度为 10 个字符,由字母和数字组成。