Skip to content

Commit 28b4a08

Browse files
e-volution-teche-volution-tech
authored
Merge branch 'master' into master
2 parents 8a1cadd + 88161bf commit 28b4a08

158 files changed

Lines changed: 578 additions & 31 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎dev-docs/adunit-reference.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ See the table below for the list of properties in the `mediaTypes` object of the
7474
| Name | Scope | Type | Description |
7575
|---------+----------+---------------------------------------+-----------------------------------------------------------------------------------------|
7676
| `sizes` | Required | Array[Number] or Array[Array[Number]] | All sizes this ad unit can accept. Examples: `[400, 600]`, `[[300, 250], [300, 600]]`. |
77+
| `pos` | Optional | Integer | OpenRTB page position value: 0=unknown, 1=above-the-fold, 3=below-the-fold, 4=header, 5=footer, 6=sidebar, 7=full-screen |
7778
| `name` | Optional | String | Name for this banner ad unit. Can be used for testing and debugging. |
7879

7980
<a name="adUnit.mediaTypes.native" />
@@ -184,7 +185,9 @@ The `native` object contains the following properties that correspond to the ass
184185
{: .table .table-bordered .table-striped }
185186
| Name | Scope | Type | Description |
186187
|------------------+-------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
187-
| `context` | Optional | String | The video context, either `'instream'`, `'outstream'`, or `'adpod'` (for long-form videos). Example: `context: 'outstream'` |
188+
| `pos` | Optional | Integer | OpenRTB page position value: 0=unknown, 1=above-the-fold, 3=below-the-fold, 4=header, 5=footer, 6=sidebar, 7=full-screen |
189+
| `context` | Recommended | String | The video context, either `'instream'`, `'outstream'`, or `'adpod'` (for long-form videos). Example: `context: 'outstream'`. Defaults to 'instream'. |
190+
| `placement` | Recommended | Integer | 1=in-stream, 2=in-banner, 3=in-article, 4=in-feed, 5=interstitial/floating. **Highly recommended** because some bidders require more than context=outstream. |
188191
| `playerSize` | Optional | Array[Integer,Integer] | The size (width, height) of the video player on the page, in pixels. Example: `playerSize: [640, 480]` |
189192
| `api` | Recommended | Array[Integer] | List of supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported. For list, see [OpenRTB spec][openRTB]. |
190193
| `mimes` | Recommended | Array[String] | Content MIME types supported, e.g., `"video/x-ms-wmv"`, `"video/mp4"`. **Required by OpenRTB when using [Prebid Server][pbServer]**. |
@@ -210,10 +213,6 @@ enabled; only applicable if the ad is skippable., see [OpenRTB spec][openRTB].
210213
| `pos` | Optional | Integer | Ad position on screen, see [OpenRTB spec][openRTB]. |
211214
| `playbackend` | Optional | Integer | The event that causes playback to end, see [OpenRTB spec][openRTB]. |
212215

213-
214-
215-
216-
217216
If `'video.context'` is set to `'adpod'` then the following parameters are also available.
218217

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

