Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.UserEventsResource

The "userEvents" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.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.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.UserEventsResource.CollectRequest Collect(string parent)
Parameters
Type Name Description
string parent

Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}. If the collect 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.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.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.UserEventsResource.ImportRequest

Write(GoogleCloudDiscoveryengineV1alphaUserEvent, string)

Writes a single user event.

Declaration
public virtual ProjectsResource.LocationsResource.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.UserEventsResource.WriteRequest
In this article
Back to top Generated by DocFX