Google Ads Ad Manager V1 Client - Class PlacementServiceClient (0.5.0)

use Google\Ads\AdManager\V1\BatchActivatePlacementsRequest;
use Google\Ads\AdManager\V1\BatchActivatePlacementsResponse;
use Google\Ads\AdManager\V1\Client\PlacementServiceClient;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent       Format: `networks/{network_code}`
 *                                      Please see {@see PlacementServiceClient::networkName()} for help formatting this field.
 * @param string $formattedNamesElement The names of the `Placement` objects to activate.
 *                                      Format: `networks/{network_code}/placements/{placement_id}`
 *                                      Please see {@see PlacementServiceClient::placementName()} for help formatting this field.
 */
function batch_activate_placements_sample(
    string $formattedParent,
    string $formattedNamesElement
): void {
    // Create a client.
    $placementServiceClient = new PlacementServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var BatchActivatePlacementsResponse $response */
        $response = $placementServiceClient->batchActivatePlacements($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 = PlacementServiceClient::networkName('[NETWORK_CODE]');
    $formattedNamesElement = PlacementServiceClient::placementName('[NETWORK_CODE]', '[PLACEMENT]');

    batch_activate_placements_sample($formattedParent, $formattedNamesElement);
}

use Google\Ads\AdManager\V1\BatchArchivePlacementsRequest;
use Google\Ads\AdManager\V1\BatchArchivePlacementsResponse;
use Google\Ads\AdManager\V1\Client\PlacementServiceClient;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent       Format: `networks/{network_code}`
 *                                      Please see {@see PlacementServiceClient::networkName()} for help formatting this field.
 * @param string $formattedNamesElement The names of the `Placement` objects to archive.
 *                                      Format: `networks/{network_code}/placements/{placement_id}`
 *                                      Please see {@see PlacementServiceClient::placementName()} for help formatting this field.
 */
function batch_archive_placements_sample(
    string $formattedParent,
    string $formattedNamesElement
): void {
    // Create a client.
    $placementServiceClient = new PlacementServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var BatchArchivePlacementsResponse $response */
        $response = $placementServiceClient->batchArchivePlacements($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 = PlacementServiceClient::networkName('[NETWORK_CODE]');
    $formattedNamesElement = PlacementServiceClient::placementName('[NETWORK_CODE]', '[PLACEMENT]');

    batch_archive_placements_sample($formattedParent, $formattedNamesElement);
}

use Google\Ads\AdManager\V1\BatchCreatePlacementsRequest;
use Google\Ads\AdManager\V1\BatchCreatePlacementsResponse;
use Google\Ads\AdManager\V1\Client\PlacementServiceClient;
use Google\Ads\AdManager\V1\CreatePlacementRequest;
use Google\Ads\AdManager\V1\Placement;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent              The parent resource where the `Placement`s will be created.
 *                                             Format: `networks/{network_code}`
 *                                             The parent field in the CreatePlacementRequest messages match this
 *                                             field. Please see
 *                                             {@see PlacementServiceClient::networkName()} for help formatting this field.
 * @param string $formattedRequestsParent      The parent resource where this `Placement` will be created.
 *                                             Format: `networks/{network_code}`
 *                                             Please see {@see PlacementServiceClient::networkName()} for help formatting this field.
 * @param string $requestsPlacementDisplayName The display name of the placement. This attribute has a maximum
 *                                             length of 255 characters.
 */
function batch_create_placements_sample(
    string $formattedParent,
    string $formattedRequestsParent,
    string $requestsPlacementDisplayName
): void {
    // Create a client.
    $placementServiceClient = new PlacementServiceClient();

    // Prepare the request message.
    $requestsPlacement = (new Placement())
        ->setDisplayName($requestsPlacementDisplayName);
    $createPlacementRequest = (new CreatePlacementRequest())
        ->setParent($formattedRequestsParent)
        ->setPlacement($requestsPlacement);
    $requests = [$createPlacementRequest,];
    $request = (new BatchCreatePlacementsRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchCreatePlacementsResponse $response */
        $response = $placementServiceClient->batchCreatePlacements($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 = PlacementServiceClient::networkName('[NETWORK_CODE]');
    $formattedRequestsParent = PlacementServiceClient::networkName('[NETWORK_CODE]');
    $requestsPlacementDisplayName = '[DISPLAY_NAME]';

    batch_create_placements_sample(
        $formattedParent,
        $formattedRequestsParent,
        $requestsPlacementDisplayName
    );
}

use Google\Ads\AdManager\V1\BatchDeactivatePlacementsRequest;
use Google\Ads\AdManager\V1\BatchDeactivatePlacementsResponse;
use Google\Ads\AdManager\V1\Client\PlacementServiceClient;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent       Format: `networks/{network_code}`
 *                                      Please see {@see PlacementServiceClient::networkName()} for help formatting this field.
 * @param string $formattedNamesElement The names of the `Placement` objects to deactivate.
 *                                      Format: `networks/{network_code}/placements/{placement_id}`
 *                                      Please see {@see PlacementServiceClient::placementName()} for help formatting this field.
 */
function batch_deactivate_placements_sample(
    string $formattedParent,
    string $formattedNamesElement
): void {
    // Create a client.
    $placementServiceClient = new PlacementServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var BatchDeactivatePlacementsResponse $response */
        $response = $placementServiceClient->batchDeactivatePlacements($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 = PlacementServiceClient::networkName('[NETWORK_CODE]');
    $formattedNamesElement = PlacementServiceClient::placementName('[NETWORK_CODE]', '[PLACEMENT]');

    batch_deactivate_placements_sample($formattedParent, $formattedNamesElement);
}

use Google\Ads\AdManager\V1\BatchUpdatePlacementsRequest;
use Google\Ads\AdManager\V1\BatchUpdatePlacementsResponse;
use Google\Ads\AdManager\V1\Client\PlacementServiceClient;
use Google\Ads\AdManager\V1\Placement;
use Google\Ads\AdManager\V1\UpdatePlacementRequest;
use Google\ApiCore\ApiException;
use Google\Protobuf\FieldMask;

/**
 * @param string $formattedParent              The parent resource where `Placements` will be updated.
 *                                             Format: `networks/{network_code}`
 *                                             The parent field in the UpdatePlacementsRequest must match this
 *                                             field. Please see
 *                                             {@see PlacementServiceClient::networkName()} for help formatting this field.
 * @param string $requestsPlacementDisplayName The display name of the placement. This attribute has a maximum
 *                                             length of 255 characters.
 */
function batch_update_placements_sample(
    string $formattedParent,
    string $requestsPlacementDisplayName
): void {
    // Create a client.
    $placementServiceClient = new PlacementServiceClient();

    // Prepare the request message.
    $requestsPlacement = (new Placement())
        ->setDisplayName($requestsPlacementDisplayName);
    $requestsUpdateMask = new FieldMask();
    $updatePlacementRequest = (new UpdatePlacementRequest())
        ->setPlacement($requestsPlacement)
        ->setUpdateMask($requestsUpdateMask);
    $requests = [$updatePlacementRequest,];
    $request = (new BatchUpdatePlacementsRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchUpdatePlacementsResponse $response */
        $response = $placementServiceClient->batchUpdatePlacements($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 = PlacementServiceClient::networkName('[NETWORK_CODE]');
    $requestsPlacementDisplayName = '[DISPLAY_NAME]';

    batch_update_placements_sample($formattedParent, $requestsPlacementDisplayName);
}

use Google\Ads\AdManager\V1\Client\PlacementServiceClient;
use Google\Ads\AdManager\V1\CreatePlacementRequest;
use Google\Ads\AdManager\V1\Placement;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent      The parent resource where this `Placement` will be created.
 *                                     Format: `networks/{network_code}`
 *                                     Please see {@see PlacementServiceClient::networkName()} for help formatting this field.
 * @param string $placementDisplayName The display name of the placement. This attribute has a maximum
 *                                     length of 255 characters.
 */
function create_placement_sample(string $formattedParent, string $placementDisplayName): void
{
    // Create a client.
    $placementServiceClient = new PlacementServiceClient();

    // Prepare the request message.
    $placement = (new Placement())
        ->setDisplayName($placementDisplayName);
    $request = (new CreatePlacementRequest())
        ->setParent($formattedParent)
        ->setPlacement($placement);

    // Call the API and handle any network failures.
    try {
        /** @var Placement $response */
        $response = $placementServiceClient->createPlacement($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 = PlacementServiceClient::networkName('[NETWORK_CODE]');
    $placementDisplayName = '[DISPLAY_NAME]';

    create_placement_sample($formattedParent, $placementDisplayName);
}

use Google\Ads\AdManager\V1\Client\PlacementServiceClient;
use Google\Ads\AdManager\V1\GetPlacementRequest;
use Google\Ads\AdManager\V1\Placement;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedName The resource name of the Placement.
 *                              Format: `networks/{network_code}/placements/{placement_id}`
 *                              Please see {@see PlacementServiceClient::placementName()} for help formatting this field.
 */
function get_placement_sample(string $formattedName): void
{
    // Create a client.
    $placementServiceClient = new PlacementServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Placement $response */
        $response = $placementServiceClient->getPlacement($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 = PlacementServiceClient::placementName('[NETWORK_CODE]', '[PLACEMENT]');

    get_placement_sample($formattedName);
}

use Google\Ads\AdManager\V1\Client\PlacementServiceClient;
use Google\Ads\AdManager\V1\ListPlacementsRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;

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

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

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

    list_placements_sample($formattedParent);
}

use Google\Ads\AdManager\V1\Client\PlacementServiceClient;
use Google\Ads\AdManager\V1\Placement;
use Google\Ads\AdManager\V1\UpdatePlacementRequest;
use Google\ApiCore\ApiException;
use Google\Protobuf\FieldMask;

/**
 * @param string $placementDisplayName The display name of the placement. This attribute has a maximum
 *                                     length of 255 characters.
 */
function update_placement_sample(string $placementDisplayName): void
{
    // Create a client.
    $placementServiceClient = new PlacementServiceClient();

    // Prepare the request message.
    $placement = (new Placement())
        ->setDisplayName($placementDisplayName);
    $updateMask = new FieldMask();
    $request = (new UpdatePlacementRequest())
        ->setPlacement($placement)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var Placement $response */
        $response = $placementServiceClient->updatePlacement($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
{
    $placementDisplayName = '[DISPLAY_NAME]';

    update_placement_sample($placementDisplayName);
}