Changelog
Revisions to both integrations, newest first. Breaking changes are called out explicitly and are announced to integration contacts before they take effect.
Version 1.0 (draft)
Status: under revision ahead of general availability.
The initial specification for both wires. Nothing in it is frozen yet, so hostnames and enumerated values may still change. Confirm details with the adon3 integration office before hard-coding them.
Hosts
Delivery moved onto its own domain, separate from the corporate site, so that delivery traffic and reporting traffic can be governed independently.
| Purpose | Host |
|---|---|
| XML feed delivery | dsp.xml.adon3.com |
| RTB bidding | rtb.adon3-ads.com |
| XML reporting | reports.xml.adon3.com |
| RTB reporting | reports.rtb.adon3.com |
All four answer on HTTP and HTTPS.
XML feed
GET /v1/feed/{feed_key}, returning JSON by default or XML withformat=xml- Supply types
link,popandpush, one per feed key - Separate response payloads per supply type: window hints on
pop, notification fields onpush - CPC settlement, with impression notices used for fill quality rather than payout
- Client hint parameters alongside
ua, for browsers that reduce the user agent
RTB exchange
- OpenRTB 2.6 and 2.5, selected with the
x-openrtb-versionheader - Objects and field names follow the IAB specification for the declared version
- One impression per request, answered with a single winning bid
- Banner, video, audio and native impression types
- Private marketplace deals via
imp.pmp - Supply chain enforcement against
sellers.json - OpenRTB substitution macros, replaced by the seller before render
adon3 requirements on top of OpenRTB
| Field | Rule |
|---|---|
device.ua | Required on every request |
device.ip or device.ipv6 | At least one required |
site.domain or app.bundle | At least one required |
Reporting
/reports/sspon both reporting hosts- Credentials passed in the query string as
sspIdandauth - Ranges set with
date_fromanddate_to, inclusive, UTC, capped at 92 days - Grouping set with
dims:dateandsubidon the XML feed,dateon RTB - Money returned as decimal strings, counts as integers
Keeping up with changes
Breaking changes are announced to your technical contact at least 30 days before they take effect, and both versions run in parallel through the transition. Additive changes, such as new optional fields and new enumerated values, ship without notice. Parse defensively and ignore fields you do not recognise rather than treating them as errors.
On the RTB wire, x-openrtb-version states which revision a request follows, and
we answer in the same revision. On the XML feed, new response fields are additive
by policy and no field is removed inside a major version.