icons Created with Sketch.

Integration and bidding protocol

Bid request protocol

Follow
  • Updated

This section contains the bid request protocols.

 

Bid request object

Field

Type

Description

id

string

The unique identifer of the bid request. 

imp

array of objects

The impressions offered in this bid request. See Impression Object below.

site

object

Specifies information about the website from which the request originated. See Site Object below.

app

object

Specifies information about the app from which the request originated. Applicable for app. See App Object below.

device

object

Specifies information about the user’s device from which the request originated. See Device Object below.

user

object

Specifies information about the person to whom the impressions will be delivered. See User Object below.

test

object

When set to 1, indicates that the request is for testing purposes and should not be billed. 

at

integer

Specifies the auction type.

  • 1: first price auction
  • 2: second price auction

tmax

integer

Specifies the maximum amount of time a DSP has to submit a bid before timing out (in milliseconds). 

bcat

array of strings

Specifies a list of blocked IAB categories.

cur

array of strings

Specifies the currencies that the bidder is allowed to respond with using ISO-4217 alphabetic codes.

badv

array of strings

Specifies a list of top-level advertiser domains that are ineligible to serve. For example, [“nike.com”, ”abc.com”]. 

 

Impression object 

Field

Type

Description

id

string

Specifies a unique identifier for this impression, solely within the context of this bid request.

video

object

The presence of this object indicates that the impression is offered as a video ad. See Video Object below.

secure

integer

Indicates whether the impression requires a secure HTTPS URL or ad markup.

  • 0: the impression is not secure
  • 1: the impression is secure

exp

integer

Specifies the number of seconds that may elapse between the auction and the actual impression

bidfloor

float

Minimum allowed CPM bid to participate in the auction for this impression. 

bidfloorcur

string

Specifies the currency of the imp.bidfloor field.

clickbrowser

integer

Specifies the type of browser opened when clicking on a creative from within an app.

  • 0: imbedded
  • 1: native

pmp

object

Specifies information about a private marketplace deal that is in effect for this impression. See Private Marketplace Object below.


Video object

Field

Type

Description

mimes

array of strings

Specifies the video content MIME types supported.

  • video/mp4
  • application/javascript
  • video/x-ms-wmv
  • video/x-msvideo
  • video/webm
  • video/3gp

minduration

integer

Specifies the minimum video ad duration, in seconds.

maxduration

integer

Specifies the maximum video ad duration, in seconds.

protocols

array of integers

Array of supported video protocols. Refer to section 5.8 of the IAB specification for a list of attributes.

protocol

integer

Specifies the highest supported video protocol. Refer to section 5.8 of the IAB specification for a list of attributes.

w

integer

Width of the video player (in pixels).

h

integer

Height of the video player (in pixels).

startdelay

integer

Specifies the start delay of the video:

  • 0: Pre-roll
  • -1: Generic mid-roll
  • -2: Generic post-roll

linearity

integer

Indicates if the impression must be linear. If none specified, all are assumed allowed.

skip

integer

Indicates if the player will allow the ad to be skipped.

skipafter

integer

Defines the number of seconds a video must play before skipping is enabled.

battr

array of integers

Defines a list of creative attributes that are considered ineligible for this request. 

playbackmethod

array of integers

Specifies the allowed playback methods. If not specified, all are assumed to be allowed. Currently supported values are:

  • 1: Autoplay, sound on
  • 2: Autoplay, sound off
  • 3: Click to play
  • 4: Mouse over to play

delivery

array of integers

Specifies the allowed delivery methods such as streaming or progressive. 

api

array of integers

Specifies the supported API frameworks for this impression.


Private marketplace object

Field

Type

Description
private_auction

integer

Indicates the auction eligibility for seats named in the deals object.

  • 0: All bids are accepted
  • 1: Only bids for specified deals are accepted

deals

array of objects

Specifies information about the deals for this bid. See Deal Object below.


Deal object

Field

Type

Description

id

string

Specifies a unique identifier for the deal. Also known as “Deal ID”.

bidfloor

float

Specifies the minimum bid in CPM for the deal, in the currency passed in deal.bidfloorcur.

bidfloorcur

string

Specifies the currency for this bid using ISO-4217 alphabetic codes.

at

integer

