Reference documentation and code samples for the Google Shopping Merchant Reviews V1beta Client class MerchantReviewAttributes.
Attributes.
Generated from protobuf message google.shopping.merchant.reviews.v1beta.MerchantReviewAttributes
Namespace
Google \ Shopping \ Merchant \ Reviews \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ merchant_id |
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. |
↳ merchant_display_name |
string
Optional. Human-readable display name for the merchant. |
↳ merchant_link |
string
Optional. URL to the merchant's main website. Do not use a redirect URL for this value. In other words, the value should point directly to the merchant's site. |
↳ merchant_rating_link |
string
Optional. URL to the landing page that hosts the reviews for this merchant. Do not use a redirect URL. |
↳ min_rating |
int|string
Optional. 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 rating. |
↳ rating |
float
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. |
↳ reviewer_id |
string
Optional. A permanent, unique identifier for the author of the review in the publisher's system. |
↳ reviewer_username |
string
Optional. Display name of the review author. |
↳ is_anonymous |
bool
Optional. Set to true if the reviewer should remain anonymous. |
↳ collection_method |
int
Optional. The method used to collect the review. |
↳ review_time |
Google\Protobuf\Timestamp
Required. The timestamp indicating when the review was written. |
↳ review_language |
string
Required. The language of the review defined by BCP-47 language code. |
↳ review_country |
string
Optional. The country where the reviewer made the order defined by ISO 3166-1 Alpha-2 Country Code. |
getMerchantId
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasMerchantId
clearMerchantId
setMerchantId
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMerchantDisplayName
Optional. Human-readable display name for the merchant.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasMerchantDisplayName
clearMerchantDisplayName
setMerchantDisplayName
Optional. Human-readable display name for the merchant.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMerchantLink
Optional. URL to the merchant's main website. Do not use a redirect URL for this value. In other words, the value should point directly to the merchant's site.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasMerchantLink
clearMerchantLink
setMerchantLink
Optional. URL to the merchant's main website. Do not use a redirect URL for this value. In other words, the value should point directly to the merchant's site.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMerchantRatingLink
Optional. URL to the landing page that hosts the reviews for this merchant.
Do not use a redirect URL.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasMerchantRatingLink
clearMerchantRatingLink
setMerchantRatingLink
Optional. URL to the landing page that hosts the reviews for this merchant.
Do not use a redirect URL.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMinRating
Optional. 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. 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 rating.
| 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 rating.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRating
Optional. The reviewer's overall rating of the merchant.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasRating
clearRating
setRating
Optional. The reviewer's overall rating of the merchant.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| 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. 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.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasContent
clearContent
setContent
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReviewerId
Optional. A permanent, unique identifier for the author of the review in the publisher's system.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasReviewerId
clearReviewerId
setReviewerId
Optional. A permanent, unique identifier for the author of the review in the publisher's system.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReviewerUsername
Optional. Display name of the review author.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasReviewerUsername
clearReviewerUsername
setReviewerUsername
Optional. Display name of the review author.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIsAnonymous
Optional. Set to true if the reviewer should remain anonymous.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasIsAnonymous
clearIsAnonymous
setIsAnonymous
Optional. Set to true if the reviewer should remain anonymous.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCollectionMethod
Optional. The method used to collect the review.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasCollectionMethod
clearCollectionMethod
setCollectionMethod
Optional. The method used to collect the review.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| 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 |
|
getReviewLanguage
Required. The language of the review defined by BCP-47 language code.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasReviewLanguage
clearReviewLanguage
setReviewLanguage
Required. The language of the review defined by BCP-47 language code.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReviewCountry
Optional. The country where the reviewer made the order defined by ISO 3166-1 Alpha-2 Country Code.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasReviewCountry
clearReviewCountry
setReviewCountry
Optional. The country where the reviewer made the order defined by ISO 3166-1 Alpha-2 Country Code.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|