Skip to end of metadata
Go to start of metadata

Bid Request to Bidders

This describes the AppNexus integration of the OpenRTB 2.4 protocol.

This Bid Request is sent to bidders whenever an ad call reaches the Impression Bus. It contains all the necessary information for a bidder to produce a bid price and a creative to serve.

The Bid Request includes information from sellers that specifies which advertisers and creatives are allowed to win an auction and run on a page. 

You may not wish to receive all bid requests that pass through the AppNexus platform. You can either throttle requests by some percentage, or filter requests by preset criteria such as geography. Please see Traffic Filtering for details.


On This Page

Implementation

Bid Request Object

AppNexus supports the following fields in the top-level bid request object:

Field

Type

Description

id

string

(Required) The unique identifier of the bid request.

imp

array of objects

(Required) The impressions offered in this bid request. See Impression Object below.
siteobjectSpecifies information about the website or subset of inventory (placement group) for the impressions. Applicable for website impressions. See Site Object below.
appobjectSpecifies information about the app for the impressions. Applicable for app impressions. See App Object below.
deviceobjectSpecifies information about the user's device to which these impressions will be delivered. See Device Object below.
userobjectSpecifies information about the person to whom the impressions will be delivered. See User Object below.
testinteger

Indicates that this auction is in test mode and is not billable. If not present, default is used.

  • 0: live mode; billable (default)
  • 1: test mode; not billable
atinteger

Specifies the auction type. If not present, default is used.

  • 1: first price
  • 2: second price plus one cent (default)
  • 546: AppNexus controls the auction logic
wseatarray of stringsSpecifies an array representing a whitelist of buyer seats allowed to bid on this impression.
tmaxintegerSpecifies the maximum time (in milliseconds) to submit a bid before timing out.
curarray of stringsSpecifies an array of allowed currencies for bids on this bid request using ISO-4217 alphabetic codes. Defaults to USD.
bcatarray of strings

Specifies a list of blocked content categories. Can include both IAB categories (listed in section 5.1 of the specification) and AppNexus categories. AppNexus categories are in this format APN-ID where ID is the AppNexus category ID; for example, APN-13. For more information about AppNexus categories, see the Category Service.

Note: This field does not reflect blocked categories for a deal.

badv

array of strings

Specifies a list of blocked top-level advertiser domains that correspond to brand URLs in the AppNexus system. For example, ["company1.com","company2.com"]. For more information, see  the Brand Service. A max of 64 values will be sent.

regsobjectSpecifies information about an industry, legal, or governmental regulation in force for this request. See Regs Object below.
source
objectProvides data about the inventory source and which entity makes the final decision. See Source Object below.

ext

object

Used for identifying AppNexus-specific extensions to the OpenRTB bid request. See Bid Request Extension Object below.

Bid Request Extension Object

AppNexus supports a single object in the ext object to support AppNexus-specific extensions:

Field

Type

Description

appnexus

object

Specifies the AppNexus-specific extensions to the OpenRTB bid request.

Bid Request AppNexus Object

AppNexus supports the following fields in the appnexus extension object for the bid request object:

Field

Type

Description

seller_member_idintegerSpecifies the ID of the member selling the inventory. See Platform Member Service to find the corresponding member names.
spend_protectionBoolean

Indicates whether the impression in this bid request is eligible for AppNexus Spend Protection. If the request is not for AppNexus Spend Protection inventory, this field will not be present in the bid request. For more details, see AppNexus Spend Protection.

  • true: Impression is eligible for Spend Protection
  • false: Impression is not eligible for Spend Protection

Alpha-Beta Notice

This field or feature is part of functionality currently in either Alpha or Beta phase. It is therefore subject to change.

publisher_integration
objectProvides details about the publisher integration into AppNexus.

Publisher Integration Object

AppNexus supports the following fields in the publisher_integration object:

Field

Type

Description

is_header

boolean

  • 0: This is not a header bidding integration.
  • 1: Integration into a wrapper.
bid_shading_high
doubleBid shading value.
bid_shading_medium
doubleBid shading value.
bid_shading_low
doubleBid shading value.

Impression Object

