Retail v2 API - Class UserEventServiceClientImpl (2.4.0)

public sealed class UserEventServiceClientImpl : UserEventServiceClient

Reference documentation and code samples for the Retail v2 API class UserEventServiceClientImpl.

UserEventService client wrapper implementation, for convenient use.

Inheritance

Object > UserEventServiceClient > UserEventServiceClientImpl

Inherited Members

UserEventServiceClient.DefaultEndpoint

UserEventServiceClient.DefaultScopes

UserEventServiceClient.ServiceMetadata

UserEventServiceClient.CreateAsync(CancellationToken)

UserEventServiceClient.Create()

UserEventServiceClient.ShutdownDefaultChannelsAsync()

UserEventServiceClient.WriteUserEventAsync(WriteUserEventRequest, CancellationToken)

UserEventServiceClient.CollectUserEventAsync(CollectUserEventRequest, CancellationToken)

UserEventServiceClient.PurgeUserEventsAsync(PurgeUserEventsRequest, CancellationToken)

UserEventServiceClient.PollOncePurgeUserEvents(String, CallSettings)

UserEventServiceClient.PollOncePurgeUserEventsAsync(String, CallSettings)

UserEventServiceClient.ImportUserEventsAsync(ImportUserEventsRequest, CancellationToken)

UserEventServiceClient.PollOnceImportUserEvents(String, CallSettings)

UserEventServiceClient.PollOnceImportUserEventsAsync(String, CallSettings)

UserEventServiceClient.RejoinUserEventsAsync(RejoinUserEventsRequest, CancellationToken)

UserEventServiceClient.PollOnceRejoinUserEvents(String, CallSettings)

UserEventServiceClient.PollOnceRejoinUserEventsAsync(String, CallSettings)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Remarks

Service for ingesting end user actions on the customer website.

Constructors

UserEventServiceClientImpl(UserEventService.UserEventServiceClient, UserEventServiceSettings, ILogger)

public UserEventServiceClientImpl(UserEventService.UserEventServiceClient grpcClient, UserEventServiceSettings settings, ILogger logger)

Constructs a client wrapper for the UserEventService service, with the specified gRPC client and settings.

Parameters
Name	Description
`grpcClient`	`UserEventService.UserEventServiceClient` The underlying gRPC client.
`settings`	`UserEventServiceSettings` The base UserEventServiceSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

GrpcClient

public override UserEventService.UserEventServiceClient GrpcClient { get; }

The underlying gRPC UserEventService client

Property Value
Type	Description
`UserEventService.UserEventServiceClient`

Overrides

UserEventServiceClient.GrpcClient

ImportUserEventsOperationsClient

public override OperationsClient ImportUserEventsOperationsClient { get; }

The long-running operations client for ImportUserEvents.

Property Value
Type	Description
`OperationsClient`

Overrides

UserEventServiceClient.ImportUserEventsOperationsClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
`LocationsClient`

Overrides

UserEventServiceClient.LocationsClient

PurgeUserEventsOperationsClient

public override OperationsClient PurgeUserEventsOperationsClient { get; }

The long-running operations client for PurgeUserEvents.

Property Value
Type	Description
`OperationsClient`

Overrides

UserEventServiceClient.PurgeUserEventsOperationsClient

RejoinUserEventsOperationsClient

public override OperationsClient RejoinUserEventsOperationsClient { get; }

The long-running operations client for RejoinUserEvents.

Property Value
Type	Description
`OperationsClient`

Overrides

UserEventServiceClient.RejoinUserEventsOperationsClient

Methods

CollectUserEvent(CollectUserEventRequest, CallSettings)

