Google Shopping Merchant Inventories V1beta Client - Class RegionalInventory (0.4.5)

Version latest

• 0.4.5 (latest)
• 0.4.4
• 0.3.0
• 0.2.0
• 0.1.1

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 Inventories V1beta Client class RegionalInventory.

Regional inventory information for the product. Represents specific information like price and availability for a given product in a specific region.

For a list of all accepted attribute values, see the regional product inventory data specification.

Generated from protobuf message google.shopping.merchant.inventories.v1beta.RegionalInventory

Namespace

Google \ Shopping \ Merchant \ Inventories \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Output only. The name of the RegionalInventory resource. Format: {regional_inventory.name=accounts/{account}/products/{product}/regionalInventories/{region}
↳ account	int|string Output only. The account that owns the product. This field will be ignored if set by the client.
↳ region	string Required. Immutable. ID of the region for this RegionalInventory resource. See the Regional availability and pricing for more details.
↳ price	Google\Shopping\Type\Price Price of the product in this region.
↳ sale_price	Google\Shopping\Type\Price Sale price of the product in this region. Mandatory if salePriceEffectiveDate is defined.
↳ sale_price_effective_date	Google\Type\Interval The TimePeriod of the sale price in this region.
↳ availability	string Availability of the product in this region. For accepted attribute values, see the regional product inventory data specification
↳ custom_attributes	array<Google\Shopping\Type\CustomAttribute> A list of custom (merchant-provided) attributes. You can also use CustomAttribute to submit any attribute of the data specification in its generic form.

getName

Output only. The name of the RegionalInventory resource.

Format: {regional_inventory.name=accounts/{account}/products/{product}/regionalInventories/{region}

Returns
Type	Description
string

setName

Output only. The name of the RegionalInventory resource.

Format: {regional_inventory.name=accounts/{account}/products/{product}/regionalInventories/{region}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getAccount

Output only. The account that owns the product. This field will be ignored if set by the client.

Returns
Type	Description
int|string

setAccount

Output only. The account that owns the product. This field will be ignored if set by the client.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getRegion

Required. Immutable. ID of the region for this RegionalInventory resource. See the Regional availability and pricing for more details.

Returns
Type	Description
string

setRegion

Required. Immutable. ID of the region for this RegionalInventory resource. See the Regional availability and pricing for more details.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPrice

Price of the product in this region.

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

hasPrice

clearPrice

setPrice

Price of the product in this region.

Parameter
Name	Description
var	Google\Shopping\Type\Price

Returns
Type	Description
$this

getSalePrice

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

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

hasSalePrice

clearSalePrice

setSalePrice

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

The TimePeriod of the sale price in this region.

Returns
Type	Description
Google\Type\Interval|null

hasSalePriceEffectiveDate

clearSalePriceEffectiveDate

setSalePriceEffectiveDate

The TimePeriod of the sale price in this region.

Parameter
Name	Description
var	Google\Type\Interval

Returns
Type	Description
$this

getAvailability

Availability of the product in this region.

For accepted attribute values, see the regional product inventory data specification

Returns
Type	Description
string

hasAvailability

clearAvailability

setAvailability

Availability of the product in this region.

For accepted attribute values, see the regional product inventory data specification

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCustomAttributes

A list of custom (merchant-provided) attributes. You can also use CustomAttribute to submit any attribute of the data specification in its generic form.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setCustomAttributes

A list of custom (merchant-provided) attributes. You can also use CustomAttribute to submit any attribute of the data specification in its generic form.

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

Returns
Type	Description
$this