Response Bid Object¶
Note
(*) Fields marked with an asterisk are optional.
While individually neither of the following fields is required, one of them must be in the response:
adm,adm_native.
Value |
Type |
Description |
|---|---|---|
id |
string |
A bidder generated ID for the bid object, used for tracking and debugging
purposes, for example |
impid |
string |
The ID of the impression object ( |
price |
float |
The bid price as a float value, expressed as CPM. All prices assumed
to be in USD if the |
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 |
Used to pass creative markup for display (banner), video, or audio ads.
One of either
|
adm_native* |
object |
Used for native bid responses, see the Native Response Object
for the data it contains. One of either |
burl |
string |
The Billing notice URL called by the exchange using a server-to-server call when a winning bid becomes billable based on exchange-specific business policy (e.g., typically delivered, viewed, etc.).” This field should contain the win price macro, see the Macros section.
|
iurl* |
string |
Sample image URL (without cache busting) for content checking. REQUIRED when bidding on on banner bid requests.
|
language* |
string |
The Alpha-2 ISO 639-1 code for the creative’s language, for example,
|
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 that
some Suppliers allow only one domain. To those Suppliers BidSwitch only sends the
first domain from the list, for example, |
cat* |
array of strings |
Array of IAB content categories, for example, |
cid* |
string |
Campaign ID or similar that is used by the Buyer to track and
organize their campaigns, for example, |
crid |
string |
Creative ID to assist with ad quality checking, for example |
attr* |
array of integers |
Creative attributes as defined in the OpenRTB protocol, for example,
|
dealid* |
string |
Reference to the |
h* |
integer |
The height of the creative in pixels when an alternative ad size is used,
relevant for banner ads only. |
w* |
integer |
The width of the creative in pixels when an alternative ad size is used,
relevant for banner ads only. |
ext* |
object |
This field can be used to supply information about the creative agency for whom the Buyer is working, see the Bid Ext Object section below for details. |
Bid Ext Object¶
Value |
Type |
Description |
|---|---|---|
advertiser_name* |
string |
The name of the advertiser serving the creative, for example,
|
agency_name* |
string |
The name of the agency representing the advertiser, for example,
|
agency_id* |
string |
ID of the agency representing the advertiser, for example, |
third_party_buyer_token |
string |
This is a Google specific response field, the token is used to identify end third-party buyer information if the exchange as an Open Bidder is an intermediary. This is obtained from the third-party buyer and must be passed to Google unaltered in the bid response. You can read more about it here https://developers.google.com/authorized-buyers/rtb/response-guide |
data* |
array of object |
Returns arbitrary data from the Buyer, each object can take data.name and data.value to describe the data, see the Data Response Object for more details. |
skadn* |
object |
Apple Ad Network Object, this will be used to pass app data from iOS 14 and newer releases. See SkAdNetwork Extension |
SkAdNetwork Extension¶
Value |
Type |
Description |
|---|---|---|
version* |
str |
Version of SKAdNetwork desired. Must be “2.0” or above. From SKAdNetwork v2.2
onwards, this should be used in the |
network* |
str |
Ad network identifier used in signature. Should match one of the items in the
|
campaign* |
str |
Campaign ID compatible with Apple’s spec. As of 2.0, this should be an integer
between 1 and 100, expressed as a string, e.g. |
fidelities* |
array of objects |
Supports multiple fidelity types introduced in SKAdNetwork v2.2, see the SkAdNetwork Fidelities object for details. Note From SKAdNetwork v2.2 onwards, this object wraps some of the other fields in this table into it. As a result, |
itunesitem* |
str |
ID of advertiser’s app in Apple’s app store. Should match the |
nonce* |
str |
An ID unique to each ad response (GUID/UUID) e.g. |
sourceapp* |
str |
ID of publisher’s app in Apple’s app store, this should match the
|
timestamp* |
str |
Unix time in millis string used at the time of signature. From SKAdNetwork v2.2
onwards, this should be used in the |
signature* |
str |
SKAdNetwork signature as specified by Apple e.g. |
SkAdNetwork Fidelities¶
Value |
Type |
Description |
|---|---|---|
version* |
str |
Version of SKAdNetwork desired. Must be “2.0” or above. |
nonce* |
str |
An ID unique to each ad response (GUID/UUID) e.g. |
timestamp* |
str |
Unix time in millis string used at the time of signature |
signature* |
str |
SKAdNetwork signature as specified by Apple e.g. |
{
"ext":{
"advertiser_name":"Coca-Cola",
"agency_name":"CC-advertising",
"data":[
{
"name":"TUV",
"value":"ABC123"
}
],
"skadn":{
"network":"cDkw7geQsH.skadnetwork",
"campaign":"45",
"itunesitem":"880047117",
"sourceapp":"123456789",
"fidelities":[
{
"timestamp":"1594406341",
"signature":"2RmFS7daRzSVZRVZ8RyMyUXg==",
"nonce":"473b1a16-b4ef-43ad-9591-fcf3aefa82a7",
"version":"2.2"
}
]
}
}
}