REST Resource: networks.cmsMetadataKeys

  • A CmsMetadataKey is a key associated with content from a publisher's CMS.

  • CmsMetadataKey objects have fields for name, displayName, and status.

  • CmsMetadataKeyStatus indicates whether a key is active or inactive.

  • Methods are available to get and list CmsMetadataKey objects.

Resource: CmsMetadataKey

Key associated with a piece of content from a publisher's CMS.

JSON representation
 { 
 "name" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "status" 
 : 
 enum (  CmsMetadataKeyStatus 
 
) 
 } 
Fields
name

string

Identifier. The resource name of the CmsMetadataKey . Format: networks/{networkCode}/cmsMetadataKeys/{cmsMetadataKeyId}

displayName

string

Required. The key of a key-value pair.

status

enum ( CmsMetadataKeyStatus )

Output only. The status of this CMS metadata key.

CmsMetadataKeyStatus

Status for CmsMetadataKey objects.

Enums
ACTIVE The key is active.
INACTIVE The key is not active.

Methods

get

API to retrieve a CmsMetadataKey object.

list

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