Class UserEventServiceGrpc.UserEventServiceImplBase (2.2.0)

public abstract static class UserEventServiceGrpc.UserEventServiceImplBase implements BindableService

Service for ingesting end user actions on the customer website.

Inheritance

java.lang.Object > UserEventServiceGrpc.UserEventServiceImplBase

Implements

io.grpc.BindableService

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

UserEventServiceImplBase()

public UserEventServiceImplBase()

Methods

bindService()

public final ServerServiceDefinition bindService()

Returns

Type	Description
io.grpc.ServerServiceDefinition

collectUserEvent(CollectUserEventRequest request, StreamObserver<HttpBody> responseObserver)

public void collectUserEvent(CollectUserEventRequest request, StreamObserver<HttpBody> responseObserver)

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`
responseObserver	`io.grpc.stub.StreamObserver<com.google.api.HttpBody>`

importUserEvents(ImportUserEventsRequest request, StreamObserver<Operation> responseObserver)

public void importUserEvents(ImportUserEventsRequest request, StreamObserver<Operation> responseObserver)

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`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

purgeUserEvents(PurgeUserEventsRequest request, StreamObserver<Operation> responseObserver)

public void purgeUserEvents(PurgeUserEventsRequest request, StreamObserver<Operation> responseObserver)

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`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

rejoinUserEvents(RejoinUserEventsRequest request, StreamObserver<Operation> responseObserver)

public void rejoinUserEvents(RejoinUserEventsRequest request, StreamObserver<Operation> responseObserver)

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

Name	Description
request	`RejoinUserEventsRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

writeUserEvent(WriteUserEventRequest request, StreamObserver<UserEvent> responseObserver)

public void writeUserEvent(WriteUserEventRequest request, StreamObserver<UserEvent> responseObserver)

Writes a single user event.

Parameters

Name	Description
request	`WriteUserEventRequest`
responseObserver	`io.grpc.stub.StreamObserver<UserEvent>`