Reference documentation and code samples for the Google Shopping Merchant Reviews V1beta Client class ProductReviewAttributes.
Attributes.
Generated from protobuf message google.shopping.merchant.reviews.v1beta.ProductReviewAttributes
Namespace
Google \ Shopping \ Merchant \ Reviews \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ 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. |
↳ review_time |
Google\Protobuf\Timestamp
Required. The timestamp indicating when the review was written. |
↳ title |
string
Optional. The title of the review. |
↳ content |
string
Required. The content of the review. |
↳ pros |
array
Optional. Contains the advantages based on the opinion of the reviewer. Omit boilerplate text like "pro:" unless it was written by the reviewer. |
↳ cons |
array
Optional. Contains the disadvantages based on the opinion of the reviewer. Omit boilerplate text like "con:" unless it was written by the reviewer. |
↳ review_link |
ProductReviewAttributes\ReviewLink
Optional. The URI of the review landing page. |
↳ reviewer_image_links |
array
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. |
↳ min_rating |
int|string
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 |
int|string
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 |
float
Optional. The reviewer's overall rating of the product. |
↳ product_names |
array
Optional. Descriptive name of a product. |
↳ product_links |
array
Optional. The URI of the product. This URI can have the same value as the |
↳ asins |
array
Optional. Contains ASINs (Amazon Standard Identification Numbers) associated with a product. |
↳ gtins |
array
Optional. Contains GTINs (global trade item numbers) associated with a product. Sub-types of GTINs (e.g. UPC, EAN, ISBN, JAN) are supported. |
↳ mpns |
array
Optional. Contains MPNs (manufacturer part numbers) associated with a product. |
↳ skus |
array
Optional. Contains SKUs (stock keeping units) associated with a product. Often this matches the product Offer Id in the product feed. |
↳ brands |
array
Optional. Contains brand names associated with a product. |
↳ is_spam |
bool
Optional. Indicates whether the review is marked as spam in the publisher's system. |
↳ collection_method |
int
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. |
getAggregatorName
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasAggregatorName
clearAggregatorName
setAggregatorName
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSubclientName
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSubclientName
clearSubclientName
setSubclientName
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPublisherName
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasPublisherName
clearPublisherName
setPublisherName
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPublisherFavicon
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasPublisherFavicon
clearPublisherFavicon
setPublisherFavicon
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReviewerId
Optional. The author of the product review.
A permanent, unique identifier for the author of the review in the publisher's system.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasReviewerId
clearReviewerId
setReviewerId
Optional. The author of the product review.
A permanent, unique identifier for the author of the review in the publisher's system.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReviewerIsAnonymous
Optional. Set to true if the reviewer should remain anonymous.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasReviewerIsAnonymous
clearReviewerIsAnonymous
setReviewerIsAnonymous
Optional. Set to true if the reviewer should remain anonymous.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReviewerUsername
Optional. The name of the reviewer of the product review.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasReviewerUsername
clearReviewerUsername
setReviewerUsername
Optional. The name of the reviewer of the product review.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReviewLanguage
Optional. The language of the review defined by BCP-47 language code.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasReviewLanguage
clearReviewLanguage
setReviewLanguage
Optional. The language of the review defined by BCP-47 language code.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReviewCountry
Optional. The country of the review defined by ISO 3166-1 Alpha-2 Country Code.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasReviewCountry
clearReviewCountry
setReviewCountry
Optional. The country of the review defined by ISO 3166-1 Alpha-2 Country Code.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReviewTime
Required. The timestamp indicating when the review was written.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasReviewTime
clearReviewTime
setReviewTime
Required. The timestamp indicating when the review was written.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTitle
Optional. The title of the review.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasTitle
clearTitle
setTitle
Optional. The title of the review.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getContent
Required. The content of the review.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasContent
clearContent
setContent
Required. The content of the review.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPros
Optional. Contains the advantages based on the opinion of the reviewer.
Omit boilerplate text like "pro:" unless it was written by the reviewer.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setPros
Optional. Contains the advantages based on the opinion of the reviewer.
Omit boilerplate text like "pro:" unless it was written by the reviewer.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCons
Optional. Contains the disadvantages based on the opinion of the reviewer.
Omit boilerplate text like "con:" unless it was written by the reviewer.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCons
Optional. Contains the disadvantages based on the opinion of the reviewer.
Omit boilerplate text like "con:" unless it was written by the reviewer.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReviewLink
Optional. The URI of the review landing page.
| Returns | |
|---|---|
| Type | Description |
ProductReviewAttributes\ReviewLink|null |
|
hasReviewLink
clearReviewLink
setReviewLink
Optional. The URI of the review landing page.
| Parameter | |
|---|---|
| Name | Description |
var |
ProductReviewAttributes\ReviewLink
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReviewerImageLinks
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setReviewerImageLinks
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMinRating
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.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasMinRating
clearMinRating
setMinRating
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaxRating
Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min attribute.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasMaxRating
clearMaxRating
setMaxRating
Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min attribute.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRating
Optional. The reviewer's overall rating of the product.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasRating
clearRating
setRating
Optional. The reviewer's overall rating of the product.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProductNames
Optional. Descriptive name of a product.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setProductNames
Optional. Descriptive name of a product.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProductLinks
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setProductLinks
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAsins
Optional. Contains ASINs (Amazon Standard Identification Numbers) associated with a product.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAsins
Optional. Contains ASINs (Amazon Standard Identification Numbers) associated with a product.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGtins
Optional. Contains GTINs (global trade item numbers) associated with a product. Sub-types of GTINs (e.g. UPC, EAN, ISBN, JAN) are supported.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setGtins
Optional. Contains GTINs (global trade item numbers) associated with a product. Sub-types of GTINs (e.g. UPC, EAN, ISBN, JAN) are supported.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMpns
Optional. Contains MPNs (manufacturer part numbers) associated with a product.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setMpns
Optional. Contains MPNs (manufacturer part numbers) associated with a product.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSkus
Optional. Contains SKUs (stock keeping units) associated with a product.
Often this matches the product Offer Id in the product feed.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setSkus
Optional. Contains SKUs (stock keeping units) associated with a product.
Often this matches the product Offer Id in the product feed.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBrands
Optional. Contains brand names associated with a product.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setBrands
Optional. Contains brand names associated with a product.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIsSpam
Optional. Indicates whether the review is marked as spam in the publisher's system.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasIsSpam
clearIsSpam
setIsSpam
Optional. Indicates whether the review is marked as spam in the publisher's system.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCollectionMethod
Optional. The method used to collect the review.
| Returns | |
|---|---|
| Type | Description |
int |
|
setCollectionMethod
Optional. The method used to collect the review.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTransactionId
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTransactionId
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|