Class UserEventServiceGrpc.UserEventServiceFutureStub (0.37.0)

public static final class UserEventServiceGrpc.UserEventServiceFutureStub extends AbstractFutureStub<UserEventServiceGrpc.UserEventServiceFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service UserEventService.

Service for ingesting end user actions on a website to Discovery Engine API.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > UserEventServiceGrpc.UserEventServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected UserEventServiceGrpc.UserEventServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
UserEventServiceGrpc.UserEventServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

collectUserEvent(CollectUserEventRequest request)

public ListenableFuture<HttpBody> collectUserEvent(CollectUserEventRequest request)

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.

Parameter
NameDescription
requestCollectUserEventRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<com.google.api.HttpBody>

importUserEvents(ImportUserEventsRequest request)

public ListenableFuture<Operation> importUserEvents(ImportUserEventsRequest request)

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.

Parameter
NameDescription
requestImportUserEventsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

writeUserEvent(WriteUserEventRequest request)

public ListenableFuture<UserEvent> writeUserEvent(WriteUserEventRequest request)

Writes a single user event.

Parameter
NameDescription
requestWriteUserEventRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<UserEvent>