type CustomTargetingKey (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
Service
CustomTargetingService
CustomTargetingKey represents a key used for custom targeting.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202408
Field
|
id
|
xsd:long
The ID of the CustomTargetingKey. This value is readonly and is populated by Google.
|
name
|
xsd:string
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
|
xsd:string
Descriptive name for the key.
|
type
|
CustomTargetingKey.Type
Indicates whether users will select from predefined values or create new targeting values,
while specifying targeting criteria for a line item.
Enumerations
-
PREDEFINED
- Target audiences by criteria values that are defined in advance.
-
FREEFORM
- Target audiences by adding criteria values when creating line items.
|
status
|
CustomTargetingKey.Status
Status of the CustomTargetingKey. This field is read-only. A key can be activated and
deactivated by calling CustomTargetingService.performCustomTargetingKeyAction.
Enumerations
-
ACTIVE
- The object is active.
-
INACTIVE
- The object is no longer active.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
|
reportableType
|
ReportableType
Reportable state of a {@CustomTargetingKey} as defined in ReportableType.
Enumerations
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
-
ON
- Available for reporting in the Ad Manager query tool.
-
OFF
- Not available for reporting in the Ad Manager query tool.
-
CUSTOM_DIMENSION
- Custom dimension available for reporting in the AdManager query tool.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-06 UTC.
[null,null,["Last updated 2025-08-06 UTC."],[[["\u003cp\u003e\u003ccode\u003eCustomTargetingKey\u003c/code\u003e objects represent keys used for custom targeting, allowing you to define criteria for ad targeting.\u003c/p\u003e\n"],["\u003cp\u003eThese keys have properties such as ID, name, display name, type (predefined or freeform), and status (active or inactive).\u003c/p\u003e\n"],["\u003cp\u003eYou can manage \u003ccode\u003eCustomTargetingKey\u003c/code\u003e objects using the \u003ccode\u003eCustomTargetingService\u003c/code\u003e to create, update, and control their status.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003etype\u003c/code\u003e property determines whether targeting values are predefined or entered freely when creating line items.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCustomTargetingKey\u003c/code\u003e objects also have a \u003ccode\u003ereportableType\u003c/code\u003e property that dictates their availability for reporting in Ad Manager.\u003c/p\u003e\n"]]],["The `CustomTargetingService` manages `CustomTargetingKey` objects, which are used for ad targeting. Key actions include creating and updating these keys. Each `CustomTargetingKey` has properties like `id`, `name`, `displayName`, `type` (either `PREDEFINED` or `FREEFORM`), `status` (e.g., `ACTIVE`, `INACTIVE`), and `reportableType` (e.g. `ON`, `OFF`, or `CUSTOM_DIMENSION`). Keys can be activated or deactivated, and their reportability can be set. The `CustomTargetingKeyPage` is a dependency of the service.\n"],null,["# type CustomTargetingKey (v202408)\n\n**Service** \n**CustomTargetingService** **Dependencies** \n[CustomTargetingKeyPage](/ad-manager/api/reference/v202408/CustomTargetingService.CustomTargetingKeyPage) [createCustomTargetingKeys()](/ad-manager/api/reference/v202408/CustomTargetingService#createCustomTargetingKeys) [updateCustomTargetingKeys()](/ad-manager/api/reference/v202408/CustomTargetingService#updateCustomTargetingKeys) \n▼\n**CustomTargetingKey**\n\n\n`CustomTargetingKey` represents a key used for custom targeting.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202408`\n\n| Field ----- ||\n|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `id` | ` `xsd:`long` The ID of the `CustomTargetingKey`. This value is readonly and is populated by Google. |\n| ### `name` | ` `xsd:`string` Name of the key. Keys can contain up to 10 characters each. You can use alphanumeric characters and symbols other than the following: \", ', =, !, +, #, \\*, \\~, ;, \\^, (, ), \\\u003c, \\\u003e, \\[, \\], the white space character. |\n| ### `displayName` | ` `xsd:`string` Descriptive name for the key. |\n| ### `type` | ` `[CustomTargetingKey.Type](/ad-manager/api/reference/v202408/CustomTargetingService.CustomTargetingKey.Type)` ` Indicates whether users will select from predefined values or create new targeting values, while specifying targeting criteria for a line item. *** ** * ** *** **Enumerations** `PREDEFINED` : Target audiences by criteria values that are defined in advance. `FREEFORM` : Target audiences by adding criteria values when creating line items. \u003cbr /\u003e |\n| ### `status` | ` `[CustomTargetingKey.Status](/ad-manager/api/reference/v202408/CustomTargetingService.CustomTargetingKey.Status)` ` Status of the `CustomTargetingKey`. This field is read-only. A key can be activated and deactivated by calling [CustomTargetingService.performCustomTargetingKeyAction](/ad-manager/api/reference/v202408/CustomTargetingService#performCustomTargetingKeyAction). *** ** * ** *** **Enumerations** `ACTIVE` : The object is active. `INACTIVE` : The object is no longer active. `UNKNOWN` : The value returned if the actual value is not exposed by the requested API version. \u003cbr /\u003e |\n| ### `reportableType` | ` `[ReportableType](/ad-manager/api/reference/v202408/CustomTargetingService.ReportableType)` ` Reportable state of a {@CustomTargetingKey} as defined in [ReportableType](/ad-manager/api/reference/v202408/CustomTargetingService.ReportableType). *** ** * ** *** **Enumerations** `UNKNOWN` : The value returned if the actual value is not exposed by the requested API version. `ON` : Available for reporting in the Ad Manager query tool. `OFF` : Not available for reporting in the Ad Manager query tool. `CUSTOM_DIMENSION` : Custom dimension available for reporting in the AdManager query tool. \u003cbr /\u003e |"]]
