Google Cloud Recommendation Engine V1beta1 Client - Class CatalogServiceClient (0.7.4)

Reference documentation and code samples for the Google Cloud Recommendation Engine V1beta1 Client class CatalogServiceClient.

Service Description: Service for ingesting catalog information of the customer's 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:

$catalogServiceClient = new CatalogServiceClient();
try {
    $formattedParent = $catalogServiceClient->catalogName('[PROJECT]', '[LOCATION]', '[CATALOG]');
    $catalogItem = new CatalogItem();
    $response = $catalogServiceClient->createCatalogItem($formattedParent, $catalogItem);
} finally {
    $catalogServiceClient->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.

Namespace

Google \ Cloud \ RecommendationEngine \ V1beta1

Methods

__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 `false`.
`↳ 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 `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ 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.

createCatalogItem

Creates a catalog item.

Parameters
Name	Description
`parent`	`string` Required. The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`.
`catalogItem`	`Google\Cloud\RecommendationEngine\V1beta1\CatalogItem` Required. The catalog item to create.
`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\CatalogItem`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\RecommendationEngine\V1beta1\CatalogItem;
use Google\Cloud\RecommendationEngine\V1beta1\CatalogItem\CategoryHierarchy;
use Google\Cloud\RecommendationEngine\V1beta1\Client\CatalogServiceClient;
use Google\Cloud\RecommendationEngine\V1beta1\CreateCatalogItemRequest;

/**
 * @param string $formattedParent                                 The parent catalog resource name, such as
 *                                                                `projects/&#42;/locations/global/catalogs/default_catalog`. Please see
 *                                                                {@see CatalogServiceClient::catalogName()} for help formatting this field.
 * @param string $catalogItemId                                   Catalog item identifier. UTF-8 encoded string with a length limit
 *                                                                of 128 bytes.
 *
 *                                                                This id must be unique among all catalog items within the same catalog. It
 *                                                                should also be used when logging user events in order for the user events
 *                                                                to be joined with the Catalog.
 * @param string $catalogItemCategoryHierarchiesCategoriesElement Catalog item categories. Each category should be a UTF-8
 *                                                                encoded string with a length limit of 2 KiB.
 *
 *                                                                Note that the order in the list denotes the specificity (from least to
 *                                                                most specific).
 * @param string $catalogItemTitle                                Catalog item title. UTF-8 encoded string with a length limit of 1
 *                                                                KiB.
 */
function create_catalog_item_sample(
    string $formattedParent,
    string $catalogItemId,
    string $catalogItemCategoryHierarchiesCategoriesElement,
    string $catalogItemTitle
): void {
    // Create a client.
    $catalogServiceClient = new CatalogServiceClient();

    // Prepare the request message.
    $catalogItemCategoryHierarchiesCategories = [$catalogItemCategoryHierarchiesCategoriesElement,];
    $categoryHierarchy = (new CategoryHierarchy())
        ->setCategories($catalogItemCategoryHierarchiesCategories);
    $catalogItemCategoryHierarchies = [$categoryHierarchy,];
    $catalogItem = (new CatalogItem())
        ->setId($catalogItemId)
        ->setCategoryHierarchies($catalogItemCategoryHierarchies)
        ->setTitle($catalogItemTitle);
    $request = (new CreateCatalogItemRequest())
        ->setParent($formattedParent)
        ->setCatalogItem($catalogItem);

    // Call the API and handle any network failures.
    try {
        /** @var CatalogItem $response */
        $response = $catalogServiceClient->createCatalogItem($request);
        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
{
    $formattedParent = CatalogServiceClient::catalogName('[PROJECT]', '[LOCATION]', '[CATALOG]');
    $catalogItemId = '[ID]';
    $catalogItemCategoryHierarchiesCategoriesElement = '[CATEGORIES]';
    $catalogItemTitle = '[TITLE]';

    create_catalog_item_sample(
        $formattedParent,
        $catalogItemId,
        $catalogItemCategoryHierarchiesCategoriesElement,
        $catalogItemTitle
    );
}

deleteCatalogItem

Deletes a catalog item.

Parameters
Name	Description
`name`	`string` Required. Full resource name of catalog item, such as `projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id`.
`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.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\RecommendationEngine\V1beta1\Client\CatalogServiceClient;
use Google\Cloud\RecommendationEngine\V1beta1\DeleteCatalogItemRequest;

/**
 * @param string $formattedName Full resource name of catalog item, such as
 *                              `projects/&#42;/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id`. Please see
 *                              {@see CatalogServiceClient::catalogItemPathName()} for help formatting this field.
 */
function delete_catalog_item_sample(string $formattedName): void
{
    // Create a client.
    $catalogServiceClient = new CatalogServiceClient();

    // Prepare the request message.
    $request = (new DeleteCatalogItemRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $catalogServiceClient->deleteCatalogItem($request);
        printf('Call completed successfully.' . PHP_EOL);
    } 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
{
    $formattedName = CatalogServiceClient::catalogItemPathName(
        '[PROJECT]',
        '[LOCATION]',
        '[CATALOG]',
        '[CATALOG_ITEM_PATH]'
    );

    delete_catalog_item_sample($formattedName);
}

getCatalogItem

Gets a specific catalog item.

Parameters
Name	Description
`name`	`string` Required. Full resource name of catalog item, such as `projects/*/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id`.
`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\CatalogItem`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\RecommendationEngine\V1beta1\CatalogItem;
use Google\Cloud\RecommendationEngine\V1beta1\Client\CatalogServiceClient;
use Google\Cloud\RecommendationEngine\V1beta1\GetCatalogItemRequest;

/**
 * @param string $formattedName Full resource name of catalog item, such as
 *                              `projects/&#42;/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id`. Please see
 *                              {@see CatalogServiceClient::catalogItemPathName()} for help formatting this field.
 */
function get_catalog_item_sample(string $formattedName): void
{
    // Create a client.
    $catalogServiceClient = new CatalogServiceClient();

    // Prepare the request message.
    $request = (new GetCatalogItemRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var CatalogItem $response */
        $response = $catalogServiceClient->getCatalogItem($request);
        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
{
    $formattedName = CatalogServiceClient::catalogItemPathName(
        '[PROJECT]',
        '[LOCATION]',
        '[CATALOG]',
        '[CATALOG_ITEM_PATH]'
    );

    get_catalog_item_sample($formattedName);
}

importCatalogItems

Bulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported. Non-existing items will be created.

Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully updated.

Parameters
Name	Description
`parent`	`string` Required. `projects/1234/locations/global/catalogs/default_catalog`
`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 and used for request deduplication. Server-generated if unspecified. Up to 128 characters long. This is returned as google.longrunning.Operation.name in the response.
`↳ 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\RecommendationEngine\V1beta1\Client\CatalogServiceClient;
use Google\Cloud\RecommendationEngine\V1beta1\ImportCatalogItemsRequest;
use Google\Cloud\RecommendationEngine\V1beta1\ImportCatalogItemsResponse;
use Google\Cloud\RecommendationEngine\V1beta1\InputConfig;
use Google\Rpc\Status;

/**
 * @param string $formattedParent `projects/1234/locations/global/catalogs/default_catalog`
 *                                Please see {@see CatalogServiceClient::catalogName()} for help formatting this field.
 */
function import_catalog_items_sample(string $formattedParent): void
{
    // Create a client.
    $catalogServiceClient = new CatalogServiceClient();

    // Prepare the request message.
    $inputConfig = new InputConfig();
    $request = (new ImportCatalogItemsRequest())
        ->setParent($formattedParent)
        ->setInputConfig($inputConfig);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $catalogServiceClient->importCatalogItems($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var ImportCatalogItemsResponse $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 = CatalogServiceClient::catalogName('[PROJECT]', '[LOCATION]', '[CATALOG]');

    import_catalog_items_sample($formattedParent);
}

listCatalogItems

Gets a list of catalog items.

Parameters
Name	Description
`parent`	`string` Required. The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`.
`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. A filter to apply on the list results.
`↳ 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\RecommendationEngine\V1beta1\CatalogItem;
use Google\Cloud\RecommendationEngine\V1beta1\Client\CatalogServiceClient;
use Google\Cloud\RecommendationEngine\V1beta1\ListCatalogItemsRequest;

/**
 * @param string $formattedParent The parent catalog resource name, such as
 *                                `projects/&#42;/locations/global/catalogs/default_catalog`. Please see
 *                                {@see CatalogServiceClient::catalogName()} for help formatting this field.
 */
function list_catalog_items_sample(string $formattedParent): void
{
    // Create a client.
    $catalogServiceClient = new CatalogServiceClient();

    // Prepare the request message.
    $request = (new ListCatalogItemsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $catalogServiceClient->listCatalogItems($request);

        /** @var CatalogItem $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());
    }
}

/**
 * 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 = CatalogServiceClient::catalogName('[PROJECT]', '[LOCATION]', '[CATALOG]');

    list_catalog_items_sample($formattedParent);
}

updateCatalogItem

Updates a catalog item. Partial updating is supported. Non-existing items will be created.

Parameters
Name	Description
`name`	`string` Required. Full resource name of catalog item, such as `projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id`.
`catalogItem`	`Google\Cloud\RecommendationEngine\V1beta1\CatalogItem` Required. The catalog item to update/create. The 'catalog_item_id' field has to match that in the 'name'.
`optionalArgs`	`array` Optional.
`↳ updateMask`	`FieldMask` Optional. Indicates which fields in the provided 'item' to update. If not set, will by default update all fields.
`↳ 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\CatalogItem`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\RecommendationEngine\V1beta1\CatalogItem;
use Google\Cloud\RecommendationEngine\V1beta1\CatalogItem\CategoryHierarchy;
use Google\Cloud\RecommendationEngine\V1beta1\Client\CatalogServiceClient;
use Google\Cloud\RecommendationEngine\V1beta1\UpdateCatalogItemRequest;

/**
 * @param string $formattedName                                   Full resource name of catalog item, such as
 *                                                                `projects/&#42;/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id`. Please see
 *                                                                {@see CatalogServiceClient::catalogItemPathName()} for help formatting this field.
 * @param string $catalogItemId                                   Catalog item identifier. UTF-8 encoded string with a length limit
 *                                                                of 128 bytes.
 *
 *                                                                This id must be unique among all catalog items within the same catalog. It
 *                                                                should also be used when logging user events in order for the user events
 *                                                                to be joined with the Catalog.
 * @param string $catalogItemCategoryHierarchiesCategoriesElement Catalog item categories. Each category should be a UTF-8
 *                                                                encoded string with a length limit of 2 KiB.
 *
 *                                                                Note that the order in the list denotes the specificity (from least to
 *                                                                most specific).
 * @param string $catalogItemTitle                                Catalog item title. UTF-8 encoded string with a length limit of 1
 *                                                                KiB.
 */
function update_catalog_item_sample(
    string $formattedName,
    string $catalogItemId,
    string $catalogItemCategoryHierarchiesCategoriesElement,
    string $catalogItemTitle
): void {
    // Create a client.
    $catalogServiceClient = new CatalogServiceClient();

    // Prepare the request message.
    $catalogItemCategoryHierarchiesCategories = [$catalogItemCategoryHierarchiesCategoriesElement,];
    $categoryHierarchy = (new CategoryHierarchy())
        ->setCategories($catalogItemCategoryHierarchiesCategories);
    $catalogItemCategoryHierarchies = [$categoryHierarchy,];
    $catalogItem = (new CatalogItem())
        ->setId($catalogItemId)
        ->setCategoryHierarchies($catalogItemCategoryHierarchies)
        ->setTitle($catalogItemTitle);
    $request = (new UpdateCatalogItemRequest())
        ->setName($formattedName)
        ->setCatalogItem($catalogItem);

    // Call the API and handle any network failures.
    try {
        /** @var CatalogItem $response */
        $response = $catalogServiceClient->updateCatalogItem($request);
        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
{
    $formattedName = CatalogServiceClient::catalogItemPathName(
        '[PROJECT]',
        '[LOCATION]',
        '[CATALOG]',
        '[CATALOG_ITEM_PATH]'
    );
    $catalogItemId = '[ID]';
    $catalogItemCategoryHierarchiesCategoriesElement = '[CATEGORIES]';
    $catalogItemTitle = '[TITLE]';

    update_catalog_item_sample(
        $formattedName,
        $catalogItemId,
        $catalogItemCategoryHierarchiesCategoriesElement,
        $catalogItemTitle
    );
}

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::catalogItemPathName

Formats a string containing the fully-qualified path to represent a catalog_item_path resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`catalog`	`string`
`catalogItemPath`	`string`

Returns
Type	Description
`string`	The formatted catalog_item_path 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}
catalogItemPath: projects/{project}/locations/{location}/catalogs/{catalog}/catalogItems/{catalog_item_path}

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.recommendationengine.v1beta1.CatalogService'

The name of the service.

SERVICE_ADDRESS

Value: 'recommendationengine.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.