Class UserEventServiceGrpc.UserEventServiceStub (0.17.0)

public static final class UserEventServiceGrpc.UserEventServiceStub extends AbstractAsyncStub<UserEventServiceGrpc.UserEventServiceStub>

A stub to allow clients to do asynchronous 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.AbstractAsyncStub > UserEventServiceGrpc.UserEventServiceStub

Methods

build(Channel channel, CallOptions callOptions)

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

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 Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

Parameters
NameDescription
requestCollectUserEventRequest
responseObserverio.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
NameDescription
requestImportUserEventsRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

writeUserEvent(WriteUserEventRequest request, StreamObserver<UserEvent> responseObserver)

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

Writes a single user event.

Parameters
NameDescription
requestWriteUserEventRequest
responseObserverio.grpc.stub.StreamObserver<UserEvent>