Skip to content

bidder adapter metadata #1947

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

Merged
merged 1 commit into from
Apr 24, 2020
Merged

bidder adapter metadata #1947

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 42 additions & 0 deletions prebid-server/developers/add-new-bidder.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,48 @@ Bidder implementations are scattered throughout several files.

Bidder implementations may assume that any params have already been validated against the defined json-schema.

### Bid Response Metadata

In addition to the standard OpenRTB2.5 response fields, Prebid encourages bidders to
provide additional metadata in their bid response:

{% highlight js %}
{
"seatbid": [{
"bid": [{
...
"ext": {
"prebid": {
"meta": {
"networkId": NETWORK_ID,
"networkName": NETWORK_NAME
"agencyId": AGENCY_ID,
"agencyName": AGENCY_NAME,
"advertiserId": ADVERTISER_ID,
"advertiserName": ADVERTISER_NAME,
"advertiserDomains": [ARRAY_OF_ADVERTISER_DOMAINS]
"brandId": BRAND_ID,
"brandName": BRAND_NAME,
"primaryCatId": IAB_CATEGORY,
"secondaryCatIds": [ARRAY_OF_IAB_CATEGORIES],
}
}
}
}]
}]
}
{% endhighlight %}

Notes:

- `advertiserDomains` is the same as the OpenRTB 2.5 `bid.adomain` field but replicated here for downstream convenience
- See the [Prebid.js Bidder Adapter](/dev-docs/bidder-adaptor.html) page for details about the requested values for each field.

{: .alert.alert-info :}
Please provide as much information as possible in the meta object. Publishers use this data for tracking down bad creatives and ad blocking. The advertiserDomains field is particularly useful. Some of these fields may become required in a future release.



## Long-Form Video Support
If long-form video will be supported ensure the bidder has the following:

Expand Down