Class UserEventServiceGrpc.UserEventServiceBlockingStub (2.9.0)

public static final class UserEventServiceGrpc.UserEventServiceBlockingStub extends AbstractBlockingStub<UserEventServiceGrpc.UserEventServiceBlockingStub>

Service for ingesting end user actions on the customer website.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > UserEventServiceGrpc.UserEventServiceBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

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

collectUserEvent(CollectUserEventRequest request)

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

Parameter
NameDescription
requestCollectUserEventRequest
Returns
TypeDescription
com.google.api.HttpBody

importUserEvents(ImportUserEventsRequest request)

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

purgeUserEvents(PurgeUserEventsRequest request)

public Operation purgeUserEvents(PurgeUserEventsRequest request)

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.

Parameter
NameDescription
requestPurgeUserEventsRequest
Returns
TypeDescription
Operation

rejoinUserEvents(RejoinUserEventsRequest request)

public Operation rejoinUserEvents(RejoinUserEventsRequest request)

Starts a user event rejoin operation with latest product catalog. Events will not be annotated with detailed product information if product is missing from the catalog at the time the user event is ingested, and these events are stored as unjoined events with a limited usage on training and serving. This method can be used to start a join operation on specified events with latest version of product catalog. It can also be used to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete.

Parameter
NameDescription
requestRejoinUserEventsRequest
Returns
TypeDescription
Operation

writeUserEvent(WriteUserEventRequest request)

public UserEvent writeUserEvent(WriteUserEventRequest request)

Writes a single user event.

Parameter
NameDescription
requestWriteUserEventRequest
Returns
TypeDescription
UserEvent