REST Resource: networks.cmsMetadataValues
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.cmsMetadataValues\n\n- [Resource: CmsMetadataValue](#CmsMetadataValue)\n - [JSON representation](#CmsMetadataValue.SCHEMA_REPRESENTATION)\n- [CmsMetadataValueStatus](#CmsMetadataValueStatus)\n- [Methods](#METHODS_SUMMARY)\n\nResource: CmsMetadataValue\n--------------------------\n\nKey value pair associated with a piece of content from a publisher's CMS.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"displayName\": string, \"key\": string, \"status\": enum (/ad-manager/api/beta/reference/rest/v1/networks.cmsMetadataValues#CmsMetadataValueStatus) } ``` |\n\n| Fields ||\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Identifier. The resource name of the `CmsMetadataValue`. Format: `networks/{networkCode}/cmsMetadataValues/{cmsMetadataValueId}` |\n| `displayName` | `string` The value of this key-value pair. |\n| `key` | `string` Required. Immutable. The resource name of the CmsMetadataKey. Format: \"networks/{networkCode}/cmsMetadataKey/{cmsMetadataKeyId}\" |\n| `status` | `enum (`[CmsMetadataValueStatus](/ad-manager/api/beta/reference/rest/v1/networks.cmsMetadataValues#CmsMetadataValueStatus)`)` Output only. The status of this CMS metadata value. |\n\nCmsMetadataValueStatus\n----------------------\n\nStatus for CmsMetadataValue objects.\n\n| Enums ||\n|-----------------------------------------|--------------------------------------|\n| `CMS_METADATA_VALUE_STATUS_UNSPECIFIED` | Default value. This value is unused. |\n| `ACTIVE` | The value is active. |\n| `ARCHIVED` | The value is archived. |\n| `INACTIVE` | The value is not active. |\n\n| Methods ------- ||\n|------------------------------------------------------------------------------------|-------------------------------------------------------|\n| ### [get](/ad-manager/api/beta/reference/rest/v1/networks.cmsMetadataValues/get) | API to retrieve a `CmsMetadataKey` object. |\n| ### [list](/ad-manager/api/beta/reference/rest/v1/networks.cmsMetadataValues/list) | API to retrieve a list of `CmsMetadataValue` objects. |"]]