Class ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource

The "userEvents" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudRetail.v2beta

Assembly: Google.Apis.CloudRetail.v2beta.dll

Syntax

public class ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource

Constructors

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 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
string	parent	Required. The parent catalog name, such as projects/1234/locations/global/catalogs/default_catalog.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.CollectRequest

Export(GoogleCloudRetailV2betaExportUserEventsRequest, string)

Exports user events. Operation.response is of type ExportResponse. Operation.metadata is of type ExportMetadata.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.ExportRequest Export(GoogleCloudRetailV2betaExportUserEventsRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudRetailV2betaExportUserEventsRequest	body	The body of the request.
string	parent	Required. Resource name of a Catalog. For example projects/1234/locations/global/catalogs/default_catalog

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.ExportRequest

Import(GoogleCloudRetailV2betaImportUserEventsRequest, 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(GoogleCloudRetailV2betaImportUserEventsRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudRetailV2betaImportUserEventsRequest	body	The body of the request.
string	parent	Required. projects/1234/locations/global/catalogs/default_catalog

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.ImportRequest

Purge(GoogleCloudRetailV2betaPurgeUserEventsRequest, 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(GoogleCloudRetailV2betaPurgeUserEventsRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudRetailV2betaPurgeUserEventsRequest	body	The body of the request.
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(GoogleCloudRetailV2betaRejoinUserEventsRequest, string)

Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete.

Declaration

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

Parameters

Type	Name	Description
GoogleCloudRetailV2betaRejoinUserEventsRequest	body	The body of the request.
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(GoogleCloudRetailV2betaUserEvent, string)

Writes a single user event.

Declaration

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

Parameters

Type	Name	Description
GoogleCloudRetailV2betaUserEvent	body	The body of the request.
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