Reference documentation and code samples for the Google Cloud Retail V2 Client class UserEventServiceClient.
Service Description: Service for ingesting end user actions on the customer website.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
$userEventServiceClient = new UserEventServiceClient();
try {
$parent = 'parent';
$userEvent = 'user_event';
$response = $userEventServiceClient->collectUserEvent($parent, $userEvent);
} finally {
$userEventServiceClient->close();
}
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
This service has a new (beta) implementation. See Google\Cloud\Retail\V2\Client\UserEventServiceClient to use the new surface.
Namespace
Google \ Cloud \ Retail \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
collectUserEvent
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 |
parent |
string
Required. The parent catalog name, such as
|
userEvent |
string
Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. |
optionalArgs |
array
Optional. |
↳ prebuiltRule |
string
The prebuilt rule name that can convert a specific type of raw_json. For example: "ga4_bq" rule for the GA4 user event schema. |
↳ uri |
string
The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests. |
↳ ets |
int
The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. |
↳ rawJson |
string
An arbitrary serialized JSON string that contains necessary information that can comprise a user event. When this field is specified, the user_event field will be ignored. Note: line-delimited JSON is not supported, a single JSON only. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Api\HttpBody | |
use Google\ApiCore\ApiException;
use Google\Api\HttpBody;
use Google\Cloud\Retail\V2\UserEventServiceClient;
/**
* @param string $parent The parent catalog name, such as
* `projects/1234/locations/global/catalogs/default_catalog`.
* @param string $userEvent URL encoded UserEvent proto with a length limit of 2,000,000
* characters.
*/
function collect_user_event_sample(string $parent, string $userEvent): void
{
// Create a client.
$userEventServiceClient = new UserEventServiceClient();
// Call the API and handle any network failures.
try {
/** @var HttpBody $response */
$response = $userEventServiceClient->collectUserEvent($parent, $userEvent);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$parent = '[PARENT]';
$userEvent = '[USER_EVENT]';
collect_user_event_sample($parent, $userEvent);
}
importUserEvents
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 |
parent |
string
Required. |
inputConfig |
Google\Cloud\Retail\V2\UserEventInputConfig
Required. The desired input location of the data. |
optionalArgs |
array
Optional. |
↳ errorsConfig |
ImportErrorsConfig
The desired location of errors incurred during the Import. Cannot be set for inline user event imports. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Retail\V2\ImportUserEventsResponse;
use Google\Cloud\Retail\V2\UserEvent;
use Google\Cloud\Retail\V2\UserEventInlineSource;
use Google\Cloud\Retail\V2\UserEventInputConfig;
use Google\Cloud\Retail\V2\UserEventServiceClient;
use Google\Rpc\Status;
/**
* @param string $formattedParent `projects/1234/locations/global/catalogs/default_catalog`
* Please see {@see UserEventServiceClient::catalogName()} for help formatting this field.
* @param string $inputConfigUserEventInlineSourceUserEventsEventType User event type. Allowed values are:
*
* * `add-to-cart`: Products being added to cart.
* * `category-page-view`: Special pages such as sale or promotion pages
* viewed.
* * `detail-page-view`: Products detail page viewed.
* * `home-page-view`: Homepage viewed.
* * `promotion-offered`: Promotion is offered to a user.
* * `promotion-not-offered`: Promotion is not offered to a user.
* * `purchase-complete`: User finishing a purchase.
* * `search`: Product search.
* * `shopping-cart-page-view`: User viewing a shopping cart.
* @param string $inputConfigUserEventInlineSourceUserEventsVisitorId A unique identifier for tracking visitors.
*
* For example, this could be implemented with an HTTP cookie, which should be
* able to uniquely identify a visitor on a single device. This unique
* identifier should not change if the visitor log in/out of the website.
*
* Don't set the field to the same fixed ID for different users. This mixes
* the event history of those users together, which results in degraded model
* quality.
*
* The field must be a UTF-8 encoded string with a length limit of 128
* characters. Otherwise, an INVALID_ARGUMENT error is returned.
*
* The field should not contain PII or user-data. We recommend to use Google
* Analytics [Client
* ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId)
* for this field.
*/
function import_user_events_sample(
string $formattedParent,
string $inputConfigUserEventInlineSourceUserEventsEventType,
string $inputConfigUserEventInlineSourceUserEventsVisitorId
): void {
// Create a client.
$userEventServiceClient = new UserEventServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$userEvent = (new UserEvent())
->setEventType($inputConfigUserEventInlineSourceUserEventsEventType)
->setVisitorId($inputConfigUserEventInlineSourceUserEventsVisitorId);
$inputConfigUserEventInlineSourceUserEvents = [$userEvent,];
$inputConfigUserEventInlineSource = (new UserEventInlineSource())
->setUserEvents($inputConfigUserEventInlineSourceUserEvents);
$inputConfig = (new UserEventInputConfig())
->setUserEventInlineSource($inputConfigUserEventInlineSource);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $userEventServiceClient->importUserEvents($formattedParent, $inputConfig);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ImportUserEventsResponse $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = UserEventServiceClient::catalogName('[PROJECT]', '[LOCATION]', '[CATALOG]');
$inputConfigUserEventInlineSourceUserEventsEventType = '[EVENT_TYPE]';
$inputConfigUserEventInlineSourceUserEventsVisitorId = '[VISITOR_ID]';
import_user_events_sample(
$formattedParent,
$inputConfigUserEventInlineSourceUserEventsEventType,
$inputConfigUserEventInlineSourceUserEventsVisitorId
);
}
purgeUserEvents
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 |
parent |
string
Required. The resource name of the catalog under which the events are
created. The format is
|
filter |
string
Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. Empty string filter is not allowed. The eligible fields for filtering are:
Examples:
The filtering fields are assumed to have an implicit AND. |
optionalArgs |
array
Optional. |
↳ force |
bool
Actually perform the purge. If |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Retail\V2\PurgeUserEventsResponse;
use Google\Cloud\Retail\V2\UserEventServiceClient;
use Google\Rpc\Status;
/**
* @param string $formattedParent The resource name of the catalog under which the events are
* created. The format is
* `projects/${projectId}/locations/global/catalogs/${catalogId}`
* Please see {@see UserEventServiceClient::catalogName()} for help formatting this field.
* @param string $filter The filter string to specify the events to be deleted with a
* length limit of 5,000 characters. Empty string filter is not allowed. The
* eligible fields for filtering are:
*
* * `eventType`: Double quoted
* [UserEvent.event_type][google.cloud.retail.v2.UserEvent.event_type] string.
* * `eventTime`: in ISO 8601 "zulu" format.
* * `visitorId`: Double quoted string. Specifying this will delete all
* events associated with a visitor.
* * `userId`: Double quoted string. Specifying this will delete all events
* associated with a user.
*
* Examples:
*
* * Deleting all events in a time range:
* `eventTime > "2012-04-23T18:25:43.511Z"
* eventTime < "2012-04-23T18:30:43.511Z"`
* * Deleting specific eventType in time range:
* `eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"`
* * Deleting all events for a specific visitor:
* `visitorId = "visitor1024"`
*
* The filtering fields are assumed to have an implicit AND.
*/
function purge_user_events_sample(string $formattedParent, string $filter): void
{
// Create a client.
$userEventServiceClient = new UserEventServiceClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $userEventServiceClient->purgeUserEvents($formattedParent, $filter);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var PurgeUserEventsResponse $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = UserEventServiceClient::catalogName('[PROJECT]', '[LOCATION]', '[CATALOG]');
$filter = '[FILTER]';
purge_user_events_sample($formattedParent, $filter);
}
rejoinUserEvents
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 |
parent |
string
Required. The parent catalog resource name, such as
|
optionalArgs |
array
Optional. |
↳ userEventRejoinScope |
int
The type of the user event rejoin to define the scope and range of the user events to be rejoined with the latest product catalog. Defaults to |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Retail\V2\RejoinUserEventsResponse;
use Google\Cloud\Retail\V2\UserEventServiceClient;
use Google\Rpc\Status;
/**
* @param string $parent The parent catalog resource name, such as
* `projects/1234/locations/global/catalogs/default_catalog`.
*/
function rejoin_user_events_sample(string $parent): void
{
// Create a client.
$userEventServiceClient = new UserEventServiceClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $userEventServiceClient->rejoinUserEvents($parent);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var RejoinUserEventsResponse $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$parent = '[PARENT]';
rejoin_user_events_sample($parent);
}
writeUserEvent
Writes a single user event.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent catalog resource name, such as
|
userEvent |
Google\Cloud\Retail\V2\UserEvent
Required. User event to write. |
optionalArgs |
array
Optional. |
↳ writeAsync |
bool
If set to true, the user event will be written asynchronously after validation, and the API will respond without waiting for the write. Therefore, silent failures can occur even if the API returns success. In case of silent failures, error messages can be found in Stackdriver logs. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Retail\V2\UserEvent | |
use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\UserEvent;
use Google\Cloud\Retail\V2\UserEventServiceClient;
/**
* @param string $parent The parent catalog resource name, such as
* `projects/1234/locations/global/catalogs/default_catalog`.
* @param string $userEventEventType User event type. Allowed values are:
*
* * `add-to-cart`: Products being added to cart.
* * `category-page-view`: Special pages such as sale or promotion pages
* viewed.
* * `detail-page-view`: Products detail page viewed.
* * `home-page-view`: Homepage viewed.
* * `promotion-offered`: Promotion is offered to a user.
* * `promotion-not-offered`: Promotion is not offered to a user.
* * `purchase-complete`: User finishing a purchase.
* * `search`: Product search.
* * `shopping-cart-page-view`: User viewing a shopping cart.
* @param string $userEventVisitorId A unique identifier for tracking visitors.
*
* For example, this could be implemented with an HTTP cookie, which should be
* able to uniquely identify a visitor on a single device. This unique
* identifier should not change if the visitor log in/out of the website.
*
* Don't set the field to the same fixed ID for different users. This mixes
* the event history of those users together, which results in degraded model
* quality.
*
* The field must be a UTF-8 encoded string with a length limit of 128
* characters. Otherwise, an INVALID_ARGUMENT error is returned.
*
* The field should not contain PII or user-data. We recommend to use Google
* Analytics [Client
* ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId)
* for this field.
*/
function write_user_event_sample(
string $parent,
string $userEventEventType,
string $userEventVisitorId
): void {
// Create a client.
$userEventServiceClient = new UserEventServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$userEvent = (new UserEvent())
->setEventType($userEventEventType)
->setVisitorId($userEventVisitorId);
// Call the API and handle any network failures.
try {
/** @var UserEvent $response */
$response = $userEventServiceClient->writeUserEvent($parent, $userEvent);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$parent = '[PARENT]';
$userEventEventType = '[EVENT_TYPE]';
$userEventVisitorId = '[VISITOR_ID]';
write_user_event_sample($parent, $userEventEventType, $userEventVisitorId);
}
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\LongRunning\OperationsClient | |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
| Parameters | |
|---|---|
| Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
static::catalogName
Formats a string containing the fully-qualified path to represent a catalog resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
catalog |
string
|
| Returns | |
|---|---|
| Type | Description |
string | The formatted catalog resource. |
static::productName
Formats a string containing the fully-qualified path to represent a product resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
catalog |
string
|
branch |
string
|
product |
string
|
| Returns | |
|---|---|
| Type | Description |
string | The formatted product resource. |
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- catalog: projects/{project}/locations/{location}/catalogs/{catalog}
- product: projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}/products/{product}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
| Parameters | |
|---|---|
| Name | Description |
formattedName |
string
The formatted name string |
template |
string
Optional name of template to match |
| Returns | |
|---|---|
| Type | Description |
array | An associative array from name component IDs to component values. |
Constants
SERVICE_NAME
Value: 'google.cloud.retail.v2.UserEventService'The name of the service.
SERVICE_ADDRESS
Value: 'retail.googleapis.com'The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443The default port of the service.
CODEGEN_NAME
Value: 'gapic'The name of the code generator, to be included in the agent header.