Google Shopping Merchant Lfp V1beta Client - Class LfpStoreServiceClient (0.1.0)

Namespace

Methods

__construct

deleteLfpStore

use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Lfp\V1beta\Client\LfpStoreServiceClient;
use Google\Shopping\Merchant\Lfp\V1beta\DeleteLfpStoreRequest;

/**
 * @param string $formattedName The name of the store to delete for the target merchant account.
 *                              Format: `accounts/{account}/lfpStores/{target_merchant}~{store_code}`
 *                              Please see {@see LfpStoreServiceClient::lfpStoreName()} for help formatting this field.
 */
function delete_lfp_store_sample(string $formattedName): void
{
    // Create a client.
    $lfpStoreServiceClient = new LfpStoreServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $lfpStoreServiceClient->deleteLfpStore($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 = LfpStoreServiceClient::lfpStoreName(
        '[ACCOUNT]',
        '[TARGET_MERCHANT]',
        '[STORE_CODE]'
    );

    delete_lfp_store_sample($formattedName);
}

getLfpStore

use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Lfp\V1beta\Client\LfpStoreServiceClient;
use Google\Shopping\Merchant\Lfp\V1beta\GetLfpStoreRequest;
use Google\Shopping\Merchant\Lfp\V1beta\LfpStore;

/**
 * @param string $formattedName The name of the store to retrieve.
 *                              Format: `accounts/{account}/lfpStores/{target_merchant}~{store_code}`
 *                              Please see {@see LfpStoreServiceClient::lfpStoreName()} for help formatting this field.
 */
function get_lfp_store_sample(string $formattedName): void
{
    // Create a client.
    $lfpStoreServiceClient = new LfpStoreServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var LfpStore $response */
        $response = $lfpStoreServiceClient->getLfpStore($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 = LfpStoreServiceClient::lfpStoreName(
        '[ACCOUNT]',
        '[TARGET_MERCHANT]',
        '[STORE_CODE]'
    );

    get_lfp_store_sample($formattedName);
}

insertLfpStore

use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Lfp\V1beta\Client\LfpStoreServiceClient;
use Google\Shopping\Merchant\Lfp\V1beta\InsertLfpStoreRequest;
use Google\Shopping\Merchant\Lfp\V1beta\LfpStore;

/**
 * @param string $formattedParent       The LFP provider account
 *                                      Format: `accounts/{account}`
 *                                      Please see {@see LfpStoreServiceClient::accountName()} for help formatting this field.
 * @param int    $lfpStoreTargetAccount The Merchant Center id of the merchant to submit the store for.
 * @param string $lfpStoreStoreCode     Immutable. A store identifier that is unique for the target
 *                                      merchant.
 * @param string $lfpStoreStoreAddress  The street address of the store.
 *                                      Example: 1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA.
 */
function insert_lfp_store_sample(
    string $formattedParent,
    int $lfpStoreTargetAccount,
    string $lfpStoreStoreCode,
    string $lfpStoreStoreAddress
): void {
    // Create a client.
    $lfpStoreServiceClient = new LfpStoreServiceClient();

    // Prepare the request message.
    $lfpStore = (new LfpStore())
        ->setTargetAccount($lfpStoreTargetAccount)
        ->setStoreCode($lfpStoreStoreCode)
        ->setStoreAddress($lfpStoreStoreAddress);
    $request = (new InsertLfpStoreRequest())
        ->setParent($formattedParent)
        ->setLfpStore($lfpStore);

    // Call the API and handle any network failures.
    try {
        /** @var LfpStore $response */
        $response = $lfpStoreServiceClient->insertLfpStore($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 = LfpStoreServiceClient::accountName('[ACCOUNT]');
    $lfpStoreTargetAccount = 0;
    $lfpStoreStoreCode = '[STORE_CODE]';
    $lfpStoreStoreAddress = '[STORE_ADDRESS]';

    insert_lfp_store_sample(
        $formattedParent,
        $lfpStoreTargetAccount,
        $lfpStoreStoreCode,
        $lfpStoreStoreAddress
    );
}

listLfpStores

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Shopping\Merchant\Lfp\V1beta\Client\LfpStoreServiceClient;
use Google\Shopping\Merchant\Lfp\V1beta\LfpStore;
use Google\Shopping\Merchant\Lfp\V1beta\ListLfpStoresRequest;

/**
 * @param string $formattedParent The LFP partner.
 *                                Format: `accounts/{account}`
 *                                Please see {@see LfpStoreServiceClient::accountName()} for help formatting this field.
 * @param int    $targetAccount   The Merchant Center id of the merchant to list stores for.
 */
function list_lfp_stores_sample(string $formattedParent, int $targetAccount): void
{
    // Create a client.
    $lfpStoreServiceClient = new LfpStoreServiceClient();

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

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

        /** @var LfpStore $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 = LfpStoreServiceClient::accountName('[ACCOUNT]');
    $targetAccount = 0;

    list_lfp_stores_sample($formattedParent, $targetAccount);
}

deleteLfpStoreAsync

getLfpStoreAsync

insertLfpStoreAsync

listLfpStoresAsync

static::accountName

static::lfpStoreName

static::parseName