Package google.shopping.merchant.reviews.v1beta

Index

MerchantReviewsService

Service to manage merchant reviews.

DeleteMerchantReview

rpc DeleteMerchantReview(DeleteMerchantReviewRequest) returns (Empty)

Deletes merchant review.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.
GetMerchantReview

rpc GetMerchantReview(GetMerchantReviewRequest) returns (MerchantReview)

Gets a merchant review.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.
InsertMerchantReview

rpc InsertMerchantReview(InsertMerchantReviewRequest) returns (MerchantReview)

Inserts a review for your Merchant Center account. If the review already exists, then the review is replaced with the new instance.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.
ListMerchantReviews

rpc ListMerchantReviews(ListMerchantReviewsRequest) returns (ListMerchantReviewsResponse)

Lists merchant reviews.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

ProductReviewsService

Service to manage product reviews.

DeleteProductReview

rpc DeleteProductReview(DeleteProductReviewRequest) returns (Empty)

Deletes a product review.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.
GetProductReview

rpc GetProductReview(GetProductReviewRequest) returns (ProductReview)

Gets a product review.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.
InsertProductReview

rpc InsertProductReview(InsertProductReviewRequest) returns (ProductReview)

Inserts a product review.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.
ListProductReviews

rpc ListProductReviews(ListProductReviewsRequest) returns (ListProductReviewsResponse)

Lists product reviews.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

DeleteMerchantReviewRequest

Request message for the DeleteMerchantReview method.

Fields
name

string

Required. The ID of the merchant review. Format: accounts/{account}/merchantReviews/{merchantReview}

DeleteProductReviewRequest

Request message for the DeleteProductReview method.

Fields
name

string

Required. The ID of the Product review. Format: accounts/{account}/productReviews/{productReview}

GetMerchantReviewRequest

Request message for the GetMerchantReview method.

Fields
name

string

Required. The ID of the merchant review. Format: accounts/{account}/merchantReviews/{merchantReview}

GetProductReviewRequest

Request message for the GetProductReview method.

Fields
name

string

Required. The ID of the merchant review. Format: accounts/{account}/productReviews/{productReview}

InsertMerchantReviewRequest

Request message for the InsertMerchantReview method.

Fields
parent

string

Required. The account where the merchant review will be inserted. Format: accounts/{account}
merchant_review

MerchantReview

Required. The merchant review to insert.
data_source

string

Required. The data source of the merchantreview Format: accounts/{account}/dataSources/{datasource}.

InsertProductReviewRequest

Request message for the InsertProductReview method.

Fields
parent

string

Required. The account where the product review will be inserted. Format: accounts/{account}
product_review

ProductReview

Required. The product review to insert.
data_source

string

Required. Format: accounts/{account}/dataSources/{datasource}.

ListMerchantReviewsRequest

Request message for the ListMerchantsReview method.

Fields
parent

string

Required. The account to list merchant reviews for. Format: accounts/{account}
page_size

int32

Optional. The maximum number of merchant reviews to return. The service can return fewer than this value. The maximum value is 1000; values above 1000 are coerced to 1000. If unspecified, the maximum number of reviews is returned.
page_token

string

Optional. A page token, received from a previous ListMerchantReviews call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListMerchantReviews must match the call that provided the page token.

ListMerchantReviewsResponse

Response message for the ListMerchantsReview method.

Fields
merchant_reviews[]

MerchantReview

The merchant review.
next_page_token

string

The token to retrieve the next page of results.

ListProductReviewsRequest

Request message for the ListProductReviews method.

Fields
parent

string

Required. The account to list product reviews for. Format: accounts/{account}
page_size

int32

Optional. The maximum number of products to return. The service may return fewer than this value.
page_token

string

Optional. A page token, received from a previous ListProductReviews call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListProductReviews must match the call that provided the page token.

ListProductReviewsResponse

response message for the ListProductReviews method.

Fields
product_reviews[]

ProductReview

The product review.
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

MerchantReview

A review for a merchant. For more information, see Introduction to Merchant Review Feeds

Fields
name

string

Identifier. The name of the merchant review. Format: "{merchantreview.name=accounts/{account}/merchantReviews/{merchantReview}}"
merchant_review_id

string

Required. The user provided merchant review ID to uniquely identify the merchant review.
attributes

MerchantReviewAttributes

Optional. A list of merchant review attributes.
custom_attributes[]

CustomAttribute

