Server-to-Server (S2S) Calls
Auction Endpoints
For European and UK traffic, GDPR compliance is mandatory. Refer to our list of vendor IDs, hereunder, to be added in your CMP in order to properly monetize.
S2S Headers
The OpenRTB Version should be passed in the header of a bid request with a custom HTTP header.
x-openrtb-version: 2.5
x-openrtb-version: 2.6
OpenRTB fields requirements
This section mentions some of the important fields that you should include in your adRequests, based either on our requirements or what we've observed performance wise with our demand partners.
While we do specify here important fields we still expect you to fill other official parameters (cf. the official documentation) and some of the extensions (cf. documentation for community and official ext.) defined by the OpenRTB specifications.
tmax
Highly Recommended
int
Maximum time in milliseconds the exchange allows for bids to be received including Internet latency to avoid timeout.
Minimum value: 470
.
app.publisher.id
Yes
string
Your ID, provided by Adagio, found under Settings > General in the Adagio Manager.
app.bundle
Yes
string
Bundle of the app. Depending if it's an iOS or Android app.bundle. For iOS: e.g. "324684580" For Android: e.g. “com.example.myapp”.
app.cat
Recommended
string array
Array of IAB Tech Lab content categories of the app. The taxonomy to be used is defined by the cattax field. If no cattax
field is supplied Content Category Taxonomy 1.0 is assumed.
app.ext.category
Recommended
string
Category of the content displayed in the page. - max length: 30 - max distinctive values: 50
app.ext.pagetype
Recommended
string
Describes what kind of content will be present in the page. - max length: 30 - max distinctive values: 50
app.paid
Recommended
integer
Indicates whether the app is paid (1) or free (0).
app.privacypolicy
Recommended
integer
Indicates whether the app has a privacy policy (1) or not (0).
app.storeurl
Highly Recommended
string
App store URL for an installed app; for IQG 2.1 compliance (it will be used by Bidders to fetch your app-ads.txt
)
app.ver
Recommended
string
Version of the app.
imp[].tagid
Yes
string
Custom value you define to identify an ad unit placement. Use consistent values, avoiding auto-incremented or random ones. e.g."identifier12345". - max length: 150 - max distinctive values: 100
imp.metric
Recommended
object array
These metrics can offer insight into the impression to assist with decisioning such as average recent viewability, click-through rate, etc. (cf. section 3.2.5 of oRTB)
imp.displaymanager
Recommended
string
Name of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile). Used by some ad servers to customize ad code by partner.
imp.displaymanagerver
Recommended
string
Version of Display Manager (declared in imp.displaymanager
)
device.ua
Recommended
string
Browser user agent string. This field represents a raw user agent string from the browser.
device.geo
Recommended
object
Location of the device, assumed to be the user current location (see object definition in 3.2.19 of oRTB).
Especially lat
& long
device.ifa
Highly Recommended
string
The IFA must be a unique value and must never be (or be based on) a hardware-specific ID
device.ext.ifa_type
Yes (only if device.ifa
is present)
string
Identify the source of the IFA (cf. oRTB docs for possible values)
device.dnt
Recommended
Integer
Standard “Do Not Track” flag as set in the header by the browser, where 0 = tracking is unrestricted, 1 = do not track.
device.lmt
Recommended
Integer
“Limit Ad Tracking” signal commercially endorsed (e.g., iOS, Android), where 0 = tracking is unrestricted, 1 = tracking must be limited per commercial guidelines.
device.ip
Recommended
String
IPv4 address closest to device.
device.devicetype
Recommended
Integer
The general type of device (cf. List: Device Types in AdCOM 1.0).
device.make
Recommended
String
Device make (e.g., “Apple”).
device.model
Recommended
String
Device model (e.g., “iPhone”).
device.os
Recommended
String
Device operating system (e.g., “iOS”).
device.osv
Recommended
String
Device operating system version (e.g., “3.1.2”).
device.hwv
Recommended
String
Hardware version of the device (e.g., “5S” for iPhone 5S).
device.language
Recommended
String
Browser language using ISO-639-1-alpha-2. Only one of language
or langb
should be present.
device.carrier
Recommended
String
Carrier or ISP (e.g., “VERIZON”) using exchange curated string names which should be published to bidders a priori.
device.connectiontype
Recommended
String
Network connection type (cf. List: Connection Types in AdCOM 1.0).
Data Compression (gzip)
Adagio ONLY supports Compressed JSON (gzip) for bid requests and bid responses.
It is mandatory to use Compressed JSON to reduce the amount of data exchanged between you and Adagio, as this decreases latency times between servers, and traffic listening costs for all parties involved.
Configure compressed JSON bid requests and enable compressed responses:
Compress your HTTP request body with gzip
Add a Content-Encoding: gzip
HTTP header to indicate that the request is compressed
Add an Accept-Encoding: gzip
header to indicate that you can accept a compressed response
Passing External IDs in the Bidrequest
External IDs (EIDs) allow DSPs to recognize users across different supply sources, improving match rates, bid relevance, and overall revenue performance.
We support the transmission of any EIDs within the user.eids
or user.ext.eids
object of your OpenRTB bid request, such as UID2.0, Ramp ID, ID5, and others.
Be sure to include the following parameters in your eids
:
source
uids.id
source.uids.atype
"user": {
"ext": {
"eids": [
{
"source": "x-device-vendor-x.com",
"uids": [
{
"id": "yyy",
"atype": 1
}
]
}
]
}
Supported Currencies
Adagio uses exchange rates from the European Central Bank to perform currency conversions. Below the list of currencies supported in Bid Requests and Bid Responses:
Last updated
Was this helpful?