REST Resource: networks.customTargetingKeys.customTargetingValues

Resource: CustomTargetingValue

The CustomTargetingValue resource.

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

string

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

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 string. For example, instead of using "age>=18 AND <=34", try "18-34"

displayName

string

Optional. Descriptive name for the CustomTargetingValue.

matchType

enum (CustomTargetingValueMatchType)

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

status

enum (CustomTargetingValueStatus)

Output only. Status of the CustomTargetingValue.

CustomTargetingValueMatchType

Match type of the custom targeting value.

Enums
CUSTOM_TARGETING_VALUE_MATCH_TYPE_UNSPECIFIED Not specified value.
EXACT Used for exact matching. For example, the targeting value car=honda will only match to the ad request car=honda.
BROAD Used for lenient matching when at least one of the words in the ad request matches the targeted value. The targeting value car=honda will match to ad requests containing the word honda. So ad requests car=honda or car=honda civic or car=buy honda or car=how much does a honda cost will all have the line item delivered. This match type can not be used within an audience segment rule.
PREFIX Used for 'starts with' matching when the first few characters in the ad request match all of the characters in the targeted value. The targeting value car=honda will match to ad requests car=honda or car=hondas for sale but not to car=I want a honda.
BROAD_PREFIX This is a combination of MatchType#BROAD and MatchType#PREFIX matching. The targeting value car=honda will match to ad requests that contain words that start with the characters in the targeted value, for example with car=civic hondas. This match type can not be used within an audience segment rule.
SUFFIX Used for 'ends with' matching when the last characters in the ad request match all of the characters in the targeted value. The targeting value car=honda will match with ad requests car=honda or car=I want a honda but not to car=hondas for sale. This match type can not be used within line item targeting.
CONTAINS Used for 'within' matching when the string in the ad request contains the string in the targeted value. The targeting value car=honda will match with ad requests car=honda, car=I want a honda, and also with car=hondas for sale, but not with car=misspelled hond a. This match type can not be used within line item targeting.

CustomTargetingValueStatus

Status of the custom targeting value.

Enums
CUSTOM_TARGETING_VALUE_STATUS_UNSPECIFIED Not specified value.
ACTIVE Custom targeting value is active.
INACTIVE Custom targeting value is inactive.

Methods

get

API to retrieve a CustomTargetingValue object.

list

API to retrieve a list of CustomTargetingValue objects.