‎dev-docs/analytics/id5.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
layout: analytics
3+
title: ID5
4+
description: ID5 Analytics Adapter
5+
modulecode: id5Analytics
6+
gdpr_supported: true
7+
usp_supported: true
8+
prebid_member: true
9+
gvl_id: 131
10+
enable_download: false
11+
---
12+
13+
#### Registration
14+
15+
The ID5 Analytics Adapter is free to use during our Beta period, but requires a simple registration with ID5. Please visit [id5.io/solutions](https://id5.io/solutions#publishers) to sign up and request your ID5 Partner Number to get started. If you're already using the ID5 Universal ID, you may use your existing Partner Number with the analytics adapter.
16+
17+
The ID5 privacy policy is at [https://id5.io/platform-privacy-policy](https://id5.io/platform-privacy-policy).
18+
19+
#### Analytics Options
20+
21+
{: .table .table-bordered .table-striped }
22+
| Parameter | Scope | Type | Description | Example |
23+
| --- | --- | --- | --- | --- |
24+
| provider | Required | String | The name of this module: `id5Analytics` | `id5Analytics` |
25+
| options.partnerId | Required | Number | This is the ID5 Partner Number obtained from registering with ID5. | `1234` |
26+
| options.eventsToTrack | Optional | Array of strings | Overrides the set of tracked events | `['auctionEnd','bidWon']` |
27+
28+
29+
### Example Configuration
30+
31+
```javascript
32+
pbjs.enableAnalytics({
33+
provider: 'id5Analytics',
34+
options: {
35+
partnerId: 173 // change to the Partner Number you received from ID5
36+
}
37+
});
38+
```

‎dev-docs/bidders/1ad4good.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ title: 1ad4good
44
description: Prebid One Ad for Good(1ad4good.org) Bidder Adaptor
55
pbjs: true
66
biddercode: 1ad4good
7+
pbjs_version_notes: not in 5.x
78
---
89

910
### Note:

‎dev-docs/bidders/7xbid.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ description: Prebid 7xbid Bidder Adaptor
55
pbjs: true
66
biddercode: 7xbid
77
media_types: banner, native
8+
pbjs_version_notes: not in 5.x
89
---
910

1011
### Bid Params

‎dev-docs/bidders/aardvark.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ usp_supported: true
99
schain_supported: true
1010
userIds: unifiedId
1111
gvl_id: 52
12+
pbjs_version_notes: not in 5.x
1213
---
1314

1415
### Bid Params

‎dev-docs/bidders/adbookpsp.md‎

Lines changed: 200 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,200 @@
1+
---
2+
layout: bidder
3+
title: AdBookPSP
4+
description: Prebid AdBookPSP Bidder Adapter
5+
biddercode: adbookpsp
6+
media_types: banner, video
7+
gdpr_supported: true
8+
prebid_member: false
9+
schain_supported: true
10+
coppa_supported: true
11+
usp_supported: true
12+
pbjs: true
13+
pbs: false
14+
---
15+
16+
*NOTE*: The AdBookPSP Bidder Adapter requires setup and approval before use. The adapter uses custom targeting keys that require a dedicated Google Ad Manager setup to work. Please reach out to your AdbookPSP representative for more details.
17+
18+
### Bid Params
19+
20+
{: .table .table-bordered .table-striped }
21+
|Name|Scope|Description|Example|Type|
22+
|----|-----|-----------|-------|----|
23+
|`orgId`|optional|Org ID listed in the Deal File|`abc123`|`string`|
24+
|`placementId`|optional|Placement ID listed in the Deal File|`abc123`|`string`|
25+
26+
Each adUnit with `adbookpsp` adapter has to have either `placementId` or `orgId` set.
27+
28+
```js
29+
var adUnits = [
30+
{
31+
bids: [
32+
{
33+
bidder: 'adbookpsp',
34+
params: {
35+
placementId: 'example-placement-id',
36+
orgId: 'example-org-id',
37+
},
38+
},
39+
],
40+
},
41+
];
42+
```
43+
44+
Alternatively, `orgId` can be set globally while configuring prebid.js:
45+
46+
```js
47+
pbjs.setConfig({
48+
adbookpsp: {
49+
orgId: 'example-org-id',
50+
},
51+
});
52+
```
53+
54+
*NOTE*: adUnit orgId will take precedence over the globally set orgId.
55+
56+
#### Banner parameters
57+
58+
Required:
59+
60+
- sizes
61+
62+
Example configuration:
63+
64+
```js
65+
var adUnits = [
66+
{
67+
code: 'div-1',
68+
mediaTypes: {
69+
banner: {
70+
sizes: [[300, 250]],
71+
},
72+
}
73+
},
74+
];
75+
```
76+
77+
#### Video parameters
78+
79+
Required:
80+
81+
- context
82+
- mimes
83+
- playerSize
84+
85+
Additionaly, all `Video` object parameters described in chapter `3.2.7` of the [OpenRTB 2.5 specification](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) can be passed as bidder params.
86+
87+
Example configuration:
88+
89+
```js
90+
var adUnits = [
91+
{
92+
code: 'div-1',
93+
mediaTypes: {
94+
video: {
95+
context: 'outstream',
96+
mimes: ['video/mp4', 'video/x-flv'],
97+
playerSize: [400, 300],
98+
protocols: [2, 3],
99+
},
100+
},
101+
bids: [
102+
{
103+
bidder: 'adbookpsp',
104+
params: {
105+
placementId: 'example-placement-id',
106+
video: {
107+
placement: 2,
108+
},
109+
},
110+
},
111+
],
112+
},
113+
];
114+
```
115+
116+
*NOTE*: Supporting outstream video requires the publisher to set up a renderer as described [in the Prebid docs](https://docs.prebid.org/dev-docs/show-outstream-video-ads.html).
117+
118+
#### Testing params
119+
120+
To test the adapter, either `placementId: 'example-placement-id'` or `orgId: 'example-org-id'` can be used.
121+
122+
*NOTE*: If any adUnit uses the testing params, all adUnits will receive testing responses.
123+
124+
Example adUnit configuration:
125+
126+
```js
127+
var adUnits = [
128+
{
129+
code: 'div-1',
130+
mediaTypes: {
131+
banner: {
132+
sizes: [[300, 250]],
133+
},
134+
},
135+
bids: [
136+
{
137+
bidder: 'adbookpsp',
138+
params: {
139+
placementId: 'example-placement-id',
140+
},
141+
},
142+
],
143+
},
144+
];
145+
```
146+
147+
Example google publisher tag configuration:
148+
149+
```js
150+
googletag
151+
.defineSlot('/22094606581/example-adbookPSP', sizes, 'div-1')
152+
.addService(googletag.pubads());
153+
```
154+
155+
### Configuration
156+
157+
Setting of the `orgId` can be done in the `pbjs.setConfig()` call. If this is the case, both `orgId` and `placementId` become optional. Remember to only call `pbjs.setConfig()` once as each call overwrites anything set in previous calls.
158+
159+
Enabling iframe based user syncs is also encouraged.
160+
161+
```javascript
162+
pbjs.setConfig({
163+
adbookpsp: {
164+
orgId: 'example-org-id',
165+
winTrackingEnabled: true,
166+
},
167+
userSync: {
168+
filterSettings: {
169+
iframe: {
170+
bidders: '*',
171+
filter: 'include',
172+
},
173+
},
174+
},
175+
});
176+
```
177+
178+
### Privacy
179+
180+
GDPR and US Privacy are both supported by default.
181+
182+
#### Event tracking
183+
184+
This adapter tracks win events for it’s bids. This functionality can be disabled by adding `winTrackingEnabled: false` to the adapter configuration:
185+
186+
```js
187+
pbjs.setConfig({
188+
adbookpsp: {
189+
winTrackingEnabled: false,
190+
},
191+
});
192+
```
193+
194+
#### COPPA support
195+
196+
COPPA support can be enabled for all the visitors by changing the config value:
197+
198+
```js
199+
config.setConfig({ coppa: true });
200+
```

‎dev-docs/bidders/adbutler.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ title: AdButler
44
description: Prebid AdButler Bidder Adaptor
55
pbjs: true
66
biddercode: adbutler
7+
pbjs_version_notes: not in 5.x
78
---
89

910

‎dev-docs/bidders/adf.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: bidder
33
title: AdformOpenRTB
4-
description: Prebid Adf Bidder Adaptor
4+
description: Prebid Adform Bidder Adaptor
55
biddercode: adf
66
media_types: banner, native, video
77
gdpr_supported: true
@@ -38,3 +38,7 @@ pbjs.setConfig({
3838
}
3939
});
4040
```
41+
42+
### Multi-format ads
43+
44+
Adform bid adapter does not support multi-format ad unit setup. Please use [twin ad unit codes]({{site.baseurl}}/dev-docs/adunit-reference.html#twin-adunit-codes) to enable multi-format auctions.

‎dev-docs/bidders/adfinity.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ pbjs: true
66
biddercode: adfinity
77
media_types: banner, video, native
88
gdpr_supported: true
9+
pbjs_version_notes: not in 5.x
910
---
1011

1112
### Bid Params

‎dev-docs/bidders/adform.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@ pbjs: true
1111
pbs: true
1212
userIds: britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, sharedId, unifiedId
1313
gvl_id: 50
14+
pbjs_version_notes: not in 5.x
1415
---
1516

17+
**Adform bid adapter is deprecated since Prebid 5.0. Please refer to [AdformOpenRTB adapter](#adf) documentation to fetch bids from Adform demand sources.**
1618

1719
### Bid Params
1820

0 commit comments

Comments
 (0)