REST Resource: accounts.productReviews

Resource: ProductReview

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

JSON representation 
{
  "name": string,
  "productReviewId": string,
  "attributes": {
    object (ProductReviewAttributes)
  },
  "customAttributes": [
    {
      object (CustomAttribute)
    }
  ],
  "dataSource": string,
  "productReviewStatus": {
    object (ProductReviewStatus)
  }
}
Fields
name

string

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

string

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

object (ProductReviewAttributes)

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

object (CustomAttribute)

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

string

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

object (ProductReviewStatus)

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

ProductReviewAttributes

Attributes.

JSON representation 
{
  "reviewTime": string,
  "pros": [
    string
  ],
  "cons": [
    string
  ],
  "reviewLink": {
    object (ReviewLink)
  },
  "reviewerImageLinks": [
    string
  ],
  "productNames": [
    string
  ],
  "productLinks": [
    string
  ],
  "asins": [
    string
  ],
  "gtins": [
    string
  ],
  "mpns": [
    string
  ],
  "skus": [
    string
  ],
  "brands": [
    string
  ],
  "collectionMethod": enum (CollectionMethod),
  "transactionId": string,
  "aggregatorName": string,
  "subclientName": string,
  "publisherName": string,
  "publisherFavicon": string,
  "reviewerId": string,
  "reviewerIsAnonymous": boolean,
  "reviewerUsername": string,
  "reviewLanguage": string,
  "reviewCountry": string,
  "title": string,
  "content": string,
  "minRating": string,
  "maxRating": string,
  "rating": number,
  "isSpam": boolean
}
Fields
reviewTime

string (Timestamp format)

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.
productNames[]

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

enum (CollectionMethod)

Optional. The method used to collect the review.
transactionId

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

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

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

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

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

string

Optional. The author of the product review.

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

boolean

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

string

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

string

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

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

string (int64 format)

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.
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 attribute.
rating

number

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

boolean

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

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.

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.

ProductReviewStatus

Product review status.

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

object (ProductReviewDestinationStatus)

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

object (ProductReviewItemLevelIssue)

Output only. A list of all issues associated with the product 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.

ProductReviewDestinationStatus

The destination status of the product review status.

JSON representation 
{
  "reportingContext": enum (ReportingContextEnum)
}
Fields
reportingContext

enum (ReportingContextEnum)

Output only. The name of the reporting context.

ProductReviewItemLevelIssue

The ItemLevelIssue of the product 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 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.
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 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.

Methods

delete

 Deletes a product review.

get

 Gets a product review.

insert

 Inserts a product review.

list

 Lists product reviews.