Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add onSetTargeting handler to bid adapters spec #1008

Merged
merged 3 commits into from
Nov 14, 2018
Merged

Add onSetTargeting handler to bid adapters spec #1008

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d15a0f2
Add documentation for the onBidWon spec handler
Spark-NF Jun 28, 2018
ba1c8dd
Add documentation for the onSetTargeting spec handler
Spark-NF Jun 28, 2018
7d36b36
Merge remote-tracking branch 'upstream/master' into onSetTargeting
jsfaure Oct 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 37 additions & 1 deletion dev-docs/bidder-adaptor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,8 @@ export const spec = {
interpretResponse: function(serverResponse, request) {},
getUserSyncs: function(syncOptions, serverResponses) {},
onTimeout: function(timeoutData) {},
onBidWon: function(bid) {}
onBidWon: function(bid) {},
onSetTargeting: function(bid) {}
}
registerBidder(spec);

Expand Down Expand Up @@ -408,6 +409,33 @@ Sample data received by this function:
}
{% endhighlight %}

### Registering on Set Targeting

The `onSetTargeting` function will be called when the adserver targeting has been set for a bid from the adapter.

Sample data received by this function:

{% highlight js %}
{
"bidder": "example",
"width": 300,
"height": 250,
"adId": "330a22bdea4cac",
"mediaType": "banner",
"cpm": 0.28,
"ad": "...",
"requestId": "418b37f85e772c",
"adUnitCode": "div-gpt-ad-1460505748561-0",
"size": "350x250",
"adserverTargeting": {
"hb_bidder": "example",
"hb_adid": "330a22bdea4cac",
"hb_pb": "0.20",
"hb_size": "350x250"
}
}
{% endhighlight %}

## Supporting Video

Follow the steps in this section to ensure that your adapter properly supports video.
Expand Down Expand Up @@ -679,6 +707,14 @@ export const spec = {
onBidWon: function(bid) {
// Bidder specific code
}

/**
* Register bidder specific code, which will execute when the adserver targeting has been set for a bid from this bidder
* @param {Bid} The bid of which the targeting has been set
*/
onSetTargeting: function(bid) {
// Bidder specific code
}
}
registerBidder(spec);

Expand Down