id

string; required

Unique ID of the bid request, provided by the supply partner.

test

integer

Indicator of test mode in which auctions are not billable, where 0 = live mode, 1 = test mode.

badv

array of strings

Blocked advertiser domains (max 50).

bcat

array of strings

Specifies a list of blocked IAB content categories (see OpenRTB 2.5 section 5.1). This is not supported by all of our demand partners.

wseat

array of strings

Specifies an array representing an include list of buyer seats allowed to bid on this impression. If omitted, there are no seat restrictions for this impression. This is not supported by all of our demand partners.

bseat

array of strings

Specifies an array representing an exclude list of buyer seats disallowed to bid on this impression. This is not supported by all of our demand partners.

tmax

integer

Maximum time in milliseconds the exchange allows for bids to be received, including Internet latency, to avoid timeout. Must be >= 100. Most responses should arrive in under 200-300ms. MobileFuse will attempt to achieve the tmax, but due to latency inconsistency, it is not guaranteed.

imp

array with object; required

Impression offered in this bid request. MobileFuse supports only a single impression per bid request. See 3.2.4 Object: Imp

app

object; required

Specifies information about the app. See 3.2.14 Object: App

device

object; required

Specifies information about the user’s device. See 3.2.18 Object: Device

user

object

Specifies information about the user. See 3.2.20 Object: User

source

object

Specifies information about the source. See 3.2.2 Object: Source

regs

object

Specifies regulations for this impression. See 3.2.3 Object: Regs

pchain

string

Payment ID chain string containing embedded syntax described in the TAG Payment ID Protocol v1.0.

tid

string

Transaction ID

ext

object; recommended

Object with fields for “omidpn”, “omidpv”, “schain”, and “ssreq”. schain attribute is required when MobileFuse’s relationship with the publisher is not direct.

coppa

integer

Flag indicating if this request is subject to the COPPA regulations established by the USA FTC, where 0 = no, 1 = yes.

ext

object

Object that supports “gdpr” property [regs.ext.gdpr + user.ext.consent] to specify that this request is subject to GDPR regulations in support of the IAB OpenRTB Extension for GDPR and “us_privacy” to specify that this request is subject to CCPA US privacy regulations in support of the IAB OpenRTB Extension for US Privacy. Please note that we enforce privacy regulations for all US (not just California) and that not all demand sources support these properties

id

string; required

A unique identifier for this impression within the context of the bid request (typically just “1”)

tagid

string; required

MobileFuse-provided ID for the ad unit, or publisher’s tagid if preferred and provided to account manager

banner

object

Required if this request is for a banner ad unit. See 3.2.6 Object: Banner

video

object

Required if this request is for a video ad unit. See 3.2.7 Object: Video

instl

integer; default 0

1 = the ad is interstitial or full screen, 0 = not interstitial.

secure

integer; default 0

Flag to indicate if the impression requires secure HTTPS URL creative assets and markup, where 0 = non-secure, 1 = secure.

bidfloor

float, default 0

Bidfloor in USD

exp

int

Advisory as to the number of seconds that may elapse between the auction and the actual impression.

ext

object

Supports skadn field to supply SKAdNetwork info

w

integer

Exact width in device independent pixels (DIPS). Note that the format field is preferred instead

h

integer

Exact height in device independent pixels (DIPS). Note that the format field is preferred instead

btype

array of integers

Specifies the banner creative types to block. Refer to section 5.2 of the IAB specification for a list of types. This is not supported by all demand sources.

battr

array of integers

Specifies the banner creative attributes to block. Refer to section 5.3 of the IAB specification for a list of attributes. This is not supported by all demand sources.

pos

integer; default 0

Ad Position. Fully supported: 0 = Unknown, 1 = Above Fold, 3 = Below Fold. Some demand supports all OpenRTB 2.5 list 5.4.

api

array of integers

List of supported API frameworks for this banner. If an API is not explicitly listed, it is assumed not to be supported. Refer to OpenRTB 2.5 list 5.6.

format

array of objects

Array of format objects representing the banner sizes permitted. See 3.2.10 Object: Format

mimes

array of strings

Content MIME types supported

expdir

array of integers

Directions in which the banner may expand. Refer to OpenRTB List 5.5.

mimes

array of strings

Specifies the video content MIME types supported; for example, video/mp4 and video/x-ms-wmv. If not specified, any MIME type is allowed.

minduration

integer; recommended

Specifies the minimum video ad duration, in seconds.

maxduration

integer; recommended

Specifies the maximum video ad duration, in seconds.

w

integer

Specifies the width of the video player, in pixels.

h

integer

Specifies the height of the video player, in pixels.

startdelay

integer

Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements. Refer to OpenRTB 2.5 List 5.12 for values.

battr

array of integers

Specifies the banner creative attributes to block. Refer to section 5.3 of the IAB specification for a list of attributes. This is not supported by all demand sources. This is not supported by all demand sources.

minbitrate

integer

Specifies the minimum bit rate, in kilobytes per second. If specified, only return creatives having at least one media file within the appropriate bit range.

maxbitrate

integer

List of supported API frameworks for this banner. If an API is not explicitly listed, it is assumed not to be supported. Refer to OpenRTB 2.5 list 5.6.

playbackmethod

