Reference documentation and code samples for the Google Ads Ad Manager V1 Client class Placement.
The Placement resource.
Generated from protobuf message google.ads.admanager.v1.Placement
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 |
↳ placement_id |
int|string
Output only. |
↳ display_name |
string
Required. The display name of the placement. Its maximum length is 255 characters. |
↳ description |
string
Optional. A description of the Placement. This value is optional and its maximum length is 65,535 characters. |
↳ placement_code |
string
Output only. A string used to uniquely identify the Placement for purposes of serving the ad. This attribute is read-only and is assigned by Google when a placement is created. |
↳ status |
int
Output only. The status of the Placement. This attribute is read-only. |
↳ targeted_ad_units |
array
Optional. The resource names of AdUnits that constitute the Placement. Format: "networks/{network_code}/adUnits/{ad_unit_id}" |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The instant this Placement was last modified. |
getName
Identifier. The resource name of the Placement.
Format: networks/{network_code}/placements/{placement_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the Placement.
Format: networks/{network_code}/placements/{placement_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPlacementId
Output only. Placement ID.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setPlacementId
Output only. Placement ID.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Required. The display name of the placement. Its maximum length is 255 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Required. The display name of the placement. Its maximum length is 255 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. A description of the Placement. This value is optional and its maximum length is 65,535 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. A description of the Placement. This value is optional and its maximum length is 65,535 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPlacementCode
Output only. A string used to uniquely identify the Placement for purposes of serving the ad. This attribute is read-only and is assigned by Google when a placement is created.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPlacementCode
Output only. A string used to uniquely identify the Placement for purposes of serving the ad. This attribute is read-only and is assigned by Google when a placement is created.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatus
Output only. The status of the Placement. This attribute is read-only.
| Returns | |
|---|---|
| Type | Description |
int |
|
setStatus
Output only. The status of the Placement. This attribute is read-only.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTargetedAdUnits
Optional. The resource names of AdUnits that constitute the Placement.
Format: "networks/{network_code}/adUnits/{ad_unit_id}"
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setTargetedAdUnits
Optional. The resource names of AdUnits that constitute the Placement.
Format: "networks/{network_code}/adUnits/{ad_unit_id}"
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The instant this Placement was last modified.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The instant this Placement was last modified.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|