Google Shopping Merchant Promotions V1beta Client - Class PromotionsServiceClient (0.1.1)

Reference documentation and code samples for the Google Shopping Merchant Promotions V1beta Client class PromotionsServiceClient.

Service Description: Service to manage promotions for products.

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 \ Promotions \ 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.

getPromotion

Retrieves the promotion from your Merchant Center account.

After inserting or updating a promotion input, it may take several minutes before the updated promotion can be retrieved.

The async variant is PromotionsServiceClient::getPromotionAsync() .

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\Promotions\V1beta\GetPromotionRequest` 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\Promotions\V1beta\Promotion`

Example

use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Promotions\V1beta\Client\PromotionsServiceClient;
use Google\Shopping\Merchant\Promotions\V1beta\GetPromotionRequest;
use Google\Shopping\Merchant\Promotions\V1beta\Promotion;

/**
 * @param string $formattedName The name of the promotion to retrieve.
 *                              Format: `accounts/{account}/promotions/{promotions}`
 *                              Please see {@see PromotionsServiceClient::promotionName()} for help formatting this field.
 */
function get_promotion_sample(string $formattedName): void
{
    // Create a client.
    $promotionsServiceClient = new PromotionsServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Promotion $response */
        $response = $promotionsServiceClient->getPromotion($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 = PromotionsServiceClient::promotionName('[ACCOUNT]', '[PROMOTION]');

    get_promotion_sample($formattedName);
}

insertPromotion

Inserts a promotion for your Merchant Center account. If the promotion already exists, then it updates the promotion instead.

The async variant is PromotionsServiceClient::insertPromotionAsync() .

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\Promotions\V1beta\InsertPromotionRequest` 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\Promotions\V1beta\Promotion`

Example

use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Promotions\V1beta\Client\PromotionsServiceClient;
use Google\Shopping\Merchant\Promotions\V1beta\InsertPromotionRequest;
use Google\Shopping\Merchant\Promotions\V1beta\Promotion;
use Google\Shopping\Merchant\Promotions\V1beta\RedemptionChannel;

/**
 * @param string $parent                            The account where the promotion will be inserted.
 *                                                  Format: accounts/{account}
 * @param string $promotionPromotionId              The user provided promotion ID to uniquely identify the
 *                                                  promotion. Follow [minimum
 *                                                  requirements](https://support.google.com/merchants/answer/7050148?ref_topic=7322920&sjid=871860036916537104-NC#minimum_requirements)
 *                                                  to prevent promotion disapprovals.
 * @param string $promotionContentLanguage          The two-letter [ISO
 *                                                  639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the
 *                                                  promotion.
 *
 *                                                  Promotions is only for [selected
 *                                                  languages](https://support.google.com/merchants/answer/4588281?ref_topic=6396150&sjid=18314938579342094533-NC#option3&zippy=).
 * @param string $promotionTargetCountry            The target country used as part of the unique identifier.
 *                                                  Represented as a [CLDR territory
 *                                                  code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml).
 *
 *                                                  Promotions are only available in selected
 *                                                  countries, [Free Listings and Shopping
 *                                                  ads](https://support.google.com/merchants/answer/4588460) [Local Inventory
 *                                                  ads](https://support.google.com/merchants/answer/10146326)
 * @param int    $promotionRedemptionChannelElement [Redemption
 *                                                  channel](https://support.google.com/merchants/answer/13837674?ref_topic=13773355&sjid=17642868584668136159-NC)
 *                                                  for the promotion. At least one channel is required.
 * @param string $dataSource                        The data source of the
 *                                                  [promotion](https://support.google.com/merchants/answer/6396268?sjid=5155774230887277618-NC)
 *                                                  Format:
 *                                                  `accounts/{account}/dataSources/{datasource}`.
 */
function insert_promotion_sample(
    string $parent,
    string $promotionPromotionId,
    string $promotionContentLanguage,
    string $promotionTargetCountry,
    int $promotionRedemptionChannelElement,
    string $dataSource
): void {
    // Create a client.
    $promotionsServiceClient = new PromotionsServiceClient();

    // Prepare the request message.
    $promotionRedemptionChannel = [$promotionRedemptionChannelElement,];
    $promotion = (new Promotion())
        ->setPromotionId($promotionPromotionId)
        ->setContentLanguage($promotionContentLanguage)
        ->setTargetCountry($promotionTargetCountry)
        ->setRedemptionChannel($promotionRedemptionChannel);
    $request = (new InsertPromotionRequest())
        ->setParent($parent)
        ->setPromotion($promotion)
        ->setDataSource($dataSource);

    // Call the API and handle any network failures.
    try {
        /** @var Promotion $response */
        $response = $promotionsServiceClient->insertPromotion($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]';
    $promotionPromotionId = '[PROMOTION_ID]';
    $promotionContentLanguage = '[CONTENT_LANGUAGE]';
    $promotionTargetCountry = '[TARGET_COUNTRY]';
    $promotionRedemptionChannelElement = RedemptionChannel::REDEMPTION_CHANNEL_UNSPECIFIED;
    $dataSource = '[DATA_SOURCE]';

    insert_promotion_sample(
        $parent,
        $promotionPromotionId,
        $promotionContentLanguage,
        $promotionTargetCountry,
        $promotionRedemptionChannelElement,
        $dataSource
    );
}

listPromotions

Lists the promotions in your Merchant Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested.

After inserting or updating a promotion, it may take several minutes before the updated processed promotion can be retrieved.

The async variant is PromotionsServiceClient::listPromotionsAsync() .

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\Promotions\V1beta\ListPromotionsRequest` 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\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Shopping\Merchant\Promotions\V1beta\Client\PromotionsServiceClient;
use Google\Shopping\Merchant\Promotions\V1beta\ListPromotionsRequest;
use Google\Shopping\Merchant\Promotions\V1beta\Promotion;

/**
 * @param string $parent The account to list processed promotions for.
 *                       Format: `accounts/{account}`
 */
function list_promotions_sample(string $parent): void
{
    // Create a client.
    $promotionsServiceClient = new PromotionsServiceClient();

    // Prepare the request message.
    $request = (new ListPromotionsRequest())
        ->setParent($parent);

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

        /** @var Promotion $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
{
    $parent = '[PARENT]';

    list_promotions_sample($parent);
}

getPromotionAsync

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\Promotions\V1beta\GetPromotionRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Shopping\Merchant\Promotions\V1beta\Promotion>`

insertPromotionAsync

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\Promotions\V1beta\InsertPromotionRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Shopping\Merchant\Promotions\V1beta\Promotion>`

listPromotionsAsync

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\Promotions\V1beta\ListPromotionsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

static::promotionName

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

Parameters
Name	Description
`account`	`string`
`promotion`	`string`

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

promotion: accounts/{account}/promotions/{promotion}

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.