- [Resource: CustomTargetingKey](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customTargetingKeys#CustomTargetingKey)
  - [JSON representation](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customTargetingKeys#CustomTargetingKey.SCHEMA_REPRESENTATION)
- [CustomTargetingKeyType](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customTargetingKeys#CustomTargetingKeyType)
- [CustomTargetingKeyStatus](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customTargetingKeys#CustomTargetingKeyStatus)
- [CustomTargetingKeyReportableType](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customTargetingKeys#CustomTargetingKeyReportableType)
- [Methods](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customTargetingKeys#METHODS_SUMMARY)

## Resource: CustomTargetingKey

The `CustomTargetingKey` resource.

| JSON representation |
|---|
| ``` { "name": string, "customTargetingKeyId": string, "adTagName": string, "displayName": string, "type": enum (`https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customTargetingKeys#CustomTargetingKeyType`), "status": enum (`https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customTargetingKeys#CustomTargetingKeyStatus`), "reportableType": enum (`https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customTargetingKeys#CustomTargetingKeyReportableType`) } ``` |

| Fields ||
|---|---|
| `name` | `string` Identifier. The resource name of the `CustomTargetingKey`. Format: `networks/{networkCode}/customTargetingKeys/{customTargetingKeyId}` |
| `customTargetingKeyId (deprecated)` | `string (https://developers.google.com/discovery/v1/type-format format)` > [!WARNING] > Output only. Parse the ID from the `name` field instead. Output only. Deprecated: `CustomTargetingKey` ID. |
| `adTagName` | `string` Immutable. Name of the key. Keys can contain up to 10 characters each. You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, \*, \~, ;, \^, (, ), \<, \>, \[, \], the white space character. |
| `displayName` | `string` Optional. Descriptive name for the `CustomTargetingKey`. |
| `type` | ``enum (`https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customTargetingKeys#CustomTargetingKeyType`)`` Required. Indicates whether users will select from predefined values or create new targeting values, while specifying targeting criteria for a line item. |
| `status` | ``enum (`https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customTargetingKeys#CustomTargetingKeyStatus`)`` Output only. Status of the `CustomTargetingKey`. |
| `reportableType` | ``enum (`https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customTargetingKeys#CustomTargetingKeyReportableType`)`` Required. Reportable state of the `CustomTargetingKey`. |

## CustomTargetingKeyType

Type of the custom targeting key.

| Enums ||
|---|---|
| `CUSTOM_TARGETING_KEY_TYPE_UNSPECIFIED` | Not specified value. |
| `PREDEFINED` | Key with a fixed set of values. |
| `FREEFORM` | Key without a fixed set of values |

## CustomTargetingKeyStatus

Status of the custom targeting key.

| Enums ||
|---|---|
| `CUSTOM_TARGETING_KEY_STATUS_UNSPECIFIED` | Not specified value. |
| `ACTIVE` | Custom targeting key is active. |
| `INACTIVE` | Custom targeting key is inactive. |

## CustomTargetingKeyReportableType

Reportable type of the custom targeting key.

| Enums ||
|---|---|
| `CUSTOM_TARGETING_KEY_REPORTABLE_TYPE_UNSPECIFIED` | Not specified value. |
| `OFF` | Not available for reporting in the Ad Manager query tool. |
| `ON` | Available for reporting in the Ad Manager query tool. |
| `CUSTOM_DIMENSION` | Custom dimension available for reporting in the AdManager query tool. |

| ## Methods ||
|---|---|
| ### `https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customTargetingKeys/batchActivate` | Batch activates `CustomTargetingKey` objects. |
| ### `https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customTargetingKeys/batchCreate` | Creates `CustomTargetingKey` objects. |
| ### `https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customTargetingKeys/batchDeactivate` | Deactivates a list of `CustomTargetingKey` objects. |
| ### `https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customTargetingKeys/batchUpdate` | Batch updates `CustomTargetingKey` objects. |
| ### `https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customTargetingKeys/create` | Creates a `CustomTargetingKey` object. |
| ### `https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customTargetingKeys/get` | Retrieves a `CustomTargetingKey` object. |
| ### `https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customTargetingKeys/list` | Lists `CustomTargetingKey` objects. |
| ### `https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customTargetingKeys/patch` | Updates a `CustomTargetingKey` object. |