type CustomTargetingKey (v202411)

AI-generated Key Takeaways

• CustomTargetingKey objects represent keys used for custom targeting, allowing for the creation of specific criteria to target ads.

• These keys have properties like name, displayName, and type which determine their functionality and how they are used in targeting.

• CustomTargetingKey can be either PREDEFINED, where targeting values are set in advance, or FREEFORM, where values are added when creating line items.

• The status property, which can be ACTIVE or INACTIVE, indicates whether the key is currently in use for targeting.

• reportableType determines whether a CustomTargetingKey is available for reporting in the Ad Manager query tool, with options including ON, OFF, and CUSTOM_DIMENSION.

Service

CustomTargetingService

Dependencies

CustomTargetingKeyPage createCustomTargetingKeys() updateCustomTargetingKeys()

▼

CustomTargetingKey

CustomTargetingKey represents a key used for custom targeting.

---

Namespace

https://www.google.com/apis/ads/publisher/v202411

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.