type CmsMetadataKey (v202408)
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/v202408
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 represents a key associated with content from a publisher's CMS, identified by a unique ID and name.\u003c/p\u003e\n"],["\u003cp\u003eIt includes a status field, indicating whether the key is active, inactive, or unknown.\u003c/p\u003e\n"],["\u003cp\u003eThe key is used within a key-value pair to store metadata, with the \u003ccode\u003ename\u003c/code\u003e field storing the key itself.\u003c/p\u003e\n"],["\u003cp\u003eGoogle assigns a read-only ID for each CmsMetadataKey.\u003c/p\u003e\n"]]],["The core content defines the `CmsMetadataKey`, which is a key associated with content from a publisher's CMS. It includes an `id` (read-only, provided by Google), a `name` (key of a key-value pair), and a `status` (read-only) which can be `ACTIVE`, `INACTIVE`, or `UNKNOWN`. The service `CmsMetadataService` depends on `CmsMetadataKeyPage` and `CmsMetadataValue`. The namespace for this service is `https://www.google.com/apis/ads/publisher/v202408`.\n"],null,["# type CmsMetadataKey (v202408)\n\n**Service** \n**CmsMetadataService** **Dependencies** \n[CmsMetadataKeyPage](/ad-manager/api/reference/v202408/CmsMetadataService.CmsMetadataKeyPage) [CmsMetadataValue](/ad-manager/api/reference/v202408/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/v202408`\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/v202408/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 |"]]
