diff --git a/adops/adops-general-sbs.md b/adops/adops-general-sbs.md index 369b71de20..f69680a77d 100644 --- a/adops/adops-general-sbs.md +++ b/adops/adops-general-sbs.md @@ -106,7 +106,7 @@ For example, for a line item with a $10.00 CPM as the price, a competitive exclu For deals, the price bucket portion of this value will contain the dealID if deals are prioritized. See [Getting Started with Long Form Video](/prebid-video/video-long-form.html#configuration) for more information. {: .alert.alert-info :} -Engineers will need to include the [Adpod module](/dev-docs/modules/adpod.html) and the [Category Translation module](/dev-docs/modules/categoryTranslation.html) in Prebid.js to implement long-form video bidding. +Ad pod (long-form) video support was removed in Prebid.js 11.0. With Prebid.js 10.x and earlier, engineers will need to include the [Adpod module](/dev-docs/modules/adpod.html) and the [Category Translation module](/dev-docs/modules/categoryTranslation.html) in Prebid.js to implement long-form video bidding. ### Creative-level Targeting diff --git a/adops/setting-up-prebid-video-in-freewheel.md b/adops/setting-up-prebid-video-in-freewheel.md index a0a9ade18e..1743f12b54 100644 --- a/adops/setting-up-prebid-video-in-freewheel.md +++ b/adops/setting-up-prebid-video-in-freewheel.md @@ -8,6 +8,9 @@ sidebarType: 3 # FreeWheel Guide for Premium Long-Form Video +{: .alert.alert-warning :} +The Prebid.js FreeWheel and ad pod (long-form) modules were removed in Prebid.js 11.0. This guide applies to Prebid.js 10.x and earlier only. + {: .alert.alert-warning :} This guide is not written, maintained, or endorsed by Freewheel. Freewheel recommends speaking to your account team before implementing any header-bidding setup to ensure full implications for direct-sold ad delivery, forecasting, and reporting is understood. diff --git a/adops/step-by-step.md b/adops/step-by-step.md index 34c0b941a5..f691853af7 100644 --- a/adops/step-by-step.md +++ b/adops/step-by-step.md @@ -176,7 +176,7 @@ For example, for a line item with a $10.00 CPM entered in the Rate field, a Labe For deals, the Rate portion of this value will contain the dealID if deals are prioritized. See [Getting Started with Long Form Video](/prebid-video/video-long-form.html#configuration) for engineering information. {: .alert.alert-info :} -Engineers will need to include the [Adpod module](/dev-docs/modules/adpod.html) and the [Category Translation module](/dev-docs/modules/categoryTranslation.html) in Prebid.js to implement long-form video bidding. (Prebid.js 10.x and earlier; Adpod support was removed in Prebid.js 11.) +Ad pod (long-form) video support was removed in Prebid.js 11.0. With Prebid.js 10.x and earlier, engineers will need to include the [Adpod module](/dev-docs/modules/adpod.html) and the [Category Translation module](/dev-docs/modules/categoryTranslation.html) in Prebid.js to implement long-form video bidding. ### Creative-level Targeting diff --git a/dev-docs/adunit-reference.md b/dev-docs/adunit-reference.md index 4d9cdc6d69..827d70da55 100644 --- a/dev-docs/adunit-reference.md +++ b/dev-docs/adunit-reference.md @@ -755,7 +755,7 @@ pbjs.addAdUnits({ * [Show Native Ads](/prebid/native-implementation.html) * [Show Video Ads](/dev-docs/show-video-with-a-dfp-video-tag.html) * [Show Outstream Video Ads](/dev-docs/show-outstream-video-ads.html) -* [Show Long-Form Video Ads](/prebid-video/video-long-form.html) +* [Show Long-Form Video Ads](/prebid-video/video-long-form.html) (removed in Prebid.js 11.0) * [Prebid.org Video Examples](/examples/video/) * [Prebid.org Native Examples](/dev-docs//examples/native-ad-example.html) diff --git a/dev-docs/bidder-adaptor.md b/dev-docs/bidder-adaptor.md index 307fb83340..d65c58171c 100644 --- a/dev-docs/bidder-adaptor.md +++ b/dev-docs/bidder-adaptor.md @@ -922,7 +922,7 @@ For examples of video parameters accepted by different adapters, see [the list o #### Ingesting the Video Context -Video ad units have a publisher-defined video context, which can be either `'instream'` or `'outstream'` or `'adpod'`. Video demand partners can choose to ingest this signal for targeting purposes. For example, the ad unit shown below has the outstream video context: +Video ad units have a publisher-defined video context, which can be either `'instream'` or `'outstream'`. Video demand partners can choose to ingest this signal for targeting purposes. For example, the ad unit shown below has the outstream video context: ```javascript ... @@ -954,152 +954,8 @@ if (bid.mediaType === 'video' || (videoMediaType && context !== 'outstream')) { #### Long-Form Video Content -{: .alert.alert-info :} -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. Microsoft adapter follows below algorithm to expand its placement. - -#### Use case 1: I want to request my endpoint to return bids with varying ranges of durations - -```text -AdUnit config -{ - ... - adPodDuration: 300, - durationRangeSec: [15, 30] - ... -} - -Algorithm -# of placements = adPodDuration / MIN_VALUE(durationRangeSec) - -Each placement set max duration: -placement.video.maxduration = MAX_VALUE(durationRangeSec) - -Example: -# of placements : 300 / 15 = 20. -placement.video.maxduration = 30 (all placements the same) - -Your endpoint responds with: -10 bids with 30 seconds duration -10 bids with 15 seconds duration -``` - -In Use case 1, you are asking endpoint to respond with 20 bids between min duration 0 and max duration 30 seconds. If you get bids with duration which does not match duration in `durationRangeSec` array, Prebid will evaluate the bid's duration and will match into the appropriate duration bucket by using a rounding-type logic. This new duration will be used in sending bids to Ad server. - -Prebid creates virtual duration buckets based on `durationRangeSec` value. Prebid will - -* round the duration to the next highest specified duration value based on adunit. If the duration is above a range within a set buffer (hardcoded to 2s in prebid-core), that bid falls down into that bucket. (eg if `durationRangeSec` was [5, 15, 30] -> 2s is rounded to 5s; 17s is rounded back to 15s; 18s is rounded up to 30s) -* reject bid if the bid is above the range of the listed durations (and outside the buffer) - -Prebid will set the rounded duration value in the `bid.video.durationBucket` field for accepted bids - -#### Use case 2: I want to request my endpoint to return bids that exactly match the durations I want - -```text -AdUnit config -{ - ... - adPodDuration: 300, - durationRangeSec: [15, 30], - requireExactDuration: true - ... -} - -Algorithm -# of placements = MAX_VALUE(adPodDuration/MIN_VALUE(allowedDurationsSec), durationRangeSec.length) - -Each placement: -placement.video.minduration = durationRangeSec[i] -placement.video.maxduration = durationRangeSec[i] - -Example: -# of placements : MAX_VALUE( (300 / 15 = 20), 2) == 20 - -20 / 2 = 10 placements: -placement.video.minduration = 15 -placement.video.maxduration = 15 - -20 / 2 = 10 placements: -placement.video.minduration = 30 -placement.video.maxduration = 30 - -Your endpoint responds with: -10 bids with 30 seconds duration -10 bids with 15 seconds duration -``` - -In Use case 2 `requireExactDuration` is set to true and hence Prebid will only select bids that exactly match duration in `durationRangeSec` (don't round at all). - -In both use cases, adapter is requesting bid responses for 20 placements in one single http request. You can split these into chunks depending on your endpoint's capacity. - -Adapter must add following new properties to bid response - -```javascript -{ - meta: { - primaryCatId: '', // only needed if you want to ensure competitive separation - }, - video: { - context: 'adpod', - durationSeconds: 30 - } -} -``` - -Microsoft Adapter uses the approach explained above. You can see an example in the [Microsoft adapter](https://github.com/prebid/Prebid.js/blob/master/modules/msftBidAdapter.js) - -Adapter must return one [IAB accepted subcategories](https://iabtechlab.com/wp-content/uploads/2017/11/IAB_Tech_Lab_Content_Taxonomy_V2_Final_2017-11.xlsx) (links to MS Excel file) if they want to support competitive separation. These IAB sub categories will be converted to Ad server industry/group. If adapter is returning their own proprietary categroy, it is the responsibility of the adapter to convert their categories into [IAB accepted subcategories](https://iabtechlab.com/wp-content/uploads/2017/11/IAB_Tech_Lab_Content_Taxonomy_V2_Final_2017-11.xlsx) (links to MS Excel file). - -If the demand partner is going to use Prebid API for this process, their adapter will need to include the `getMappingFileInfo` function in their spec file. Prebid core will use the information returned from the function to preload the mapping file in local storage and update on the specified refresh cycle. - -**Params** - -{: .table .table-bordered .table-striped } - -| Key | Scope | Description | Example | -| --- | --- | --- | --- | -| `url` | Required | The URL to the mapping file. | `"//example.com/mapping.json"` | -| `refreshInDays` | Optional | A number representing the number of days before the mapping values are updated. Default value is 1 | `7` | -| `localStorageKey` | Optional | A unique key to store the mapping file in local storage. Default value is bidder code. | `"uniqueKey"` | - -**Example** - -```javascript -getMappingFileInfo: function() { - return { - url: '', - refreshInDays: 7 - localStorageKey: '' - } -} -``` - -The mapping file is stored locally to expedite category conversion. Depending on the size of the adpod each adapter could have 20-30 bids. Storing the mapping file locally will prevent HTTP calls being made for each category conversion. - -To get the subcategory to use, call this function, which needs to be imported from the `bidderFactory`. - -```javascript -getIabSubCategory(bidderCode, pCategory) -``` - -**Params** - -{: .table .table-bordered .table-striped } - -| Key | Scope | Description | Example | -|--------------|----------|-----------------------------------------------|-----------------------| -| `bidderCode` | Required | BIDDER_CODE defined in spec. | `"sample-biddercode"` | -| `pCategory` | Required | Proprietary category returned in bid response | `"sample-category"` | - -**Example** - -```javascript - -import { getIabSubCategory } from '../src/adapters/bidderFactory'; -let primaryCatId = getIabSubCategory(bidderCode, pCategory) - -``` +{: .alert.alert-warning :} +Ad pod (long-form) video support, including the `adpod` video context, category translation (`getMappingFileInfo`, `getIabSubCategory`), and duration buckets, was removed in Prebid.js 11.0. #### Outstream Video Renderers @@ -1132,10 +988,6 @@ function createBid(status, reqBid, response) { ``` -### Deals in Ad Pods - -To do deals for long-form video (`adpod` ad unit) just add the `dielTier` integer value to `bid.video.dealTier`. For more details on conducting deals in ad pods see our [ad pod module documentation](/dev-docs/modules/adpod.html). - ## Supporting Native In order for your bidder to support the native media type: diff --git a/dev-docs/bidders/optable.md b/dev-docs/bidders/optable.md index cfb211182d..f18bc87467 100644 --- a/dev-docs/bidders/optable.md +++ b/dev-docs/bidders/optable.md @@ -4,6 +4,7 @@ title: Optable description: Prebid Optable Bidder Adapter biddercode: optable pbjs: true +enable_download: false pbjs_version_notes: removed in 11.0 privacy_sandbox: paapi prebid_member: true @@ -14,16 +15,16 @@ sidebarType: 1 If you have any questions regarding set up, please reach out to your account manager or . -### Bid Parameters +## Bid Parameters -#### Banner +### Banner {: .table .table-bordered .table-striped } | Name | Scope | Description | Example | Type | | ---- | ----- | ----------- | ------- | ---- | | `site` | required | Optable site ID provided by your Optable representative. | "aaaaaaaa" | String | -### AdUnit Format for Banner +## AdUnit Format for Banner ```javascript var adUnits = [ diff --git a/dev-docs/bidders/ringieraxelspringer.md b/dev-docs/bidders/ringieraxelspringer.md index d4400cc2e9..fdd6b01c3e 100644 --- a/dev-docs/bidders/ringieraxelspringer.md +++ b/dev-docs/bidders/ringieraxelspringer.md @@ -6,6 +6,8 @@ biddercode: ringieraxelspringer aliasCode: das media_types: banner, native pbjs: true +enable_download: false +pbjs_version_notes: removed in 11.0 pbs: false prebid_member: false gvl_id: 1021 @@ -26,20 +28,20 @@ coppa_supported: false usp_supported: false --- -### Bid Params +## Bid Params {: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | -|------------------|----------|------------------------------------------------------------------------------------------------------|---------------------------------------------|----------| -| `network` | required | Specific identifier provided by RAS | `'4178463'` | `string` | -| `site` | required | Specific identifier name (case-insensitive) that is associated with this ad unit and provided by RAS | `'example_com'` | `string` | -| `area` | required | Ad unit category name; only case-insensitive alphanumeric with underscores and hyphens are allowed | `'sport'` | `string` | -| `slot` | required | Ad unit placement name (case-insensitive) provided by RAS | `'slot'` | `string` | -| `pageContext` | optional | Web page context data | `{}` | `object` | -| `pageContext.dr` | optional | Document referrer URL address | `'https://example.com/'` | `string` | -| `pageContext.du` | optional | Document URL address | `'https://example.com/sport/football/article.html?id=932016a5-02fc-4d5c-b643-fafc2f270f06'` | `string` | -| `pageContext.dv` | optional | Document virtual address as slash-separated path that may consist of any number of parts (case-insensitive alphanumeric with underscores and hyphens); first part should be the same as `site` value and second as `area` value; next parts may reflect website navigation | `'example_com/sport/football'` | `string` | +| Name | Scope | Description | Example | Type | +| --- | --- | --- | --- | --- | +| `network` | required | Specific identifier provided by RAS | `'4178463'` | `string` | +| `site` | required | Specific identifier name (case-insensitive) that is associated with this ad unit and provided by RAS | `'example_com'` | `string` | +| `area` | required | Ad unit category name; only case-insensitive alphanumeric with underscores and hyphens are allowed | `'sport'` | `string` | +| `slot` | required | Ad unit placement name (case-insensitive) provided by RAS | `'slot'` | `string` | +| `pageContext` | optional | Web page context data | `{}` | `object` | +| `pageContext.dr` | optional | Document referrer URL address | `'https://example.com/'` | `string` | +| `pageContext.du` | optional | Document URL address | `'https://example.com/sport/football/article.html?id=932016a5-02fc-4d5c-b643-fafc2f270f06'` | `string` | +| `pageContext.dv` | optional | Document virtual address as slash-separated path that may consist of any number of parts (case-insensitive alphanumeric with underscores and hyphens); first part should be the same as `site` value and second as `area` value; next parts may reflect website navigation | `'example_com/sport/football'` | `string` | | `pageContext.keyWords` | optional | List of keywords associated with this ad unit; only case-insensitive alphanumeric with underscores and hyphens are allowed | `['euro', 'lewandowski']` | `string[]` | -| `pageContext.keyValues` | optional | Key-values associated with this ad unit (case-insensitive); following characters are not allowed in the values: `" ' = ! + # * ~ ; ^ ( ) < > ] [ & @` | `{}` | `object` | -| `pageContext.keyValues.ci` | optional | Content unique identifier | `'932016a5-02fc-4d5c-b643-fafc2f270f06'` | `object` | -| `pageContext.keyValues.adunit` | optional | Ad unit name | `'example_com/sport'` | `string` | +| `pageContext.keyValues` | optional | Key-values associated with this ad unit (case-insensitive); following characters are not allowed in the values: `" ' = ! + # * ~ ; ^ ( ) < > ] [ & @` | `{}` | `object` | +| `pageContext.keyValues.ci` | optional | Content unique identifier | `'932016a5-02fc-4d5c-b643-fafc2f270f06'` | `object` | +| `pageContext.keyValues.adunit` | optional | Ad unit name | `'example_com/sport'` | `string` | diff --git a/dev-docs/modules/adpod.md b/dev-docs/modules/adpod.md index f7a5635dc1..d13fcadef3 100644 --- a/dev-docs/modules/adpod.md +++ b/dev-docs/modules/adpod.md @@ -5,7 +5,8 @@ title: Module - Adpod description: Enables developers to add support for a new adserver that handles ad pod (long-form) videos. module_code : adpod display_name : Adpod -enable_download : true +enable_download : false +pbjs_version_notes: removed in 11.0 sidebarType : 1 --- @@ -13,7 +14,7 @@ sidebarType : 1 {:.no_toc} {: .alert.alert-warning :} -This module was removed in Prebid.js 11.0. See the [Prebid.js 11 release notes](/dev-docs/pb11-notes.html#removed-modules). +The Adpod module was removed in Prebid.js 11.0. Ad pod (long-form) video is no longer supported by Prebid.js. * TOC {:toc} diff --git a/dev-docs/modules/categoryTranslation.md b/dev-docs/modules/categoryTranslation.md index 7a2a8fbe2e..eb4f594022 100644 --- a/dev-docs/modules/categoryTranslation.md +++ b/dev-docs/modules/categoryTranslation.md @@ -5,7 +5,8 @@ title: Module - Category Translation description: Converts IAB category to ad server category for long-form videos. module_code : categoryTranslation display_name : CategoryTranslation -enable_download : true +enable_download : false +pbjs_version_notes: removed in 11.0 sidebarType : 1 --- @@ -13,7 +14,7 @@ sidebarType : 1 {:.no_toc} {: .alert.alert-warning :} -This module was removed in Prebid.js 11.0. See the [Prebid.js 11 release notes](/dev-docs/pb11-notes.html#removed-modules). +The Category Translation module was removed in Prebid.js 11.0 along with ad pod (long-form) video support. This module converts the IAB sub category to Ad server industry group identifiers. The identifiers ensure competitive separation of industries and products. diff --git a/dev-docs/modules/dfpAdpod.md b/dev-docs/modules/dfpAdpod.md index 8d896ac66e..df02de6508 100644 --- a/dev-docs/modules/dfpAdpod.md +++ b/dev-docs/modules/dfpAdpod.md @@ -5,7 +5,8 @@ title: Module - Google Ad Manager Adpod Support description: Required for serving adpod video through Google Ad Manager. module_code : dfpAdpod display_name : Google Ad Manager Adpod Support -enable_download : true +enable_download : false +pbjs_version_notes: removed in 11.0 vendor_specific: true sidebarType : 1 --- @@ -17,6 +18,9 @@ This module was removed in Prebid.js 11.0. See the [Prebid.js 11 release notes]( {:.no_toc} +{: .alert.alert-warning :} +The Google Ad Manager Adpod module was removed in Prebid.js 11.0 along with ad pod (long-form) video support. + This module exposes the [`pbjs.adServers.dfp.buildAdpodVideoUrl](/dev-docs/publisher-api-reference/adServers.gam.buildAdpodVideoUrl.html) method, required to use [adpod](/dev-docs/modules/adpod.html) with Google Ad Manager. ## Further Reading diff --git a/dev-docs/modules/dfp_express.md b/dev-docs/modules/dfp_express.md index 13ca288169..7884c9bba3 100644 --- a/dev-docs/modules/dfp_express.md +++ b/dev-docs/modules/dfp_express.md @@ -5,7 +5,8 @@ title: Module - Google Ad Manager Express description: A simplified installation mechanism for publishers that have Google Publisher Tag (GPT) ad calls in their pages. module_code : express display_name : Google Ad Manager Express -enable_download : true +enable_download : false +pbjs_version_notes: removed in 11.0 vendor_specific: true sidebarType : 1 --- @@ -19,6 +20,9 @@ This module was removed in Prebid.js 11.0. See the [Prebid.js 11 release notes]( {:.no_toc} +{: .alert.alert-warning :} +The Google Ad Manager Express module was removed in Prebid.js 11.0. + This module is a simplified alternate installation mechanism for publishers that have Google Publisher Tag (GPT) ad calls in their pages. Here's how it works: * You build a Prebid.js package that contains the extra module code and optionally the page's AdUnits. diff --git a/dev-docs/modules/freewheel.md b/dev-docs/modules/freewheel.md index e017c09fd8..37dac71c8d 100644 --- a/dev-docs/modules/freewheel.md +++ b/dev-docs/modules/freewheel.md @@ -5,7 +5,8 @@ title: Module - Freewheel description: Passes key value targeting to Freewheel SDK for adpod mediaType adUnits. module_code : freeWheelAdserverVideo display_name : Freewheel Video Support -enable_download : true +enable_download : false +pbjs_version_notes: removed in 11.0 vendor_specific: true sidebarType : 1 --- @@ -13,7 +14,7 @@ sidebarType : 1 # Freewheel Module {: .alert.alert-warning :} -This module was removed in Prebid.js 11.0. See the [Prebid.js 11 release notes](/dev-docs/pb11-notes.html#removed-modules). +The Freewheel Video Support module (freeWheelAdserverVideo) was removed in Prebid.js 11.0 along with ad pod (long-form) video support. This module returns the targeting key value pairs for the FreeWheel ad server. diff --git a/dev-docs/modules/intersectionRtdProvider.md b/dev-docs/modules/intersectionRtdProvider.md index 2de5118284..aa6672c2f2 100644 --- a/dev-docs/modules/intersectionRtdProvider.md +++ b/dev-docs/modules/intersectionRtdProvider.md @@ -7,7 +7,8 @@ description: Real Time Intersection page_type: module module_type: rtd module_code : intersectionRtdProvider -enable_download : true +enable_download : false +pbjs_version_notes: removed in 11.0 sidebarType : 1 --- @@ -15,7 +16,7 @@ sidebarType : 1 {:.no_toc} {: .alert.alert-warning :} -This module was removed in Prebid.js 11.0. See the [Prebid.js 11 release notes](/dev-docs/pb11-notes.html#removed-modules). +The Intersection RTD module was removed in Prebid.js 11.0. * TOC {:toc} diff --git a/dev-docs/modules/paapi.md b/dev-docs/modules/paapi.md index 5f4c001178..fde613092a 100644 --- a/dev-docs/modules/paapi.md +++ b/dev-docs/modules/paapi.md @@ -5,14 +5,15 @@ title: Module - PAAPI description: Protected Audience API module_code : paapi display_name : PAAPI -enable_download : true +enable_download : false +pbjs_version_notes: removed in 11.0 sidebarType : 1 --- # PAAPI module {: .alert.alert-warning :} -This module was removed in Prebid.js 11.0. See the [Prebid.js 11 release notes](/dev-docs/pb11-notes.html#removed-modules). +The PAAPI module was removed in Prebid.js 11.0. Prebid.js no longer supports the Protected Audience API. This module allows Prebid.js to support PAAPI, formerly known as [FLEDGE](https://github.com/WICG/turtledove/blob/main/FLEDGE.md). @@ -89,7 +90,7 @@ adunit. This attribute will take precedence over `defaultForSlots` setting. | ortb2Imp.ext.ae | Integer | Auction Environment: 1 indicates PAAPI eligible, 0 indicates it is not | Absence indicates this is not PAAPI eligible | The `ae` field stands for Auction Environment and was chosen to be consistent with the field that GAM passes to bidders -in their Open Bidding and Exchange Bidding APIs. More details on that can be found in the +in their Open Bidding and Exchange Bidding APIs. More details are in the [FLEDGE RTB proposal](https://github.com/google/ads-privacy/tree/master/proposals/fledge-rtb#bid-request-changes-indicating-interest-group-auction-support) In practice, this looks as follows: @@ -123,7 +124,7 @@ Chrome has enabled a two-tier auction in PAAPI. This allows multiple sellers (fr a single entity serving as the final decision maker. In their [current approach](https://github.com/google/ads-privacy/tree/master/proposals/fledge-multiple-seller-testing), GPT has opted to run the final auction layer while allowing other SSPs/sellers to participate as [Component Auctions](https://github.com/WICG/turtledove/blob/main/FLEDGE.md#21-initiating-an-on-device-auction) which feed their -bids to the final layer. To learn more, see [Component Auctions in the FLEDGE explainer](https://github.com/WICG/turtledove/blob/main/FLEDGE.md#24-scoring-bids-in-component-auctions). +bids to the final layer. To learn more, see [scoring bids in component auctions](https://github.com/WICG/turtledove/blob/main/FLEDGE.md#24-scoring-bids-in-component-auctions). The PAAPI auction, including Component Auctions, are configured via an `AuctionConfig` object that defines the parameters of the auction for a given seller. This module enables PAAPI support by allowing bid adaptors to return `AuctionConfig` objects in addition to bids. If a bid adaptor returns an diff --git a/dev-docs/modules/paapiForGpt.md b/dev-docs/modules/paapiForGpt.md index 8200102c55..c99d3df1f9 100644 --- a/dev-docs/modules/paapiForGpt.md +++ b/dev-docs/modules/paapiForGpt.md @@ -7,14 +7,15 @@ title: Module - paapiForGpt description: how to use PAAPI with GPT module_code : paapiForGpt display_name : Fledge (PAAPI) for GPT -enable_download : true +enable_download : false +pbjs_version_notes: removed in 11.0 sidebarType : 1 --- # Protected Audience API (PAAPI) for GPT Module {: .alert.alert-warning :} -This module was removed in Prebid.js 11.0. See the [Prebid.js 11 release notes](/dev-docs/pb11-notes.html#removed-modules). +The paapiForGpt module was removed in Prebid.js 11.0. Prebid.js no longer supports the Protected Audience API. This module allows Prebid.js to support PAAPI (formerly FLEDGE) by integrating with GPT's support for [component auctions](https://developers.google.com/publisher-tag/reference#googletag.config.componentauctionconfig). diff --git a/dev-docs/modules/tcfControl.md b/dev-docs/modules/tcfControl.md index 4b98020443..9f2e116646 100644 --- a/dev-docs/modules/tcfControl.md +++ b/dev-docs/modules/tcfControl.md @@ -84,7 +84,7 @@ The following fields related to anonymizing aspects of the auction are supported Notes: -* By default, Prebid allows some limited use of storage even when purpose 1 consent was not given: this is limited to non-PII, such as [category translation mappings](/dev-docs/modules/categoryTranslation.html), or temporary test data used to probe the browser's storage features. If `strictStorageEnforcement` is true, Purpose 1 consent will always be enforced for any access to storage. +* By default, Prebid allows some limited use of storage even when purpose 1 consent was not given: this is limited to non-PII, such as temporary test data used to probe the browser's storage features. If `strictStorageEnforcement` is true, Purpose 1 consent will always be enforced for any access to storage. * To accommodate Prebid.js modules and adapters that don't have GVL IDs, the vendorExceptions list is based on Prebid.js biddercodes instead of Global Vendor List (GVL) IDs (i.e. "bidderA" instead of "12345"). * An alternate way of establishing a GVL mapping is to define a 'gvlMapping' object: diff --git a/dev-docs/modules/topLevelPaapi.md b/dev-docs/modules/topLevelPaapi.md index 9396a03d72..abcc60df18 100644 --- a/dev-docs/modules/topLevelPaapi.md +++ b/dev-docs/modules/topLevelPaapi.md @@ -5,14 +5,15 @@ title: Module - topLevelPaapi description: Run top level PAAPI auctions module_code : topLevelPaapi display_name : Run top level PAAPI auctions -enable_download : true +enable_download : false +pbjs_version_notes: removed in 11.0 sidebarType : 1 --- # Top level PAAPI module {: .alert.alert-warning :} -This module was removed in Prebid.js 11.0. See the [Prebid.js 11 release notes](/dev-docs/pb11-notes.html#removed-modules). +The topLevelPaapi module was removed in Prebid.js 11.0. Prebid.js no longer supports the Protected Audience API. This module allows Prebid.js to support PAAPI by running on-device auctions as the top level seller. diff --git a/dev-docs/modules/userid-submodules/dmd.md b/dev-docs/modules/userid-submodules/dmd.md index cc4be158e4..b6296f31ea 100644 --- a/dev-docs/modules/userid-submodules/dmd.md +++ b/dev-docs/modules/userid-submodules/dmd.md @@ -7,13 +7,11 @@ bidRequestUserId: dmdId eidsource: hcn.health example: '"1111"' enable_download: false +pbjs_version_notes: removed in 11.0 --- -# NOTE: DMD HAS BEEN DEPRECATED - -# THIS MODULE NO LONGER FUNCTIONS AND WILL BE REMOVED FROM A - -# FUTURE VERSION OF PREBID +{: .alert.alert-warning :} +The DMD ID module was deprecated and has been removed in Prebid.js 11.0. DMD is the preeminent supplier of US-based healthcare professional (HCP) identity data to the pharmaceutical, health system and medical publishing industries. DMD is the only data provider that has acquired its deterministic identity data through a fully consented, first-party, opt-in process. DMD’s privacy policy that can be found at [Privacy Policy](https://hcn.health/privacy-policy). @@ -38,7 +36,7 @@ Please reach out to [prebid@dmdconnects.com](mailto:prebid@dmdconnects.com) to r | name | Required | String | The name of Module | `"dmdId"` | | storage | Required | Object | | | | storage.name | Required | String | `dmd-dgid` | | -| params | Required | Object | Container of all module params. | | +| params | Required | Object | Container of all module params. | | | params.api_key | Required | String | This is your `api_key` as provided by DMD Marketing Corp. | `3fdbe297-3690-4f5c-9e11-ee9186a6d77c` | ## DMD ID Example diff --git a/dev-docs/publisher-api-reference/adServers.freewheel.getTargeting.md b/dev-docs/publisher-api-reference/adServers.freewheel.getTargeting.md index 12b22adfb9..6260ab2628 100644 --- a/dev-docs/publisher-api-reference/adServers.freewheel.getTargeting.md +++ b/dev-docs/publisher-api-reference/adServers.freewheel.getTargeting.md @@ -1,10 +1,13 @@ --- layout: api_prebidjs -title: pbjs.adServers.freewheel.getTargeting(options) +title: pbjs.adServers.freewheel.getTargeting(options) [Removed in 11.0] +head_title: "pbjs.adServers.freewheel.getTargeting(options) [Removed in 11.0] for Header Bidding" description: adServers.freewheel.getTargeting API sidebarType: 1 --- +{: .alert.alert-warning :} +This function was removed in Prebid.js 11.0 along with the `freeWheelAdserverVideo` module and ad pod (long-form) video support. {: .alert.alert-info :} The FreeWheel implementation of this function requires including the `freeWheelAdserverVideo` module in your Prebid.js build. @@ -22,12 +25,12 @@ pbjs.adServers.freewheel.getTargeting({ }); ``` -#### Argument Reference +## Argument Reference -##### The `options` object +### The `options` object {: .table .table-bordered .table-striped } | Param | Scope | Type | Description | | --- | --- | --- | --- | -| codes | Optional | `Array` | [`adUnitCode1`] | -| callback | Required | `Function` | Callback function to execute when targeting data is back. | +| codes | Optional | `Array` | [`adUnitCode1`] | +| callback | Required | `Function` | Callback function to execute when targeting data is back. | diff --git a/dev-docs/publisher-api-reference/adServers.gam.buildAdpodVideoUrl.md b/dev-docs/publisher-api-reference/adServers.gam.buildAdpodVideoUrl.md index cf0d72f57c..5daca0aaeb 100644 --- a/dev-docs/publisher-api-reference/adServers.gam.buildAdpodVideoUrl.md +++ b/dev-docs/publisher-api-reference/adServers.gam.buildAdpodVideoUrl.md @@ -1,10 +1,13 @@ --- layout: api_prebidjs -title: pbjs.adServers.gam.buildAdpodVideoUrl(options) [Alpha] +title: pbjs.adServers.gam.buildAdpodVideoUrl(options) [Removed in 11.0] +head_title: "pbjs.adServers.gam.buildAdpodVideoUrl(options) [Removed in 11.0] for Header Bidding" description: adServers.gam.buildAdpodVideoUrl API sidebarType: 1 --- +{: .alert.alert-warning :} +This function was removed in Prebid.js 11.0 along with ad pod (long-form) video support. {: .alert.alert-info :} The GAM implementation of this function requires including the `gamAdServerVideo` module in your Prebid.js build. diff --git a/dev-docs/publisher-api-reference/getPAAPIBids.md b/dev-docs/publisher-api-reference/getPAAPIBids.md index aa6cdb5365..27a8d0ba8b 100644 --- a/dev-docs/publisher-api-reference/getPAAPIBids.md +++ b/dev-docs/publisher-api-reference/getPAAPIBids.md @@ -1,10 +1,14 @@ --- layout: api_prebidjs -title: pbjs.getPAAPIBids(options) +title: pbjs.getPAAPIBids(options) [Removed in 11.0] +head_title: "pbjs.getPAAPIBids(options) [Removed in 11.0] for Header Bidding" description: getPAAPIBids API sidebarType: 1 --- +{: .alert.alert-warning :} +This function was removed in Prebid.js 11.0 along with the topLevelPaapi module. + Returns a promise of the latest PAAPI bid for each ad unit, optionally filtered by auction or ad unit. **Kind**: static method of pbjs API. Only available when the [topLevelPaapi module](/dev-docs/modules/topLevelPaapi.html) is installed. @@ -16,26 +20,26 @@ Returns a promise of the latest PAAPI bid for each ad unit, optionally filtered {: .table .table-bordered .table-striped } | Param | Scope | Type | Description | | --- | --- | --- | --- | -| options | Optional | `Object` | | +| options | Optional | `Object` | | | options.adUnitCode | Optional | `String` | Ad unit filter; if provided, only return the PAAPI winner for this ad unit | -| options.auctionId | Optional | `String` | Auction filter; if provided, only return PAAPI winners for this auction | +| options.auctionId | Optional | `String` | Auction filter; if provided, only return PAAPI winners for this auction | **Result**: The return value is a map where each value is either `null` (when there is no PAAPI winner), or an object with this format: {: .table .table-bordered .table-stripped :} -| Param | Type | Description | -| --- | --- | --- | -| adId | String | Ad ID. can be used with [renderAd](/dev-docs/publisher-api-reference/renderAd.html) | -| auctionId | String | Auction ID tied to this bid | -| adUnitCode | String | Ad unit code tied to this bid | -| source | String | Always `"paapi"` | -| urn | String | Creative URN (only set if `paapi.topLevelSeller.auctionConfig.resolveToConfig` is `false`| -| frameConfig | Object | Creative fenced frame config (only set if `paapi.topLevelSeller.auctionConfig.resolveToConfig` is `true`| -| auctionConfig | Object | The auction config object that was passed to `navigator.runAdAuction` and generated this bid | -| width | Number | Creative width | -| height | Number | Creative height | +| Param | Type | Description | +| --- | --- | --- | +| adId | String | Ad ID. can be used with [renderAd](/dev-docs/publisher-api-reference/renderAd.html) | +| auctionId | String | Auction ID tied to this bid | +| adUnitCode | String | Ad unit code tied to this bid | +| source | String | Always `"paapi"` | +| urn | String | Creative URN (only set if `paapi.topLevelSeller.auctionConfig.resolveToConfig` is `false` | +| frameConfig | Object | Creative fenced frame config (only set if `paapi.topLevelSeller.auctionConfig.resolveToConfig` is `true` | +| auctionConfig | Object | The auction config object that was passed to `navigator.runAdAuction` and generated this bid | +| width | Number | Creative width | +| height | Number | Creative height | **Example**: diff --git a/dev-docs/publisher-api-reference/getPAAPIConfig.md b/dev-docs/publisher-api-reference/getPAAPIConfig.md index 34aeb84746..b76bdd8f65 100644 --- a/dev-docs/publisher-api-reference/getPAAPIConfig.md +++ b/dev-docs/publisher-api-reference/getPAAPIConfig.md @@ -1,10 +1,14 @@ --- layout: api_prebidjs -title: pbjs.getPAAPIConfig(options) +title: pbjs.getPAAPIConfig(options) [Removed in 11.0] +head_title: "pbjs.getPAAPIConfig(options) [Removed in 11.0] for Header Bidding" description: getPAAPIConfig API sidebarType: 1 --- +{: .alert.alert-warning :} +This function was removed in Prebid.js 11.0 along with the PAAPI module. + Return the latest available PAAPI auction configuration for each ad unit, optionally filtered by auction or ad unit. **Kind**: static method of pbjs API. Only available when the [PAAPI module](/dev-docs/modules/paapi.html) is installed. @@ -16,9 +20,9 @@ Return the latest available PAAPI auction configuration for each ad unit, option {: .table .table-bordered .table-striped } | Param | Scope | Type | Description | | --- | --- | --- | --- | -| options | Optional | `Object` | | +| options | Optional | `Object` | | | options.adUnitCode | Optional | `String` | Ad unit filter; if provided, only return configuration for this ad unit | -| options.auctionId | Optional | `String` | Auction filter; if provided, only return configuration from this auction | +| options.auctionId | Optional | `String` | Auction filter; if provided, only return configuration from this auction | **Example**: diff --git a/dev-docs/publisher-api-reference/setPAAPIConfigForGPT.md b/dev-docs/publisher-api-reference/setPAAPIConfigForGPT.md index e1b882cffc..2e552663a7 100644 --- a/dev-docs/publisher-api-reference/setPAAPIConfigForGPT.md +++ b/dev-docs/publisher-api-reference/setPAAPIConfigForGPT.md @@ -1,10 +1,14 @@ --- layout: api_prebidjs -title: pbjs.setPAAPIConfigForGPT(options) +title: pbjs.setPAAPIConfigForGPT(options) [Removed in 11.0] +head_title: "pbjs.setPAAPIConfigForGPT(options) [Removed in 11.0] for Header Bidding" description: setPAAPIConfigForGPT API sidebarType: 1 --- +{: .alert.alert-warning :} +This function was removed in Prebid.js 11.0 along with the paapiForGpt module. + Configure GPT slots to use PAAPI. **Kind**: static method of pbjs API. Only available when the [paapiForGpt module](/dev-docs/modules/paapiForGpt.html) is installed. @@ -14,7 +18,7 @@ Configure GPT slots to use PAAPI. {: .table .table-bordered .table-striped } | Param | Scope | Type | Description | | --- | --- | --- | --- | -| options | Optional | `Object` | | +| options | Optional | `Object` | | | options.adUnitCode | Optional | `String` | Ad unit filter; if provided, only configure the GPT slot that matches this ad unit | | options.auctionId | Optional | `String` | Auction filter; if provided, only configure GPT slots with PAAPI configs from this auction | | customSlotMatching | Optional | `Function` | Custom slot matching function - of the same type used by [setTargetingForGPTAsync](/dev-docs/publisher-api-reference/setTargetingForGPTAsync.html) | diff --git a/dev-docs/show-long-form-video-with-gam.md b/dev-docs/show-long-form-video-with-gam.md index b12f4af3cd..82b9b46eff 100644 --- a/dev-docs/show-long-form-video-with-gam.md +++ b/dev-docs/show-long-form-video-with-gam.md @@ -9,6 +9,9 @@ sidebarType: 4 {: .no_toc} +{: .alert.alert-warning :} +Ad pod (long-form) video support was removed in Prebid.js 11.0. This page applies to Prebid.js 10.x and earlier only. + In this tutorial, we'll detail how to set up Prebid.js to display a Programmatic OTT with Prebid (POP) video ad (ad pod) from Google Ad Manager (GAM). * TOC diff --git a/examples/video/index.md b/examples/video/index.md index 5241432a80..b19326cc3c 100644 --- a/examples/video/index.md +++ b/examples/video/index.md @@ -37,3 +37,10 @@ The following examples are available: - [Google Ad Manager](/examples/video/outstream/pb-ve-outstream-dfp.html) - [No Server](/examples/video/outstream/pb-ve-outstream-no-server.html) + +## Long-Form (Ad Pods) + +{: .alert.alert-warning :} +Ad pod (long-form) video support was removed in Prebid.js 11.0. These examples apply to Prebid.js 10.x and earlier only. + +- [Freewheel](/examples/video/long-form/pb-ve-lf-freewheel.html) diff --git a/prebid-video/video-long-form.md b/prebid-video/video-long-form.md index ea56cb3ca0..9b98fa8863 100644 --- a/prebid-video/video-long-form.md +++ b/prebid-video/video-long-form.md @@ -13,6 +13,9 @@ sidebarType: 4 {: .no_toc } +{: .alert.alert-warning :} +Ad pod (long-form) video support was removed in Prebid.js 11.0. This page applies to Prebid.js 10.x and earlier only. + If you’re new to header bidding and Prebid review the following to get a general understanding of Prebid.js. - [What Is Prebid?](/overview/intro.html) diff --git a/prebid-video/video-overview.md b/prebid-video/video-overview.md index 5f8d34b1e2..3a2abdf9d9 100644 --- a/prebid-video/video-overview.md +++ b/prebid-video/video-overview.md @@ -94,6 +94,9 @@ Prebid retrieves the winning video bid and renderer from the ad ID (hb_adid). Pr ### Long-form Video +{: .alert.alert-warning :} +Ad pod (long-form) video support was removed in Prebid.js 11.0. This section applies to Prebid.js 10.x and earlier only. + Here’s a high-level diagram showing how long-form video header bidding works for adpod video (with more details outlined in the steps below): ![Instream Video Diagram]({{site.baseurl}}/assets/images/prebid-video/instream-video.png){: .pb-img.pb-lg-img :} @@ -125,7 +128,7 @@ The video player loads the master video ad server tag URL, which makes a call to ## Further Reading - [Getting Started with Video for Prebid.js](/prebid-video/video-getting-started.html) -- [Getting Started with Long-Form Video for Prebid.js](/prebid-video/video-long-form.html) +- [Getting Started with Long-Form Video for Prebid.js](/prebid-video/video-long-form.html) (Prebid.js 10.x and earlier) - [What is Prebid?](/overview/intro.html) - [AdOps - Before You Start](/adops/before-you-start.html) - [Getting Started for Developers](/dev-docs/getting-started.html) diff --git a/support/privacy-resources.md b/support/privacy-resources.md index fd49363203..58d82008f1 100644 --- a/support/privacy-resources.md +++ b/support/privacy-resources.md @@ -70,6 +70,9 @@ Prebid Server supports reading the Topics headers and inserting them into the Op #### Protected Audience API +{: .alert.alert-warning :} +The Prebid.js PAAPI modules (`paapi`, `paapiForGpt`, `topLevelPaapi`) and the `paapi` setConfig option were removed in Prebid.js 11.0. The Prebid.js guidance in this section applies to Prebid.js 10.x and earlier only. + PAAPI (also called PAA) is Chrome's solution for ad targeting done in a privacy-friendly way. In short, GAM will kick off an in-browser auction after the contextual auction. If the in-browser auction wins, it can override the ad chosen by GAM.