ProductReviewAttributes

import type { ProductReviewAttributes } from "https://googleapis.deno.dev/v1/merchantapi:reviews_v1beta.ts";

Attributes.

interface ProductReviewAttributes {

aggregatorName?: string;

asins?: string[];

brands?: string[];

collectionMethod?: "COLLECTION_METHOD_UNSPECIFIED" | "UNSOLICITED" | "POST_FULFILLMENT";

cons?: string[];

content?: string;

gtins?: string[];

isSpam?: boolean;

maxRating?: bigint;

minRating?: bigint;

mpns?: string[];

productLinks?: string[];

productNames?: string[];

pros?: string[];

publisherFavicon?: string;

publisherName?: string;

rating?: number;

reviewCountry?: string;

reviewerId?: string;

reviewerImageLinks?: string[];

reviewerIsAnonymous?: boolean;

reviewerUsername?: string;

reviewLanguage?: string;

reviewLink?: ReviewLink;

reviewTime?: Date;

skus?: string[];

subclientName?: string;

title?: string;

transactionId?: string;

}

§Properties

aggregatorName?: string

[src]

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.

asins?: string[]

[src]

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

brands?: string[]

[src]

Optional. Contains brand names associated with a product.

collectionMethod?: "COLLECTION_METHOD_UNSPECIFIED" | "UNSOLICITED" | "POST_FULFILLMENT"

[src]

Optional. The method used to collect the review.

cons?: string[]

[src]

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

content?: string

[src]

Required. The content of the review.

gtins?: string[]

[src]

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

isSpam?: boolean

[src]

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

maxRating?: bigint

[src]

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

minRating?: bigint

[src]

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.

mpns?: string[]

[src]

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

productLinks?: string[]

[src]

Optional. The URI of the product. This URI can have the same value as the review_link element, if the review URI and the product URI are the same.

productNames?: string[]

[src]

Optional. Descriptive name of a product.

pros?: string[]

[src]

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

publisherFavicon?: string

[src]

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.

publisherName?: string

[src]

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.

rating?: number

[src]

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

reviewCountry?: string

[src]

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

reviewerId?: string

[src]

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

reviewerImageLinks?: string[]

[src]

Optional. A URI to an image of the reviewed product created by the review author. The URI does not have to end with an image file extension.

reviewerIsAnonymous?: boolean

[src]

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

reviewerUsername?: string

[src]

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

reviewLanguage?: string

[src]

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

reviewLink?: ReviewLink

[src]

Optional. The URI of the review landing page.

reviewTime?: Date

[src]

Required. The timestamp indicating when the review was written.

skus?: string[]

[src]

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

subclientName?: string

[src]

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.

title?: string

[src]

Optional. The title of the review.

transactionId?: string

[src]

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.