Google Shopping Merchant Accounts V1beta Client - Class RegionsServiceClient (0.2.0)

Namespace

Methods

__construct

createRegion

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

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

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

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

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

deleteRegionAsync

getRegionAsync

listRegionsAsync

updateRegionAsync

static::accountName

static::regionName

static::parseName