Google Ads Ad Manager V1 Client - Class CustomTargetingKeyServiceClient (0.6.0)

use Google\Ads\AdManager\V1\BatchActivateCustomTargetingKeysRequest;
use Google\Ads\AdManager\V1\BatchActivateCustomTargetingKeysResponse;
use Google\Ads\AdManager\V1\Client\CustomTargetingKeyServiceClient;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent       Format: `networks/{network_code}`
 *                                      Please see {@see CustomTargetingKeyServiceClient::networkName()} for help formatting this field.
 * @param string $formattedNamesElement The resource names of the `CustomTargetingKey`s to activate.
 *                                      Format:
 *                                      `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}`
 *                                      Please see {@see CustomTargetingKeyServiceClient::customTargetingKeyName()} for help formatting this field.
 */
function batch_activate_custom_targeting_keys_sample(
    string $formattedParent,
    string $formattedNamesElement
): void {
    // Create a client.
    $customTargetingKeyServiceClient = new CustomTargetingKeyServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var BatchActivateCustomTargetingKeysResponse $response */
        $response = $customTargetingKeyServiceClient->batchActivateCustomTargetingKeys($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 = CustomTargetingKeyServiceClient::networkName('[NETWORK_CODE]');
    $formattedNamesElement = CustomTargetingKeyServiceClient::customTargetingKeyName(
        '[NETWORK_CODE]',
        '[CUSTOM_TARGETING_KEY]'
    );

    batch_activate_custom_targeting_keys_sample($formattedParent, $formattedNamesElement);
}

use Google\Ads\AdManager\V1\BatchCreateCustomTargetingKeysRequest;
use Google\Ads\AdManager\V1\BatchCreateCustomTargetingKeysResponse;
use Google\Ads\AdManager\V1\Client\CustomTargetingKeyServiceClient;
use Google\Ads\AdManager\V1\CreateCustomTargetingKeyRequest;
use Google\Ads\AdManager\V1\CustomTargetingKey;
use Google\Ads\AdManager\V1\CustomTargetingKeyReportableTypeEnum\CustomTargetingKeyReportableType;
use Google\Ads\AdManager\V1\CustomTargetingKeyTypeEnum\CustomTargetingKeyType;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent                          The parent resource where `CustomTargetingKeys` will be created.
 *                                                         Format: `networks/{network_code}`
 *                                                         The parent field in the CreateCustomTargetingKeyRequest must match this
 *                                                         field. Please see
 *                                                         {@see CustomTargetingKeyServiceClient::networkName()} for help formatting this field.
 * @param string $formattedRequestsParent                  The parent resource where this `CustomTargetingKey` will be
 *                                                         created. Format: `networks/{network_code}`
 *                                                         Please see {@see CustomTargetingKeyServiceClient::networkName()} for help formatting this field.
 * @param int    $requestsCustomTargetingKeyType           Indicates whether users will select from predefined values or
 *                                                         create new targeting values, while specifying targeting criteria for a line
 *                                                         item.
 * @param int    $requestsCustomTargetingKeyReportableType Reportable state of the `CustomTargetingKey`.
 */
function batch_create_custom_targeting_keys_sample(
    string $formattedParent,
    string $formattedRequestsParent,
    int $requestsCustomTargetingKeyType,
    int $requestsCustomTargetingKeyReportableType
): void {
    // Create a client.
    $customTargetingKeyServiceClient = new CustomTargetingKeyServiceClient();

    // Prepare the request message.
    $requestsCustomTargetingKey = (new CustomTargetingKey())
        ->setType($requestsCustomTargetingKeyType)
        ->setReportableType($requestsCustomTargetingKeyReportableType);
    $createCustomTargetingKeyRequest = (new CreateCustomTargetingKeyRequest())
        ->setParent($formattedRequestsParent)
        ->setCustomTargetingKey($requestsCustomTargetingKey);
    $requests = [$createCustomTargetingKeyRequest,];
    $request = (new BatchCreateCustomTargetingKeysRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchCreateCustomTargetingKeysResponse $response */
        $response = $customTargetingKeyServiceClient->batchCreateCustomTargetingKeys($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 = CustomTargetingKeyServiceClient::networkName('[NETWORK_CODE]');
    $formattedRequestsParent = CustomTargetingKeyServiceClient::networkName('[NETWORK_CODE]');
    $requestsCustomTargetingKeyType = CustomTargetingKeyType::CUSTOM_TARGETING_KEY_TYPE_UNSPECIFIED;
    $requestsCustomTargetingKeyReportableType = CustomTargetingKeyReportableType::CUSTOM_TARGETING_KEY_REPORTABLE_TYPE_UNSPECIFIED;

    batch_create_custom_targeting_keys_sample(
        $formattedParent,
        $formattedRequestsParent,
        $requestsCustomTargetingKeyType,
        $requestsCustomTargetingKeyReportableType
    );
}

use Google\Ads\AdManager\V1\BatchDeactivateCustomTargetingKeysRequest;
use Google\Ads\AdManager\V1\BatchDeactivateCustomTargetingKeysResponse;
use Google\Ads\AdManager\V1\Client\CustomTargetingKeyServiceClient;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent       Format: `networks/{network_code}`
 *                                      Please see {@see CustomTargetingKeyServiceClient::networkName()} for help formatting this field.
 * @param string $formattedNamesElement The resource names of the `CustomTargetingKey`s to deactivate.
 *                                      Format:
 *                                      `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}`
 *                                      Please see {@see CustomTargetingKeyServiceClient::customTargetingKeyName()} for help formatting this field.
 */
function batch_deactivate_custom_targeting_keys_sample(
    string $formattedParent,
    string $formattedNamesElement
): void {
    // Create a client.
    $customTargetingKeyServiceClient = new CustomTargetingKeyServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var BatchDeactivateCustomTargetingKeysResponse $response */
        $response = $customTargetingKeyServiceClient->batchDeactivateCustomTargetingKeys($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 = CustomTargetingKeyServiceClient::networkName('[NETWORK_CODE]');
    $formattedNamesElement = CustomTargetingKeyServiceClient::customTargetingKeyName(
        '[NETWORK_CODE]',
        '[CUSTOM_TARGETING_KEY]'
    );

    batch_deactivate_custom_targeting_keys_sample($formattedParent, $formattedNamesElement);
}

use Google\Ads\AdManager\V1\BatchUpdateCustomTargetingKeysRequest;
use Google\Ads\AdManager\V1\BatchUpdateCustomTargetingKeysResponse;
use Google\Ads\AdManager\V1\Client\CustomTargetingKeyServiceClient;
use Google\Ads\AdManager\V1\CustomTargetingKey;
use Google\Ads\AdManager\V1\CustomTargetingKeyReportableTypeEnum\CustomTargetingKeyReportableType;
use Google\Ads\AdManager\V1\CustomTargetingKeyTypeEnum\CustomTargetingKeyType;
use Google\Ads\AdManager\V1\UpdateCustomTargetingKeyRequest;
use Google\ApiCore\ApiException;
use Google\Protobuf\FieldMask;

/**
 * @param string $formattedParent                          The parent resource where `CustomTargetingKeys` will be updated.
 *                                                         Format: `networks/{network_code}`
 *                                                         The parent field in the UpdateCustomTargetingKeyRequest must match this
 *                                                         field. Please see
 *                                                         {@see CustomTargetingKeyServiceClient::networkName()} for help formatting this field.
 * @param int    $requestsCustomTargetingKeyType           Indicates whether users will select from predefined values or
 *                                                         create new targeting values, while specifying targeting criteria for a line
 *                                                         item.
 * @param int    $requestsCustomTargetingKeyReportableType Reportable state of the `CustomTargetingKey`.
 */
function batch_update_custom_targeting_keys_sample(
    string $formattedParent,
    int $requestsCustomTargetingKeyType,
    int $requestsCustomTargetingKeyReportableType
): void {
    // Create a client.
    $customTargetingKeyServiceClient = new CustomTargetingKeyServiceClient();

    // Prepare the request message.
    $requestsCustomTargetingKey = (new CustomTargetingKey())
        ->setType($requestsCustomTargetingKeyType)
        ->setReportableType($requestsCustomTargetingKeyReportableType);
    $requestsUpdateMask = new FieldMask();
    $updateCustomTargetingKeyRequest = (new UpdateCustomTargetingKeyRequest())
        ->setCustomTargetingKey($requestsCustomTargetingKey)
        ->setUpdateMask($requestsUpdateMask);
    $requests = [$updateCustomTargetingKeyRequest,];
    $request = (new BatchUpdateCustomTargetingKeysRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BatchUpdateCustomTargetingKeysResponse $response */
        $response = $customTargetingKeyServiceClient->batchUpdateCustomTargetingKeys($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 = CustomTargetingKeyServiceClient::networkName('[NETWORK_CODE]');
    $requestsCustomTargetingKeyType = CustomTargetingKeyType::CUSTOM_TARGETING_KEY_TYPE_UNSPECIFIED;
    $requestsCustomTargetingKeyReportableType = CustomTargetingKeyReportableType::CUSTOM_TARGETING_KEY_REPORTABLE_TYPE_UNSPECIFIED;

    batch_update_custom_targeting_keys_sample(
        $formattedParent,
        $requestsCustomTargetingKeyType,
        $requestsCustomTargetingKeyReportableType
    );
}

use Google\Ads\AdManager\V1\Client\CustomTargetingKeyServiceClient;
use Google\Ads\AdManager\V1\CreateCustomTargetingKeyRequest;
use Google\Ads\AdManager\V1\CustomTargetingKey;
use Google\Ads\AdManager\V1\CustomTargetingKeyReportableTypeEnum\CustomTargetingKeyReportableType;
use Google\Ads\AdManager\V1\CustomTargetingKeyTypeEnum\CustomTargetingKeyType;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedParent                  The parent resource where this `CustomTargetingKey` will be
 *                                                 created. Format: `networks/{network_code}`
 *                                                 Please see {@see CustomTargetingKeyServiceClient::networkName()} for help formatting this field.
 * @param int    $customTargetingKeyType           Indicates whether users will select from predefined values or
 *                                                 create new targeting values, while specifying targeting criteria for a line
 *                                                 item.
 * @param int    $customTargetingKeyReportableType Reportable state of the `CustomTargetingKey`.
 */
function create_custom_targeting_key_sample(
    string $formattedParent,
    int $customTargetingKeyType,
    int $customTargetingKeyReportableType
): void {
    // Create a client.
    $customTargetingKeyServiceClient = new CustomTargetingKeyServiceClient();

    // Prepare the request message.
    $customTargetingKey = (new CustomTargetingKey())
        ->setType($customTargetingKeyType)
        ->setReportableType($customTargetingKeyReportableType);
    $request = (new CreateCustomTargetingKeyRequest())
        ->setParent($formattedParent)
        ->setCustomTargetingKey($customTargetingKey);

    // Call the API and handle any network failures.
    try {
        /** @var CustomTargetingKey $response */
        $response = $customTargetingKeyServiceClient->createCustomTargetingKey($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 = CustomTargetingKeyServiceClient::networkName('[NETWORK_CODE]');
    $customTargetingKeyType = CustomTargetingKeyType::CUSTOM_TARGETING_KEY_TYPE_UNSPECIFIED;
    $customTargetingKeyReportableType = CustomTargetingKeyReportableType::CUSTOM_TARGETING_KEY_REPORTABLE_TYPE_UNSPECIFIED;

    create_custom_targeting_key_sample(
        $formattedParent,
        $customTargetingKeyType,
        $customTargetingKeyReportableType
    );
}

use Google\Ads\AdManager\V1\Client\CustomTargetingKeyServiceClient;
use Google\Ads\AdManager\V1\CustomTargetingKey;
use Google\Ads\AdManager\V1\GetCustomTargetingKeyRequest;
use Google\ApiCore\ApiException;

/**
 * @param string $formattedName The resource name of the CustomTargetingKey.
 *                              Format:
 *                              `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}`
 *                              Please see {@see CustomTargetingKeyServiceClient::customTargetingKeyName()} for help formatting this field.
 */
function get_custom_targeting_key_sample(string $formattedName): void
{
    // Create a client.
    $customTargetingKeyServiceClient = new CustomTargetingKeyServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var CustomTargetingKey $response */
        $response = $customTargetingKeyServiceClient->getCustomTargetingKey($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 = CustomTargetingKeyServiceClient::customTargetingKeyName(
        '[NETWORK_CODE]',
        '[CUSTOM_TARGETING_KEY]'
    );

    get_custom_targeting_key_sample($formattedName);
}

use Google\Ads\AdManager\V1\Client\CustomTargetingKeyServiceClient;
use Google\Ads\AdManager\V1\ListCustomTargetingKeysRequest;
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;

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

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

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

    list_custom_targeting_keys_sample($formattedParent);
}

use Google\Ads\AdManager\V1\Client\CustomTargetingKeyServiceClient;
use Google\Ads\AdManager\V1\CustomTargetingKey;
use Google\Ads\AdManager\V1\CustomTargetingKeyReportableTypeEnum\CustomTargetingKeyReportableType;
use Google\Ads\AdManager\V1\CustomTargetingKeyTypeEnum\CustomTargetingKeyType;
use Google\Ads\AdManager\V1\UpdateCustomTargetingKeyRequest;
use Google\ApiCore\ApiException;
use Google\Protobuf\FieldMask;

/**
 * @param int $customTargetingKeyType           Indicates whether users will select from predefined values or
 *                                              create new targeting values, while specifying targeting criteria for a line
 *                                              item.
 * @param int $customTargetingKeyReportableType Reportable state of the `CustomTargetingKey`.
 */
function update_custom_targeting_key_sample(
    int $customTargetingKeyType,
    int $customTargetingKeyReportableType
): void {
    // Create a client.
    $customTargetingKeyServiceClient = new CustomTargetingKeyServiceClient();

    // Prepare the request message.
    $customTargetingKey = (new CustomTargetingKey())
        ->setType($customTargetingKeyType)
        ->setReportableType($customTargetingKeyReportableType);
    $updateMask = new FieldMask();
    $request = (new UpdateCustomTargetingKeyRequest())
        ->setCustomTargetingKey($customTargetingKey)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var CustomTargetingKey $response */
        $response = $customTargetingKeyServiceClient->updateCustomTargetingKey($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
{
    $customTargetingKeyType = CustomTargetingKeyType::CUSTOM_TARGETING_KEY_TYPE_UNSPECIFIED;
    $customTargetingKeyReportableType = CustomTargetingKeyReportableType::CUSTOM_TARGETING_KEY_REPORTABLE_TYPE_UNSPECIFIED;

    update_custom_targeting_key_sample($customTargetingKeyType, $customTargetingKeyReportableType);
}