Recommendations AI v1beta1 API - Class ProductCatalogItem (2.0.0-beta02)

public sealed class ProductCatalogItem : IMessage<ProductCatalogItem>, IEquatable<ProductCatalogItem>, IDeepCloneable<ProductCatalogItem>, IBufferMessage, IMessage

Reference documentation and code samples for the Recommendations AI v1beta1 API class ProductCatalogItem.

ProductCatalogItem captures item metadata specific to retail products.

Inheritance

Object > ProductCatalogItem

Namespace

Google.Cloud.RecommendationEngine.V1Beta1

Assembly

Google.Cloud.RecommendationEngine.V1Beta1.dll

Constructors

ProductCatalogItem()

public ProductCatalogItem()

ProductCatalogItem(ProductCatalogItem)

public ProductCatalogItem(ProductCatalogItem other)
Parameter
NameDescription
otherProductCatalogItem

Properties

AvailableQuantity

public long AvailableQuantity { get; set; }

Optional. The available quantity of the item.

Property Value
TypeDescription
Int64

CanonicalProductUri

public string CanonicalProductUri { get; set; }

Optional. Canonical URL directly linking to the item detail page with a length limit of 5 KiB..

Property Value
TypeDescription
String

Costs

public MapField<string, float> Costs { get; }

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)
Property Value
TypeDescription
MapField<String, Single>

CurrencyCode

public string CurrencyCode { get; set; }

Optional. Only required if the price is set. Currency code for price/costs. Use three-character ISO-4217 code.

Property Value
TypeDescription
String

ExactPrice

public ProductCatalogItem.Types.ExactPrice ExactPrice { get; set; }

Optional. The exact product price.

Property Value
TypeDescription
ProductCatalogItem.Types.ExactPrice

Images

public RepeatedField<Image> Images { get; }

Optional. Product images for the catalog item.

Property Value
TypeDescription
RepeatedField<Image>

PriceCase

public ProductCatalogItem.PriceOneofCase PriceCase { get; }
Property Value
TypeDescription
ProductCatalogItem.PriceOneofCase

PriceRange

public ProductCatalogItem.Types.PriceRange PriceRange { get; set; }

Optional. The product price range.

Property Value
TypeDescription
ProductCatalogItem.Types.PriceRange

StockState

public ProductCatalogItem.Types.StockState StockState { get; set; }

Optional. Online stock state of the catalog item. Default is IN_STOCK.

Property Value
TypeDescription
ProductCatalogItem.Types.StockState