Class UserEventService.UserEventServiceBase (2.2.0)

Stay organized with collections Save and categorize content based on your preferences.
[BindServiceMethod(typeof(UserEventService), "BindService")]
public abstract class UserEventServiceBase

Base class for server-side implementations of UserEventService

Inheritance

Object > UserEventService.UserEventServiceBase

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.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 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.

Parameters
NameDescription
requestCollectUserEventRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<HttpBody>

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
NameDescription
requestImportUserEventsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

PurgeUserEvents(PurgeUserEventsRequest, ServerCallContext)

public virtual Task<Operation> PurgeUserEvents(PurgeUserEventsRequest request, ServerCallContext context)

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.

Parameters
NameDescription
requestPurgeUserEventsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

RejoinUserEvents(RejoinUserEventsRequest, ServerCallContext)

public virtual Task<Operation> RejoinUserEvents(RejoinUserEventsRequest request, ServerCallContext context)

Starts 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 method can be used to start a join operation on specified events with latest version of product catalog. It can also be used to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete.

Parameters
NameDescription
requestRejoinUserEventsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

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
NameDescription
requestWriteUserEventRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<UserEvent>

The response to send back to the client (wrapped by a task).