Struct google_api_proto::google::cloud::recommendationengine::v1beta1::ProductDetail

pub struct ProductDetail {
    pub id: String,
    pub currency_code: String,
    pub original_price: f32,
    pub display_price: f32,
    pub stock_state: i32,
    pub quantity: i32,
    pub available_quantity: i32,
    pub item_attributes: Option<FeatureMap>,
}

Detailed product information associated with a user event.

Fields

id: String

Required. Catalog item ID. UTF-8 encoded string with a length limit of 128 characters.

currency_code: String

Optional. Currency code for price/costs. Use three-character ISO-4217 code. Required only if originalPrice or displayPrice is set.

original_price: f32

Optional. Original price of the product. If provided, this will override the original price in Catalog for this product.

display_price: f32

Optional. Display price of the product (e.g. discounted price). If provided, this will override the display price in Catalog for this product.

stock_state: i32

Optional. Item stock state. If provided, this overrides the stock state in Catalog for items in this event.

quantity: i32

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.

available_quantity: i32

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.

item_attributes: Option<FeatureMap>

Optional. Extra features associated with a product in the user event.

Implementations

impl ProductDetail

pub fn stock_state(&self) -> StockState

Returns the enum value of stock_state, or the default if the field is set to an invalid enum value.

pub fn set_stock_state(&mut self, value: StockState)

Sets stock_state to the provided enum value.

Trait Implementations

impl Clone for ProductDetail

fn clone(&self) -> ProductDetail

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProductDetail

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ProductDetail

fn default() -> Self

Returns the “default value” for a type.

impl Message for ProductDetail

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ProductDetail

fn eq(&self, other: &ProductDetail) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ProductDetail