Skip to content
Adagio Documentation

Bid Request Fields for App Inventory

In OpenRTB, the bidrequest object acts as the central container for a request. It provides a complete description of the ad opportunity, user information, environment details, and any other context needed for effective bidding.

Below are the fields that Adagio considers required or highly recommended for OpenRTB S2S bid requests on App inventory. A sample bid request from a publisher appears after the table.

  • Required: Necessary to receive a response from Adagio.
  • Highly Recommended: Shown to improve yield and performance.

Required parameters

Section titled “Required parameters”
  • bidrequest.id
  • bidrequest.app.bundle
  • bidrequest.imp[].id
  • bidrequest.imp[].tagid
  • depending on the media
    • bidrequest.imp[].banner.* , bidrequest.imp[].video.* or bidrequest.imp[].native.*
  • if applicable:
    • bidrequest.regs.*
    • bidrequest.user.consent or bidrequest.user.ext.consent
Section titled “Recommended parameters”
⚡️ Highly Recommended
  • bidrequest.tmax
  • bidrequest.source.*: all sub-fields are considered as bringing value to the demand
  • bidrequest.imp[].gpid
  • bidrquest.imp[].ext.skadn for iOS 14+
  • bidrequest.app.storeurl
  • bidrequest.app.content.url : required by Amazon DSP (cf. amazon-dsp-contenturl-and-amazonadbot.md)
  • bidrequest.device.ifa
  • bidrequest.device.ext.ifa_type
  • if open measurement is present :
    • bidrequest.imp[].api = 7
    • bidrequest.source.ext.omidpn (string): OM SDK partner name.
    • bidrequest.source.ext.omidpv (string): OM SDK version
✅ Recommended
  • bidrequest.app.id
  • bidrequest.app.domain
  • bidrequest.app.cat
  • bidrequest.app.ver
  • bidrequest.app.privacypolicy
  • bidrequest.app.paid
  • bidrequest.app.ext.category
  • bidrequest.app.ext.pagetype
  • bidrequest.imp[].metric
  • bidrequest.imp[].instl
  • bidrequest.imp[].exp
  • bidrequest.imp[].displaymanager
  • bidrequest.imp[].displaymanagerver
  • bidrequest.imp[].ext.skadn: for iOS App only
  • bidrequest.device.*: all sub-fields are considered as bringing value to the demand
  • bidrequest.geo.*: all sub-fields are considered as bringing value to the demand

Bid Request Sample for App

Section titled “Bid Request Sample for App ”
{
    "id": "60681242-4b80-473c-a395-4743ec6f1696",
    "tmax": 1200,
    "imp": [
        {
            "id": "1",
            "tagid": "12303405",
            "secure": 1,
            "banner": {
                "api": [
                    3,
                    5,
                    6,
                    7
                ],
                "format": [
                    {
                        "w": 320,
                        "h": 50
                    }
                ]
            },
            "ext": {
                "gpid": "/4145/fnc/desk/art/sports/ban1"
            },
            "metric": [
                {
                    "type": "viewability",
                    "value": 0.85
                }
            ]
        }
    ],
    "app": {
        "name": "My App",
        "bundle": "org.mobile.myapp",
        "content": {
            "url": "https://publishersite.com/article/12345"
        },
        "cat": [
          "IAB9",
          "IAB9-30",
          "IAB1",
          "IAB19",
          "IAB3"
        ],
        "paid": 0,
        "privacypolicy": 1,
        "storeurl": "https://play.google.com/store/apps/details?id=org.mobile.myapp",
        "ver": "1.0.0",
        "publisher": {
            "id": "1000"
        },
        "ext": {
            "pagetype": "topic",
            "category": "home"
        }
    },
    "device": {
        "ifa": "469203a9-7bf5-4827-ad7b-29e00af35f32",
        "ext": {
            "ifa_type": "dpid"
        },
        "ua": "Mozilla\/5.0 (Linux; Android 15; sdk_gphone64_arm64 Build\/AE3A.240806.036; wv) AppleWebKit\/537.36 (KHTML, like Gecko) Version\/4.0 Chrome\/124.0.6367.219 Mobile Safari\/537.36",
        "lmt": 0,
        "dnt": 0,
        "geo": {
              "lat": 42.71,
              "lon": -78.83,
              "type": 1,
              "country": "USA",
              "region": "NY",
              "metro": "716",
              "city": "Hamburg",
              "zip": 14075
        },
        "devicetype": 4,
        "ip": "1.1.1.1",
        "make": "Google",
        "model": "sdk_gphone64_arm64",
        "os": "Android",
        "osv": "15",
        "hwv": "Google sdk_gphone64_arm64",
        "language": "en",
        "carrier": "T-Mobile",
        "mccmnc": "310-260",
        "h": 2400,
        "w": 1080,
        "connectiontype": 2,
        "pxratio": 2.625
    },
    "regs": {
        "gdpr": 1
    },
    "user": {
        "consent": "CO9boCtO9boCtAJAEBENBBCsAP_AAH_AACiQHGtd_X_fb39j-_59_9t0eY1f9_7_v20zjgeds-8Nyd_X_L8X42M7vB36pq4KuR4Eu3LBAQFlHOHcTUmw6IkVqTPsak2Mr7NKJ7PEinMbe2dYGHtfn9VTuZKYr97s___z__-__v__79f_r-3_3_vp9V---2BxIBJhqXwEWYljgSTRpVCiBCFcSHQAgAooRhaJrCAlcFOyuAj9BAwAQGoCMCIEGIKMWQQAAAABJREBIAeCARAEQCAAEAKkBCAAjQBBYASBgEAAoBoWAEUAQgSEGRwVHKYEBEi0UE8lYAlF3sYYQhlFADQIAAAA.f_gAD_gAAAAA"
    },
    "source": {
        "tid": "60681242-4b80-473c-a395-4743ec6f1696",
        "schain": {
            "ver": "1.0",
            "complete": 1,
            "nodes": [
                {
                    "asi": "advertising-sys.com",
                    "sid": "99999",
                    "hp": 1
                }
            ]
        }
    }
}