Google Shopping Merchant Promotions V1beta Client - Class Promotion (0.1.0)

Reference documentation and code samples for the Google Shopping Merchant Promotions V1beta Client class Promotion.

Represents a promotion. See the following articles for more details.

Required promotion input attributes to pass data validation checks are primarily defined below:

Generated from protobuf message google.shopping.merchant.promotions.v1beta.Promotion

Namespace

Google \ Shopping \ Merchant \ Promotions \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Identifier. The name of the promotion. Format: accounts/{account}/promotions/{promotion}
↳ promotion_id string

Required. The user provided promotion ID to uniquely identify the promotion. Follow minimum requirements to prevent promotion disapprovals.
↳ content_language string

Required. The two-letter ISO 639-1 language code for the promotion. Promotions is only for selected languages.
↳ target_country string

Required. The target country used as part of the unique identifier. Represented as a CLDR territory code. Promotions are only available in selected countries, Free Listings and Shopping ads Local Inventory ads
↳ redemption_channel array

Required. Redemption channel for the promotion. At least one channel is required.
↳ data_source string

Output only. The primary data source of the promotion.
↳ attributes Google\Shopping\Merchant\Promotions\V1beta\Attributes

Optional. A list of promotion attributes.
↳ custom_attributes array<Google\Shopping\Type\CustomAttribute>

Optional. 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.
↳ promotion_status Google\Shopping\Merchant\Promotions\V1beta\PromotionStatus

Output only. The status of a promotion, data validation issues, that is, information about a promotion computed asynchronously.
↳ version_number int|string

Optional. Represents the existing version (freshness) of the promotion, which can be used to preserve the right order when multiple updates are done at the same time. If set, the insertion is prevented when version number is lower than the current version number of the existing promotion. Re-insertion (for example, promotion refresh after 30 days) can be performed with the current version_number. If the operation is prevented, the aborted exception will be thrown.

getName

Identifier. The name of the promotion.

Format: accounts/{account}/promotions/{promotion}

Returns
Type Description
string

setName

Identifier. The name of the promotion.

Format: accounts/{account}/promotions/{promotion}

Parameter
Name Description
var string
Returns
Type Description
$this

getPromotionId

Required. The user provided promotion ID to uniquely identify the promotion. Follow minimum requirements to prevent promotion disapprovals.

Returns
Type Description
string

setPromotionId

Required. The user provided promotion ID to uniquely identify the promotion. Follow minimum requirements to prevent promotion disapprovals.

Parameter
Name Description
var string
Returns
Type Description
$this

getContentLanguage

Required. The two-letter ISO 639-1 language code for the promotion.

Promotions is only for selected languages.

Returns
Type Description
string

setContentLanguage

Required. The two-letter ISO 639-1 language code for the promotion.

Promotions is only for selected languages.

Parameter
Name Description
var string
Returns
Type Description
$this

getTargetCountry

Required. The target country used as part of the unique identifier.

Represented as a CLDR territory code. Promotions are only available in selected countries, Free Listings and Shopping ads Local Inventory ads

Returns
Type Description
string

setTargetCountry

Required. The target country used as part of the unique identifier.

Represented as a CLDR territory code. Promotions are only available in selected countries, Free Listings and Shopping ads Local Inventory ads

Parameter
Name Description
var string
Returns
Type Description
$this

getRedemptionChannel

Required. Redemption channel for the promotion. At least one channel is required.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRedemptionChannel

Required. Redemption channel for the promotion. At least one channel is required.

Parameter
Name Description
var int[]
Returns
Type Description
$this

getDataSource

Output only. The primary data source of the promotion.

Returns
Type Description
string

setDataSource

Output only. The primary data source of the promotion.

Parameter
Name Description
var string
Returns
Type Description
$this

getAttributes

Optional. A list of promotion attributes.

Returns
Type Description
Google\Shopping\Merchant\Promotions\V1beta\Attributes|null

hasAttributes

clearAttributes

setAttributes

Optional. A list of promotion attributes.

Parameter
Name Description
var Google\Shopping\Merchant\Promotions\V1beta\Attributes
Returns
Type Description
$this

getCustomAttributes

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setCustomAttributes

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

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

getPromotionStatus

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

Returns
Type Description
Google\Shopping\Merchant\Promotions\V1beta\PromotionStatus|null

hasPromotionStatus

clearPromotionStatus

setPromotionStatus

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

Parameter
Name Description
var Google\Shopping\Merchant\Promotions\V1beta\PromotionStatus
Returns
Type Description
$this

getVersionNumber

Optional. Represents the existing version (freshness) of the promotion, which can be used to preserve the right order when multiple updates are done at the same time.

If set, the insertion is prevented when version number is lower than the current version number of the existing promotion. Re-insertion (for example, promotion refresh after 30 days) can be performed with the current version_number. If the operation is prevented, the aborted exception will be thrown.

Returns
Type Description
int|string

hasVersionNumber

clearVersionNumber

setVersionNumber

Optional. Represents the existing version (freshness) of the promotion, which can be used to preserve the right order when multiple updates are done at the same time.

If set, the insertion is prevented when version number is lower than the current version number of the existing promotion. Re-insertion (for example, promotion refresh after 30 days) can be performed with the current version_number. If the operation is prevented, the aborted exception will be thrown.

Parameter
Name Description
var int|string
Returns
Type Description
$this