Package google.shopping.merchant.reviews.v1beta

索引

MerchantReviewsService

用於管理商家評論的服務。

DeleteMerchantReview

rpc DeleteMerchantReview(DeleteMerchantReviewRequest) returns (Empty)

刪除商家評論。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/content

詳情請參閱 OAuth 2.0 Overview

GetMerchantReview

rpc GetMerchantReview(GetMerchantReviewRequest) returns (MerchantReview)

取得商家評論。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/content

詳情請參閱 OAuth 2.0 Overview

InsertMerchantReview

rpc InsertMerchantReview(InsertMerchantReviewRequest) returns (MerchantReview)

插入 Merchant Center 帳戶的評論。如果評論已存在,系統會將評論替換為新例項。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/content

詳情請參閱 OAuth 2.0 Overview

ListMerchantReviews

rpc ListMerchantReviews(ListMerchantReviewsRequest) returns (ListMerchantReviewsResponse)

列出商家評論。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/content

詳情請參閱 OAuth 2.0 Overview

ProductReviewsService

用於管理產品評論的服務。

DeleteProductReview

rpc DeleteProductReview(DeleteProductReviewRequest) returns (Empty)

刪除產品評論。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/content

詳情請參閱 OAuth 2.0 Overview

GetProductReview

rpc GetProductReview(GetProductReviewRequest) returns (ProductReview)

取得產品評論。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/content

詳情請參閱 OAuth 2.0 Overview

InsertProductReview

rpc InsertProductReview(InsertProductReviewRequest) returns (ProductReview)

插入產品評論。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/content

詳情請參閱 OAuth 2.0 Overview

ListProductReviews

rpc ListProductReviews(ListProductReviewsRequest) returns (ListProductReviewsResponse)

列出產品評論。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/content

詳情請參閱 OAuth 2.0 Overview

DeleteMerchantReviewRequest

DeleteMerchantReview 方法的要求訊息。

欄位
name

string

必要欄位。商家評論的 ID。格式:accounts/{account}/merchantReviews/{merchantReview}

DeleteProductReviewRequest

DeleteProductReview 方法的要求訊息。

欄位
name

string

必要欄位。產品評論的 ID。格式:accounts/{account}/productReviews/{productReview}

GetMerchantReviewRequest

GetMerchantReview 方法的要求訊息。

欄位
name

string

必要欄位。商家評論的 ID。格式:accounts/{account}/merchantReviews/{merchantReview}

GetProductReviewRequest

GetProductReview 方法的要求訊息。

欄位
name

string

必要欄位。商家評論的 ID。格式:accounts/{account}/productReviews/{productReview}

InsertMerchantReviewRequest

InsertMerchantReview 方法的要求訊息。

欄位
parent

string

必要欄位。商家評論插入的帳戶。格式:accounts/{account}

merchant_review

MerchantReview

必要欄位。要插入的商家評論。

data_source

string

必要欄位。merchantreview 格式的資料來源:accounts/{account}/dataSources/{datasource}

InsertProductReviewRequest

InsertProductReview 方法的要求訊息。

欄位
parent

string

必要欄位。要插入產品評論的帳戶。格式:accounts/{account}

product_review

ProductReview

必要欄位。要插入的產品評論。

data_source

string

必要欄位。格式:accounts/{account}/dataSources/{datasource}

ListMerchantReviewsRequest

ListMerchantsReview 方法的要求訊息。

欄位
parent

string

必要欄位。要列出商家評論的帳戶。格式:accounts/{account}

page_size

int32

選用設定。要傳回的商家評論數量上限。服務傳回的產品數量可能會少於這個值。許可的最大值為 1000;超出的數值將一律指定為 1000。如未指定,系統會傳回評論數上限。

page_token

string

選用設定。從先前 ListMerchantReviews 呼叫收到的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時,提供至 ListMerchantReviews 的所有其他參數須與提供網頁權杖的呼叫相符。

ListMerchantReviewsResponse

ListMerchantsReview 方法的回應訊息。

欄位
merchant_reviews[]

MerchantReview

商家評論。

next_page_token

string

用來擷取下一頁結果的符記。

ListProductReviewsRequest

針對 ListProductReviews 方法的請求訊息。

欄位
parent

string

必要欄位。要列出產品評論的帳戶。格式:accounts/{account}

page_size

int32

選用設定。可指定傳回產品數量上限。服務傳回的產品數量可能會少於這個值。

page_token

string

選用設定。從先前 ListProductReviews 呼叫收到的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時,提供至 ListProductReviews 的所有其他參數須與提供網頁權杖的呼叫相符。

ListProductReviewsResponse

ListProductReviews 方法的回應訊息。

欄位
product_reviews[]

ProductReview

產品評論。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

MerchantReview

商家評論。詳情請參閱「商家評論動態饋給簡介

欄位
name

string

ID。商家評論的名稱。格式:"{merchantreview.name=accounts/{account}/merchantReviews/{merchantReview}}"

merchant_review_id

string

必要欄位。使用者提供的商家評論 ID 可用於識別商家評論。

attributes

MerchantReviewAttributes

選用設定。商家評論屬性清單。

custom_attributes[]

CustomAttribute

必要欄位。自訂 (商家提供) 屬性清單。您也可以使用這項功能,以泛型形式 (例如 { "name": "size type", "value": "regular" }) 提交資料規格的任何屬性。這項功能可用於提交 API 未明確公開的屬性,例如實驗性屬性。每個自訂屬性允許的字元數上限為 10240 個 (代表名稱和值的字元總數)。每項產品最多可設定 2500 個自訂屬性,總大小為 102.4 KB。插入時,自訂屬性名稱中的底線會替換為空格。

data_source

string

僅供輸出。商家評論的主要資料來源。

merchant_review_status

MerchantReviewStatus

僅供輸出。商家評論的狀態、資料驗證問題,也就是商家評論的資訊以非同步方式計算。

MerchantReviewAttributes

屬性。

欄位
merchant_id

string

必要欄位。在所有要求中不得重複,且必須保持穩定。換句話說,如果今天和 90 天前的請求都指向同一家商家,則兩者必須具有相同的 ID。

merchant_display_name

string

選用設定。商家的人類可讀顯示名稱。

min_rating

int64

選用設定。評分的最小可能數字。這個值應為最差評分,且不得為無評分值。

max_rating

int64

選用設定。評分可能的最高數字。最大評分值必須大於最小評分值。

rating

double

選用設定。評論者對商家的整體評分。

title

string

選用設定。評論的標題。

content

string

必要欄位。這應該是使用者提供的任何自由格式文字,且不得截斷。如果您針對不同問題提供了多個回覆,請一併附上所有回覆,並提供最少的回覆內容,讓回覆內容有意義。如果未回答問題,請勿提供背景資訊。

reviewer_id

string

選用設定。發布商系統中評論作者的永久專屬 ID。

reviewer_username

string

選用設定。評論作者的顯示名稱。

is_anonymous

bool

選用設定。如果評論者應保持匿名,請設為 true。

collection_method

CollectionMethod

選用設定。用於收集評論的方法。

review_time

Timestamp

必要欄位。指示評論撰寫時間的時間戳記。

review_language

string

必要欄位。評論的語言,由 BCP-47 語言代碼定義。

review_country

string

選用設定。根據 ISO 3166-1 Alpha-2 國家/地區代碼定義,審查員下單的國家/地區。

CollectionMethod

用於收集評論的方法。

列舉
COLLECTION_METHOD_UNSPECIFIED 未指定收集方法。
MERCHANT_UNSOLICITED 使用者提交評論時,並非回覆特定邀請。
POINT_OF_SALE 使用者下單時,收到邀請才提交評論。
AFTER_FULFILLMENT 使用者在訂單完成後,收到邀請才提交評論。

MerchantReviewStatus

商家評論的狀態、資料驗證問題,也就是商家評論的資訊以非同步方式計算。

欄位
destination_statuses[]

MerchantReviewDestinationStatus

僅供輸出。商家評論的預定目的地。

item_level_issues[]

MerchantReviewItemLevelIssue

僅供輸出。與商家評論相關的所有問題清單。

create_time

Timestamp

僅供輸出。項目建立日期,採用 ISO 8601 格式。

last_update_time

Timestamp

僅供輸出。項目上次更新的日期,採用 ISO 8601 格式。

MerchantReviewDestinationStatus

商家審查狀態的目的狀態。

欄位
reporting_context

ReportingContextEnum

僅供輸出。報表內容名稱。

MerchantReviewItemLevelIssue

商家審查狀態的 ItemLevelIssue。

欄位
code

string

僅供輸出。問題的錯誤代碼。

severity

Severity

僅供輸出。這個問題對商家評論的服務品質有何影響。

resolution

string

僅供輸出。商家是否可解決這個問題。

attribute

string

僅供輸出。屬性名稱 (如果問題是因單一屬性造成)。

reporting_context

ReportingContextEnum

僅供輸出。問題適用的回報情境。

description

string

僅供輸出。問題的簡短英文說明。

detail

string

僅供輸出。問題的詳細英文說明。

documentation

string

僅供輸出。協助解決問題的說明網頁網址。

嚴重性

這個問題對商家評論的放送方式有何影響。

列舉
SEVERITY_UNSPECIFIED 不指定。
NOT_IMPACTED 這項問題代表警告,不會直接影響商家評論。
DISAPPROVED 問題導致商家評論遭拒登。

ProductReview

產品評論。詳情請參閱「產品評論動態饋給簡介

欄位
name

string

ID。產品評論的名稱。格式:"{productreview.name=accounts/{account}/productReviews/{productReview}}"

product_review_id

string

必要欄位。發布商系統中產品評論的永久專屬 ID。

attributes

ProductReviewAttributes

選用設定。產品評論屬性清單。

custom_attributes[]

CustomAttribute

選用設定。自訂 (商家提供) 屬性清單。

data_source

string

僅供輸出。產品評論的主要資料來源。

product_review_status

ProductReviewStatus

僅供輸出。產品評論的狀態、資料驗證問題,也就是非同步計算的產品評論相關資訊。

ProductReviewAttributes

屬性。

欄位
review_time

