Skip to content

dim-segment.schema.md

Latest commit

 

History

History
238 lines (117 loc) · 3.76 KB

dim-segment.schema.md

File metadata and controls

238 lines (117 loc) · 3.76 KB

Segment Dimension Schema

https://ns.adobe.com/xdm/context/dim-segment

This is the dimension schema for a segment definition which includes required fields like segment ID and name of segment.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted insights-metrics/dim-segment.schema.json

Schema Hierarchy

  • Segment Dimension https://ns.adobe.com/xdm/context/dim-segment

Segment Dimension Example

{
  "xdm:segment": {
    "xdm:ID": "0f4ac2cd-a007-4e18-af2b-20c3dd64a8a2",
    "xdm:name": "Users with TV segment",
    "xdm:status": "ACTIVE"
  }
}

Segment Dimension Properties

Property Type Required Defined by
@id string Optional Record Schema
xdm:segment object Optional Segment Dimension (this schema)
* 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)

xdm:segment

Segment Dimension and its properties.

xdm:segment

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

xdm:segment Type

object with following properties:

Property Type Required
xdm:ID string Optional
xdm:description string Optional
xdm:name string Optional
xdm:namespace string Optional
xdm:source string Optional
xdm:status string Optional
xdm:version string Optional

xdm:ID

Segment Identifier

Unique identifier of the segment.

xdm:ID

  • is optional
  • type: string
xdm:ID Type

string

xdm:description

Segment description

Description of the segment.

xdm:description

  • is optional
  • type: string
xdm:description Type

string

xdm:name

Segment name

Name of the segment.

xdm:name

  • is optional
  • type: string
xdm:name Type

string

xdm:namespace

Segment Namespace

Segment namespace.

xdm:namespace

  • is optional
  • type: string
xdm:namespace Type

string

xdm:source

Segment Source

Segment source indicating whether the segment was sent from an internal or external source.

xdm:source

  • is optional
  • type: string
xdm:source Type

string

xdm:status

Segment status

Current status of segment from external system normalized to active, inactive, deleted, draft or revoked.

xdm:status

  • is optional
  • type: enum

The value of this property must be equal to one of the known values below.

xdm:status Known Values
Value Description
ACTIVE Active
INACTIVE Inactive
DELETED Deleted
DRAFT Draft
REVOKED Revoked

xdm:version

Segment version

Version of the segment.

xdm:version

  • is optional
  • type: string
xdm:version Type

string