Google Shopping Merchant Lfp V1beta Client - Class LfpInventory (1.1.1)

Reference documentation and code samples for the Google Shopping Merchant Lfp V1beta Client class LfpInventory.

Local Inventory for the merchant.

Generated from protobuf message google.shopping.merchant.lfp.v1beta.LfpInventory

Namespace

Google \ Shopping \ Merchant \ Lfp \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Output only. Identifier. The name for the LfpInventory resource. Format: accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}
↳ target_account int|string

Required. The Merchant Center ID of the merchant to submit the inventory for.
↳ store_code string

Required. The identifier of the merchant's store. Either the store code inserted through InsertLfpStore or the store code in the Business Profile.
↳ offer_id string

Required. Immutable. A unique identifier for the product. If both inventories and sales are submitted for a merchant, this id should match for the same product. Note: if the merchant sells the same product new and used, they should have different IDs.
↳ region_code string

Required. The CLDR territory code for the country where the product is sold.
↳ content_language string

Required. The two-letter ISO 639-1 language code for the item.
↳ gtin string

Optional. The Global Trade Item Number of the product.
↳ price Google\Shopping\Type\Price

Optional. The current price of the product.
↳ availability string

Required. Availability of the product at this store. For accepted attribute values, see the local product inventory data specification
↳ quantity int|string

Optional. Quantity of the product available at this store. Must be greater than or equal to zero.
↳ collection_time Google\Protobuf\Timestamp

Optional. The time when the inventory is collected. If not set, it will be set to the time when the inventory is submitted.
↳ pickup_method string

Optional. Supported pickup method for this offer. Unless the value is "not supported", this field must be submitted together with pickupSla. For accepted attribute values, see the local product inventory data specification.
↳ pickup_sla string

Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with pickupMethod. For accepted attribute values, see the local product inventory data specification.
↳ feed_label string

Optional. The feed label for the product. If this is not set, it will default to regionCode.

getName

Output only. Identifier. The name for the LfpInventory resource.

Format: accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}

Returns
Type Description
string

setName

Output only. Identifier. The name for the LfpInventory resource.

Format: accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}

Parameter
Name Description
var string
Returns
Type Description
$this

getTargetAccount

Required. The Merchant Center ID of the merchant to submit the inventory for.

Returns
Type Description
int|string

setTargetAccount

Required. The Merchant Center ID of the merchant to submit the inventory for.

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

getStoreCode

Required. The identifier of the merchant's store. Either the store code inserted through InsertLfpStore or the store code in the Business Profile.

Returns
Type Description
string

setStoreCode

Required. The identifier of the merchant's store. Either the store code inserted through InsertLfpStore or the store code in the Business Profile.

Parameter
Name Description
var string
Returns
Type Description
$this

getOfferId

Required. Immutable. A unique identifier for the product. If both inventories and sales are submitted for a merchant, this id should match for the same product.

Note: if the merchant sells the same product new and used, they should have different IDs.

Returns
Type Description
string

setOfferId

Required. Immutable. A unique identifier for the product. If both inventories and sales are submitted for a merchant, this id should match for the same product.

Note: if the merchant sells the same product new and used, they should have different IDs.

Parameter
Name Description
var string
Returns
Type Description
$this

getRegionCode

Required. The CLDR territory code for the country where the product is sold.

Returns
Type Description
string

setRegionCode

Required. The CLDR territory code for the country where the product is sold.

Parameter
Name Description
var string
Returns
Type Description
$this

getContentLanguage

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

Returns
Type Description
string

setContentLanguage

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

Parameter
Name Description
var string
Returns
Type Description
$this

getGtin

Optional. The Global Trade Item Number of the product.

Returns
Type Description
string

hasGtin

clearGtin

setGtin

Optional. The Global Trade Item Number of the product.

Parameter
Name Description
var string
Returns
Type Description
$this

getPrice

Optional. The current price of the product.

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

hasPrice

clearPrice

setPrice

Optional. The current price of the product.

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

getAvailability

Required. Availability of the product at this store.

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

Returns
Type Description
string

setAvailability

Required. Availability of the product at this store.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getQuantity

Optional. Quantity of the product available at this store. Must be greater than or equal to zero.

Returns
Type Description
int|string

hasQuantity

clearQuantity

setQuantity

Optional. Quantity of the product available at this store. Must be greater than or equal to zero.

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

getCollectionTime

Optional. The time when the inventory is collected. If not set, it will be set to the time when the inventory is submitted.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCollectionTime

clearCollectionTime

setCollectionTime

Optional. The time when the inventory is collected. If not set, it will be set to the time when the inventory is submitted.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getPickupMethod

Optional. Supported pickup method for this offer. Unless the value is "not supported", this field must be submitted together with pickupSla. For accepted attribute values, see the local product inventory data specification.

Returns
Type Description
string

hasPickupMethod

clearPickupMethod

setPickupMethod

Optional. Supported pickup method for this offer. Unless the value is "not supported", this field must be submitted together with pickupSla. For accepted attribute values, see the local product inventory data specification.

Parameter
Name Description
var string
Returns
Type Description
$this

getPickupSla

Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with pickupMethod. For accepted attribute values, see the local product inventory data specification.

Returns
Type Description
string

hasPickupSla

clearPickupSla

setPickupSla

Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with pickupMethod. For accepted attribute values, see the local product inventory data specification.

Parameter
Name Description
var string
Returns
Type Description
$this

getFeedLabel

Optional. The feed label for the product. If this is not set, it will default to regionCode.

Returns
Type Description
string

hasFeedLabel

clearFeedLabel

setFeedLabel

Optional. The feed label for the product. If this is not set, it will default to regionCode.

Parameter
Name Description
var string
Returns
Type Description
$this