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

Jump to bottom

PBS dev docs and metadata #3002

Merged
merged 2 commits into from
Sep 3, 2021
Merged

PBS dev docs and metadata #3002

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2c6d40
PBS dev docs and metadata
bretg Jun 1, 2021
2b440ec
proper dchain syntax
bretg Jun 7, 2021
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
10 changes: 4 additions & 6 deletions prebid-server/developers/add-new-bidder-go.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

<p></p>

Expand Down Expand Up @@ -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: json.RawMessage(`{Some Demand Chain JSON}`),
BrandID: 4,
BrandName: "Some Brand Name",
PrimaryCategoryID: "IAB-1",
Expand Down
7 changes: 3 additions & 4 deletions prebid-server/developers/add-new-bidder-java.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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 |
Expand All @@ -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. |

<p></p>

Expand Down