AI-generated Key Takeaways
-
CmsMetadataValuerepresents a key-value pair associated with content from a publisher's CMS. -
The
CmsMetadataValueresource includes fields such asname,displayName,key, andstatus. -
CmsMetadataValueStatusdefines the possible states of a CMS metadata value, includingACTIVE,ARCHIVED, andINACTIVE. -
The available methods include
getto retrieve a singleCmsMetadataValueandlistto retrieve multipleCmsMetadataValueobjects.
Resource: CmsMetadataValue
Key value pair associated with a piece of content from a publisher's CMS.
| JSON representation |
|---|
{
"name"
:
string
,
"displayName"
:
string
,
"key"
:
string
,
"status"
:
enum (
|
| Fields | |
|---|---|
name
|
Identifier. The resource name of the |
displayName
|
The value of this key-value pair. |
key
|
Required. Immutable. The resource name of the CmsMetadataKey. Format: "networks/{networkCode}/cmsMetadataKey/{cmsMetadataKeyId}" |
status
|
Output only. The status of this CMS metadata value. |
CmsMetadataValueStatus
Status for CmsMetadataValue objects.
| Enums | |
|---|---|
CMS_METADATA_VALUE_STATUS_UNSPECIFIED
|
Default value. This value is unused. |
ACTIVE
|
The value is active. |
ARCHIVED
|
The value is archived. |
INACTIVE
|
The value is not active. |
Methods |
|
|---|---|
|
API to retrieve a CmsMetadataKey
object. |
|
API to retrieve a list of CmsMetadataValue
objects. |

