XML 架構

本節需要符合商家評論資料動態饋給的 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) 所有動態饋給均不得重複,且必須保持穩定。換句話說,如果今天的動態饋給和 90 天前的動態饋給都參照同一商家,則 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 日期時間時區 必要 (1) 商家建立的時間/日期。這個欄位不可變更。
last_update_timestamp 日期時間時區 必要 (1) 商家上次更新的時間/日期。如果特定商家 ID 的 <merchant> 元素中的任何欄位有所更新,這個值也必須變更。

<deleted_merchants>

說明

已刪除商家的專屬容器。

包含

名稱 格式化 發生次數 說明
deleted_merchant -- 必填 (1 至 n) 包含與單一已刪除商家相關的元素。

<deleted_merchant>

說明

已刪除的商家。

屬性

名稱 格式化 發生次數 說明
id Id 必要 (1) 指定要從動態饋給中刪除的商家 ID。ID 必須與任何先前動態饋給檔案中的 <merchant> 元素 id 屬性相符。

包含

名稱 格式化 發生次數 說明
last_update_timestamp 日期時間時區 必要 (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) 系統中評論的 ID。所有動態饋給均不得重複,且必須保持穩定。

範例:

<review id=132739 mid=1234>

mid Id 必要 (1) 此評論所屬的商家 ID。

包含

請在審查元素中加入下列元素。

名稱 格式化 發生次數 說明
reviewer_name NonEmptyString 選填 (0‐1) 評論的作者顯示名稱,前提是該評論應有已命名的作者。 匿名評論不得包含這個欄位。

範例:

<reviewer_name>
  Joel
</reviewer_name>

create_timestamp 日期時間時區 必要 (1) 使用者提交評論的時間/日期。這個欄位不可變更。

範例:

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

last_update_timestamp 日期時間時區 必要 (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> 元素沒有評分,則應將整個相關評論排除在動態饋給之外,因為需要 <overall> 元素,而且如果沒有該評論,則無法接受評論。
collection_method CollectionMethodType 必要 (1) 用來收集評論的方法。這個值必須是下列任一值:
  • 主動聲明:使用者在提交評論時沒有回應特定的推銷要求。
  • point_of_sale:當使用者下訂單時,使用者提交了評論來回應評論。
  • after_fulfillment:使用者在完成訂單後,為提交評論來回應評論。

範例:

  <collection_method>
    after_fulfillment
  </collection_method>

<ratings>

說明

包含評論者的評分。如果 <overall> 元素沒有評分,則必須從動態饋給中排除整個相關評論,因為必須使用 <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) 指定要從動態饋給中刪除的評論 ID。ID 必須與任何動態饋給檔案中的 <review> 元素 ID 屬性相符。

包含

名稱 格式化 發生次數 說明
last_update_timestamp 日期時間時區 必要 (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>