Google Shopping Merchant Accounts V1beta Client - Class UserServiceClient (0.1.0)

Namespace

Methods

__construct

createUser

use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1beta\Client\UserServiceClient;
use Google\Shopping\Merchant\Accounts\V1beta\CreateUserRequest;
use Google\Shopping\Merchant\Accounts\V1beta\User;

/**
 * @param string $formattedParent The resource name of the account for which a user will be
 *                                created. Format: `accounts/{account}`
 *                                Please see {@see UserServiceClient::accountName()} for help formatting this field.
 * @param string $userId          The email address of the user (for example,
 *                                `john.doe@gmail.com`).
 */
function create_user_sample(string $formattedParent, string $userId): void
{
    // Create a client.
    $userServiceClient = new UserServiceClient();

    // Prepare the request message.
    $user = new User();
    $request = (new CreateUserRequest())
        ->setParent($formattedParent)
        ->setUserId($userId)
        ->setUser($user);

    // Call the API and handle any network failures.
    try {
        /** @var User $response */
        $response = $userServiceClient->createUser($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 = UserServiceClient::accountName('[ACCOUNT]');
    $userId = '[USER_ID]';

    create_user_sample($formattedParent, $userId);
}

deleteUser

use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1beta\Client\UserServiceClient;
use Google\Shopping\Merchant\Accounts\V1beta\DeleteUserRequest;

/**
 * @param string $formattedName The name of the user to delete.
 *                              Format: `accounts/{account}/users/{email}`
 *
 *                              It is also possible to delete the user corresponding to the caller by using
 *                              `me` rather than an email address as in `accounts/{account}/users/me`. Please see
 *                              {@see UserServiceClient::userName()} for help formatting this field.
 */
function delete_user_sample(string $formattedName): void
{
    // Create a client.
    $userServiceClient = new UserServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $userServiceClient->deleteUser($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 = UserServiceClient::userName('[ACCOUNT]', '[EMAIL]');

    delete_user_sample($formattedName);
}

getUser

use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1beta\Client\UserServiceClient;
use Google\Shopping\Merchant\Accounts\V1beta\GetUserRequest;
use Google\Shopping\Merchant\Accounts\V1beta\User;

/**
 * @param string $formattedName The name of the user to retrieve.
 *                              Format: `accounts/{account}/users/{email}`
 *
 *                              It is also possible to retrieve the user corresponding to the caller by
 *                              using `me` rather than an email address as in
 *                              `accounts/{account}/users/me`. Please see
 *                              {@see UserServiceClient::userName()} for help formatting this field.
 */
function get_user_sample(string $formattedName): void
{
    // Create a client.
    $userServiceClient = new UserServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var User $response */
        $response = $userServiceClient->getUser($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 = UserServiceClient::userName('[ACCOUNT]', '[EMAIL]');

    get_user_sample($formattedName);
}

listUsers

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Shopping\Merchant\Accounts\V1beta\Client\UserServiceClient;
use Google\Shopping\Merchant\Accounts\V1beta\ListUsersRequest;
use Google\Shopping\Merchant\Accounts\V1beta\User;

/**
 * @param string $formattedParent The parent, which owns this collection of users.
 *                                Format: `accounts/{account}`
 *                                Please see {@see UserServiceClient::accountName()} for help formatting this field.
 */
function list_users_sample(string $formattedParent): void
{
    // Create a client.
    $userServiceClient = new UserServiceClient();

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

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

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

    list_users_sample($formattedParent);
}

updateUser

use Google\ApiCore\ApiException;
use Google\Protobuf\FieldMask;
use Google\Shopping\Merchant\Accounts\V1beta\Client\UserServiceClient;
use Google\Shopping\Merchant\Accounts\V1beta\UpdateUserRequest;
use Google\Shopping\Merchant\Accounts\V1beta\User;

/**
 * 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_user_sample(): void
{
    // Create a client.
    $userServiceClient = new UserServiceClient();

    // Prepare the request message.
    $user = new User();
    $updateMask = new FieldMask();
    $request = (new UpdateUserRequest())
        ->setUser($user)
        ->setUpdateMask($updateMask);

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

createUserAsync

deleteUserAsync

getUserAsync

listUsersAsync

updateUserAsync

static::accountName

static::userName

static::parseName