Bid Request JSON Examples

Display Example

{
    "id": "0123456789ABCDEF",
    "tmax": 150,
    "at": 2,
    "seat": [
        "16",
        "160",
        "1600"
    ],
    "ext": {
        "ssp": "google",
        "at": 1,
        "ads_txt": {
            "status": 2,
            "auth_id": "1kjgh7653",
            "pub_id": "537120563"
        }
    },
    "cur": [
        "USD",
        "EUR"
    ],
    "source": {
        "tid": "FEDCBA9876543210",
        "ts": 1541796182157,
        "ds": "AE23865DF890100BECCD76579DD4769DBBA9812CEE8ED90BF"
    },
    "package": 0,
    "item": [
        {
            "id": "1",
            "metric": {
                "type": "viewability",
                "vendor": "moat",
                "value": 0.8
            },
            "qty": 1,
            "private": 0,
            "deal": [
                {
                    "id": "1234",
                    "flr": 1.50
                }
            ],
            "spec": {
                "placement": {
                    "tagid": "plc-ftr-123abc",
                    "curlx": 1,
                    "secure": 1,
                    "display": {
                        "ctype": [
                            2,
                            3
                        ],
                        "ampren": 0,
                        "instl": 0,
                        "displayfmt": [
                            {
                                "w": 320,
                                "h": 50
                            },
                            {
                                "w": 320,
                                "h": 250
                            }
                        ],
                        "event": [
                            {
                                "type": 1,
                                "method": [
                                    1
                                ]
                            }
                        ]
                    }
                }
            }
        },
        {
            "id": "2",
            "qty": 1,
            "private": 0,
            "deal": [
                {
                    "id": "123456",
                    "flr": 1.70
                }
            ],
            "spec": {
                "placement": {
                    "tagid": "plc-ftr-123abcdef",
                    "secure": 1,
                    "display": {
                        "ctype": [
                            1,
                            3
                        ],
                        "ampren": 0,
                        "instl": 0,
                        "displayfmt": [
                            {
                                "w": 320,
                                "h": 50
                            },
                            {
                                "w": 320,
                                "h": 250
                            }
                        ],
                        "event": [
                            {
                                "type": 1,
                                "method": [
                                    2
                                ]
                            }
                        ]
                    }
                }
            }
        }
    ],
    "context": {
        "regs": {
            "gdpr": 1,
            "coppa": 0
        },
        "restrictions": {
            "cattax": 1,
            "bcat": [
                "IAB24",
                "IAB25",
                "IAB26"
            ],
            "ext": {
                "addcat": [
                    {
                        "cattax": 501,
                        "bcat": [
                            "bsw1",
                            "bsw2"
                        ]
                    }
                ]
            },
            "badv": [
                "example.com",
                "such_example.com"
            ]
        },
        "site": {
            "id": "1234",
            "name": "Example Site",
            "domain": "examplesitedomain.com",
            "mobile": 1,
            "amp": 0,
            "pub": {
                "id": "9876",
                "name": "Example Publisher, Inc.",
                "domain": "examplepubdomain.com"
            }
        },
        "user": {
            "id": "a0af45c77890045deec100acb8443baff57c",
            "consent": "ihdknkhkq8y",
            "buyeruid": "fcd4282456238256034abcdef220d9aa5892",
            "yob": 1990,
            "gender": "F",
            "ext": {
                "consented_providers_settings": {
                    "consented_providers": [
                        1,
                        52,
                        45,
                        23
                    ]
                }
            }
        },
        "device": {
            "type": 4,
            "ifa": "8846d6fa10008bceaaf322908dfcb221",
            "ip": "1.2.3.4",
            "ua": "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.2.16) Gecko/20110319 Firefox/3.6.16",
            "make": "Apple",
            "model": "iPhone",
            "hwv": "6s",
            "os": 13,
            "osv": "11.4.1",
            "mccmnc": "310-005",
            "geo": {
                "type": 1,
                "lat": 42.3601,
                "lon": 71.0581,
                "country": "USA",
                "utcoffset": -300
            }
        }
    }
}

Rewarded Video Example

