type CmsMetadataValue (v202508)

  • CmsMetadataValue represents a key-value pair from a publisher's CMS associated with content.

  • Each CmsMetadataValue has a unique ID (cmsMetadataValueId) used for targeting, which is read-only and provided by Google.

  • The valueName field stores the string value of the key-value pair.

  • The status field indicates the current state of the CMS metadata value (e.g., ACTIVE, INACTIVE, ARCHIVED), and is read-only.
Service
CmsMetadataService
Dependencies
CmsMetadataValuePage
▼
CmsMetadataValue

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

Namespace
https://www.google.com/apis/ads/publisher/v202508

Field

cmsMetadataValueId

xsd:long

The ID of this CMS metadata value, to be used in targeting. This field is read-only and provided by Google.

valueName

xsd:string

The value of this key-value pair.

key

CmsMetadataKey

status

CmsMetadataValueStatus

The status of this CMS metadata value. This attribute is read-only.

Enumerations
ACTIVE
INACTIVE
ARCHIVED
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.