GoogleApi.Retail.V2.Model.GoogleCloudRetailV2PriceInfo (google_api_retail v0.20.0)

View Source

The price information of a Product.

Attributes

  • cost (type: number(), default: nil) - The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property cost_of_goods_sold.
  • currencyCode (type: String.t, default: nil) - The 3-letter currency code defined in ISO 4217. If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned.
  • originalPrice (type: number(), default: nil) - Price of the product without any discount. If zero, by default set to be the price. If set, original_price should be greater than or equal to price, otherwise an INVALID_ARGUMENT error is thrown.
  • price (type: number(), default: nil) - Price of the product. Google Merchant Center property price. Schema.org property Offer.price.
  • priceEffectiveTime (type: DateTime.t, default: nil) - The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search.
  • priceExpireTime (type: DateTime.t, default: nil) - The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search.
  • priceRange (type: GoogleApi.Retail.V2.Model.GoogleCloudRetailV2PriceInfoPriceRange.t, default: nil) - Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Retail.V2.Model.GoogleCloudRetailV2PriceInfo{
  cost: number() | nil,
  currencyCode: String.t() | nil,
  originalPrice: number() | nil,
  price: number() | nil,
  priceEffectiveTime: DateTime.t() | nil,
  priceExpireTime: DateTime.t() | nil,
  priceRange:
    GoogleApi.Retail.V2.Model.GoogleCloudRetailV2PriceInfoPriceRange.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.