Skip to content

Commit

Permalink
AMP FPD doc updates (#2844)
Browse files Browse the repository at this point in the history
  • Loading branch information
bretg authored Apr 8, 2021
1 parent 898f0dc commit 3ddb211
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 12 deletions.
Binary file modified assets/images/flowcharts/FirstPartyData-Detailed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 11 additions & 10 deletions prebid-server/features/pbs-fpd.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,24 +25,25 @@ Each of the three main sources of Prebid Server traffic will place
First Party Data in the OpenRTB JSON in several places:

{: .table .table-bordered .table-striped }
| OpenRTB Attribute | Description | PBJS Source | SDK Source | AMP Source |
| OpenRTB Attribute | Description | Prebid.js Source | SDK Source | AMP Source |
| --- | --- | --- | --- | --- |
| site.ATTR | Only standard OpenRTB attributes should be here: name, domain, cat, sectioncat, pagecat, page, ref, search, keywords. | config ortb2.site.ATTR | n/a | site.ATTR |
| site.ext.data.ATTR | Any other site-related attributes should go here. | config ortb2.site.ext.data | n/a | site.ext.data.ATTR |
| site.ATTR | Only standard OpenRTB attributes should be here: name, domain, cat, sectioncat, pagecat, page, ref, search, keywords. | config ortb2.site.ATTR | n/a | Stored Request |
| site.ext.data.ATTR | Any other site-related attributes should go here. | config ortb2.site.ext.data | n/a | Stored Request |
| app.ext.data.ATTR | Any app-related attributes should go here. | n/a | Targeting addContextData() | n/a |
| user.ATTR | Only standard OpenRTB attributes should be here: yob, gender, keywords. | config ortb2.user.ATTR | n/a | user.ATTR |
| user.ext.data.ATTR | Any other user-related attributes should go here. | config ortb2.user.ext.data.ATTR | Targeting addUserData() | user.ext.data.ATTR |
| imp[].ext.data.ATTR | AdUnit-specific attributes should go here. | AdUnit.ortb2.ext.data | AdUnit addContextData() | n/a |
| ext.prebid.data.bidders[] | If specified, only these bidders are allowed to see fields in {site/app/user}.ext.data. | n/a | addBidderToAccessControlList() | bidders |
| ext.prebid.bidderconfig | Bidder-specific config | [setBidderConfig()](/dev-docs/publisher-api-reference.html#module_pbjs.setBidderConfig) | n/a | n/a |
| user.ATTR | Only standard OpenRTB attributes should be here: yob, gender, keywords. | config ortb2.user.ATTR | n/a | n/a |
| user.ext.data.ATTR | Any other user-related attributes should go here. | config ortb2.user.ext.data.ATTR | Targeting addUserData() | n/a |
| imp[].ext.data.ATTR | AdUnit-specific attributes should go here. | AdUnit.ortb2.ext.data | AdUnit addContextData() | AMP targeting attribute or Stored Request |
| ext.prebid. data.bidders[] | If specified, only these bidders are allowed to see fields in {site/app/user}.ext.data. | n/a | addBidderTo AccessControlList() | Stored Request |
| ext.prebid. bidderconfig | Bidder-specific config | [setBidderConfig()](/dev-docs/publisher-api-reference.html#module_pbjs.setBidderConfig) | n/a | Stored Request |

This diagram summarizes how first party data flows into the OpenRTB JSON:

![First Party Data Summary](/assets/images/flowcharts/FirstPartyData-Detailed.png){: .pb-lg-img :}

{: .alert.alert-info :}
Note that Prebid.js supports the [`setBidderConfig`](/dev-docs/publisher-api-reference.html#module_pbjs.setBidderConfig) method of defining
bidder-specific first party data, while SDK and AMP only support the `ext.prebid.data.bidders[]` approach.
Note that Prebid.js directly supports the [`setBidderConfig`](/dev-docs/publisher-api-reference.html#module_pbjs.setBidderConfig) method of defining
bidder-specific first party data, while SDK only supports the `ext.prebid.data.bidders[]` approach with an in-app call.
Both SDK and AMP can have the stored request define bidder FPD permissions.

## OpenRTB Examples

Expand Down
4 changes: 2 additions & 2 deletions prebid-server/use-cases/pbs-amp.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,8 @@ Only a few dynamic parameters on the query string are integrated into the result

#### First Party Data Support

Any targeting data passed in through the [`/openrtb2/amp`](/prebid-server/endpoints/openrtb2/pbs-endpoint-amp.html) endpoint is merged
into the OpenRTB JSON and permissions, if defined, are applied to each bidder.
Ad Server targeting data passed in through the [`/openrtb2/amp`](/prebid-server/endpoints/openrtb2/pbs-endpoint-amp.html) endpoint is merged
into the OpenRTB JSON in imp[].ext.data for each bidder if permissions allow.

#### Auction and Response

Expand Down

0 comments on commit 3ddb211

Please sign in to comment.