Set Up Custom Integrations With Adform OpenRTB Handler

Greta
Greta
  • Updated

You can use the Adform OpenRTB Handler to apply custom integrations to all the data Adform sends or receives.

Adform's OpenRTB Handler is OpenRTB 2.5 compliant.

The request endpoint is:

https://adx.adform.net/adx/openrtb

In the request content type, the HTTP header must be set to Content-Type: application/json.

Match Cookies

An example of a cookie-matching endpoint:

https://c1.adform.net/cookie?redirect_url=https%3A%2F%2Fcookie.com%2Fsetuid%3Fuid%3D%24UID

In the above example, the redirect_url parameter contains partner server matching endpoint. Adform replaces the $UID macro in this URL with the actual ID.

You can append custom parameters to Adform's cookie-matching URL, which will be passed along in the redirect to the URL. For example, to pass the custom=mycustomparamvalue1 parameter, include it in the redirect value after URL-encoding it:

https://c1.adform.net/cookie?redirect_url=https%3a%2f%2fcookie.com%2fsetuid%3fuid%3d%24UID%26custom%3dmycustomparamvalue1

It'll redirect to this URL:

 https://cookie.com/setuid?uid={{CookieIdWillBeReplaced}}&custom=mycustomparamvalue1

Learn about third-party cookie matching.

Dynamic Master Tag Support

Adform supports two types of tags: exact and dynamic. For exact tags, Adform assumes that a placement was created within an account and then a master tag ID (mid-value) is used within a header bidding setup. With dynamic master tags, you can create tags using the information provided from the OpenRTB protocol.

Adform uses the following information to create both publisher and placement:

  • Site.name: Creates a new publisher within the system unless it already exists. If site.name isn't provided, Adform uses the site.domain value. If site.domain is also empty, Adform tries to extract the domain from the URL as defined in site.page .

  • Imp[].banner.pos OR Imp[].video.pos: Determines the placement's position on the screen.

  • Imp[].ext.bidder.inv: Indicates the inventory source ID (your Adform account ID), where the publisher and placement are or mapped to.

  • Imp[].ext.bidder.mname: Creates a new placement if a placement with such name does not yet exist.

  • Imp[].banner.w + Imp[].banner.h OR Imp[].banner.format[0].w + Imp[].banner.format[0].h Defines the dimensions of the placement.

Adform must approve each placement created dynamically before bidding is activated. Accounts may have a limited number of unapproved placements in the system. When the limit is reached, you can't create any new placements.

Note

Adform doesn't support in-app placement creation using dynamic master tags. To onboard in-app inventory and pass app information through an openRTB request, see Onboard In-App Inventory Into Adform SSP.

Bid Request Specifications

See Bid Request Specifications for information about bid request attributes.

Bid Requests Samples

See Sample Bid Requests to see examples of various bid requests.

Bid Response Specifications

A bid request endpoint responds with either:

  • An OpenRTB 2.5 bid response,

  • HTTP 400 if the request is malformed, or

  • HTTP 503 if the account specified in the request is blocked.

See Bid Response for information about bid response attributes.

Bid Responses Samples

For examples of various bid responses, see Sample Bid Responses.

Was this article helpful?

/
How we can make it better?

Thank you for your feedback!