{
    "id": "0123456789ABCDEF",
    "tmax": 150,
    "at": 2,
    "cur": [
        "USD"
    ],
    "source": {
        "tid": "FEDCBA9876543210",
        "ts": 1541796182157,
        "ds": "AE23865DF890100BECCD76579DD4769DBBA9812CEE8ED90BF"
    },
    "package": 0,
    "item": [
        {
            "id": "1",
            "ext": {
                "ssp": "google",
                "at": 1,
                "ads_txt": {
                    "status": 2,
                    "auth_id": "1kjgh7653",
                    "pub_id": "537120563"
                }
            },
            "qty": 1,
            "private": 0,
            "spec": {
                "placement": {
                    "curlx": 1,
                    "reward": 1,
                    "tagid": "plc-ftr-123abc",
                    "secure": 1,
                    "video": {
                        "ptype": 3,
                        "skip": 1,
                        "skipmin": 10,
                        "pos": 1,
                        "delay": -1,
                        "minbitrate": 6,
                        "mime": [
                            "video/mp4"
                        ],
                        "playmethod": 1,
                        "api": [
                            1,
                            2
                        ],
                        "ctype": [
                            3,
                            4,
                            5
                        ],
                        "w": 600,
                        "h": 400
                    }
                }
            }
        }
    ],
    "context": {
        "regs": {
            "gdpr": 0,
            "coppa": 1
        },
        "restrictions": {
            "bcat": [
                "IAB24",
                "IAB25",
                "IAB26"
            ],
            "cattax": 1,
            "badv": [
                "ford.com",
                "buick.com"
            ]
        },
        "site": {
            "id": "1234",
            "name": "Awesome Example Site",
            "domain": "examplesitedomain.com",
            "mobile": 1,
            "amp": 0,
            "pub": {
                "id": "criteo_9876",
                "name": "Example Publisher, Inc.",
                "domain": "examplepubdomain.com"
            }
        },
        "user": {
            "id": "a0af45c77890045deec100acb8443baff57c",
            "consent": "ihdknkhkq8y",
            "buyeruid": "fcd4282456238256034abcdef220d9aa5892",
            "yob": 1990,
            "gender": "F",
            "ext": {
                "consented_providers_settings": {
                    "consented_providers": [
                        1,
                        52,
                        45,
                        23
                    ]
                }
            }
        },
        "device": {
            "type": 4,
            "ifa": "8846d6fa10008bceaaf322908dfcb221",
            "ip": "1.2.3.4",
            "make": "Apple",
            "model": "iPhone",
            "hwv": "6s",
            "os": 13,
            "osv": "11.4.1",
            "mccmnc": "310-005",
            "geo": {
                "type": 1,
                "lat": 42.3601,
                "lon": 71.0581,
                "country": "USA",
                "utcoffset": -300
            }
        }
    }
}

In-App Request

