Struct gapi_grpc::google::cloud::recommendationengine::v1beta1::ProductEventDetail

pub struct ProductEventDetail {
    pub search_query: String,
    pub page_categories: Vec<CategoryHierarchy>,
    pub product_details: Vec<ProductDetail>,
    pub list_id: String,
    pub cart_id: String,
    pub purchase_transaction: Option<PurchaseTransaction>,
}

ProductEventDetail captures user event information specific to retail products.

Fields

search_query: String

Required for search events. Other event types should not set this field. The user’s search query as UTF-8 encoded text with a length limit of 5 KiB.

page_categories: Vec<CategoryHierarchy>

Required for category-page-view events. Other event types should not set this field. The categories associated with a category page. Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: categories : [“Sales”, “2017 Black Friday Deals”].

product_details: Vec<ProductDetail>

The main product details related to the event.

This field is required for the following event types:

• add-to-cart
• add-to-list
• checkout-start
• detail-page-view
• purchase-complete
• refund
• remove-from-cart
• remove-from-list

This field is optional for the following event types:

• page-visit
• shopping-cart-page-view - note that ‘product_details’ should be set for this unless the shopping cart is empty.

This field is not allowed for the following event types:

• category-page-view
• home-page-view
• search

list_id: String

Required for add-to-list and remove-from-list events. The id or name of the list that the item is being added to or removed from. Other event types should not set this field.

cart_id: String

Optional. The id or name of the associated shopping cart. This id is used to associate multiple items added or present in the cart before purchase.

This can only be set for add-to-cart, remove-from-cart, checkout-start, purchase-complete, or shopping-cart-page-view events.

purchase_transaction: Option<PurchaseTransaction>

Optional. A transaction represents the entire purchase transaction. Required for purchase-complete events. Optional for checkout-start events. Other event types should not set this field.

Trait Implementations

impl Clone for ProductEventDetail

fn clone(&self) -> ProductEventDetail

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProductEventDetail

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

Formats the value using the given formatter.

impl Default for ProductEventDetail

fn default() -> ProductEventDetail

Returns the “default value” for a type.

impl Message for ProductEventDetail

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

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

Encodes the message to a buffer.

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

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<ProductEventDetail> for ProductEventDetail

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

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

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

This method tests for !=.

impl StructuralPartialEq for ProductEventDetail