# Google Shopping Merchant Accounts V1beta Client - Class RegionsServiceClient (1.4.1)

1.4.1 (latest) 1.4.0 1.3.1 1.2.2 1.1.0 1.0.0 0.10.0 0.9.1 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.3 0.2.0 0.1.0

> [!WARNING]
> **Beta**
>
>
> This library is covered by the [Pre-GA Offerings Terms](https://docs.cloud.google.com/terms/service-terms#1)
> of the Terms of Service. Pre-GA libraries might have limited support,
> and changes to pre-GA libraries might not be compatible with other pre-GA versions.
> For more information, see the
> [launch stage descriptions](https://docs.cloud.google.com/products#product-launch-stages).

Reference documentation and code samples for the Google Shopping Merchant Accounts V1beta Client class RegionsServiceClient.

Service Description: Manages regions configuration.

This API defines the following resource model:

- Region

This class provides the ability to make remote calls to the backing service through method
calls that map to API methods.

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 \\ Accounts \\ V1beta \\ Client

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `options` | `array|https://docs.cloud.google.com/php/docs/reference/gax/latest/Options.ClientOptions.html` 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` | `https://docs.cloud.google.com/php/docs/reference/auth/latest/FetchAuthTokenInterface.html|https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html` This option should only be used with a pre-constructed [Google\\Auth\\FetchAuthTokenInterface](https://docs.cloud.google.com/php/docs/reference/auth/latest/FetchAuthTokenInterface.html) or [Google\\ApiCore\\CredentialsWrapper](https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html) object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. **Important** : If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly `use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Shopping\Merchant\Accounts\V1beta\RegionsServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new RegionsServiceClient(['credentials' => $creds]);` <https://cloud.google.com/docs/authentication/external/externally-sourced-credentials> |
| `↳ 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()](https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html#_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|https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.TransportInterface.html` 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](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.TransportInterface.html) 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()](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.GrpcTransport.html#_Google_ApiCore_Transport_GrpcTransport__build__) and [Google\\ApiCore\\Transport\\RestTransport::build()](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.RestTransport.html#_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. |
| `↳ logger` | `false|Psr\Log\LoggerInterface` A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
| `↳ universeDomain` | `string` The service domain for the client. Defaults to 'googleapis.com'. |

### createRegion

Creates a region definition in your Merchant Center account. Executing this
method requires admin access.

The async variant is [RegionsServiceClient::createRegionAsync()](https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1beta.Client.RegionsServiceClient#_Google_Shopping_Merchant_Accounts_V1beta_Client_RegionsServiceClient__createRegionAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1beta.CreateRegionRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1beta.Region` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Shopping\Merchant\Accounts\V1beta\Client\RegionsServiceClient;
    use Google\Shopping\Merchant\Accounts\V1beta\CreateRegionRequest;
    use Google\Shopping\Merchant\Accounts\V1beta\Region;

    /**
     * @param string $formattedParent The account to create a region for.
     *                                Format: `accounts/{account}`
     *                                Please see {@see RegionsServiceClient::accountName()} for help formatting this field.
     * @param string $regionId        The identifier for the region, unique over all regions of the
     *                                same account.
     */
    function create_region_sample(string $formattedParent, string $regionId): void
    {
        // Create a client.
        $regionsServiceClient = new RegionsServiceClient();

        // Prepare the request message.
        $region = new Region();
        $request = (new CreateRegionRequest())
            ->setParent($formattedParent)
            ->setRegionId($regionId)
            ->setRegion($region);

        // Call the API and handle any network failures.
        try {
            /** @var Region $response */
            $response = $regionsServiceClient->createRegion($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 = RegionsServiceClient::accountName('[ACCOUNT]');
        $regionId = '[REGION_ID]';

        create_region_sample($formattedParent, $regionId);
    }

### deleteRegion

Deletes a region definition from your Merchant Center account. Executing
this method requires admin access.

The async variant is [RegionsServiceClient::deleteRegionAsync()](https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1beta.Client.RegionsServiceClient#_Google_Shopping_Merchant_Accounts_V1beta_Client_RegionsServiceClient__deleteRegionAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1beta.DeleteRegionRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Shopping\Merchant\Accounts\V1beta\Client\RegionsServiceClient;
    use Google\Shopping\Merchant\Accounts\V1beta\DeleteRegionRequest;

    /**
     * @param string $formattedName The name of the region to delete.
     *                              Format: `accounts/{account}/regions/{region}`
     *                              Please see {@see RegionsServiceClient::regionName()} for help formatting this field.
     */
    function delete_region_sample(string $formattedName): void
    {
        // Create a client.
        $regionsServiceClient = new RegionsServiceClient();

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

        // Call the API and handle any network failures.
        try {
            $regionsServiceClient->deleteRegion($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 = RegionsServiceClient::regionName('[ACCOUNT]', '[REGION]');

        delete_region_sample($formattedName);
    }

### getRegion

Retrieves a region defined in your Merchant Center account.

The async variant is [RegionsServiceClient::getRegionAsync()](https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1beta.Client.RegionsServiceClient#_Google_Shopping_Merchant_Accounts_V1beta_Client_RegionsServiceClient__getRegionAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1beta.GetRegionRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1beta.Region` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Shopping\Merchant\Accounts\V1beta\Client\RegionsServiceClient;
    use Google\Shopping\Merchant\Accounts\V1beta\GetRegionRequest;
    use Google\Shopping\Merchant\Accounts\V1beta\Region;

    /**
     * @param string $formattedName The name of the region to retrieve.
     *                              Format: `accounts/{account}/regions/{region}`
     *                              Please see {@see RegionsServiceClient::regionName()} for help formatting this field.
     */
    function get_region_sample(string $formattedName): void
    {
        // Create a client.
        $regionsServiceClient = new RegionsServiceClient();

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

        // Call the API and handle any network failures.
        try {
            /** @var Region $response */
            $response = $regionsServiceClient->getRegion($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 = RegionsServiceClient::regionName('[ACCOUNT]', '[REGION]');

        get_region_sample($formattedName);
    }

### listRegions

Lists the regions in your Merchant Center account.

The async variant is [RegionsServiceClient::listRegionsAsync()](https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1beta.Client.RegionsServiceClient#_Google_Shopping_Merchant_Accounts_V1beta_Client_RegionsServiceClient__listRegionsAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1beta.ListRegionsRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\PagedListResponse;
    use Google\Shopping\Merchant\Accounts\V1beta\Client\RegionsServiceClient;
    use Google\Shopping\Merchant\Accounts\V1beta\ListRegionsRequest;
    use Google\Shopping\Merchant\Accounts\V1beta\Region;

    /**
     * @param string $formattedParent The account to list regions for.
     *                                Format: `accounts/{account}`
     *                                Please see {@see RegionsServiceClient::accountName()} for help formatting this field.
     */
    function list_regions_sample(string $formattedParent): void
    {
        // Create a client.
        $regionsServiceClient = new RegionsServiceClient();

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

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

            /** @var Region $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 = RegionsServiceClient::accountName('[ACCOUNT]');

        list_regions_sample($formattedParent);
    }

### updateRegion

Updates a region definition in your Merchant Center account. Executing this
method requires admin access.

The async variant is [RegionsServiceClient::updateRegionAsync()](https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1beta.Client.RegionsServiceClient#_Google_Shopping_Merchant_Accounts_V1beta_Client_RegionsServiceClient__updateRegionAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1beta.UpdateRegionRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1beta.Region` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Shopping\Merchant\Accounts\V1beta\Client\RegionsServiceClient;
    use Google\Shopping\Merchant\Accounts\V1beta\Region;
    use Google\Shopping\Merchant\Accounts\V1beta\UpdateRegionRequest;

    /**
     * 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 update_region_sample(): void
    {
        // Create a client.
        $regionsServiceClient = new RegionsServiceClient();

        // Prepare the request message.
        $region = new Region();
        $request = (new UpdateRegionRequest())
            ->setRegion($region);

        // Call the API and handle any network failures.
        try {
            /** @var Region $response */
            $response = $regionsServiceClient->updateRegion($request);
            printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

### createRegionAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1beta.CreateRegionRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1beta.Region>` |   |

### deleteRegionAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1beta.DeleteRegionRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<void>` |   |

### getRegionAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1beta.GetRegionRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1beta.Region>` |   |

### listRegionsAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1beta.ListRegionsRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html>` |   |

### updateRegionAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1beta.UpdateRegionRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1beta.Region>` |   |

### static::accountName

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `account` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted account resource. |

### static::regionName

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `account` | `string` |
| `region` | `string` |

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

- account: accounts/{account}
- region: accounts/{account}/regions/{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. |