AppNexus supports the following fields in the imp object, which describe the impression being auctioned. A single bid request may contain an array with multiple imp objects.

Field

Type

Description

id

string

(Required) Specifies a unique identifier for this impression within the context of the bid request. Set to the value of auction_id_64. 

banner

object

Required if this impression is offered as a banner ad. See Banner Object below.

videoobject

Required if this impression is offered as a video ad. See Video Object below.

audio

object

Required if this impression is offered as an audio ad. See Audio Object below.

native

object

Required if this impression is offered as a native ad. See Native Object below

instl

integer

Indicates whether the impression is interstitial or full screen.

  • 0: the impression is not interstitial or full screen (default)
  • 1 the impression is interstitial or full screen

tagid

string

Specifies an identifier for the specific ad placement or ad tag that was used to initiate the auction. This is the AppNexus placement ID. Omitted if seller visibility settings prohibit sharing.

secureinteger

Indicates whether the impression requires secure HTTPS URL creative assets and markup. If omitted, the secure state is unknown but non-secure HTTP support can be assumed.

  • 0: the impression is not secure
  • 1 the impression is secure
pmpobjectSpecifies information about a private marketplace deal that is in effect for this impression. See Private Marketplace Object below.

ext

object

Used for identifying AppNexus-specific extensions to OpenRTB for the impression object. See Impression Extension Object below.

Banner Object

For banner impressions, AppNexus supports the following fields:

Field

Type

Description

w

integer

(Recommended) Specifies the exact width of the banner in pixels.

h

integer

(Recommended) Specifies the exact height of the banner in pixels.

id

string

Specifies a unique identifier for the banner object. Useful for tracking multiple banner objects (such as with a companion banner array). Typically, the first banner in the array is 1 and subsequent objects increment from there. Currently hardcoded to 1.

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.

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.

posinteger

Specifies the position of the banner on the screen.

  • 0: Unknown (default)
  • 1: Above the fold
  • 3: Below the fold
apiarray of integersSpecifies the supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported. Refer to section 5.6 of the IAB specification for a list of API frameworks.
format
array of objectsReplaced sizes as of February 21, 2017. The format objects that represent the banner sizes permitted. See Format Object below.
extobjectUsed for identifying AppNexus-specific extensions to OpenRTB for the banner object. See Banner Extension Object below.

Banner Extension Object

AppNexus supports a single object in the ext object to support AppNexus-specific extensions to the banner object:

Field

Type

Description

appnexus

object

Specifies the AppNexus-specific extensions to the banner object.

Banner AppNexus Object

AppNexus supports the following field in the appnexus extension object of the banner object:

Field

Type

Description

sizesobject

 Field has been deprecated. Array of format objects representing the banner sizes permitted. If none are specified, using the banner h and w attributes is highly recommended. See Sizes Object below.

Sizes Object

AppNexus supports the following field in the appnexus extension object of the banner object:

Field

Type

Description

 winteger

 Specifies the width of the creative, in pixels.

 hinteger

 Specifies the height of the creative, in pixels.

Format Object

AppNexus supports the following field in the format object of the banner object:

Field

Type

Description

 winteger

 Specifies the width of the creative, in pixels.

 hinteger

 Specifies the height of the creative, in pixels.

Video Object

For video impressions, AppNexus supports the following fields:

Field

Type

Description

mimes

array of strings

(Required) Specifies the video content MIME types supported; for example, video/x-ms-wmv and video/x-flv.

minduration

integer

(Recommended) Specifies the minimum video ad duration, in seconds.

maxduration

integer

(Recommended) Specifies the maximum video ad duration, in seconds.

w

integer

(Recommended) Specifies the width of the video player, in pixels.

h

integer

(Recommended) Specifies the height of the video player, in pixels.

startdelay

integer

(Recommended) Specifies the start delay of the video ad:

  • > 0: For values greater than zero, the delay before video start, in seconds.
  • 0: Pre-roll
  • -1: Generic mid-roll
  • -2: Generic post-roll

battr

array of integers

Specifies the video creative attributes to block. Refer to section 5.3 of the IAB specification for a list of attributes.

