type CmsMetadataKey (v202411)

  • CmsMetadataKey objects represent keys linked to publisher's CMS content, identified by a unique ID.

  • Each key has a name used in key-value pairs and a status (ACTIVE, INACTIVE, or UNKNOWN) indicating its current state.

  • The CmsMetadataKey object has a namespace of https://www.google.com/apis/ads/publisher/v202411.

  • The ID of a CmsMetadataKey is read-only and assigned by Google.
Service
CmsMetadataService
Dependencies
CmsMetadataKeyPage CmsMetadataValue
▼
CmsMetadataKey

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

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

Field

id

xsd:long

The ID of this CMS metadata key. This field is read-only and provided by Google.

name

xsd:string

The key of a key-value pair.

status

CmsMetadataKeyStatus

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

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