Skip to content

package.schema.md

Latest commit

 

History

History
474 lines (256 loc) · 11 KB

package.schema.md

File metadata and controls

474 lines (256 loc) · 11 KB

DSP Advertising Package Schema

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

Adobe Advertising Cloud DSP Package Details.

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

Schema Hierarchy

  • DSP Advertising Package https://ns.adobe.com/xdm/adcloud/dsp/package

DSP Advertising Package Properties

Property Type Required Defined by
@id string Optional Record Schema
dsp:campaignId string Optional DSP Advertising Package (this schema)
dsp:goalInterval enum Optional DSP Advertising Package (this schema)
dsp:goalMetric string Optional DSP Advertising Package (this schema)
dsp:goalMetricValue integer Optional DSP Advertising Package (this schema)
dsp:goalType enum Optional DSP Advertising Package (this schema)
dsp:packageDescription string Optional DSP Advertising Package (this schema)
dsp:packageEndTime string Optional DSP Advertising Package (this schema)
dsp:packageName string Optional DSP Advertising Package (this schema)
dsp:packageStartTime string Optional DSP Advertising Package (this schema)
dsp:packageStatus enum Optional DSP Advertising Package (this schema)
dsp:pricePerUom number Optional DSP Advertising Package (this schema)
dsp:purchaseUom enum Optional DSP Advertising Package (this schema)
dsp:unitsPurchased number Optional DSP Advertising Package (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:campaignId

Campaign Identifier

Campaign Identifier on the display advertising platform which has this package associated.

dsp:campaignId

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

dsp:campaignId Type

string

dsp:goalInterval

Goal Interval

The time frame for which the metric value is computed. E.g. DAY, ALLTIME

dsp:goalInterval

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

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

dsp:goalInterval Known Values

Value Description
ALLTIME ALLTIME
DAY DAY
HOUR HOUR
MONTH MONTH
WEEK WEEK

dsp:goalMetric

Goal Metric

The metric on which the pacing occurs so that the campaign hits the desired metric value over the course of its lifetime. E.g. SPEND, IMPRESSIONS

dsp:goalMetric

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

dsp:goalMetric Type

string

dsp:goalMetricValue

Goal Interval

The maximum value allowed for the metric to reach in a certain interval.

dsp:goalMetricValue

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

dsp:goalMetricValue Type

integer

dsp:goalType

Goal Type

The action taken when the metric hits the maximum value.

dsp:goalType

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

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

dsp:goalType Known Values

Value Description
CAP CAP
PACE PACE

dsp:packageDescription

Package Description

The description of the package.

dsp:packageDescription

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

dsp:packageDescription Type

string

dsp:packageEndTime

Package End Time

The end time of serving ads in placements linked to the campaign belonging to this package.

dsp:packageEndTime

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

dsp:packageEndTime Type

string

dsp:packageName

Package Name

The name of the package.

dsp:packageName

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

dsp:packageName Type

string

dsp:packageStartTime

Package Start Time

The starting time of serving ads in placements linked to the campaign belonging to this package.

dsp:packageStartTime

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

dsp:packageStartTime Type

string

dsp:packageStatus

Package Status

Package Status indicates if underlying ads are eligible to serve.

dsp:packageStatus

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

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

dsp:packageStatus Known Values

Value Description
Active Active
Inactive Inactive
Deleted Deleted

dsp:pricePerUom

Price per Unit of Measure

The price per unit of measure.

dsp:pricePerUom

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

dsp:pricePerUom Type

number

dsp:purchaseUom

Purchase Unit of Measure

The unit-of-measure of the purchase.

dsp:purchaseUom

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

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

dsp:purchaseUom Known Values

Value Description
CPM CPM
CPV CPV
CPE CPE
CPCV CPCV
CPC CPC
OTCPM OTCPM
vCPM vCPM
GRP GRP
vCPCV vCPCV

dsp:unitsPurchased

Units Purchased

The number of purchased units.

dsp:unitsPurchased

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

dsp:unitsPurchased Type

number

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