Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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
(allowed statuses)

PENDING

environment

enum

optional

Environment of the ad-source
(allowed environments)

-

ownerType

enum

optional

Type of the ad-source’s owner
(allowed owner types)

NETWORK

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
(allowed source attributes)

-

requestsPerDay

object

optional

Ad-source’s request capping
(allowed request attributes)

-

impressionCap

object

optional

Ad-source’s impression capping
(allowed impression attributes)

-

priceException

object

optional

Ad-source’s price exception configuration
(allowed price exception attributes)

-

playerSettings

object

optional

Player settings configuration
(allowed player settings attributes)

-

tpp

object

optional

Third Party Platform configuration
(allowed tpp attributes)

-

targeting

object

optional

Ad-source’s targeting configuration
(allowed targeting attributes)

-

prebid

object

optional | required for source.type=PREBID

Prebid ad-source specific configuration
(allowed prebid attributes)

-

creativeType

enum

required

Creative Type of an ad-source (allowed creative types)

VIDEO

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 Sizeplacement

enumobject

required for
provider=GOOGLE or provider=CUSTOM and
source.type=PREBIDTAG and creativeType=Display

Display Tag ad-source specific configurationPlacement Attributes

2.2 Source Attributes
Anchor
SourceAttributes
SourceAttributes

...

Attribute Key

Type

Mandatory

Description

Default Value

country.include

boolean

optional

Inclusion of the countries

-

country.list

string

optional | required if country.include=true

Comma-separated list of country-codes (ex UA,IL)

-

domain.include

boolean

optional

Inclusion of the domains

-

domain.list

string

optional | required if domain.include=true

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

...

Placement Attributes
Anchor

...

PlacementAttributes

...

PlacementAttributes

Attribute Key

Type

Mandatory

Description

Default Value

platform

creativeSize

enum

required

Prebid platform, (allowed platforms)
Pay attention each platform

for
provider=GOOGLE or provider=CUSTOM and
source.type=TAG and creativeType=Display

Google tag supports multiple sizes, separated with comma

E.g:

  • 300x250,250x250,1x1

  • 320x100

Custom provider supports only 1 value

E.g:

250x250
supported creative sizes

2.10 Prebid Attributes
Anchor
PrebidAttributes
PrebidAttributes

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)

-

...

2.

...

11 Prebid Attributes Per Platform
Anchor
PrebidAttributesPerPlatform
PrebidAttributesPerPlatform

2.

...

11.1 OpenX Attributes

Attribute Key

Type

Mandatory

Description

Default Value

unit

string

required

-

-

delDomain

string

required

-

-

videoContext

enum

required

allowed types

-

environment

enum

required

allowed types

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

allowed types

-

2.

...

11.3 LKQD Attributes

Attribute Key

Type

Mandatory

Description

Default Value

siteId

string

required

-

-

placementId

string

required

-

-

videoContext

enum

required

allowed types

-

2.

...

11.4 GRID Attributes

Attribute Key

Type

Mandatory

Description

Default Value

adTagId

string

required

-

-

videoContext

enum

required

allowed types

-

2.

...

11.5 MARS Attributes

Attribute Key

Type

Mandatory

Description

Default Value

zoneId

numeric

required

-

-

skippable

boolean

optional

-

-

startDelay

enum

required

allowed delays

PRE_ROLL

videoContext

enum

required

allowed types

-

playbackMethod

enum

required

allowed playbacks

-

2.

...

11.6 ADMAN Attributes

Attribute Key

Type

Mandatory

Description

Default Value

placementId

string

required

-

-

videoContext

enum

required

allowed types

-

2.

...

11.7 SPOTX Attributes

Attribute Key

Type

Mandatory

Description

Default Value

channelId

string

required

-

-

2.

...

11.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

allowed types

-

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

allowed placements

startDelay

enum

required

allowed delays

PRE_ROLL

videoContext

enum

required

allowed types

-

2.

...

11.10 ONETAG Attributes

Attribute Key

Type

Mandatory

Description

Default Value

publisherId

string

required

-

-

maxDuration

numeric

optional

min=1, max=600

60

videoContext

enum

required

allowed types

-

2.

...

11.11 ADFORM Attributes

Attribute Key

Type

Mandatory

Description

