Google Shopping Merchant Reviews V1beta Client - Class MerchantReview (0.1.0)

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Shopping Merchant Reviews V1beta Client class MerchantReview.

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

Generated from protobuf message google.shopping.merchant.reviews.v1beta.MerchantReview

Namespace

Google \ Shopping \ Merchant \ Reviews \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Identifier. The name of the merchant review. Format: "{merchantreview.name=accounts/{account}/merchantReviews/{merchantReview}}"
↳ merchant_review_id	string Required. The user provided merchant review ID to uniquely identify the merchant review.
↳ attributes	MerchantReviewAttributes Optional. A list of merchant review attributes.
↳ custom_attributes	array<Google\Shopping\Type\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.
↳ data_source	string Output only. The primary data source of the merchant review.
↳ merchant_review_status	MerchantReviewStatus Output only. The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously.

getName

Identifier. The name of the merchant review.

Format: "{merchantreview.name=accounts/{account}/merchantReviews/{merchantReview}}"

Returns
Type	Description
string

setName

Identifier. The name of the merchant review.

Format: "{merchantreview.name=accounts/{account}/merchantReviews/{merchantReview}}"

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getMerchantReviewId

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

Returns
Type	Description
string

setMerchantReviewId

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getAttributes

Optional. A list of merchant review attributes.

Returns
Type	Description
MerchantReviewAttributes|null

hasAttributes

clearAttributes

setAttributes

Optional. A list of merchant review attributes.

Parameter
Name	Description
var	MerchantReviewAttributes

Returns
Type	Description
$this

getCustomAttributes

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.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setCustomAttributes

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.

Parameter
Name	Description
var	array<Google\Shopping\Type\CustomAttribute>

Returns
Type	Description
$this

getDataSource

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

Returns
Type	Description
string

setDataSource

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getMerchantReviewStatus

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

Returns
Type	Description
MerchantReviewStatus|null

hasMerchantReviewStatus

clearMerchantReviewStatus

setMerchantReviewStatus

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

Parameter
Name	Description
var	MerchantReviewStatus

Returns
Type	Description
$this