{
    "id": "0123456789ABCDEF",
    "tmax": 150,
    "cur": [
        "USD"
    ],
    "source": {
        "tid": "FEDCBA9876543210",
        "fd": 1,
        "ts": 1541796182157,
        "ds": "AE23865DF890100BECCD76579DD4769DBBA9812CEE8ED90BF"
    },
    "package": 0,
    "ext": {
        "ssp": "pubnative",
        "at": 501,
        "wt": 1
    },
    "item": [
        {
            "id": "1",
            "metric": {
                "type": "viewability",
                "vendor": "moat",
                "value": 0.8
            },
            "qty": 1,
            "private": 0,
            "spec": {
                "placement": {
                    "curlx": 1,
                    "reward": 1,
                    "tagid": "plc-ftr-123abc",
                    "secure": 1,
                    "display": {
                        "pos": 1,
                        "event": [
                            {
                                "type": 1,
                                "method": [
                                    2
                                ]
                            },
                            {
                                "type": 2,
                                "method": [
                                    3,
                                    4
                                ]
                            }
                        ],
                        "instl": 1,
                        "ptype": 1,
                        "context": 10,
                        "api": [
                            3,
                            5,
                            6
                        ],
                        "ctype": [
                            1
                        ],
                        "nativefmt": {
                            "asset": [
                                {
                                    "id": 1,
                                    "data": {
                                        "type": 12
                                    },
                                    "req": 1
                                },
                                {
                                    "title": {
                                        "len": 50
                                    },
                                    "id": 2,
                                    "req": 1
                                },
                                {
                                    "id": 3,
                                    "img": {
                                        "w": 80,
                                        "h": 80,
                                        "type": 1
                                    },
                                    "req": 1
                                },
                                {
                                    "id": 4,
                                    "img": {
                                        "w": 1200,
                                        "h": 627,
                                        "type": 3
                                    },
                                    "req": 1
                                },
                                {
                                    "data": {
                                        "type": 3
                                    },
                                    "id": 5,
                                    "req": 0
                                },
                                {
                                    "id": 6,
                                    "data": {
                                        "len": 100,
                                        "type": 2
                                    },
                                    "req": 1
                                }
                            ]
                        }
                    }
                }
            }
        }
    ],
    "context": {
        "regs": {
            "gdpr": 1,
            "coppa": 0
        },
        "restrictions": {
            "cattax": 1,
            "bcat": [
                "IAB24",
                "IAB25",
                "IAB26"
            ],
            "ext": {
                "addcat": [
                    {
                        "cattax": 501,
                        "bcat": [
                            "bsw1",
                            "bsw2"
                        ]
                    }
                ]
            },
            "badv": [
                "example.com",
                "such_example.com"
            ]
        },
        "app": {
            "id": "pubnative_1009429",
            "publisher": {
                "name": "example published",
                "id": "pubnative_1005292"
            },
            "storeurl": "https://play.google.com/store/apps/details?id=com.leo.appmaster",
            "bundle": "com.leo.appmaster",
            "cat": [
                "IAB3"
            ],
            "name": "PG_lock_pic"
        },
        "user": {
            "id": "a0af45c77890045deec100acb8443baff57c",
            "consent": "ihdknkhkq8y",
            "buyeruid": "fcd4282456238256034abcdef220d9aa5892",
            "yob": 1990,
            "gender": "F",
            "ext": {
                "ug": 1,
                "cookie_age": 54,
                "consented_providers_settings": {
                    "consented_providers": [
                        1,
                        52,
                        45,
                        23
                    ]
                }
            }
        },
        "device": {
            "type": 1,
            "contype": 3,
            "ip": "223.176.12.242",
            "ifa": "8846d6fa10008bceaaf322908dfcb221",
            "model": "Micromax A096",
            "osv": "5.0.2",
            "os": "Android",
            "carrier": "Airtel",
            "mccmnc": "310-005",
            "geo": {
                "country": "IN",
                "lon": 85.1167,
                "city": "Patna",
                "lat": 25.6,
                "zip": "800002",
                "region": "IN-BR",
                "type": 2
            }
        }
    }
}

Audio Request

{
    "id": "0123456789ABCDEF",
    "tmax": 150,
    "at": 2,
    "cur": [
        "USD"
    ],
    "source": {
        "tid": "FEDCBA9876543210",
        "ts": 1541796182157,
        "ds": "AE23865DF890100BECCD76579DD4769DBBA9812CEE8ED90BF"
    },
    "package": 0,
    "item": [
        {
            "id": "1",
            "qty": 1,
            "private": 0,
            "spec": {
                "placement": {
                    "curlx": 1,
                    "tagid": "plc-ftr-123abc",
                    "secure": 1,
                    "display": {
                        "ctype": [
                            2,
                            3
                        ],
                        "displayfmt": [
                            {
                                "w": 320,
                                "h": 50
                            },
                            {
                                "w": 320,
                                "h": 250
                            }
                        ]
                    }
                }
            }
        }
    ],
    "context": {
        "restrictions": {
            "bcat": [
                "IAB24",
                "IAB25",
                "IAB26"
            ],
            "cattax": 1,
            "badv": [
                "example.com",
                "another_example.com"
            ]
        },
        "dooh": {
            "id": "TrainAds",
            "pub": {
                "id": "thalys_9876",
                "name": "Example Publisher, Inc.",
                "domain": "examplepubdomain.com"
            },
            "fixed": 2,
            "etime": 15
        },
        "device": {
            "type": 4,
            "ifa": "8846d6fa10008bceaaf322908dfcb221",
            "ip": "1.2.3.4",
            "make": "Apple",
            "model": "iPhone",
            "ua": "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.2.16) Gecko/20110319 Firefox/3.6.16",
            "hwv": "6s",
            "os": "13",
            "osv": "11.4.1",
            "mccmnc": "310-005",
            "geo": {
                "type": 1,
                "lat": 42.3601,
                "lon": 71.0581,
                "country": "USA",
                "utcoffset": -300
            }
        }
    }
}

