Recommendations AI v1beta1 API - Class ListUserEventsRequest (2.0.0-beta05) 

public sealed class ListUserEventsRequest : IMessage<ListUserEventsRequest>, IEquatable<ListUserEventsRequest>, IDeepCloneable<ListUserEventsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Recommendations AI v1beta1 API class ListUserEventsRequest.

Request message for ListUserEvents method.

Inheritance

object > ListUserEventsRequest

Namespace

Google.Cloud.RecommendationEngine.V1Beta1

Assembly

Google.Cloud.RecommendationEngine.V1Beta1.dll

Constructors

ListUserEventsRequest()

public ListUserEventsRequest()

ListUserEventsRequest(ListUserEventsRequest)

public ListUserEventsRequest(ListUserEventsRequest other)
Parameter
Name Description
other ListUserEventsRequest

Properties

Filter

public string Filter { get; set; }

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
Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

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

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

Optional. The previous ListUserEventsResponse.next_page_token.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

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

Property Value
Type Description
string

ParentAsEventStoreName

public EventStoreName ParentAsEventStoreName { get; set; }

EventStoreName-typed view over the Parent resource name property.

Property Value
Type Description
EventStoreName