Class LocalInventory (2.5.0) 

LocalInventory(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The inventory information at a place (e.g. a store) identified by a place ID.

Attributes
Name Description
place_id str
Optional. The place ID for the current set of inventory information.
price_info google.cloud.retail_v2alpha.types.PriceInfo
Optional. Product price and cost information. Google Merchant Center property price __.
availability google.cloud.retail_v2alpha.types.LocalInventory.Availability
Optional. The availability of the Product at this place_id. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered "in stock" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property availability __. Schema.org property Offer.availability __. This field is currently only used by the Recommendations API. For Search, please make use of fulfillment_types or custom attributes for similar behaviour. See here __ for more details.
attributes MutableMapping[str, google.cloud.retail_v2alpha.types.CustomAttribute]
Optional. Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: - At most 30 attributes are allowed. - The key must be a UTF-8 encoded string with a length limit of 32 characters. - The key must match the pattern: ``a-zA-Z0-9][a-zA-Z0-9_]*``. For example, key0LikeThis or KEY_1_LIKE_THIS. - The attribute values must be of the same type (text or number). - Only 1 value is allowed for each attribute. - For text values, the length limit is 256 UTF-8 characters. - The attribute does not support search. The searchable field should be unset or set to false. - The max summed total bytes of custom attribute keys and values per product is 5MiB.
fulfillment_types MutableSequence[str]
Optional. Supported fulfillment types. Valid fulfillment type values include commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI. Supported values: - "pickup-in-store" - "ship-to-store" - "same-day-delivery" - "next-day-delivery" - "custom-type-1" - "custom-type-2" - "custom-type-3" - "custom-type-4" - "custom-type-5" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.

Classes

AttributesEntry

AttributesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.
mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

Availability

Availability(value)

Product availability. If this field is unspecified, the product is assumed to be in stock.