Google Ads Ad Manager V1 Client - Class DaiEncodingProfileServiceClient (0.14.1)

use Google\Ads\AdManager\V1\ActivateDaiEncodingProfileRequest;
use Google\Ads\AdManager\V1\BatchActivateDaiEncodingProfilesRequest;
use Google\Ads\AdManager\V1\BatchActivateDaiEncodingProfilesResponse;
use Google\Ads\AdManager\V1\Client\DaiEncodingProfileServiceClient;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent       Format: `networks/{network_code}`
 *                                      Please see {@see DaiEncodingProfileServiceClient::networkName()} for help formatting this field.
 * @param string $formattedRequestsName The resource name of the DaiEncodingProfile to activate.
 *                                      Format:
 *                                      `networks/{network_code}/daiEncodingProfiles/{dai_encoding_profile_id}`
 *                                      Please see {@see DaiEncodingProfileServiceClient::daiEncodingProfileName()} for help formatting this field.
 */
function batch_activate_dai_encoding_profiles_sample(
    string $formattedParent,
    string $formattedRequestsName
): void {
    // Create a client.
    $daiEncodingProfileServiceClient = new DaiEncodingProfileServiceClient();

    // Prepare the request message.
    $activateDaiEncodingProfileRequest = (new ActivateDaiEncodingProfileRequest())
        ->setName($formattedRequestsName);
    $requests = [$activateDaiEncodingProfileRequest,];
    $request = (new BatchActivateDaiEncodingProfilesRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchActivateDaiEncodingProfilesResponse $response */
        $response = $daiEncodingProfileServiceClient->batchActivateDaiEncodingProfiles($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 = DaiEncodingProfileServiceClient::networkName('[NETWORK_CODE]');
    $formattedRequestsName = DaiEncodingProfileServiceClient::daiEncodingProfileName(
        '[NETWORK_CODE]',
        '[DAI_ENCODING_PROFILE]'
    );

    batch_activate_dai_encoding_profiles_sample($formattedParent, $formattedRequestsName);
}

use Google\Ads\AdManager\V1\ArchiveDaiEncodingProfileRequest;
use Google\Ads\AdManager\V1\BatchArchiveDaiEncodingProfilesRequest;
use Google\Ads\AdManager\V1\BatchArchiveDaiEncodingProfilesResponse;
use Google\Ads\AdManager\V1\Client\DaiEncodingProfileServiceClient;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent       Format: `networks/{network_code}`
 *                                      Please see {@see DaiEncodingProfileServiceClient::networkName()} for help formatting this field.
 * @param string $formattedRequestsName The resource name of the DaiEncodingProfile to archive.
 *                                      Format:
 *                                      `networks/{network_code}/daiEncodingProfiles/{dai_encoding_profile_id}`
 *                                      Please see {@see DaiEncodingProfileServiceClient::daiEncodingProfileName()} for help formatting this field.
 */
function batch_archive_dai_encoding_profiles_sample(
    string $formattedParent,
    string $formattedRequestsName
): void {
    // Create a client.
    $daiEncodingProfileServiceClient = new DaiEncodingProfileServiceClient();

    // Prepare the request message.
    $archiveDaiEncodingProfileRequest = (new ArchiveDaiEncodingProfileRequest())
        ->setName($formattedRequestsName);
    $requests = [$archiveDaiEncodingProfileRequest,];
    $request = (new BatchArchiveDaiEncodingProfilesRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchArchiveDaiEncodingProfilesResponse $response */
        $response = $daiEncodingProfileServiceClient->batchArchiveDaiEncodingProfiles($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 = DaiEncodingProfileServiceClient::networkName('[NETWORK_CODE]');
    $formattedRequestsName = DaiEncodingProfileServiceClient::daiEncodingProfileName(
        '[NETWORK_CODE]',
        '[DAI_ENCODING_PROFILE]'
    );

    batch_archive_dai_encoding_profiles_sample($formattedParent, $formattedRequestsName);
}

use Google\Ads\AdManager\V1\BatchCreateDaiEncodingProfilesRequest;
use Google\Ads\AdManager\V1\BatchCreateDaiEncodingProfilesResponse;
use Google\Ads\AdManager\V1\Client\DaiEncodingProfileServiceClient;
use Google\Ads\AdManager\V1\ContainerTypeEnum\ContainerType;
use Google\Ads\AdManager\V1\CreateDaiEncodingProfileRequest;
use Google\Ads\AdManager\V1\DaiEncodingProfile;
use Google\Ads\AdManager\V1\DaiEncodingProfileVariantTypeEnum\DaiEncodingProfileVariantType;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent                         The parent resource where `DaiEncodingProfiles` will be created.
 *                                                        Format: `networks/{network_code}`
 *                                                        The parent field in the CreateDaiEncodingProfileRequest must match this
 *                                                        field. Please see
 *                                                        {@see DaiEncodingProfileServiceClient::networkName()} for help formatting this field.
 * @param string $formattedRequestsParent                 The parent resource where this `DaiEncodingProfile` will be
 *                                                        created. Format: `networks/{network_code}`
 *                                                        Please see {@see DaiEncodingProfileServiceClient::networkName()} for help formatting this field.
 * @param string $requestsDaiEncodingProfileDisplayName   The name of the DaiEncodingProfile. It may be at most 64
 *                                                        characters. The name field can contain alphanumeric characters and symbols
 *                                                        other than the following: ", ', =, !, +, #, , ~, ;, ^, (, ), <, >, [, ],
 *                                                        the white space character.
 * @param int    $requestsDaiEncodingProfileVariantType   The variant playlist type that this DaiEncodingProfile
 *                                                        represents.
 * @param int    $requestsDaiEncodingProfileContainerType The digital container type of the underlying media. This is
 *                                                        required for MEDIA and IFRAME variant types.
 */
function batch_create_dai_encoding_profiles_sample(
    string $formattedParent,
    string $formattedRequestsParent,
    string $requestsDaiEncodingProfileDisplayName,
    int $requestsDaiEncodingProfileVariantType,
    int $requestsDaiEncodingProfileContainerType
): void {
    // Create a client.
    $daiEncodingProfileServiceClient = new DaiEncodingProfileServiceClient();

    // Prepare the request message.
    $requestsDaiEncodingProfile = (new DaiEncodingProfile())
        ->setDisplayName($requestsDaiEncodingProfileDisplayName)
        ->setVariantType($requestsDaiEncodingProfileVariantType)
        ->setContainerType($requestsDaiEncodingProfileContainerType);
    $createDaiEncodingProfileRequest = (new CreateDaiEncodingProfileRequest())
        ->setParent($formattedRequestsParent)
        ->setDaiEncodingProfile($requestsDaiEncodingProfile);
    $requests = [$createDaiEncodingProfileRequest,];
    $request = (new BatchCreateDaiEncodingProfilesRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchCreateDaiEncodingProfilesResponse $response */
        $response = $daiEncodingProfileServiceClient->batchCreateDaiEncodingProfiles($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 = DaiEncodingProfileServiceClient::networkName('[NETWORK_CODE]');
    $formattedRequestsParent = DaiEncodingProfileServiceClient::networkName('[NETWORK_CODE]');
    $requestsDaiEncodingProfileDisplayName = '[DISPLAY_NAME]';
    $requestsDaiEncodingProfileVariantType = DaiEncodingProfileVariantType::DAI_ENCODING_PROFILE_VARIANT_TYPE_UNSPECIFIED;
    $requestsDaiEncodingProfileContainerType = ContainerType::CONTAINER_TYPE_UNSPECIFIED;

    batch_create_dai_encoding_profiles_sample(
        $formattedParent,
        $formattedRequestsParent,
        $requestsDaiEncodingProfileDisplayName,
        $requestsDaiEncodingProfileVariantType,
        $requestsDaiEncodingProfileContainerType
    );
}

use Google\Ads\AdManager\V1\BatchUpdateDaiEncodingProfilesRequest;
use Google\Ads\AdManager\V1\BatchUpdateDaiEncodingProfilesResponse;
use Google\Ads\AdManager\V1\Client\DaiEncodingProfileServiceClient;
use Google\Ads\AdManager\V1\ContainerTypeEnum\ContainerType;
use Google\Ads\AdManager\V1\DaiEncodingProfile;
use Google\Ads\AdManager\V1\DaiEncodingProfileVariantTypeEnum\DaiEncodingProfileVariantType;
use Google\Ads\AdManager\V1\UpdateDaiEncodingProfileRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent                         The parent resource where `DaiEncodingProfiles` will be updated.
 *                                                        Format: `networks/{network_code}`
 *                                                        The parent field in the UpdateDaiEncodingProfileRequest must match this
 *                                                        field. Please see
 *                                                        {@see DaiEncodingProfileServiceClient::networkName()} for help formatting this field.
 * @param string $requestsDaiEncodingProfileDisplayName   The name of the DaiEncodingProfile. It may be at most 64
 *                                                        characters. The name field can contain alphanumeric characters and symbols
 *                                                        other than the following: ", ', =, !, +, #, , ~, ;, ^, (, ), <, >, [, ],
 *                                                        the white space character.
 * @param int    $requestsDaiEncodingProfileVariantType   The variant playlist type that this DaiEncodingProfile
 *                                                        represents.
 * @param int    $requestsDaiEncodingProfileContainerType The digital container type of the underlying media. This is
 *                                                        required for MEDIA and IFRAME variant types.
 */
function batch_update_dai_encoding_profiles_sample(
    string $formattedParent,
    string $requestsDaiEncodingProfileDisplayName,
    int $requestsDaiEncodingProfileVariantType,
    int $requestsDaiEncodingProfileContainerType
): void {
    // Create a client.
    $daiEncodingProfileServiceClient = new DaiEncodingProfileServiceClient();

    // Prepare the request message.
    $requestsDaiEncodingProfile = (new DaiEncodingProfile())
        ->setDisplayName($requestsDaiEncodingProfileDisplayName)
        ->setVariantType($requestsDaiEncodingProfileVariantType)
        ->setContainerType($requestsDaiEncodingProfileContainerType);
    $updateDaiEncodingProfileRequest = (new UpdateDaiEncodingProfileRequest())
        ->setDaiEncodingProfile($requestsDaiEncodingProfile);
    $requests = [$updateDaiEncodingProfileRequest,];
    $request = (new BatchUpdateDaiEncodingProfilesRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchUpdateDaiEncodingProfilesResponse $response */
        $response = $daiEncodingProfileServiceClient->batchUpdateDaiEncodingProfiles($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 = DaiEncodingProfileServiceClient::networkName('[NETWORK_CODE]');
    $requestsDaiEncodingProfileDisplayName = '[DISPLAY_NAME]';
    $requestsDaiEncodingProfileVariantType = DaiEncodingProfileVariantType::DAI_ENCODING_PROFILE_VARIANT_TYPE_UNSPECIFIED;
    $requestsDaiEncodingProfileContainerType = ContainerType::CONTAINER_TYPE_UNSPECIFIED;

    batch_update_dai_encoding_profiles_sample(
        $formattedParent,
        $requestsDaiEncodingProfileDisplayName,
        $requestsDaiEncodingProfileVariantType,
        $requestsDaiEncodingProfileContainerType
    );
}

use Google\Ads\AdManager\V1\Client\DaiEncodingProfileServiceClient;
use Google\Ads\AdManager\V1\ContainerTypeEnum\ContainerType;
use Google\Ads\AdManager\V1\CreateDaiEncodingProfileRequest;
use Google\Ads\AdManager\V1\DaiEncodingProfile;
use Google\Ads\AdManager\V1\DaiEncodingProfileVariantTypeEnum\DaiEncodingProfileVariantType;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent                 The parent resource where this `DaiEncodingProfile` will be
 *                                                created. Format: `networks/{network_code}`
 *                                                Please see {@see DaiEncodingProfileServiceClient::networkName()} for help formatting this field.
 * @param string $daiEncodingProfileDisplayName   The name of the DaiEncodingProfile. It may be at most 64
 *                                                characters. The name field can contain alphanumeric characters and symbols
 *                                                other than the following: ", ', =, !, +, #, , ~, ;, ^, (, ), <, >, [, ],
 *                                                the white space character.
 * @param int    $daiEncodingProfileVariantType   The variant playlist type that this DaiEncodingProfile
 *                                                represents.
 * @param int    $daiEncodingProfileContainerType The digital container type of the underlying media. This is
 *                                                required for MEDIA and IFRAME variant types.
 */
function create_dai_encoding_profile_sample(
    string $formattedParent,
    string $daiEncodingProfileDisplayName,
    int $daiEncodingProfileVariantType,
    int $daiEncodingProfileContainerType
): void {
    // Create a client.
    $daiEncodingProfileServiceClient = new DaiEncodingProfileServiceClient();

    // Prepare the request message.
    $daiEncodingProfile = (new DaiEncodingProfile())
        ->setDisplayName($daiEncodingProfileDisplayName)
        ->setVariantType($daiEncodingProfileVariantType)
        ->setContainerType($daiEncodingProfileContainerType);
    $request = (new CreateDaiEncodingProfileRequest())
        ->setParent($formattedParent)
        ->setDaiEncodingProfile($daiEncodingProfile);

    // Call the API and handle any network failures.
    try {
        /** @var DaiEncodingProfile $response */
        $response = $daiEncodingProfileServiceClient->createDaiEncodingProfile($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 = DaiEncodingProfileServiceClient::networkName('[NETWORK_CODE]');
    $daiEncodingProfileDisplayName = '[DISPLAY_NAME]';
    $daiEncodingProfileVariantType = DaiEncodingProfileVariantType::DAI_ENCODING_PROFILE_VARIANT_TYPE_UNSPECIFIED;
    $daiEncodingProfileContainerType = ContainerType::CONTAINER_TYPE_UNSPECIFIED;

    create_dai_encoding_profile_sample(
        $formattedParent,
        $daiEncodingProfileDisplayName,
        $daiEncodingProfileVariantType,
        $daiEncodingProfileContainerType
    );
}

use Google\Ads\AdManager\V1\Client\DaiEncodingProfileServiceClient;
use Google\Ads\AdManager\V1\DaiEncodingProfile;
use Google\Ads\AdManager\V1\GetDaiEncodingProfileRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedName The resource name of the DaiEncodingProfile.
 *                              Format:
 *                              `networks/{network_code}/daiEncodingProfiles/{dai_encoding_profile_id}`
 *                              Please see {@see DaiEncodingProfileServiceClient::daiEncodingProfileName()} for help formatting this field.
 */
function get_dai_encoding_profile_sample(string $formattedName): void
{
    // Create a client.
    $daiEncodingProfileServiceClient = new DaiEncodingProfileServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var DaiEncodingProfile $response */
        $response = $daiEncodingProfileServiceClient->getDaiEncodingProfile($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 = DaiEncodingProfileServiceClient::daiEncodingProfileName(
        '[NETWORK_CODE]',
        '[DAI_ENCODING_PROFILE]'
    );

    get_dai_encoding_profile_sample($formattedName);
}

use Google\Ads\AdManager\V1\Client\DaiEncodingProfileServiceClient;
use Google\Ads\AdManager\V1\ListDaiEncodingProfilesRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;

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

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

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

    list_dai_encoding_profiles_sample($formattedParent);
}

use Google\Ads\AdManager\V1\Client\DaiEncodingProfileServiceClient;
use Google\Ads\AdManager\V1\ContainerTypeEnum\ContainerType;
use Google\Ads\AdManager\V1\DaiEncodingProfile;
use Google\Ads\AdManager\V1\DaiEncodingProfileVariantTypeEnum\DaiEncodingProfileVariantType;
use Google\Ads\AdManager\V1\UpdateDaiEncodingProfileRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $daiEncodingProfileDisplayName   The name of the DaiEncodingProfile. It may be at most 64
 *                                                characters. The name field can contain alphanumeric characters and symbols
 *                                                other than the following: ", ', =, !, +, #, , ~, ;, ^, (, ), <, >, [, ],
 *                                                the white space character.
 * @param int    $daiEncodingProfileVariantType   The variant playlist type that this DaiEncodingProfile
 *                                                represents.
 * @param int    $daiEncodingProfileContainerType The digital container type of the underlying media. This is
 *                                                required for MEDIA and IFRAME variant types.
 */
function update_dai_encoding_profile_sample(
    string $daiEncodingProfileDisplayName,
    int $daiEncodingProfileVariantType,
    int $daiEncodingProfileContainerType
): void {
    // Create a client.
    $daiEncodingProfileServiceClient = new DaiEncodingProfileServiceClient();

    // Prepare the request message.
    $daiEncodingProfile = (new DaiEncodingProfile())
        ->setDisplayName($daiEncodingProfileDisplayName)
        ->setVariantType($daiEncodingProfileVariantType)
        ->setContainerType($daiEncodingProfileContainerType);
    $request = (new UpdateDaiEncodingProfileRequest())
        ->setDaiEncodingProfile($daiEncodingProfile);

    // Call the API and handle any network failures.
    try {
        /** @var DaiEncodingProfile $response */
        $response = $daiEncodingProfileServiceClient->updateDaiEncodingProfile($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
{
    $daiEncodingProfileDisplayName = '[DISPLAY_NAME]';
    $daiEncodingProfileVariantType = DaiEncodingProfileVariantType::DAI_ENCODING_PROFILE_VARIANT_TYPE_UNSPECIFIED;
    $daiEncodingProfileContainerType = ContainerType::CONTAINER_TYPE_UNSPECIFIED;

    update_dai_encoding_profile_sample(
        $daiEncodingProfileDisplayName,
        $daiEncodingProfileVariantType,
        $daiEncodingProfileContainerType
    );
}