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

Reference documentation and code samples for the Google Shopping Merchant Lfp V1beta Client class LfpSaleServiceClient.

Service Description: Service for a LFP partner to submit sales data for a merchant.

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

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.

insertLfpSale

Inserts a LfpSale for the given merchant.

The async variant is Google\Shopping\Merchant\Lfp\V1beta\Client\LfpSaleServiceClient::insertLfpSaleAsync() .

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\Lfp\V1beta\InsertLfpSaleRequest` A request to house fields associated with the call.
`callOptions`	`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\Lfp\V1beta\LfpSale`

Example

use Google\ApiCore\ApiException;
use Google\Protobuf\Timestamp;
use Google\Shopping\Merchant\Lfp\V1beta\Client\LfpSaleServiceClient;
use Google\Shopping\Merchant\Lfp\V1beta\InsertLfpSaleRequest;
use Google\Shopping\Merchant\Lfp\V1beta\LfpSale;
use Google\Shopping\Type\Price;

/**
 * @param string $parent                 The LFP provider account.
 *                                       Format: `accounts/{lfp_partner}`
 * @param int    $lfpSaleTargetAccount   The Merchant Center ID of the merchant to submit the sale for.
 * @param string $lfpSaleStoreCode       The identifier of the merchant's store. Either a `storeCode`
 *                                       inserted through the API or the code of the store in the Business Profile.
 * @param string $lfpSaleOfferId         A unique identifier for the product. If both inventories and
 *                                       sales are submitted for a merchant, this id should match for the same
 *                                       product.
 *
 *                                       **Note**: if the merchant sells the same product new and used, they should
 *                                       have different IDs.
 * @param string $lfpSaleRegionCode      The [CLDR territory
 *                                       code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml)
 *                                       for the country where the product is sold.
 * @param string $lfpSaleContentLanguage The two-letter ISO 639-1 language code for the item.
 * @param string $lfpSaleGtin            The Global Trade Item Number of the sold product.
 * @param int    $lfpSaleQuantity        The relative change of the available quantity. Negative for items
 *                                       returned.
 */
function insert_lfp_sale_sample(
    string $parent,
    int $lfpSaleTargetAccount,
    string $lfpSaleStoreCode,
    string $lfpSaleOfferId,
    string $lfpSaleRegionCode,
    string $lfpSaleContentLanguage,
    string $lfpSaleGtin,
    int $lfpSaleQuantity
): void {
    // Create a client.
    $lfpSaleServiceClient = new LfpSaleServiceClient();

    // Prepare the request message.
    $lfpSalePrice = new Price();
    $lfpSaleSaleTime = new Timestamp();
    $lfpSale = (new LfpSale())
        ->setTargetAccount($lfpSaleTargetAccount)
        ->setStoreCode($lfpSaleStoreCode)
        ->setOfferId($lfpSaleOfferId)
        ->setRegionCode($lfpSaleRegionCode)
        ->setContentLanguage($lfpSaleContentLanguage)
        ->setGtin($lfpSaleGtin)
        ->setPrice($lfpSalePrice)
        ->setQuantity($lfpSaleQuantity)
        ->setSaleTime($lfpSaleSaleTime);
    $request = (new InsertLfpSaleRequest())
        ->setParent($parent)
        ->setLfpSale($lfpSale);

    // Call the API and handle any network failures.
    try {
        /** @var LfpSale $response */
        $response = $lfpSaleServiceClient->insertLfpSale($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]';
    $lfpSaleTargetAccount = 0;
    $lfpSaleStoreCode = '[STORE_CODE]';
    $lfpSaleOfferId = '[OFFER_ID]';
    $lfpSaleRegionCode = '[REGION_CODE]';
    $lfpSaleContentLanguage = '[CONTENT_LANGUAGE]';
    $lfpSaleGtin = '[GTIN]';
    $lfpSaleQuantity = 0;

    insert_lfp_sale_sample(
        $parent,
        $lfpSaleTargetAccount,
        $lfpSaleStoreCode,
        $lfpSaleOfferId,
        $lfpSaleRegionCode,
        $lfpSaleContentLanguage,
        $lfpSaleGtin,
        $lfpSaleQuantity
    );
}

insertLfpSaleAsync

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\Lfp\V1beta\InsertLfpSaleRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

static::lfpSaleName

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

Parameters
Name	Description
`account`	`string`
`sale`	`string`

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

lfpSale: accounts/{account}/lfpSales/{sale}

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.