Default Value

domain

string

optional

-

-

mid

string

required

-

-

videoContext

enum

required

allowed types

-

2.

...

11.12 UNRULY Attributes

Attribute Key

Type

Mandatory

Description

Default Value

siteId

string

required

-

-

targetingUUID

string

required

-

-

videoContext

enum

required

allowed types

-

2.

...

11.13 LOOPME Attributes

Attribute Key

Type

Mandatory

Description

Default Value

appId

string

required

-

-

videoContext

enum

required

allowed types

-

2.

...

11.14 TREMOR Attributes

Attribute Key

Type

Mandatory

Description

Default Value

adCode

string

required

-

-

supplyCode

string

required

-

-

placement

enum

required

allowed placements

-

videoContext

enum

required

allowed types

-

2.

...

11.15 SONOBI Attributes

Attribute Key

Type

Mandatory

Description

Default Value

seatId

string

required

-

-

videoContext

enum

required

allowed types

-

2.

...

11.16 SPOTXV2 Attributes

Attribute Key

Type

Mandatory

Description

Default Value

channelId

string

required

-

-

videoContext

enum

required

allowed types

-

cookieSync.syncId

string

optional

-

-

cookieSync.provider

enum

optional

allowed providers

-

2.

...

11.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

allowed types

-

2.

...

11.18 SYNACOR Attributes

Attribute Key

Type

Mandatory

Description

Default Value

seatId

string

required

-

-

position

enum

required

allowed positions

-

placement

enum

required

allowed placements

-

placementId

string

required

-

-

maxDuration

numeric

optional

min=1, max=600

60

videoContext

enum

required

allowed types

-

playbackMethod

enum

required

allowed playbacks

-

2.

...

11.19 YIELDMO Attributes

Attribute Key

Type

Mandatory

Description

Default Value

position

enum

required

allowed positions

-

placement

enum

required

allowed placements

-

skippable

boolean

optional

-

-

startDelay

enum

required

allowed delays

PRE_ROLL

placementId

string

required

-

-

maxDuration

numeric

optional

min=1, max=600

60

videoContext

enum

required

allowed types

-

playbackMethod

enum

required

allowed playbacks

-

2.

...

11.20 RUBICON Attributes

Attribute Key

Type

Mandatory

Description

Default Value

siteId

string

required

-

-

zoneId

numeric

required

-

-

position

enum

required

allowed positions

-

size_id

enum

required

allowed sizeIds

-

accountId

string

required

-

-

videoContext

enum

required

allowed types

-

2.

...

11.21 ONEVIDEO Attributes

Attribute Key

Type

Mandatory

Description

Default Value

siteId

string

optional

-

-

adTagId

string

required

-

-

placement

enum

required

allowed placements

-

publisherId

string

required

-

-

videoContext

enum

required

allowed types

-

2.

...

11.22 UCFUNNEL Attributes

Attribute Key

Type

Mandatory

Description

Default Value

seatId

string

required

-

-

videoContext

enum

required

allowed types

-

2.

...

11.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

allowed types

-

2.

...

11.24 YIELDLAB Attributes

Attribute Key

Type

Mandatory

Description

Default Value

adSlot

string

required

-

-

supplyCode

string

required

-

-

videoContext

enum

required

allowed types

-

2.

...

11.25 RUBICON2 Attributes

Attribute Key

Type

Mandatory

Description

Default Value

siteId

string

required

-

-

zoneId

numeric

required

-

-

position

enum

required

allowed positions

-

size_id

enum

required

allowed sizeIds

-

accountId

string

required

-

-

maxDuration

numeric

optional

min=1, max=600

60

videoContext

enum

required

allowed types

-

2.

...

11.26 PUBMATIC Attributes

Attribute Key

Type

Mandatory

Description

Default Value

placement

enum

required

allowed placements

-

skippable

boolean

optional

-

-

publisherId

string

required

-

-

maxDuration

numeric

optional

min=1, max=600

60

videoContext

enum

required

allowed types

-

2.

...

11.27 MEDIANET Attributes

Attribute Key

Type

Mandatory

Description

Default Value

placement

enum

required

allowed placements

-

startDelay

enum

required

allowed delays

PRE_ROLL

publisherId

string

required

-

-

