Reference documentation and code samples for the Google Cloud Recommendation Engine V1beta1 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 {
$formattedParent = $userEventServiceClient->eventStoreName('[PROJECT]', '[LOCATION]', '[CATALOG]', '[EVENT_STORE]');
$userEvent = 'user_event';
$response = $userEventServiceClient->collectUserEvent($formattedParent, $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.
Methods
eventStoreName
Formats a string containing the fully-qualified path to represent a event_store resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
catalog |
string
|
eventStore |
string
|
| Returns | |
|---|---|
| Type | Description |
string | The formatted event_store resource. |
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
- eventStore: projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}
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. |
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 | |
__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 Recommendations AI JavaScript pixel. Users should not call this method directly.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent eventStore name, such as
|
userEvent |
string
Required. URL encoded UserEvent proto. |
optionalArgs |
array
Optional. |
↳ uri |
string
Optional. The url including cgi-parameters but excluding the hash fragment. The URL must be truncated to 1.5K bytes to conservatively be under the 2K bytes. This is often more useful than the referer url, because many browsers only send the domain for 3rd party requests. |
↳ ets |
int
Optional. The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. |
↳ 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\RecommendationEngine\V1beta1\Client\UserEventServiceClient;
use Google\Cloud\RecommendationEngine\V1beta1\CollectUserEventRequest;
/**
* @param string $formattedParent The parent eventStore name, such as
* `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`. Please see
* {@see UserEventServiceClient::eventStoreName()} for help formatting this field.
* @param string $userEvent URL encoded UserEvent proto.
*/
function collect_user_event_sample(string $formattedParent, string $userEvent): void
{
// Create a client.
$userEventServiceClient = new UserEventServiceClient();
// Prepare the request message.
$request = (new CollectUserEventRequest())
->setParent($formattedParent)
->setUserEvent($userEvent);
// Call the API and handle any network failures.
try {
/** @var HttpBody $response */
$response = $userEventServiceClient->collectUserEvent($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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::eventStoreName(
'[PROJECT]',
'[LOCATION]',
'[CATALOG]',
'[EVENT_STORE]'
);
$userEvent = '[USER_EVENT]';
collect_user_event_sample($formattedParent, $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\RecommendationEngine\V1beta1\InputConfig
Required. The desired input location of the data. |
optionalArgs |
array
Optional. |
↳ requestId |
string
Optional. Unique identifier provided by client, within the ancestor dataset scope. Ensures idempotency for expensive long running operations. Server-generated if unspecified. Up to 128 characters long. This is returned as google.longrunning.Operation.name in the response. Note that this field must not be set if the desired input config is catalog_inline_source. |
↳ errorsConfig |
ImportErrorsConfig
Optional. The desired location of errors incurred during the Import. |
↳ 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\RecommendationEngine\V1beta1\Client\UserEventServiceClient;
use Google\Cloud\RecommendationEngine\V1beta1\ImportUserEventsRequest;
use Google\Cloud\RecommendationEngine\V1beta1\ImportUserEventsResponse;
use Google\Cloud\RecommendationEngine\V1beta1\InputConfig;
use Google\Rpc\Status;
/**
* @param string $formattedParent Required.
* `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`
* Please see {@see UserEventServiceClient::eventStoreName()} for help formatting this field.
*/
function import_user_events_sample(string $formattedParent): void
{
// Create a client.
$userEventServiceClient = new UserEventServiceClient();
// Prepare the request message.
$inputConfig = new InputConfig();
$request = (new ImportUserEventsRequest())
->setParent($formattedParent)
->setInputConfig($inputConfig);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $userEventServiceClient->importUserEvents($request);
$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());
}
}
/**
* 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::eventStoreName(
'[PROJECT]',
'[LOCATION]',
'[CATALOG]',
'[EVENT_STORE]'
);
import_user_events_sample($formattedParent);
}
listUserEvents
Gets a list of user events within a time range, with potential filtering.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent eventStore resource name, such as
|
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ filter |
string
Optional. Filtering expression to specify restrictions over returned events. This is a sequence of terms, where each term applies some kind of a restriction to the returned user events. Use this expression to restrict results to a specific time range, or filter events by eventType. eg: eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search We expect only 3 types of fields: * eventTime: this can be specified a maximum of 2 times, once with a less than operator and once with a greater than operator. The eventTime restrict should result in one contiguous valid eventTime range. * eventType: only 1 eventType restriction can be specified. * eventsMissingCatalogItems: specififying this will restrict results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" * Example 2: eventTime > "2012-04-23T18:25:43.511Z" eventType = detail-page-view * Example 3: eventsMissingCatalogItems eventType = search eventTime < "2018-04-23T18:30:43.511Z" * Example 4: eventTime > "2012-04-23T18:25:43.511Z" * Example 5: eventType = search * Example 6: eventsMissingCatalogItems |
↳ 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\PagedListResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\RecommendationEngine\V1beta1\Client\UserEventServiceClient;
use Google\Cloud\RecommendationEngine\V1beta1\ListUserEventsRequest;
use Google\Cloud\RecommendationEngine\V1beta1\UserEvent;
/**
* @param string $formattedParent The parent eventStore resource name, such as
* `projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`. Please see
* {@see UserEventServiceClient::eventStoreName()} for help formatting this field.
*/
function list_user_events_sample(string $formattedParent): void
{
// Create a client.
$userEventServiceClient = new UserEventServiceClient();
// Prepare the request message.
$request = (new ListUserEventsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $userEventServiceClient->listUserEvents($request);
/** @var UserEvent $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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::eventStoreName(
'[PROJECT]',
'[LOCATION]',
'[CATALOG]',
'[EVENT_STORE]'
);
list_user_events_sample($formattedParent);
}
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 event_store under which the events are
created. The format is
|
filter |
string
Required. The filter string to specify the events to be deleted. Empty string filter is not allowed. This filter can also be used with ListUserEvents API to list events that will be deleted. The eligible fields for filtering are:
|
optionalArgs |
array
Optional. |
↳ force |
bool
Optional. The default value is false. Override this flag to true to actually perform the purge. If the field is not set to true, a sampling of events to be deleted will be returned. |
↳ 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\RecommendationEngine\V1beta1\Client\UserEventServiceClient;
use Google\Cloud\RecommendationEngine\V1beta1\PurgeUserEventsRequest;
use Google\Cloud\RecommendationEngine\V1beta1\PurgeUserEventsResponse;
use Google\Rpc\Status;
/**
* @param string $formattedParent The resource name of the event_store under which the events are
* created. The format is
* `projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}`
* Please see {@see UserEventServiceClient::eventStoreName()} for help formatting this field.
* @param string $filter The filter string to specify the events to be deleted. Empty
* string filter is not allowed. This filter can also be used with
* ListUserEvents API to list events that will be deleted. The eligible fields
* for filtering are:
* * eventType - UserEvent.eventType field of type string.
* * eventTime - in ISO 8601 "zulu" format.
* * visitorId - field of type string. Specifying this will delete all events
* associated with a visitor.
* * userId - field of type string. Specifying this will delete all events
* associated with a user.
* Example 1: Deleting all events in a time range.
* `eventTime > "2012-04-23T18:25:43.511Z" eventTime <
* "2012-04-23T18:30:43.511Z"`
* Example 2: Deleting specific eventType in time range.
* `eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"`
* Example 3: 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();
// Prepare the request message.
$request = (new PurgeUserEventsRequest())
->setParent($formattedParent)
->setFilter($filter);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $userEventServiceClient->purgeUserEvents($request);
$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());
}
}
/**
* 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::eventStoreName(
'[PROJECT]',
'[LOCATION]',
'[CATALOG]',
'[EVENT_STORE]'
);
$filter = '[FILTER]';
purge_user_events_sample($formattedParent, $filter);
}
writeUserEvent
Writes a single user event.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent eventStore resource name, such as
|
userEvent |
Google\Cloud\RecommendationEngine\V1beta1\UserEvent
Required. User event to write. |
optionalArgs |
array
Optional. |
↳ 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\RecommendationEngine\V1beta1\UserEvent | |
use Google\ApiCore\ApiException;
use Google\Cloud\RecommendationEngine\V1beta1\Client\UserEventServiceClient;
use Google\Cloud\RecommendationEngine\V1beta1\UserEvent;
use Google\Cloud\RecommendationEngine\V1beta1\UserInfo;
use Google\Cloud\RecommendationEngine\V1beta1\WriteUserEventRequest;
/**
* @param string $formattedParent The parent eventStore resource name, such as
* `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`. Please see
* {@see UserEventServiceClient::eventStoreName()} for help formatting this field.
* @param string $userEventEventType User event type. Allowed values are:
*
* * `add-to-cart` Products being added to cart.
* * `add-to-list` Items being added to a list (shopping list, favorites
* etc).
* * `category-page-view` Special pages such as sale or promotion pages
* viewed.
* * `checkout-start` User starting a checkout process.
* * `detail-page-view` Products detail page viewed.
* * `home-page-view` Homepage viewed.
* * `page-visit` Generic page visits not included in the event types above.
* * `purchase-complete` User finishing a purchase.
* * `refund` Purchased items being refunded or returned.
* * `remove-from-cart` Products being removed from cart.
* * `remove-from-list` Items being removed from a list.
* * `search` Product search.
* * `shopping-cart-page-view` User viewing a shopping cart.
* * `impression` List of items displayed. Used by Google Tag Manager.
* @param string $userEventUserInfoVisitorId A unique identifier for tracking visitors with a length limit of
* 128 bytes.
*
* For example, this could be implemented with a 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.
* Maximum length 128 bytes. Cannot be empty.
*/
function write_user_event_sample(
string $formattedParent,
string $userEventEventType,
string $userEventUserInfoVisitorId
): void {
// Create a client.
$userEventServiceClient = new UserEventServiceClient();
// Prepare the request message.
$userEventUserInfo = (new UserInfo())
->setVisitorId($userEventUserInfoVisitorId);
$userEvent = (new UserEvent())
->setEventType($userEventEventType)
->setUserInfo($userEventUserInfo);
$request = (new WriteUserEventRequest())
->setParent($formattedParent)
->setUserEvent($userEvent);
// Call the API and handle any network failures.
try {
/** @var UserEvent $response */
$response = $userEventServiceClient->writeUserEvent($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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::eventStoreName(
'[PROJECT]',
'[LOCATION]',
'[CATALOG]',
'[EVENT_STORE]'
);
$userEventEventType = '[EVENT_TYPE]';
$userEventUserInfoVisitorId = '[VISITOR_ID]';
write_user_event_sample($formattedParent, $userEventEventType, $userEventUserInfoVisitorId);
}
Constants
SERVICE_NAME
Value: 'google.cloud.recommendationengine.v1beta1.UserEventService'The name of the service.
SERVICE_ADDRESS
Value: 'recommendationengine.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.