Reference documentation and code samples for the Google Ads Ad Manager V1 Client class CustomTargetingValue.
The CustomTargetingValue resource.
Generated from protobuf message google.ads.admanager.v1.CustomTargetingValue
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the |
↳ custom_targeting_key |
string
Required. Immutable. The resource name of the |
↳ ad_tag_name |
string
Immutable. Name of the |
↳ display_name |
string
Optional. Descriptive name for the |
↳ match_type |
int
Required. Immutable. The way in which the CustomTargetingValue.name strings will be matched. |
↳ status |
int
Output only. Status of the |
getName
Identifier. The resource name of the CustomTargetingValue.
Format:
networks/{network_code}/customTargetingValues/{custom_targeting_value_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the CustomTargetingValue.
Format:
networks/{network_code}/customTargetingValues/{custom_targeting_value_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCustomTargetingKey
Required. Immutable. The resource name of the CustomTargetingKey.
Format:
networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setCustomTargetingKey
Required. Immutable. The resource name of the CustomTargetingKey.
Format:
networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdTagName
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"
| Returns | |
|---|---|
| Type | Description |
string |
|
setAdTagName
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"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Optional. Descriptive name for the CustomTargetingValue.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. Descriptive name for the CustomTargetingValue.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMatchType
Required. Immutable. The way in which the CustomTargetingValue.name strings will be matched.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type CustomTargetingValueMatchType. |
setMatchType
Required. Immutable. The way in which the CustomTargetingValue.name strings will be matched.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type CustomTargetingValueMatchType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatus
Output only. Status of the CustomTargetingValue.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type CustomTargetingValueStatus. |
setStatus
Output only. Status of the CustomTargetingValue.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type CustomTargetingValueStatus. |
| Returns | |
|---|---|
| Type | Description |
$this |
|