Timestamp

必要欄位。指示評論撰寫時間的時間戳記。

pros[]

string

選用設定。包含評論者認為的優點。除非評論者有寫下「pro:」等樣板文字,否則請省略這類文字。

cons[]

string

選用設定。根據評論者意見,列出產品的缺點。除非評論者有寫下「con:」,否則請省略「con:」等樣板文字。

product_names[]

string

選用設定。產品的描述性名稱。

asins[]

string

選用設定。包含與產品相關聯的 ASIN (Amazon Standard Identification Numbers)。

gtins[]

string

選用設定。包含與產品相關聯的全球交易品項識別碼 (GTIN)。系統支援全球交易品項識別碼的子類型 (例如通用產品代碼、EAN、ISBN、JAN)。

mpns[]

string

選用設定。包含與產品相關聯的製造商零件編號 (MPN)。

skus[]

string

選用設定。包含與產品相關聯的 SKU (存貨單位)。這個值通常會與產品動態饋給中的產品 Offer ID 相符。

brands[]

string

選用設定。包含與產品相關聯的品牌名稱。

collection_method

CollectionMethod

選用設定。用於收集評論的方法。

transaction_id

string

選用設定。發布商系統中與評論相關聯的交易專屬 ID。這個 ID 可用來指出多則評論與同筆交易相關。

aggregator_name

string

選用設定。產品評論匯集工具的名稱。

發布商可以使用評論集結網站來管理評論並提供動態饋給。這個元素表示使用集結網站,並包含集結網站的相關資訊。

subclient_name

string

選用設定。產品評論的子客戶名稱。

子客戶是產品評論來源的 ID。應與檔案資料來源路徑中提供的目錄相同。

publisher_name

string

選用設定。產品評論發布者的名稱。

發布商的資訊,可能是零售商、製造商、評論服務公司,或任何發布產品評論實體。

publisher_favicon

string

選用設定。發布商公司 favicon 的連結。圖片尺寸應為 favicon 大小:16 x 16 像素。圖片格式應為 GIF、JPG 或 PNG。

reviewer_id

string

選用設定。產品評論的作者。

發布商系統中評論作者的永久專屬 ID。

reviewer_is_anonymous

bool

選用設定。如果評論者應保持匿名,請設為 true。

reviewer_username

string

選用設定。產品評論的評論者名稱。

review_language

string

選用設定。評論的語言,由 BCP-47 語言代碼定義。

review_country

string

選用設定。根據 ISO 3166-1 Alpha-2 國家/地區代碼定義的評論國家/地區。

title

string

選用設定。評論的標題。

content

string

必要欄位。評論內容。

min_rating

int64

選用設定。包含與評論相關聯的評分。評分的最小可能數字。這個值應為最差評分,且不得為無評分值。

max_rating

int64

選用設定。評分可能的最高數字。max 屬性的值必須大於 min 屬性的值。

rating

double

選用設定。評論者對產品的整體評分。

is_spam

bool

選用設定。指出評論是否在發布商系統中標示為垃圾內容。

CollectionMethod

用於收集評論的方法。

列舉
COLLECTION_METHOD_UNSPECIFIED 未指定收集方法。
UNSOLICITED 使用者提交評論時,並非回覆特定邀請。
POST_FULFILLMENT 使用者在訂單完成後,收到邀請才提交評論。

類型

評論 URI 的類型。

列舉
TYPE_UNSPECIFIED 未指定類型。
SINGLETON 評論頁面只包含這一則評論。
GROUP 評論頁面包含一組評論,其中包括這則評論。

ProductReviewStatus

產品審查狀態。

欄位
destination_statuses[]

ProductReviewDestinationStatus

僅供輸出。產品評論的預定目的地。

item_level_issues[]

ProductReviewItemLevelIssue

僅供輸出。與產品評論相關的所有問題清單。

create_time

Timestamp

僅供輸出。項目建立日期,採用 ISO 8601 格式。

last_update_time

Timestamp

僅供輸出。項目上次更新的日期,採用 ISO 8601 格式。

ProductReviewDestinationStatus

產品審查狀態的目的地狀態。

欄位
reporting_context

ReportingContextEnum

僅供輸出。報表內容名稱。

ProductReviewItemLevelIssue

產品審查狀態的 ItemLevelIssue。

欄位
code

string

僅供輸出。問題的錯誤代碼。

severity

Severity

僅供輸出。這個問題對產品評論放送的影響程度。

resolution

string

僅供輸出。商家是否可解決這個問題。

attribute

string

僅供輸出。屬性名稱 (如果問題是因單一屬性造成)。

reporting_context

ReportingContextEnum

僅供輸出。問題適用的回報情境。

description

string

僅供輸出。問題的簡短英文說明。

detail

string

僅供輸出。問題的詳細英文說明。

documentation

string

僅供輸出。協助解決問題的說明網頁網址。

嚴重性

問題對產品評論的放送方式有何影響。

列舉
SEVERITY_UNSPECIFIED 不指定。
NOT_IMPACTED 這項問題代表警告,不會對產品評論造成直接影響。
DISAPPROVED 問題導致產品評論遭拒登。