Google Shopping Merchant Accounts V1 Client - Class AccountServicesServiceClient (0.10.0)

Reference documentation and code samples for the Google Shopping Merchant Accounts V1 Client class AccountServicesServiceClient.

Service Description: Service to support AccountService API.

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 \ Accounts \ V1 \ 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. Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information https://cloud.google.com/docs/authentication/external/externally-sourced-credentials

↳ 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

approveAccountService

Approve an account service proposal.

The async variant is AccountServicesServiceClient::approveAccountServiceAsync() .

Parameters
Name Description
request Google\Shopping\Merchant\Accounts\V1\ApproveAccountServiceRequest

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\Accounts\V1\AccountService
Example
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1\AccountService;
use Google\Shopping\Merchant\Accounts\V1\ApproveAccountServiceRequest;
use Google\Shopping\Merchant\Accounts\V1\Client\AccountServicesServiceClient;

/**
 * @param string $formattedName The resource name of the account service to approve.
 *                              Format: `accounts/{account}/services/{service}`
 *                              Please see {@see AccountServicesServiceClient::accountServiceName()} for help formatting this field.
 */
function approve_account_service_sample(string $formattedName): void
{
    // Create a client.
    $accountServicesServiceClient = new AccountServicesServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var AccountService $response */
        $response = $accountServicesServiceClient->approveAccountService($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 = AccountServicesServiceClient::accountServiceName('[ACCOUNT]', '[SERVICE]');

    approve_account_service_sample($formattedName);
}

getAccountService

Retrieve an account service.

The async variant is AccountServicesServiceClient::getAccountServiceAsync() .

Parameters
Name Description
request Google\Shopping\Merchant\Accounts\V1\GetAccountServiceRequest

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\Accounts\V1\AccountService
Example
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1\AccountService;
use Google\Shopping\Merchant\Accounts\V1\Client\AccountServicesServiceClient;
use Google\Shopping\Merchant\Accounts\V1\GetAccountServiceRequest;

/**
 * @param string $formattedName The resource name of the account service to get.
 *                              Format: `accounts/{account}/services/{service}`
 *                              Please see {@see AccountServicesServiceClient::accountServiceName()} for help formatting this field.
 */
function get_account_service_sample(string $formattedName): void
{
    // Create a client.
    $accountServicesServiceClient = new AccountServicesServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var AccountService $response */
        $response = $accountServicesServiceClient->getAccountService($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 = AccountServicesServiceClient::accountServiceName('[ACCOUNT]', '[SERVICE]');

    get_account_service_sample($formattedName);
}

listAccountServices

List account services for the specified accounts. Supports filtering.

The async variant is AccountServicesServiceClient::listAccountServicesAsync() .

Parameters
Name Description
request Google\Shopping\Merchant\Accounts\V1\ListAccountServicesRequest

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\Accounts\V1\AccountService;
use Google\Shopping\Merchant\Accounts\V1\Client\AccountServicesServiceClient;
use Google\Shopping\Merchant\Accounts\V1\ListAccountServicesRequest;

/**
 * @param string $formattedParent The parent account of the account service to filter by.
 *                                Format: `accounts/{account}`
 *                                Please see {@see AccountServicesServiceClient::accountName()} for help formatting this field.
 */
function list_account_services_sample(string $formattedParent): void
{
    // Create a client.
    $accountServicesServiceClient = new AccountServicesServiceClient();

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

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

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

    list_account_services_sample($formattedParent);
}

proposeAccountService

Propose an account service.

The async variant is AccountServicesServiceClient::proposeAccountServiceAsync() .

Parameters
Name Description
request Google\Shopping\Merchant\Accounts\V1\ProposeAccountServiceRequest

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\Accounts\V1\AccountService
Example
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1\AccountService;
use Google\Shopping\Merchant\Accounts\V1\Client\AccountServicesServiceClient;
use Google\Shopping\Merchant\Accounts\V1\ProposeAccountServiceRequest;

/**
 * @param string $formattedParent The resource name of the parent account for the service.
 *                                Format: `accounts/{account}`
 *                                Please see {@see AccountServicesServiceClient::accountName()} for help formatting this field.
 * @param string $provider        The provider of the service. Either the reference to an account
 *                                such as `providers/123` or a well-known service provider (one of
 *                                `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`).
 */
function propose_account_service_sample(string $formattedParent, string $provider): void
{
    // Create a client.
    $accountServicesServiceClient = new AccountServicesServiceClient();

    // Prepare the request message.
    $accountService = new AccountService();
    $request = (new ProposeAccountServiceRequest())
        ->setParent($formattedParent)
        ->setProvider($provider)
        ->setAccountService($accountService);

    // Call the API and handle any network failures.
    try {
        /** @var AccountService $response */
        $response = $accountServicesServiceClient->proposeAccountService($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 = AccountServicesServiceClient::accountName('[ACCOUNT]');
    $provider = '[PROVIDER]';

    propose_account_service_sample($formattedParent, $provider);
}

rejectAccountService

Reject an account service (both proposed and approve services can be rejected).

The async variant is AccountServicesServiceClient::rejectAccountServiceAsync() .

Parameters
Name Description
request Google\Shopping\Merchant\Accounts\V1\RejectAccountServiceRequest

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\Accounts\V1\Client\AccountServicesServiceClient;
use Google\Shopping\Merchant\Accounts\V1\RejectAccountServiceRequest;

/**
 * @param string $formattedName The resource name of the account service to reject.
 *                              Format: `accounts/{account}/services/{service}`
 *                              Please see {@see AccountServicesServiceClient::accountServiceName()} for help formatting this field.
 */
function reject_account_service_sample(string $formattedName): void
{
    // Create a client.
    $accountServicesServiceClient = new AccountServicesServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $accountServicesServiceClient->rejectAccountService($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 = AccountServicesServiceClient::accountServiceName('[ACCOUNT]', '[SERVICE]');

    reject_account_service_sample($formattedName);
}

approveAccountServiceAsync

Parameters
Name Description
request Google\Shopping\Merchant\Accounts\V1\ApproveAccountServiceRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Shopping\Merchant\Accounts\V1\AccountService>

getAccountServiceAsync

Parameters
Name Description
request Google\Shopping\Merchant\Accounts\V1\GetAccountServiceRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Shopping\Merchant\Accounts\V1\AccountService>

listAccountServicesAsync

Parameters
Name Description
request Google\Shopping\Merchant\Accounts\V1\ListAccountServicesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

proposeAccountServiceAsync

Parameters
Name Description
request Google\Shopping\Merchant\Accounts\V1\ProposeAccountServiceRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Shopping\Merchant\Accounts\V1\AccountService>

rejectAccountServiceAsync

Parameters
Name Description
request Google\Shopping\Merchant\Accounts\V1\RejectAccountServiceRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<void>

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::accountServiceName

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

Parameters
Name Description
account string
service string
Returns
Type Description
string The formatted account_service 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}
  • accountService: accounts/{account}/services/{service}

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.