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

use Google\Ads\AdManager\V1\BatchArchiveSlatesRequest;
use Google\Ads\AdManager\V1\BatchArchiveSlatesResponse;
use Google\Ads\AdManager\V1\Client\SlateServiceClient;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent       The parent resource containing the slates.
 *                                      Format: "networks/{network_code}"
 *                                      Please see {@see SlateServiceClient::networkName()} for help formatting this field.
 * @param string $formattedNamesElement The resource names of the slates to archive.
 *                                      Format: "networks/{network_code}/slates/{slate_id}"
 *                                      Please see {@see SlateServiceClient::slateName()} for help formatting this field.
 */
function batch_archive_slates_sample(string $formattedParent, string $formattedNamesElement): void
{
    // Create a client.
    $slateServiceClient = new SlateServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var BatchArchiveSlatesResponse $response */
        $response = $slateServiceClient->batchArchiveSlates($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 = SlateServiceClient::networkName('[NETWORK_CODE]');
    $formattedNamesElement = SlateServiceClient::slateName('[NETWORK_CODE]', '[SLATE]');

    batch_archive_slates_sample($formattedParent, $formattedNamesElement);
}

use Google\Ads\AdManager\V1\BatchCreateSlatesRequest;
use Google\Ads\AdManager\V1\BatchCreateSlatesResponse;
use Google\Ads\AdManager\V1\Client\SlateServiceClient;
use Google\Ads\AdManager\V1\CreateSlateRequest;
use Google\Ads\AdManager\V1\Slate;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent          The parent resource where `Slates` will be created.
 *                                         Format: `networks/{network_code}`
 *                                         The parent field in the CreateSlateRequest must match this
 *                                         field. Please see
 *                                         {@see SlateServiceClient::networkName()} for help formatting this field.
 * @param string $formattedRequestsParent  The parent resource where this `Slate` will be created.
 *                                         Format: `networks/{network_code}`
 *                                         Please see {@see SlateServiceClient::networkName()} for help formatting this field.
 * @param string $requestsSlateDisplayName The display name of the Slate. It has a maximum length of 255
 *                                         characters.
 */
function batch_create_slates_sample(
    string $formattedParent,
    string $formattedRequestsParent,
    string $requestsSlateDisplayName
): void {
    // Create a client.
    $slateServiceClient = new SlateServiceClient();

    // Prepare the request message.
    $requestsSlate = (new Slate())
        ->setDisplayName($requestsSlateDisplayName);
    $createSlateRequest = (new CreateSlateRequest())
        ->setParent($formattedRequestsParent)
        ->setSlate($requestsSlate);
    $requests = [$createSlateRequest,];
    $request = (new BatchCreateSlatesRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchCreateSlatesResponse $response */
        $response = $slateServiceClient->batchCreateSlates($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 = SlateServiceClient::networkName('[NETWORK_CODE]');
    $formattedRequestsParent = SlateServiceClient::networkName('[NETWORK_CODE]');
    $requestsSlateDisplayName = '[DISPLAY_NAME]';

    batch_create_slates_sample($formattedParent, $formattedRequestsParent, $requestsSlateDisplayName);
}

use Google\Ads\AdManager\V1\BatchUnarchiveSlatesRequest;
use Google\Ads\AdManager\V1\BatchUnarchiveSlatesResponse;
use Google\Ads\AdManager\V1\Client\SlateServiceClient;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent       The parent resource containing the slates.
 *                                      Format: "networks/{network_code}"
 *                                      Please see {@see SlateServiceClient::networkName()} for help formatting this field.
 * @param string $formattedNamesElement The resource names of the slates to unarchive.
 *                                      Format: "networks/{network_code}/slates/{slate_id}"
 *                                      Please see {@see SlateServiceClient::slateName()} for help formatting this field.
 */
function batch_unarchive_slates_sample(
    string $formattedParent,
    string $formattedNamesElement
): void {
    // Create a client.
    $slateServiceClient = new SlateServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var BatchUnarchiveSlatesResponse $response */
        $response = $slateServiceClient->batchUnarchiveSlates($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 = SlateServiceClient::networkName('[NETWORK_CODE]');
    $formattedNamesElement = SlateServiceClient::slateName('[NETWORK_CODE]', '[SLATE]');

    batch_unarchive_slates_sample($formattedParent, $formattedNamesElement);
}

use Google\Ads\AdManager\V1\BatchUpdateSlatesRequest;
use Google\Ads\AdManager\V1\BatchUpdateSlatesResponse;
use Google\Ads\AdManager\V1\Client\SlateServiceClient;
use Google\Ads\AdManager\V1\Slate;
use Google\Ads\AdManager\V1\UpdateSlateRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent          The parent resource where `Slates` will be updated.
 *                                         Format: `networks/{network_code}`
 *                                         The parent field in the UpdateSlateRequest must match this
 *                                         field. Please see
 *                                         {@see SlateServiceClient::networkName()} for help formatting this field.
 * @param string $requestsSlateDisplayName The display name of the Slate. It has a maximum length of 255
 *                                         characters.
 */
function batch_update_slates_sample(
    string $formattedParent,
    string $requestsSlateDisplayName
): void {
    // Create a client.
    $slateServiceClient = new SlateServiceClient();

    // Prepare the request message.
    $requestsSlate = (new Slate())
        ->setDisplayName($requestsSlateDisplayName);
    $updateSlateRequest = (new UpdateSlateRequest())
        ->setSlate($requestsSlate);
    $requests = [$updateSlateRequest,];
    $request = (new BatchUpdateSlatesRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchUpdateSlatesResponse $response */
        $response = $slateServiceClient->batchUpdateSlates($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 = SlateServiceClient::networkName('[NETWORK_CODE]');
    $requestsSlateDisplayName = '[DISPLAY_NAME]';

    batch_update_slates_sample($formattedParent, $requestsSlateDisplayName);
}

use Google\Ads\AdManager\V1\Client\SlateServiceClient;
use Google\Ads\AdManager\V1\CreateSlateRequest;
use Google\Ads\AdManager\V1\Slate;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent  The parent resource where this `Slate` will be created.
 *                                 Format: `networks/{network_code}`
 *                                 Please see {@see SlateServiceClient::networkName()} for help formatting this field.
 * @param string $slateDisplayName The display name of the Slate. It has a maximum length of 255
 *                                 characters.
 */
function create_slate_sample(string $formattedParent, string $slateDisplayName): void
{
    // Create a client.
    $slateServiceClient = new SlateServiceClient();

    // Prepare the request message.
    $slate = (new Slate())
        ->setDisplayName($slateDisplayName);
    $request = (new CreateSlateRequest())
        ->setParent($formattedParent)
        ->setSlate($slate);

    // Call the API and handle any network failures.
    try {
        /** @var Slate $response */
        $response = $slateServiceClient->createSlate($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 = SlateServiceClient::networkName('[NETWORK_CODE]');
    $slateDisplayName = '[DISPLAY_NAME]';

    create_slate_sample($formattedParent, $slateDisplayName);
}

use Google\Ads\AdManager\V1\Client\SlateServiceClient;
use Google\Ads\AdManager\V1\GetSlateRequest;
use Google\Ads\AdManager\V1\Slate;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedName The resource name of the Slate to retrieve.
 *                              Format: `networks/{network_code}/slates/{slate_id}`
 *                              Please see {@see SlateServiceClient::slateName()} for help formatting this field.
 */
function get_slate_sample(string $formattedName): void
{
    // Create a client.
    $slateServiceClient = new SlateServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Slate $response */
        $response = $slateServiceClient->getSlate($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 = SlateServiceClient::slateName('[NETWORK_CODE]', '[SLATE]');

    get_slate_sample($formattedName);
}

use Google\Ads\AdManager\V1\Client\SlateServiceClient;
use Google\Ads\AdManager\V1\ListSlatesRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;

/**
 * @param string $formattedParent The parent resource containing the Slates.
 *                                Format: `networks/{network_code}`
 *                                Please see {@see SlateServiceClient::networkName()} for help formatting this field.
 */
function list_slates_sample(string $formattedParent): void
{
    // Create a client.
    $slateServiceClient = new SlateServiceClient();

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

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

    list_slates_sample($formattedParent);
}

use Google\Ads\AdManager\V1\Client\SlateServiceClient;
use Google\Ads\AdManager\V1\Slate;
use Google\Ads\AdManager\V1\UpdateSlateRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $slateDisplayName The display name of the Slate. It has a maximum length of 255
 *                                 characters.
 */
function update_slate_sample(string $slateDisplayName): void
{
    // Create a client.
    $slateServiceClient = new SlateServiceClient();

    // Prepare the request message.
    $slate = (new Slate())
        ->setDisplayName($slateDisplayName);
    $request = (new UpdateSlateRequest())
        ->setSlate($slate);

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

    update_slate_sample($slateDisplayName);
}