Skip to content

Latest commit

 

History

History
433 lines (233 loc) · 10.1 KB

placement.schema.md

File metadata and controls

433 lines (233 loc) · 10.1 KB
Raw

DSP Advertising Campaign Placement Schema

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

Adobe Advertising Cloud DSP Campaign Placement Details.

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

Schema Hierarchy

  • DSP Advertising Campaign Placement https://ns.adobe.com/xdm/adcloud/dsp/placement

DSP Advertising Campaign Placement Example

{
  "@id": "1",
  "dsp:placementKey": "YFk8RnlYHwnG4KbFSQor",
  "dsp:placementName": "Yahoo : CTP : UK : YouTube",
  "dsp:placementType": "Site",
  "dsp:placementStartTime": "2017-02-26T15:52:25+00:00",
  "dsp:placementEndTime": "2017-09-26T15:52:25+00:00",
  "dsp:placementBudget": 123,
  "dsp:campaignId": "12",
  "dsp:packageId": "1",
  "dsp:siteId": "12334",
  "dsp:adIds": [
    "1",
    "2"
  ],
  "repo:createDate": "2019-04-26T14:00:00+00:00",
  "repo:modifyDate": "2019-04-27T14:00:00+00:00"
}

DSP Advertising Campaign Placement Properties

Property Type Required Defined by
@id string Optional Record Schema
dsp:adIds string[] Optional DSP Advertising Campaign Placement (this schema)
dsp:campaignId string Optional DSP Advertising Campaign Placement (this schema)
dsp:packageId string Optional DSP Advertising Campaign Placement (this schema)
dsp:placementBudget integer Optional DSP Advertising Campaign Placement (this schema)
dsp:placementEndTime string Optional DSP Advertising Campaign Placement (this schema)
dsp:placementKey string Optional DSP Advertising Campaign Placement (this schema)
dsp:placementName string Optional DSP Advertising Campaign Placement (this schema)
dsp:placementStartTime string Optional DSP Advertising Campaign Placement (this schema)
dsp:placementType enum Optional DSP Advertising Campaign Placement (this schema)
dsp:siteId string Optional DSP Advertising Campaign Placement (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:adIds

Ad Identifiers

List of identifiers for the ads which are linked to this campaign placement.

dsp:adIds

  • is optional

  • type: string[]

  • defined in this schema

dsp:adIds Type

Array type: string[]

All items must be of the type: string

dsp:campaignId

Campaign Identifier

Identifier of the campaign this placement belongs to.

dsp:campaignId

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

dsp:campaignId Type

string

dsp:packageId

Package Identifier

Identifier of the package the placement belongs to.

dsp:packageId

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

dsp:packageId Type

string

dsp:placementBudget

Campaign Placement Budget

Campaign placement budget.

dsp:placementBudget

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

dsp:placementBudget Type

integer

dsp:placementEndTime

Campaign Placement End Date and Time

The date after which a placement stops showing ads (ms since Jan 1, 1970).

dsp:placementEndTime

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

dsp:placementEndTime Type

string

dsp:placementKey

Placement Key

Campaign Placement external unique identifier.

dsp:placementKey

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

dsp:placementKey Type

string

dsp:placementName

Name

Campaign Placement name.

dsp:placementName

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

dsp:placementName Type

string

dsp:placementStartTime

Campaign Placement Start Date and Time

The date on which a placement starts showing ads (ms since Jan 1, 1970)

dsp:placementStartTime

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

dsp:placementStartTime Type

string

dsp:placementType

Placement Type

Budget Type indicates how the allocated budget will be spent

dsp:placementType

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

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

dsp:placementType Known Values

Value Description
Direct Direct
Site Site
Network Network
Planner Planner
Audit Audit
ParentPlan ParentPlan
ChildPlan ChildPlan
Template Template
SAS SAS

dsp:siteId

Site Identifier

Identifier of the site where the placement will be shown.

dsp:siteId

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

dsp:siteId 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