Struct google_recommendationengine1_beta1::api::GoogleCloudRecommendationengineV1beta1ProductEventDetail

pub struct GoogleCloudRecommendationengineV1beta1ProductEventDetail {
    pub cart_id: Option<String>,
    pub list_id: Option<String>,
    pub page_categories: Option<Vec<GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy>>,
    pub product_details: Option<Vec<GoogleCloudRecommendationengineV1beta1ProductDetail>>,
    pub purchase_transaction: Option<GoogleCloudRecommendationengineV1beta1PurchaseTransaction>,
    pub search_query: Option<String>,
}

ProductEventDetail captures user event information specific to retail products.

This type is not used in any activity, and only used as part of another schema.

Fields

cart_id: Option<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.

list_id: Option<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.

page_categories: Option<Vec<GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy>>

Required for category-page-view events. At least one of search_query or page_categories is required for search 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: Option<Vec<GoogleCloudRecommendationengineV1beta1ProductDetail>>

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. * search (highly encouraged) In a search event, this field represents the products returned to the end user on the current page (the end user may have not finished broswing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new SEARCH event with different product_details is desired. The end user may have not finished broswing the whole page yet. This field is not allowed for the following event types: * category-page-view * home-page-view

purchase_transaction: Option<GoogleCloudRecommendationengineV1beta1PurchaseTransaction>

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.

search_query: Option<String>

At least one of search_query or page_categories is 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.

Trait Implementations

impl Clone for GoogleCloudRecommendationengineV1beta1ProductEventDetail

fn clone(&self) -> GoogleCloudRecommendationengineV1beta1ProductEventDetail

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GoogleCloudRecommendationengineV1beta1ProductEventDetail

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

Formats the value using the given formatter.

impl Default for GoogleCloudRecommendationengineV1beta1ProductEventDetail

fn default() -> GoogleCloudRecommendationengineV1beta1ProductEventDetail

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GoogleCloudRecommendationengineV1beta1ProductEventDetail

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Part for GoogleCloudRecommendationengineV1beta1ProductEventDetail

impl Serialize for GoogleCloudRecommendationengineV1beta1ProductEventDetail

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.