campaign.schema.md

XDM Business Campaign Schema

https://ns.adobe.com/xdm/classes/campaign

XDM Business Campaign is a standard Experience Data Model (XDM) class that captures the minimum required properties of a business campaign. This XDM class can only be included in the profile for customers with the B2B or B2P Edition.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	Yes	Stable	No	Forbidden	Permitted	classes/campaign.schema.json

Schema Hierarchy

• XDM Business Campaign https://ns.adobe.com/xdm/classes/campaign
  • Extensibility base schema https://ns.adobe.com/xdm/common/extensible
  • External Source System Audit Details https://ns.adobe.com/xdm/common/external-source-system-audit-details
  • Record Schema https://ns.adobe.com/xdm/data/record
  • B2B Source https://ns.adobe.com/xdm/datatypes/b2b-source

XDM Business Campaign Example

{}

XDM Business Campaign Properties

Property	Type	Required	Defined by
@id	string	Optional	Record Schema
xdm:campaignDescription	string	Optional	XDM Business Campaign (this schema)
xdm:campaignID	string	Optional	XDM Business Campaign (this schema)
xdm:campaignKey	B2B Source	Optional	XDM Business Campaign (this schema)
xdm:campaignName	string	Optional	XDM Business Campaign (this schema)
xdm:campaignType	string	Optional	XDM Business Campaign (this schema)
xdm:extSourceSystemAudit	External Source System Audit Attributes	Optional	External Source System Audit Details
*	any	Additional	this schema allows additional properties

@id

Identifier

A unique identifier for the record.

@id

• is optional
• type: string
• defined in Record Schema

@id Type

string

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

xdm:campaignDescription

Campaign Description

Campaign description.

xdm:campaignDescription

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

xdm:campaignDescription Type

string

xdm:campaignID

Campaign ID

Unique identifer for campaign.

xdm:campaignID

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

xdm:campaignID Type

string

xdm:campaignKey

Campaign Key

Unique composite identifier of the Campaign.

xdm:campaignKey

• is optional
• type: B2B Source
• defined in this schema

xdm:campaignKey Type

• B2B Source – https://ns.adobe.com/xdm/datatypes/b2b-source

xdm:campaignName

Campaign Name

Friendly name for campaign.

xdm:campaignName

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

xdm:campaignName Type

string

xdm:campaignType

Campaign Type

The type of campaign for which audience gets selected.

xdm:campaignType

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

xdm:campaignType Type

string

xdm:extSourceSystemAudit

External Source System Audit Properties

Audit attributes for external sources.

xdm:extSourceSystemAudit

• is optional
• type: External Source System Audit Attributes
• defined in External Source System Audit Details

xdm:extSourceSystemAudit Type

• External Source System Audit Attributes – https://ns.adobe.com/xdm/common/external-source-system-audit