REST Resource: networks.customTargetingValues

  • The CustomTargetingValue resource is defined by its name, associated custom targeting key, ad tag name, display name, match type, and status.

  • The name field serves as the unique identifier for the CustomTargetingValue resource using a specific format.

  • The customTargetingKey and matchType fields are required and immutable, while adTagName is immutable, and displayName is optional.

  • The status field is an output-only enum indicating the current status of the CustomTargetingValue.

  • Methods are available to either retrieve a single CustomTargetingValue object or a list of CustomTargetingValue objects.

Resource: CustomTargetingValue

The CustomTargetingValue resource.

JSON representation 
{
  "name": string,
  "customTargetingKey": string,
  "adTagName": string,
  "displayName": string,
  "matchType": enum (CustomTargetingValueMatchType),
  "status": enum (CustomTargetingValueStatus)
}
Fields
name

string

Identifier. The resource name of the CustomTargetingValue. Format: networks/{networkCode}/customTargetingValues/{customTargetingValueId}
customTargetingKey

string

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

string

Immutable. Name of the CustomTargetingValue. Values can contain up to 40 characters each. You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ]. Values are not data-specific; all values are treated as strings. For example, instead of using "age>=18 AND <=34", try "18-34"
displayName

string

Optional. Descriptive name for the CustomTargetingValue.
matchType

enum (CustomTargetingValueMatchType)

Required. Immutable. The way in which the CustomTargetingValue.name strings will be matched.
status

enum (CustomTargetingValueStatus)

Output only. Status of the CustomTargetingValue.

Methods

get

 API to retrieve a CustomTargetingValue object.

list

 API to retrieve a list of CustomTargetingValue objects.