public override HttpBody CollectUserEvent(CollectUserEventRequest request, CallSettings callSettings = null)

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` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`HttpBody`	The RPC response.

Overrides

UserEventServiceClient.CollectUserEvent(CollectUserEventRequest, CallSettings)

CollectUserEventAsync(CollectUserEventRequest, CallSettings)

public override Task<HttpBody> CollectUserEventAsync(CollectUserEventRequest request, CallSettings callSettings = null)

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` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<HttpBody>`	A Task containing the RPC response.

Overrides

UserEventServiceClient.CollectUserEventAsync(CollectUserEventRequest, CallSettings)

ImportUserEvents(ImportUserEventsRequest, CallSettings)

public override Operation<ImportUserEventsResponse, ImportMetadata> ImportUserEvents(ImportUserEventsRequest request, CallSettings callSettings = null)

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` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<ImportUserEventsResponse, ImportMetadata>`	The RPC response.

Overrides

UserEventServiceClient.ImportUserEvents(ImportUserEventsRequest, CallSettings)

ImportUserEventsAsync(ImportUserEventsRequest, CallSettings)

public override async Task<Operation<ImportUserEventsResponse, ImportMetadata>> ImportUserEventsAsync(ImportUserEventsRequest request, CallSettings callSettings = null)

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` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<ImportUserEventsResponse, ImportMetadata>>`	A Task containing the RPC response.

Overrides

UserEventServiceClient.ImportUserEventsAsync(ImportUserEventsRequest, CallSettings)

PurgeUserEvents(PurgeUserEventsRequest, CallSettings)

public override Operation<PurgeUserEventsResponse, PurgeMetadata> PurgeUserEvents(PurgeUserEventsRequest request, CallSettings callSettings = null)

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` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<PurgeUserEventsResponse, PurgeMetadata>`	The RPC response.

Overrides

UserEventServiceClient.PurgeUserEvents(PurgeUserEventsRequest, CallSettings)

PurgeUserEventsAsync(PurgeUserEventsRequest, CallSettings)

public override async Task<Operation<PurgeUserEventsResponse, PurgeMetadata>> PurgeUserEventsAsync(PurgeUserEventsRequest request, CallSettings callSettings = null)

Parameters
Name	Description
`request`	`PurgeUserEventsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<PurgeUserEventsResponse, PurgeMetadata>>`	A Task containing the RPC response.

Overrides

UserEventServiceClient.PurgeUserEventsAsync(PurgeUserEventsRequest, CallSettings)

RejoinUserEvents(RejoinUserEventsRequest, CallSettings)

public override Operation<RejoinUserEventsResponse, RejoinUserEventsMetadata> RejoinUserEvents(RejoinUserEventsRequest request, CallSettings callSettings = null)

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` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<RejoinUserEventsResponse, RejoinUserEventsMetadata>`	The RPC response.

Overrides

UserEventServiceClient.RejoinUserEvents(RejoinUserEventsRequest, CallSettings)

RejoinUserEventsAsync(RejoinUserEventsRequest, CallSettings)

public override async Task<Operation<RejoinUserEventsResponse, RejoinUserEventsMetadata>> RejoinUserEventsAsync(RejoinUserEventsRequest request, CallSettings callSettings = null)

Parameters
Name	Description
`request`	`RejoinUserEventsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<RejoinUserEventsResponse, RejoinUserEventsMetadata>>`	A Task containing the RPC response.

Overrides

UserEventServiceClient.RejoinUserEventsAsync(RejoinUserEventsRequest, CallSettings)

WriteUserEvent(WriteUserEventRequest, CallSettings)

public override UserEvent WriteUserEvent(WriteUserEventRequest request, CallSettings callSettings = null)

Writes a single user event.

Parameters
Name	Description
`request`	`WriteUserEventRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`UserEvent`	The RPC response.

Overrides

UserEventServiceClient.WriteUserEvent(WriteUserEventRequest, CallSettings)

WriteUserEventAsync(WriteUserEventRequest, CallSettings)

public override Task<UserEvent> WriteUserEventAsync(WriteUserEventRequest request, CallSettings callSettings = null)

Writes a single user event.

Parameters
Name	Description
`request`	`WriteUserEventRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<UserEvent>`	A Task containing the RPC response.

Overrides

UserEventServiceClient.WriteUserEventAsync(WriteUserEventRequest, CallSettings)