Skip to content

Commit

Permalink
Merge branch 'master' into qortex-rtd-md-pr
Browse files Browse the repository at this point in the history
  • Loading branch information
mickannese authored Oct 2, 2023
2 parents 6b330eb + 113e513 commit 55bd980
Show file tree
Hide file tree
Showing 29 changed files with 1,344 additions and 355 deletions.
2 changes: 2 additions & 0 deletions _includes/dev-docs/loads-external-javascript.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
{: .alert.alert-warning :}
Disclosure: This module loads external code that is not open source and has not been reviewed by Prebid.org.
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 dev-docs/bidder-adaptor.md
Original file line number Diff line number Diff line change
Expand Up @@ -1282,7 +1282,7 @@ registerBidder(spec);
* 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.
* If you support the COPPA flag, add `coppa_supported: true`. Default is false.
* If you support the IAB's GPP consent string, add `gpp_supported: true`. Default is false.
* If you support the IAB's GPP consent string, add `gpp_sids` with a comma separated list of section names, e.g. `gpp_sids: tcfeu, tcfca, usnat, usstate_all, usp`. Default is None.
* If you support the [supply chain](/dev-docs/modules/schain.html) feature, add `schain_supported: true`. Default is false.
* If you support passing a demand chain on the response, add `dchain_supported: true`. Default is false.
* If your bidder doesn't work well with safeframed creatives, add `safeframes_ok: false`. This will alert publishers to not use safeframed creatives when creating the ad server entries for your bidder. No default value.
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/acuityads.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ tcfeu_supported: true
usp_supported: true
coppa_supported: true
schain_supported: true
gpp_supported: true
userId: britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId
media_types: banner, video, native
safeframes_ok: true
Expand Down
2 changes: 2 additions & 0 deletions dev-docs/bidders/adliveconnect.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ multiformat_supported: will-bid-on-one
floors_supported: true
aliasCode: adkernel
sidebarType: 1
enable_download: false
pbjs_version_notes: removed in 8.14
---

### Note
Expand Down
27 changes: 27 additions & 0 deletions dev-docs/bidders/c1x.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
layout: bidder
title: C1X
description: Prebid C1X Bidder Adaptor
pbs: false
pbjs: true
biddercode: c1x
media_types: banner
tcfeu_supported: false
pbs_app_supported: false
enable_download: true
---

### Note

The C1X Header Bidding adaptor requires approval from the C1X team. Please reach out to <header-bidding@c1exchange.com> for more information.

### Bid params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|----------------|----------|-----------------------------------------------------------------|-------------------------------------|----------|
| `placementId` | required | Placement ID | `'12345'` | `string` |
| `siteId` | required | Site ID from which the request is originating | `'999'` | `string` |
| `dealId` | optional | Deal ID to get the specific deal from our DSP | `'123456'` | `string` |
| `floorPriceMap`| optional | Minimum floor prices needed from the DSP's to enter the auction | `{"300x250": 4.00,"300x600": 3.00}` | `object` |
| `pageurl` | optional | Url of the webpage where the request is originating from | `'www.example.com'` | `string` |
1 change: 1 addition & 0 deletions dev-docs/bidders/concert.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ media_types: banner
tcfeu_supported: false
usp_supported: true
gpp_supported: true
userIds: sharedId, unifiedId, uid2
sidebarType: 1
---

Expand Down
70 changes: 70 additions & 0 deletions dev-docs/bidders/illumin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
layout: bidder
title: Illumin
description: Prebid Illumin Bidder Adaptor
biddercode: illumin
filename: illuminBidAdapter
userIds: britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId
tcfeu_supported: true
usp_supported: true
coppa_supported: false
schain_supported: true
gpp_supported: true
floors_supported: true
media_types: banner, video
prebid_member: false
safeframes_ok: false
deals_supported: false
pbs_app_supported: false
fpd_supported: false
ortb_blocking_supported: false
multiformat_supported: will-bid-on-one
pbjs: true
sidebarType: 1
---

### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|------------|----------|-------------------------------------------------------------------------------------------|------------------------------|----------|
| `cId` | required | The connection ID from Illumin. | `'562524b21b1c1f08117fc7f9'` | `string` |
| `pId` | required | The publisher ID from Illumin. | `'59ac17c192832d0011283fe3'` | `string` |
| `bidFloor` | optional | The minimum bid value desired. Illumin will not respond with bids lower than this value. | `0.90` | `float` |

## Example

```javascript
var adUnits = [{
code: 'banner-div',
mediaTypes: {
banner: {
sizes: [
[300, 250],
[728, 90]
]
}
},
bids: [{
bidder: 'illumin',
params: {
cId: '562524b21b1c1f08117fc7f9', // Required - PROVIDED DURING SETUP...
pId: '59ac17c192832d0011283fe3', // Required - PROVIDED DURING SETUP...
bidFloor: 1.23 // Optional
}
}]
}
];

// configure pbjs to enable user syncing
pbjs.setConfig({
userSync: {
filterSettings: {
iframe: {
bidders: 'illumin',
filter: 'include'
}
}
}
});
```
1 change: 1 addition & 0 deletions dev-docs/bidders/incrementx.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ biddercode: incrementx
media_types: banner
tcfeu_supported: false
multiformat_supported: will-bid-on-one
filename: incrxBidAdapter
sidebarType: 1
---

Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/integr8.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@ sidebarType: 1
|---------------|----------|------------------------------------------------------------------------|--------------------|-----------|
| `propertyId` | required |Property id | `"12345"` | `string` |
| `placementId` | required |Placement id | `"54321"` | `string` |
| `deliveryUrl` | optional |Custom endpoint url for the bid request | `"https://central.sea.integr8.digital/bid"` | `string` |
| `data` | optional |Catalog data (contents) and/or inventory data (custom key/value pairs) | `{catalogs: [{ catalogId: "699229", items: ["193", "4", "1"] }], inventory: { category: ["tech"], query: ["iphone 12"] }}` | `object` |
1 change: 1 addition & 0 deletions dev-docs/bidders/mobfoxpb.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ tcfeu_supported: true
pbjs: true
pbs: true
pbs_app_supported: true
gpp_supported: true
gvl_id: 311
enable_download: true
sidebarType: 1
Expand Down
6 changes: 3 additions & 3 deletions dev-docs/bidders/viant.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ tcfeu_supported: false
coppa_supported: true
usp_supported: true
gpp_supported: false
schain_supported: false
schain_supported: true
userId: uid2, unifiedId
pbjs: true
prebid_member: false
prebid_member: true
dchain_supported: false
safeframes_ok: false
deals_supported: true
Expand All @@ -26,7 +26,7 @@ sidebarType: 1

### Registration

If you have any questions regarding set up, please reach out to <dist-runtime@viantinc.com>.
If you have any questions regarding set up, please reach out to <Marketplace@adelphic.com>.

#### Bid Params

Expand Down
3 changes: 1 addition & 2 deletions dev-docs/modules/a1MediaRtdProvider.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ sidebarType : 1

# A1Media RTD Module

{: .alert.alert-warning :}
Disclosure: This module loads external code that is not open source and has not been reviewed by Prebid.org.
{% include dev-docs/loads-external-javascript.md %}

The A1Media RTD module loads a script for obtaining A1Media user segments, providing the user segment data to bid-requests.

Expand Down
3 changes: 1 addition & 2 deletions dev-docs/modules/aaxBlockmeterRtdProvider.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ The module enables publishers with an AAX relationship to measure traffic coming