Specifies the auction type (1=First Price, 2=Second Price, 3=price passed in deal.bidfloor is agreed upon price).

  • 1: First Price
  • 2: Only bids for specified deals are accepted
  • 3: Price passed in deal.bidfloor is agreed upon price

wseat

string array

Specifies a list of DSP seats who are eligible to bid on this deal. 


Site object

Only one of site and app objects are allowed in an imp object.

Sites (also known as placement groups) are a subset of inventory for a publisher. Dailymotion supports the following fields in the site object:

Field

Type

Description

id

string

The Dailymotion Zone ID. 

domain

string

Specifies the domain of the site where the impression will be shown. 

cat

array of strings

Specifies a list of IAB content categories tied to the Zone. 

page

string

Specifies the full URL of the page where the impression will be shown.

publisher

object

Specifies information about the publisher. See Publisher Object below.

content

object

Specifies information about the content. See Content Object below.


App object

Only one of site and app objects are allowed in an imp object.

Field

Type

Description

id

string

The Dailymotion Zone ID. 

bundle

string

Specifies the application bundle or package name (e.g., com.foo.mygame). This is intended to be a unique ID across multiple exchanges.

domain

string

Specifies the domain of the app.

storeurl

string

Specifies the App store URL of the app.

cat

array of strings

Specifies a list of IAB content categories (listed in section 5.1 of the specification).

ver

string

Specifies the app’s version. 

publisher

object

Specifies information about the publisher. See Publisher Object below.

content

object

Specifies information about the content. See Content Object below.


Publisher object

Field

Type

Description

id

string

The Dailymotion publisher ID. 


Content object

Field

Type

Description

id

string

Unique ID of the video.

title

string

Title of the video.

url

string

Url of the video.

context

integer

Type of content (game,video,text etc...)

livestream

integer

Defines whether the video is a live feed, or on demand

len

integer

Length of the video, in seconds


Device object

Field

Type

Description

ua

string

Specifies the user agent string from the browser. 

geo

object

Specifies the location of the device. See Geo Object for details.

dnt

integer

Specifies the Do Not Track setting:

  • 0: Do Not Track is set to false in browser (tracking is allowed)
  • 1: Do Not Track is set to true in browser (user has opted out of tracking)

ip

string

Specifies the IPv4 address closest to the device.

devicetype

integer

Specifies the type of device, using IAB values:

·       1: Mobile/Tablet

·       2: Personal Computer

·       3: Connected TV

·       4: Phone

·       5: Tablet

·       6: Connected Device

·       7: Set Top Box

Only used if not supported via the ua field

make

string

Specifies the make of the device.

model

string

Specifies the model of the device.

os

string

Specifies operating system of the device.

osv

string

Specifies the OS version.

language

string

Specifies the browser language;

carrier

string

Specifies carrier for the device.

connectiontype

integer

Specifies through what means the device is connected to the internet 

ifa

string

The "identifier for advertising" is an unhashed device ID sanctioned for advertiser use.
Example: "ifa": "AA000DFE74168477C70D291f574D344790E0BB12".


Geo object

Field

Type

Description

country

string

Specifies the country from which the user is currently using the device.

region

string

Specifies the region from which the user is currently using the device.

metro

string

Google metro code. 

city

string

Specifies the city from which the user is currently using the device.

zip

string

Specifies the zip code from which the user is currently using the device.


User object

Field

Type

Description

id

string

The Dailymotion unique ID for this user

buyeruid

string

The DSP’s unique ID for this user. 

 

 

Examples

Desktop/mobile web bid request

