Skip to content

Latest commit

 

History

History
175 lines (106 loc) · 4.43 KB

agency.schema.md

File metadata and controls

175 lines (106 loc) · 4.43 KB
Raw

E-Mail Schema

https://ns.adobe.com/xdm/channels/agency

The marketing experience is handed-off to an external agency. This channel has no specific mechanism and is designed for descriptive purposes only. Such as, to define experiences for which you want to keep a trace of the population targeted in an external tool

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Experimental Yes Forbidden Permitted channels/agency.schema.json

Schema Hierarchy

E-Mail Example

{
  "@id": "https://ns.adobe.com/xdm/channels/agency",
  "@type": "https://ns.adobe.com/xdm/channel-types/offline"
}

E-Mail Properties

Property Type Required Defined by
@id const Required E-Mail (this schema)
@type const Optional E-Mail (this schema)
xdm:contentTypes const Optional E-Mail (this schema)
xdm:locationTypes const Optional E-Mail (this schema)
xdm:metricTypes const Optional E-Mail (this schema)
xdm:mode const Optional E-Mail (this schema)
* any Additional this schema allows additional properties

@id

The ID uniquely identifies the channel. Each specific experience channel defines a constant @id.

@id

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

The value of this property must be equal to:

"https://ns.adobe.com/xdm/channels/agency"

@type

The @type property is used to provide a rough classification of channels with similar properties.

@type

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

The value of this property must be equal to:

"https://ns.adobe.com/xdm/channel-types/offline"

@type Known Values

Value Description
https://ns.adobe.com/xdm/channel-types/web The world wide web, including mobile web
https://ns.adobe.com/xdm/channel-types/social Social media platforms
https://ns.adobe.com/xdm/channel-types/mobile Mobile applications
https://ns.adobe.com/xdm/channel-types/messaging Instant Messaging
https://ns.adobe.com/xdm/channel-types/email E-Mail
https://ns.adobe.com/xdm/channel-types/offline Non-Digital experience channels

xdm:contentTypes

The content types that this channel can deliver.

xdm:contentTypes

  • is optional

  • type: const

  • defined in this schema

The value of this property must be equal to:

[]

xdm:locationTypes

The types of locations (virtual places) that this channel consists of and can deliver content to.

xdm:locationTypes

  • is optional

  • type: const

  • defined in this schema

The value of this property must be equal to:

[]

xdm:metricTypes

The metrics that can be collected in this channel.

xdm:metricTypes

  • is optional

  • type: const

  • defined in this schema

The value of this property must be equal to:

[]

xdm:mode

How experiences are delivered in this channel.

xdm:mode

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

The value of this property must be equal to:

"bidirectional"

xdm:mode Known Values

Value Description
push The publisher of an experience can initiate an experience by sending a message into the channel. Most push channels involve some form of subscription or opt-in.
pull The consumer can initiate an experience by requesting a location in the channel. Most pull channels give publishers some control how the experience is then delivered.
bidirectional Both push and pull interaction modes are supported by the channel.