Versions Compared

Old Version 14

changes.mady.by.user Lior Weissbrod

Saved on

compared with

New Version 15

changes.mady.by.user Oleksii Puchkov

Saved on

Key

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

...

Specific attribute types:

  1. Boolean - defines the availability (logical state) of an attribute. Possible values:

    • true or 1 ;

    • false or 0 ;

  2. 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 of 0). 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 (ex CLICK_WITH_SOUND_ON is equal to Click 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
(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

-

...

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.

-

...

Attribute Key

Type

Mandatory

Description

Default Value

unit

string

required

-

-

delDomain

string

required

-

-

videoContext

enum

required

allowed types

-

environment

enum

required

allowed types

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

allowed types

-

...

3.23 Display Formats Enum
Anchor
BannerFormatEnum
BannerFormatEnum

Key

Value

IMAGE

1

3.24 OpenX Environments Enum
Anchor
OpenXEnvEnum
OpenXEnvEnum

Key

Value

WEB

1