Service for ingesting end user actions on the customer website.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
UserEventServiceClient(UserEventServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
UserEventServiceClient const &
|
UserEventServiceClient(UserEventServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
UserEventServiceClient &&
|
UserEventServiceClient(std::shared_ptr< UserEventServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< UserEventServiceConnection >
|
opts |
Options
|
Operators
operator=(UserEventServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
UserEventServiceClient const &
|
Returns | |
---|---|
Type | Description |
UserEventServiceClient & |
operator=(UserEventServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
UserEventServiceClient &&
|
Returns | |
---|---|
Type | Description |
UserEventServiceClient & |
Functions
WriteUserEvent(google::cloud::retail::v2::WriteUserEventRequest const &, Options)
Writes a single user event.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::retail::v2::WriteUserEventRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::retail::v2::UserEvent > |
the result of the RPC. The response message type (google.cloud.retail.v2.UserEvent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CollectUserEvent(google::cloud::retail::v2::CollectUserEventRequest const &, Options)
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 |
google::cloud::retail::v2::CollectUserEventRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::api::HttpBody > |
the result of the RPC. The response message type (google.api.HttpBody) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
PurgeUserEvents(google::cloud::retail::v2::PurgeUserEventsRequest const &, Options)
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 |
google::cloud::retail::v2::PurgeUserEventsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::retail::v2::PurgeUserEventsResponse > > |
A |
PurgeUserEvents(NoAwaitTag, google::cloud::retail::v2::PurgeUserEventsRequest const &, Options)
Deletes permanently all user events specified by the filter provided.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::retail::v2::PurgeUserEventsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
PurgeUserEvents(google::longrunning::Operation const &, Options)
Deletes permanently all user events specified by the filter provided.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::retail::v2::PurgeUserEventsResponse > > |
ImportUserEvents(google::cloud::retail::v2::ImportUserEventsRequest const &, Options)
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 |
google::cloud::retail::v2::ImportUserEventsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::retail::v2::ImportUserEventsResponse > > |
A |
ImportUserEvents(NoAwaitTag, google::cloud::retail::v2::ImportUserEventsRequest const &, Options)
Bulk import of User events.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::retail::v2::ImportUserEventsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
ImportUserEvents(google::longrunning::Operation const &, Options)
Bulk import of User events.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::retail::v2::ImportUserEventsResponse > > |
RejoinUserEvents(google::cloud::retail::v2::RejoinUserEventsRequest const &, Options)
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 |
google::cloud::retail::v2::RejoinUserEventsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::retail::v2::RejoinUserEventsResponse > > |
A |
RejoinUserEvents(NoAwaitTag, google::cloud::retail::v2::RejoinUserEventsRequest const &, Options)
Starts a user-event rejoin operation with latest product catalog.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::retail::v2::RejoinUserEventsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
RejoinUserEvents(google::longrunning::Operation const &, Options)
Starts a user-event rejoin operation with latest product catalog.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::retail::v2::RejoinUserEventsResponse > > |
ListOperations(std::string const &, std::string const &, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation's parent resource. |
filter |
std::string const &
The standard list filter. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListOperations(google::longrunning::ListOperationsRequest, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::ListOperationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetOperation(std::string const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetOperation(google::longrunning::GetOperationRequest const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::GetOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |