Google Ads Ad Manager V1 Client - Class AdUnitServiceClient (0.6.0)

use Google\Ads\AdManager\V1\BatchActivateAdUnitsRequest;
use Google\Ads\AdManager\V1\BatchActivateAdUnitsResponse;
use Google\Ads\AdManager\V1\Client\AdUnitServiceClient;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent       Format: `networks/{network_code}`
 *                                      Please see {@see AdUnitServiceClient::networkName()} for help formatting this field.
 * @param string $formattedNamesElement The resource names of the `AdUnit`s to activate.
 *                                      Format: `networks/{network_code}/adUnits/{ad_unit_id}`
 *                                      Please see {@see AdUnitServiceClient::adUnitName()} for help formatting this field.
 */
function batch_activate_ad_units_sample(
    string $formattedParent,
    string $formattedNamesElement
): void {
    // Create a client.
    $adUnitServiceClient = new AdUnitServiceClient();

    // Prepare the request message.
    $formattedNames = [$formattedNamesElement,];
    $request = (new BatchActivateAdUnitsRequest())
        ->setParent($formattedParent)
        ->setNames($formattedNames);

    // Call the API and handle any network failures.
    try {
        /** @var BatchActivateAdUnitsResponse $response */
        $response = $adUnitServiceClient->batchActivateAdUnits($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 = AdUnitServiceClient::networkName('[NETWORK_CODE]');
    $formattedNamesElement = AdUnitServiceClient::adUnitName('[NETWORK_CODE]', '[AD_UNIT]');

    batch_activate_ad_units_sample($formattedParent, $formattedNamesElement);
}

use Google\Ads\AdManager\V1\BatchArchiveAdUnitsRequest;
use Google\Ads\AdManager\V1\BatchArchiveAdUnitsResponse;
use Google\Ads\AdManager\V1\Client\AdUnitServiceClient;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent       Format: `networks/{network_code}`
 *                                      Please see {@see AdUnitServiceClient::networkName()} for help formatting this field.
 * @param string $formattedNamesElement The resource names of the `AdUnit`s to archive.
 *                                      Format: `networks/{network_code}/adUnits/{ad_unit_id}`
 *                                      Please see {@see AdUnitServiceClient::adUnitName()} for help formatting this field.
 */
function batch_archive_ad_units_sample(
    string $formattedParent,
    string $formattedNamesElement
): void {
    // Create a client.
    $adUnitServiceClient = new AdUnitServiceClient();

    // Prepare the request message.
    $formattedNames = [$formattedNamesElement,];
    $request = (new BatchArchiveAdUnitsRequest())
        ->setParent($formattedParent)
        ->setNames($formattedNames);

    // Call the API and handle any network failures.
    try {
        /** @var BatchArchiveAdUnitsResponse $response */
        $response = $adUnitServiceClient->batchArchiveAdUnits($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 = AdUnitServiceClient::networkName('[NETWORK_CODE]');
    $formattedNamesElement = AdUnitServiceClient::adUnitName('[NETWORK_CODE]', '[AD_UNIT]');

    batch_archive_ad_units_sample($formattedParent, $formattedNamesElement);
}

use Google\Ads\AdManager\V1\AdUnit;
use Google\Ads\AdManager\V1\BatchCreateAdUnitsRequest;
use Google\Ads\AdManager\V1\BatchCreateAdUnitsResponse;
use Google\Ads\AdManager\V1\Client\AdUnitServiceClient;
use Google\Ads\AdManager\V1\CreateAdUnitRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent                     The parent resource where `AdUnits` will be created.
 *                                                    Format: `networks/{network_code}`
 *                                                    The parent field in the CreateAdUnitRequest must match this
 *                                                    field. Please see
 *                                                    {@see AdUnitServiceClient::networkName()} for help formatting this field.
 * @param string $formattedRequestsParent             The parent resource where this `AdUnit` will be created.
 *                                                    Format: `networks/{network_code}`
 *                                                    Please see {@see AdUnitServiceClient::networkName()} for help formatting this field.
 * @param string $formattedRequestsAdUnitParentAdUnit Immutable. The AdUnit's parent. Every ad unit has a parent except
 *                                                    for the root ad unit, which is created by Google. Format:
 *                                                    "networks/{network_code}/adUnits/{ad_unit_id}"
 *                                                    Please see {@see AdUnitServiceClient::adUnitName()} for help formatting this field.
 * @param string $requestsAdUnitDisplayName           The display name of the ad unit. Its maximum length is 255
 *                                                    characters.
 */
function batch_create_ad_units_sample(
    string $formattedParent,
    string $formattedRequestsParent,
    string $formattedRequestsAdUnitParentAdUnit,
    string $requestsAdUnitDisplayName
): void {
    // Create a client.
    $adUnitServiceClient = new AdUnitServiceClient();

    // Prepare the request message.
    $requestsAdUnit = (new AdUnit())
        ->setParentAdUnit($formattedRequestsAdUnitParentAdUnit)
        ->setDisplayName($requestsAdUnitDisplayName);
    $createAdUnitRequest = (new CreateAdUnitRequest())
        ->setParent($formattedRequestsParent)
        ->setAdUnit($requestsAdUnit);
    $requests = [$createAdUnitRequest,];
    $request = (new BatchCreateAdUnitsRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchCreateAdUnitsResponse $response */
        $response = $adUnitServiceClient->batchCreateAdUnits($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 = AdUnitServiceClient::networkName('[NETWORK_CODE]');
    $formattedRequestsParent = AdUnitServiceClient::networkName('[NETWORK_CODE]');
    $formattedRequestsAdUnitParentAdUnit = AdUnitServiceClient::adUnitName(
        '[NETWORK_CODE]',
        '[AD_UNIT]'
    );
    $requestsAdUnitDisplayName = '[DISPLAY_NAME]';

    batch_create_ad_units_sample(
        $formattedParent,
        $formattedRequestsParent,
        $formattedRequestsAdUnitParentAdUnit,
        $requestsAdUnitDisplayName
    );
}

use Google\Ads\AdManager\V1\BatchDeactivateAdUnitsRequest;
use Google\Ads\AdManager\V1\BatchDeactivateAdUnitsResponse;
use Google\Ads\AdManager\V1\Client\AdUnitServiceClient;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent       Format: `networks/{network_code}`
 *                                      Please see {@see AdUnitServiceClient::networkName()} for help formatting this field.
 * @param string $formattedNamesElement The resource names of the `AdUnit`s to deactivate.
 *                                      Format: `networks/{network_code}/adUnits/{ad_unit_id}`
 *                                      Please see {@see AdUnitServiceClient::adUnitName()} for help formatting this field.
 */
function batch_deactivate_ad_units_sample(
    string $formattedParent,
    string $formattedNamesElement
): void {
    // Create a client.
    $adUnitServiceClient = new AdUnitServiceClient();

    // Prepare the request message.
    $formattedNames = [$formattedNamesElement,];
    $request = (new BatchDeactivateAdUnitsRequest())
        ->setParent($formattedParent)
        ->setNames($formattedNames);

    // Call the API and handle any network failures.
    try {
        /** @var BatchDeactivateAdUnitsResponse $response */
        $response = $adUnitServiceClient->batchDeactivateAdUnits($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 = AdUnitServiceClient::networkName('[NETWORK_CODE]');
    $formattedNamesElement = AdUnitServiceClient::adUnitName('[NETWORK_CODE]', '[AD_UNIT]');

    batch_deactivate_ad_units_sample($formattedParent, $formattedNamesElement);
}

use Google\Ads\AdManager\V1\AdUnit;
use Google\Ads\AdManager\V1\BatchUpdateAdUnitsRequest;
use Google\Ads\AdManager\V1\BatchUpdateAdUnitsResponse;
use Google\Ads\AdManager\V1\Client\AdUnitServiceClient;
use Google\Ads\AdManager\V1\UpdateAdUnitRequest;
use Google\ApiCore\ApiException;
use Google\Protobuf\FieldMask;

/**
 * @param string $formattedParent                     The parent resource where `AdUnits` will be updated.
 *                                                    Format: `networks/{network_code}`
 *                                                    The parent field in the UpdateAdUnitRequest must match this
 *                                                    field. Please see
 *                                                    {@see AdUnitServiceClient::networkName()} for help formatting this field.
 * @param string $formattedRequestsAdUnitParentAdUnit Immutable. The AdUnit's parent. Every ad unit has a parent except
 *                                                    for the root ad unit, which is created by Google. Format:
 *                                                    "networks/{network_code}/adUnits/{ad_unit_id}"
 *                                                    Please see {@see AdUnitServiceClient::adUnitName()} for help formatting this field.
 * @param string $requestsAdUnitDisplayName           The display name of the ad unit. Its maximum length is 255
 *                                                    characters.
 */
function batch_update_ad_units_sample(
    string $formattedParent,
    string $formattedRequestsAdUnitParentAdUnit,
    string $requestsAdUnitDisplayName
): void {
    // Create a client.
    $adUnitServiceClient = new AdUnitServiceClient();

    // Prepare the request message.
    $requestsAdUnit = (new AdUnit())
        ->setParentAdUnit($formattedRequestsAdUnitParentAdUnit)
        ->setDisplayName($requestsAdUnitDisplayName);
    $requestsUpdateMask = new FieldMask();
    $updateAdUnitRequest = (new UpdateAdUnitRequest())
        ->setAdUnit($requestsAdUnit)
        ->setUpdateMask($requestsUpdateMask);
    $requests = [$updateAdUnitRequest,];
    $request = (new BatchUpdateAdUnitsRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchUpdateAdUnitsResponse $response */
        $response = $adUnitServiceClient->batchUpdateAdUnits($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 = AdUnitServiceClient::networkName('[NETWORK_CODE]');
    $formattedRequestsAdUnitParentAdUnit = AdUnitServiceClient::adUnitName(
        '[NETWORK_CODE]',
        '[AD_UNIT]'
    );
    $requestsAdUnitDisplayName = '[DISPLAY_NAME]';

    batch_update_ad_units_sample(
        $formattedParent,
        $formattedRequestsAdUnitParentAdUnit,
        $requestsAdUnitDisplayName
    );
}

use Google\Ads\AdManager\V1\AdUnit;
use Google\Ads\AdManager\V1\Client\AdUnitServiceClient;
use Google\Ads\AdManager\V1\CreateAdUnitRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent             The parent resource where this `AdUnit` will be created.
 *                                            Format: `networks/{network_code}`
 *                                            Please see {@see AdUnitServiceClient::networkName()} for help formatting this field.
 * @param string $formattedAdUnitParentAdUnit Immutable. The AdUnit's parent. Every ad unit has a parent except
 *                                            for the root ad unit, which is created by Google. Format:
 *                                            "networks/{network_code}/adUnits/{ad_unit_id}"
 *                                            Please see {@see AdUnitServiceClient::adUnitName()} for help formatting this field.
 * @param string $adUnitDisplayName           The display name of the ad unit. Its maximum length is 255
 *                                            characters.
 */
function create_ad_unit_sample(
    string $formattedParent,
    string $formattedAdUnitParentAdUnit,
    string $adUnitDisplayName
): void {
    // Create a client.
    $adUnitServiceClient = new AdUnitServiceClient();

    // Prepare the request message.
    $adUnit = (new AdUnit())
        ->setParentAdUnit($formattedAdUnitParentAdUnit)
        ->setDisplayName($adUnitDisplayName);
    $request = (new CreateAdUnitRequest())
        ->setParent($formattedParent)
        ->setAdUnit($adUnit);

    // Call the API and handle any network failures.
    try {
        /** @var AdUnit $response */
        $response = $adUnitServiceClient->createAdUnit($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 = AdUnitServiceClient::networkName('[NETWORK_CODE]');
    $formattedAdUnitParentAdUnit = AdUnitServiceClient::adUnitName('[NETWORK_CODE]', '[AD_UNIT]');
    $adUnitDisplayName = '[DISPLAY_NAME]';

    create_ad_unit_sample($formattedParent, $formattedAdUnitParentAdUnit, $adUnitDisplayName);
}

use Google\Ads\AdManager\V1\AdUnit;
use Google\Ads\AdManager\V1\Client\AdUnitServiceClient;
use Google\Ads\AdManager\V1\GetAdUnitRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedName The resource name of the AdUnit.
 *                              Format: `networks/{network_code}/adUnits/{ad_unit_id}`
 *                              Please see {@see AdUnitServiceClient::adUnitName()} for help formatting this field.
 */
function get_ad_unit_sample(string $formattedName): void
{
    // Create a client.
    $adUnitServiceClient = new AdUnitServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var AdUnit $response */
        $response = $adUnitServiceClient->getAdUnit($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 = AdUnitServiceClient::adUnitName('[NETWORK_CODE]', '[AD_UNIT]');

    get_ad_unit_sample($formattedName);
}

use Google\Ads\AdManager\V1\Client\AdUnitServiceClient;
use Google\Ads\AdManager\V1\ListAdUnitSizesRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;

/**
 * @param string $formattedParent The parent, which owns this collection of AdUnitSizes.
 *                                Format: `networks/{network_code}`
 *                                Please see {@see AdUnitServiceClient::networkName()} for help formatting this field.
 */
function list_ad_unit_sizes_sample(string $formattedParent): void
{
    // Create a client.
    $adUnitServiceClient = new AdUnitServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $adUnitServiceClient->listAdUnitSizes($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 = AdUnitServiceClient::networkName('[NETWORK_CODE]');

    list_ad_unit_sizes_sample($formattedParent);
}

use Google\Ads\AdManager\V1\Client\AdUnitServiceClient;
use Google\Ads\AdManager\V1\ListAdUnitsRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;

/**
 * @param string $formattedParent The parent, which owns this collection of AdUnits.
 *                                Format: `networks/{network_code}`
 *                                Please see {@see AdUnitServiceClient::networkName()} for help formatting this field.
 */
function list_ad_units_sample(string $formattedParent): void
{
    // Create a client.
    $adUnitServiceClient = new AdUnitServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $adUnitServiceClient->listAdUnits($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 = AdUnitServiceClient::networkName('[NETWORK_CODE]');

    list_ad_units_sample($formattedParent);
}

use Google\Ads\AdManager\V1\AdUnit;
use Google\Ads\AdManager\V1\Client\AdUnitServiceClient;
use Google\Ads\AdManager\V1\UpdateAdUnitRequest;
use Google\ApiCore\ApiException;
use Google\Protobuf\FieldMask;

/**
 * @param string $formattedAdUnitParentAdUnit Immutable. The AdUnit's parent. Every ad unit has a parent except
 *                                            for the root ad unit, which is created by Google. Format:
 *                                            "networks/{network_code}/adUnits/{ad_unit_id}"
 *                                            Please see {@see AdUnitServiceClient::adUnitName()} for help formatting this field.
 * @param string $adUnitDisplayName           The display name of the ad unit. Its maximum length is 255
 *                                            characters.
 */
function update_ad_unit_sample(
    string $formattedAdUnitParentAdUnit,
    string $adUnitDisplayName
): void {
    // Create a client.
    $adUnitServiceClient = new AdUnitServiceClient();

    // Prepare the request message.
    $adUnit = (new AdUnit())
        ->setParentAdUnit($formattedAdUnitParentAdUnit)
        ->setDisplayName($adUnitDisplayName);
    $updateMask = new FieldMask();
    $request = (new UpdateAdUnitRequest())
        ->setAdUnit($adUnit)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var AdUnit $response */
        $response = $adUnitServiceClient->updateAdUnit($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
{
    $formattedAdUnitParentAdUnit = AdUnitServiceClient::adUnitName('[NETWORK_CODE]', '[AD_UNIT]');
    $adUnitDisplayName = '[DISPLAY_NAME]';

    update_ad_unit_sample($formattedAdUnitParentAdUnit, $adUnitDisplayName);
}