com.google.cloud.discoveryengine.v1beta

Interface UserEventServiceGrpc.AsyncService

All Known Implementing Classes:

UserEventServiceGrpc.UserEventServiceImplBase

Enclosing class:

UserEventServiceGrpc

public static interface UserEventServiceGrpc.AsyncService

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

Method Summary

Modifier and Type	Method and Description
default void	collectUserEvent(CollectUserEventRequest request, io.grpc.stub.StreamObserver<com.google.api.HttpBody> responseObserver) Writes a single user event from the browser.
default void	importUserEvents(ImportUserEventsRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Bulk import of user events.
default void	purgeUserEvents(PurgeUserEventsRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Deletes permanently all user events specified by the filter provided.
default void	writeUserEvent(WriteUserEventRequest request, io.grpc.stub.StreamObserver<UserEvent> responseObserver) Writes a single user event.

Method Detail

writeUserEvent

default void writeUserEvent(WriteUserEventRequest request,
                            io.grpc.stub.StreamObserver<UserEvent> responseObserver)

 Writes a single user event.
 

collectUserEvent

default void collectUserEvent(CollectUserEventRequest request,
                              io.grpc.stub.StreamObserver<com.google.api.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.
 

purgeUserEvents

default void purgeUserEvents(PurgeUserEventsRequest request,
                             io.grpc.stub.StreamObserver<com.google.longrunning.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.
 

importUserEvents

default void importUserEvents(ImportUserEventsRequest request,
                              io.grpc.stub.StreamObserver<com.google.longrunning.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.