Skip to content

Commit

Permalink
Merge branch 'master' into update-lkqd-version-note
Browse files Browse the repository at this point in the history
  • Loading branch information
bretg authored Feb 10, 2022
2 parents 7d9ee10 + 1ad7c96 commit c37233f
Show file tree
Hide file tree
Showing 191 changed files with 2,842 additions and 975 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
This repository contains the source files for the Prebid.js documentation site at [Prebid.org](https://prebid.org).

Please see the sections below for more information.
Please see the sections below for more information:

+ [Contributing](#contributing)
+ [License](#license)
Expand Down
18 changes: 17 additions & 1 deletion _data/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@

- sbSecId: 0
title: Header Bidding
link: /wrapper_code_of_conduct.html
link: https://prebid.org/code-of-conduct/
isHeader: 0
isSectionHeader: 0
sectionTitle:
Expand Down Expand Up @@ -467,6 +467,14 @@
sectionTitle:
subgroup: 8

- sbSecId: 1
title: Ad Server Key Values
link: /features/adServerKvps.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 8

- sbSecId: 1
title: Native Ads
link: /prebid/native-implementation.html
Expand Down Expand Up @@ -1841,6 +1849,14 @@
sectionTitle:
subgroup: 3

- sbSecId: 5
title: Native
link: /prebid-server/features/pbs-native.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 3

- sbSecId: 5
title: Caching
link: /prebid-server/features/pbs-caching.html
Expand Down
8 changes: 7 additions & 1 deletion _layouts/bidder.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,15 @@

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

{% if page.enable_download == false %}
<div class="pb-bidder-s2">
<h4>Note:</h4> This adapter is not available in current versions of Prebid.js. Reason: {{page.pbjs_version_notes}}
</div>
{% endif %}

{% if page.s2s_only == true %}
<div class="pb-bidder-s2">
<h3>Note:</h3> This is a S2S adapter only.</h3>
<h3>Note:</h3> This is a Prebid Server adapter only.
</div>
{% endif %}

Expand Down
1 change: 1 addition & 0 deletions adops/before-you-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,5 +126,6 @@ Implementing header bidding requires much more collaboration with your dev team
## Related Topics

- [Getting Started with Prebid.js](/overview/getting-started.html): How Prebid.js works at a high level.
- [Prebid.js and Ad Server Key Values](/features/adServerKvps.html)
- [What is Prebid?](/overview/intro.html): Overview and history of header bidding and Prebid.js.
+ [Docs by Format](/dev-docs/docs-by-format.html): Engineering and ad ops docs arranged by ad format (video, native, etc.).
39 changes: 39 additions & 0 deletions dev-docs/analytics/zeta_global_ssp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
layout: analytics
title: Zeta Global Ssp
description: Zeta Global Ssp Prebid Analytics Adapter
modulecode: zeta_global_ssp
gdpr_supported: true
usp_supported: true
prebid_member: true
gvl_id: 833
enable_download: false
pbjs: true
pbjs_version_notes: v6.5.0 and later
---

#### Registration

Please visit []() for more information.

#### Analytics Options

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|-------------|---------|--------------------|-----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|------------------|
| sid | required | The Zeta Global Ssp Publisher ID | `111` | `int` |
| tags | optional | The object containing set of Zeta's custom tags witch the publisher has to supply | `tags: {}` | `object` |

### Example Configuration

```
pbjs.enableAnalytics({
provider: 'zeta_global_ssp',
options: {
sid: 111,
tags: {
...
}
}
});
```
62 changes: 40 additions & 22 deletions dev-docs/bidder-adaptor.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,18 +184,23 @@ A high level example of the structure:
import * as utils from 'src/utils';
import { registerBidder } from 'src/adapters/bidderFactory';
import { config } from 'src/config';
import {BANNER, VIDEO, NATIVE} from 'src/mediaTypes.js';
const BIDDER_CODE = 'example';
export const spec = {
code: BIDDER_CODE,
aliases: ['ex'], // short code
gvlid: IAB_GVL_ID_FOR_GDPR,
aliases: [
{ code: "myalias", gvlid: IAB_GVL_ID_FOR_GDPR_IF_DIFFERENT }
],
isBidRequestValid: function(bid) {},
buildRequests: function(validBidRequests[], bidderRequest) {},
interpretResponse: function(serverResponse, request) {},
getUserSyncs: function(syncOptions, serverResponses, gdprConsent, uspConsent) {},
onTimeout: function(timeoutData) {},
onBidWon: function(bid) {},
onSetTargeting: function(bid) {},
onBidderError: function({ error, bidderRequest })
onBidderError: function({ error, bidderRequest }),
supportedMediaTypes: [BANNER, VIDEO, NATIVE]
}
registerBidder(spec);

Expand Down Expand Up @@ -623,20 +628,31 @@ If the alias entry is an object, the following attributes are supported:
| `gvlid` | optional | global vendor list id of company scoped to alias | `integer` |
| `skipPbsAliasing` | optional | ability to skip passing spec.code to prebid server in request extension. In case you have a prebid server adapter with the name same as the alias/shortcode. Default value: `false` | `boolean` |

### Supporting Privacy Regulations

If your bid adapter is going to be used in Europe, you should support GDPR:
- Get a [Global Vendor ID](https://iabeurope.eu/vendor-list-tcf-v2-0/) from the IAB-Europe
- Add your GVLID into the spec block as 'gvlid'. If you don't do this, Prebid.js may block requests to your adapter.
- Read the gdprConsent string from the bid request object and pass it through to your endpoint

If your bid adapter is going to be used in the United States, you should support COPPA and CCPA:
- Read the uspConsent string from the bid request object and pass it through t
o your endpoint
- Call config.getConfig('coppa') and forward to your endpoint

## Supporting Video

Follow the steps in this section to ensure that your adapter properly supports video.

### Step 1: Register the adapter as supporting video

Add the `supportedMediaTypes` argument to the spec object, and make sure `video` is in the list:
Add the `supportedMediaTypes` argument to the spec object, and make sure VIDEO is in the list:

{% highlight js %}

export const spec = {
code: BIDDER_CODE,
supportedMediaTypes: ['video'],
supportedMediaTypes: [VIDEO],
...
}

Expand All @@ -649,22 +665,20 @@ If your adapter supports banner and video media types, make sure to include `'ba

Video parameters are often passed in from the ad unit in a `video` object. As of Prebid 4.0 the following paramters should be read from the ad unit when available; bidders can accept overrides of the ad unit on their bidder configuration parameters but should read from the ad unit configuration when their bidder parameters are not set. Parameters one should expect on the ad unit include:

| parameter |
|-|
| mimes |
| minduration |
| maxduration |
| protocols |
| startdelay |
| placement |
| skip |
| skipafter |
| minbitrate |
| maxbitrate |
| delivery |
| playbackmethod |
| api |
| linearity |
- mimes
- minduration
- maxduration
- protocols
- startdelay
- placement
- skip
- skipafter
- minbitrate
- maxbitrate
- delivery
- playbackmethod
- api
- linearity

The design of these parameters may vary depending on what your server-side bidder accepts. If possible, we recommend using the video parameters in the [OpenRTB specification](https://iabtechlab.com/specifications-guidelines/openrtb/).

Expand Down Expand Up @@ -705,7 +719,7 @@ if (bid.mediaType === 'video' || (videoMediaType && context !== 'outstream')) {
#### Long-Form Video Content

{: .alert.alert-info :}
Following is Prebid's way to setup bid request for long-form, apadters are free to choose their own approach.
The following is Prebid's way to setup bid request for long-form, adapters are free to choose their own approach.

Prebid now accepts multiple bid responses for a single `bidRequest.bids` object. For each Ad pod Prebid expects you to send back n bid responses. It is up to you how bid responses are returned. Prebid's recommendation is that you expand an Ad pod placement into a set of request objects according to the total adpod duration and the range of duration seconds. It also depends on your endpoint as well how you may want to create your request for long-form. Appnexus adapter follows below algorithm to expand its placement.

Expand Down Expand Up @@ -890,6 +904,7 @@ In order for your bidder to support the native media type:
1. Your (server-side) bidder needs to return a response that contains native assets.
2. Your (client-side) bidder adapter needs to unpack the server's response into a Prebid-compatible bid response populated with the required native assets.
3. Your bidder adapter must be capable of ingesting the required and optional native assets specified on the `adUnit.mediaTypes.native` object, as described in [Show Native Ads](/prebid/native-implementation.html).
4. Your spec must declare NATIVE in the supportedMediaTypes array.

The adapter code samples below fulfills requirement #2, unpacking the server's reponse and:

Expand Down Expand Up @@ -963,10 +978,13 @@ For example tests, see [the existing adapter test suites](https://github.com/pre
import * as utils from 'src/utils';
import {config} from 'src/config';
import {registerBidder} from 'src/adapters/bidderFactory';
import {BANNER, VIDEO, NATIVE} from 'src/mediaTypes.js';
const BIDDER_CODE = 'example';
export const spec = {
code: BIDDER_CODE,
aliases: ['ex'], // short code
gvlid: 0000000000,
supportedMediaTypes: [BANNER, VIDEO, NATIVE],
aliases: [{code: "myAlias", gvlid: 99999999999} ],
/**
* Determines whether or not the given bid request is valid.
*
Expand Down
3 changes: 2 additions & 1 deletion dev-docs/bidders/1ad4good.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: 1ad4good
description: Prebid One Ad for Good(1ad4good.org) Bidder Adaptor
pbjs: true
biddercode: 1ad4good
pbjs_version_notes: not in 5.x
enable_download: false
pbjs_version_notes: not ported to 5.x
---

### Note:
Expand Down
13 changes: 12 additions & 1 deletion dev-docs/bidders/33across.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,4 +156,15 @@ var adUnits = [
...
}
```

### SRA Mode
We recommend using SRA mode to optimize the bidding process as this allows our adapter to group together bid requests for Ad Units pertaining to the same product and site ID thereby minimizing the number of http requests made to our endpoint. To enable SRA set the following bidder specific config under 33Across
```
pbjs.setBidderConfig({
bidders: ['33across'],
config: {
ttxSettings: {
enableSRAMode: true
}
}
});
```
3 changes: 2 additions & 1 deletion dev-docs/bidders/7xbid.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ description: Prebid 7xbid Bidder Adaptor
pbjs: true
biddercode: 7xbid
media_types: banner, native
pbjs_version_notes: not in 5.x
enable_download: false
pbjs_version_notes: not ported to 5.x
---

### Bid Params
Expand Down
3 changes: 2 additions & 1 deletion dev-docs/bidders/aardvark.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ usp_supported: true
schain_supported: true
userIds: unifiedId
gvl_id: 52
pbjs_version_notes: not in 5.x
enable_download: false
pbjs_version_notes: not ported to 5.x
---

### Bid Params
Expand Down
10 changes: 6 additions & 4 deletions dev-docs/bidders/adagio.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ coppa_supported: true
schain_supported: true
gvl_id: 617
prebid_member: true
pbs: true
fpd_supported: true
fpd_supported: false
---

### Note
Expand All @@ -23,7 +22,7 @@ The Adagio bidder adaptor requires setup and approval from the Adagio team. Plea

### Bid Params

**Important**: Adagio needs to collect attention data about the ads displayed on a page and must listen to some specifics ad-server events. Please refer to the [Adagio user guide](https://adagio-team.atlassian.net/wiki/spaces/AH/pages/67272705/EN+Adagio+Prebid.js+installation+guide+for+publishers) for details.
**Important**: Adagio needs to collect attention data about the ads displayed on a page and must listen to some specifics ad-server events. Please refer to the [Adagio user guide](https://adagioio.notion.site/Adagio-Account-Setup-Guide-fbcd940649224cdfa10393d2f008792e) for details.

{: .table .table-bordered .table-striped }

Expand All @@ -37,7 +36,6 @@ The Adagio bidder adaptor requires setup and approval from the Adagio team. Plea
| `environment`* | recommended | Environment where the page is displayed.<br><i>- max length: 30</i><br><i>- max distinctives values: 10</i> | `'desktop'` | `string` |
| `category`* | recommended | Category of the content displayed in the page.<br><i>- max length: 30</i><br><i>- max distinctives values: 50</i> | `'sport'` | `string` |
| `subcategory`* | optional | Subcategory of the content displayed in the page.<br><i>- max length: 30</i><br><i>- max distinctives values: 50</i> | `'handball'` | `string` |
| `postBid` | optional | Used in Post-Bid context only. | `true` | `boolean` |
| `video` | optional | OpenRTB 2.5 video options object.<br> All options will override ones defined in mediaTypes.video | `{skip: 1, playbackmethod: [6]}` | `object` |
| `native` | optional | Partial OpenRTB Native 1.2 request object. Supported fields are:<br>- context<br>-plcmttype | `{context: 1, plcmttype: 2}` | `object` |

Expand All @@ -49,3 +47,7 @@ The Adagio bidder adaptor requires setup and approval from the Adagio team. Plea
| Name | description |
|--------------|-------------------------------------|
| `adagio_bvw` | Url to handle Measure beacon |

### First Party Data

Adagio does not support FPD for now. It will be added soon.
3 changes: 2 additions & 1 deletion dev-docs/bidders/adbutler.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: AdButler
description: Prebid AdButler Bidder Adaptor
pbjs: true
biddercode: adbutler
pbjs_version_notes: not in 5.x
enable_download: false
pbjs_version_notes: not ported to 5.x
---


Expand Down
2 changes: 1 addition & 1 deletion dev-docs/bidders/adf.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ prebid_member: true
pbjs: true
pbs: true
schain_supported: true
userIds: britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, sharedId, unifiedId
userIds: all
gvl_id: 50
prevBiddercode: adformOpenRTB
floors_supported: true
Expand Down
3 changes: 2 additions & 1 deletion dev-docs/bidders/adfinity.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ pbjs: true
biddercode: adfinity
media_types: banner, video, native
gdpr_supported: true
pbjs_version_notes: not in 5.x
enable_download: false
pbjs_version_notes: not ported to 5.x
---

### Bid Params
Expand Down
5 changes: 3 additions & 2 deletions dev-docs/bidders/adform.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ usp_supported: true
prebid_member: true
pbjs: true
pbs: true
userIds: britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, sharedId, unifiedId
userIds: all
gvl_id: 50
pbjs_version_notes: not in 5.x
enable_download: false
pbjs_version_notes: not ported to 5.x
---

**Adform bid adapter is deprecated since Prebid 5.0. Please refer to [AdformOpenRTB adapter](#adf) documentation to fetch bids from Adform demand sources.**
Expand Down
3 changes: 2 additions & 1 deletion dev-docs/bidders/adglare.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ description: Prebid Adapter for AdGlare Ad Server
pbjs: true
biddercode: adglare
media_types: banner
pbjs_version_notes: not in 5.x
enable_download: false
pbjs_version_notes: not ported to 5.x
---

### Bid Params
Expand Down
3 changes: 2 additions & 1 deletion dev-docs/bidders/adlive.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: Adlive
description: adlive bid adapter
pbjs: true
biddercode: adlive
pbjs_version_notes: not in 5.x
enable_download: false
pbjs_version_notes: not ported to 5.x
---

### Bid Params
Expand Down
3 changes: 2 additions & 1 deletion dev-docs/bidders/admedia.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ pbjs: true
biddercode: admedia
media_types: banner
gdpr_supported: false
pbjs_version_notes: not in 5.x
enable_download: false
pbjs_version_notes: not ported to 5.x
---


Expand Down
Loading

0 comments on commit c37233f

Please sign in to comment.