Google Shopping Merchant Inventories V1 Client - Class LocalInventory (0.7.0)

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

Local inventory information for the product. Represents in-store information for a specific product at the store specified by storeCode.

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

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

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 LocalInventory resource. Format: accounts/{account}/products/{product}/localInventories/{store_code}

↳ account int|string

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

↳ store_code string

Required. Immutable. Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the Local product inventory data specification for more information.

↳ local_inventory_attributes LocalInventoryAttributes

Optional. A list of local inventory attributes.

getName

Output only. The name of the LocalInventory resource.

Format: accounts/{account}/products/{product}/localInventories/{store_code}

Returns
Type Description
string

setName

Output only. The name of the LocalInventory resource.

Format: accounts/{account}/products/{product}/localInventories/{store_code}

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

getStoreCode

Required. Immutable. Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the Local product inventory data specification for more information.

Returns
Type Description
string

setStoreCode

Required. Immutable. Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the Local product inventory data specification for more information.

Parameter
Name Description
var string
Returns
Type Description
$this

getLocalInventoryAttributes

Optional. A list of local inventory attributes.

Returns
Type Description
LocalInventoryAttributes|null

hasLocalInventoryAttributes

clearLocalInventoryAttributes

setLocalInventoryAttributes

Optional. A list of local inventory attributes.

Parameter
Name Description
var LocalInventoryAttributes
Returns
Type Description
$this