array of integers

Playback methods that may be in use. If none are specified, any method may be used. Refer to OpenRTB 2.5 List 5.10. 

pos

integer

Ad position on screen. Refer to OpenRTB 2.5 List 5.4.

api

array of integers

List of supported API frameworks for this impression. Refer to OpenRTB 2.5 List 5.6. If an API is not explicitly listed, it is assumed not to be supported.

protocols

array of integers

Array of supported video protocols. Refer to OpenRTB 2.5 List 5.8.

placement

integer

Placement type for the impression. Refer to OpenRTB 2.5 List 5.9.

boxingallowed

integer; default 1

Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed, where 0 = no, 1 = yes

delivery

array of integers

Supported delivery methods (e.g., streaming, progressive). If none specified, assume all are supported. Refer to List 5.15.

skip

integer

Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes.

skipafter

integer; default 0

Videos of total duration greater than this number of seconds can be skippable; only applicable if the ad is skippable.

skipmin

integer; default 0

Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable

w

integer

Specifies the width of the creative, in pixels.

h

integer

Specifies the height of the creative, in pixels.

bundle

string; required

On Android, this should be a bundle or package name (e.g., com.foo.mygame). On iOS, it should be a numeric ID.

domain

string

Domain of the app (e.g., “mygame.foo.com”).

cat

array of strings

Array of IAB content categories of the app. Refer to OpenRTB 2.5 List 5.1

name

string

App name

publisher

object

Details about the publisher of the app. See 3.2.15 Object: Publisher

storeurl

string

App store URL for an installed app

ver

string

Application version

keywords

string

Comma separated list of keywords about the app.

id

string

Please use bundle instead

paid

integer

0 = app is free, 1 = the app is a paid version

content

object

Details about the content of the app. See 3.2.16 Object: Content

name

string

Publisher name

id

string

Publisher id

contentrating

string

Content rating (e.g., MPAA).

genre

string

Genre that best describes the content (e.g., rock, pop, etc).

len

integer

Length of content in seconds; appropriate for video

livestream

integer

0 = not live, 1 = content is live (e.g., stream, live blog).

series

string

Content series.

Video Examples: “The Office” (television), “Star Wars” (movie), or “Arby ‘N’ The Chief” (made for web).

Non-Video Example: “Ecocentric” (Time Magazine blog).

title

string

Content title.

Video Examples: “Search Committee” (television), “A New Hope” (movie), or “Endgame” (made for web).

Non-Video Example: “Why an Antarctic Glacier Is Melting So Quickly” (Time magazine article).

context

integer

Type of content (game, video, text, etc.). Refer to OpenRTB List 5.18.

ifa

string; recommended

ID sanctioned for advertiser use in the clear (i.e., not hashed).

ua

string; required

Browser user agent string.

geo

object; recommended

Location of the device assumed to be the user’s current location defined by a Geo object. See 3.2.19 Object: Geo

dnt

integer

Standard “Do Not Track” flag as set in the header by the browser, where 0 = tracking is unrestricted, 1 = do not track.

lmt

integer

“Limit Ad Tracking” signal commercially endorsed (e.g., iOS, Android), where 0 = tracking is unrestricted, 1 = tracking must be limited per commercial guidelines. Values of 1 will be treated as opt outs for the purpose of us privacy laws.

ip

string; required

IPv4 address closest to device

ipv6

string

IP address closest to device as IPv6

devicetype

integer

The general type of device. Refer to OpenRTB 2.5 List 5.21

make

string

Device make (e.g., “Apple”).

model

string

Device model (e.g., “iPhone”).

os

string

Device operating system (e.g., “iOS”).

osv

string

Device operating system version (e.g., “3.1.2”).

language

string

Browser language using ISO-639-1-alpha-2.

carrier

string

Carrier or ISP

connectiontype

integer

Network connection type. Refer to List 5.22.

w

integer

Physical width of the screen in pixels.

h

integer

Physical height of the screen in pixels.

ext

object

Supports ifv and atts fields per the SKAdNetwork extension

city

string

City using United Nations Code for Trade & Transport Locations. See OpenRTB Appendix A for a link to the codes

country

string

Country code using ISO-3166-1-alpha-3. MobileFuse only accepts USA and CAN traffic.

lat

float; recommended

Latitude from -90.0 to +90.0, where negative is south. Highly recommended to increase ability to monetize.

lon

float; recommended

Longitude from -180.0 to +180.0, where negative is west. Highly recommended to increase ability to monetize.

metro

string

Google metro code; similar to but not exactly Nielsen DMAs. See OpenRTB Appendix A for a link to the codes

region

string

Region code using ISO-3166-2; 2-letter state code if USA.

type

integer; recommended

Source of location data; recommended when passing lat/lon. Refer to OpenRTB 2.5 List 5.20.

utcoffset

integer

Local time as the number +/- of minutes from UTC.

zip

string

Zip or postal code.

gender

string

Gender, where “M” = male, “F” = female, “O” = known to be other (i.e., omitted is unknown).

yob

integer

Year of birth as a 4-digit integer.

ext

object

Object containing one field for “consent” which is highly recommended if the request is subject to GDPR regulations. “consent” contains the data structure developed by the GDPR Consent Working Group under the auspices of IAB Europe.