public sealed class UserEventServiceClientImpl : UserEventServiceClientReference documentation and code samples for the Discovery Engine v1 API class UserEventServiceClientImpl.
UserEventService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.DiscoveryEngine.V1Assembly
Google.Cloud.DiscoveryEngine.V1.dll
Remarks
Service for ingesting end user actions on a website to Discovery Engine API.
Constructors
UserEventServiceClientImpl(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 |
UserEventServiceUserEventServiceClientThe underlying gRPC client. |
settings |
UserEventServiceSettingsThe base UserEventServiceSettings used within this client. |
logger |
ILoggerOptional ILogger to use within this client. |
Properties
GrpcClient
public override UserEventService.UserEventServiceClient GrpcClient { get; }The underlying gRPC UserEventService client
| Property Value | |
|---|---|
| Type | Description |
UserEventServiceUserEventServiceClient |
|
ImportUserEventsOperationsClient
public override OperationsClient ImportUserEventsOperationsClient { get; }The long-running operations client for ImportUserEvents.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
LocationsClient
public override LocationsClient LocationsClient { get; }The LocationsClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
LocationsClient |
|
PurgeUserEventsOperationsClient
public override OperationsClient PurgeUserEventsOperationsClient { get; }The long-running operations client for PurgeUserEvents.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
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 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.
| Parameters | |
|---|---|
| Name | Description |
request |
CollectUserEventRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
HttpBody |
The RPC response. |
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 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.
| Parameters | |
|---|---|
| Name | Description |
request |
CollectUserEventRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskHttpBody |
A Task containing the RPC response. |
ImportUserEvents(ImportUserEventsRequest, CallSettings)
public override Operation<ImportUserEventsResponse, ImportUserEventsMetadata> 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 |
ImportUserEventsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationImportUserEventsResponseImportUserEventsMetadata |
The RPC response. |
ImportUserEventsAsync(ImportUserEventsRequest, CallSettings)
public override Task<Operation<ImportUserEventsResponse, ImportUserEventsMetadata>> 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 |
ImportUserEventsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationImportUserEventsResponseImportUserEventsMetadata |
A Task containing the RPC response. |
PurgeUserEvents(PurgeUserEventsRequest, CallSettings)
public override Operation<PurgeUserEventsResponse, PurgeUserEventsMetadata> 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 |
PurgeUserEventsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationPurgeUserEventsResponsePurgeUserEventsMetadata |
The RPC response. |
PurgeUserEventsAsync(PurgeUserEventsRequest, CallSettings)
public override Task<Operation<PurgeUserEventsResponse, PurgeUserEventsMetadata>> PurgeUserEventsAsync(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 |
PurgeUserEventsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationPurgeUserEventsResponsePurgeUserEventsMetadata |
A Task containing the RPC response. |
WriteUserEvent(WriteUserEventRequest, CallSettings)
public override UserEvent WriteUserEvent(WriteUserEventRequest request, CallSettings callSettings = null)Writes a single user event.
| Parameters | |
|---|---|
| Name | Description |
request |
WriteUserEventRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
UserEvent |
The RPC response. |
WriteUserEventAsync(WriteUserEventRequest, CallSettings)
public override Task<UserEvent> WriteUserEventAsync(WriteUserEventRequest request, CallSettings callSettings = null)Writes a single user event.
| Parameters | |
|---|---|
| Name | Description |
request |
WriteUserEventRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskUserEvent |
A Task containing the RPC response. |