Google Ads Ad Manager V1 Client - Class AdBreakServiceClient (0.3.1)

use Google\Ads\AdManager\V1\AdBreak;
use Google\Ads\AdManager\V1\Client\AdBreakServiceClient;
use Google\Ads\AdManager\V1\CreateAdBreakRequest;
use Google\ApiCore\ApiException;
use Google\Protobuf\Duration;

/**
 * @param string $formattedParent The parent resource where this `AdBreak` will be created
 *                                identified by an asset key or custom asset key.
 *
 *                                Formats:
 *                                `networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}`
 *                                `networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}`
 *                                Please see {@see AdBreakServiceClient::liveStreamEventName()} for help formatting this field.
 */
function create_ad_break_sample(string $formattedParent): void
{
    // Create a client.
    $adBreakServiceClient = new AdBreakServiceClient();

    // Prepare the request message.
    $adBreakDuration = new Duration();
    $adBreak = (new AdBreak())
        ->setDuration($adBreakDuration);
    $request = (new CreateAdBreakRequest())
        ->setParent($formattedParent)
        ->setAdBreak($adBreak);

    // Call the API and handle any network failures.
    try {
        /** @var AdBreak $response */
        $response = $adBreakServiceClient->createAdBreak($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 = AdBreakServiceClient::liveStreamEventName(
        '[NETWORK_CODE]',
        '[LIVE_STREAM_EVENT]'
    );

    create_ad_break_sample($formattedParent);
}

use Google\Ads\AdManager\V1\Client\AdBreakServiceClient;
use Google\Ads\AdManager\V1\DeleteAdBreakRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedName The name of the ad break to delete.
 *
 *                              Format:
 *                              `networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break}`
 *                              Please see {@see AdBreakServiceClient::adBreakName()} for help formatting this field.
 */
function delete_ad_break_sample(string $formattedName): void
{
    // Create a client.
    $adBreakServiceClient = new AdBreakServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $adBreakServiceClient->deleteAdBreak($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 = AdBreakServiceClient::adBreakName('[NETWORK_CODE]', '[ASSET_KEY]', '[AD_BREAK]');

    delete_ad_break_sample($formattedName);
}

use Google\Ads\AdManager\V1\AdBreak;
use Google\Ads\AdManager\V1\Client\AdBreakServiceClient;
use Google\Ads\AdManager\V1\GetAdBreakRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedName The resource name of the AdBreak using the asset key or custom
 *                              asset key.
 *
 *                              Format:
 *                              `networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break_id}`
 *                              `networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}/adBreaks/{ad_break_id}`
 *                              Please see {@see AdBreakServiceClient::adBreakName()} for help formatting this field.
 */
function get_ad_break_sample(string $formattedName): void
{
    // Create a client.
    $adBreakServiceClient = new AdBreakServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var AdBreak $response */
        $response = $adBreakServiceClient->getAdBreak($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 = AdBreakServiceClient::adBreakName('[NETWORK_CODE]', '[ASSET_KEY]', '[AD_BREAK]');

    get_ad_break_sample($formattedName);
}

use Google\Ads\AdManager\V1\Client\AdBreakServiceClient;
use Google\Ads\AdManager\V1\ListAdBreaksRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;

/**
 * @param string $formattedParent The parent, which owns this collection of AdBreaks.
 *
 *                                Formats:
 *                                `networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}`
 *                                `networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}`
 *                                Please see {@see AdBreakServiceClient::liveStreamEventName()} for help formatting this field.
 */
function list_ad_breaks_sample(string $formattedParent): void
{
    // Create a client.
    $adBreakServiceClient = new AdBreakServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $adBreakServiceClient->listAdBreaks($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 = AdBreakServiceClient::liveStreamEventName(
        '[NETWORK_CODE]',
        '[LIVE_STREAM_EVENT]'
    );

    list_ad_breaks_sample($formattedParent);
}

use Google\Ads\AdManager\V1\AdBreak;
use Google\Ads\AdManager\V1\Client\AdBreakServiceClient;
use Google\Ads\AdManager\V1\UpdateAdBreakRequest;
use Google\ApiCore\ApiException;
use Google\Protobuf\Duration;
use Google\Protobuf\FieldMask;

/**
 * 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_ad_break_sample(): void
{
    // Create a client.
    $adBreakServiceClient = new AdBreakServiceClient();

    // Prepare the request message.
    $adBreakDuration = new Duration();
    $adBreak = (new AdBreak())
        ->setDuration($adBreakDuration);
    $updateMask = new FieldMask();
    $request = (new UpdateAdBreakRequest())
        ->setAdBreak($adBreak)
        ->setUpdateMask($updateMask);

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