Skip to content

Commit

Permalink
Merge branch 'master' into dev
Browse files Browse the repository at this point in the history
  • Loading branch information
SSuranie committed Mar 29, 2021
2 parents 37a73dd + 5322aa9 commit eb991af
Show file tree
Hide file tree
Showing 247 changed files with 2,837 additions and 996 deletions.
26 changes: 25 additions & 1 deletion _data/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -506,6 +506,14 @@
sectionTitle:
subgroup: 8

- sbSecId: 1
title: Timeouts
link: /features/timeouts.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 8


#--------------Prebid Mobile--------------|

Expand Down Expand Up @@ -625,6 +633,14 @@
sectionTitle:
subgroup: 1

- sbSecId: 2
title: In App Native Ad Unit
link: /prebid-mobile/pbm-api/ios/pbm-native-inapp-ios.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 1

- sbSecId: 2
title: Video Outstream Ad Unit
link: /prebid-mobile/pbm-api/ios/pbm-videooutstreamadunit-ios.html
Expand Down Expand Up @@ -738,6 +754,14 @@
sectionTitle:
subgroup: 2

- sbSecId: 2
title: In App Native Ad Unit
link: /prebid-mobile/pbm-api/android/pbm-native-inapp-android.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 2

- sbSecId: 2
title: Banner Interstitial Ad Unit
link: /prebid-mobile/pbm-api/android/pbm-bannerinterstitialadunit-android.html
Expand Down Expand Up @@ -2007,7 +2031,7 @@
sbCollapseId: tools

- sbSecId: 8
title:
title:
link:
isHeader: 1
headerId: toolsinvis
Expand Down
22 changes: 16 additions & 6 deletions _includes/adops/adops-gam-video-setup.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,20 @@ <h2 id="line-item-setup">Line Item Setup</h2>
<p>Be sure to duplicate your line item and video creative for each Prebid price bucket you intend to create. </p>
<p class="alert alert-warning">By default, Prebid.js caps all CPMs at $20. As a video seller, you may expect to see CPMs higher than $20. In order to receive those bids, you’ll need to make sure your dev team implements custom price buckets as described in the <a href="/dev-docs/show-video-with-a-dfp-video-tag.html#implement-custom-price-buckets">engineering setup instructions</a>. Once those changes are made on the engineering side, there should be no changes required from the ad ops side to support CPMs over $20.</p>

<p class="alert alert-success"><b>Multiple Cache Services</b><br>You might need separate video line items for each cache service being used. For example, if both AppNexus and Rubicon Project are bidders, you’ll either need to create separate line items to support the different cache URLs required or provide separately-targeted creatives, as described below.</p>

<h2 id="creative-setup">Creative Setup</h2>

When setting up video creatives, it's important to understand where the VAST XML is stored for each of your bidders. The most common place to store VAST XML is AppNexus' cache, but some bidders (such as RubiconProject and SpotX) use their own cache services. To support such
bidders, you will need to have either:
bidders, you will need to choose one of the following approaches:
<ul>
<li>a separate line item for each bidder, or</li>
<li>a creative for each cache service utilized by your implementation.</li>
<li>Create a separate line item for each bidder.</li>
<li>Include a creative for each cache service utilized by your implementation.</li>
<li>Use the <a href="/dev-docs/publisher-api-reference.html#setConfig-vast-cache">ignoreBidderCacheKey</a> option on setConfig({cache}).</li>
</ul>

<h3 id="creative-single-cache">Single Cache Location</h3>

If you only use bidders that provide full VAST responses, no special setup is needed. Otherwise, do the following:

<p>1. For each line item you create, click on the <b>Creatives</b> tab, click the <b>ADD CREATIVE</b> button, and choose the size you're entering.</p>

<p>2. In the dialog that appears, choose <b>Redirect</b>.</p>
Expand All @@ -71,7 +72,7 @@ <h3 id="creative-single-cache">Single Cache Location</h3>

<p class="alert alert-info"><strong>Prebid Cache and the VAST creative URL warning</strong><br />
Google Ad Manager will show you a warning stating that fetching VAST from the creative
URL failed. This is expected, since the creative URL above points
URL failed. This is expected, since the creative URL above points
to a server-side asset cache hosted by Prebid Server.</p>

<p>4. Set the <b>Duration</b> to <b>1</b>.</p>
Expand All @@ -82,6 +83,15 @@ <h3 id="creative-single-cache">Single Cache Location</h3>

<h3 id="creative-multiple-cache">Multiple Cache Locations</h3>

If you're utilizing any bidders that cache their own VAST, you have two options:

<ul>
<li>If you're using Prebid.js 4.28 or later, you can specify the <a href="/dev-docs/publisher-api-reference.html#setConfig-vast-cache">ignoreBidderCacheKey</a> option on setConfig({cache}). This will cause the browser to generate a VAST wrapper and cache it in your standard location. Then you can use the instructions
above for "Single Cache Location". The tradeoff is that this approach requires
the video player to unwrap one extra level of VAST.</li>
<li>Utilize creative-level targeting in the ad server. Keep reading for more details.</li>
</ul>

To set up multiple video creatives in the same line item (i.e., to run AppNexus, Rubicon, and SpotX all together in the same video line item), you can utilize creative targeting.
<br/>
<br/>
Expand Down
6 changes: 0 additions & 6 deletions _includes/send-all-bids-keyword-targeting.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,8 @@
{% capture infoNote %}
**Important:** Google Ad Manager has a key-value key character [limit](https://support.google.com/dfp_premium/answer/1628457?hl=en#Key-values) of up to **20 characters**. Some of the keys without truncation will exceed 20 chars. Prebid.js automatically truncates the key length to 20 characters. For example, `hb_adid_longBidderName` is truncated to `hb_adid_longBidderNa` (`me` is truncated). Note that the key is case-sensitive. To get the exact key-value keys for each bidder, find them at [Bidder Params](/dev-docs/bidders.html).
{% endcapture %}

{% include alerts/alert_note.html content=infoNote %}


{: .table .table-bordered .table-striped }
| Default Key | Scope | Description | Example |
| :---- |:---- | :---- | :---- |
| `hb_pb_BIDDERCODE` | Required | The price bucket. Used by the line item to target. Case sensitive and truncated to 20 chars. The `BIDDERCODE` is documented at [Bidder Params](/dev-docs/bidders.html). | `hb_pb_rubicon` = `2.10` |
| `hb_adid_BIDDERCODE` | Required | The ad Id. Used by the ad server creative to render ad. Case sensitive and truncated to 20 chars. The `BIDDERCODE` is documented at [Bidder Params](/dev-docs/bidders.html). | `hb_adid_longBidderNa` = `234234` |
| `hb_size_BIDDERCODE` | Optional | This is not required for adops. Case sensitive and truncated to 20 chars. | `hb_size_appnexus` = `300x250` |

64 changes: 64 additions & 0 deletions _layouts/analytics.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
{% include head.html %}

{% include nav.html %}


<div class="container pb-docs-container">

<div class="row ">

<div class="col-lg-3 sidebar" id="sidebar">

<div>
<button class="navbar-toggler d-lg-none" type="button" data-toggle="collapse" data-target="#sidebarContent" aria-controls="sidebarContent" aria-expanded="false" aria-label="Toggle Sidebar navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse d-lg-block" id="sidebarContent">
{% include left_nav.html %}
</div>
</div>

</div>

<div class="col-lg-9">
<div class="pb-content" markdown="1">

{% if page.is_full_screen %}
{{content}}
{% else %}

<div class="row">

<div class="col-md-9" role="main">
<div class="bs-docs-section">

<h3>{{ page.title }}</h3>

<h3>Features</h3>

{{content}}

</div>

</div>

</div>

{% endif %}


</div>


</div>
</div>
<!--end row-->
</div>
{% if page.title != "Credits" %}
{% if page.layout != "home" %}
{% include footer.html %}
{% endif %}
{% endif %}

</body>
</html>
12 changes: 6 additions & 6 deletions _layouts/bidder.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,26 +53,26 @@ <h3>Features</h3>
<tr>
<th class="pbTh">Media Types</th>
<td class="pbTd">{% unless page.media_types contains 'no-display' %}display{% if page.media_types contains 'video' %},{% endif %}{% endunless %}{% if page.media_types contains 'video' %} video{% endif %}{% if page.media_types != "no-display, native" and page.media_types contains 'native' %}, native{% endif %}{% if page.media_types == "no-display, native" %}native{% endif %}</td>
<th class="pbTh">GDPR TCF1 Support</th>
<th class="pbTh">GDPR TCF Support</th>
<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">GDPR TCF2 Support</th>
<td class="pbTd">{% if page.tcf2_supported == true %}yes{% else %}no{% endif %}</td>
<th class="pbTh">USP/CCPA Support</th>
<td class="pbTd">{% if page.usp_supported == true %}yes{% else %}no{% endif %}</td>
</tr>
<tr>
<th class="pbTh">SChain Support</th>
<th class="pbTh">Supply Chain Support</th>
<td class="pbTd">{% if page.schain_supported == true %}yes{% else %}no{% endif %}</td>
<th class="pbTh">COPPA Support</th>
<td class="pbTd">{% if page.coppa_supported == true %}yes{% else %}no{% endif %}</td>
</tr>
<tr>
<th class="pbTh">Demand Chain Support</th>
<td class="pbTd">{% if page.dchain_supported == true %}yes{% else %}no{% endif %}</td>
<th class="pbTh">Safeframes OK</th>
<td class="pbTd">{% if page.safeframes_ok == false %}no{% elsif page.safeframes_ok == true %}yes{% else %}check with bidder{% endif %}</td>
<th class="pbTh">USP/CCPA Support</th>
<td class="pbTd">{% if page.usp_supported == true %}yes{% else %}no{% endif %}</td>
</tr>
<tr>
<th class="pbTh">Supports Deals</th>
Expand Down
2 changes: 1 addition & 1 deletion _layouts/home.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<div class="row justify-content-center text-center mt-6">
<div class="col-md-10">
<h1>Prebid Documentation</h1>
<p>Welcome to the Prebid.org technical documentation portal. Here you will find the help you need to work with the Prebid.org family of products. Visit <a href="https://prebid.org" target="_blank">Prebid.org</a> for general product overviews, blog updates, and additional information on membership and events.</p>
<p>Welcome to the Prebid.org technical documentation portal. Here you will find the help you need to work with the Prebid.org family of products. Visit <a href="https://prebid.org" target="_blank">Prebid.org</a> for general product overviews, blog updates, and additional information on membership and events. If you're wondering what Prebid and Header Bidding are all about, check out <a href="https://prebid.org/why-prebid/" target="_blank">Why Prebid?</a></p>
</div>
</div> <!-- row -->

Expand Down
19 changes: 10 additions & 9 deletions adops/send-all-bids-adops.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,24 @@ sidebarType: 3

This page shows how to set up your ad server so that you can send all bids and report on them.

As a publisher, you may wish to have your ad server see **all** header bidding bids (instead of seeing only the winning bids in each auction). Reasons you might want this behavior include:
* TOC
{: toc }

## Overview

As a publisher, you may want to have your ad server see **all** header bidding bids (instead of seeing only the winning bids in each auction). Reasons you might want this behavior include:

+ You want your ad server to see all header bidding bids, so that your ad server can report on bid prices, instead of only winning prices
+ You want your ad server to see all header bidding bids so that your ad server can report on bid prices instead of only winning prices.

+ You have a contractual agreement with your header bidding partner
+ You have a contractual agreement with your header bidding partner.

{: .alert.alert-success :}
See the [Publisher API Reference]({{site.baseurl}}/dev-docs/publisher-api-reference.html#setConfig-Send-All-Bids) for more details.

* TOC
{: toc }

## Overview

+ Your developers may optionally add `enableSendAllBids: true` to `pbjs.setConfig()`. This is not strictly necessary, as `enableSendAllBids` defaults to `true`. For details, see the [Publisher API Reference]({{site.baseurl}}/dev-docs/publisher-api-reference.html#setConfig-Send-All-Bids).
If you decide to send all bids to the ad sever, your developers have the option of explicity adding `enableSendAllBids: true` to `pbjs.setConfig()`. However, since the default value is `true` this addition is not strictly necessary. For details, see the [Publisher API Reference]({{site.baseurl}}/dev-docs/publisher-api-reference.html#setConfig-Send-All-Bids).

+ From the ad ops side, you may choose to set up one order per bidder, so that each order can have a set of line items using targeting keywords that include the bidder's name. For example, if you are working with [Rubicon]({{site.baseurl}}/dev-docs/bidders.html#rubicon), you would use `hb_pb_rubicon` in your line item's key-value targeting, and `hb_adid_rubicon` in the creative.
From the ad ops side, you can choose to set up one order per bidder, which allows for each order to have a set of line items using targeting keywords that include the bidder's name. For example, if you are working with [Rubicon](/dev-docs/bidders.html#rubicon), you would use `hb_pb_rubicon` in your line item's key-value targeting, and `hb_adid_rubicon` in the creative.

{% include send-all-bids-keyword-targeting.md %}

Expand Down
Binary file added assets/images/dev-docs/prebid-timeouts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.
Binary file removed assets/images/flowcharts/FirstPartyData-Summary.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion cookies.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebarType: 0

# Cookie Declaration

Prebid.org may store or retrieve information on your browser in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. However, blocking cookies may impact your experience of the site and the services we are able to offer.
The docs.prebid.org website may store or retrieve information on your browser in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. However, blocking cookies may impact your experience of the site and the services we are able to offer.

<!-- OneTrust Cookies Settings button start -->
<a class="optanon-show-settings">Cookie Settings</a>
Expand Down
14 changes: 8 additions & 6 deletions dev-docs/adunit-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ See the table below for the list of properties on the ad unit. For example ad u
| `mediaTypes` | Optional | Object | Defines one or more media types that can serve into the ad unit. For a list of properties, see [`adUnit.mediaTypes`](#adUnit.mediaTypes) below. |
| `labelAny` | Optional | Array[String] | Used for [conditional ads][conditionalAds]. Works with `sizeConfig` argument to [pbjs.setConfig][configureResponsive]. |
| `labelAll` | Optional | Array[String] | Used for [conditional ads][conditionalAds]. Works with `sizeConfig` argument to [pbjs.setConfig][configureResponsive]. |
| `fpd` | Optional | Object | Similar to [global first party data configuration](/dev-docs/publisher-api-reference.html#setConfig-fpd), but specific to this adunit. |
| `ortb2Imp` | Optional | Object | Similar to [global first party data configuration](/dev-docs/publisher-api-reference.html#setConfig-fpd), but specific to this adunit. Note that the setConfig data is global to the logical OpenRTB object, but AdUnit-specific data is defined in the scope of a particular imp object. |

<a name="adUnit.bids" />

Expand Down Expand Up @@ -531,18 +531,20 @@ pbjs.addAdUnits({
sizes: [[300,250]]
}
},
fpd: {
context: {
pbAdSlot: "homepage-top-rect",
adUnitSpecificContextAttribute: "123"
ortb2Imp: {
ext: {
data: {
pbAdSlot: "homepage-top-rect",
adUnitSpecificContextAttribute: "123"
}
}
},
...
});
{% endhighlight %}

Notes:
- Only contextual data is supported on the AdUnit; user-related data goes in the [global first party data](/dev-docs/publisher-api-reference.html#setConfig-fpd).
- Only contextual data should be added on the AdUnit; user-related data goes in the [global first party data](/dev-docs/publisher-api-reference.html#setConfig-fpd) config.
- For additional help with analytics and reporting you can use the [Prebid Ad Slot](/features/pbAdSlot.html), a special type of first party data.

## Related Topics
Expand Down
34 changes: 34 additions & 0 deletions dev-docs/analytics/adWMG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
layout: analytics
title: adWMG
description: adWMG Analytics Adapter
modulecode: adWMG
gdpr_supported: true
usp_supported: false
coppa_supported: false
prebid_member: false
gvl_id: 959
---

#### Analytics Options

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|-------------|---------|--------------------|-----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|------------------|
| publisher_id | required | Publisher ID from WMG Dashboard | `'5abd0543ba45723db49d97ea'` | string |
| site | required | Domain where Prebid.js working | `'test.com'` | string |


### Example Configuration

```
pbjs.enableAnalytics({
provider: 'adWMG',
options : {
site: 'test.com',
publisher_id: '5abd0543ba45723db49d97ea'
}});
```
#### Registration

Please visit [https://adwmg.com/](https://adwmg.com/) for more information.
12 changes: 12 additions & 0 deletions dev-docs/analytics/adagio.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: analytics
title: Adagio
description: Adagio Analytics Adapter
modulecode: adagio
prebid_member: true
---

#### Registration

Please visit [https://adagio.io/](https://adagio.io/) for more information.

11 changes: 11 additions & 0 deletions dev-docs/analytics/adkernelAdn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
layout: analytics
title: Adkernel
description: Adkernel Analytics Adapter
modulecode: adkernelAdn
---

#### Registration

Please visit []() for more information.

12 changes: 12 additions & 0 deletions dev-docs/analytics/adomik.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: analytics
title: Adomik
description: Adomik Analytics Adapter
modulecode: adomik
prebid_member: true
---

#### Registration

Please visit []() for more information.

11 changes: 11 additions & 0 deletions dev-docs/analytics/adxcg.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
layout: analytics
title: Adxcg
description: Adxcg Analytics Adapter
modulecode: adxcg
---

#### Registration

Please visit []() for more information.

Loading

0 comments on commit eb991af

Please sign in to comment.