Reference documentation and code samples for the Google Ads Ad Manager V1 Client class CmsMetadataValue.
Key value pair associated with a piece of content from a publisher's CMS.
Generated from protobuf message google.ads.admanager.v1.CmsMetadataValue
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
The value of this key-value pair. |
↳ key |
string
Required. Immutable. The resource name of the CmsMetadataKey. Format: "networks/{network_code}/cmsMetadataKey/{cms_metadata_key_id}" |
↳ status |
int
Output only. The status of this CMS metadata value. |
getName
Identifier. The resource name of the CmsMetadataValue.
Format:
networks/{network_code}/cmsMetadataValues/{cms_metadata_value_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the CmsMetadataValue.
Format:
networks/{network_code}/cmsMetadataValues/{cms_metadata_value_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
The value of this key-value pair.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
The value of this key-value pair.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKey
Required. Immutable. The resource name of the CmsMetadataKey.
Format: "networks/{network_code}/cmsMetadataKey/{cms_metadata_key_id}"
| Returns | |
|---|---|
| Type | Description |
string |
|
setKey
Required. Immutable. The resource name of the CmsMetadataKey.
Format: "networks/{network_code}/cmsMetadataKey/{cms_metadata_key_id}"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatus
Output only. The status of this CMS metadata value.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type CmsMetadataValueStatus. |
setStatus
Output only. The status of this CMS metadata value.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type CmsMetadataValueStatus. |
| Returns | |
|---|---|
| Type | Description |
$this |
|