minbitrate
integerThe minimum bit rate, in kilobytes per second.
maxbitrate
integerThe maximum bit rate, in kilobytes per second.
playbackmethodarray of integers

Specifies the allowed playback methods. If not specified, all are assumed to be allowed. Currently supported values are:

  • 1: Autoplay, sound on
  • 2: Autoplay, sound off
  • 3: Click to play
  • 4: Mouse over to play
apiarray of integers

Specifies the supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported. Currently supported values are:

  • 1: VPAID 1.0
  • 2: VPAID 2.0
  • 3: MRAID-1
  • 4: ORMMA
  • 5: MRAID-2
protocols
array of integers

Array of supported video protocols. Currently supported values are:

  • 1: VAST 1.0
  • 2: VAST 2.0
  • 3: VAST 3.0
  • 4: VAST 1.0 Wrapper
  • 5: VAST 2.0 Wrapper
  • 6: VAST 3.0 Wrapper
  • 7: VAST 4.0
  • 8: DAAST 1.0

ext

object

Used for identifying AppNexus-specific extensions to OpenRTB for the video object. See Video Extension Object below.

Video Extension Object

AppNexus supports a single object in the ext object to support AppNexus-specific extensions to the video object:

Field

Type

Description

appnexus

object

Specifies the AppNexus-specific extensions to the video object.

Video AppNexus Object

AppNexus supports the following fields in the appnexus extension object of the video object:

Field

Type

Description

contextinteger

   Specifies the video context:

  • 0: Unknown
  • 1: Pre-roll
  • 2:  Mid-roll
  • 3:  Post-roll
  • 4: Outstream
  • 5: BannerStream
predicted_video_completion_ratedoubleSpecifies the probability that the video impression will be viewed completely by a user, based on historical data.

Audio Object

Field

Type

Description

mimes

array of strings

(Required) Specifies the audio content MIME types supported; for example, audio/vnd.wav, audio/mpeg, audio/mp4, audio/ogg, or audio/mp2.

minduration

integer

(Recommended) Specifies the minimum audio ad duration, in seconds.

maxduration

integer

(Recommended) Specifies the maximum audio ad duration, in seconds.

startdelay

integer

(Recommended) Specifies the start delay of the audio ad:

  • > 0: For values greater than zero, the delay before audio start, in seconds.
  • 0: Pre-roll
  • -1: Generic mid-roll (delay unknown)
  • -2: Generic post-roll

battr

array of integers

Specifies the audio creative attributes to block. AppNexus supports:

  • 11: Surveys
  • 16: Ad Provides Skip Button
minbitrateintegerThe minimum bit rate, in kilobytes per second.
maxbitrateintegerThe maximum bit rate, in kilobytes per second.
apiarray of integers

Specifies the supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported. Currently supported values are:

  • 1: VPAID 1.0
  • 2: VPAID 2.0
  • 3: MRAID-1
  • 4: ORMMA
  • 5: MRAID-2

Native Object

For native impressions, AppNexus supports the following field, which contains the creative markup:

 Field

Type

Description

request

string

The rendered creative markup to be delivered; native creatives can be returned in this field as a JSON-encoded string. The first value in the string must be native. See Request Object below and Example Bid Requests for examples of native bid requests.

Note: As of February 9th, we will be updating our native bid requests to send native 1.1. Please look at the updated Example Bid Request for Native 1.1 for an example of this.

Request Object

For native impressions, the request object contains the creative object in the following fields:

Field

Type

Description

ver

string

(Recommended) Specifies the version of the native ad specification currently in use.

 

layout

integer

Specifies the layout of the native ad unit. Currently hardcoded to 3 (news feed).

Note: This is a Native 1.0 field. We will not send this field in a 1.1 request. This field will be deprecated.

adunit

integer

Specifies the ad unit ID of the native ad unit. Currently hardcoded to 2 (recommendation widget).

Note: This is a Native 1.0 field. We will not send this field in a 1.1 request. This field will be deprecated.

plcmtcnt

integer

Specifies the number of identical placements available on the bid request. Usually 1, but can be a different integer if the bid request is for a feed with multiple placements within it.

