Google Ads Ad Manager V1 Client - Class UserServiceClient (0.15.1)

use Google\Ads\AdManager\V1\BatchActivateUsersRequest;
use Google\Ads\AdManager\V1\BatchActivateUsersResponse;
use Google\Ads\AdManager\V1\Client\UserServiceClient;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent Format: `networks/{network_code}`
 *                                Please see {@see UserServiceClient::networkName()} for help formatting this field.
 * @param string $namesElement    The resource names of the `User` objects to activate.
 */
function batch_activate_users_sample(string $formattedParent, string $namesElement): void
{
    // Create a client.
    $userServiceClient = new UserServiceClient();

    // Prepare the request message.
    $names = [$namesElement];
    $request = (new BatchActivateUsersRequest())
        ->setParent($formattedParent)
        ->setNames($names);

    // Call the API and handle any network failures.
    try {
        /** @var BatchActivateUsersResponse $response */
        $response = $userServiceClient->batchActivateUsers($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::networkName('[NETWORK_CODE]');
    $namesElement = '[NAMES]';

    batch_activate_users_sample($formattedParent, $namesElement);
}

use Google\Ads\AdManager\V1\BatchCreateUsersRequest;
use Google\Ads\AdManager\V1\BatchCreateUsersResponse;
use Google\Ads\AdManager\V1\Client\UserServiceClient;
use Google\Ads\AdManager\V1\CreateUserRequest;
use Google\Ads\AdManager\V1\User;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent           The parent resource where `Users` will be created.
 *                                          Format: `networks/{network_code}`
 *                                          The parent field in the CreateUserRequest must match this
 *                                          field. Please see
 *                                          {@see UserServiceClient::networkName()} for help formatting this field.
 * @param string $formattedRequestsParent   The parent resource where this `User` will be created.
 *                                          Format: `networks/{network_code}`
 *                                          Please see {@see UserServiceClient::networkName()} for help formatting this field.
 * @param string $requestsUserDisplayName   The name of the User. It has a maximum length of 128 characters.
 * @param string $requestsUserEmail         The email or login of the User. In order to create a new user,
 *                                          you must already have a Google Account.
 * @param string $formattedRequestsUserRole The unique Role ID of the User. Roles that are created by Google
 *                                          will have negative IDs. Please see
 *                                          {@see UserServiceClient::roleName()} for help formatting this field.
 */
function batch_create_users_sample(
    string $formattedParent,
    string $formattedRequestsParent,
    string $requestsUserDisplayName,
    string $requestsUserEmail,
    string $formattedRequestsUserRole
): void {
    // Create a client.
    $userServiceClient = new UserServiceClient();

    // Prepare the request message.
    $requestsUser = (new User())
        ->setDisplayName($requestsUserDisplayName)
        ->setEmail($requestsUserEmail)
        ->setRole($formattedRequestsUserRole);
    $createUserRequest = (new CreateUserRequest())
        ->setParent($formattedRequestsParent)
        ->setUser($requestsUser);
    $requests = [$createUserRequest];
    $request = (new BatchCreateUsersRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchCreateUsersResponse $response */
        $response = $userServiceClient->batchCreateUsers($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::networkName('[NETWORK_CODE]');
    $formattedRequestsParent = UserServiceClient::networkName('[NETWORK_CODE]');
    $requestsUserDisplayName = '[DISPLAY_NAME]';
    $requestsUserEmail = '[EMAIL]';
    $formattedRequestsUserRole = UserServiceClient::roleName('[NETWORK_CODE]', '[ROLE]');

    batch_create_users_sample(
        $formattedParent,
        $formattedRequestsParent,
        $requestsUserDisplayName,
        $requestsUserEmail,
        $formattedRequestsUserRole
    );
}

use Google\Ads\AdManager\V1\BatchDeactivateUsersRequest;
use Google\Ads\AdManager\V1\BatchDeactivateUsersResponse;
use Google\Ads\AdManager\V1\Client\UserServiceClient;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent Format: `networks/{network_code}`
 *                                Please see {@see UserServiceClient::networkName()} for help formatting this field.
 * @param string $namesElement    The resource names of the `User` objects to deactivate.
 */
function batch_deactivate_users_sample(string $formattedParent, string $namesElement): void
{
    // Create a client.
    $userServiceClient = new UserServiceClient();

    // Prepare the request message.
    $names = [$namesElement];
    $request = (new BatchDeactivateUsersRequest())
        ->setParent($formattedParent)
        ->setNames($names);

    // Call the API and handle any network failures.
    try {
        /** @var BatchDeactivateUsersResponse $response */
        $response = $userServiceClient->batchDeactivateUsers($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::networkName('[NETWORK_CODE]');
    $namesElement = '[NAMES]';

    batch_deactivate_users_sample($formattedParent, $namesElement);
}

use Google\Ads\AdManager\V1\BatchUpdateUsersRequest;
use Google\Ads\AdManager\V1\BatchUpdateUsersResponse;
use Google\Ads\AdManager\V1\Client\UserServiceClient;
use Google\Ads\AdManager\V1\UpdateUserRequest;
use Google\Ads\AdManager\V1\User;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent           The parent resource where `Users` will be updated.
 *                                          Format: `networks/{network_code}`
 *                                          The parent field in the UpdateUserRequest must match this
 *                                          field. Please see
 *                                          {@see UserServiceClient::networkName()} for help formatting this field.
 * @param string $requestsUserDisplayName   The name of the User. It has a maximum length of 128 characters.
 * @param string $requestsUserEmail         The email or login of the User. In order to create a new user,
 *                                          you must already have a Google Account.
 * @param string $formattedRequestsUserRole The unique Role ID of the User. Roles that are created by Google
 *                                          will have negative IDs. Please see
 *                                          {@see UserServiceClient::roleName()} for help formatting this field.
 */
function batch_update_users_sample(
    string $formattedParent,
    string $requestsUserDisplayName,
    string $requestsUserEmail,
    string $formattedRequestsUserRole
): void {
    // Create a client.
    $userServiceClient = new UserServiceClient();

    // Prepare the request message.
    $requestsUser = (new User())
        ->setDisplayName($requestsUserDisplayName)
        ->setEmail($requestsUserEmail)
        ->setRole($formattedRequestsUserRole);
    $updateUserRequest = (new UpdateUserRequest())
        ->setUser($requestsUser);
    $requests = [$updateUserRequest];
    $request = (new BatchUpdateUsersRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchUpdateUsersResponse $response */
        $response = $userServiceClient->batchUpdateUsers($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::networkName('[NETWORK_CODE]');
    $requestsUserDisplayName = '[DISPLAY_NAME]';
    $requestsUserEmail = '[EMAIL]';
    $formattedRequestsUserRole = UserServiceClient::roleName('[NETWORK_CODE]', '[ROLE]');

    batch_update_users_sample(
        $formattedParent,
        $requestsUserDisplayName,
        $requestsUserEmail,
        $formattedRequestsUserRole
    );
}

use Google\Ads\AdManager\V1\Client\UserServiceClient;
use Google\Ads\AdManager\V1\CreateUserRequest;
use Google\Ads\AdManager\V1\User;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent   The parent resource where this `User` will be created.
 *                                  Format: `networks/{network_code}`
 *                                  Please see {@see UserServiceClient::networkName()} for help formatting this field.
 * @param string $userDisplayName   The name of the User. It has a maximum length of 128 characters.
 * @param string $userEmail         The email or login of the User. In order to create a new user,
 *                                  you must already have a Google Account.
 * @param string $formattedUserRole The unique Role ID of the User. Roles that are created by Google
 *                                  will have negative IDs. Please see
 *                                  {@see UserServiceClient::roleName()} for help formatting this field.
 */
function create_user_sample(
    string $formattedParent,
    string $userDisplayName,
    string $userEmail,
    string $formattedUserRole
): void {
    // Create a client.
    $userServiceClient = new UserServiceClient();

    // Prepare the request message.
    $user = (new User())
        ->setDisplayName($userDisplayName)
        ->setEmail($userEmail)
        ->setRole($formattedUserRole);
    $request = (new CreateUserRequest())
        ->setParent($formattedParent)
        ->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::networkName('[NETWORK_CODE]');
    $userDisplayName = '[DISPLAY_NAME]';
    $userEmail = '[EMAIL]';
    $formattedUserRole = UserServiceClient::roleName('[NETWORK_CODE]', '[ROLE]');

    create_user_sample($formattedParent, $userDisplayName, $userEmail, $formattedUserRole);
}

use Google\Ads\AdManager\V1\Client\UserServiceClient;
use Google\Ads\AdManager\V1\GetUserRequest;
use Google\Ads\AdManager\V1\User;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedName The resource name of the User.
 *                              Format: `networks/{network_code}/users/{user_id}`
 *                              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('[NETWORK_CODE]', '[USER]');

    get_user_sample($formattedName);
}

use Google\Ads\AdManager\V1\Client\UserServiceClient;
use Google\Ads\AdManager\V1\ListUsersRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;

/**
 * @param string $formattedParent The parent, which owns this collection of Users.
 *                                Format: `networks/{network_code}`
 *                                Please see {@see UserServiceClient::networkName()} 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);

        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::networkName('[NETWORK_CODE]');

    list_users_sample($formattedParent);
}

use Google\Ads\AdManager\V1\Client\UserServiceClient;
use Google\Ads\AdManager\V1\UpdateUserRequest;
use Google\Ads\AdManager\V1\User;
use Google\ApiCore\ApiException;

/**
 * @param string $userDisplayName   The name of the User. It has a maximum length of 128 characters.
 * @param string $userEmail         The email or login of the User. In order to create a new user,
 *                                  you must already have a Google Account.
 * @param string $formattedUserRole The unique Role ID of the User. Roles that are created by Google
 *                                  will have negative IDs. Please see
 *                                  {@see UserServiceClient::roleName()} for help formatting this field.
 */
function update_user_sample(
    string $userDisplayName,
    string $userEmail,
    string $formattedUserRole
): void {
    // Create a client.
    $userServiceClient = new UserServiceClient();

    // Prepare the request message.
    $user = (new User())
        ->setDisplayName($userDisplayName)
        ->setEmail($userEmail)
        ->setRole($formattedUserRole);
    $request = (new UpdateUserRequest())
        ->setUser($user);

    // 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());
    }
}

/**
 * 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
{
    $userDisplayName = '[DISPLAY_NAME]';
    $userEmail = '[EMAIL]';
    $formattedUserRole = UserServiceClient::roleName('[NETWORK_CODE]', '[ROLE]');

    update_user_sample($userDisplayName, $userEmail, $formattedUserRole);
}