Console
    Contact Us Start free

    Google Cloud Recommendation Engine V1beta1 Client - Class UserEvent (0.4.12)

    Reference documentation and code samples for the Google Cloud Recommendation Engine V1beta1 Client class UserEvent.

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

    Generated from protobuf message google.cloud.recommendationengine.v1beta1.UserEvent

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ event_type
    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.

    ↳ user_info
    Google\Cloud\RecommendationEngine\V1beta1\UserInfo

    Required. User information.

    ↳ event_detail
    Google\Cloud\RecommendationEngine\V1beta1\EventDetail

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

    ↳ product_event_detail
    Google\Cloud\RecommendationEngine\V1beta1\ProductEventDetail

    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

    ↳ event_time
    Google\Protobuf\Timestamp

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

    ↳ event_source
    int

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

    getEventType

    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.
    Returns
    Type
    Description
    string

    setEventType

    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.
    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getUserInfo

    Required. User information.

    Returns
    Type
    Description
    Google\Cloud\RecommendationEngine\V1beta1\UserInfo |null

    hasUserInfo

    clearUserInfo

    setUserInfo

    Required. User information.

    Parameter
    Name
    Description
    var
    Google\Cloud\RecommendationEngine\V1beta1\UserInfo
    Returns
    Type
    Description
    $this

    getEventDetail

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

    Returns
    Type
    Description
    Google\Cloud\RecommendationEngine\V1beta1\EventDetail |null

    hasEventDetail

    clearEventDetail

    setEventDetail

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

    Parameter
    Name
    Description
    var
    Google\Cloud\RecommendationEngine\V1beta1\EventDetail
    Returns
    Type
    Description
    $this

    getProductEventDetail

    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
    Returns
    Type
    Description
    Google\Cloud\RecommendationEngine\V1beta1\ProductEventDetail |null

    hasProductEventDetail

    clearProductEventDetail

    setProductEventDetail

    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
    Parameter
    Name
    Description
    var
    Google\Cloud\RecommendationEngine\V1beta1\ProductEventDetail
    Returns
    Type
    Description
    $this

    getEventTime

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

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasEventTime

    clearEventTime

    setEventTime

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

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getEventSource

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

    Returns
    Type
    Description
    int

    setEventSource

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

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: