REST Resource: networks.cmsMetadataKeys
Stay organized with collections
Save and categorize content based on your preferences.
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-20 UTC.
[null,null,["Last updated 2025-08-20 UTC."],[],[],null,["# REST Resource: networks.cmsMetadataKeys\n\n- [Resource: CmsMetadataKey](#CmsMetadataKey)\n - [JSON representation](#CmsMetadataKey.SCHEMA_REPRESENTATION)\n- [CmsMetadataKeyStatus](#CmsMetadataKeyStatus)\n- [Methods](#METHODS_SUMMARY)\n\nResource: CmsMetadataKey\n------------------------\n\nKey associated with a piece of content from a publisher's CMS.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"displayName\": string, \"status\": enum (/ad-manager/api/beta/reference/rest/v1/networks.cmsMetadataKeys#CmsMetadataKeyStatus) } ``` |\n\n| Fields ||\n|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Identifier. The resource name of the `CmsMetadataKey`. Format: `networks/{networkCode}/cmsMetadataKeys/{cmsMetadataKeyId}` |\n| `displayName` | `string` Required. The key of a key-value pair. |\n| `status` | `enum (`[CmsMetadataKeyStatus](/ad-manager/api/beta/reference/rest/v1/networks.cmsMetadataKeys#CmsMetadataKeyStatus)`)` Output only. The status of this CMS metadata key. |\n\nCmsMetadataKeyStatus\n--------------------\n\nStatus for CmsMetadataKey objects.\n\n| Enums ||\n|---------------------------------------|--------------------------------------|\n| `CMS_METADATA_KEY_STATUS_UNSPECIFIED` | Default value. This value is unused. |\n| `ACTIVE` | The key is active. |\n| `INACTIVE` | The key is not active. |\n\n| Methods ------- ||\n|----------------------------------------------------------------------------------|-----------------------------------------------------|\n| ### [get](/ad-manager/api/beta/reference/rest/v1/networks.cmsMetadataKeys/get) | API to retrieve a `CmsMetadataKey` object. |\n| ### [list](/ad-manager/api/beta/reference/rest/v1/networks.cmsMetadataKeys/list) | API to retrieve a list of `CmsMetadataKey` objects. |"]]