AAX can also help publishers monetize this traffic by allowing them to serve [acceptable ads](https://acceptableads.com/about/) to these adblock visitors and recover their lost revenue. [Reach out to us](https://www.aax.media/try-blockmeter/) to know more.

{: .alert.alert-warning :}
Disclosure: This module loads external code that is not open source and has not been reviewed by Prebid.org.
{% include dev-docs/loads-external-javascript.md %}

## Configuration

Expand Down
3 changes: 1 addition & 2 deletions dev-docs/modules/arcspanRtdProvider.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ sidebarType : 1

ArcSpan is a real-time audience monetization platform focused on the needs of the world’s finest publishers and retailers. Unlock the true value of your first-party audience data while providing advertisers the targeting performance they need.

{: .alert.alert-warning :}
Disclosure: This module loads external code that is not open source and has not been reviewed by Prebid.org.
{% include dev-docs/loads-external-javascript.md %}

### Usage

Expand Down
11 changes: 7 additions & 4 deletions dev-docs/modules/gdprEnforcement.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ sidebarType : 1
---

# GDPR Enforcement Module

{: .no_toc }

* TOC
Expand Down Expand Up @@ -49,7 +48,7 @@ The following table details the Prebid.js activities that fall under the [Transp
| Read and write data to device | Purpose 1 - Store and/or access information on a device | May prevent one or more adapters or modules from being able to read or write cookies or localstorage in the user's browser. | 3.14+ |
| Perform header bidding auction | Purpose 2 - Basic ads | May prevent one or more bid adapters from participating in the auction. | 4.0+ |
| Transmit user first party data to partners | Purpose 4 - Personalized ads | May prevent one or more modules from receiving user first party data | 8.16+ |
| Transmit user IDs to partners | Depends on configuration (see [note](#note-transmitEids))| May prevent one or more modules from receiving user IDs | 8.16+ |
| Transmit Extended User IDs to partners | Depends on configuration (see [note](#note-transmitEids))| May prevent one or more modules from receiving user IDs and EIDs. | 8.16+ |
| Invoke analytics adapters | Purpose 7 - Measurement | May prevent one or more analytics adapters from participating in the auction. | 4.x+ |
| Transmit precise geolocation data to partners | Specal Feature 1 - Use precise geolocation data | May cause geolocation data to be truncated for one or more modules | 8.16+ |

Expand Down Expand Up @@ -77,6 +76,7 @@ The following fields related to GDPR enforcement are supported in the [`consentM
| gdpr.rules[].enforceVendor | `Boolean` | Determines whether to enforce vendor signals for this purpose. The default in Prebid.js 3.x is not to enforce vendor signals. Prebid.js 4.0 enforces legal basis for Purposes 1 and 2 by default. | true |
| gdpr.rules[].vendorExceptions | `Array of Strings` | Defines a list of biddercodes or module names that are exempt from the enforcement of this Purpose. | ["bidderA", "userID-module-B"] |
| gdpr.rules[].softVendorExceptions | `Array of Strings` | Defines a list of biddercodes or module names that are exempt from the enforcement of vendor signals for this purpose. Unlike with `vendorExceptions`, Purpose consent is still enforced . | ["bidderA", "userID-module-B"] |
| gdpr.rules[].eidsRequireP4Consent | `Boolean` | Only relevant on the personalizedAds `purpose`. If true, user IDs and EIDs will not be shared without evidence of consent for TCF Purpose 4. If false, evidence of consent for any of Purposes 2-10 is sufficient for sharing user IDs and EIDs. Defaults to false. See [note](#note-transmitEids) | true |
| strictStorageEnforcement | `Boolean` | If false (the default), allows some use of storage regardless of purpose 1 consent - see [note](#strictStorageEnforcement) below | true |

Notes:
Expand Down Expand Up @@ -206,9 +206,12 @@ See the [IAB TCF Consent String Format](https://github.com/InteractiveAdvertisin

<a id="note-transmitEids"></a>

### Note on user IDs
### Note on Extended User IDs

{: .alert.alert-info :}
Note: the default of the eidsRequireP4Consent flag may change from false to true in a future major release.

By default, sending user IDs to bid adapters or RTD modules (the `transmitEids` activity) is not tied to a single TCF Purpose; instead it is allowed if one of these scenario is true:
By default, sending user IDs and EIDs to bid adapters or RTD modules (the `transmitEids` activity) is not tied to a single TCF Purpose; instead it is allowed if one of these scenarios is true:

* We have evidence of consent for the vendor and evidence of consent for _any_ purpose between 2 and 10;
* We have evidence of consent for any purpose between 2 and 10, and the vendor is excepted through `softVendorException` in at least one of: `basicAds`, `personalizedAds`, or `measurement`;
Expand Down
3 changes: 1 addition & 2 deletions dev-docs/modules/geoedgeRtdProvider.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ sidebarType : 1
The Geoedge Realtime module lets publishers block bad ads such as automatic redirects, malware, offensive creatives and landing pages.
To use this module, you'll need to work with [Geoedge](https://www.geoedge.com/publishers-real-time-protection/) to get an account and cutomer key.

{: .alert.alert-warning :}
Disclosure: This module loads external code that is not open source and has not been reviewed by Prebid.org.
{% include dev-docs/loads-external-javascript.md %}

## Integration

Expand Down
3 changes: 1 addition & 2 deletions dev-docs/modules/medianetRtdProvider.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@ The module currently provisions Media.net's Intelligent Refresh configured by th

Intelligent Refresh (IR) module lets publisher refresh their ad inventory without affecting page experience of visitors through configured criteria. The module optionally provides tracking of refresh inventory and appropriate targeting in GAM. Publisher configured criteria is fetched via an external JS payload.

{: .alert.alert-warning :}
Disclosure: This module loads external code that is not open source and has not been reviewed by Prebid.org.
{% include dev-docs/loads-external-javascript.md %}

## Configuration

Expand Down
29 changes: 29 additions & 0 deletions dev-docs/publisher-api-reference/setConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ Core config:
* [Turn on send all bids mode](#setConfig-Send-All-Bids)
* [Configure send bids control](#setConfig-Send-Bids-Control)
* [Bid cache](#setConfig-Use-Bid-Cache)
* [Minimum bid cache TTL](#setConfig-minBidCacheTTL)
* [Event history TTL](#setConfig-eventHistoryTTL)
* [Set the order in which bidders are called](#setConfig-Bidder-Order)
* [Set the page URL](#setConfig-Page-URL)
* [Set price granularity](#setConfig-Price-Granularity)
Expand Down Expand Up @@ -279,6 +281,33 @@ pbjs.setConfig({
});
```

#### Minimum bid cache TTL

<a id="setConfig-minBidCacheTTL"></a>

By default, Prebid keeps every bid it receives stored in memory until the user leaves the page. This can cause high memory usage on long-running single-page apps; you can configure Prebid to drop stale bids from memory with `minBidCacheTTL`:

```javascript
pbjs.setConfig({
minBidCacheTTL: 60 // minimum time (in seconds) that bids should be kept in cache
})
```

When set, bids are only kept in memory for the duration of their TTL or the value of `minBidCacheTTL`, whichever is greater. Setting `minBidCacheTTL: 0` causes bids to be dropped as soon as they expire.

#### Event history TTL

<a id="setConfig-eventHistoryTTL"></a>

By default, Prebid keeps in memory a log of every event since the initial page load, and makes it available to analytics adapters and [getEvents()](/dev-docs/publisher-api-reference/getEvents.html).
This can cause high memory usage on long-running single-page apps; you can set a limit on how long events are preserved with `eventHistoryTTL`:

```javascript
pbjs.setConfig({
eventHistoryTTL: 60 // maximum time (in seconds) that events should be kept in memory
})
```

#### Bidder Order

Set the order in which bidders are called:
Expand Down
Loading

0 comments on commit 55bd980

Please sign in to comment.