placementId

string

required

-

-

maxDuration

numeric

optional

min=1, max=600

60

videoContext

enum

required

allowed types

-

playbackMethod

enum

required

allowed playbacks

-

2.

...

11.28 ADSDATAAV Attributes

Attribute Key

Type

Mandatory

Description

Default Value

url

string

required

-

-

publisherId

string

required

-

-

2.

...

11.29 RHYTHMONE Attributes

Attribute Key

Type

Mandatory

Description

Default Value

placementId

string

required

-

-

videoContext

enum

required

allowed types

-

2.

...

11.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

allowed types

-

playbackMethod

enum

required

allowed playbacks

-

2.

...

11.31 FREEWHEEL Attributes

Attribute Key

Type

Mandatory

Description

Default Value

zoneId

numeric

required

-

-

videoContext

enum

required

allowed types

-

2.

...

11.32 PULSEPOINT Attributes

Attribute Key

Type

Mandatory

Description

Default Value

position

enum

required

allowed positions

-

placement

enum

required

allowed placements

adTagId

string

required

-

-

publisherId

string

required

-

-

maxDuration

numeric

optional

min=1, max=600

60

videoContext

enum

required

allowed types

-

playbackMethod

enum

required

allowed playbacks

-

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

allowed types

-

playbackMethod

enum

required

allowed playbacks

-

2.

...

11.34 CONVERSANT Attributes

Attribute Key

Type

Mandatory

Description

Default Value

siteId

string

required

-

-

position

enum

required

allowed positions

-

adTagId

string

required

-

-

maxDuration

numeric

optional

min=1, max=600

60

videoContext

enum

required

allowed types

-

2.

...

11.35 IRONSOURCE Attributes

Attribute Key

Type

Mandatory

Description

Default Value

publisherId

string

required

-

-

videoContext

enum

required

allowed types

-

2.

...

11.36 TRIPLELIFT Attributes

Attribute Key

Type

Mandatory

Description

Default Value

inventoryCode

string

required

-

-

videoContext

enum

required

allowed types

-

2.

...

11.37 QUANTUMDEX Attributes

Attribute Key

Type

Mandatory

Description

Default Value

siteId

string

required

-

-

videoContext

enum

required

allowed types

-

2.

...

11.38 KRUSH_MEDIA Attributes

Attribute Key

Type

Mandatory

Description

Default Value

key

string

required

-

-

videoContext

enum

required

allowed types

-

2.

...

11.39 LUNA_MEDIA_HB Attributes

Attribute Key

Type

Mandatory

Description

Default Value

placementId

string

required

-

-

videoContext

enum

required

allowed types

-

2.

...

11.40 RICH_AUDIENCE Attributes

Attribute Key

Type

Mandatory

Description

Default Value

placementId

string

required

-

-

videoContext

enum

required

allowed types

-

2.

...

11.41 _33ACROSS Attributes

Attribute Key

Type

Mandatory

Description

Default Value

siteId

string

required

-

-

placement

enum

required

allowed placements

startDelay

enum

required

allowed delays

PRE_ROLL

maxDuration

numeric

optional

min=1, max=600

60

videoContext

enum

required

allowed types

-

playbackMethod

enum

required

allowed playbacks

-

2.

...

11.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

allowed delays

PRE_ROLL

videoContext

enum

required

allowed types

-

2.

...

11.43 IMPROVEDIGITAL Attributes

Attribute Key

Type

Mandatory

Description

Default Value

publisherId

string

required

-

-

placementKey

string

required

-

-

videoContext

enum

required

allowed types

-

...

3.24 OpenX Environments Enum
Anchor
OpenXEnvEnum
OpenXEnvEnum

Key

Value

WEB

1

3.25 Creative Size Enum
Anchor
CreativeSizeEnum
CreativeSizeEnum

Key

Value

120x600

1

125x125

2

160x600

3

200x200

4

240x400

5

250x250

6

250x360

7

300x50

8

300x250

9

300x600

10

300x1050

11

320x50

12

320x100

13

320x480

14

336x280

15

468x60

16

480x320

17

580x400

18

728x90

19

768x1024

20

930x180

21

970x250

22

970x90

23

980x120

24

180x150

25

234x60

26

120x240

27

1x1

28