...
Boolean - defines the availability (logical state) of an attribute. Possible values:
true
or1
;false
or0
;
Enum (enumeration) is a key-value type structure that defined possible values for an attribute. To set enum type attribute value one of the next approaches can be used:
Numeric enum value;
String enum key - in this case, input data will be more self-descriptive (ex
PENDING
instead of0
). By default, all the enum keys are uppercased with an underscore between words, but in the input data you can use any case and use spaces instead of underscore to have more readable data (exCLICK_WITH_SOUND_ON
is equal toClick with sound ON
);
2.1 Basic attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
name | string | required | Name of the ad-source | - |
cpm | numeric | optional | Gross rate/auction floor price ($) | 0 |
status | enum | optional | status of the ad-source |
|
environment | enum | optional | Environment of the ad-source | - |
ownerType | enum | optional | Type of the ad-source’s owner |
|
advertiser | string | optional | Name of the advertiser entity which should be associated with a new adsource | - |
channel | string | optional | Name of the Channel which should be associated with a new adsource | - |
priority | numeric | optional | Channel’s priority for the new ad-source | 1 - First priority |
source | object | required | Ad-source’s source configuration | - |
requestsPerDay | object | optional | Ad-source’s request capping | - |
impressionCap | object | optional | Ad-source’s impression capping | - |
priceException | object | optional | Ad-source’s price exception configuration | - |
playerSettings | object | optional | Player settings configuration | - |
tpp | object | optional | Third Party Platform configuration | - |
targeting | object | optional | Ad-source’s targeting configuration | - |
prebid | object | optional | required for | Prebid ad-source specific configuration | - |
creativeType | enum | required | Creative Type of an ad-source (allowed creative types) |
|
displayFormat | enum | optional | Display Format of an ad-source (allowed display formats) | - |
provider | enum | optional | Type of the ad-source’s provider | - |
ownerPublisherId | string | optional | Name of the Publisher entity which should be associated with an adsource | - |
Creative Size | enum | required for | Display Tag ad-source specific configuration |
2.2 Source Attributes
Anchor | ||||
---|---|---|---|---|
|
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
url | string | required | Url link of the ad-source (in case of prebid - valid prebid json should be provided) | - |
mode | enum | optional | - | |
type | enum | optional | Type of ad-source |
|
clickThroughUrl | string | optional | Link for click-through action | - |
platform | enum | optional | Platform of the platform link source | - |
environment | enum | optional | required for | Environment of the platform link source | - |
2.3 Requests Per Day Attributes
Anchor | ||||
---|---|---|---|---|
|
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
limit | numeric | optional | required if | Limit of daily requests | - |
hasLimit | boolean | optional | Activates limitation by daily requests | false |
servingMode | enum | optional | Serving mode of request capping |
|
2.4 Impression Capping Attributes
Anchor | ||||
---|---|---|---|---|
|
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
sum | numeric | optional | Capping limit | - |
frequency | enum | optional |
|
2.5 Price Exception Attributes
Anchor | ||||
---|---|---|---|---|
|
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
enabled | boolean | optional | Activates price exception accounting | false |
value | numeric | optional | required if | Revenue share | - |
max | numeric | optional | Max CPM | - |
type | enum | optional | Accounting Type | - |
cutModel | enum | optional | Exception Cut Model | - |
2.6 Player Settings Attributes
Anchor | ||||
---|---|---|---|---|
|
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
maxRPM | numeric | optional | Maximum Requests per Minute (between 0 - 60) | - |
tagTimeout | numeric | optional | The timeout to wait for an ad-source until we kill it in start/init ad. | - |
2.7 Third Party Platform Attributes
Anchor | ||||
---|---|---|---|---|
|
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
tppAsid | string | optional | required if | Third party platform adsource id | - |
tppId | enum | optional | Third party platform | - |
2.8 Targeting Attributes
Anchor | ||||
---|---|---|---|---|
|
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
country.include | boolean | optional | Inclusion of the countries | - |
country.list | string | optional | required if | Comma-separated list of country-codes (ex | - |
domain.include | boolean | optional | Inclusion of the domains | - |
domain.list | string | optional | required if | Comma-separated list of domain lists names OR Comma-separated list of domain names within square brackets: [domain.com , site.com, webpage.com] | |
deviceType.include | boolean | optional | Inclusion of the device types | true |
deviceType.list | string | optional | Comma-separated list. Possible Values: Desktop, Tablet, Smartphone, Feature Phone, Smart-TV, Robot, Other non-Mobile, Other Mobile. |
2.9 Prebid Attributes
Anchor | ||||
---|---|---|---|---|
|
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
platform | enum | required | Prebid platform, (allowed platforms) | - |
...
2.10 Prebid Attributes Per Platform
Anchor | ||||
---|---|---|---|---|
|
2.10.1 OpenX Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
unit | string | required | - | - |
delDomain | string | required | - | - |
videoContext | enum | required | - | |
environment | enum | required |
2.10.2 IX Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
siteId | string | required | - | - |
skippable | boolean | optional | - | - |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - |
2.10.3 LKQD Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
siteId | string | required | - | - |
placementId | string | required | - | - |
videoContext | enum | required | - |
2.10.4 GRID Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
adTagId | string | required | - | - |
videoContext | enum | required | - |
2.10.5 MARS Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
zoneId | numeric | required | - | - |
skippable | boolean | optional | - | - |
startDelay | enum | required |
| |
videoContext | enum | required | - | |
playbackMethod | enum | required | - |
2.10.6 ADMAN Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
placementId | string | required | - | - |
videoContext | enum | required | - |
2.10.7 SPOTX Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
channelId | string | required | - | - |
2.10.8 XAXIS Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
skippable | boolean | optional | - | - |
placementId | string | required | - | - |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - |
2.10.9 GUMGUM Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
zoneId | string | required | - | - |
maxDuration | numeric | optional | min=1, max=600 | 60 |
placement | enum | required | ||
startDelay | enum | required |
| |
videoContext | enum | required | - |
2.10.10 ONETAG Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
publisherId | string | required | - | - |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - |
2.10.11 ADFORM Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
domain | string | optional | - | - |
mid | string | required | - | - |
videoContext | enum | required | - |
2.10.12 UNRULY Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
siteId | string | required | - | - |
targetingUUID | string | required | - | - |
videoContext | enum | required | - |
2.10.13 LOOPME Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
appId | string | required | - | - |
videoContext | enum | required | - |
2.10.14 TREMOR Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
adCode | string | required | - | - |
supplyCode | string | required | - | - |
placement | enum | required | - | |
videoContext | enum | required | - |
2.10.15 SONOBI Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
seatId | string | required | - | - |
videoContext | enum | required | - |
2.10.16 SPOTXV2 Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
channelId | string | required | - | - |
videoContext | enum | required | - | |
cookieSync.syncId | string | optional | - | - |
cookieSync.provider | enum | optional | - |
2.10.17 EMX Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
skippable | boolean | optional | - | - |
seatId | string | required | - | - |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - |
2.10.18 SYNACOR Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
seatId | string | required | - | - |
position | enum | required | - | |
placement | enum | required | - | |
placementId | string | required | - | - |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - | |
playbackMethod | enum | required | - |
2.10.19 YIELDMO Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
position | enum | required | - | |
placement | enum | required | - | |
skippable | boolean | optional | - | - |
startDelay | enum | required |
| |
placementId | string | required | - | - |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - | |
playbackMethod | enum | required | - |
2.10.20 RUBICON Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
siteId | string | required | - | - |
zoneId | numeric | required | - | - |
position | enum | required | - | |
size_id | enum | required | - | |
accountId | string | required | - | - |
videoContext | enum | required | - |
2.10.21 ONEVIDEO Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
siteId | string | optional | - | - |
adTagId | string | required | - | - |
placement | enum | required | - | |
publisherId | string | required | - | - |
videoContext | enum | required | - |
2.10.22 UCFUNNEL Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
seatId | string | required | - | - |
videoContext | enum | required | - |
2.10.23 APPNEXUS Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
skippable | boolean | optional | - | - |
placementId | string | required | - | - |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - |
2.10.24 YIELDLAB Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
adSlot | string | required | - | - |
supplyCode | string | required | - | - |
videoContext | enum | required | - |
2.10.25 RUBICON2 Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
siteId | string | required | - | - |
zoneId | numeric | required | - | - |
position | enum | required | - | |
size_id | enum | required | - | |
accountId | string | required | - | - |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - |
2.10.26 PUBMATIC Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
placement | enum | required | - | |
skippable | boolean | optional | - | - |
publisherId | string | required | - | - |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - |
2.10.27 MEDIANET Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
placement | enum | required | - | |
startDelay | enum | required |
| |
publisherId | string | required | - | - |
placementId | string | required | - | - |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - | |
playbackMethod | enum | required | - |
2.10.28 ADSDATAAV Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
url | string | required | - | - |
publisherId | string | required | - | - |
2.10.29 RHYTHMONE Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
placementId | string | required | - | - |
videoContext | enum | required | - |
2.10.30 UNDERTONE Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
skippable | boolean | optional | - | - |
publisherId | string | required | - | - |
placementId | string | optional | - | - |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - | |
playbackMethod | enum | required | - |
2.10.31 FREEWHEEL Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
zoneId | numeric | required | - | - |
videoContext | enum | required | - |
2.10.32 PULSEPOINT Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
position | enum | required | - | |
placement | enum | required | ||
adTagId | string | required | - | - |
publisherId | string | required | - | - |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - | |
playbackMethod | enum | required | - |
2.10.33 BEACHFRONT Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
appId | string | required | - | - |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - | |
playbackMethod | enum | required | - |
2.10.34 CONVERSANT Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
siteId | string | required | - | - |
position | enum | required | - | |
adTagId | string | required | - | - |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - |
2.10.35 IRONSOURCE Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
publisherId | string | required | - | - |
videoContext | enum | required | - |
2.10.36 TRIPLELIFT Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
inventoryCode | string | required | - | - |
videoContext | enum | required | - |
2.10.37 QUANTUMDEX Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
siteId | string | required | - | - |
videoContext | enum | required | - |
2.10.38 KRUSH_MEDIA Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
key | string | required | - | - |
videoContext | enum | required | - |
2.10.39 LUNA_MEDIA_HB Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
placementId | string | required | - | - |
videoContext | enum | required | - |
2.10.40 RICH_AUDIENCE Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
placementId | string | required | - | - |
videoContext | enum | required | - |
2.10.41 _33ACROSS Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
siteId | string | required | - | - |
placement | enum | required | ||
startDelay | enum | required |
| |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - | |
playbackMethod | enum | required | - |
2.10.42 SMARTADSERVER Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
domain | string | optional | - | - |
siteId | string | required | - | - |
pageId | string | required | - | - |
formatId | string | required | - | - |
startDelay | enum | required |
| |
videoContext | enum | required | - |
2.10.43 IMPROVEDIGITAL Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
---|---|---|---|---|
publisherId | string | required | - | - |
placementKey | string | required | - | - |
videoContext | enum | required | - |
...
3. Supported Enumerations
3.1 Statuses Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 0 |
| 1 |
3.2 Environments Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 1 |
| 2 |
| 3 |
| 4 |
3.3 Owner Types Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 1 |
| 2 |
3.4 Source Modes Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 0 |
| 1 |
3.5 Source Types Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 2 |
| 4 |
| 8 |
| 9 |
3.6 Platform Link Platforms Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 1 |
| 2 |
| 3 |
| 4 |
| 5 |
| 6 |
3.7 Platform Link Environments Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 1 |
| 2 |
| 3 |
3.8 Request Capping Serving Modes Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 1 |
| 2 |
3.9 Impression Capping Frequencies Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 0 |
| 1 |
| 3 |
| 4 |
3.10 Accounting Types Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 0 |
| 1 |
3.11 Exception Cut Models Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 1 |
| 2 |
| 3 |
3.12 Prebid Platforms Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 1 |
| 2 |
| 3 |
| 4 |
| 5 |
| 7 |
| 8 |
| 9 |
| 10 |
| 11 |
| 12 |
| 13 |
| 14 |
| 15 |
| 16 |
| 17 |
| 18 |
| 20 |
| 21 |
| 22 |
| 23 |
| 24 |
| 25 |
| 26 |
| 27 |
| 28 |
| 30 |
| 31 |
| 32 |
| 34 |
| 100 |
| 101 |
| 102 |
| 103 |
| 104 |
| 105 |
| 106 |
| 107 |
| 108 |
| 109 |
| 112 |
| 113 |
| 114 |
| 115 |
| 116 |
| 117 |
3.13 Video Contexts Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
|
|
|
|
3.14 Start Delays Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 0 |
| 1 |
| 2 |
| 3 |
3.15 Playback Methods Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 1 |
| 2 |
| 3 |
| 4 |
| 5 |
| 6 |
3.16 Playsments Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 1 |
| 2 |
| 3 |
| 4 |
| 5 |
| 6 |
3.17 CookieSync Providers Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 1 |
| 2 |
| 24 |
| 25 |
3.18 Positions Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 0 |
| 1 |
| 2 |
| 3 |
| 4 |
| 5 |
| 6 |
| 7 |
3.19 Third Party Platforms Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 1 |
| 2 |
| 3 |
| 4 |
| 5 |
| 6 |
| 7 |
| 8 |
| 9 |
| 13 |
| 21 |
| 28 |
| 35 |
| 54 |
| 56 |
| 60 |
| 99 |
| 104 |
3.20 Size_ID Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 201 |
| 202 |
| 204 |
| 205 |
3.21 Rubicon Positions Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
|
|
|
|
3.22 Creative Types Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 1 |
| 2 |
3.23 Display Formats Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 1 |
3.24 OpenX Environments Enum
Anchor | ||||
---|---|---|---|---|
|
Key | Value |
---|---|
| 1 |