Required. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, { "name": "size type", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API, such as experimental attributes. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion.
data_source

string

Output only. The primary data source of the merchant review.
merchant_review_status

MerchantReviewStatus

Output only. The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously.

MerchantReviewAttributes

Attributes.

Fields
merchant_id

string

Required. Must be unique and stable across all requests. In other words, if a request today and another 90 days ago refer to the same merchant, they must have the same id.
merchant_display_name

string

Optional. Human-readable display name for the merchant.
min_rating

int64

Optional. The minimum possible number for the rating. This should be the worst possible rating and should not be a value for no rating.
max_rating

int64

Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min rating.
rating

double

Optional. The reviewer's overall rating of the merchant.
title

string

Optional. The title of the review.
content

string

Required. This should be any freeform text provided by the user and should not be truncated. If multiple responses to different questions are provided, all responses should be included, with the minimal context for the responses to make sense. Context should not be provided if questions were left unanswered.
reviewer_id

string

Optional. A permanent, unique identifier for the author of the review in the publisher's system.
reviewer_username

string

Optional. Display name of the review author.
is_anonymous

bool

Optional. Set to true if the reviewer should remain anonymous.
collection_method

CollectionMethod

Optional. The method used to collect the review.
review_time

Timestamp

Required. The timestamp indicating when the review was written.
review_language

string

Required. The language of the review defined by BCP-47 language code.
review_country

string

Optional. The country where the reviewer made the order defined by ISO 3166-1 Alpha-2 Country Code.

CollectionMethod

The method used to collect the review.

Enums
COLLECTION_METHOD_UNSPECIFIED Collection method unspecified.
MERCHANT_UNSOLICITED The user was not responding to a specific solicitation when they submitted the review.
POINT_OF_SALE The user submitted the review in response to a solicitation when the user placed an order.
AFTER_FULFILLMENT The user submitted the review in response to a solicitation after fulfillment of the user's order.

MerchantReviewStatus

The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously.

Fields
destination_statuses[]

MerchantReviewDestinationStatus

Output only. The intended destinations for the merchant review.
item_level_issues[]

MerchantReviewItemLevelIssue

Output only. A list of all issues associated with the merchant review.
create_time

Timestamp

Output only. Date on which the item has been created, in ISO 8601 format.
last_update_time

Timestamp

Output only. Date on which the item has been last updated, in ISO 8601 format.

MerchantReviewDestinationStatus

The destination status of the merchant review status.

Fields
reporting_context

ReportingContextEnum

Output only. The name of the reporting context.

MerchantReviewItemLevelIssue

The ItemLevelIssue of the merchant review status.

Fields
code

string

Output only. The error code of the issue.
severity

Severity

Output only. How this issue affects serving of the merchant review.
resolution

string

Output only. Whether the issue can be resolved by the merchant.
attribute

string

Output only. The attribute's name, if the issue is caused by a single attribute.
reporting_context

ReportingContextEnum

Output only. The reporting context the issue applies to.
description

string

Output only. A short issue description in English.
detail

string

Output only. A detailed issue description in English.
documentation

string

Output only. The URL of a web page to help with resolving this issue.

Severity

How the issue affects the serving of the merchant review.

Enums
SEVERITY_UNSPECIFIED Not specified.
NOT_IMPACTED This issue represents a warning and does not have a direct affect on the merchant review.
DISAPPROVED Issue disapproves the merchant review.

ProductReview

A review for a product. For more information, see Introduction to Product Review Feeds

Fields
name

string

Identifier. The name of the product review. Format: "{productreview.name=accounts/{account}/productReviews/{productReview}}"
product_review_id

string

Required. The permanent, unique identifier for the product review in the publisher’s system.
attributes

ProductReviewAttributes

Optional. A list of product review attributes.
custom_attributes[]

CustomAttribute

Optional. A list of custom (merchant-provided) attributes.
data_source

string

Output only. The primary data source of the product review.
product_review_status

ProductReviewStatus

Output only. The status of a product review, data validation issues, that is, information about a product review computed asynchronously.

ProductReviewAttributes

Attributes.

Fields
review_time

Timestamp

Required. The timestamp indicating when the review was written.
pros[]

string

Optional. Contains the advantages based on the opinion of the reviewer. Omit boilerplate text like "pro:" unless it was written by the reviewer.
cons[]

string

Optional. Contains the disadvantages based on the opinion of the reviewer. Omit boilerplate text like "con:" unless it was written by the reviewer.
product_names[]

string

Optional. Descriptive name of a product.
asins[]

string

Optional. Contains ASINs (Amazon Standard Identification Numbers) associated with a product.
gtins[]

string

Optional. Contains GTINs (global trade item numbers) associated with a product. Sub-types of GTINs (e.g. UPC, EAN, ISBN, JAN) are supported.
mpns[]

string

Optional. Contains MPNs (manufacturer part numbers) associated with a product.
skus[]

string

Optional. Contains SKUs (stock keeping units) associated with a product. Often this matches the product Offer Id in the product feed.
brands[]

string

Optional. Contains brand names associated with a product.
collection_method

CollectionMethod

Optional. The method used to collect the review.
transaction_id

string

Optional. A permanent, unique identifier for the transaction associated with the review in the publisher's system. This ID can be used to indicate that multiple reviews are associated with the same transaction.
aggregator_name

string

Optional. The name of the aggregator of the product reviews.

A publisher may use a reviews aggregator to manage reviews and provide the feeds. This element indicates the use of an aggregator and contains information about the aggregator.
subclient_name

string

Optional. The name of the subclient of the product reviews.

The subclient is an identifier of the product review source. It should be equivalent to the directory provided in the file data source path.
publisher_name

string

Optional. The name of the publisher of the product reviews.

The information about the publisher, which may be a retailer, manufacturer, reviews service company, or any entity that publishes product reviews.
publisher_favicon

string

Optional. A link to the company favicon of the publisher. The image dimensions should be favicon size: 16x16 pixels. The image format should be GIF, JPG or PNG.
reviewer_id

string

Optional. The author of the product review.

A permanent, unique identifier for the author of the review in the publisher's system.
reviewer_is_anonymous

bool

Optional. Set to true if the reviewer should remain anonymous.
reviewer_username

string

Optional. The name of the reviewer of the product review.
review_language

string

Optional. The language of the review defined by BCP-47 language code.
review_country

string

Optional. The country of the review defined by ISO 3166-1 Alpha-2 Country Code.
title

string

Optional. The title of the review.
content

string

Required. The content of the review.
min_rating

int64

Optional. Contains the ratings associated with the review. The minimum possible number for the rating. This should be the worst possible rating and should not be a value for no rating.
max_rating

int64

Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min attribute.
rating

double

Optional. The reviewer's overall rating of the product.
is_spam

bool

Optional. Indicates whether the review is marked as spam in the publisher's system.

CollectionMethod

The method used to collect the review.

Enums
COLLECTION_METHOD_UNSPECIFIED Collection method unspecified.
UNSOLICITED The user was not responding to a specific solicitation when they submitted the review.
POST_FULFILLMENT The user submitted the review in response to a solicitation after fulfillment of the user's order.

Type

Type of the review URI.

Enums
TYPE_UNSPECIFIED Type unspecified.
SINGLETON The review page contains only this single review.
GROUP The review page contains a group of reviews including this review.

ProductReviewStatus

Product review status.

Fields
destination_statuses[]

ProductReviewDestinationStatus

Output only. The intended destinations for the product review.
item_level_issues[]

ProductReviewItemLevelIssue

Output only. A list of all issues associated with the product review.
create_time

Timestamp

Output only. Date on which the item has been created, in ISO 8601 format.
last_update_time

Timestamp

Output only. Date on which the item has been last updated, in ISO 8601 format.

ProductReviewDestinationStatus

The destination status of the product review status.

Fields
reporting_context

ReportingContextEnum

Output only. The name of the reporting context.

ProductReviewItemLevelIssue

The ItemLevelIssue of the product review status.

Fields
code

string

Output only. The error code of the issue.
severity

Severity

Output only. How this issue affects serving of the product review.
resolution

string

Output only. Whether the issue can be resolved by the merchant.
attribute

string

Output only. The attribute's name, if the issue is caused by a single attribute.
reporting_context

ReportingContextEnum

Output only. The reporting context the issue applies to.
description

string

Output only. A short issue description in English.
detail

string

Output only. A detailed issue description in English.
documentation

string

Output only. The URL of a web page to help with resolving this issue.

Severity

How the issue affects the serving of the product review.

Enums
SEVERITY_UNSPECIFIED Not specified.
NOT_IMPACTED This issue represents a warning and does not have a direct affect on the product review.
DISAPPROVED Issue disapproves the product review.