Google Shopping Merchant Inventories V1 Client - Class RegionalInventory (1.0.0)

Reference documentation and code samples for the Google Shopping Merchant Inventories V1 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.v1.RegionalInventory

Namespace

Google \ Shopping \ Merchant \ Inventories \ V1

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.

↳ regional_inventory_attributes RegionalInventoryAttributes

Optional. A list of regional inventory attributes.

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

getRegionalInventoryAttributes

Optional. A list of regional inventory attributes.

Returns
Type Description
RegionalInventoryAttributes|null

hasRegionalInventoryAttributes

clearRegionalInventoryAttributes

setRegionalInventoryAttributes

Optional. A list of regional inventory attributes.

Parameter
Name Description
var RegionalInventoryAttributes
Returns
Type Description
$this