Google Shopping Merchant Accounts V1beta Client - Class AccountsServiceClient (0.3.0)

Reference documentation and code samples for the Google Shopping Merchant Accounts V1beta Client class AccountsServiceClient.

Service Description: Service to support Accounts 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 \ 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.

createAndConfigureAccount

Creates a standalone Merchant Center account with additional configuration.

Adds the user that makes the request as an admin for the new account.

The async variant is Google\Shopping\Merchant\Accounts\V1beta\Client\AccountsServiceClient::createAndConfigureAccountAsync() .

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\Accounts\V1beta\CreateAndConfigureAccountRequest` 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\V1beta\Account`

Example

use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1beta\Account;
use Google\Shopping\Merchant\Accounts\V1beta\Client\AccountsServiceClient;
use Google\Shopping\Merchant\Accounts\V1beta\CreateAndConfigureAccountRequest;
use Google\Shopping\Merchant\Accounts\V1beta\CreateAndConfigureAccountRequest\AddAccountService;
use Google\Type\TimeZone;

/**
 * @param string $accountAccountName  A human-readable name of the account. See
 *                                    [store name](https://support.google.com/merchants/answer/160556) and
 *                                    [business name](https://support.google.com/merchants/answer/12159159) for
 *                                    more information.
 * @param string $accountLanguageCode The account's [BCP-47 language
 *                                    code](https://tools.ietf.org/html/bcp47), such as `en-US` or `sr-Latn`.
 */
