Google Shopping Merchant Inventories V1beta Client - Class LocalInventoryServiceClient (0.5.0)

Namespace

Methods

__construct

deleteLocalInventory

use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Inventories\V1beta\Client\LocalInventoryServiceClient;
use Google\Shopping\Merchant\Inventories\V1beta\DeleteLocalInventoryRequest;

/**
 * @param string $formattedName The name of the local inventory for the given product to delete.
 *                              Format:
 *                              `accounts/{account}/products/{product}/localInventories/{store_code}`
 *                              Please see {@see LocalInventoryServiceClient::localInventoryName()} for help formatting this field.
 */
function delete_local_inventory_sample(string $formattedName): void
{
    // Create a client.
    $localInventoryServiceClient = new LocalInventoryServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $localInventoryServiceClient->deleteLocalInventory($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 = LocalInventoryServiceClient::localInventoryName(
        '[ACCOUNT]',
        '[PRODUCT]',
        '[STORE_CODE]'
    );

    delete_local_inventory_sample($formattedName);
}

insertLocalInventory

use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Inventories\V1beta\Client\LocalInventoryServiceClient;
use Google\Shopping\Merchant\Inventories\V1beta\InsertLocalInventoryRequest;
use Google\Shopping\Merchant\Inventories\V1beta\LocalInventory;

/**
 * @param string $formattedParent         The account and product where this inventory will be inserted.
 *                                        Format: `accounts/{account}/products/{product}`
 *                                        Please see {@see LocalInventoryServiceClient::productName()} for help formatting this field.
 * @param string $localInventoryStoreCode Immutable. Store code (the store ID from your Business Profile)
 *                                        of the physical store the product is sold in. See the [Local product
 *                                        inventory data
 *                                        specification](https://support.google.com/merchants/answer/3061342) for
 *                                        more information.
 */
function insert_local_inventory_sample(
    string $formattedParent,
    string $localInventoryStoreCode
): void {
    // Create a client.
    $localInventoryServiceClient = new LocalInventoryServiceClient();

    // Prepare the request message.
    $localInventory = (new LocalInventory())
        ->setStoreCode($localInventoryStoreCode);
    $request = (new InsertLocalInventoryRequest())
        ->setParent($formattedParent)
        ->setLocalInventory($localInventory);

    // Call the API and handle any network failures.
    try {
        /** @var LocalInventory $response */
        $response = $localInventoryServiceClient->insertLocalInventory($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 = LocalInventoryServiceClient::productName('[ACCOUNT]', '[PRODUCT]');
    $localInventoryStoreCode = '[STORE_CODE]';

    insert_local_inventory_sample($formattedParent, $localInventoryStoreCode);
}

listLocalInventories

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Shopping\Merchant\Inventories\V1beta\Client\LocalInventoryServiceClient;
use Google\Shopping\Merchant\Inventories\V1beta\ListLocalInventoriesRequest;
use Google\Shopping\Merchant\Inventories\V1beta\LocalInventory;

/**
 * @param string $formattedParent The `name` of the parent product to list local inventories for.
 *                                Format:
 *                                `accounts/{account}/products/{product}`
 *                                Please see {@see LocalInventoryServiceClient::productName()} for help formatting this field.
 */
function list_local_inventories_sample(string $formattedParent): void
{
    // Create a client.
    $localInventoryServiceClient = new LocalInventoryServiceClient();

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

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

        /** @var LocalInventory $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 = LocalInventoryServiceClient::productName('[ACCOUNT]', '[PRODUCT]');

    list_local_inventories_sample($formattedParent);
}

deleteLocalInventoryAsync

insertLocalInventoryAsync

listLocalInventoriesAsync

static::localInventoryName

static::productName

static::parseName