RTB Specs

Owned by
Yael Schuster
Last updated: Mar 04, 2021
2 min read

Overview

Aniview supports setting up Ad Sources using OpenRTB protocol. The supported protocol versions are 2.3, 2.4 or 2.5.

This document describes the supported fields and features for these integrations. In addition to that, the supported supply environments are: Video for Web, Mobile Web, App, and CTV.

In terms of encoding, we support both plain text and GZIP (Recommended).

Request Object - Supported Fields

When calling the demand partners, Aniview supports the following objects and fields. If additional fields or extensions are required, please contact Aniview.

Note - Some fields are located in the ext object in earlier versions of openRTB. In those cases, Aniview will automatically adjust it according to the configurable version):

Object

Supported Fields

Object

Supported Fields

request object

id
tmax
test
at
cur
bcat
badv
imp (Object)
regs (Object)
device (Object)
user (Object)
ext (Object)
site (Object)
app (Object)
ifa

imp

secure
instl
id
tagid
video (Object)
bidfloor
bidfloorcur

video

boxingallowed
startdelay
mimes
api
placement
maxbitrate
w
h
pos
minduration
maxduration
playbackmethod
delivery
ext (Object)
linearity
protocols

site

ref
id
page
name
domain
publisher (Object)
content (Object)

app

id
name
publisher (Object)
bundle
storeurl

publisher

id
name
domain

device

js
carrier
devicetype
make
ua
os
ip
language
geo (object)
osv
dnt
model

geo

country
lat
lon
type

user

id
buyeruid

regs

coppa
ext.gdpr

pmp

private_auction
deals

deal

id
bidfloor
bidfloorcur
at
wseat

source

tid
pchain
ext.schain

Response

Aniview supports the OpenRTB macros and will replace them in the response markup.

Supported fields:

Object

Supported Fields

Object

Supported Fields

response object

id
cur (only USD is supported)
seatbid (Object)

seatbid

bid

bid

id
impid
price
adm
nurl
burl
lurl *
adomain
cat
w
h

* lurl is supported for both Substitution Macros (as per Section 4.4 of the OpenRTB 2.5 specs) and as Loss Reason Codes (as per section 5.25). The codes are as follows:

  • INVALID_BID = 3

  • NO_BID_PRICE = 9

  • BID_PRICE_BELLOW_FLOOR = 100

  • LOST_TO_HIGHER_BID_PRICE = 102

  • ADVERTISER_DOMAIN_EXCLUSION = 205

  • APP_BUNDLE_EXCLUSION = 206

  • IAB_CATEGORY_EXCLUSION = 209

Cookie Sync

Both demand initiated and supply initiated syncs are supported by Aniview.
However, supply initiated cookie sync is recommended. Syncing is automatically initiated by the player for relevant web traffic. It is also recommended to support a dynamic redirect URL so that Aniview can control the redirect URL back to Aniview in real-time.


For demand initiated sync, Aniview will provide a sync URL.


For supply initiated sync, for new demand partners, provide a sync URL and Aniview will implement the integration.

Sync examples:

  • DSP sync url: https://sync.dsp.com/partner=abc&r=https%3A%2F%2Fsync.aniview.com%2Fcookiesyncendpoint%3Fauid%3D1234%26biddername%3D9999%26key%3DBUYERUID.

  • DSP will redirect back to Aniview replacing BUYERUID with the actual user ID.

  • Aniview will save the user ID mapping table and will use the buyeruid in future requests.