Skip to content

Reusable foundation

OpenRTB 2.6 common envelope

This complete banner transaction demonstrates the common 2.6 request and response envelope. The format chapters that follow show the exact imp and bid objects to use for each Nexus media type.

Bid Request

json
{
  "id": "req-2.6-001",
  "at": 2,
  "tmax": 300,
  "cur": ["USD"],
  "source": {
    "tid": "nexus-transaction-001",
    "schain": {
      "ver": "1.0",
      "complete": 1,
      "nodes": [
        {
          "asi": "exchange.example",
          "sid": "publisher-1001",
          "hp": 1
        }
      ]
    }
  },
  "imp": [
    {
      "id": "1",
      "secure": 1,
      "bidfloor": 0.15,
      "bidfloorcur": "USD",
      "banner": {
        "format": [
          { "w": 300, "h": 250 },
          { "w": 320, "h": 50 }
        ],
        "mimes": ["image/jpeg", "image/png", "image/gif"]
      }
    }
  ],
  "site": {
    "id": "site-1001",
    "domain": "publisher.example",
    "publisher": { "id": "publisher-1001" },
    "content": {
      "langb": "en-US",
      "livestream": 0,
      "realtime": 0,
      "firstbroadcast": 0
    }
  },
  "device": {
    "ua": "Mozilla/5.0",
    "sua": {
      "browsers": [{ "brand": "Chromium", "version": ["124"] }],
      "platform": { "brand": "Windows", "version": ["10"] },
      "mobile": 0,
      "source": 1
    },
    "ip": "192.0.2.10",
    "langb": "en-US"
  },
  "user": {
    "id": "buyer-visible-user-id",
    "eids": [
      {
        "source": "identity.example",
        "uids": [{ "id": "consented-id", "atype": 1 }]
      }
    ]
  },
  "regs": {
    "gdpr": 1,
    "gpp": "DBABMA~CPXxRfAPXxRfAAfKABENB-CgAAAAAAAAAAYgAAAAAAAA",
    "gpp_sid": [2]
  }
}

Bid Response

json
{
  "id": "req-2.6-001",
  "bidid": "bid-2.6-001",
  "cur": "USD",
  "seatbid": [
    {
      "seat": "advertiser-seat-25",
      "bid": [
        {
          "id": "bid-1",
          "impid": "1",
          "price": 0.175,
          "adomain": ["advertiser.example"],
          "cid": "campaign-41",
          "crid": "creative-31",
          "mtype": 1,
          "w": 300,
          "h": 250,
          "nurl": "https://bidder.example/win?price=${AUCTION_PRICE}",
          "burl": "https://bidder.example/billing?price=${AUCTION_PRICE}",
          "lurl": "https://bidder.example/loss?code=${AUCTION_LOSS}",
          "adm": "[NEXUS_XML_AD_MARKUP]"
        }
      ]
    }
  ]
}

No Bid

Return HTTP 204 No Content when no bid is submitted. If a structured no-bid response is agreed, use the IAB nbr code list and return valid OpenRTB JSON.

White-label Nexus API documentation