Google Shopping Merchant Inventories V1beta Client - Class RegionalInventoryServiceClient (0.3.0)

Reference documentation and code samples for the Google Shopping Merchant Inventories V1beta Client class RegionalInventoryServiceClient.

Service Description: Service to manage regional inventory for products. There is also separate regions resource and API to manage regions definitions.

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:

$regionalInventoryServiceClient = new RegionalInventoryServiceClient();
try {
    $formattedName = $regionalInventoryServiceClient->regionalInventoryName('[ACCOUNT]', '[PRODUCT]', '[REGION]');
    $regionalInventoryServiceClient->deleteRegionalInventory($formattedName);
} finally {
    $regionalInventoryServiceClient->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 \ Shopping \ Merchant \ Inventories \ V1beta

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.

deleteRegionalInventory

Deletes the specified RegionalInventory resource from the given product in your merchant account. It might take up to an hour for the RegionalInventory to be deleted from the specific product.

Once you have received a successful delete response, wait for that period before attempting a delete again.

Parameters
Name	Description
`name`	`string` Required. The name of the `RegionalInventory` resource to delete. Format: `accounts/{account}/products/{product}/regionalInventories/{region}`
`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\Shopping\Merchant\Inventories\V1beta\Client\RegionalInventoryServiceClient;
use Google\Shopping\Merchant\Inventories\V1beta\DeleteRegionalInventoryRequest;

/**
 * @param string $formattedName The name of the `RegionalInventory` resource to delete.
 *                              Format:
 *                              `accounts/{account}/products/{product}/regionalInventories/{region}`
 *                              Please see {@see RegionalInventoryServiceClient::regionalInventoryName()} for help formatting this field.
 */
function delete_regional_inventory_sample(string $formattedName): void
{
    // Create a client.
    $regionalInventoryServiceClient = new RegionalInventoryServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $regionalInventoryServiceClient->deleteRegionalInventory($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 = RegionalInventoryServiceClient::regionalInventoryName(
        '[ACCOUNT]',
        '[PRODUCT]',
        '[REGION]'
    );

    delete_regional_inventory_sample($formattedName);
}

insertRegionalInventory

Inserts a RegionalInventory to a given product in your merchant account.

Replaces the full RegionalInventory resource if an entry with the same region already exists for the product.

It might take up to 30 minutes for the new or updated RegionalInventory resource to appear in products.

Parameters
Name	Description
`parent`	`string` Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}`
`regionalInventory`	`Google\Shopping\Merchant\Inventories\V1beta\RegionalInventory` Required. Regional inventory information to add to the product. If the product already has a `RegionalInventory` resource for the same `region`, full replacement of the `RegionalInventory` resource is performed.
`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\Shopping\Merchant\Inventories\V1beta\RegionalInventory`

Example

use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Inventories\V1beta\Client\RegionalInventoryServiceClient;
use Google\Shopping\Merchant\Inventories\V1beta\InsertRegionalInventoryRequest;
use Google\Shopping\Merchant\Inventories\V1beta\RegionalInventory;

/**
 * @param string $parent                  The account and product where this inventory will be inserted.
 *                                        Format: `accounts/{account}/products/{product}`
 * @param string $regionalInventoryRegion ID of the region for this
 *                                        `RegionalInventory` resource. See the [Regional availability and
 *                                        pricing](https://support.google.com/merchants/answer/9698880) for more
 *                                        details.
 */
function insert_regional_inventory_sample(string $parent, string $regionalInventoryRegion): void
{
    // Create a client.
    $regionalInventoryServiceClient = new RegionalInventoryServiceClient();

    // Prepare the request message.
    $regionalInventory = (new RegionalInventory())
        ->setRegion($regionalInventoryRegion);
    $request = (new InsertRegionalInventoryRequest())
        ->setParent($parent)
        ->setRegionalInventory($regionalInventory);

    // Call the API and handle any network failures.
    try {
        /** @var RegionalInventory $response */
        $response = $regionalInventoryServiceClient->insertRegionalInventory($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
{
    $parent = '[PARENT]';
    $regionalInventoryRegion = '[REGION]';

    insert_regional_inventory_sample($parent, $regionalInventoryRegion);
}

listRegionalInventories

Lists the RegionalInventory resources for the given product in your merchant account. The response might contain fewer items than specified by pageSize. If pageToken was returned in previous request, it can be used to obtain additional results.

RegionalInventory resources are listed per product for a given account.

Parameters
Name	Description
`parent`	`string` Required. The `name` of the parent product to list `RegionalInventory` resources for. Format: `accounts/{account}/products/{product}`
`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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Shopping\Merchant\Inventories\V1beta\Client\RegionalInventoryServiceClient;
use Google\Shopping\Merchant\Inventories\V1beta\ListRegionalInventoriesRequest;
use Google\Shopping\Merchant\Inventories\V1beta\RegionalInventory;

/**
 * @param string $parent The `name` of the parent product to list `RegionalInventory`
 *                       resources for. Format: `accounts/{account}/products/{product}`
 */
function list_regional_inventories_sample(string $parent): void
{
    // Create a client.
    $regionalInventoryServiceClient = new RegionalInventoryServiceClient();

    // Prepare the request message.
    $request = (new ListRegionalInventoriesRequest())
        ->setParent($parent);

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

        /** @var RegionalInventory $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
{
    $parent = '[PARENT]';

    list_regional_inventories_sample($parent);
}

static::regionalInventoryName

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

Parameters
Name	Description
`account`	`string`
`product`	`string`
`region`	`string`

Returns
Type	Description
`string`	The formatted regional_inventory 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

regionalInventory: accounts/{account}/products/{product}/regionalInventories/{region}

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.shopping.merchant.inventories.v1beta.RegionalInventoryService'

The name of the service.

SERVICE_ADDRESS

Value: 'merchantapi.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.