TV Request

{
    "id": "0123456789ABCDEF",
    "seat": [
        "123"
    ],
    "tmax": 150,
    "at": 2,
    "cur": [
        "USD"
    ],
    "source": {
        "tid": "FEDCBA9876543210",
        "ts": 1541796182157,
        "ds": "AE23865DF890100BECCD76579DD4769DBBA9812CEE8ED90BF",
        "fd": 0
    },
    "ext": {
        "ssp": "dish",
        "at": 2,
        "wt": 1
    },
    "package": 0,
    "item": [
        {
            "id": "1",
            "qty": 2,
            "flr": 1.23,
            "dt": 1554900829,
            "dlvy": 2,
            "private": 0,
            "spec": {
                "placement": {
                    "curlx": 1,
                    "reward": 1,
                    "tagid": "plc-ftr-123abc",
                    "secure": 1,
                    "video": {
                        "ptype": 2,
                        "skip": 1,
                        "skipmin": 10,
                        "pos": 1,
                        "delay": -1,
                        "minbitr": 60,
                        "mime": [
                            "video/x-flv",
                            "video/mp4",
                            "application/x-shockwave-flash",
                            "application/javascript"
                        ],
                        "playmethod": 1,
                        "api": [
                            1,
                            2
                        ],
                        "ctype": [
                            3,
                            6
                        ],
                        "w": 600,
                        "h": 400
                    }
                }
            }
        }
    ],
    "context": {
        "regs": {
            "gdpr": 1,
            "coppa": 0
        },
        "restrictions": {
            "bcat": [
                "IAB24",
                "IAB25",
                "IAB26"
            ],
            "cattax": 1,
            "badv": [
                "ford.com",
                "buick.com"
            ]
        },
        "site": {
            "id": "1234",
            "name": "Awesome Example Site",
            "domain": "examplesitedomain.com",
            "mobile": 1,
            "amp": 0,
            "pub": {
                "id": "criteo_9876",
                "name": "Example Publisher, Inc.",
                "domain": "examplepubdomain.com"
            }
        },
        "user": {
            "id": "a0af45c77890045deec100acb8443baff57c",
            "consent": "ihdknkhkq8y",
            "buyeruid": "fcd4282456238256034abcdef220d9aa5892",
            "keywords": "A_18_24,COLLEGE,HHI_75_100,M_18_24,HH_SINGLE",
            "data": [
                {
                    "name": "program_types",
                    "segment": [
                        {
                            "name": "HOCKEY_DEC",
                            "value": "8"
                        },
                        {
                            "name": "BASEBALL_DEC",
                            "value": "9"
                        },
                        {
                            "name": "FOOTBALL_DEC",
                            "value": "8.1"
                        }
                    ]
                }
            ],
            "yob": 1990,
            "gender": "F",
            "ext": {
                "consented_providers_settings": {
                    "consented_providers": [
                        1,
                        52,
                        45,
                        23
                    ]
                }
            }
        },
        "device": {
            "type": 6,
            "ua": "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.2.16) Gecko/20110319 Firefox/3.6.16",
            "make": "Samsung",
            "model": "UE55F8000AFXZ",
            "geo": {
                "type": 1,
                "lat": 42.3601,
                "lon": 71.0581,
                "country": "USA",
                "utcoffset": -300
            }
        }
    }
}

Native Request

