Interface UserEventServiceGrpc.AsyncService (2.47.0)

public static interface UserEventServiceGrpc.AsyncService

Service for ingesting end user actions on the customer website.

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 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 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
Name	Description
`request`	`ImportUserEventsRequest`
`responseObserver`	`io.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
Name	Description
`request`	`PurgeUserEventsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

rejoinUserEvents(RejoinUserEventsRequest request, StreamObserver<Operation> responseObserver)

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

Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method 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 default void writeUserEvent(WriteUserEventRequest request, StreamObserver<UserEvent> responseObserver)

Writes a single user event.

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