Struct google_api_proto::google::cloud::retail::v2::user_event_service_client::UserEventServiceClient

pub struct UserEventServiceClient<T> { /* private fields */ }

Service for ingesting end user actions on the customer website.

Implementations

impl<T> UserEventServiceClient<T>

where T: GrpcService<BoxBody>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

pub fn new(inner: T) -> Self

pub fn with_origin(inner: T, origin: Uri) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> UserEventServiceClient<InterceptedService<T, F>>

where F: Interceptor, T::ResponseBody: Default, T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>, <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn write_user_event( &mut self, request: impl IntoRequest<WriteUserEventRequest>, ) -> Result<Response<UserEvent>, Status>

Writes a single user event.

pub async fn collect_user_event( &mut self, request: impl IntoRequest<CollectUserEventRequest>, ) -> Result<Response<HttpBody>, Status>

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.

pub async fn purge_user_events( &mut self, request: impl IntoRequest<PurgeUserEventsRequest>, ) -> Result<Response<Operation>, Status>

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.

pub async fn import_user_events( &mut self, request: impl IntoRequest<ImportUserEventsRequest>, ) -> Result<Response<Operation>, Status>

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.

pub async fn rejoin_user_events( &mut self, request: impl IntoRequest<RejoinUserEventsRequest>, ) -> Result<Response<Operation>, Status>

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.

Trait Implementations

impl<T: Clone> Clone for UserEventServiceClient<T>

fn clone(&self) -> UserEventServiceClient<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for UserEventServiceClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.