Skip to content

advertisement.schema.md

Latest commit

 

History

History
415 lines (229 loc) · 9.64 KB

advertisement.schema.md

File metadata and controls

415 lines (229 loc) · 9.64 KB

DSP Advertising Advertisement Schema

https://ns.adobe.com/xdm/adcloud/dsp/advertisement

Adobe Advertising Cloud DSP Advertisement Details.

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

Schema Hierarchy

  • DSP Advertising Advertisement https://ns.adobe.com/xdm/adcloud/dsp/advertisement

DSP Advertising Advertisement Example

{
  "@id": "14",
  "dsp:adKey": "yyyy029YLCDvseo8QhTE",
  "dsp:adStatus": "Active",
  "dsp:adClass": "inbanner",
  "dsp:adUnitType": "Flash",
  "dsp:externalCreativeId": "5121209",
  "dsp:promotedVideoId": "14",
  "dsp:adServerId": "2",
  "dsp:placementIds": [
    "1"
  ]
}

DSP Advertising Advertisement Properties

Property Type Required Defined by
@id string Optional Record Schema
dsp:adClass string Optional DSP Advertising Advertisement (this schema)
dsp:adKey string Optional DSP Advertising Advertisement (this schema)
dsp:adName string Optional DSP Advertising Advertisement (this schema)
dsp:adServerId string Optional DSP Advertising Advertisement (this schema)
dsp:adStatus enum Optional DSP Advertising Advertisement (this schema)
dsp:adUnitType enum Optional DSP Advertising Advertisement (this schema)
dsp:externalCreativeId string Optional DSP Advertising Advertisement (this schema)
dsp:placementIds string[] Optional DSP Advertising Advertisement (this schema)
dsp:promotedVideoId string Optional DSP Advertising Advertisement (this schema)
repo:createDate string Optional Audit trail
repo:modifyDate string Optional Audit trail
xdm:createdByBatchID string Optional Audit trail
xdm:modifiedByBatchID string Optional Audit trail
xdm:repositoryCreatedBy string Optional Audit trail
xdm:repositoryLastModifiedBy string Optional Audit trail
* 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)

dsp:adClass

Ad Class

Ad class of driving event.

dsp:adClass

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

dsp:adClass Type

string

dsp:adKey

Ad Key

Ad external unique identifier.

dsp:adKey

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

dsp:adKey Type

string

dsp:adName

Ad Name

Ad name.

dsp:adName

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

dsp:adName Type

string

dsp:adServerId

Ad Server Identifier

Identifier for the Ad Server providing this Ad.

dsp:adServerId

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

dsp:adServerId Type

string

dsp:adStatus

Ad Status

Ad Status indicates if it is eligible to be served.

dsp:adStatus

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

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

dsp:adStatus Known Values

Value Description
Active Active
Inactive Inactive
Deleted Deleted

dsp:adUnitType

Ad Unit Type

Identifier for the literal piece of code driving display of the ad in a browser/device.

dsp:adUnitType

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

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

dsp:adUnitType Known Values

Value Description
Onsite Onsite
Flash Flash
Embed Embed
YouTube YouTube
New Flash New Flash
HTML5 HTML5
instream instream
vast_proxy vast_proxy
external_instream external_instream
instream_selector instream_selector
inbanner_3rd_party inbanner_3rd_party
external_inbanner external_inbanner
mraid_3rd_party mraid_3rd_party
dooh dooh
standard_display standard_display
fb_news_feed_post fb_news_feed_post
fb_news_feed fb_news_feed

dsp:externalCreativeId

External Creative Identifier

Identifier for the creative which this ad is associated with.

dsp:externalCreativeId

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

dsp:externalCreativeId Type

string

dsp:placementIds

Placement Ids

List of Placement Ids where this Ad is used.

dsp:placementIds

  • is optional

  • type: string[]

  • defined in this schema

dsp:placementIds Type

Array type: string[]

All items must be of the type: string

dsp:promotedVideoId

Promoted Video Identifier

Promoted video Identifier contained in this Ad.

dsp:promotedVideoId

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

dsp:promotedVideoId Type

string

repo:createDate

The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00".

repo:createDate

repo:createDate Type

string

repo:createDate Example

"2004-10-23T12:00:00-06:00"

repo:modifyDate

The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00".

repo:modifyDate

repo:modifyDate Type

string

repo:modifyDate Example

"2004-10-23T12:00:00-06:00"

xdm:createdByBatchID

Created by batch identifier

The dataset files in Catalog which has been originating the creation of the record.

xdm:createdByBatchID

xdm:createdByBatchID Type

string

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

xdm:modifiedByBatchID

Modified by batch identifier

The last dataset files in Catalog which has modified the record. At creation time, modifiedByBatchID is set as createdByBatchID.

xdm:modifiedByBatchID

xdm:modifiedByBatchID Type

string

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

xdm:repositoryCreatedBy

Created by user identifier

User ID of who created the record.

xdm:repositoryCreatedBy

xdm:repositoryCreatedBy Type

string

xdm:repositoryLastModifiedBy

Modified by user identifier

User ID of who last modified the record. At creation time, modifiedByUser is set as createdByUser.

xdm:repositoryLastModifiedBy

xdm:repositoryLastModifiedBy Type

string