REST Resource: networks.customTargetingKeys

    • The CustomTargetingKey resource represents a custom targeting key in Ad Manager.

    • Custom targeting keys have fields such as name, ID, type, status, and reportable type.

    • The type of a custom targeting key determines if it uses predefined values or allows freeform values.

    • The status of a custom targeting key indicates whether it is active or inactive.

    • The reportable type of a custom targeting key determines its availability for reporting in the Ad Manager query tool.

    Resource: CustomTargetingKey

    The CustomTargetingKey resource.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "customTargetingKeyId" 
 : 
 string 
 , 
 "adTagName" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "type" 
 : 
 enum (  CustomTargetingKeyType 
 
) 
 , 
 "status" 
 : 
 enum (  CustomTargetingKeyStatus 
 
) 
 , 
 "reportableType" 
 : 
 enum (  CustomTargetingKeyReportableType 
 
) 
 }
    Fields
    name

    string

    Identifier. The resource name of the CustomTargetingKey . Format: networks/{networkCode}/customTargetingKeys/{customTargetingKeyId}

    customTargetingKeyId
    (deprecated)

    string ( int64 format)

    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 ( 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 ( CustomTargetingKeyStatus )

    Output only. Status of the CustomTargetingKey .
    reportableType

    enum ( 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

    batchActivate

    		API to batch activate CustomTargetingKey objects.

    batchCreate

    		API to batch create CustomTargetingKey objects.

    batchDeactivate

    		Deactivates a list of CustomTargetingKey objects.

    batchUpdate

    		API to batch update CustomTargetingKey objects.

    create

    		API to create a CustomTargetingKey object.

    get

    		API to retrieve a CustomTargetingKey object.

    list

    		API to retrieve a list of CustomTargetingKey objects.

    patch

    		API to update a CustomTargetingKey object.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: