Skip to end of metadata
Go to start of metadata

Mobile OpenRTB 2.2 Bid Request

In the OpenRTB 2.2 specification, you'll find required, recommended, and optional bid request fields. Xandr supports all required fields but only certain recommended and optional fields. This page clarifies which recommended and optional fields Xandr supports.

Xandr Support for OpenRTB 2.2 will be deprecated on May 21, 2018.

Xandr supports the OpenRTB 2.4 specification for receiving all media type impressions.

On This Page

Endpoints

To send a bid request to Xandr, you POST to the following endpoint:

For testing in our client-testing environment, you POST to the following endpoint:

To cause Xandr to return a no bid response, you can pass testbid=nobid in the query string of your request.

Optional/Recommended Fields Supported By Xandr

Xandr supports the recommended and optional fields listed below. Any optional or recommended fields not listed below will not be interpreted in bid requests.

Bid Request Object

Xandr supports the following optional fields in the top-level bid request object.

Field

Type

Description

bcat

array of strings

The IAB creative categories to block. Xandr will not submit creatives with these categories. For a list of supported IAB categories, see section "6.1 Content Categories" in the OpenRTB 2.2 specification.

badv

array of strings

The domains to block. Xandr will not respond with creatives that have these domains in their brand URLs. To view brands registered in the Xandr system, use the Brand Service.

ext

object

A Xandr-specific extension to identify the device. Note that device IDs in the device object override any device IDs in the ext object. See Extension Object and Device Object for details.

Extension Object

Xandr supports the following Xandr-specific fields in the ext.udi and ext.appnexus objects. The ext.udi object holds device identifier information, and the ext.appnexus object currently holds the Xandr user ID.

Note that device IDs in the device object override any device IDs in the ext.udi object. See Device Object for more details.

ext.appnexus

Field

Type

Description

anidstringThe Xandr user ID of the user on this request.  For more information about how to map your user IDs with ours, see User ID Mapping.

ext.udi

Field

Type

Description

androidid

string

The raw identifier for an Android device. This is unencrypted.

androididmd5

string

The MD5-encrypted identifier for an Android device.

androididsha1

string

The SHA1-encrypted identifier for an Android device.

imei

string

The raw IMEI (International Mobile Equipment Identity) identifier for the mobile device. This is unencrypted. 

imeimd5

string

The MD5-encrypted IMEI identifier for the mobile device. 

imeisha1

string

The SHA1-encrypted IMEI identifier for the mobile device. 

idfa

string

The Apple advertising identifier for an Apple device running iOS 6+.

udidmd5

string

The MD5-encrypted UDID (Unique Device Identifier) for the mobile device.

udidsha1

string

The SHA1-encrypted UDID (Unique Device Identifier) for the mobile device.

macmd5

string

The MD5-encrypted MAC (Media Access Control) address for the mobile device.

macsha1

string

The SHA1-encrypted MAC (Media Access Control) address for the mobile device.

odin

string

The ODIN-encrypted unique identifier representing the mobile device.

openudid

string

The OPENUDID-encrypted identifier for the mobile device.

Impression Object

Xandr supports the following optional field in the imp object.

Field

Type

Description

tagid

string

The Xandr placement code for the impression. To retrieve placement codes, use the Placement Service.

Note: If this field is not passed, Xandr checks the following locations, in the following sequence, to map your request to a placement in Xandr: 1. id in the Site Object (if a mobile web impression) or id in the App Object (if a mobile app impression); 2. id in the Publisher Object. See Placement Mapping for more details.

banner

object

See Banner Object for details.

pmpobjectSee PMP Object for details.

Banner Object

For banner impressions, Xandr supports the following recommended and optional fields in the banner object.

Field

Type

Description

w

int

The width of the impression in pixels. This is highly recommended.

h

int

The height of the impression in pixels. This is highly recommended.

battr

array of ints

The creative attributes to block. Xandr will not submit creatives with these attributes. For a list of supported creative attributes, see section "6.3 Creative Attributes" in the OpenRTB 2.2 specification.

btype

array of ints

