Google Shopping Merchant Inventories V1 Client - Class RegionalInventoryAttributes (1.4.0)

Reference documentation and code samples for the Google Shopping Merchant Inventories V1 Client class RegionalInventoryAttributes.

Regional inventory attributes.

Generated from protobuf message google.shopping.merchant.inventories.v1.RegionalInventoryAttributes

Namespace

Google \ Shopping \ Merchant \ Inventories \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ price Google\Shopping\Type\Price

Optional. Price of the product in this region.

↳ sale_price Google\Shopping\Type\Price

Optional. Sale price of the product in this region. Mandatory if salePriceEffectiveDate is defined.

↳ sale_price_effective_date Google\Type\Interval

Optional. The TimePeriod of the sale price in this region.

↳ availability int

Optional. Availability of the product in this region.

↳ loyalty_programs array<InventoryLoyaltyProgram>

Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product in this region. This field is used to show region-specific member prices on Product Listing Ads (PLA). To use this, the loyalty program must be configured in Google Merchant Center, and the merchant must be using the Regional Availability and Pricing (RAAP) feature. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries. See Loyalty program for details on supported countries and loyalty program configuration. Also see Regional availability and pricing and How to set up regional member pricing for more information.

getPrice

Optional. Price of the product in this region.

Returns
Type Description
Google\Shopping\Type\Price|null

hasPrice

clearPrice

setPrice

Optional. Price of the product in this region.

Parameter
Name Description
var Google\Shopping\Type\Price
Returns
Type Description
$this

getSalePrice

Optional. Sale price of the product in this region. Mandatory if salePriceEffectiveDate is defined.

Returns
Type Description
Google\Shopping\Type\Price|null

hasSalePrice

clearSalePrice

setSalePrice

Optional. Sale price of the product in this region. Mandatory if salePriceEffectiveDate is defined.

Parameter
Name Description
var Google\Shopping\Type\Price
Returns
Type Description
$this

getSalePriceEffectiveDate

Optional. The TimePeriod of the sale price in this region.

Returns
Type Description
Google\Type\Interval|null

hasSalePriceEffectiveDate

clearSalePriceEffectiveDate

setSalePriceEffectiveDate

Optional. The TimePeriod of the sale price in this region.

Parameter
Name Description
var Google\Type\Interval
Returns
Type Description
$this

getAvailability

Optional.

Availability of the product in this region.

Returns
Type Description
int

hasAvailability

clearAvailability

setAvailability

Optional.

Availability of the product in this region.

Parameter
Name Description
var int
Returns
Type Description
$this

getLoyaltyPrograms

Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product in this region.

This field is used to show region-specific member prices on Product Listing Ads (PLA). To use this, the loyalty program must be configured in Google Merchant Center, and the merchant must be using the Regional Availability and Pricing (RAAP) feature. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries. See Loyalty program for details on supported countries and loyalty program configuration. Also see Regional availability and pricing and How to set up regional member pricing for more information.

Returns
Type Description
Google\Protobuf\RepeatedField<InventoryLoyaltyProgram>

setLoyaltyPrograms

Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product in this region.

This field is used to show region-specific member prices on Product Listing Ads (PLA). To use this, the loyalty program must be configured in Google Merchant Center, and the merchant must be using the Regional Availability and Pricing (RAAP) feature. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries. See Loyalty program for details on supported countries and loyalty program configuration. Also see Regional availability and pricing and How to set up regional member pricing for more information.

Parameter
Name Description
var array<InventoryLoyaltyProgram>
Returns
Type Description
$this