Retail v2 API - Class UserEventService.UserEventServiceBase (2.8.0)

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

Reference documentation and code samples for the Retail v2 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.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
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).

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
Name	Description
`request`	`PurgeUserEventsRequest` 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).

RejoinUserEvents(RejoinUserEventsRequest, ServerCallContext)

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

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.

Parameters
Name	Description
`request`	`RejoinUserEventsRequest` 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).