Class: Google::Cloud::RecommendationEngine::V1beta1::ListUserEventsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/recommendationengine/v1beta1/user_event_service.rb

Overview

Request message for ListUserEvents method.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Optional. Filtering expression to specify restrictions over returned events. This is a sequence of terms, where each term applies some kind of a restriction to the returned user events. Use this expression to restrict results to a specific time range, or filter events by eventType. eg: eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search

We expect only 3 types of fields:

  • eventTime: this can be specified a maximum of 2 times, once with a less than operator and once with a greater than operator. The eventTime restrict should result in one contiguous valid eventTime range.

  • eventType: only 1 eventType restriction can be specified.

  • eventsMissingCatalogItems: specififying this will restrict results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found.

Some examples of valid filters expressions:

  • Example 1: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
  • Example 2: eventTime > "2012-04-23T18:25:43.511Z" eventType = detail-page-view
  • Example 3: eventsMissingCatalogItems eventType = search eventTime < "2018-04-23T18:30:43.511Z"
  • Example 4: eventTime > "2012-04-23T18:25:43.511Z"
  • Example 5: eventType = search
  • Example 6: eventsMissingCatalogItems

Returns:

  • (::String) —

    Optional. Filtering expression to specify restrictions over returned events. This is a sequence of terms, where each term applies some kind of a restriction to the returned user events. Use this expression to restrict results to a specific time range, or filter events by eventType. eg: eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search

    We expect only 3 types of fields:

    • eventTime: this can be specified a maximum of 2 times, once with a less than operator and once with a greater than operator. The eventTime restrict should result in one contiguous valid eventTime range.

    • eventType: only 1 eventType restriction can be specified.

    • eventsMissingCatalogItems: specififying this will restrict results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found.

    Some examples of valid filters expressions:

    • Example 1: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
    • Example 2: eventTime > "2012-04-23T18:25:43.511Z" eventType = detail-page-view
    • Example 3: eventsMissingCatalogItems eventType = search eventTime < "2018-04-23T18:30:43.511Z"
    • Example 4: eventTime > "2012-04-23T18:25:43.511Z"
    • Example 5: eventType = search
    • Example 6: eventsMissingCatalogItems


171
172
173
174
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event_service.rb', line 171

class ListUserEventsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.

Returns:

  • (::Integer) —

    Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.



171
172
173
174
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event_service.rb', line 171

class ListUserEventsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns Optional. The previous ListUserEventsResponse.next_page_token.

Returns:

  • (::String) —

    Optional. The previous ListUserEventsResponse.next_page_token.



171
172
173
174
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event_service.rb', line 171

class ListUserEventsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns Required. The parent eventStore resource name, such as projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store.

Returns:

  • (::String) —

    Required. The parent eventStore resource name, such as projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store.



171
172
173
174
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event_service.rb', line 171

class ListUserEventsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end