Google Ads Ad Manager V1 Client - Class CmsMetadataKey (0.5.0)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class CmsMetadataKey.

Key associated with a piece of content from a publisher's CMS.

Generated from protobuf message google.ads.admanager.v1.CmsMetadataKey

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. The resource name of the CmsMetadataKey. Format: networks/{network_code}/cmsMetadataKeys/{cms_metadata_key_id}

↳ display_name string

Required. The key of a key-value pair.

↳ status int

Output only. The status of this CMS metadata key.

getName

Identifier. The resource name of the CmsMetadataKey.

Format: networks/{network_code}/cmsMetadataKeys/{cms_metadata_key_id}

Returns
Type Description
string

setName

Identifier. The resource name of the CmsMetadataKey.

Format: networks/{network_code}/cmsMetadataKeys/{cms_metadata_key_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Required. The key of a key-value pair.

Returns
Type Description
string

setDisplayName

Required. The key of a key-value pair.

Parameter
Name Description
var string
Returns
Type Description
$this

getStatus

Output only. The status of this CMS metadata key.

Returns
Type Description
int Enum of type CmsMetadataKeyStatus.

setStatus

Output only. The status of this CMS metadata key.

Parameter
Name Description
var int

Enum of type CmsMetadataKeyStatus.

Returns
Type Description
$this