Google Shopping Merchant Notifications V1beta Client - Class NotificationsApiServiceClient (0.1.2)

Reference documentation and code samples for the Google Shopping Merchant Notifications V1beta Client class NotificationsApiServiceClient.

Service Description: Service to manage notification subscriptions for merchants

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 \ Notifications \ 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.
↳ logger false|LoggerInterface

A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

createNotificationSubscription

Creates a notification subscription for a merchant. We will allow the following types of notification subscriptions to exist together (per merchant as a subscriber per event type):

  1. Subscription for all managed accounts + subscription for self
  2. Multiple "partial" subscriptions for managed accounts + subscription for self

we will not allow (per merchant as a subscriber per event type):

  1. multiple self subscriptions.
  2. multiple "all managed accounts" subscriptions.
  3. all and partial subscriptions at the same time.
  4. multiple partial subscriptions for the same target account

The async variant is NotificationsApiServiceClient::createNotificationSubscriptionAsync() .

Parameters
Name Description
request Google\Shopping\Merchant\Notifications\V1beta\CreateNotificationSubscriptionRequest

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\Notifications\V1beta\NotificationSubscription
Example 
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Notifications\V1beta\Client\NotificationsApiServiceClient;
use Google\Shopping\Merchant\Notifications\V1beta\CreateNotificationSubscriptionRequest;
use Google\Shopping\Merchant\Notifications\V1beta\NotificationSubscription;

/**
 * @param string $formattedParent The merchant account that owns the new notification subscription.
 *                                Format: `accounts/{account}`
 *                                Please see {@see NotificationsApiServiceClient::accountName()} for help formatting this field.
 */
