...
Example file templates:
| View file | ||
|---|---|---|
| ||
| View file | ||
|
| View file | ||
|---|---|---|
|
| View file | ||
|---|---|---|
|
| View file | ||
|---|---|---|
|
| View file | ||
|---|---|---|
|
Provided templates are just boilerplates, all supported attributes describe below.
2. Supported attributes
Specific attribute types:
...
| View file | ||
|---|---|---|
|
| View file | ||
|---|---|---|
|
Provided templates are just boilerplates, all supported attributes describe below.
...
2. Supported attributes
Specific attribute types:
Boolean - defines the availability (logical state) of an attribute. Possible values:
trueor1;falseor0;
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
PENDINGinstead 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_ONis 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 | - |
placement |
object | required for |
|
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 |
...
Attribute Key
...
Type
...
Mandatory
...
Description
...
Default Value
...
platform
...
enum
...
required
...
Prebid platform, (allowed platforms)
Pay attention each platform requires a different set of the params which should also be provided as a part of prebid params
(attributes per platform)
...
-
...
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 Placement Attributes
| Anchor | ||||
|---|---|---|---|---|
|
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
creativeSize |
enum | required |
-
-
for | Google tag supports multiple sizes, separated with comma E.g:
Custom provider supports only 1 value E.g:
|
2.10 Prebid Attributes
| Anchor | ||||
|---|---|---|---|---|
|
Attribute Key | Type | Mandatory | Description | Default Value |
|---|---|---|---|---|
platform | enum | required | Prebid platform, (allowed platforms) | - |
...
2.11 Prebid Attributes Per Platform
| Anchor | ||||
|---|---|---|---|---|
|
2.11.1 OpenX Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|---|---|---|---|
unit | string | required | - | - |
delDomain | string | required | - | - |
videoContext | enum | required | - | |
environment | enum | required |
2.11.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.11.3 LKQD Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|---|---|---|---|
siteId | string | required | - | - |
placementId | string | required | - | - |
videoContext | enum | required | - |
2.11.4 GRID Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|---|---|---|---|
adTagId | string | required | - | - |
videoContext | enum | required | - |
2.
...
11.
...
5 MARS Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
zoneId |
numeric | required | - | - | |
skippable | boolean | optional | - | - |
maxDuration
numeric
optional
min=1, max=600
60
startDelay | enum | required |
| |
videoContext | enum | required | - | |
playbackMethod | enum | required |
- |
2.
...
11.
...
6 ADMAN Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
placementId | string | required | - | - |
videoContext |
enum | required | - |
-
videoContext
2.11.7 SPOTX Attributes
2.
...
11.
...
8 XAXIS Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
adTagId
string
required
-
skippable | boolean | optional | - | - |
placementId | string | required | - | - |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - |
2.
...
11.
...
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 | - |
playbackMethod
enum
required
-
2.11.10
...
ONETAG Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
placementId
string
required
-
publisherId | string | required | - | - |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - |
2.
...
11.
...
11 ADFORM Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
domain | string | optional | - | - |
mid | string | required | - | - |
videoContext | enum | required | - |
2.
...
11.
...
12 UNRULY Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
siteId |
string |
required | - | - |
targetingUUID | string | required | - | - |
maxDuration
numeric
optional
min=1, max=600
videoContext | enum | required | - |
2.
...
11.
...
13 LOOPME Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
appId | string | required | - | - |
maxDuration
numeric
optional
min=1, max=600
60
placement
enum
required
startDelay
enum
required
PRE_ROLLvideoContext | enum | required | - |
2.
...
11.
...
14 TREMOR Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
adCode | string | required | - | - |
supplyCode | string | required | - | - |
placement |
enum |
optional
min=1, max=600
required | - | |||
videoContext | enum | required | - |
2.
...
11.
...
15 SONOBI Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
mid
string
seatId | string |
optional
-
-
required | - | - | ||
videoContext | enum | required | - |
2.
...
11.
...
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.
...
11.
...
17 EMX Attributes
Attribute Key |
|---|
Type
Mandatory
Description
Default Value
Type | Mandatory | Description | Default Value | |
|---|---|---|---|---|
skippable | boolean | optional | - | - |
seatId | string | required | - | - |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - |
2.
...
11.
...
18 SYNACOR Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
seatId | string | required | - | - |
position |
enum | required |
- | ||||
placement | enum | required | - |
placementId |
string | required |
Attribute Key
Type
Mandatory
Description
Default Value
seatId
string
required
-
-
- | - |
2.10.15 SONOBI Attributes
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - | |
playbackMethod | enum | required |
- |
2.
...
11.
...
19 YIELDMO Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
position |
enum | required |
- |
placement | enum | required |
- |
skippable |
boolean | optional | - | - |
startDelay | enum |
required |
-
2.10.17 EMX 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 | - | |
playbackMethod | enum | required | - |
2.
...
11.
...
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 | - | - |
numeric
optional
min=1, max=600
60
videoContext | enum | required |
-
playbackMethod
enum
- |
2.
...
11.
...
21 ONEVIDEO Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
position
siteId | string | optional | - | - |
adTagId | string | required |
- | - | |||
placement | enum | required | - |
publisherId |
string |
required | - | - |
videoContext | enum | required |
PRE_ROLL
placementId
string
- |
-
maxDuration
numeric
optional
min=1, max=600
60
videoContext
enum
required
-
2.11.22 UCFUNNEL Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|---|---|---|---|
seatId | string | required | - | - |
videoContext | enum | required |
- |
2.
...
11.
...
23 APPNEXUS Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
skippable |
boolean |
optional | - | - |
placementId |
string | required | - | - |
maxDuration |
size_id
enum
required
-
accountId
string
required
-
-
numeric |
required
-
optional | min=1, max=600 | 60 | ||
videoContext | enum | required | - |
2.
...
11.
...
24 YIELDLAB Attributes
Attribute Key |
|---|
Type
Mandatory
Description
Default Value
siteId
string
optional
-
-
Type | Mandatory | Description | Default Value | |
|---|---|---|---|---|
adSlot | string | required | - | - |
placement
enum
required
-
publisherId
supplyCode | string | required | - | - |
videoContext | enum | required | - |
2.
...
11.
...
25 RUBICON2 Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
siteId | string | required | - | - |
zoneId |
numeric | required |
Attribute Key
Type
Mandatory
Description
Default Value
skippable
boolean
optional
-
-
- | - |
2.10.23 APPNEXUS Attributes
position | enum | required | - | |
size_id | enum | required | - | |
accountId | string | required | - | - |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - |
2.
...
11.
...
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.
...
11.
...
27 MEDIANET Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
placement |
enum | required |
- |
zoneId
numeric
required
-
-
position
startDelay | enum | required |
-
size_id
| ||
publisherId | string | required |
- | - |
placementId | string | required | - | - |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - | |
playbackMethod | enum | required | - |
2.
...
11.
...
28 ADSDATAAV Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
url |
string | required |
- | - |
publisherId |
string |
required | - | - |
publisherId
string
required
-
-
maxDuration
numeric
optional
min=1, max=600
2.11.29 RHYTHMONE Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|---|---|---|---|
placementId | string | required | - | - |
videoContext | enum | required | - |
2.
...
11.
...
30 UNDERTONE Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
skippable |
boolean |
optional |
- | - |
startDelay
enum
required
PRE_ROLL
publisherId | string | required | - | - |
placementId | string |
optional | - | - |
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
optional | min=1, max=600 | 60 | ||
videoContext | enum | required | - | |
playbackMethod | enum | required | - |
2.
...
11.
...
31 FREEWHEEL Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
zoneId |
numeric | required | - | - | |
videoContext | enum | required | - |
2.
...
11.
...
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.
...
11.
...
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.
...
11.
...
34 CONVERSANT Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
siteId |
string | required |
- | - |
position | enum | required |
adTagId
string
required
- |
adTagId |
publisherId
string | required | - | - | |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required |
-
playbackMethod
enum
- |
2.
...
11.
...
35 IRONSOURCE Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
publisherId | string | required | - | - |
maxDuration
optional
min=1, max=600
60
videoContext | enum | required | - |
playbackMethod
enum
required
-
2.
...
11.
...
36 TRIPLELIFT Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
inventoryCode | string | required | - | - |
videoContext | enum | required |
- |
adTagId
string
required
-
-
maxDuration
numeric
optional
min=1, max=600
2.11.37 QUANTUMDEX Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|---|---|---|---|
siteId | string | required | - | - |
videoContext | enum | required | - |
2.
...
11.38 KRUSH_MEDIA Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
key | string | required | - | - |
videoContext | enum | required | - |
2.
...
11.39 LUNA_MEDIA_HB Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
placementId | string | required | - | - |
videoContext | enum | required | - |
2.
...
11.40 RICH_AUDIENCE Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
placementId | string | required | - | - |
videoContext | enum | required | - |
2.
...
11.
...
41 _
...
33ACROSS Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
siteId | string | required | - | - |
placement | enum | required |
-
2.10.39 LUNA_MEDIA_HB Attributes
Attribute Key
Type
Mandatory
Description
Default Value
placementId
string
required
-
-
startDelay | enum | required |
| |
maxDuration | numeric | optional | min=1, max=600 | 60 |
videoContext | enum | required | - | |
playbackMethod | enum | required |
- |
2.
...
11.42 SMARTADSERVER Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
domain | string |
optional | - | - |
siteId |
string | required |
Attribute Key
Type
Mandatory
Description
Default Value
- | - |
2.10.41 _33ACROSS Attributes
pageId | string | required | - | - |
formatId | string | required | - |
-
placement
enum
required
- | ||||
startDelay | enum | required |
|
numeric
optional
min=1, max=600
60
videoContext | enum | required |
-
playbackMethod
enum
- |
2.
...
11.
...
43 IMPROVEDIGITAL Attributes
Attribute Key | Type | Mandatory | Description | Default Value |
|---|
publisherId | string | required | - | - |
placementKey | string |
required | - | - |
siteId
string
required
-
-
pageId
string
required
-
-
formatId
string
required
-
-
startDelay
enum
required
PRE_ROLL
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
...
Key
...
Value
...
PENDING
...
0
...
ACTIVE
...
1
...
Key
...
Value
...
MOBILE_WEB
...
1
...
DESKTOP
...
2
...
IN_APP
...
3
...
CTV
...
4
...
Key
...
Value
...
NETWORK
...
1
...
PUBLISHER
...
2
...
Key
...
Value
...
EVEN
...
0
...
MANUAL
...
1
...
Key
...
Value
...
VAST
...
2
...
PLATFORM_LINK
...
4
...
PREBID
...
8
...
SERVER_SIDE_VAST
...
9
...
Key
...
Value
...
SPOTX
...
1
...
ARTIMEDIA
...
2
...
GOOGLE_SDK
...
3
...
AOL
...
4
...
YANDEX_SDK
...
5
...
AMAZON
...
6
...
Key
...
Value
...
WEB
...
1
...
IN_APP
...
2
...
CUSTOM
...
3
...
Key
...
Value
...
AS_FAST_AS_POSSIBLE
...
1
...
EVENLY
...
2
...
Key
...
Value
...
TOTAL
...
0
...
DAILY
...
1
...
MONTHLY
...
3
...
UNLIMITED
...
4
...
Key
...
Value
...
REVSHARE
...
0
...
FEE
...
1
...
Key
...
Value
...
OVERRIDE_CONNECTION
...
1
...
DEMAND_CUT
...
2
...
FROM_REVENUE_CPM
...
3
...
Key
...
Value
...
OPENX
...
1
...
APPNEXUS
...
2
...
RUBICON
...
3
...
PUBMATIC
...
4
...
FREEWHEEL
...
5
...
SMARTADSERVER
...
7
...
TREMOR
...
8
...
SPOTX
...
9
...
SPOTXV2
...
10
...
BEACHFRONT
...
11
...
RUBICON2
...
12
...
RHYTHMONE
...
13
...
ONEVIDEO
...
14
...
ADSDATAAV
...
15
...
SYNACOR
...
16
...
LOOPME
...
17
...
IX
...
18
...
XAXIS
...
20
...
PULSEPOINT
...
21
...
UCFUNNEL
...
22
...
EMX
...
23
...
SONOBI
...
24
...
IMPROVEDIGITAL
...
25
...
LKQD
...
26
...
ADMAN
...
27
...
GUMGUM
...
28
...
UNRULY
...
30
...
ONETAG
...
31
...
YIELDLAB
...
32
...
UNDERTONE
...
34
...
CONVERSANT
...
100
...
IRONSOURCE
...
101
...
GRID
...
102
...
MEDIANET
...
103
...
_33ACROSS
...
104
...
MARS
...
105
...
TRIPLELIFT
...
106
...
RICH_AUDIENCE
...
107
...
QUANTUMDEX
...
108
...
CRITEO
...
109
...
LUNA_MEDIA_HB
...
112
...
YIELDMO
...
113
...
ADFORM
...
114
...
KRUSH_MEDIA
...
115
...
AMX
...
116
...
ENGAGE_BDR
...
117
...
Key
...
Value
...
OUTSTREAM
...
outstream
...
INSTREAM
...
instream
...
Key
...
Value
...
NOT_SPECIFIED
...
0
...
PRE_ROLL
...
1
...
MID_ROLL
...
2
...
POST_ROLL
...
3
...
Key
...
Value
...
PAGE_LOAD_WITH_SOUND_ON
...
1
...
PAGE_LOAD_WITH_SOUND_OFF
...
2
...
CLICK_WITH_SOUND_ON
...
3
...
MOUSE_OVER_WITH_SOUND_ON
...
4
...
VIEWPORT_WITH_SOUND_ON
...
5
...
VIEWPORT_WITH_SOUND_OFF
...
6
...
Key
...
Value
...
INSTREAM
...
1
...
INBANNER
...
2
...
INARTICLE
...
3
...
INFEED
...
4
...
INTERSTITIAL
...
5
...
LONGFORM
...
6
...
Key
...
Value
...
PUBMATIC
...
1
...
SPOTX
...
2
...
BIDSWITCH
...
24
...
AOL
...
25
...
Key
...
Value
...
UNKNOWN
...
0
...
ABOVE_THE_FOLD
...
1
...
DEPRECATED
...
2
...
BELOW_THE_FOLD
...
3
...
HEADER
...
4
...
FOOTER
...
5
...
SIDEBAR
...
6
...
FULL_SCREEN
...
7
...
Key
...
Value
...
TAG_MANAGER_ADX
...
1
...
APPNEXUS
...
2
...
SPOTX
...
3
...
AOL
...
4
...
RUBICON
...
5
...
OPENX
...
6
...
FREEWHEEL
...
7
...
SMART_ADSERVER
...
8
...
INDEX_EXCHANGE
...
9
...
RHYTHMONE
...
13
...
PULSEPOINT
...
21
...
GUMGUM
...
28
...
PUBMATIC
...
35
...
EMX_DIGITAL
...
54
...
LOOPME
...
56
...
SONOBI
...
60
...
COLOSSUSSSP
...
99
...
_33ACROSS
...
104
...
Key
...
Value
...
PRE_ROLL
...
201
...
INTESTITIAL
...
202
...
MID_ROLL
...
204
...
POST_ROLL
...
205
...
Key
...
Value
...
BELOW
...
below
...
ABOVE
...
above
...
Key
...
Value
...
VIDEO
...
1
...
DISPLAY
...
2
...
Key
...
Value
...
IMAGE
...
1
...
...
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 |
3.25 Creative Size Enum
| Anchor | ||||
|---|---|---|---|---|
|
Key | Value |
|---|---|
| 1 |
| 2 |
| 3 |
| 4 |
| 5 |
| 6 |
| 7 |
| 8 |
| 9 |
| 10 |
| 11 |
| 12 |
| 13 |
| 14 |
| 15 |
| 16 |
| 17 |
| 18 |
| 19 |
| 20 |
| 21 |
| 22 |
| 23 |
| 24 |
| 25 |
| 26 |
| 27 |
| 28 |