Class ProjectsResource.LocationsResource.CatalogsResource.EventStoresResource.UserEventsResource.ListRequest

Gets a list of user events within a time range, with potential filtering. The method does not list unjoined user events. Unjoined user event definition: when a user event is ingested from Recommendations AI User Event APIs, the catalog item included in the user event is connected with the current catalog. If a catalog item of the ingested event is not in the current catalog, it could lead to degraded model quality. This is called an unjoined event.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GoogleCloudRecommendationengineV1beta1ListUserEventsResponse>
RecommendationsAIBaseServiceRequest<GoogleCloudRecommendationengineV1beta1ListUserEventsResponse>
ProjectsResource.LocationsResource.CatalogsResource.EventStoresResource.UserEventsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.RecommendationsAI.v1beta1
Assembly: Google.Apis.RecommendationsAI.v1beta1.dll
Syntax
public class ProjectsResource.LocationsResource.CatalogsResource.EventStoresResource.UserEventsResource.ListRequest : RecommendationsAIBaseServiceRequest<GoogleCloudRecommendationengineV1beta1ListUserEventsResponse>, IClientServiceRequest<GoogleCloudRecommendationengineV1beta1ListUserEventsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type Name Description
IClientService service
string parent

Properties

Filter

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 &gt; "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime&lt;"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 &gt; "2012-04-23T18:25:43.511Z" eventTime &lt; "2012-04-23T18:30:43.511Z" * Example 2: eventTime &gt; "2012-04-23T18:25:43.511Z" eventType = detail-page-view * Example 3: eventsMissingCatalogItems eventType = search eventTime &lt; "2018-04-23T18:30:43.511Z" * Example 4: eventTime &gt; "2012-04-23T18:25:43.511Z" * Example 5: eventType = search * Example 6: eventsMissingCatalogItems

Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

PageSize

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

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

Optional. The previous ListUserEventsResponse.next_page_token.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Parent

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

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements