Adform OpenRTB handler

Adform's OpenRTB Handler is the endpoint that receives OpenRTB supply from custom integrations on the Adform platform. Adform publishes setup, request, response, and sample pages for it.

Direction and version

Supply partners send bid requests into the Adform OpenRTB Handler, and the Handler returns bid responses.

OpenRTB 2.5 compatibility, though the request table also lists the 2.6 fields user.eids, regs.gpp, and regs.gpp_sid.

The RTBlint profile adform-handler checks requests and responses against the published contract.

Rules beyond the OpenRTB spec

DSA requirements in regs.ext.dsa use dsarequired 0 to 3, and pubrender and datatopub 0 to 2. Adform's samples spell dsarequired and dsaparams as required and params.
Transparency parameters in dsaparams must be 1, 2, or 3.
When the request's DSA requirement is 2 or 3, each bid must return bid.ext.dsa.
Response DSA objects always include paid. Values of behalf and paid are limited to 100 characters.
A supply chain in source.ext.schain needs ver, complete, and at least one node, and each node needs asi and sid.
Native image assets must declare dimensions, as w and h or wmin and hmin. Images without dimensions do not produce impressions.
Legacy regs.ext.gdpr, user.ext.consent, user.ext.eids, and source.ext.schain remain valid.

Documented extensions

Path	Meaning
`ext.pt`	Price type of the request, as a string.
`regs.ext.gpc`	Global Privacy Control signal, as a string.
`regs.ext.dsa`	DSA requirements and transparency platforms.
`regs.ext.gdpr`	GDPR flag, 0 or 1.
`user.ext.consent`	TCF consent string.
`user.ext.eids`	Extended identifiers in their OpenRTB 2.5 location.
`source.ext.schain`	Supply chain in its OpenRTB 2.5 location.
`bid.ext.dsa`	DSA transparency returned with the bid.

What the validator checks for this profile

openrtb.profile.adform.dsa_name_length Adform DSA advertiser names must contain at most 100 Unicode characters.
openrtb.profile.adform.dsa_parameter Adform DSA targeting parameter must be 1, 2, or 3.
openrtb.profile.adform.dsa_required Adform requires DSA response information when the Handler request's DSA requirement is 2 or 3.
openrtb.profile.adform.native_image_size Adform Native image requests need image dimensions; unbounded images do not generate impressions.
openrtb.profile.adform.schain_nodes Adform's declared supply chain requires at least one node.

Validate against this contract

Open the tester with the Adform OpenRTB handler profile, or run:

rtblint validate --profile adform-handler request.json