type CmsMetadataValue (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
Service
CmsMetadataService
Key value pair associated with a piece of content from a publisher's CMS.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202408
Field
|
|
|
xsd:long
The ID of this CMS metadata value, to be used in targeting. This field is read-only and
provided by Google.
|
valueName
|
xsd:string
The value of this key-value pair.
|
key
|
CmsMetadataKey
|
status
|
CmsMetadataValueStatus
The status of this CMS metadata value.
This attribute is read-only.
Enumerations
-
ACTIVE
-
INACTIVE
-
ARCHIVED
-
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\u003eCmsMetadataValue represents a key-value pair linked to publisher content from their CMS, used for targeting.\u003c/p\u003e\n"],["\u003cp\u003eEach CmsMetadataValue has a unique ID, a value, an associated key, and a status (active, inactive, archived, or unknown).\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ecmsMetadataValueId\u003c/code\u003e is read-only and assigned by Google, while \u003ccode\u003evalueName\u003c/code\u003e stores the actual value of the key-value pair.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ekey\u003c/code\u003e is a reference to the CmsMetadataKey object that defines the key for this value.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003estatus\u003c/code\u003e reflects the current state of the CmsMetadataValue and is also read-only.\u003c/p\u003e\n"]]],["The content details `CmsMetadataValue`, a key-value pair for publisher CMS content. It contains fields such as `cmsMetadataValueId` (read-only ID), `valueName` (the value), and `key` (referencing `CmsMetadataKey`). The `status` field, which is read-only, reflects the state of the metadata value, using enumerated options `ACTIVE`, `INACTIVE`, `ARCHIVED`, and `UNKNOWN`. This data is used for targeting and is part of the `CmsMetadataService`.\n"],null,["# type CmsMetadataValue (v202408)\n\n**Service** \n**CmsMetadataService** **Dependencies** \n[CmsMetadataValuePage](/ad-manager/api/reference/v202408/CmsMetadataService.CmsMetadataValuePage) \n▼\n**CmsMetadataValue**\n\nKey value pair 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| ### `cmsMetadataValueId` | ` `xsd:`long` The ID of this CMS metadata value, to be used in targeting. This field is read-only and provided by Google. |\n| ### `valueName` | ` `xsd:`string` The value of this key-value pair. |\n| ### `key` | ` `[CmsMetadataKey](/ad-manager/api/reference/v202408/CmsMetadataService.CmsMetadataKey)` ` \u003cbr /\u003e |\n| ### `status` | ` `[CmsMetadataValueStatus](/ad-manager/api/reference/v202408/CmsMetadataService.CmsMetadataValueStatus)` ` The status of this CMS metadata value. This attribute is read-only. *** ** * ** *** **Enumerations** `ACTIVE` : `INACTIVE` : `ARCHIVED` : `UNKNOWN` : The value returned if the actual value is not exposed by the requested API version. \u003cbr /\u003e |"]]
