Reference documentation and code samples for the Google Cloud Retail V2 Client class CatalogServiceClient.
Service Description: Service for managing catalog configuration.
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 {
$formattedAttributesConfig = $catalogServiceClient->attributesConfigName('[PROJECT]', '[LOCATION]', '[CATALOG]');
$catalogAttribute = new CatalogAttribute();
$response = $catalogServiceClient->addCatalogAttribute($formattedAttributesConfig, $catalogAttribute);
} 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.
This service has a new (beta) implementation. See Google\Cloud\Retail\V2\Client\CatalogServiceClient 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. |
addCatalogAttribute
Adds the specified CatalogAttribute to the AttributesConfig.
If the CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.
Parameters | |
---|---|
Name | Description |
attributesConfig |
string
Required. Full AttributesConfig resource name. Format:
|
catalogAttribute |
Google\Cloud\Retail\V2\CatalogAttribute
Required. The CatalogAttribute to add. |
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\Retail\V2\AttributesConfig |
use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\AttributesConfig;
use Google\Cloud\Retail\V2\CatalogAttribute;
use Google\Cloud\Retail\V2\CatalogServiceClient;
/**
* @param string $formattedAttributesConfig Full AttributesConfig resource name. Format:
* `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
* Please see {@see CatalogServiceClient::attributesConfigName()} for help formatting this field.
* @param string $catalogAttributeKey Attribute name.
* For example: `color`, `brands`, `attributes.custom_attribute`, such as
* `attributes.xyz`.
* To be indexable, the attribute name can contain only alpha-numeric
* characters and underscores. For example, an attribute named
* `attributes.abc_xyz` can be indexed, but an attribute named
* `attributes.abc-xyz` cannot be indexed.
*
* If the attribute key starts with `attributes.`, then the attribute is a
* custom attribute. Attributes such as `brands`, `patterns`, and `title` are
* built-in and called system attributes.
*/
function add_catalog_attribute_sample(
string $formattedAttributesConfig,
string $catalogAttributeKey
): void {
// Create a client.
$catalogServiceClient = new CatalogServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$catalogAttribute = (new CatalogAttribute())
->setKey($catalogAttributeKey);
// Call the API and handle any network failures.
try {
/** @var AttributesConfig $response */
$response = $catalogServiceClient->addCatalogAttribute(
$formattedAttributesConfig,
$catalogAttribute
);
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
{
$formattedAttributesConfig = CatalogServiceClient::attributesConfigName(
'[PROJECT]',
'[LOCATION]',
'[CATALOG]'
);
$catalogAttributeKey = '[KEY]';
add_catalog_attribute_sample($formattedAttributesConfig, $catalogAttributeKey);
}
getAttributesConfig
Gets an AttributesConfig.
Parameters | |
---|---|
Name | Description |
name |
string
Required. Full AttributesConfig resource name. Format:
|
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\Retail\V2\AttributesConfig |
use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\AttributesConfig;
use Google\Cloud\Retail\V2\CatalogServiceClient;
/**
* @param string $formattedName Full AttributesConfig resource name. Format:
* `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
* Please see {@see CatalogServiceClient::attributesConfigName()} for help formatting this field.
*/
function get_attributes_config_sample(string $formattedName): void
{
// Create a client.
$catalogServiceClient = new CatalogServiceClient();
// Call the API and handle any network failures.
try {
/** @var AttributesConfig $response */
$response = $catalogServiceClient->getAttributesConfig($formattedName);
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::attributesConfigName('[PROJECT]', '[LOCATION]', '[CATALOG]');
get_attributes_config_sample($formattedName);
}
getCompletionConfig
Gets a CompletionConfig.
Parameters | |
---|---|
Name | Description |
name |
string
Required. Full CompletionConfig resource name. Format:
|
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\Retail\V2\CompletionConfig |
use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\CatalogServiceClient;
use Google\Cloud\Retail\V2\CompletionConfig;
/**
* @param string $formattedName Full CompletionConfig resource name. Format:
* `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig`
* Please see {@see CatalogServiceClient::completionConfigName()} for help formatting this field.
*/
function get_completion_config_sample(string $formattedName): void
{
// Create a client.
$catalogServiceClient = new CatalogServiceClient();
// Call the API and handle any network failures.
try {
/** @var CompletionConfig $response */
$response = $catalogServiceClient->getCompletionConfig($formattedName);
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::completionConfigName('[PROJECT]', '[LOCATION]', '[CATALOG]');
get_completion_config_sample($formattedName);
}
getDefaultBranch
Get which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ catalog |
string
The parent catalog resource name, such as |
↳ 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\GetDefaultBranchResponse |
use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\CatalogServiceClient;
use Google\Cloud\Retail\V2\GetDefaultBranchResponse;
/**
* 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 get_default_branch_sample(): void
{
// Create a client.
$catalogServiceClient = new CatalogServiceClient();
// Call the API and handle any network failures.
try {
/** @var GetDefaultBranchResponse $response */
$response = $catalogServiceClient->getDefaultBranch();
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
listCatalogs
Lists all the Catalogs associated with the project.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The account resource name with an associated location. If the caller does not have permission to list Catalogs under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned. |
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. |
↳ 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\Retail\V2\Catalog;
use Google\Cloud\Retail\V2\CatalogServiceClient;
/**
* @param string $formattedParent The account resource name with an associated location.
*
* If the caller does not have permission to list
* [Catalog][google.cloud.retail.v2.Catalog]s under this location, regardless
* of whether or not this location exists, a PERMISSION_DENIED error is
* returned. Please see
* {@see CatalogServiceClient::locationName()} for help formatting this field.
*/
function list_catalogs_sample(string $formattedParent): void
{
// Create a client.
$catalogServiceClient = new CatalogServiceClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $catalogServiceClient->listCatalogs($formattedParent);
/** @var Catalog $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::locationName('[PROJECT]', '[LOCATION]');
list_catalogs_sample($formattedParent);
}
removeCatalogAttribute
Removes the specified CatalogAttribute from the AttributesConfig.
If the CatalogAttribute to remove does not exist, a NOT_FOUND error is returned.
Parameters | |
---|---|
Name | Description |
attributesConfig |
string
Required. Full AttributesConfig resource name. Format:
|
key |
string
Required. The attribute name key of the CatalogAttribute to remove. |
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\Retail\V2\AttributesConfig |
use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\AttributesConfig;
use Google\Cloud\Retail\V2\CatalogServiceClient;
/**
* @param string $formattedAttributesConfig Full AttributesConfig resource name. Format:
* `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
* Please see {@see CatalogServiceClient::attributesConfigName()} for help formatting this field.
* @param string $key The attribute name key of the
* [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to remove.
*/
function remove_catalog_attribute_sample(string $formattedAttributesConfig, string $key): void
{
// Create a client.
$catalogServiceClient = new CatalogServiceClient();
// Call the API and handle any network failures.
try {
/** @var AttributesConfig $response */
$response = $catalogServiceClient->removeCatalogAttribute($formattedAttributesConfig, $key);
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
{
$formattedAttributesConfig = CatalogServiceClient::attributesConfigName(
'[PROJECT]',
'[LOCATION]',
'[CATALOG]'
);
$key = '[KEY]';
remove_catalog_attribute_sample($formattedAttributesConfig, $key);
}
replaceCatalogAttribute
Replaces the specified CatalogAttribute in the AttributesConfig by updating the catalog attribute with the same CatalogAttribute.key.
If the CatalogAttribute to replace does not exist, a NOT_FOUND error is returned.
Parameters | |
---|---|
Name | Description |
attributesConfig |
string
Required. Full AttributesConfig resource name. Format:
|
catalogAttribute |
Google\Cloud\Retail\V2\CatalogAttribute
Required. The updated CatalogAttribute. |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
Indicates which fields in the provided CatalogAttribute to update. The following are NOT supported: * CatalogAttribute.key If not set, all supported fields are updated. |
↳ 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\AttributesConfig |
use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\AttributesConfig;
use Google\Cloud\Retail\V2\CatalogAttribute;
use Google\Cloud\Retail\V2\CatalogServiceClient;
/**
* @param string $formattedAttributesConfig Full AttributesConfig resource name. Format:
* `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
* Please see {@see CatalogServiceClient::attributesConfigName()} for help formatting this field.
* @param string $catalogAttributeKey Attribute name.
* For example: `color`, `brands`, `attributes.custom_attribute`, such as
* `attributes.xyz`.
* To be indexable, the attribute name can contain only alpha-numeric
* characters and underscores. For example, an attribute named
* `attributes.abc_xyz` can be indexed, but an attribute named
* `attributes.abc-xyz` cannot be indexed.
*
* If the attribute key starts with `attributes.`, then the attribute is a
* custom attribute. Attributes such as `brands`, `patterns`, and `title` are
* built-in and called system attributes.
*/
function replace_catalog_attribute_sample(
string $formattedAttributesConfig,
string $catalogAttributeKey
): void {
// Create a client.
$catalogServiceClient = new CatalogServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$catalogAttribute = (new CatalogAttribute())
->setKey($catalogAttributeKey);
// Call the API and handle any network failures.
try {
/** @var AttributesConfig $response */
$response = $catalogServiceClient->replaceCatalogAttribute(
$formattedAttributesConfig,
$catalogAttribute
);
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
{
$formattedAttributesConfig = CatalogServiceClient::attributesConfigName(
'[PROJECT]',
'[LOCATION]',
'[CATALOG]'
);
$catalogAttributeKey = '[KEY]';
replace_catalog_attribute_sample($formattedAttributesConfig, $catalogAttributeKey);
}
setDefaultBranch
Set a specified branch id as default branch. API methods such as SearchService.Search, ProductService.GetProduct, ProductService.ListProducts will treat requests using "default_branch" to the actual branch id set as default.
For example, if projects/*/locations/*/catalogs/*/branches/1
is set as
default, setting
SearchRequest.branch to
projects/*/locations/*/catalogs/*/branches/default_branch
is equivalent
to setting
SearchRequest.branch to
projects/*/locations/*/catalogs/*/branches/1
.
Using multiple branches can be useful when developers would like
to have a staging branch to test and verify for future usage. When it
becomes ready, developers switch on the staging branch using this API while
keeping using projects/*/locations/*/catalogs/*/branches/default_branch
as SearchRequest.branch to
route the traffic to this staging branch.
CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one.
More specifically:
- PredictionService will only return product IDs from branch {newBranch}.
- SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set).
- UserEventService will only join events with products from branch {newBranch}.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ catalog |
string
Full resource name of the catalog, such as |
↳ branchId |
string
The final component of the resource name of a branch. This field must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT error is returned. If there are no sufficient active products in the targeted branch and force is not set, a FAILED_PRECONDITION error is returned. |
↳ note |
string
Some note on this request, this can be retrieved by CatalogService.GetDefaultBranch before next valid default branch set occurs. This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
↳ force |
bool
If set to true, it permits switching to a branch with branch_id even if it has no sufficient active products. |
↳ 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. |
use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\CatalogServiceClient;
/**
* 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 set_default_branch_sample(): void
{
// Create a client.
$catalogServiceClient = new CatalogServiceClient();
// Call the API and handle any network failures.
try {
$catalogServiceClient->setDefaultBranch();
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateAttributesConfig
Updates the AttributesConfig.
The catalog attributes in the request will be updated in the catalog, or inserted if they do not exist. Existing catalog attributes not included in the request will remain unchanged. Attributes that are assigned to products, but do not exist at the catalog level, are always included in the response. The product attribute is assigned default values for missing catalog attribute fields, e.g., searchable and dynamic facetable options.
Parameters | |
---|---|
Name | Description |
attributesConfig |
Google\Cloud\Retail\V2\AttributesConfig
Required. The AttributesConfig to update. |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated. |
↳ 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\AttributesConfig |
use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\AttributesConfig;
use Google\Cloud\Retail\V2\CatalogServiceClient;
/**
* @param string $attributesConfigName Immutable. The fully qualified resource name of the attribute
* config. Format: `projects/*/locations/*/catalogs/*/attributesConfig`
*/
function update_attributes_config_sample(string $attributesConfigName): void
{
// Create a client.
$catalogServiceClient = new CatalogServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$attributesConfig = (new AttributesConfig())
->setName($attributesConfigName);
// Call the API and handle any network failures.
try {
/** @var AttributesConfig $response */
$response = $catalogServiceClient->updateAttributesConfig($attributesConfig);
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
{
$attributesConfigName = '[NAME]';
update_attributes_config_sample($attributesConfigName);
}
updateCatalog
Updates the Catalogs.
Parameters | |
---|---|
Name | Description |
catalog |
Google\Cloud\Retail\V2\Catalog
Required. The Catalog to update. If the caller does not have permission to update the Catalog, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Catalog to update does not exist, a NOT_FOUND error is returned. |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is 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\Cloud\Retail\V2\Catalog |
use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\Catalog;
use Google\Cloud\Retail\V2\CatalogServiceClient;
use Google\Cloud\Retail\V2\ProductLevelConfig;
/**
* @param string $catalogName Immutable. The fully qualified resource name of the catalog.
* @param string $catalogDisplayName Immutable. The catalog display name.
*
* This field must be a UTF-8 encoded string with a length limit of 128
* characters. Otherwise, an INVALID_ARGUMENT error is returned.
*/
function update_catalog_sample(string $catalogName, string $catalogDisplayName): void
{
// Create a client.
$catalogServiceClient = new CatalogServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$catalogProductLevelConfig = new ProductLevelConfig();
$catalog = (new Catalog())
->setName($catalogName)
->setDisplayName($catalogDisplayName)
->setProductLevelConfig($catalogProductLevelConfig);
// Call the API and handle any network failures.
try {
/** @var Catalog $response */
$response = $catalogServiceClient->updateCatalog($catalog);
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
{
$catalogName = '[NAME]';
$catalogDisplayName = '[DISPLAY_NAME]';
update_catalog_sample($catalogName, $catalogDisplayName);
}
updateCompletionConfig
Updates the CompletionConfigs.
Parameters | |
---|---|
Name | Description |
completionConfig |
Google\Cloud\Retail\V2\CompletionConfig
Required. The CompletionConfig to update. If the caller does not have permission to update the CompletionConfig, then a PERMISSION_DENIED error is returned. If the CompletionConfig to update does not exist, a NOT_FOUND error is returned. |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated. |
↳ 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\CompletionConfig |
use Google\ApiCore\ApiException;
use Google\Cloud\Retail\V2\CatalogServiceClient;
use Google\Cloud\Retail\V2\CompletionConfig;
/**
* @param string $completionConfigName Immutable. Fully qualified name
* `projects/*/locations/*/catalogs/*/completionConfig`
*/
function update_completion_config_sample(string $completionConfigName): void
{
// Create a client.
$catalogServiceClient = new CatalogServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$completionConfig = (new CompletionConfig())
->setName($completionConfigName);
// Call the API and handle any network failures.
try {
/** @var CompletionConfig $response */
$response = $catalogServiceClient->updateCompletionConfig($completionConfig);
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
{
$completionConfigName = '[NAME]';
update_completion_config_sample($completionConfigName);
}
static::attributesConfigName
Formats a string containing the fully-qualified path to represent a attributes_config resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
catalog |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted attributes_config resource. |
static::branchName
Formats a string containing the fully-qualified path to represent a branch resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
catalog |
string
|
branch |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted branch resource. |
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::completionConfigName
Formats a string containing the fully-qualified path to represent a completion_config resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
catalog |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted completion_config resource. |
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted location 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
- attributesConfig: projects/{project}/locations/{location}/catalogs/{catalog}/attributesConfig
- branch: projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}
- catalog: projects/{project}/locations/{location}/catalogs/{catalog}
- completionConfig: projects/{project}/locations/{location}/catalogs/{catalog}/completionConfig
- location: projects/{project}/locations/{location}
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.CatalogService'
The name of the service.
SERVICE_ADDRESS
Value: 'retail.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.