Class ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource

The "userEvents" collection of methods.

Inheritance

System.Object

ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Google.Apis.CloudRetail.v2

Assembly: Google.Apis.CloudRetail.v2.dll

Syntax

public class UserEventsResource

Constructors

UserEventsResource(IClientService)

Constructs a new resource.

Declaration

public UserEventsResource(IClientService service)

Parameters

Type	Name	Description
Google.Apis.Services.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 Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.CollectRequest Collect(string parent)

Parameters

Type	Name	Description
System.String	parent	Required. The parent catalog name, such as projects/1234/locations/global/catalogs/default_catalog.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.CollectRequest

Import(GoogleCloudRetailV2ImportUserEventsRequest, 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.UserEventsResource.ImportRequest Import(GoogleCloudRetailV2ImportUserEventsRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudRetailV2ImportUserEventsRequest	body	The body of the request.
System.String	parent	Required. projects/1234/locations/global/catalogs/default_catalog

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.ImportRequest

Purge(GoogleCloudRetailV2PurgeUserEventsRequest, 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.UserEventsResource.PurgeRequest Purge(GoogleCloudRetailV2PurgeUserEventsRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudRetailV2PurgeUserEventsRequest	body	The body of the request.
System.String	parent	Required. The resource name of the catalog under which the events are created. The format is projects/${projectId}/locations/global/catalogs/${catalogId}

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.PurgeRequest

Rejoin(GoogleCloudRetailV2RejoinUserEventsRequest, String)

Triggers a user event rejoin operation with latest product catalog. Events will not be annotated with detailed product information if product is missing from the catalog 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 product catalog. It can also be used to correct events joined with wrong product catalog.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.RejoinRequest Rejoin(GoogleCloudRetailV2RejoinUserEventsRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudRetailV2RejoinUserEventsRequest	body	The body of the request.
System.String	parent	Required. The parent catalog resource name, such as projects/1234/locations/global/catalogs/default_catalog.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.RejoinRequest

Write(GoogleCloudRetailV2UserEvent, String)

Writes a single user event.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.WriteRequest Write(GoogleCloudRetailV2UserEvent body, string parent)

Parameters

Type	Name	Description
GoogleCloudRetailV2UserEvent	body	The body of the request.
System.String	parent	Required. The parent catalog resource name, such as projects/1234/locations/global/catalogs/default_catalog.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.WriteRequest