plcmttype
integer

The design/format/layout of the ad unit being offered. AppNexus will send either value:

  • 1: In the feed of content
  • 4: Recommendation widget
privacy
boolean

Flag to indicate if the seller supports a buyer-specific privacy notice.

  • 0 or absent: The native ad doesn't support custom privacy links
  • 1: The native ad supports buyer-specific privacy notice

assets

array of objects

Specifies a list of assets that are expected to be returned on the bid response. See Assets Object below.

Assets Object

AppNexus supports the following fields in the assets object in the native object:

Field

Type

Description

id

integer

Specifies a unique identifier for the asset in this bid request. Typically, the first asset in the array is 1 and subsequent assets increment from there.
requiredinteger

Specifies if the asset is required:

  • 0: Asset is optional
  • 1: Asset is required
titleobjectSpecifies information about the title of the asset. See Title Object below.
imgobjectSpecifies information about the image for the asset. See Image Object below.
dataobjectSpecifies information about data for the asset. See Assets Data Object below.

Title Object

AppNexus supports the following fields in the title object in the assets object:

Field

Type

Description

len

integer

Maximum length of the text in the title.

Image Object

AppNexus supports the following fields in the img object of the assets object:

Field

Type

Description

type

integer

Specifies the type ID of the image element requested by the publisher. Supported values are:

  • 1: Icon image for use on smaller screen sizes (icon_img_url)
  • 3: Large image preview fo the ad for use on larger screen sizes (main_media)
w

integer

Specifies the exact width of the image, in pixels.

wminintegerSpecifies the minimum requested width of the image, in pixels. If included, this value should be used for any rescaling of images by the client. If w or wmin are both included, use w as the exact width.

h

integer

Specifies the height of the image, in pixels.

hmininteger

Specifies the minimum requested height of the image, in pixels. If included, this value should be used for any rescaling of images by the client. If both h and hmin are included, use h as the exact height.

mimesarray of stringsSpecifies the image content MIME types supported. Should be empty, as all image types are supported.

Assets Data Object

AppNexus supports the following fields in the data object of the assets object:

Field

Type

Description

type

integer

Specifies the type ID of the element supported by the publisher. The publisher can display this information in an appropriate format. Supported values are:

  • 1: sponsored - "Sponsored By" message, where the the response contains the brand name of the sponsor
  • 2: desc - Descriptive text associated with the product or service being advertised
  • 3: rating - Rating of the product being offered to the user. For example, an app's rating in an app store from 0–5.
  • 12: ctatext - Descriptive text for a "call to action" button for the destination URL

len

integer

Maximum length of the text in the element's response.

Private Marketplace Object

AppNexus supports the following fields in the pmp object of the imp object to support private marketplaces (deals) between buyers and sellers that may apply to this impression:

Field

Type

Description

private_auction

integer

Indicates the auction eligibility for seats named in the deals object.

  • 0: All bids are accepted
  • 1: Only bids for specified deals are accepted

deals

array of objectsSpecifies information about the deals for this bid. See Deal Object below.

Deal Object

AppNexus supports the following fields in the deal object of the pmp object:

Field

Type

Description

id

string

(Required) Specifies a unique identifier for the deal.

bidfloor

floatSpecifies the minimum bid price for the deal, in CPM using the default currency (USD). If omitted, default is 0.00.
atinteger

Optional override of the overall auction type of the bid request. If omitted, default is 2.

  • 1: First price
  • 2: Second price plus one cent (default)
  • 3: Bid floor is the agreed upon deal price (fixed price)
wseatarray of stringsSpecifies a list of buyer seat IDs that are allowed to bid on this deal.

ext

object

Used for identifying AppNexus-specific extensions to OpenRTB for the deal object. See Deal Extension Object below.

Deal Extension Object

AppNexus supports a single object in the ext object to support AppNexus-specific extensions to the deal object:

Field

Type

Description

appnexus

object

Specifies the AppNexus-specific extensions to the deal object.

Deal AppNexus Object

AppNexus supports the following fields in the appnexus extension object of the deal object:

Field

Type

Description

ad_quality_override