function create_and_configure_account_sample(
    string $accountAccountName,
    string $accountLanguageCode
): void {
    // Create a client.
    $accountsServiceClient = new AccountsServiceClient();

    // Prepare the request message.
    $accountTimeZone = new TimeZone();
    $account = (new Account())
        ->setAccountName($accountAccountName)
        ->setTimeZone($accountTimeZone)
        ->setLanguageCode($accountLanguageCode);
    $service = [new AddAccountService()];
    $request = (new CreateAndConfigureAccountRequest())
        ->setAccount($account)
        ->setService($service);

    // Call the API and handle any network failures.
    try {
        /** @var Account $response */
        $response = $accountsServiceClient->createAndConfigureAccount($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
{
    $accountAccountName = '[ACCOUNT_NAME]';
    $accountLanguageCode = '[LANGUAGE_CODE]';

    create_and_configure_account_sample($accountAccountName, $accountLanguageCode);
}

deleteAccount

Deletes the specified account regardless of its type: standalone, MCA or sub-account. Deleting an MCA leads to the deletion of all of its sub-accounts. Executing this method requires admin access.

The deletion succeeds only if the account does not provide services to any other account and has no processed offers. You can use the force parameter to override this.

The async variant is Google\Shopping\Merchant\Accounts\V1beta\Client\AccountsServiceClient::deleteAccountAsync() .

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\Accounts\V1beta\DeleteAccountRequest` 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\V1beta\Client\AccountsServiceClient;
use Google\Shopping\Merchant\Accounts\V1beta\DeleteAccountRequest;

/**
 * @param string $formattedName The name of the account to delete.
 *                              Format: `accounts/{account}`
 *                              Please see {@see AccountsServiceClient::accountName()} for help formatting this field.
 */
function delete_account_sample(string $formattedName): void
{
    // Create a client.
    $accountsServiceClient = new AccountsServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $accountsServiceClient->deleteAccount($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 = AccountsServiceClient::accountName('[ACCOUNT]');

    delete_account_sample($formattedName);
}

getAccount

Retrieves an account from your Merchant Center account.

After inserting, updating, or deleting an account, it may take several minutes before changes take effect.

The async variant is Google\Shopping\Merchant\Accounts\V1beta\Client\AccountsServiceClient::getAccountAsync() .

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\Accounts\V1beta\GetAccountRequest` 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\V1beta\Account`

Example

use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1beta\Account;
use Google\Shopping\Merchant\Accounts\V1beta\Client\AccountsServiceClient;
use Google\Shopping\Merchant\Accounts\V1beta\GetAccountRequest;

/**
 * @param string $formattedName The name of the account to retrieve.
 *                              Format: `accounts/{account}`
 *                              Please see {@see AccountsServiceClient::accountName()} for help formatting this field.
 */
function get_account_sample(string $formattedName): void
{
    // Create a client.
    $accountsServiceClient = new AccountsServiceClient();

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

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

    get_account_sample($formattedName);
}

listAccounts

Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters.

This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. If no filter is provided, then it returns accounts the user is directly added to.

The async variant is Google\Shopping\Merchant\Accounts\V1beta\Client\AccountsServiceClient::listAccountsAsync() .

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\Accounts\V1beta\ListAccountsRequest` 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\V1beta\Account;
use Google\Shopping\Merchant\Accounts\V1beta\Client\AccountsServiceClient;
use Google\Shopping\Merchant\Accounts\V1beta\ListAccountsRequest;

/**
 * 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 list_accounts_sample(): void
{
    // Create a client.
    $accountsServiceClient = new AccountsServiceClient();

    // Prepare the request message.
    $request = new ListAccountsRequest();

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

        /** @var Account $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());
    }
}

listSubAccounts

List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful ListAccounts method. This method will produce the same results as calling ListsAccounts with the following filter: relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))

The async variant is Google\Shopping\Merchant\Accounts\V1beta\Client\AccountsServiceClient::listSubAccountsAsync() .

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\Accounts\V1beta\ListSubAccountsRequest` 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\V1beta\Account;
use Google\Shopping\Merchant\Accounts\V1beta\Client\AccountsServiceClient;
use Google\Shopping\Merchant\Accounts\V1beta\ListSubAccountsRequest;

/**
 * @param string $formattedProvider The parent account.
 *                                  Format: `accounts/{account}`
 *                                  Please see {@see AccountsServiceClient::accountName()} for help formatting this field.
 */
function list_sub_accounts_sample(string $formattedProvider): void
{
    // Create a client.
    $accountsServiceClient = new AccountsServiceClient();

    // Prepare the request message.
    $request = (new ListSubAccountsRequest())
        ->setProvider($formattedProvider);

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

        /** @var Account $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
{
    $formattedProvider = AccountsServiceClient::accountName('[ACCOUNT]');

    list_sub_accounts_sample($formattedProvider);
}

updateAccount

Updates an account regardless of its type: standalone, MCA or sub-account.

Executing this method requires admin access.

The async variant is Google\Shopping\Merchant\Accounts\V1beta\Client\AccountsServiceClient::updateAccountAsync() .

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\Accounts\V1beta\UpdateAccountRequest` 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\V1beta\Account`

Example

use Google\ApiCore\ApiException;
use Google\Protobuf\FieldMask;
use Google\Shopping\Merchant\Accounts\V1beta\Account;
use Google\Shopping\Merchant\Accounts\V1beta\Client\AccountsServiceClient;
use Google\Shopping\Merchant\Accounts\V1beta\UpdateAccountRequest;
use Google\Type\TimeZone;

/**
 * @param string $accountAccountName  A human-readable name of the account. See
 *                                    [store name](https://support.google.com/merchants/answer/160556) and
 *                                    [business name](https://support.google.com/merchants/answer/12159159) for
 *                                    more information.
 * @param string $accountLanguageCode The account's [BCP-47 language
 *                                    code](https://tools.ietf.org/html/bcp47), such as `en-US` or `sr-Latn`.
 */
function update_account_sample(string $accountAccountName, string $accountLanguageCode): void
{
    // Create a client.
    $accountsServiceClient = new AccountsServiceClient();

    // Prepare the request message.
    $accountTimeZone = new TimeZone();
    $account = (new Account())
        ->setAccountName($accountAccountName)
        ->setTimeZone($accountTimeZone)
        ->setLanguageCode($accountLanguageCode);
    $updateMask = new FieldMask();
    $request = (new UpdateAccountRequest())
        ->setAccount($account)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var Account $response */
        $response = $accountsServiceClient->updateAccount($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
{
    $accountAccountName = '[ACCOUNT_NAME]';
    $accountLanguageCode = '[LANGUAGE_CODE]';

    update_account_sample($accountAccountName, $accountLanguageCode);
}

createAndConfigureAccountAsync

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\Accounts\V1beta\CreateAndConfigureAccountRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteAccountAsync

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\Accounts\V1beta\DeleteAccountRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getAccountAsync

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\Accounts\V1beta\GetAccountRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listAccountsAsync

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\Accounts\V1beta\ListAccountsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listSubAccountsAsync

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\Accounts\V1beta\ListSubAccountsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateAccountAsync

Parameters
Name	Description
`request`	`Google\Shopping\Merchant\Accounts\V1beta\UpdateAccountRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

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

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

Parameter
Name	Description
`version`	`string`

Returns
Type	Description
`string`	The formatted terms_of_service resource.

static::userName

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

Parameters
Name	Description
`account`	`string`
`email`	`string`

Returns
Type	Description
`string`	The formatted user 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}
termsOfService: termsOfService/{version}
user: accounts/{account}/users/{email}

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.