Reference documentation and code samples for the Recommendations AI V1beta1 API class Google::Cloud::RecommendationEngine::V1beta1::ListUserEventsRequest.
Request message for ListUserEvents method.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#filter
deffilter()->::String
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
#filter=
deffilter=(value)->::String
Parameter
value (::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
#page_size
defpage_size()->::Integer
Returns
(::Integer) — Optional. Maximum number of results to return per page. If zero, the
service will choose a reasonable default.
#page_size=
defpage_size=(value)->::Integer
Parameter
value (::Integer) — 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.
#page_token
defpage_token()->::String
Returns
(::String) — Optional. The previous ListUserEventsResponse.next_page_token.
#page_token=
defpage_token=(value)->::String
Parameter
value (::String) — Optional. The previous ListUserEventsResponse.next_page_token.
Returns
(::String) — Optional. The previous ListUserEventsResponse.next_page_token.
#parent
defparent()->::String
Returns
(::String) — Required. The parent eventStore resource name, such as
projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store.
#parent=
defparent=(value)->::String
Parameter
value (::String) — 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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Recommendations AI V1beta1 API - Class Google::Cloud::RecommendationEngine::V1beta1::ListUserEventsRequest (v0.13.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.13.0 (latest)](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/latest/Google-Cloud-RecommendationEngine-V1beta1-ListUserEventsRequest)\n- [0.12.1](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/0.12.1/Google-Cloud-RecommendationEngine-V1beta1-ListUserEventsRequest)\n- [0.11.0](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/0.11.0/Google-Cloud-RecommendationEngine-V1beta1-ListUserEventsRequest)\n- [0.10.0](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/0.10.0/Google-Cloud-RecommendationEngine-V1beta1-ListUserEventsRequest)\n- [0.9.2](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/0.9.2/Google-Cloud-RecommendationEngine-V1beta1-ListUserEventsRequest)\n- [0.8.2](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/0.8.2/Google-Cloud-RecommendationEngine-V1beta1-ListUserEventsRequest)\n- [0.7.0](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/0.7.0/Google-Cloud-RecommendationEngine-V1beta1-ListUserEventsRequest)\n- [0.6.1](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/0.6.1/Google-Cloud-RecommendationEngine-V1beta1-ListUserEventsRequest)\n- [0.5.0](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/0.5.0/Google-Cloud-RecommendationEngine-V1beta1-ListUserEventsRequest)\n- [0.4.1](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/0.4.1/Google-Cloud-RecommendationEngine-V1beta1-ListUserEventsRequest)\n- [0.3.7](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/0.3.7/Google-Cloud-RecommendationEngine-V1beta1-ListUserEventsRequest) \nReference documentation and code samples for the Recommendations AI V1beta1 API class Google::Cloud::RecommendationEngine::V1beta1::ListUserEventsRequest.\n\nRequest message for ListUserEvents method. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #filter\n\n def filter() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. Filtering expression to specify restrictions over\n returned events. This is a sequence of terms, where each term applies some\n kind of a restriction to the returned user events. Use this expression to\n restrict results to a specific time range, or filter events by eventType.\n eg: eventTime \\\u003e \"2012-04-23T18:25:43.511Z\" eventsMissingCatalogItems\n eventTime\\\u003c\"2012-04-23T18:25:43.511Z\" eventType=search\n\n We expect only 3 types of fields:\n - eventTime: this can be specified a maximum of 2 times, once with a\n less than operator and once with a greater than operator. The\n eventTime restrict should result in one contiguous valid eventTime\n range.\n\n - eventType: only 1 eventType restriction can be specified.\n\n - eventsMissingCatalogItems: specififying this will restrict results\n to events for which catalog items were not found in the catalog. The\n default behavior is to return only those events for which catalog\n items were found.\n\n Some examples of valid filters expressions:\n - Example 1: eventTime \\\u003e \"2012-04-23T18:25:43.511Z\" eventTime \\\u003c \"2012-04-23T18:30:43.511Z\"\n - Example 2: eventTime \\\u003e \"2012-04-23T18:25:43.511Z\" eventType = detail-page-view\n - Example 3: eventsMissingCatalogItems eventType = search eventTime \\\u003c \"2018-04-23T18:30:43.511Z\"\n - Example 4: eventTime \\\u003e \"2012-04-23T18:25:43.511Z\"\n - Example 5: eventType = search\n - Example 6: eventsMissingCatalogItems\n\n### #filter=\n\n def filter=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) ---\n\n Optional. Filtering expression to specify restrictions over\n returned events. This is a sequence of terms, where each term applies some\n kind of a restriction to the returned user events. Use this expression to\n restrict results to a specific time range, or filter events by eventType.\n eg: eventTime \\\u003e \"2012-04-23T18:25:43.511Z\" eventsMissingCatalogItems\n eventTime\\\u003c\"2012-04-23T18:25:43.511Z\" eventType=search\n\n We expect only 3 types of fields:\n - eventTime: this can be specified a maximum of 2 times, once with a\n less than operator and once with a greater than operator. The\n eventTime restrict should result in one contiguous valid eventTime\n range.\n\n - eventType: only 1 eventType restriction can be specified.\n\n - eventsMissingCatalogItems: specififying this will restrict results\n to events for which catalog items were not found in the catalog. The\n default behavior is to return only those events for which catalog\n items were found.\n\n Some examples of valid filters expressions:\n - Example 1: eventTime \\\u003e \"2012-04-23T18:25:43.511Z\" eventTime \\\u003c \"2012-04-23T18:30:43.511Z\"\n - Example 2: eventTime \\\u003e \"2012-04-23T18:25:43.511Z\" eventType = detail-page-view\n - Example 3: eventsMissingCatalogItems eventType = search eventTime \\\u003c \"2018-04-23T18:30:43.511Z\"\n - Example 4: eventTime \\\u003e \"2012-04-23T18:25:43.511Z\"\n - Example 5: eventType = search\n- Example 6: eventsMissingCatalogItems \n**Returns**\n\n- (::String) --- Optional. Filtering expression to specify restrictions over\n returned events. This is a sequence of terms, where each term applies some\n kind of a restriction to the returned user events. Use this expression to\n restrict results to a specific time range, or filter events by eventType.\n eg: eventTime \\\u003e \"2012-04-23T18:25:43.511Z\" eventsMissingCatalogItems\n eventTime\\\u003c\"2012-04-23T18:25:43.511Z\" eventType=search\n\n We expect only 3 types of fields:\n - eventTime: this can be specified a maximum of 2 times, once with a\n less than operator and once with a greater than operator. The\n eventTime restrict should result in one contiguous valid eventTime\n range.\n\n - eventType: only 1 eventType restriction can be specified.\n\n - eventsMissingCatalogItems: specififying this will restrict results\n to events for which catalog items were not found in the catalog. The\n default behavior is to return only those events for which catalog\n items were found.\n\n Some examples of valid filters expressions:\n - Example 1: eventTime \\\u003e \"2012-04-23T18:25:43.511Z\" eventTime \\\u003c \"2012-04-23T18:30:43.511Z\"\n - Example 2: eventTime \\\u003e \"2012-04-23T18:25:43.511Z\" eventType = detail-page-view\n - Example 3: eventsMissingCatalogItems eventType = search eventTime \\\u003c \"2018-04-23T18:30:43.511Z\"\n - Example 4: eventTime \\\u003e \"2012-04-23T18:25:43.511Z\"\n - Example 5: eventType = search\n - Example 6: eventsMissingCatalogItems\n\n### #page_size\n\n def page_size() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.\n\n### #page_size=\n\n def page_size=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default. \n**Returns**\n\n- (::Integer) --- Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.\n\n### #page_token\n\n def page_token() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. The previous ListUserEventsResponse.next_page_token.\n\n### #page_token=\n\n def page_token=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. The previous ListUserEventsResponse.next_page_token. \n**Returns**\n\n- (::String) --- Optional. The previous ListUserEventsResponse.next_page_token.\n\n### #parent\n\n def parent() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The parent eventStore resource name, such as `projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`.\n\n### #parent=\n\n def parent=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The parent eventStore resource name, such as `projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`. \n**Returns**\n\n- (::String) --- Required. The parent eventStore resource name, such as `projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`."]]
