From c2c6d40fb673f5e4ecd9a2371cbb6d9bab10972a Mon Sep 17 00:00:00 2001 From: bretg Date: Tue, 1 Jun 2021 16:14:19 -0400 Subject: [PATCH 1/2] PBS dev docs and metadata --- prebid-server/developers/add-new-bidder-go.md | 10 ++++------ prebid-server/developers/add-new-bidder-java.md | 7 +++---- 2 files changed, 7 insertions(+), 10 deletions(-) diff --git a/prebid-server/developers/add-new-bidder-go.md b/prebid-server/developers/add-new-bidder-go.md index 7cfc39e2f7..dbda1d6486 100644 --- a/prebid-server/developers/add-new-bidder-go.md +++ b/prebid-server/developers/add-new-bidder-go.md @@ -619,7 +619,7 @@ Either `.Bids[].BidVideo.PrimaryCategory` or `.Bids[].Bid.Cat` should be provide Prebid has historically struggled with sharing granular bid response data with publishers, analytics, and reporting systems. To address this, we've introduced a standard object model. We encourage adapters to provide as much information as possible in the bid response. {: .alert.alert-danger :} -Bid metadata will be *required* in Prebid.js 5.X+ release, specifically for AdvertiserDomains and MediaType. We recommend making sure your adapter sets these values or Prebid.js may throw out the bid. +Bid metadata will be *required* in Prebid.js 5.X+ release, specifically for bid.ADomain and MediaType. We recommend making sure your adapter sets these values or Prebid.js may throw out the bid. {: .table .table-bordered .table-striped } | Path | Description @@ -630,13 +630,12 @@ Bid metadata will be *required* in Prebid.js 5.X+ release, specifically for Adve | `.AgencyName` | Bidder-specific agency name. | `.AdvertiserID` | Bidder-specific advertiser id. | `.AdvertiserName` | Bidder-specific advertiser name. -| `.AdvertiserDomains` | Advertiser domains for the landing page(s). Should match `.Bids[].Bid.ADomain`. | `.BrandID` | Bidder-specific brand id for advertisers with multiple brands. | `.BrandName` | Bidder-specific brand name. -| `.dchain` | Demand Chain Object. +| `.DChain` | Demand Chain Object. | `.PrimaryCategoryID` | Primary IAB category id. | `.SecondaryCategoryIDs` | Secondary IAB category ids. -| `.MediaType` | Either `banner`, `audio`, `video`, or `native`. Should match `.Bids[].BidType`. +| `.MediaType` | Either `banner`, `audio`, `video`, or `native`. This is used in the scenario where a bidder responds with a mediatype different than the stated type. e.g. native when the impression is for a banner. One use case is to help publishers determine whether the creative should be wrapped in a safeframe.

@@ -673,8 +672,7 @@ func buildMeta(bid *adapters.TypedBid) (json.RawMessage, error) { AgencyName: "Some Agency Name", AdvertiserID: 3, AdvertiserName: "Some Advertiser Name", - AdvertiserDomains: bid.ADomain, - dchain: bid.ext.dchain, + DChain: DEMAND_CHAIN_JSON, BrandID: 4, BrandName: "Some Brand Name", PrimaryCategoryID: "IAB-1", diff --git a/prebid-server/developers/add-new-bidder-java.md b/prebid-server/developers/add-new-bidder-java.md index 692954b274..e4aec3643c 100644 --- a/prebid-server/developers/add-new-bidder-java.md +++ b/prebid-server/developers/add-new-bidder-java.md @@ -563,7 +563,7 @@ Please review the entire [OpenRTB 2.5 Bid Response](https://www.iab.com/wp-conte | `.Bids[].Bid.Price` | Required | Net price CPM of the bid, not gross price. Publishers can correct for gross price bids by setting Bid Adjustments to account for fees. We recommend the most granular price a bidder can provide. | `.Bids[].Bid.W` | Optional | Width of the creative in pixels. | `.Bids[].Bid.H` | Optional | Height of the creative in pixels. -| `.Bids[].Bid.Ext` | Optional | Embedded JSON containing Prebid metadata (see below) or custom information. +| `.Bids[].Bid.Ext.Prebid.Meta` | Optional | Embedded JSON containing Prebid metadata (see below) or custom information. {: .alert.alert-info :} We recommend resolving creative OpenRTB macros in your adapter. Otherwise, AUCTION_PRICE will eventually get resolved by the [Prebid Universal Creative](https://github.com/prebid/prebid-universal-creative), but by then the bid price will be in the ad server currency and quantized by the price granularity. @@ -584,7 +584,7 @@ Either `.Bids[].BidVideo.PrimaryCategory` or `.Bids[].Bid.Cat` should be provide Prebid has historically struggled with sharing granular bid response data with publishers, analytics, and reporting systems. To address this, we've introduced a standard object model. We encourage adapters to provide as much information as possible in the bid response. {: .alert.alert-danger :} -Bid metadata will be *required* in Prebid.js 5.x+ release, specifically for AdvertiserDomains and MediaType. We recommend making sure your adapter sets these values or Prebid.js may throw out the bid. +Bid metadata will be *required* in Prebid.js 5.X+ release, specifically for bid.ADomain and MediaType. We recommend making sure your adapter sets these values or Prebid.js may throw out the bid. {: .table .table-bordered .table-striped } | Path | Description | @@ -595,13 +595,12 @@ Bid metadata will be *required* in Prebid.js 5.x+ release, specifically for Adve | `.AgencyName` | Bidder-specific agency name | | `.AdvertiserID` | Bidder-specific advertiser id | | `.AdvertiserName` | Bidder-specific advertiser name | -| `.AdvertiserDomains` | Advertiser domains for the landing page(s). Should match `.Bids[].Bid.ADomain` | | `.BrandID` | Bidder-specific brand id for advertisers with multiple brands | | `.BrandName` | Bidder-specific brand name | | `.dchain` | Demand Chain Object | `.PrimaryCategoryID` | Primary IAB category id | | `.SecondaryCategoryIDs` | Secondary IAB category ids | -| `.MediaType` | Either `banner`, `audio`, `video`, or `native`. Should match `.Bids[].BidType` | +| `.MediaType` | Either `banner`, `audio`, `video`, or `native`. This is used in the scenario where a bidder responds with a mediatype different than the stated type. e.g. native when the impression is for a banner. One use case is to help publishers determine whether the creative should be wrapped in a safeframe. |

From 2b440ecfd430de0b6be6f5369f3d90d82b26a4ce Mon Sep 17 00:00:00 2001 From: bretg Date: Mon, 7 Jun 2021 17:39:32 -0400 Subject: [PATCH 2/2] proper dchain syntax --- prebid-server/developers/add-new-bidder-go.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/prebid-server/developers/add-new-bidder-go.md b/prebid-server/developers/add-new-bidder-go.md index dbda1d6486..6518e0b03c 100644 --- a/prebid-server/developers/add-new-bidder-go.md +++ b/prebid-server/developers/add-new-bidder-go.md @@ -672,7 +672,7 @@ func buildMeta(bid *adapters.TypedBid) (json.RawMessage, error) { AgencyName: "Some Agency Name", AdvertiserID: 3, AdvertiserName: "Some Advertiser Name", - DChain: DEMAND_CHAIN_JSON, + DChain: json.RawMessage(`{Some Demand Chain JSON}`), BrandID: 4, BrandName: "Some Brand Name", PrimaryCategoryID: "IAB-1",