adding COPPA support docs, feature table (#1367)

prebid · Jun 25, 2019 · afea797 · afea797
1 parent 6272a2c
commit afea797
Show file tree

Hide file tree

Showing 11 changed files with 56 additions and 16 deletions.
diff --git a/_layouts/bidder.html b/_layouts/bidder.html
@@ -29,22 +29,35 @@
 
 		                    <h3>{{ page.title }}</h3>
 
-		                    <h4>Bidder Code</h4>
-
 		                    {% if page.s2s_only == true %}
 								<div class="pb-bidder-s2">
 									<h3>Note:</h3> This is a S2S adapter only.</h3>
 								</div>
 							{% endif %}
 
-		                    <code>{{ page.biddercode }}</code> 
-		                    {% if page.biddercode_longer_than_12 != true %}
-		                        <h4>Send All Bids Ad Server Keys</h4>
-		                        <code>hb_pb_{{ page.biddercode }}</code>
-		                        <code>hb_adid_{{ page.biddercode }}</code>
-		                        <code>hb_size_{{ page.biddercode }}</code> 
-		                    {% endif %} 
-
+<h3>Features</h3>
+
+<table>
+<tr><th class="pbTh">Bidder Code</th><td class="pbTd">{{ page.biddercode }}</td><th class="pbTh">Prebid.org Member</th><td class="pbTd">{% if page.prebid_member == true %}yes{% else %}no{% endif %}</td></tr>
+<tr><th class="pbTh">Media Types</th><td class="pbTd">display{% if page.media_types contains 'video' %}, video{% endif %}{% if page.media_types contains 'native' %}, native{% endif %}</td><th class="pbTh">GDPR Support<td class="pbTd">{% if page.gdpr_supported == true %}yes{% else %}no{% endif %}</td></tr>
+<tr><th class="pbTh">User IDs</th><td class="pbTd">{% if page.userIds and page.userIds != '' %}{{page.userIds}}{% else %}none{% endif %}</td><th class="pbTh">COPPA Support</th><td class="pbTd">{% if page.coppa_supported == true %}yes{% else %}no{% endif %}</td></tr>
+</table>
+
+<h3>"Send All Bids" Ad Server Keys</h3>
+
+<font size="-1">These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.</font>
+
+<table>
+<tr><td class="pbTd"><code>{{ "hb_pb_" | append: page.biddercode | slice: 0,20 }}</code></td><td class="pbTd"><code>{{ "hb_bidder_" | append: page.biddercode | slice: 0,20 }}</code></td><td class="pbTd"><code>{{ "hb_adid_" | append: page.biddercode | slice: 0,20 }}</code></td></tr>
+<tr><td class="pbTd"><code>{{ "hb_size_" | append: page.biddercode | slice: 0,20 }}</code></td><td class="pbTd"><code>{{ "hb_source_" | append: page.biddercode | slice: 0,20 }}</code></td><td class="pbTd"><code>{{ "hb_format_" | append: page.biddercode | slice: 0,20 }}</code></td></tr>
+<tr><td class="pbTd"><code>{{ "hb_cache_host_" | append: page.biddercode | slice: 0,20 }}</code></td><td class="pbTd"><code>{{ "hb_cache_id_" | append: page.biddercode | slice: 0,20 }}</code></td><td class="pbTd"><code>{{ "hb_uuid_" | append: page.biddercode | slice: 0,20 }}</code></td></tr>
+</table>
+
+{% if page.bidder_supports_deals != false %}
+<h3>"Deal ID" Ad Server Key</h3>
+<code>{{ "hb_deal_" | append: page.biddercode | slice: 0,20 }}</code>
+{% endif %}
+
 		                    {{content}}
 
 		                </div>

diff --git a/dev-docs/bidders.md b/dev-docs/bidders.md
@@ -94,9 +94,13 @@ The following parameters in the `bidResponse` object are common across all bidde
 <h3>Note:</h3> This is a S2S adapter only.
 {% endif %}
 
-<h3>Bidder Code</h3>
+<h3>Features</h3>
+
+{: .table .table-bordered .table-striped }
+| **Bidder Code** | {{ page.biddercode }} | **Prebid.org Member** | {% if page.prebid_member == true %}yes{% else %}no{% endif %} |
+| **Media Types** | display{% if page.media_types contains 'video' %}, video{% endif %}{% if page.media_types contains 'native' %}, native{% endif %} | **GDPR Support** | {% if page.gdpr_supported == true %}yes{% else %}no{% endif %} |
+| **User IDs** | {% if page.userIds and page.userIds != '' %}{{page.userIds}}{% else %}none{% endif %} | **COPPA Support** | {% if page.coppa_supported == true %}yes{% else %}no{% endif %} |
 
-<code>{{ page.biddercode }}</code>
 
 <h3>"Send All Bids" Ad Server Keys</h3>
 

diff --git a/dev-docs/bidders/appnexus.md b/dev-docs/bidders/appnexus.md
@@ -6,6 +6,7 @@ biddercode: appnexus
 hide: true
 media_types: banner, video, native
 gdpr_supported: true
+prebid_member: true
 ---
 
 ### Table of Contents

diff --git a/dev-docs/bidders/arteebee.md b/dev-docs/bidders/arteebee.md
@@ -5,6 +5,7 @@ description: Prebid Arteebee Bidder Adaptor
 hide: true
 biddercode: arteebee
 gdpr_supported: true
+coppa_supported: true
 ---
 
 ### Bid Params

diff --git a/dev-docs/bidders/criteo.md b/dev-docs/bidders/criteo.md
@@ -7,6 +7,7 @@ biddercode: criteo
 bidder_supports_deals: false
 media_types: native
 gdpr_supported: true
+prebid_member: true
 ---
 
 

diff --git a/dev-docs/bidders/openx.md b/dev-docs/bidders/openx.md
@@ -6,7 +6,9 @@ hide: true
 biddercode: openx
 media_types: video
 gdpr_supported: true
+coppa_supported: true
 userIds: pubcommon
+prebid_member: true
 ---
 
 ### Bid Parameters

diff --git a/dev-docs/bidders/openxoutstream.md b/dev-docs/bidders/openxoutstream.md
@@ -5,7 +5,8 @@ description: Prebid OpenX Outstream Bidder Adaptor
 hide: true
 biddercode: openxoutstream
 media_types: native
-
+prebid_member: true
+coppa_supported: true
 ---
 
 

diff --git a/dev-docs/bidders/pubmatic.md b/dev-docs/bidders/pubmatic.md
@@ -7,6 +7,7 @@ biddercode: pubmatic
 media_types: banner, video, native
 gdpr_supported: true
 userIds: unifiedId/tradedesk
+prebid_member: true
 ---
 
 ### Prebid Server Note:

diff --git a/dev-docs/bidders/rubicon.md b/dev-docs/bidders/rubicon.md
@@ -5,11 +5,12 @@ description: Rubicon Project Prebid Bidder Adaptor
 hide: true
 biddercode: rubicon
 gdpr_supported: true
+coppa_supported: true
 media_types: video
 userIds: unifiedId/tradedesk, digitrust
+prebid_member: true
 ---
 
-
 ### Note:
 The Rubicon Project adapter requires setup and approval from the Rubicon Project team, even for existing Rubicon Project publishers. Please reach out to your account team or globalsupport@rubiconproject.com for more information.
 

diff --git a/dev-docs/bidders/sortable.md b/dev-docs/bidders/sortable.md
@@ -6,6 +6,7 @@ biddercode: sortable
 hide: true
 media_types: banner
 gdpr_supported: true
+prebid_member: true
 ---
 
 **Table of Contents**

diff --git a/dev-docs/publisher-api-reference.md b/dev-docs/publisher-api-reference.md
@@ -56,6 +56,7 @@ This page has documentation for the public API methods of Prebid.js.
     * [userSync](#setConfig-Configure-User-Syncing)
     * [targetingControls](#setConfig-targetingControls)
     * [sizeConfig and labels](#setConfig-Configure-Responsive-Ads) (responsive ads)
+    * [COPPA](#setConfig-coppa)
     * [Generic Configuration](#setConfig-Generic-Configuration)
     * [Troubleshooting your config](#setConfig-Troubleshooting-your-configuration)
   * [.getConfig([string])](#module_pbjs.getConfig)
@@ -1237,6 +1238,7 @@ Core config:
 + [Configure user syncing](#setConfig-Configure-User-Syncing)
 + [Configure targeting controls](#setConfig-targetingControls)
 + [Configure responsive ad units with `sizeConfig` and `labels`](#setConfig-Configure-Responsive-Ads)
++ [COPPA](#setConfig-coppa)
 + [Generic Configuration](#setConfig-Generic-Configuration)
 + [Troubleshooting your configuration](#setConfig-Troubleshooting-your-configuration)
 
@@ -1961,8 +1963,20 @@ pbjs.addAdUnits([{
 
 See [Conditional Ad Units]({{site.baseurl}}/dev-docs/conditional-ad-units.html) for additional use cases around labels.
 
-<a name="setConfig-Generic-Configuration" />
 
+<a name="setConfig-coppa" />
+
+#### COPPA
+
+Bidder adapters that support the Child Online Privacy Protection Act (COPPA) read the `coppa` configuration.
+Publishers with content falling under the scope of this regulation should consult with their legal teams.
+The flag may be passed to supporting adapters with this config:
+
+{% highlight js %}
+pbjs.setConfig('coppa', 'true'));
+{% endhighlight %}
+
+<a name="setConfig-Generic-Configuration" />
 
 #### Generic setConfig Configuration
 
@@ -1977,7 +1991,7 @@ Some adapters may support other options, as defined in their documentation. To s
 If you call `pbjs.setConfig` without an object, e.g.,
 
 {% highlight js %}
-pbjs.setConfig('debug', 'true'))
+pbjs.setConfig('debug', 'true'));
 {% endhighlight %}
 
 then Prebid.js will print an error to the console that says: