Skip to content

Latest commit

 

History

History
161 lines (95 loc) · 5.18 KB

segmentfolder.schema.md

File metadata and controls

161 lines (95 loc) · 5.18 KB
Raw

Adobe Audience Manager Segment Folder Class Schema

https://ns.adobe.com/experience/audiencemanager/segmentfolder

This Adobe Audience Manager-specific folder definition helps organize segment definitions into a hierarchy. This includes required fields like folder identity and folder name. The segment definition class requires use of the 'Adobe Audience Manager Segment Definition' fieldgroup in order to point to the parent folder, which is an instance of this class.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted adobe/experience/audiencemanager/segmentfolder.schema.json

Schema Hierarchy

  • Adobe Audience Manager Segment Folder Class https://ns.adobe.com/experience/audiencemanager/segmentfolder
    • Identity https://ns.adobe.com/xdm/context/identity
    • IdentityMap https://ns.adobe.com/xdm/context/identitymap
    • Record Schema https://ns.adobe.com/xdm/data/record

Adobe Audience Manager Segment Folder Class Example

{
  "xdm:identityMap": {
    "AAMSegments": [
      {
        "xdm:id": "id123",
        "xdm:primary": true
      }
    ]
  },
  "https://ns.adobe.com/experience/audiencemanager/segmentFolderName": "User Folder",
  "https://ns.adobe.com/experience/audiencemanager/segmentFolderStatus": "ACTIVE",
  "https://ns.adobe.com/experience/audiencemanager/segmentParentFolderIdentity": {
    "xdm:id": "id1111",
    "xdm:namespace": {
      "xdm:code": "AAMSegments"
    }
  }
}

Adobe Audience Manager Segment Folder Class Properties

Property Type Required Defined by
@id string Optional Record Schema
https://ns.adobe.com/experience/audiencemanager/segmentFolderName string Required Adobe Audience Manager Segment Folder Class (this schema)
https://ns.adobe.com/experience/audiencemanager/segmentFolderStatus string Optional Adobe Audience Manager Segment Folder Class (this schema)
https://ns.adobe.com/experience/audiencemanager/segmentParentFolderIdentity Identity Optional Adobe Audience Manager Segment Folder Class (this schema)
xdm:identityMap object Required IdentityMap
* any Additional this schema allows additional properties

@id

Identifier

A unique identifier for the record.

@id

@id Type

string

  • format: uri-reference – URI Reference (according to RFC3986)

https://ns.adobe.com/experience/audiencemanager/segmentFolderName

Segment folder name

Name of the segment folder

https://ns.adobe.com/experience/audiencemanager/segmentFolderName

  • is required
  • type: string
  • defined in this schema

https://ns.adobe.com/experience/audiencemanager/segmentFolderName Type

string

https://ns.adobe.com/experience/audiencemanager/segmentFolderStatus

Segment folder status

Current status of segment folder

https://ns.adobe.com/experience/audiencemanager/segmentFolderStatus

  • is optional
  • type: string
  • defined in this schema

https://ns.adobe.com/experience/audiencemanager/segmentFolderStatus Type

string

https://ns.adobe.com/experience/audiencemanager/segmentFolderStatus Known Values

Value Description
ACTIVE Active
INACTIVE Inactive
DELETED Deleted

https://ns.adobe.com/experience/audiencemanager/segmentParentFolderIdentity

Parent folder identity

Identity of the parent folder of current folder

https://ns.adobe.com/experience/audiencemanager/segmentParentFolderIdentity

  • is optional
  • type: Identity
  • defined in this schema

https://ns.adobe.com/experience/audiencemanager/segmentParentFolderIdentity Type

  • Identity – https://ns.adobe.com/xdm/context/identity

xdm:identityMap

xdm:identityMap

xdm:identityMap Type

object with following properties:

Property Type Required