Skip to content

Commit

Permalink
Add supported modules table for GDPR Enforcement module. (#2271)
Browse files Browse the repository at this point in the history
* add supported modules table

* adding GVL ID as a metadata field

* adding GVL ID to bidder doc

* Update gdprEnforcement.md

* Update gdprEnforcement.md

Co-authored-by: bretg <bgorsline@gmail.com>
Co-authored-by: MartianTribe <steve@martiantribe.com>
  • Loading branch information
3 people authored Aug 28, 2020
1 parent f79eec1 commit f7c2b5d
Show file tree
Hide file tree
Showing 28 changed files with 59 additions and 2 deletions.
2 changes: 2 additions & 0 deletions dev-docs/bidder-adaptor.md
Original file line number Diff line number Diff line change
Expand Up @@ -1003,6 +1003,7 @@ registerBidder(spec);
- If you support the GDPR consentManagement module and TCF1, add `gdpr_supported: true`. Default is false.
- If you're on the IAB Global Vendor List, add your ID number in `gvl_id`.
- If you support the GDPR consentManagement module and TCF2, add `tcf2_supported: true`. Default is false.
- If you have an IAB Global Vendor List ID, add `gvl_id: ID`. There's no default.
- If you support the US Privacy consentManagementUsp module, add `usp_supported: true`. Default is false.
- If you support one or more userId modules, add `userId: (list of supported vendors)`. No default value.
- If you support video and/or native mediaTypes add `media_types: video, native`. Note that display is added by default. If you don't support display, add "no-display" as the first entry, e.g. `media_types: no-display, native`. No default value.
Expand Down Expand Up @@ -1033,6 +1034,7 @@ bidder_supports_deals: true/false
pbjs: true/false
pbs: true/false
prebid_member: true/false
gvl_id: none
---
### Note:
Expand Down
2 changes: 1 addition & 1 deletion dev-docs/bidders.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ You can also download the full <a href="/dev-docs/bidder-data.csv" download>CSV
| **SChain Support** | {% if page.schain_supported == true %}yes{% else %}no{% endif %} | **COPPA Support** | {% if page.coppa_supported == true %}yes{% else %}no{% endif %} |
| **Safeframes OK** | {% if page.safeframes_ok == false %}no{% elsif page.safeframes_ok == true %}yes{% else %}check with bidder{% endif %} | **USP/CCPA Support** | {% if page.usp_supported == true %}yes{% else %}no{% endif %} |
| **Supports Deals** | {% if page.bidder_supports_deals == false %}no{% elsif page.bidder_supports_deals == true %}yes{% else %}check with bidder{% endif %} | **Prebid.js Adapter** | yes |
| | | **Prebid Server Adapter** | {% if page.pbs == true %}yes{% else %}no{% endif %} |
| **IAB GVL ID** | {% if page.gvl_id %}{{page.gvl_id}}{% else %}check with bidder{% endif %} | **Prebid Server Adapter** | {% if page.pbs == true %}yes{% else %}no{% endif %} |

<h3>"Send All Bids" Ad Server Keys</h3>

Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/aardvark.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ tcf2_supported: true
usp_supported: true
schain_supported: true
userIds: unifiedId
gvl_id: 52
---

### Bid Params
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/adagio.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ media_types: banner
gdpr_supported: true
schain_supported: true
tcf2_supported: true
gvl_id: 617
---

### Note
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/adform.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ prebid_member: true
pbjs: true
pbs: true
userIds: britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, sharedId, unifiedId
gvl_id: 50
---


Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/adformOpenRTB.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ tcf2_supported: true
prebid_member: true
pbjs: true
userIds: britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, sharedId, unifiedId
gvl_id: 50
---

### Bid params
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/adhese.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ media_types: banner, video
gdpr_supported: true
tcf2_supported: true
userIds: id5Id
gvl_id: 553
---

### Note
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/adtelligent.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ safeframes_ok: true
prebid_member: true
pbjs: true
pbs: true
gvl_id: 410
---

### Bid params
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/aol.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ pbjs: true
biddercode: aol
gdpr_supported: true
usp_supported: true
gvl_id: 25
---

### Note:
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/appnexus.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ usp_supported: true
tcf2_supported: true
pbjs: true
pbs: true
gvl_id: 32
---

### Table of Contents
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/apstream.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ pbjs: true
media_types: banner
gdpr_supported: true
tcf2_supported: true
gvl_id: 394
---

### Bid Params
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/beintoo.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ pbjs: true
pbs: true
biddercode: beintoo
aliasCode : appnexus
gvl_id: 618
---

### Bid Params
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/conversant.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ gdpr_supported: true
userIds: criteo, id5Id, identityLink, liveIntentId, parrableId, pubCommonId, unifiedId
prebid_member: true
tcf2_supported: true
gvl_id: 24
---


Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/criteo.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ gdpr_supported: true
usp_supported: true
prebid_member: true
tcf2_supported: true
gvl_id: 91
---
### Note
{: .alert.alert-warning :}
Expand Down
2 changes: 1 addition & 1 deletion dev-docs/bidders/districtm.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ biddercode: districtm
aliasCode : appnexus
sidebarType: 1
isBidder: true

gvl_id: 144
---

### Bid Params
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/emx_digital.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ biddercode: emx_digital
bidder_supports_deals: false
media_types: banner, video
gdpr_supported: true
gvl_id: 183
---

### Registration
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/fidelity.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ biddercode: fidelity
media_types: banner
gdpr_supported: true
usp_supported: true
gvl_id: 408
---

### Bid Params
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/improvedigital.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ usp_supported: true
media_types: banner, native, video
schain_supported: true
tcf2_supported: true
gvl_id: 253
---

### Bid params
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/indexExchange.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ gdpr_supported: true
usp_supported: true
tcf2_supported: true
media_types: banner, video
gvl_id: 10
---

## Overview
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/medianet.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ userIds: britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrable
prebid_member: true
tcf2_supported: true
pbjs: true
gvl_id: 142
---

### Bid Params
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/openx.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ coppa_supported: true
userIds: britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId
prebid_member: true
tcf2_supported: true
gvl_id: 69
---

### Registration
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/openxoutstream.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ biddercode: openxoutstream
media_types: native
prebid_member: true
coppa_supported: true
gvl_id: 69
---


Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/pubmatic.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ safeframes_ok: true
tcf2_supported: true
pbjs: true
pbs: true
gvl_id: 76
---

### Prebid Server Note:
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/pulsepoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ media_types: banner, video, native
userIds: britepoolId, criteo, id5Id, identityLink, liveIntentId, parrableId, pubCommonId, unifiedId
pbjs: true
pbs: true
gvl_id: 81
---


Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/rubicon.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ safeframes_ok: true
bidder_supports_deals: true
pbjs: true
pbs: true
gvl_id: 52
---

### Registration
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/spotx.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ schain_supported: true
usp_supported: true
safeframes_ok: false
pbjs: true
gvl_id: 165
---

### Bid Params
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/sublime.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ description: Prebid Sublime Bidder Adapter
pbjs: true
biddercode: sublime
gdpr_supported: true
gvl_id: 114
---

### Note
Expand Down
31 changes: 31 additions & 0 deletions dev-docs/modules/gdprEnforcement.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,37 @@ Before allowing an activity tied to a TCF-protected Purpose for a given vendor,

See the [IAB TCF Consent String Format](https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/blob/master/TCFv2/IAB%20Tech%20Lab%20-%20Consent%20string%20and%20vendor%20list%20formats%20v2.md) for details.

## Modules that Support GVL ID

The GDPR Enforcement module requires the GVL ID for a module to be specified. If no GVL ID is found the module will be blocked by default unless it is specifically listed under `vendorExceptions`. The following modules have listed their GVL IDs.

{% assign bidder_pages = site.pages | where: "layout", "bidder" %}

<table class="table table-bordered table-striped">
<thead>
<tr>
<th>Module Type</th>
<th>Module</th>
</tr>
</thead>
<tbody>
{% for page in bidder_pages %}{% unless page.gvl_id %}{% continue %}{% endunless %}
<tr>
<td>Bid Adapter</td>
<td>{{page.title}}</td>
</tr>
{% endfor %}
<tr>
<td>Analytics Adapter</td>
<td>AppNexus</td>
</tr>
<tr>
<td>User ID</td>
<td>ID5</td>
</tr>
</tbody>
</table>

## Build the Package

Follow the basic build instructions in the GitHub Prebid.js repo's main [README](https://github.com/prebid/Prebid.js/blob/master/README.md). Include the base consent management module and this enforcement module as additional options on the **gulp build** command:
Expand Down

0 comments on commit f7c2b5d

Please sign in to comment.