Google Cloud Recommendation Engine V1beta1 Client - Class ListUserEventsRequest (0.7.6)

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

Request message for ListUserEvents method.

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

Namespace

Google \ Cloud \ RecommendationEngine \ V1beta1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

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

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

Optional. The previous ListUserEventsResponse.next_page_token.
↳ 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

getParent

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

Returns
Type Description
string

setParent

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

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

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

Returns
Type Description
int

setPageSize

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

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. The previous ListUserEventsResponse.next_page_token.

Returns
Type Description
string

setPageToken

Optional. The previous ListUserEventsResponse.next_page_token.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

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

setFilter

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

static::build

Parameters
Name Description
parent string

Required. The parent eventStore resource name, such as projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store. Please see UserEventServiceClient::eventStoreName() for help formatting this field.
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
Type Description
ListUserEventsRequest