Class ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.UserEventsResource

The "userEvents" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.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.DiscoveryEngine.v1alpha

Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll

Syntax

public class ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.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 third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

Declaration

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

Parameters

Type	Name	Description
string	parent	Required. The parent DataStore resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.UserEventsResource.CollectRequest

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

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest	body	The body of the request.
string	parent	Required. Parent DataStore resource name, of the form projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.UserEventsResource.ImportRequest

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

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest	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/{project}/locations/global/collections/{collection}/dataStores/{dataStore}.

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.UserEventsResource.PurgeRequest

Write(GoogleCloudDiscoveryengineV1alphaUserEvent, string)

Writes a single user event.

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.UserEventsResource.WriteRequest Write(GoogleCloudDiscoveryengineV1alphaUserEvent body, string parent)

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1alphaUserEvent	body	The body of the request.
string	parent	Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: projects/{project}/locations/{location}.

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource.UserEventsResource.WriteRequest