Reference documentation and code samples for the Google Ads Ad Manager V1 Client class GeoTarget.
Represents a location in the world, for targeting.
Generated from protobuf message google.ads.admanager.v1.GeoTarget
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 |
↳ display_name |
string
Output only. The display name of the GeoTarget. |
↳ canonical_parent |
string
Output only. The name of the direct parent that defines the canonical name of the geo target. For example, if the current geo target is "San Francisco", its canonical name would be "San Francisco, California, United States" thus the canonical_parent would be the name of California and the canonical_parent of California would be the name of United states Format: |
↳ parent_names |
array
Output only. All parents of the geo target ordered by ascending size. |
↳ region_code |
string
Output only. The Unicode CLDR region code of the geo target. |
↳ type |
string
Output only. The location type (unlocalized) for this geographical entity. |
↳ targetable |
bool
Output only. Whether the geo target is targetable. |
getName
Identifier. The resource name of the GeoTarget
.
Format: networks/{network_code}/geoTargets/{geo_target_id}
Returns | |
---|---|
Type | Description |
string |
setName
Identifier. The resource name of the GeoTarget
.
Format: networks/{network_code}/geoTargets/{geo_target_id}
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getDisplayName
Output only. The display name of the GeoTarget.
Returns | |
---|---|
Type | Description |
string |
hasDisplayName
clearDisplayName
setDisplayName
Output only. The display name of the GeoTarget.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getCanonicalParent
Output only. The name of the direct parent that defines the canonical name
of the geo target. For example, if the current geo target is "San
Francisco", its canonical name would be "San Francisco, California, United
States" thus the canonical_parent would be the name of California and the
canonical_parent of California would be the name of United states Format:
networks/{network_code}/geoTargets/{geo_target}
Returns | |
---|---|
Type | Description |
string |
hasCanonicalParent
clearCanonicalParent
setCanonicalParent
Output only. The name of the direct parent that defines the canonical name
of the geo target. For example, if the current geo target is "San
Francisco", its canonical name would be "San Francisco, California, United
States" thus the canonical_parent would be the name of California and the
canonical_parent of California would be the name of United states Format:
networks/{network_code}/geoTargets/{geo_target}
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getParentNames
Output only. All parents of the geo target ordered by ascending size.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setParentNames
Output only. All parents of the geo target ordered by ascending size.
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getRegionCode
Output only. The Unicode CLDR region code of the geo target.
Returns | |
---|---|
Type | Description |
string |
hasRegionCode
clearRegionCode
setRegionCode
Output only. The Unicode CLDR region code of the geo target.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getType
Output only. The location type (unlocalized) for this geographical entity.
Returns | |
---|---|
Type | Description |
string |
hasType
clearType
setType
Output only. The location type (unlocalized) for this geographical entity.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getTargetable
Output only. Whether the geo target is targetable.
Returns | |
---|---|
Type | Description |
bool |
hasTargetable
clearTargetable
setTargetable
Output only. Whether the geo target is targetable.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |