To discuss and provide feedback on our products, join the official Ad Manager Discord channel in the Google Advertising and Measurement Community server.

REST Resource: networks.cmsMetadataValues

Page Summary

CmsMetadataValue represents a key-value pair associated with content from a publisher's CMS.
The CmsMetadataValue resource includes fields such as name , displayName , key , and status .
CmsMetadataValueStatus defines the possible states of a CMS metadata value, including ACTIVE , ARCHIVED , and INACTIVE .
The available methods include get to retrieve a single CmsMetadataValue and list to retrieve multiple CmsMetadataValue objects.

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

JSON representation
{ "name" : string , "displayName" : string , "key" : string , "status" : enum ( `CmsMetadataValueStatus` ) }

Fields
`name`	`string` Identifier. The resource name of the `CmsMetadataValue` . Format: `networks/{networkCode}/cmsMetadataValues/{cmsMetadataValueId}`
`displayName`	`string` The value of this key-value pair.
`key`	`string` Required. Immutable. The resource name of the CmsMetadataKey. Format: "networks/{networkCode}/cmsMetadataKey/{cmsMetadataKeyId}"
`status`	`enum ( CmsMetadataValueStatus )` Output only. The status of this CMS metadata value.

Status for CmsMetadataValue objects.

Enums
`CMS_METADATA_VALUE_STATUS_UNSPECIFIED`	Default value. This value is unused.
`ACTIVE`	The value is active.
`ARCHIVED`	The value is archived.
`INACTIVE`	The value is not active.

Methods
`batchActivate`	API to activate a list of `CmsMetadataValue` objects.
`batchDeactivate`	API to deactivate a list of `CmsMetadataValue` objects.
`get`	API to retrieve a `CmsMetadataValue` object.
`list`	API to retrieve a list of `CmsMetadataValue` objects.