Google Ads Ad Manager V1 Client - Class LabelServiceClient (0.7.0)

use Google\Ads\AdManager\V1\BatchActivateLabelsRequest;
use Google\Ads\AdManager\V1\BatchActivateLabelsResponse;
use Google\Ads\AdManager\V1\Client\LabelServiceClient;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent       Format: `networks/{network_code}`
 *                                      Please see {@see LabelServiceClient::networkName()} for help formatting this field.
 * @param string $formattedNamesElement Resource names for the Label.
 *                                      Format: `networks/{network_code}/labels/{label_id}`
 *                                      Please see {@see LabelServiceClient::labelName()} for help formatting this field.
 */
function batch_activate_labels_sample(
    string $formattedParent,
    string $formattedNamesElement
): void {
    // Create a client.
    $labelServiceClient = new LabelServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var BatchActivateLabelsResponse $response */
        $response = $labelServiceClient->batchActivateLabels($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 = LabelServiceClient::networkName('[NETWORK_CODE]');
    $formattedNamesElement = LabelServiceClient::labelName('[NETWORK_CODE]', '[LABEL]');

    batch_activate_labels_sample($formattedParent, $formattedNamesElement);
}

use Google\Ads\AdManager\V1\BatchCreateLabelsRequest;
use Google\Ads\AdManager\V1\BatchCreateLabelsResponse;
use Google\Ads\AdManager\V1\Client\LabelServiceClient;
use Google\Ads\AdManager\V1\CreateLabelRequest;
use Google\Ads\AdManager\V1\Label;
use Google\Ads\AdManager\V1\LabelTypeEnum\LabelType;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent           The parent resource where `Labels` will be created.
 *                                          Format: `networks/{network_code}`
 *                                          The parent field in the CreateLabelRequest must match this
 *                                          field. Please see
 *                                          {@see LabelServiceClient::networkName()} for help formatting this field.
 * @param string $formattedRequestsParent   The parent resource where this `Label` will be created.
 *                                          Format: `networks/{network_code}`
 *                                          Please see {@see LabelServiceClient::networkName()} for help formatting this field.
 * @param string $requestsLabelDisplayName  Display name of the Label. This attribute has a maximum length of
 *                                          127 characters.
 * @param int    $requestsLabelTypesElement Unordered list. The types of the Label.
 */
function batch_create_labels_sample(
    string $formattedParent,
    string $formattedRequestsParent,
    string $requestsLabelDisplayName,
    int $requestsLabelTypesElement
): void {
    // Create a client.
    $labelServiceClient = new LabelServiceClient();

    // Prepare the request message.
    $requestsLabelTypes = [$requestsLabelTypesElement,];
    $requestsLabel = (new Label())
        ->setDisplayName($requestsLabelDisplayName)
        ->setTypes($requestsLabelTypes);
    $createLabelRequest = (new CreateLabelRequest())
        ->setParent($formattedRequestsParent)
        ->setLabel($requestsLabel);
    $requests = [$createLabelRequest,];
    $request = (new BatchCreateLabelsRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchCreateLabelsResponse $response */
        $response = $labelServiceClient->batchCreateLabels($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 = LabelServiceClient::networkName('[NETWORK_CODE]');
    $formattedRequestsParent = LabelServiceClient::networkName('[NETWORK_CODE]');
    $requestsLabelDisplayName = '[DISPLAY_NAME]';
    $requestsLabelTypesElement = LabelType::LABEL_TYPE_UNSPECIFIED;

    batch_create_labels_sample(
        $formattedParent,
        $formattedRequestsParent,
        $requestsLabelDisplayName,
        $requestsLabelTypesElement
    );
}

use Google\Ads\AdManager\V1\BatchDeactivateLabelsRequest;
use Google\Ads\AdManager\V1\BatchDeactivateLabelsResponse;
use Google\Ads\AdManager\V1\Client\LabelServiceClient;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent       Format: `networks/{network_code}`
 *                                      Please see {@see LabelServiceClient::networkName()} for help formatting this field.
 * @param string $formattedNamesElement Resource names for the Label.
 *                                      Format: `networks/{network_code}/labels/{label_id}`
 *                                      Please see {@see LabelServiceClient::labelName()} for help formatting this field.
 */
function batch_deactivate_labels_sample(
    string $formattedParent,
    string $formattedNamesElement
): void {
    // Create a client.
    $labelServiceClient = new LabelServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var BatchDeactivateLabelsResponse $response */
        $response = $labelServiceClient->batchDeactivateLabels($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 = LabelServiceClient::networkName('[NETWORK_CODE]');
    $formattedNamesElement = LabelServiceClient::labelName('[NETWORK_CODE]', '[LABEL]');

    batch_deactivate_labels_sample($formattedParent, $formattedNamesElement);
}

use Google\Ads\AdManager\V1\BatchUpdateLabelsRequest;
use Google\Ads\AdManager\V1\BatchUpdateLabelsResponse;
use Google\Ads\AdManager\V1\Client\LabelServiceClient;
use Google\Ads\AdManager\V1\Label;
use Google\Ads\AdManager\V1\LabelTypeEnum\LabelType;
use Google\Ads\AdManager\V1\UpdateLabelRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent           The parent resource where `Labels` will be updated.
 *                                          Format: `networks/{network_code}`
 *                                          The parent field in the UpdateLabelRequest must match this
 *                                          field. Please see
 *                                          {@see LabelServiceClient::networkName()} for help formatting this field.
 * @param string $requestsLabelDisplayName  Display name of the Label. This attribute has a maximum length of
 *                                          127 characters.
 * @param int    $requestsLabelTypesElement Unordered list. The types of the Label.
 */
function batch_update_labels_sample(
    string $formattedParent,
    string $requestsLabelDisplayName,
    int $requestsLabelTypesElement
): void {
    // Create a client.
    $labelServiceClient = new LabelServiceClient();

    // Prepare the request message.
    $requestsLabelTypes = [$requestsLabelTypesElement,];
    $requestsLabel = (new Label())
        ->setDisplayName($requestsLabelDisplayName)
        ->setTypes($requestsLabelTypes);
    $updateLabelRequest = (new UpdateLabelRequest())
        ->setLabel($requestsLabel);
    $requests = [$updateLabelRequest,];
    $request = (new BatchUpdateLabelsRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchUpdateLabelsResponse $response */
        $response = $labelServiceClient->batchUpdateLabels($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 = LabelServiceClient::networkName('[NETWORK_CODE]');
    $requestsLabelDisplayName = '[DISPLAY_NAME]';
    $requestsLabelTypesElement = LabelType::LABEL_TYPE_UNSPECIFIED;

    batch_update_labels_sample($formattedParent, $requestsLabelDisplayName, $requestsLabelTypesElement);
}

use Google\Ads\AdManager\V1\Client\LabelServiceClient;
use Google\Ads\AdManager\V1\CreateLabelRequest;
use Google\Ads\AdManager\V1\Label;
use Google\Ads\AdManager\V1\LabelTypeEnum\LabelType;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent   The parent resource where this `Label` will be created.
 *                                  Format: `networks/{network_code}`
 *                                  Please see {@see LabelServiceClient::networkName()} for help formatting this field.
 * @param string $labelDisplayName  Display name of the Label. This attribute has a maximum length of
 *                                  127 characters.
 * @param int    $labelTypesElement Unordered list. The types of the Label.
 */
function create_label_sample(
    string $formattedParent,
    string $labelDisplayName,
    int $labelTypesElement
): void {
    // Create a client.
    $labelServiceClient = new LabelServiceClient();

    // Prepare the request message.
    $labelTypes = [$labelTypesElement,];
    $label = (new Label())
        ->setDisplayName($labelDisplayName)
        ->setTypes($labelTypes);
    $request = (new CreateLabelRequest())
        ->setParent($formattedParent)
        ->setLabel($label);

    // Call the API and handle any network failures.
    try {
        /** @var Label $response */
        $response = $labelServiceClient->createLabel($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 = LabelServiceClient::networkName('[NETWORK_CODE]');
    $labelDisplayName = '[DISPLAY_NAME]';
    $labelTypesElement = LabelType::LABEL_TYPE_UNSPECIFIED;

    create_label_sample($formattedParent, $labelDisplayName, $labelTypesElement);
}

use Google\Ads\AdManager\V1\Client\LabelServiceClient;
use Google\Ads\AdManager\V1\GetLabelRequest;
use Google\Ads\AdManager\V1\Label;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedName The resource name of the Label.
 *                              Format: `networks/{network_code}/labels/{label_id}`
 *                              Please see {@see LabelServiceClient::labelName()} for help formatting this field.
 */
function get_label_sample(string $formattedName): void
{
    // Create a client.
    $labelServiceClient = new LabelServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Label $response */
        $response = $labelServiceClient->getLabel($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 = LabelServiceClient::labelName('[NETWORK_CODE]', '[LABEL]');

    get_label_sample($formattedName);
}

use Google\Ads\AdManager\V1\Client\LabelServiceClient;
use Google\Ads\AdManager\V1\ListLabelsRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;

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

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

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

    list_labels_sample($formattedParent);
}

use Google\Ads\AdManager\V1\Client\LabelServiceClient;
use Google\Ads\AdManager\V1\Label;
use Google\Ads\AdManager\V1\LabelTypeEnum\LabelType;
use Google\Ads\AdManager\V1\UpdateLabelRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $labelDisplayName  Display name of the Label. This attribute has a maximum length of
 *                                  127 characters.
 * @param int    $labelTypesElement Unordered list. The types of the Label.
 */
function update_label_sample(string $labelDisplayName, int $labelTypesElement): void
{
    // Create a client.
    $labelServiceClient = new LabelServiceClient();

    // Prepare the request message.
    $labelTypes = [$labelTypesElement,];
    $label = (new Label())
        ->setDisplayName($labelDisplayName)
        ->setTypes($labelTypes);
    $request = (new UpdateLabelRequest())
        ->setLabel($label);

    // Call the API and handle any network failures.
    try {
        /** @var Label $response */
        $response = $labelServiceClient->updateLabel($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
{
    $labelDisplayName = '[DISPLAY_NAME]';
    $labelTypesElement = LabelType::LABEL_TYPE_UNSPECIFIED;

    update_label_sample($labelDisplayName, $labelTypesElement);
}