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

可选。要返回的商家评价的数量上限。服务返回的值可以小于此值。最大值为 1,000;大于 1,000 的值会强制转换为 1,000。如果未指定,则返回评价数量上限。

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

对商家的评价。如需了解详情,请参阅商家评价 Feed 简介

字段
name

string

标识符。商家评价的名称。格式:"{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.4KB。自定义属性名称中的下划线会在插入时替换为空格。

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

可选。评价作者在发布商系统中的永久唯一标识符。

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

对商品的评价。如需了解详情,请参阅商品评价 Feed 简介

字段
name

string

标识符。商品评价的名称。格式:"{productreview.name=accounts/{account}/productReviews/{productReview}}"

product_review_id

string

必需。发布商系统中商品评价的永久唯一标识符。

attributes

ProductReviewAttributes

可选。商品评价属性列表。

custom_attributes[]

CustomAttribute

可选。自定义(商家提供)属性的列表。

data_source

string

仅限输出。商品评价的主要数据源。

product_review_status

ProductReviewStatus

仅限输出。商品评价的状态、数据验证问题,即异步计算的商品评价相关信息。

ProductReviewAttributes

属性。

字段
review_time

Timestamp

必需。指示撰写评价时的时间戳。

pros[]

string

可选。包含审核者意见中的优势。除非是评价者撰写的,否则请省略“pro:”等样本文字。

cons[]

string

可选。包含评价者意见中的缺点。除非是评价者撰写的,否则请省略“缺点:”等样本文字。

product_names[]

string

可选。商品的描述性名称。

asins[]

string

可选。包含与商品关联的 ASIN(Amazon 标准识别码)。

gtins[]

string

可选。包含与商品关联的 GTIN(全球贸易项目代码)。支持 GTIN 的子类型(例如 UPC、EAN、ISBN、JAN)。

mpns[]

string

可选。包含与商品关联的 MPN(制造商部件号)。

skus[]

string

可选。包含与商品关联的 SKU(库存单元)。此 ID 通常与商品 Feed 中的商品优惠 ID 一致。

brands[]

string

可选。包含与商品相关联的品牌名称。

collection_method

CollectionMethod

可选。用于收集评价的方法。

transaction_id

string

可选。与发布商系统中与评价相关联的交易的永久唯一标识符。此 ID 可用于指明多条评价与同一笔交易相关联。

aggregator_name

string

可选。商品评价集合商家的名称。

发布商可以使用评价集合商家来管理评价和提供 Feed。此元素表示使用了聚合器,并包含聚合器的相关信息。

subclient_name

string

可选。商品评价的子客户的名称。

子客户端是商品评价来源的标识符。它应与文件数据源路径中提供的目录相同。

publisher_name

string

可选。商品评价发布商的名称。

发布商的相关信息,发布商可以是零售商、制造商、评价服务公司或发布商品评价的任何实体。

publisher_favicon

string

可选。指向发布商公司 favicon 的链接。图片尺寸应为 favicon 大小:16x16 像素。图片格式应为 GIF、JPG 或 PNG。

reviewer_id

string

可选。商品评价的作者。

评价作者在发布商系统中的永久唯一标识符。

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

可选。评分的可能最大值。最高分级的值必须大于最小分级属性的值。

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 问题导致商品评价被拒批。