function create_notification_subscription_sample(string $formattedParent): void
{
    // Create a client.
    $notificationsApiServiceClient = new NotificationsApiServiceClient();

    // Prepare the request message.
    $notificationSubscription = new NotificationSubscription();
    $request = (new CreateNotificationSubscriptionRequest())
        ->setParent($formattedParent)
        ->setNotificationSubscription($notificationSubscription);

    // Call the API and handle any network failures.
    try {
        /** @var NotificationSubscription $response */
        $response = $notificationsApiServiceClient->createNotificationSubscription($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 = NotificationsApiServiceClient::accountName('[ACCOUNT]');

    create_notification_subscription_sample($formattedParent);
}

deleteNotificationSubscription

Deletes a notification subscription for a merchant.

The async variant is NotificationsApiServiceClient::deleteNotificationSubscriptionAsync() .

Parameters
Name Description
request Google\Shopping\Merchant\Notifications\V1beta\DeleteNotificationSubscriptionRequest

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.
Example 
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Notifications\V1beta\Client\NotificationsApiServiceClient;
use Google\Shopping\Merchant\Notifications\V1beta\DeleteNotificationSubscriptionRequest;

/**
 * @param string $formattedName The name of the notification subscription to be deleted. Please see
 *                              {@see NotificationsApiServiceClient::notificationSubscriptionName()} for help formatting this field.
 */
function delete_notification_subscription_sample(string $formattedName): void
{
    // Create a client.
    $notificationsApiServiceClient = new NotificationsApiServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $notificationsApiServiceClient->deleteNotificationSubscription($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 = NotificationsApiServiceClient::notificationSubscriptionName(
        '[ACCOUNT]',
        '[NOTIFICATION_SUBSCRIPTION]'
    );

    delete_notification_subscription_sample($formattedName);
}

getNotificationSubscription

Gets notification subscriptions for an account.

The async variant is NotificationsApiServiceClient::getNotificationSubscriptionAsync() .

Parameters
Name Description
request Google\Shopping\Merchant\Notifications\V1beta\GetNotificationSubscriptionRequest

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\Notifications\V1beta\NotificationSubscription
Example 
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Notifications\V1beta\Client\NotificationsApiServiceClient;
use Google\Shopping\Merchant\Notifications\V1beta\GetNotificationSubscriptionRequest;
use Google\Shopping\Merchant\Notifications\V1beta\NotificationSubscription;

/**
 * @param string $formattedName The `name` of the notification subscription. Please see
 *                              {@see NotificationsApiServiceClient::notificationSubscriptionName()} for help formatting this field.
 */
function get_notification_subscription_sample(string $formattedName): void
{
    // Create a client.
    $notificationsApiServiceClient = new NotificationsApiServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var NotificationSubscription $response */
        $response = $notificationsApiServiceClient->getNotificationSubscription($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 = NotificationsApiServiceClient::notificationSubscriptionName(
        '[ACCOUNT]',
        '[NOTIFICATION_SUBSCRIPTION]'
    );

    get_notification_subscription_sample($formattedName);
}

listNotificationSubscriptions

Gets all the notification subscriptions for a merchant.

The async variant is NotificationsApiServiceClient::listNotificationSubscriptionsAsync() .

Parameters
Name Description
request Google\Shopping\Merchant\Notifications\V1beta\ListNotificationSubscriptionsRequest

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\Notifications\V1beta\Client\NotificationsApiServiceClient;
use Google\Shopping\Merchant\Notifications\V1beta\ListNotificationSubscriptionsRequest;
use Google\Shopping\Merchant\Notifications\V1beta\NotificationSubscription;

/**
 * @param string $formattedParent The merchant account who owns the notification subscriptions.
 *                                Format: `accounts/{account}`
 *                                Please see {@see NotificationsApiServiceClient::accountName()} for help formatting this field.
 */
function list_notification_subscriptions_sample(string $formattedParent): void
{
    // Create a client.
    $notificationsApiServiceClient = new NotificationsApiServiceClient();

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

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

        /** @var NotificationSubscription $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 = NotificationsApiServiceClient::accountName('[ACCOUNT]');

    list_notification_subscriptions_sample($formattedParent);
}

updateNotificationSubscription

Updates an existing notification subscription for a merchant.

The async variant is NotificationsApiServiceClient::updateNotificationSubscriptionAsync() .

Parameters
Name Description
request Google\Shopping\Merchant\Notifications\V1beta\UpdateNotificationSubscriptionRequest

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\Notifications\V1beta\NotificationSubscription
Example 
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Notifications\V1beta\Client\NotificationsApiServiceClient;
use Google\Shopping\Merchant\Notifications\V1beta\NotificationSubscription;
use Google\Shopping\Merchant\Notifications\V1beta\UpdateNotificationSubscriptionRequest;

/**
 * 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_notification_subscription_sample(): void
{
    // Create a client.
    $notificationsApiServiceClient = new NotificationsApiServiceClient();

    // Prepare the request message.
    $notificationSubscription = new NotificationSubscription();
    $request = (new UpdateNotificationSubscriptionRequest())
        ->setNotificationSubscription($notificationSubscription);

    // Call the API and handle any network failures.
    try {
        /** @var NotificationSubscription $response */
        $response = $notificationsApiServiceClient->updateNotificationSubscription($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

createNotificationSubscriptionAsync

Parameters
Name Description
request Google\Shopping\Merchant\Notifications\V1beta\CreateNotificationSubscriptionRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Shopping\Merchant\Notifications\V1beta\NotificationSubscription>

deleteNotificationSubscriptionAsync

Parameters
Name Description
request Google\Shopping\Merchant\Notifications\V1beta\DeleteNotificationSubscriptionRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<void>

getNotificationSubscriptionAsync

Parameters
Name Description
request Google\Shopping\Merchant\Notifications\V1beta\GetNotificationSubscriptionRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Shopping\Merchant\Notifications\V1beta\NotificationSubscription>

listNotificationSubscriptionsAsync

Parameters
Name Description
request Google\Shopping\Merchant\Notifications\V1beta\ListNotificationSubscriptionsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

updateNotificationSubscriptionAsync

Parameters
Name Description
request Google\Shopping\Merchant\Notifications\V1beta\UpdateNotificationSubscriptionRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Shopping\Merchant\Notifications\V1beta\NotificationSubscription>

static::accountName

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

Parameter
Name Description
account string
Returns
Type Description
string The formatted account resource.

static::notificationSubscriptionName

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

Parameters
Name Description
account string
notificationSubscription string
Returns
Type Description
string The formatted notification_subscription 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

  • account: accounts/{account}
  • notificationSubscription: accounts/{account}/notificationsubscriptions/{notification_subscription}

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.