REST Resource: accounts.merchantReviews

Resource: MerchantReview

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

JSON representation 
{
  "name": string,
  "merchantReviewId": string,
  "attributes": {
    object (MerchantReviewAttributes)
  },
  "customAttributes": [
    {
      object (CustomAttribute)
    }
  ],
  "dataSource": string,
  "merchantReviewStatus": {
    object (MerchantReviewStatus)
  }
}
Fields
name

string

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

string

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

object (MerchantReviewAttributes)

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

object (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.
dataSource

string

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

object (MerchantReviewStatus)

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 (CollectionMethod),
  "reviewTime": string,
  "reviewLanguage": string,
  "reviewCountry": string
}
Fields
merchantId

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.
merchantDisplayName

string

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

string (int64 format)

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

string (int64 format)

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

number

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.
reviewerId

string

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

string

Optional. Display name of the review author.
isAnonymous

boolean

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

enum (CollectionMethod)

Optional. The method used to collect the review.
reviewTime

string (Timestamp format)

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

string

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

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.

JSON representation 
{
  "destinationStatuses": [
    {
      object (MerchantReviewDestinationStatus)
    }
  ],
  "itemLevelIssues": [
    {
      object (MerchantReviewItemLevelIssue)
    }
  ],
  "createTime": string,
  "lastUpdateTime": string
}
Fields
destinationStatuses[]

object (MerchantReviewDestinationStatus)

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

object (MerchantReviewItemLevelIssue)

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

string (Timestamp format)

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

string (Timestamp format)

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 (ReportingContextEnum)
}
Fields
reportingContext

enum (ReportingContextEnum)

Output only. The name of the reporting context.

MerchantReviewItemLevelIssue

The ItemLevelIssue of the merchant review status.

JSON representation 
{
  "code": string,
  "severity": enum (Severity),
  "resolution": string,
  "attribute": string,
  "reportingContext": enum (ReportingContextEnum),
  "description": string,
  "detail": string,
  "documentation": string
}
Fields
code

string

Output only. The error code of the issue.
severity

enum (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.
reportingContext

enum (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.

Methods

delete

 Deletes merchant review.

get

 Gets a merchant review.

insert

 Inserts a review for your Merchant Center account.

list

 Lists merchant reviews.