- Resource: MerchantReview
- MerchantReviewAttributes
- CollectionMethod
- MerchantReviewStatus
- MerchantReviewDestinationStatus
- MerchantReviewItemLevelIssue
- Severity
- Methods
Resource: MerchantReview
A review for a merchant. For more information, see Introduction to Merchant Review Feeds
JSON representation |
---|
{ "name": string, "merchantReviewId": string, "attributes": { object ( |
Fields | |
---|---|
name |
Identifier. The name of the merchant review. Format: |
merchant |
Required. The user provided merchant review ID to uniquely identify the merchant review. |
attributes |
Optional. A list of merchant review attributes. |
custom |
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, |
data |
Output only. The primary data source of the merchant review. |
merchant |
Output only. The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously. |
MerchantReviewAttributes
Attributes.
JSON representation |
---|
{
"merchantId": string,
"merchantDisplayName": string,
"merchantLink": string,
"merchantRatingLink": string,
"minRating": string,
"maxRating": string,
"rating": number,
"title": string,
"content": string,
"reviewerId": string,
"reviewerUsername": string,
"isAnonymous": boolean,
"collectionMethod": enum ( |
Fields | |
---|---|
merchant |
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 |
Optional. Human-readable display name for the merchant. |
merchant |
Optional. URL to the merchant's main website. Do not use a redirect URL for this value. In other words, the value should point directly to the merchant's site. |
merchant |
Optional. URL to the landing page that hosts the reviews for this merchant. Do not use a redirect URL. |
min |
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 |
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 |
Optional. The reviewer's overall rating of the merchant. |
title |
Optional. The title of the review. |
content |
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 |
Optional. A permanent, unique identifier for the author of the review in the publisher's system. |
reviewer |
Optional. Display name of the review author. |
is |
Optional. Set to true if the reviewer should remain anonymous. |
collection |
Optional. The method used to collect the review. |
review |
Required. The timestamp indicating when the review was written. |
review |
Required. The language of the review defined by BCP-47 language code. |
review |
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.
JSON representation |
---|
{ "destinationStatuses": [ { object ( |
Fields | |
---|---|
destination |
Output only. The intended destinations for the merchant review. |
item |
Output only. A list of all issues associated with the merchant review. |
create |
Output only. Date on which the item has been created, in ISO 8601 format. |
last |
Output only. Date on which the item has been last updated, in ISO 8601 format. |
MerchantReviewDestinationStatus
The destination status of the merchant review status.
JSON representation |
---|
{
"reportingContext": enum ( |
Fields | |
---|---|
reporting |
Output only. The name of the reporting context. |
MerchantReviewItemLevelIssue
The ItemLevelIssue of the merchant review status.
JSON representation |
---|
{ "code": string, "severity": enum ( |
Fields | |
---|---|
code |
Output only. The error code of the issue. |
severity |
Output only. How this issue affects serving of the merchant review. |
resolution |
Output only. Whether the issue can be resolved by the merchant. |
attribute |
Output only. The attribute's name, if the issue is caused by a single attribute. |
reporting |
Output only. The reporting context the issue applies to. |
description |
Output only. A short issue description in English. |
detail |
Output only. A detailed issue description in English. |
documentation |
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. |
Methods |
|
---|---|
|
Deletes merchant review. |
|
Gets a merchant review. |
|
Inserts a review for your Merchant Center account. |
|
Lists merchant reviews. |