Struct google_recommendationengine1_beta1::api::GoogleCloudRecommendationengineV1beta1UserEvent

pub struct GoogleCloudRecommendationengineV1beta1UserEvent {
    pub event_detail: Option<GoogleCloudRecommendationengineV1beta1EventDetail>,
    pub event_source: Option<String>,
    pub event_time: Option<String>,
    pub event_type: Option<String>,
    pub product_event_detail: Option<GoogleCloudRecommendationengineV1beta1ProductEventDetail>,
    pub user_info: Option<GoogleCloudRecommendationengineV1beta1UserInfo>,
}

UserEvent captures all metadata information recommendation engine needs to know about how end users interact with customers' website.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• locations catalogs event stores user events write projects (request|response)

Fields

event_detail: Option<GoogleCloudRecommendationengineV1beta1EventDetail>

Optional. User event detailed information common across different recommendation types.

event_source: Option<String>

Optional. This field should not be set when using JavaScript pixel or the Recommendations AI Tag. Defaults to EVENT_SOURCE_UNSPECIFIED.

event_time: Option<String>

Optional. Only required for ImportUserEvents method. Timestamp of user event created.

event_type: Option<String>

Required. User event type. Allowed values are: * add-to-cart Products being added to cart. * add-to-list Items being added to a list (shopping list, favorites etc). * category-page-view Special pages such as sale or promotion pages viewed. * checkout-start User starting a checkout process. * detail-page-view Products detail page viewed. * home-page-view Homepage viewed. * page-visit Generic page visits not included in the event types above. * purchase-complete User finishing a purchase. * refund Purchased items being refunded or returned. * remove-from-cart Products being removed from cart. * remove-from-list Items being removed from a list. * search Product search. * shopping-cart-page-view User viewing a shopping cart. * impression List of items displayed. Used by Google Tag Manager.

product_event_detail: Option<GoogleCloudRecommendationengineV1beta1ProductEventDetail>

Optional. Retail product specific user event metadata. This field is required for the following event types: * add-to-cart * add-to-list * category-page-view * checkout-start * detail-page-view * purchase-complete * refund * remove-from-cart * remove-from-list * search This field is optional for the following event types: * page-visit * shopping-cart-page-view - note that 'product_event_detail' should be set for this unless the shopping cart is empty. This field is not allowed for the following event types: * home-page-view

user_info: Option<GoogleCloudRecommendationengineV1beta1UserInfo>

Required. User information.

Trait Implementations

impl Clone for GoogleCloudRecommendationengineV1beta1UserEvent

fn clone(&self) -> GoogleCloudRecommendationengineV1beta1UserEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GoogleCloudRecommendationengineV1beta1UserEvent

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

Formats the value using the given formatter.

impl Default for GoogleCloudRecommendationengineV1beta1UserEvent

fn default() -> GoogleCloudRecommendationengineV1beta1UserEvent

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for GoogleCloudRecommendationengineV1beta1UserEvent

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

Deserialize this value from the given Serde deserializer.

impl RequestValue for GoogleCloudRecommendationengineV1beta1UserEvent

impl ResponseResult for GoogleCloudRecommendationengineV1beta1UserEvent

impl Serialize for GoogleCloudRecommendationengineV1beta1UserEvent

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

Serialize this value into the given Serde serializer.