GoogleApi.RecommendationEngine.V1beta1.Model.GoogleCloudRecommendationengineV1beta1ProductDetail (google_api_recommendation_engine v0.3.1) View Source

Detailed product information associated with a user event.

Attributes

  • availableQuantity (type: integer(), default: nil) - Optional. Quantity of the products in stock when a user event happens. Optional. If provided, this overrides the available quantity in Catalog for this event. and can only be set if stock_status is set to IN_STOCK. Note that if an item is out of stock, you must set the stock_state field to be OUT_OF_STOCK. Leaving this field unspecified / as zero is not sufficient to mark the item out of stock.
  • currencyCode (type: String.t, default: nil) - Optional. Currency code for price/costs. Use three-character ISO-4217 code. Required only if originalPrice or displayPrice is set.
  • displayPrice (type: number(), default: nil) - Optional. Display price of the product (e.g. discounted price). If provided, this will override the display price in Catalog for this product.
  • id (type: String.t, default: nil) - Required. Catalog item ID. UTF-8 encoded string with a length limit of 128 characters.
  • itemAttributes (type: GoogleApi.RecommendationEngine.V1beta1.Model.GoogleCloudRecommendationengineV1beta1FeatureMap.t, default: nil) - Optional. Extra features associated with a product in the user event.
  • originalPrice (type: number(), default: nil) - Optional. Original price of the product. If provided, this will override the original price in Catalog for this product.
  • quantity (type: integer(), default: nil) - Optional. Quantity of the product associated with the user event. For example, this field will be 2 if two products are added to the shopping cart for add-to-cart event. Required for add-to-cart, add-to-list, remove-from-cart, checkout-start, purchase-complete, refund event types.
  • stockState (type: String.t, default: nil) - Optional. Item stock state. If provided, this overrides the stock state in Catalog for items in this event.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() ::
  %GoogleApi.RecommendationEngine.V1beta1.Model.GoogleCloudRecommendationengineV1beta1ProductDetail{
    availableQuantity: integer(),
    currencyCode: String.t(),
    displayPrice: number(),
    id: String.t(),
    itemAttributes:
      GoogleApi.RecommendationEngine.V1beta1.Model.GoogleCloudRecommendationengineV1beta1FeatureMap.t(),
    originalPrice: number(),
    quantity: integer(),
    stockState: String.t()
  }

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.