integer

Specifies how the deal handles creatives:
  • 1: Creatives use existing ad quality settings. (default)
  • 2: Creatives in "pending" audit status will serve. Once these creatives are audited, the existing ad quality settings are used.
  • 3: No ad profile restrictions will be applied to this deal. (Maximum trust)
allowed_media_typesarray of integersSpecifies the IDs of the media types that are allowed on this deal. (See Expandables and Rich Media for a list of media types.) If there are no unique media types for this deal as compared to the main bid request object, this field will be an empty array. This does NOT mean the deal does not allow any media types, instead it just means that the media types on the main bid object (anything not specifically listed in the “battr” object) can be used when bidding on this deal. If this array is populated, it will contain a complete list of media types allowed on this deal.
allowed_media_subtypesarray of integersSpecifies the IDs of the media subtypes that are allowed on this deal. (See Expandables and Rich Media for a list of media subtypes.) If there are no unique media subtypes for this deal as compared to the main bid request object, this field will be an empty array. This does NOT mean the deal does not allow any media subtypes, instead it just means that the media subtypes on the main bid object (anything not specifically listed in the “battr” object) can be used when bidding on this deal. If this array is populated, it will contain a complete list of submedia types allowed on this deal.
sizesarray of objectsSpecifies the allowable creative sizes for this deal. If there are no unique sizes for this deal as compared to the main bid request object, this field will be an empty array. This does NOT mean the deal does not allow any sizes, instead it just means that the sizes on the main bid object should be used when bidding on this deal. See Sizes Object below. If this array is populated, it will contain a complete list of sizes allowed on this deal.

Sizes Object

AppNexus supports the following fields in the sizes object of the deal ext object.

Field

Type

Description

w

integer

Specifies the width of the creative allowed for this deal, in pixels.

h

integer

Specifies the height of the creative allowed for this deal, in pixels.

Impression Extension Object

AppNexus supports a single object in the ext object to support AppNexus-specific extensions to the imp object:

Field

Type

Description

appnexus

object

Specifies the AppNexus-specific extensions to the impression object.

Impression AppNexus Object

AppNexus supports the following fields in the appnexus extension object of the imp object:

Field

Type

Description

estimated_clear_pricedoubleSpecifies the estimated clear price needed to win the impression.

predicted_view_rate

double

Specifies the probability that the impression will be viewable by the user, based on historical data.
member_ad_profile_idintegerSpecifies the seller's ad profile ID.
allowed_payment_types
array of objects

Specifies the allowable payments types for this impression. If this field is not present, then the only allowed payment type is 'impression'.

Note: This object is not enabled for all clients. Please reach out to your account representative for this feature.

Allowed Payment Types Object

AppNexus supports the following fields in the allowed_payment_types object:

Note: This object is not enabled for all clients. Please reach out to your account representative for this feature. 

Field

Type

Description

payment_type

integer

Specifies the payment type allowed for this impression. Currently supported values:

  • 1: Impression (Default)
  • 2: Viewable Impression
conversion_rate
doubleSpecifies the the rate that AppNexus will use to convert a non-impression bid to an eCPM price for bid ranking in the auction. A Bidder may use this for internal bid ranking, budgeting/pacing, or potentially for others.

Site Object

Sites (also known as placement groups) are a subset of inventory for a publisher. AppNexus supports the following fields in the site object:

Field

Type

Description

id

string

Recommended. Specifies the AppNexus site ID. Omitted if seller visibility prohibits sharing. Bidders cannot lookup what site the ID corresponds to, but these IDs can be used as anonymous, optimizable chunks of inventory.

domain

string

Specifies the domain of the site (for example, publishersite.com). Omitted if seller visibility prohibits sharing.

cat

array of strings

Specifies a list of content categories. Can include both IAB categories (listed in section 5.1 of the specification) and AppNexus categories. AppNexus categories are in this format APN-ID where ID is the AppNexus category ID; for example, APN-13. For more information about AppNexus categories, see the Category Service. Omitted if seller visibility settings prohibit sharing.

