Class ProjectsResource.LocationsResource.CatalogsResource.EventStoresResource.UserEventsResource
The "userEvents" collection of methods.
Inheritance
Inherited Members
Namespace: Google.Apis.RecommendationsAI.v1beta1
Assembly: Google.Apis.RecommendationsAI.v1beta1.dll
Syntax
public class ProjectsResource.LocationsResource.CatalogsResource.EventStoresResource.UserEventsResourceConstructors
UserEventsResource(IClientService)
Constructs a new resource.
Declaration
public UserEventsResource(IClientService service)Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service |
Methods
Collect(string)
Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Recommendations AI JavaScript pixel. Users should not call this method directly.
Declaration
public virtual ProjectsResource.LocationsResource.CatalogsResource.EventStoresResource.UserEventsResource.CollectRequest Collect(string parent)Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent eventStore name, such as
|
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.CatalogsResource.EventStoresResource.UserEventsResource.CollectRequest |
Import(GoogleCloudRecommendationengineV1beta1ImportUserEventsRequest, string)
Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
Declaration
public virtual ProjectsResource.LocationsResource.CatalogsResource.EventStoresResource.UserEventsResource.ImportRequest Import(GoogleCloudRecommendationengineV1beta1ImportUserEventsRequest body, string parent)Parameters
| Type | Name | Description |
|---|---|---|
| GoogleCloudRecommendationengineV1beta1ImportUserEventsRequest | body | The body of the request. |
| string | parent | Required.
|
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.CatalogsResource.EventStoresResource.UserEventsResource.ImportRequest |
List(string)
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.
Declaration
public virtual ProjectsResource.LocationsResource.CatalogsResource.EventStoresResource.UserEventsResource.ListRequest List(string parent)Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The parent eventStore resource name, such as
|
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.CatalogsResource.EventStoresResource.UserEventsResource.ListRequest |
Purge(GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest, string)
Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.
Declaration
public virtual ProjectsResource.LocationsResource.CatalogsResource.EventStoresResource.UserEventsResource.PurgeRequest Purge(GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest body, string parent)Parameters
| Type | Name | Description |
|---|---|---|
| GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest | body | The body of the request. |
| string | parent | Required. The resource name of the event_store under which the events are created. The
format is
|
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.CatalogsResource.EventStoresResource.UserEventsResource.PurgeRequest |
Rejoin(GoogleCloudRecommendationengineV1beta1RejoinUserEventsRequest, string)
Triggers a user event rejoin operation with latest catalog data. Events will not be annotated with detailed catalog information if catalog item is missing at the time the user event is ingested, and these events are stored as unjoined events with a limited usage on training and serving. This API can be used to trigger a 'join' operation on specified events with latest version of catalog items. It can also be used to correct events joined with wrong catalog items.
Declaration
public virtual ProjectsResource.LocationsResource.CatalogsResource.EventStoresResource.UserEventsResource.RejoinRequest Rejoin(GoogleCloudRecommendationengineV1beta1RejoinUserEventsRequest body, string parent)Parameters
| Type | Name | Description |
|---|---|---|
| GoogleCloudRecommendationengineV1beta1RejoinUserEventsRequest | body | The body of the request. |
| string | parent | Required. Full resource name of user event, such as
|
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.CatalogsResource.EventStoresResource.UserEventsResource.RejoinRequest |
Write(GoogleCloudRecommendationengineV1beta1UserEvent, string)
Writes a single user event.
Declaration
public virtual ProjectsResource.LocationsResource.CatalogsResource.EventStoresResource.UserEventsResource.WriteRequest Write(GoogleCloudRecommendationengineV1beta1UserEvent body, string parent)Parameters
| Type | Name | Description |
|---|---|---|
| GoogleCloudRecommendationengineV1beta1UserEvent | body | The body of the request. |
| string | parent | Required. The parent eventStore resource name, such as "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store". |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.CatalogsResource.EventStoresResource.UserEventsResource.WriteRequest |