中文(台灣) 的翻譯尚未完成。
中文(台灣) 更新時間：
API Reference
In-house mediation is not publicly available
In-house bidding with Audience Network is currently in Closed Beta and is not publicly available. We'll provide further updates if this changes.
As an alternative, you can access Audience Network Bidding through one of the mediation platforms we partner with.
This section applies if you are using Bidding Kit Server as a standalone product.
If you are integrating with Bidding KIt 3, this section does not apply.
Auction Endpoint
/bks/auction
Description
Bidding Kit Server accepts auction requests on this endpoint, which sends bid requests to individual bidders, collects responses, runs the auction, sends notification to bidders, merges waterfall entries with bids from all the bidders and responds back with a consolidated list of bidders and waterfall entries sorted according to price
URL Structure
http:///bks/auction
POST Method
Request parameters
Request body sent to the auction endpoint looks similar to this
{
"bidder_data":{
"facebook":{
<request> // request for facebook bidder, optional, set this field when you
want to send bid request to facebook bidder, please see section
below for more details
},
"applovin":{
<request> // request for applovin bidder, optional, set this field when you
want to send bid request to applovin bidder, please see section
below for more details
},
"tapjoy":{
<request> // request for tapjoy bidder, optional, set this field when you
want to send bid request to tapjoy bidder, please see section
below for more details
},
"chartboost":{
<request> // request for chartboost bidder, optional, set this field when
you want to send bid request to chartboost bidder, please see
section below for more details
},
"ironsource":{
<request> // request for ironsource bidder, optional, set this field when
you want to send bid request to ironsource bidder, please see
section below for more details
"vungle":{
<request> // request for vungle bidder, optional, set this field when
you want to send bid request to vungle bidder, please see
section below for more details
}
},
"waterfall_entries": [
{
"name":<string>, // name for the waterfall entry
"cpm":<double> // cpm in cents for this entry
}
]
}| Parameters | Type | Description |
|---|---|---|
|
| Mapping from bidder name to request sent to that bidder. Currently only |
|
| A list of waterfall entries passed in the request. This field is optional if you choose not to pass any waterfall entries in the request. If you do, these waterfall entries will be merged with bids from the bidders and be returned in a sorted list in the response of Bidding Kit Server. |
|
| Name of this waterfall entry. This is an identifier for each waterfall entry, used to distinguish each. This will be returned in the response. |
|
| CPM (in cents) for this waterfall entry. This will be used to sort when waterfall entries are merged with bids from bidders. |
Request for Facebook bidder
{
"id":<string>,
"imp":[
{
"id":<string>,
"banner": {
"w":<int>,
"h":<int>,
},
"native":{
"w":<int>,
"h":<int>,
},
"video":{
"w":<int>，
"h":<int>,
"linearity":<int>,
"ext":{
"videotype":<string>,
},
},
"tagid":<string>,
"instl":<int>,
}
],
"app":{
"publisher" => {
"id":<string>,
},
},
"device":{
"ua":<string>,
"ifa":<string>,
"dnt":<int>,
"lmt":<int>,
},
"regs":{
"coppa":<int>,
},
"user":{
"buyeruid":<string>,
},
"ext":{
"platformid":<string>,
},
"at":<int>,
"tmax":<int>,
"test":<int>,
}| Parameters | Type | Description |
|---|---|---|
|
| Platform's auction identifier, auction ID. Randomly generated token to identify each auction opportunity. This id should be the same for all bidders in the same request. |
|
| List of slots to bid on. |
|
| Platform's identifier for this slot auction, won’t affect the bidding function. |
|
| Pptional field, present only for banner impression opportunities. One of |
|
| Width. |
|
| Height. |
|
| Optional field, present only for native impression opportunities. One of |
|
| Width. |
|
| Height. |
|
| Optional field, present only for video impression opportunities. One of |
|
| Width. |
|
| Height. |
|
| Optional field, instream video opportunity when set to 1. |
|
| Optional field, present if you want to specify the video type. |
|
|
|
|
| Placement ID. |
|
| Interstitial flag. Optional field. |
|
| App details. |
|
| Publisher details. |
|
| Publisher Facebook app ID. |
|
| Device details. |
|
| Device user agent. |
|
| Identifiers for Advertisers, ID sanctioned for advertiser use. |
|
| “do not track”, user’s preference regarding tracking. Optional field. |
|
| “limit ads tracking”, user’s preference to opt-out of having an ID for Advertisers (IDFA/IFA). Optional field. |
|
| Regulations object. |
|
| US FTC regulations for Children's Online Privacy Protection Act. Optional field. |
|
| User details. |
|
| Facebook Audience Network Bidder Token. Mandatory field. |
|
| Mediation partner Platform ID or publisher Facebook app ID. Mandatory field. |
|
| Auction timeout in milliseconds. This is the maximum time allowed to return a bid. If in |
|
|
|
Request for AppLovin bidder
Refer to Applovin’s documentation when you want to get bids from them. Bidding Kit Server won’t check or modify the requests for Applovin bidder, and will send them directly to the bidder.
Request for Tapjoy bidder
Refer to Tapjoy’s documentation when you want to get bids from them. Bidding Kit Server won’t check or modify the requests for Tapjoy bidder, and will send them directly to the bidder.
Request for Chartboost bidder
Refer to Chartboost's documentation when you want to get bids from them, and request the document “Chartboost Programmatic Supply Integration Guide for Facebook Bidding Kit 09172020.pdf” from your SPM.
Bidding Kit Server won’t check or modify the requests for Chartboost bidder, and will send them directly to the bidder.
Request for Ironsource bidder
Refer to Ironsource's documentation when you want to get bids from them, and request the document “BKSironSource-SDK-In-App-Bidding.pdf” from your SPM.
Request for Vungle bidder
Refer to Vungle’s documentation when you want to get bids from them, and request the document “External - Vungle Header Bidding oRTB Specification.pdf” from your SPM.
Response
{
"auction_id":<string>,
"notification_data":<string>,
"bids": [
{
"name":<string>,
"price":<double>,
"cur":<string>,
"is_bidder":<boolean>,
"adunit_id":<string>,
"sdk_rendering_data": {
"bid_payload":<string>
}
"ext": {
"encrypted_cpm":<string>
}
}
]
}| Parameters | Type | Description |
|---|---|---|
|
| Auction ID passed in the request. |
|
| Essential token for display notification. Should be echoed back in display notification API. |
|
| Details of the bids and waterfall entries. Elements in this list will be sorted ascendent by price. |
|
| Name of the bidder or waterfall entries passed in the request. |
|
| Price in US dollars. |
|
| Currency of the bid, currently only US dollars (“USD”). |
|
| Ad unit id needed by bidders to load and show ads. If a bidder doesn’t need this ID, Bidding Kit Server will return an empty string. This field will only present in bids, not in waterfall entries. |
|
| Bid payload for SDK to render the ads. |
|
| Encrypted blob of impression information. Can be used to get aggregated revenue data by publishers. |
Notify Display Endpoint
/bks/notifyDisplay
Description
This endpoint will accept a request when the ad is displayed and send the display notification to bidders.
URL Structure
http:///bks/notifyDisplay
POST Method
Request Parameters
{
{
"auction_id":<string>,
"clearing_price_cents":<double>,
"notification_data":<string>
"name":<string>
}| Parameters | Type | Description |
|---|---|---|
|
| Auction ID passed in the bid request. |
|
| Clearing price in cents. |
|
| Value returned as |
|
| Name of the winner. |
Response
200 OK