Class ProductCatalogItem (0.10.9)

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

ProductCatalogItem captures item metadata specific to retail products.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
`exact_price`	`google.cloud.recommendationengine_v1beta1.types.ProductCatalogItem.ExactPrice` Optional. The exact product price. This field is a member of `oneof`_ `price`.
`price_range`	`google.cloud.recommendationengine_v1beta1.types.ProductCatalogItem.PriceRange` Optional. The product price range. This field is a member of `oneof`_ `price`.
`costs`	`MutableMapping[str, float]` Optional. A map to pass the costs associated with the product. For example: {"manufacturing": 45.5} The profit of selling this item is computed like so: - If 'exactPrice' is provided, profit = displayPrice - sum(costs) - If 'priceRange' is provided, profit = minPrice - sum(costs)
`currency_code`	`str` Optional. Only required if the price is set. Currency code for price/costs. Use three-character ISO-4217 code.
`stock_state`	`google.cloud.recommendationengine_v1beta1.types.ProductCatalogItem.StockState` Optional. Online stock state of the catalog item. Default is `IN_STOCK`.
`available_quantity`	`int` Optional. The available quantity of the item.
`canonical_product_uri`	`str` Optional. Canonical URL directly linking to the item detail page with a length limit of 5 KiB..
`images`	`MutableSequence[google.cloud.recommendationengine_v1beta1.types.Image]` Optional. Product images for the catalog item.

Classes

CostsEntry

CostsEntry(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.

ExactPrice

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

Exact product price.

PriceRange

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

Product price range when there are a range of prices for different variations of the same product.

StockState

StockState(value)

Item stock state. If this field is unspecified, the item is assumed to be in stock.

Values: STOCK_STATE_UNSPECIFIED (0): Default item stock status. Should never be used. IN_STOCK (0): Item in stock. OUT_OF_STOCK (1): Item out of stock. PREORDER (2): Item that is in pre-order state. BACKORDER (3): Item that is back-ordered (i.e. temporarily out of stock).