{
    "id": "0123456789ABCDEF",
    "tmax": 150,
    "at": 2,
    "seat": [
        "16",
        "160",
        "1600"
    ],
    "cur": [
        "USD",
        "EUR"
    ],
    "source": {
        "tid": "FEDCBA9876543210",
        "ts": 1541796182157,
        "ds": "AE23865DF890100BECCD76579DD4769DBBA9812CEE8ED90BF"
    },
    "package": 0,
    "ext": {
        "ssp": "google",
        "at": 1,
        "ads_txt": {
            "status": 2,
            "auth_id": "1kjgh7653",
            "pub_id": "537120563"
        }
    },
    "item": [
        {
            "id": "1",
            "metric": {
                "type": "viewability",
                "vendor": "moat",
                "value": 0.8
            },
            "qty": 1,
            "private": 0,
            "deal": [
                {
                    "id": "1234",
                    "flr": 1.50
                }
            ],
            "spec": {
                "placement": {
                    "tagid": "plc-ftr-123abc",
                    "curlx": 1,
                    "secure": 1,
                    "display": {
                        "ctype": [
                            2,
                            3
                        ],
                        "ampren": 0,
                        "instl": 0,
                        "displayfmt": [
                            {
                                "w": 320,
                                "h": 50
                            },
                            {
                                "w": 320,
                                "h": 250
                            }
                        ],
                        "event": [
                            {
                                "type": 1,
                                "method": [
                                    1
                                ]
                            }
                        ]
                    }
                }
            }
        },
        {
            "id": "2",
            "qty": 1,
            "private": 0,
            "deal": [
                {
                    "id": "123456",
                    "flr": 1.70
                }
            ],
            "spec": {
                "placement": {
                    "tagid": "plc-ftr-123abcdef",
                    "secure": 1,
                    "display": {
                        "ctype": [
                            1,
                            3
                        ],
                        "ampren": 0,
                        "instl": 0,
                        "nativefmt": {
                            "asset": [
                                {
                                    "id": 1,
                                    "title": {
                                        "len": 25
                                    }
                                },
                                {
                                    "id": 2,
                                    "img": {
                                        "type": 1,
                                        "w": 320,
                                        "h": 50
                                    }
                                },
                                {
                                    "id": 3,
                                    "data": {
                                        "type": 12,
                                        "len": 25
                                    }
                                },
                                {
                                    "id": 4,
                                    "video": {
                                        "ptype": 3,
                                        "skip": 1,
                                        "skipmin": 10,
                                        "pos": 1,
                                        "delay": -1,
                                        "mime": [
                                            "video/mp4"
                                        ],
                                        "playmethod": 1,
                                        "api": [
                                            1,
                                            2
                                        ],
                                        "ctype": [
                                            3,
                                            4,
                                            5
                                        ],
                                        "w": 600,
                                        "h": 400
                                    }
                                }
                            ]
                        },
                        "event": [
                            {
                                "type": 1,
                                "method": [
                                    2
                                ]
                            }
                        ]
                    }
                }
            }
        }
    ],
    "context": {
        "regs": {
            "gdpr": 1,
            "coppa": 0
        },
        "restrictions": {
            "cattax": 1,
            "bcat": [
                "IAB24",
                "IAB25",
                "IAB26"
            ],
            "ext": {
                "addcat": [
                    {
                        "cattax": 501,
                        "bcat": [
                            "bsw1",
                            "bsw2"
                        ]
                    }
                ]
            },
            "badv": [
                "example.com",
                "such_example.com"
            ]
        },
        "site": {
            "id": "1234",
            "name": "Example Site",
            "domain": "examplesitedomain.com",
            "mobile": 1,
            "amp": 0,
            "pub": {
                "id": "9876",
                "name": "Example Publisher, Inc.",
                "domain": "examplepubdomain.com"
            }
        },
        "user": {
            "id": "a0af45c77890045deec100acb8443baff57c",
            "consent": "ihdknkhkq8y",
            "buyeruid": "fcd4282456238256034abcdef220d9aa5892",
            "yob": 1990,
            "gender": "F",
            "ext": {
                "consented_providers_settings": {
                    "consented_providers": [
                        1,
                        52,
                        45,
                        23
                    ]
                }
            }
        },
        "device": {
            "type": 4,
            "ifa": "8846d6fa10008bceaaf322908dfcb221",
            "ip": "1.2.3.4",
            "ua": "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.2.16) Gecko/20110319 Firefox/3.6.16",
            "make": "Apple",
            "model": "iPhone",
            "hwv": "6s",
            "os": 13,
            "osv": "11.4.1",
            "mccmnc": "310-005",
            "geo": {
                "type": 1,
                "lat": 42.3601,
                "lon": 71.0581,
                "country": "USA",
                "utcoffset": -300
            }
        }
    }
}