The types of banner creatives to block. Xandr will not submit banners of these types. For a list of banner types, see section "6.2 Banner Ad Types" in the OpenRTB 2.2 specification.

The license could not be verified: License Certificate has expired!

Site Object

For mobile web impressions, Xandr supports the following optional fields in the site object.

Field

Type

Description

id

string

The Xandr placement code for a mobile web impression. To retrieve placement codes, use the Placement Service.

Note: Xandr checks this field only if the placement code is not passed in the tagid field of the Impression Object. If the placement is not passed in either location, Xandr checks the id in the Publisher Object. See Placement Mapping for more details.

cat

array of strings

The IAB content categories for the site. You may want to pass content categories to enable buyers to more precisely target your inventory. For a list of supported IAB content categories, see section "6.1 Content Categories" in the OpenRTB 2.2 specification.

publisher

object

See Publisher Object for details.

App Object

For mobile app impressions, Xandr supports the following optional fields in the app object.

Field

Type

Description

id

string

The Xandr placement code for a mobile app impression. To retrieve placement codes, use the Placement Service.

Note: Xandr checks this field only if the placement code is not passed in the tagid field of the Impression Object. If the placement is not passed in either location, Xandr checks the id in the Publisher Object. See Placement Mapping for more details.

publisher

object

See Publisher Object for details.

Publisher Object

Xandr supports the following recommended field in the publisher object.

Field

Type

Description

id

string

The Xandr code for the publisher. Xandr uses the default placement associated with this publisher when the placement code is not passed in any of the following locations:

Device Object

Xandr supports the following recommended and optional fields in the device object. Note that device IDs in this object override any device IDs in the ext object. See Extensions Object for more details.

Field

Type

Description

ua

string

The user agent string from the browser. User agent often identifies such information as the application, operating system, and software vendor acting on behalf of the user, e.g., "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv:1.9.0.4) Gecko/2008102920 Firefox/3.0.4".

ip

string

The IPv4 address closest to device. This is used only when the geo object is not passed.

geo

object

The location of the device, as derived from the device's location services (i.e., cell tower triangulation or GPS) or IP address. Note that geo overrides ip. See Geo Object for details.

ifastringThe Google Android ID or Apple Advertising ID, depending on the device type.

didsha1

string

The SHA1-encrypted unique identifier for the mobile device.

didmd5

string

The MD5-encrypted unique identifier for the mobile device.

dpidsha1

string

The SHA1-encrypted platform-specific (e.g., Android ID or UDID for iOS) unique identifier for the mobile device.

dpidmd5

string

The MD5-encrypted platform-specific (e.g., Android ID or UDID for iOS) unique identifier for the mobile device.

carrier

string

The carrier for the device. You can use the Carrier Service to view the carriers registered in the Xandr system.

make

string

The make of the device. To view the makes registered in the Xandr system, use the Device Make Service.

model

string

The mode of the device. To view the models registered in the Xandr system, use the Device Model Service.

os

string

The operating system of the device. If passed, this overrides the operating system in the ua field. To view operating systems registered in the Xandr system, use the Operating System Extended Service.

devicetype

int

The type of device (i.e., "Mobile/Tablet" or "Personal Computer"). For a list of supported device types, see section "6.16 Device Type" in the OpenRTB 2.2 specification.

Geo Object

Xandr supports the following optional fields in the geo object.

Field

Type

Description

lat

float

The latitude of the device, as derived from the device's location services (i.e., cell tower triangulation or GPS) or IP address. This can be from -90 to 90. South is negative.

lon

float

The longitude of the device, as derived from the device's location services (i.e., cell tower triangulation or GPS) or IP address. This can be from -90 to 90. West is negative.

Placement Mapping

When Xandr receives your bid request, we map your request to a placement in Xandr. We look up the following, in the following sequence:

  1. tagid in the imp object
  2. id in the site object (if a mobile web impression) or id in the app object (if a mobile app impression)
  3. id in the publisher object

If we can't map your request to any of the above, Xandr maps your request to the default placement for your Xandr member.

  • No labels