type CustomTargetingKey (v202011)

CustomTargetingKey represents a key used for custom targeting.


Namespace
https://www.google.com/apis/ads/publisher/v202011

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. This can be used for encoding . If you don't want users to be able to see potentially sensitive targeting information in the ad tags of your site, you can encode your key/values. For example, you can create key/value g1=abc to represent gender=female. 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.

valueDeclarationType

ValueDeclarationType

Indicates the type of values being passed for this key in ad requests. This field is nullable for a key until it is set, after which it cannot be reset back to null.


Enumerations
NON_USER_DATA
Values are not user-related data and will be used in all ad requests.
USER_DATA
Values are declared as user data that will not be used in sensitive ad requests' targeting.
USER_ID
Values are declared as user identifiers that will not be used in targeting and will be encrypted in DT using a publisher-provided public key.

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
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.