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

Document demand chain objects #2737

Merged
merged 3 commits into from
Mar 11, 2021
Merged

Document demand chain objects #2737

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
393403b
Update bidder-adaptor.md
patmmccann Mar 4, 2021
5d6c3c2
Update bidder-adaptor.md
patmmccann Mar 4, 2021
4408ba5
wordsmithing
bretg Mar 8, 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
20 changes: 11 additions & 9 deletions dev-docs/bidder-adaptor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,18 +362,19 @@ The `interpretResponse` function will be called when the browser has received th
ad: CREATIVE_BODY,
dealId: DEAL_ID,
meta: {
networkId: NETWORK_ID,
networkName: NETWORK_NAME
agencyId: AGENCY_ID,
agencyName: AGENCY_NAME,
advertiserDomains: [ARRAY_OF_ADVERTISER_DOMAINS],
advertiserId: ADVERTISER_ID,
advertiserName: ADVERTISER_NAME,
advertiserDomains: [ARRAY_OF_ADVERTISER_DOMAINS]
agencyId: AGENCY_ID,
agencyName: AGENCY_NAME,
brandId: BRAND_ID,
brandName: BRAND_NAME,
dchain: DEMAND_CHAIN_OBJECT,
mediaType: MEDIA_TYPE,
networkId: NETWORK_ID,
networkName: NETWORK_NAME,
primaryCatId: IAB_CATEGORY,
secondaryCatIds: [ARRAY_OF_IAB_CATEGORIES],
mediaType: MEDIA_TYPE
secondaryCatIds: [ARRAY_OF_IAB_CATEGORIES]
}
};
bidResponses.push(bidResponse);
Expand All @@ -383,8 +384,8 @@ The `interpretResponse` function will be called when the browser has received th

{: .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.
data for tracking down bad creatives and ad blocking. The advertiserDomains field and the Demand Chain Object are
particularly useful. Publishers may have analytics or security vendors with the capability to parse and validate complicated demand chain objects. The meta.advertiserDomains field is proposed as required in 5.0; other fields may become required in a future release.

The parameters of the `bidResponse` object are:

Expand Down Expand Up @@ -414,6 +415,7 @@ The parameters of the `bidResponse` object are:
| `meta.advertiserDomains` | Optional | Array of Advertiser Domains for the landing page(s). This is an array to align with the OpenRTB 'adomain' field. | `["advertisera.com"]` |
| `meta.brandId` | Optional | Bidder-specific Brand ID (some advertisers may have many brands) | 4444 |
| `meta.brandName` | Optional | Brand Name | `"BrandB"` |
| `meta.dchain` | Optional | Demand Chain Object | `{ 'ver': '1.0', 'complete': 0, 'nodes': [ { 'asi': 'magnite.com', 'bsid': '123456789', } ] }` |
| `meta.primaryCatId` | Optional | Primary [IAB category ID](https://www.iab.com/guidelines/iab-quality-assurance-guidelines-qag-taxonomy/) | `"IAB-111"` |
| `meta.secondaryCatIds` | Optional | Array of secondary IAB category IDs | `["IAB-222","IAB-333"]` |
| `meta.mediaType` | Optional | "banner", "native", or "video" - this should be set in scenarios where a bidder responds to a "banner" mediaType with a creative that's actually a video (e.g. outstream) or native. | `"native"` |
Expand Down