type CmsMetadataKey (v202411)
Stay organized with collections
Save and categorize content based on your preferences.
Service
CmsMetadataService
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-06 UTC.
[null,null,["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eCmsMetadataKey objects represent keys linked to publisher's CMS content, identified by a unique ID.\u003c/p\u003e\n"],["\u003cp\u003eEach key has a name used in key-value pairs and a status (ACTIVE, INACTIVE, or UNKNOWN) indicating its current state.\u003c/p\u003e\n"],["\u003cp\u003eThe CmsMetadataKey object has a namespace of \u003ccode\u003ehttps://www.google.com/apis/ads/publisher/v202411\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe ID of a CmsMetadataKey is read-only and assigned by Google.\u003c/p\u003e\n"]]],[],null,["# type CmsMetadataKey (v202411)\n\n**Service** \n**CmsMetadataService** **Dependencies** \n[CmsMetadataKeyPage](/ad-manager/api/reference/v202411/CmsMetadataService.CmsMetadataKeyPage) [CmsMetadataValue](/ad-manager/api/reference/v202411/CmsMetadataService.CmsMetadataValue) \n▼\n**CmsMetadataKey**\n\nKey associated with a piece of content from a publisher's CMS.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202411`\n\n| Field ----- ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `id` | ` `xsd:`long` The ID of this CMS metadata key. This field is read-only and provided by Google. |\n| ### `name` | ` `xsd:`string` The key of a key-value pair. |\n| ### `status` | ` `[CmsMetadataKeyStatus](/ad-manager/api/reference/v202411/CmsMetadataService.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. \u003cbr /\u003e |"]]