type CustomTargetingValue (v202505)

  • CustomTargetingValue represents a value used for custom targeting and is part of the CustomTargetingService.

  • Each CustomTargetingValue is associated with a CustomTargetingKey and has unique identifiers for both the key and the value itself.

  • Values have a name, which can contain up to 40 alphanumeric characters and specific symbols, and an optional display name.

  • Various match types determine how the name string is matched in ad requests, including exact, broad, prefix, broad prefix, suffix, and contains.

  • CustomTargetingValue has a status that can be active or inactive and is managed through actions on the CustomTargetingService.
Service
CustomTargetingService
Dependencies
CustomTargetingValuePage createCustomTargetingValues() updateCustomTargetingValues()
▼
CustomTargetingValue

CustomTargetingValue represents a value used for custom targeting.

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

Field

customTargetingKeyId

xsd:long

The ID of the CustomTargetingKey for which this is the value.

id

xsd:long

The ID of the CustomTargetingValue. This value is readonly and is populated by Google.

name

xsd:string

Name of the value. 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

xsd:string

Descriptive name for the value.

matchType

CustomTargetingValue.MatchType

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

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

UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

status

CustomTargetingValue.Status

Status of the CustomTargetingValue. This field is read-only. A value can be activated and deactivated by calling CustomTargetingService.performCustomTargetingValueAction.

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.