Interface UserEventServiceGrpc.AsyncService (0.35.0)

public static interface UserEventServiceGrpc.AsyncService

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

Methods

collectUserEvent(CollectUserEventRequest request, StreamObserver<HttpBody> responseObserver)

public default 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 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.

Parameters
NameDescription
requestCollectUserEventRequest
responseObserverio.grpc.stub.StreamObserver<com.google.api.HttpBody>

importUserEvents(ImportUserEventsRequest request, StreamObserver<Operation> responseObserver)

public default 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>

purgeUserEvents(PurgeUserEventsRequest request, StreamObserver<Operation> responseObserver)

public default 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
NameDescription
requestPurgeUserEventsRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

writeUserEvent(WriteUserEventRequest request, StreamObserver<UserEvent> responseObserver)

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

Writes a single user event.

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