Discovery Engine v1beta API - Class UserEventService.UserEventServiceBase (1.0.0-beta12)

[BindServiceMethod(typeof(UserEventService), "BindService")]
public abstract class UserEventService.UserEventServiceBase

Reference documentation and code samples for the Discovery Engine v1beta API class UserEventService.UserEventServiceBase.

Base class for server-side implementations of UserEventService

Inheritance

object > UserEventService.UserEventServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Methods

CollectUserEvent(CollectUserEventRequest, ServerCallContext)

public virtual Task<HttpBody> CollectUserEvent(CollectUserEventRequest request, ServerCallContext context)

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.

Parameters
Name	Description
`request`	`CollectUserEventRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskHttpBody`	The response to send back to the client (wrapped by a task).

ImportUserEvents(ImportUserEventsRequest, ServerCallContext)

public virtual Task<Operation> ImportUserEvents(ImportUserEventsRequest request, ServerCallContext context)

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.

Parameters
Name	Description
`request`	`ImportUserEventsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

WriteUserEvent(WriteUserEventRequest, ServerCallContext)

public virtual Task<UserEvent> WriteUserEvent(WriteUserEventRequest request, ServerCallContext context)

Writes a single user event.

Parameters
Name	Description
`request`	`WriteUserEventRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskUserEvent`	The response to send back to the client (wrapped by a task).