{
    "cur": ["EUR","JPY","USD","AUD","GBP","CAD"],
    "site": {
        "content": {
            "len": 30,
            "livestream": 0,
            "id": "",
            "context": 1,
            "url": "http%3A%2F%2Fdai.ly%2Fx2o5v4v",
            "title": "funnycat"
        },
        "publisher": {
            "id": "1"
        },
        "domain": "news.dailymotion.com",
        "id": "1",
        "page": "news.dailymotion.com",
        "cat": [
            "IAB18-3"
        ]
    },
    "user": {
        "buyeruid": "QADMX01386D23D0E1C79A7MXZQXOOVVNBF_1",
        "id": "QADMX01386D23D0E1C79A7MXZQXOOVVNBF"
    },
    "badv": [],
    "device": {
        "carrier": "",
        "ifa": "",
        "dnt": 0,
        "make": "Apple",
        "osv": "5",
        "geo": {
            "zip": "10010",
            "country": "US",
            "metro": "501",
            "region": "NY",
            "city": "New York"
        },
        "ip": "198.54.201.163",
        "ua": "Mozilla%2F5.0+%28iPhone%3B+CPU+iPhone+OS+5_1_1+like+Mac+OS+X%29+AppleWebKit%2F534.46+%28KHTML%2C+like+Gecko%29+Version%2F5.1+Mobile%2F9B206+Safari%2F7534.48.3",
        "model": "iPhone",
        "devicetype": 4,
        "connectiontype": 0,
        "language": "en",
        "os": "iOS"
    },
    "test": 1,
    "imp": [
        {
            "bidfloorcur": "USD",
            "exp": 0,
            "bidfloor": 6,
            "video": {
                "skipafter": 5,
                "linearity": 1,
                "mimes": [
                    "video/mp4",
                    "application/javascript",
                    "video/x-ms-wmv",
                    "video/x-msvideo",
                    "video/webm",
                    "video/3gp"
                ],
                "protocol": 5,
                "minduration": 0,
                "protocols": [
                    2,
                    5
                ],
				"w": 551,
				"h": 311,
                "battr": [
                    13,
                    14
                ],
                "delivery": [
                    1,
                    2
                ],
                "skip": 1,
                "startdelay": 0,
                "maxduration": 30
            },
            "id": "1",
            "clickbrowser": 1,
            "secure": 0
        }
    ],
    "id": "1",
    "at": 2,
    "tmax": 200,
    "bcat": [],
    "ext": ""
}

 

Mobile app bid request

{
    "cur": ["EUR","JPY","USD","AUD","GBP","CAD"],
    "app": {
        "publisher": {
            "id": "1"
        },
        "domain": "",
        "id": "1",
        "content": {
            "len": 30,
            "livestream": 0,
            "id": "123",
            "context": 1,
            "url": "http%3A%2F%2Fdai.ly%2Fx2o5v4v",
            "title": "funnycat"
        },
        "bundle": "com.foo.mygame",
        "cat": [
            "IAB18-3"
        ]
    },
    "user": {
        "buyeruid": "QADMX01386D23D0E1C79A7MXZQXOOVVNBF_1",
        "id": "QADMX01386D23D0E1C79A7MXZQXOOVVNBF"
    },
    "badv": [],
    "device": {
        "carrier": "",
        "ifa": "201F2EB1-8041-9E39-CD07-FCBBA5A29B41",
        "dnt": 0,
        "make": "Apple",
        "osv": "5",
        "geo": {
            "zip": "10010",
            "country": "US",
            "metro": "501",
            "region": "NY",
            "city": "New York"
        },
        "ip": "198.54.201.163",
        "ua": "Mozilla%2F5.0+%28iPhone%3B+CPU+iPhone+OS+5_1_1+like+Mac+OS+X%29+AppleWebKit%2F534.46+%28KHTML%2C+like+Gecko%29+Version%2F5.1+Mobile%2F9B206+Safari%2F7534.48.3",
        "model": "iPhone",
        "devicetype": 4,
        "connectiontype": 0,
        "language": "en",
        "os": "iOS"
    },
    "test": 1,
    "imp": [
        {
            "bidfloorcur": "USD",
            "exp": 0,
            "bidfloor": 6,
            "video": {
                "skipafter": 5,
                "linearity": 1,
                "mimes": [
                    "video/mp4",
                    "application/javascript",
                    "video/x-ms-wmv",
                    "video/x-msvideo",
                    "video/webm",
                    "video/3gp"
                ],
                "protocol": 5,
                "minduration": 0,
                "protocols": [
                    2,
                    5
                ],
				"w": 551,
				"h": 311,
                "battr": [
                    13,
                    14
                ],
                "delivery": [
                    1,
                    2
                ],
                "skip": 1,
                "startdelay": 0,
                "maxduration": 30
            },
            "id": "1",
            "clickbrowser": 1,
            "secure": 0
        }
    ],
    "id": "1",
    "at": 2,
    "tmax": 200,
    "bcat": [],
    "ext": ""
}

Related articles