Prebid Client-Side Request

hbjson request format

Value

Type

Description

id

string

(Required) Unique ID of the bid request, for example "b5ba5ed2-547e-4e86-8a84-34a440dad6db"

imp

array of objects

(Required) Array of objects representing the impressions offered, see the Impression Object section.

user

object

User Object which describes the user, see the User Object section.

tmax

integer

Maximum time in milliseconds the exchange allows for bids to be received to avoid timeout, including internet latency, for example, 120.

source

object

(Required) Indicates the entity responsible for the final impression sale decision, see the Source Object section.

site

object

(Required) The object describing the site, see the Site Object section

regs

object

A regulations object that specifies any industry, legal, or governmental regulations in force for this request, see the Regulation Object section.

ext

object

Extension Object used for Supplier specific properties.

ext Object

hbjson request extension

Value

Type

Description

keywords

array of strings

A list of keywords describing the page

Example Prebid Client-side Request
{
    "id": "some_bid_id",
    "site": {
        "page": "http://www.example.com/article"
    },
    "user": {
        "id": "aaa",
        "buyerid": "xxx",
        "ext": {
            "eids": [
                {
                    "source": "x-device-vendor-x.com",
                    "uids": [
                        {
                            "id": "yyy",
                            "atype": 1
                        },
                        {
                            "id": "zzz",
                            "atype": 1
                        },
                        {
                            "id": "DB700403-9A24-4A4B-A8D5-8A0B4BE777D2",
                            "atype": 2
                        }
                    ]
                },
                {
                    "source": "digitru.st",
                    "uids": [
                        {
                            "id": "IPl4zj44RhezVyNE83bYfoz59H5GCIQrfCdAVyN51zcsme0faoHqfLBijMQEazqGewXTZsMwMfZqwne8x4eAVeNmAx7iPpk7bpGYp71GUZyysbEEReDYEMJ2hNSldGTT9UExI62HvXuBM16X121r0i8Tko2Bps84tQFWb4lJeun/nRzYwj3ehUGjkE3UOxvHoplNqA43n25pRjgUkUVTRgrpTVLv5Vl4PJ4ir7twHLLow539N3ETb0cHt8GVweHBc2dGmqUTNQxGUZxBA21omEmotXpfqRKrHUo4fm/O9NFgYRN6W8LaCy3USy8dPQ==",
                            "atype": 1,
                            "ext": {
                                "keyv": 4
                            }
                        }
                    ]
                },
                {
                    "source": "stat-id-vendor-z.org",
                    "uids": [
                        {
                            "id": "0db20294a3908612bc7e732c2022095391074cf3",
                            "atype": 1,
                            "ext": {
                                "confidence": 0.75
                            }
                        }
                    ]
                }
            ]
        }
    },
    "regs": {
        "ext": {
            "us_privacy": "1YNN",
            "gdpr": 1
        }
    },
    "source": {
        "tid": "absdbasd",
        "ext": {
            "wrapper": "Prebid_js",
            "wrapper_version": "3.20.0",
            "schain": {
                "ver": "1.0",
                "complete": 1,
                "nodes": [
                    {
                        "asi": "directseller.com",
                        "sid": "00001",
                        "rid": "BidRequest1",
                        "hp": 1
                    }
                ]
            }
        }
    },
    "ext": {
        "keywords": {
            "topic": [
                "soccer",
                "football"
            ]
        }
    },
    "tmax": 1000,
    "imp": [
        {
            "bidfloor": 3.213,
            "id": "1",
            "banner": {
                "w": 160,
                "h": 600,
                "format": [
                    {
                        "h": 300,
                        "w": 300
                    },
                    {
                        "h": 350,
                        "w": 300
                    }
                ]
            },
            "tagid": "1",
            "ext": {
                "divid": "some_divid"
            }
        },
        {
            "bidfloor": 3.213,
            "id": "2",
            "video": {
                "minduration": 5,
                "maxduration": 60,
                "mimes": [
                    "video/mp4"
                ],
                "placement": 2,
                "w": 160,
                "h": 600,
                "api": [
                    2
                ]
            },
            "tagid": "2",
            "ext": {
                "divid": "some_divid"
            }
        }
    ]
}