pagestringSpecifies the full URL of the page where the impression will be shown (for example, page.publishersite.com/path/to/page). Omitted if seller visibility settings prohibit sharing. Will contain the domain instead of the full URL if only domain is exposed in the visibility profile.

publisher

object

Specifies information about the publisher. Omitted if seller visibility settings prohibit sharing. See Publisher Object below.

App Object

AppNexus supports the following fields in the app object:

Field

Type

Description

id

string

Specifies the AppNexus site ID. Omitted if seller visibility prohibits sharing. Bidders cannot lookup what site the ID corresponds to, but these IDs can be used as anonymous, optimizable chunks of inventory.

bundle

string

Specifies the application bundle or package name (e.g., com.foo.mygame). This is intended to be a unique ID across multiple exchanges. Omitted if seller visibility prohibits sharing.

cat

array of strings

Specifies a list of content categories. Can include both IAB categories (listed in section 5.1 of the specification) and AppNexus categories. AppNexus categories are in this format APN-ID where ID is the AppNexus category ID; for example, APN-13. For more information about AppNexus categories, see the Category Service. Omitted if seller visibility settings prohibit sharing.

publisher

object

Specifies information about the publisher. Omitted if seller visibility settings prohibit sharing. See Publisher Object below.

name
stringThe full name of the app (i.e. Angry Birds). (This value may be aliased at the publisher's request.)

Publisher Object

AppNexus supports the following field in the publisher object:

Field

Type

Description

id

string

Specifies the AppNexus publisher ID. Omitted if seller visibility settings prohibit sharing.

Device Object

AppNexus supports the following fields in the device object. Note that the device IDs in this object should override any device IDs in the Bid Request Extension Object.

Field

Type

Description

ua

string

(Recommended) Specifies 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".

geo

object

Specifies the location of the device, as derived from the device's location services (such as cell tower triangulation or GPS) or IP address. Also includes the timezone and a code for the designated market area. Note that geo overrides IP. See Geo Object for details.

dnt

integer

Specifies the Do Not Track setting:

  • 0: Do Not Track is set to false in browser (tracking is allowed)
  • 1: Do Not Track is set to true in browser (user has opted out of tracking)

ip

string

Specifies the IPv4 address closest to the device. Omitted if seller visibility settings prohibit sharing.

ipv6
string

IP address closest to device as IPv6

Note: This field has not been released yet. It will be released July 2017.

devicetype

integer

Specifies the type of device, using IAB values:

  • 1: Mobile/Tablet

  • 2: Personal Computer

  • 3: Connected TV

  • 4: Phone

  • 5: Tablet

  • 6: Connected Device

  • 7: Set Top Box

make

string

Specifies the make of the device. You can use the Device Make Service to view the makes registered in the AppNexus system by making a GET call to https://api.adnxs.com/device-make.

model

string

Specifies the model of the device. You can use the Device Model Service to view the models registered in the AppNexus system by making a GET call to https://api.adnxs.com/device-model.

os

string

Specifies operating system of the device. If passed, this overrides the operating system in the ua field. You can use the Operating System Service to view the operating systems registered in the AppNexus system by making a GET call to https://api.adnxs.com/operating-system.

language

string

Specifies the browser language; use ISO 639-1 or ISO 3166 alpha-2 codes.

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.

carrier

string

Specifies carrier for the device. You can use the Carrier Service to view the carriers registered in the AppNexus system by making a GET call to https://api.adnxs.com/carrier.

connectiontype

integer

Specifies the detected data connection type for the device using IAB values:

  • 0: Unknown
  • 1: Ethernet
  • 2: Wifi

  • 3: Cellular Network – Unknown Generation

  • 4: Cellular Network – 2G

  • 5: Cellular Network – 3G

  • 6: Cellular Network – 4G

ifastringSpecifies the ID sanctioned for advertiser use in the clear. Set to iOS idfa, Android aaid, or Windows adid if available. Omitted if seller visibility settings prohibit sharing.

dpidsha1

string

Specifies the SHA1-encrypted, platform-specific (e.g., ANDROID_ID or UDID for iOS) unique identifier for the mobile device. Omitted if seller visibility settings prohibit sharing.

dpidmd5

string

Specifies the MD5-encrypted, platform-specific (e.g., ANDROID_ID or UDID for iOS) unique identifier for the mobile device.Omitted if seller visibility settings prohibit sharing.

Geo Object

AppNexus supports the following fields in the geo object:

Field

Type

Description

lat

float

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

lon

float

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

country

string

Specifies the country name, according to ISO-3166-1 Alpha-3.

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

city

string

Specifies the city name. Omitted if seller visibility settings prohibit sharing.

zip

string

Specifies the ZIP or postal code where the device is located. Omitted if seller visibility settings prohibit sharing.

metro
stringContains a code for the user's designated market area based on their IP address (if the IP adddress can be determined).
utcoffset
intIndicates the local time as an offset from UTC.
ext
objectUsed for identifying AppNexus-specific extensions to OpenRTB for the geo object. See Geo Extension Object below.

Geo Extension Object

AppNexus supports a single object in the ext object to support AppNexus-specific extensions to the geo object:

Field

Type

Description

appnexus

object

Specifies the AppNexus-specific extensions to the geo object. See Geo AppNexus Object below for a list of the extensions for this object.

Geo AppNexus Object

AppNexus supports the following field in the appnexus extension object of the geo object:

Field

Type

Description

timezonestring

Contains the timezone of the user based on IP address (if the IP address can be determined).

User Object

AppNexus supports the following fields in the user object:

Field

Type

Description

id

string

(Either id or buyeruid is recommended) Specifies the AppNexus unique ID for this user. Omitted if seller visibility settings prohibit sharing. The unique 64-bit ID for the user. It will be the same for all requests from this user until cookies are cleared. This field is 0 when AppNexus does not have a match for this user or the user's browser doesn't accept cookies. It will be -1 for opt-out users.

buyeruidstring(Either id or buyeruid is recommended) The buyer's unique ID for this user, if known. Omitted if seller visibility settings prohibit sharing.

yob

integer

Specifies the year of birth as a 4-digit integer. Omitted if unknown, or if seller visibility settings prohibit sharing.

gender

string

Specifies the gender. Set to null if unknown. Omitted if unknown, or seller visibility settings prohibit sharing.

  • M: male
  • F: female
  • O: other
dataarray of objectsSpecifies information about data for the user. See User Data Object below.
ext
objectUsed for identifying AppNexus-specific extensions to OpenRTB for the user object.

User Data Object

AppNexus supports the following fields in the data object of the user object:

Field

Type

Description

id

string

Specifies the ID of the data provider.

segment

array of objectsSpecifies information about the segments for this user. See Segment Object below.

User Extension Object

AppNexus supports a single object in the ext object to support AppNexus-specific extensions to the user object:

Field

Type

Description

appnexus

object

Specifies the AppNexus-specific extensions to the user object. See below for a list of the extensions for this object.

User AppNexus Object

AppNexus supports the following field in the appnexus extension object of the user object:

Field

Type

Description

userdata_json

string

The userdata attached to the user's cookie stored by the bidder receiving the request.

Segment Object

AppNexus supports the following fields in the segment object of the user data object:

Field

Type

Description

id

string

Specifies the AppNexus segment ID.

value

stringSpecifies the value of the data segment.

Regs Object

AppNexus supports the following fields in the regs object:

Field

Type

Description

coppa

integer

Indicates if this request is subject to the United States Children's Online Privacy Protection Act (COPPA).

  • 0: Not subject to COPPA. Treat as a normal auction.
  • 1: Subject to COPPA. Limit what is allowed for targeting and logging as required.

Source Object

AppNexus supports the following fields in the source object:

Field

Type

Description

fd

integer

Entity responsible for the final impression sale decision, where:

  • 0: exchange (default)
  • 1: upstream source
tid
stringTransaction ID that must be common across all participants in this bid request. Value will be passed in from the seller. If seller does not provide a transaction ID, AppNexus will create one and share it.

Example Bid Requests

Banner/Video Bid Request

Native Bid Request 1 - Native 1.1 Bid Request

Native Bid Request 2 - Native 1.0 Bid Request (NOT SUPPORTED)

  • No labels