Bid Object

Field

Type

Details

id

string

A bidder generated ID for the bid object, used for tracking and debugging purposes, for example 3.

impid

string

The ID of the impression object (imp) from the bid request to which this bid response applies, for example "1"

price

float

The bid price as a float value, expressed as CPM. All prices assumed to be in USD if the cur parameter is omitted, for example 1.23

protocol*

integer

The Video response protocol of the markup if applicable, see the Video Response Protocols table for the valid values.

Note: This field is required in video responses.

adm*

string

Creative markup for banner ads.

  • This field is required for banner ads, and is ignored for video or native bid responses.

  • No more than one win price macro can be used in the adm field, otherwise The MediaGrid records multiple impression events.

  • When using an <iframe> to include markup and/or pixel trackers, you should close the </iframe> properly as not doing so may result in discrepancies on some browsers.

burl

string

(Required) Specifies the billing notice URL called by Commerce Grid using a server-to-server call when Commerce Grid records a billable impression.

  • This field should contain the win price macro, and there can only be one win price macro, see the Macros section.

  • The MediaGrid expects that burl calls should return a HTTP status 200, 204, or 30x, see the Server-to-Server (s2s) Calls section for more information.

  • You can respond with a non-secure burl for secure bid requests:

"burl":"http://dsp.com/winnotice?impid=102&winprice=${AUCTION_PRICE}"

nurl

string

(Optional) The win notice URL called if the bid wins.

  • This field should not be used for submitting creative markup.

  • The URL can contain the win price macro, see the Macros section

  • This URL will be mostly called from the user’s browser and should thus be SSL-compliant for requests with imp.secure set to 1.

http://dsp.com/winnotice?impid=102&winprice=${AUCTION_PRICE}

iurl*

string

Sample image URL (without cache busting) for content checking, e.g. "http://adserver.com/preview?impid=102"

language*

string

The Alpha-2 ISO 639-1 code for the creative’s language, for example, ja. The nonstandard code "xx" may also be used if the creative has no linguistic content (e.g., a banner with just a company logo).

Use this field instead of the deprecated bid.ext.language field.

adid*

string

ID that references the ad to be served if the bid wins. Either the adid field or crid field should be present in the response, for example "3021"

Notes:

  • It is recommended to have separate IDs for secure and non-secure versions of the same creative, e.g. cr_123 & cr_123_ssl

  • When Commerce Grid passes the creative ID to the publisher it prepends the Buyer ID, using the the following syntax: {DSP_ID}_{Creative_ID}, for example 70_650029457 or 79_0RsSUxZety0O1.

  • When Commerce Grid receives both adid and crid fields, the adid ID field is used to pass the creative ID to publishers

adomain

array of strings

Advertiser’s primary or top-level domain for advertiser checking. This can be a list of domains if there is a rotating creative. Note:

  • The MediaGrid invalids non-ascii domains. If you need to pass a domain that uses unicode character such as in the Cyrillic or Japanese script, use punycode

    e.g. детивнепитики.рф or faß.de

bundle*

string

A platform-specific application identifier intended to be unique to the app and independent of the exchange. On Android, this should be a bundle or package name (e.g., com.foo.mygame)

cid*

string

Campaign ID or similar that is used by the Buyer to track and organize their campaigns, for example, 102

crid*

string

Creative ID to assist with ad quality checking. Either the adid field or crid field should be present in the response, for example “3021”

Notes:

  • It is recommended to have separate IDs for secure and non-secure versions of the same creative, e.g. cr_123 & cr_123_ssl

  • When Commerce Grid passes the creative ID to the publisher it prepends the Buyer ID, using the the following syntax: {DSP_ID}_{Creative_ID}, for example 70_650029457 or 79_0RsSUxZety0O1.

  • When Commerce Grid receives both adid and crid fields, the adid ID field is used to pass the creative ID to publishers

attr*

array of integers

Creative attributes as defined in the OpenRTB protocol, for example, [1,3].

dealid*

string

Reference to the deal.id from the bid request, if this bid pertains to a private marketplace direct deal, for example, "AA-1234"

h*

integer

The height of the creative in pixels when an alternative ad size is used, relevant for banner ads only. 250.

w*

integer

The width of the creative in pixels when an alternative ad size is used, relevant for banner ads only. 300.

cat*

array of strings

The IAB category of the creative.

slotinpod*

integer

Indicates that the bid response is only eligible for a specific position within a video or audio ad pod

mtype*

integer

Type of creative markup. The following values are supported:

  • 1: Banner

  • 2: Video

  • 3: Audio

  • 4: Native

dur*

integer

Duration of the video or audio creative in seconds.

ext*

object

This field may be required under certain circumstances, see Bid Ext Object.