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

use Google\Ads\AdManager\V1\BatchCreateBreakTemplatesRequest;
use Google\Ads\AdManager\V1\BatchCreateBreakTemplatesResponse;
use Google\Ads\AdManager\V1\BreakTemplate;
use Google\Ads\AdManager\V1\Client\BreakTemplateServiceClient;
use Google\Ads\AdManager\V1\CreateBreakTemplateRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent         The parent resource where `BreakTemplates` will be created.
 *                                        Format: `networks/{network_code}`
 *                                        The parent field in the `CreateBreakTemplateRequest` must match this
 *                                        field. Please see
 *                                        {@see BreakTemplateServiceClient::networkName()} for help formatting this field.
 * @param string $formattedRequestsParent The parent resource where this `BreakTemplate` will be created.
 *                                        Format: `networks/{network_code}`
 *                                        Please see {@see BreakTemplateServiceClient::networkName()} for help formatting this field.
 */
function batch_create_break_templates_sample(
    string $formattedParent,
    string $formattedRequestsParent
): void {
    // Create a client.
    $breakTemplateServiceClient = new BreakTemplateServiceClient();

    // Prepare the request message.
    $requestsBreakTemplate = new BreakTemplate();
    $createBreakTemplateRequest = (new CreateBreakTemplateRequest())
        ->setParent($formattedRequestsParent)
        ->setBreakTemplate($requestsBreakTemplate);
    $requests = [$createBreakTemplateRequest,];
    $request = (new BatchCreateBreakTemplatesRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchCreateBreakTemplatesResponse $response */
        $response = $breakTemplateServiceClient->batchCreateBreakTemplates($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 = BreakTemplateServiceClient::networkName('[NETWORK_CODE]');
    $formattedRequestsParent = BreakTemplateServiceClient::networkName('[NETWORK_CODE]');

    batch_create_break_templates_sample($formattedParent, $formattedRequestsParent);
}

use Google\Ads\AdManager\V1\BatchUpdateBreakTemplatesRequest;
use Google\Ads\AdManager\V1\BatchUpdateBreakTemplatesResponse;
use Google\Ads\AdManager\V1\BreakTemplate;
use Google\Ads\AdManager\V1\Client\BreakTemplateServiceClient;
use Google\Ads\AdManager\V1\UpdateBreakTemplateRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent The parent resource where `BreakTemplates` will be updated.
 *                                Format: `networks/{network_code}`
 *                                The parent field in the `UpdateBreakTemplateRequest` must match this
 *                                field. Please see
 *                                {@see BreakTemplateServiceClient::networkName()} for help formatting this field.
 */
function batch_update_break_templates_sample(string $formattedParent): void
{
    // Create a client.
    $breakTemplateServiceClient = new BreakTemplateServiceClient();

    // Prepare the request message.
    $requestsBreakTemplate = new BreakTemplate();
    $updateBreakTemplateRequest = (new UpdateBreakTemplateRequest())
        ->setBreakTemplate($requestsBreakTemplate);
    $requests = [$updateBreakTemplateRequest,];
    $request = (new BatchUpdateBreakTemplatesRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

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

    batch_update_break_templates_sample($formattedParent);
}

use Google\Ads\AdManager\V1\BreakTemplate;
use Google\Ads\AdManager\V1\Client\BreakTemplateServiceClient;
use Google\Ads\AdManager\V1\CreateBreakTemplateRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent The parent resource where this `BreakTemplate` will be created.
 *                                Format: `networks/{network_code}`
 *                                Please see {@see BreakTemplateServiceClient::networkName()} for help formatting this field.
 */
function create_break_template_sample(string $formattedParent): void
{
    // Create a client.
    $breakTemplateServiceClient = new BreakTemplateServiceClient();

    // Prepare the request message.
    $breakTemplate = new BreakTemplate();
    $request = (new CreateBreakTemplateRequest())
        ->setParent($formattedParent)
        ->setBreakTemplate($breakTemplate);

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

    create_break_template_sample($formattedParent);
}

use Google\Ads\AdManager\V1\BreakTemplate;
use Google\Ads\AdManager\V1\Client\BreakTemplateServiceClient;
use Google\Ads\AdManager\V1\GetBreakTemplateRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedName The resource name of the `BreakTemplate`.
 *                              Format: `networks/{network_code}/breakTemplates/{break_template_id}`
 *                              Please see {@see BreakTemplateServiceClient::breakTemplateName()} for help formatting this field.
 */
function get_break_template_sample(string $formattedName): void
{
    // Create a client.
    $breakTemplateServiceClient = new BreakTemplateServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var BreakTemplate $response */
        $response = $breakTemplateServiceClient->getBreakTemplate($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 = BreakTemplateServiceClient::breakTemplateName(
        '[NETWORK_CODE]',
        '[BREAK_TEMPLATE]'
    );

    get_break_template_sample($formattedName);
}

use Google\Ads\AdManager\V1\Client\BreakTemplateServiceClient;
use Google\Ads\AdManager\V1\ListBreakTemplatesRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;

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

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

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

    list_break_templates_sample($formattedParent);
}

use Google\Ads\AdManager\V1\BreakTemplate;
use Google\Ads\AdManager\V1\Client\BreakTemplateServiceClient;
use Google\Ads\AdManager\V1\UpdateBreakTemplateRequest;
use Google\ApiCore\ApiException;

/**
 * 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_break_template_sample(): void
{
    // Create a client.
    $breakTemplateServiceClient = new BreakTemplateServiceClient();

    // Prepare the request message.
    $breakTemplate = new BreakTemplate();
    $request = (new UpdateBreakTemplateRequest())
        ->setBreakTemplate($breakTemplate);

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