REST Resource: networks.cmsMetadataValues

  • CmsMetadataValue represents a key-value pair associated with content from a publisher's CMS.

  • The CmsMetadataValue resource includes fields such as name , displayName , key , and status .

  • CmsMetadataValueStatus defines the possible states of a CMS metadata value, including ACTIVE , ARCHIVED , and INACTIVE .

  • The available methods include get to retrieve a single CmsMetadataValue and list to retrieve multiple CmsMetadataValue objects.

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 (  CmsMetadataValueStatus 
 
) 
 } 
Fields
name

string

Identifier. The resource name of the CmsMetadataValue . Format: networks/{networkCode}/cmsMetadataValues/{cmsMetadataValueId}

displayName

string

The value of this key-value pair.

key

string

Required. Immutable. The resource name of the CmsMetadataKey. Format: "networks/{networkCode}/cmsMetadataKey/{cmsMetadataKeyId}"

status

enum ( CmsMetadataValueStatus )

Output only. The status of this CMS metadata value.

CmsMetadataValueStatus

Status for CmsMetadataValue objects.

Enums
ACTIVE The value is active.
ARCHIVED The value is archived.
INACTIVE The value is not active.

Methods

get

API to retrieve a CmsMetadataKey object.

list

API to retrieve a list of CmsMetadataValue objects.
Create a Mobile Website
View Site in Mobile | Classic
Share by: