diff --git a/dev-docs/bidders/ix.md b/dev-docs/bidders/ix.md index c4592e1406..a7c84b16e3 100644 --- a/dev-docs/bidders/ix.md +++ b/dev-docs/bidders/ix.md @@ -376,20 +376,20 @@ pbjs.addAdUnits({ **Before you begin:** -* You must have Google Ad Manager and the [fledgeForGpt](/dev-docs/modules/fledgeForGpt.html) module. +* You must have Google Ad Manager and the [paapiForGpt](/dev-docs/modules/paapiForGpt.html) module. * In your Google Ad Manager configuration, make sure that you have not opted out from using the Protected Audience API. For more information about the configuration, see Google's documentation on [Protected Audience API and Ad Manager after Chrome GA](https://support.google.com/admanager/answer/13627134?hl=en&ref_topic=12264880&sjid=10591375417866092080-NA). Depending on the Prebid.js version that you are using, the steps to configure Prebid.js will differ. Follow the steps provided in the appropriate section for the version of Prebid.js that you are using: **Configure Protected Audience API for Prebid.js versions 8.18.0 to 8.36.0** -1. Build the `fledgeForGpt` module in your Prebid.js configuration by adding `fledgeForGpt` to the list of modules that you are already using. For more information about the module, see Prebid's [Protected Audience API (PAAPI) for GPT Module](/dev-docs/modules/fledgeForGpt.html) documentation. -2. Configure your ad units to make them eligible for Protected Audience API demand. You can do this in the global-level configuration, bidder level, or ad-unit level. For more information about the configurations, see Prebid's [Protected Audience API (PAAPI) for GPT Module](/dev-docs/modules/fledgeForGpt.html) documentation. Index recommends that you do this in the global-level configuration by using the `defaultForSlots` parameter with a value of `1`. The following code is an example of the configuration done at the global level: +1. Build the `paapiForGpt` module in your Prebid.js configuration by adding `fledgeForGpt` to the list of modules that you are already using. For more information about the module, see Prebid's [Protected Audience API (PAAPI) for GPT Module](/dev-docs/modules/paapiForGpt.html) documentation. +2. Configure your ad units to make them eligible for Protected Audience API demand. You can do this in the global-level configuration, bidder level, or ad-unit level. For more information about the configurations, see Prebid's [Protected Audience API (PAAPI) for GPT Module](/dev-docs/modules/paapiForGpt.html) documentation. Index recommends that you do this in the global-level configuration by using the `defaultForSlots` parameter with a value of `1`. The following code is an example of the configuration done at the global level: ```javascript pbjs.que.push(function() { pbjs.setConfig({ - fledgeForGpt: { + paapi: { enabled: true, defaultForSlots: 1 } @@ -397,12 +397,12 @@ Depending on the Prebid.js version that you are using, the steps to configure Pr }); ``` - **Note:** If you are using the `fledgeForGpt.bidders[]`, make sure that you include `ix` to the list of bidders as follows: + **Note:** If you are using the `paapiForGpt.bidders[]`, make sure that you include `ix` to the list of bidders as follows: ```javascript pbjs.que.push(function() { pbjs.setConfig({ - fledgeForGpt: { + paapi: { enabled: true, bidders: ['ix', /* any other bidders */], defaultForSlots: 1 @@ -421,16 +421,16 @@ Depending on the Prebid.js version that you are using, the steps to configure Pr ```javascript pbjs.que.push(function() { pbjs.setConfig({ - paapi: { + fledgeForGpt: { enabled: true, - defaultForSlots: 1 + defaultForSlots: 1, bidders: ['ix', /* any other bidders */], }); }); ``` - * In the `paapi.gpt.autoconfig` field, set `autoconfig` to `false`. This step is important because, by default, the `fledgeForGpt` module expects the Google Publisher Tag (GPT) ad units to be loaded before the Protected Audience configuration is added to the ad unit. Setting `autoconfig` to `false` will avoid any race conditions resulting from asynchronous libraries being loaded out of order, which would prevent the ad unit from being properly configured for Protected Audience API.
-**Note:** The `fledgeForGpt.autoconfig` property is also backward compatible and can be used in place of the `paapi.gpt.autoconfig` property. However, Index recommends that you use the `paapi.gpt.autoconfig` property.
+ * In the `paapi.gpt.autoconfig` field, set `autoconfig` to `false`. This step is important because, by default, the `paapiForGpt` module expects the Google Publisher Tag (GPT) ad units to be loaded before the Protected Audience configuration is added to the ad unit. Setting `autoconfig` to `false` will avoid any race conditions resulting from asynchronous libraries being loaded out of order, which would prevent the ad unit from being properly configured for Protected Audience API.
+**Note:** The `paapiForGpt.autoconfig` property is also backward compatible and can be used in place of the `paapi.gpt.autoconfig` property. However, Index recommends that you use the `paapi.gpt.autoconfig` property.
```javascript pbjs.que.push(function() { diff --git a/dev-docs/bidders/medianet.md b/dev-docs/bidders/medianet.md index 8b402d6818..cb8eb86f66 100644 --- a/dev-docs/bidders/medianet.md +++ b/dev-docs/bidders/medianet.md @@ -148,13 +148,13 @@ var adUnits = [{ To enable PAAPI auctions follow the instructions below: -1. Add the `fledgeForGpt` and `paapi` modules to your prebid bundle. +1. Add the `paapiForGpt` and `paapi` modules to your prebid bundle. 2. Add the following configuration for the module ```javascript pbjs.que.push(function() { pbjs.setConfig({ - fledgeForGpt: { + paapi: { enabled: true, bidders: ['medianet'], defaultForSlots: 1 @@ -164,4 +164,4 @@ pbjs.que.push(function() { ``` For a detailed guide to enabling PAAPI auctions follow Prebid's documentation -on [`fledgeForGpt`](https://docs.prebid.org/dev-docs/modules/fledgeForGpt.html) +on [`paapiForGpt`](https://docs.prebid.org/dev-docs/modules/paapiForGpt.html) diff --git a/dev-docs/bidders/rtbhouse.md b/dev-docs/bidders/rtbhouse.md index 9b819d39b5..a1abc7d5d7 100644 --- a/dev-docs/bidders/rtbhouse.md +++ b/dev-docs/bidders/rtbhouse.md @@ -74,30 +74,30 @@ pbjs.setBidderConfig({ If you’re a Prebid Server host company looking to enable the RTB House server-side adapter, you'll need to contact . They will guide you through the process. Do not use the default bidder config file as it will require custom partner code to be entered. It will be provided by RTB House. -### Protected Audience API (FLEDGE) support +### Protected Audience API (PAAPI) support There’s an option to receive demand for Protected Audience API (FLEDGE/PAAPI) ads using RTB House bid adapter. -Prebid’s [fledgeForGpt](https://docs.prebid.org/dev-docs/modules/fledgeForGpt.html) +Prebid’s [paapiForGpt](https://docs.prebid.org/dev-docs/modules/paapiForGpt.html) module and Google Ad Manager is currently required. The following steps should be taken to setup Protected Audience for RTB House: 1. Reach out to your RTB House representative for setup coordination. -2. Build and enable FLEDGE module as described in -[fledgeForGpt](https://docs.prebid.org/dev-docs/modules/fledgeForGpt.html) +2. Build and enable PAAPI module as described in +[paapiForGpt](https://docs.prebid.org/dev-docs/modules/paapiForGpt.html) module documentation. - a. Make sure to enable RTB House bidder to participate in FLEDGE. If there are any other bidders to be allowed for that, add them to the **bidders** array: + a. Make sure to enable RTB House bidder to participate in PAAPI. If there are any other bidders to be allowed for that, add them to the **bidders** array: ```javascript - pbjs.setBidderConfig({ - bidders: ["rtbhouse"], - config: { - fledgeEnabled: true - } - }); + pbjs.setConfig({ + paapi: { + enabled: true, + bidders: ["rtbhouse"] + } + }) ``` b. If you as a publisher have your own [decisionLogicUrl](https://github.com/WICG/turtledove/blob/main/FLEDGE.md#21-initiating-an-on-device-auction) @@ -107,7 +107,6 @@ module documentation. pbjs.setBidderConfig({ bidders: ["rtbhouse"], config: { - fledgeEnabled: true, fledgeConfig: { seller: 'https://seller.domain', decisionLogicUrl: 'https://seller.domain/decisionLogicFile.js', diff --git a/dev-docs/bidders/unruly.md b/dev-docs/bidders/unruly.md index 7a0824c838..644f9ea86b 100644 --- a/dev-docs/bidders/unruly.md +++ b/dev-docs/bidders/unruly.md @@ -30,30 +30,30 @@ sidebarType: 1 | `siteid` | deprecated | The site ID from Unruly. This will be provided to you by your Unruly account manager, this is backward compability. | `123456` | `integer` | | `featureOverrides` | optional | This param is a generic object for configuring Unruly outstream demand. To run UNmissable, set ‘canRunUnmissable’ to true. | `"featureOverrides": {"canRunUnmissable": true}` | `object` | -### Protected Audience API (FLEDGE) support +### Protected Audience API (PAAPI) support There’s an option to receive demand for Protected Audience API (FLEDGE/PAAPI) ads using Unruly's (Nexxen) bid adapter. -Prebid’s [fledgeForGpt](https://docs.prebid.org/dev-docs/modules/fledgeForGpt.html) +Prebid’s [paapiForGpt](https://docs.prebid.org/dev-docs/modules/paapiForGpt.html) module and Google Ad Manager is currently required. The following steps should be taken to setup Protected Audience for Unruly(Nexxen): 1. Reach out to your account manager to coordinate set up: -2. Build and enable FLEDGE module as described in -[fledgeForGpt](https://docs.prebid.org/dev-docs/modules/fledgeForGpt.html) +2. Build and enable PAAPI module as described in +[paapiForGpt](https://docs.prebid.org/dev-docs/modules/paapiForGpt.html) module documentation. - Make sure to enable Unruly bidder to participate in FLEDGE. If there are any other bidders to be allowed for that, add them to the **bidders** array: + Make sure to enable Unruly bidder to participate in PAAPI. If there are any other bidders to be allowed for that, add them to the **bidders** array: ```javascript - pbjs.setBidderConfig({ - bidders: ["unruly"], - config: { - fledgeEnabled: true - } - }); + pbjs.setConfig({ + paapi: { + bidders: ["unruly"], + enabled: true + } + }) ``` ### First Party Data diff --git a/dev-docs/modules/paapi.md b/dev-docs/modules/paapi.md index 8a47f9402e..71df078690 100644 --- a/dev-docs/modules/paapi.md +++ b/dev-docs/modules/paapi.md @@ -16,7 +16,7 @@ This module allows Prebid.js to support PAAPI, formerly known as [FLEDGE](https: This document covers the steps necessary for publishers to enable PAAPI on their inventory. It also describes the changes Bid Adapters need to implement in order to support PAAPI. -A related module, [fledgeForGpt](/dev-docs/modules/fledgeForGpt.html), adds support specifically for GPT's [component auctions](https://developers.google.com/publisher-tag/reference#googletag.config.componentauctionconfig). +A related module, [paapiForGpt](/dev-docs/modules/paapiForGpt.html), adds support specifically for GPT's [component auctions](https://developers.google.com/publisher-tag/reference#googletag.config.componentauctionconfig). ## Publisher Integration @@ -29,7 +29,7 @@ To use PAAPI, publishers must: ``` - enable PAAPI, globally or by ad unit, through [configuration](#config) -- manage the PAAPI auctions. This can be delegated to GPT with the [fledgeForGpt module](/dev-docs/modules/fledgeForGpt.html); homegrown solutions are possible with [getPAAPIConfig](/dev-docs/publisher-api-reference/getPAAPIConfig.html), but out of scope for this document. +- manage the PAAPI auctions. This can be delegated to GPT with the [paapiForGpt module](/dev-docs/modules/paapiForGpt.html); homegrown solutions are possible with [topLevelPaapi](/dev-docs/modules/topLevelPaapi.html). @@ -43,6 +43,7 @@ This module exposes the following settings: |enabled | Boolean |Enable/disable the module |Defaults to `false` | |bidders | Array[String] |Optional list of bidders |Defaults to all bidders | |defaultForSlots | Number |Default value for `imp.ext.ae` in requests for specified bidders |Should be 1 | +|componentSeller | Object |Configuration for publishers acting as component sellers | See [note](#componentSeller) | As noted above, PAAPI support is disabled by default. To enable it, set the `enabled` value to `true` for this module and configure `defaultForSlots` to be `1` (meaning _Client-side auction_). using the `setConfig` method of Prebid.js: @@ -72,30 +73,6 @@ pbjs.que.push(function() { }); ``` -### Bidder Configuration - -This module adds the following setting for bidders: - -{: .table .table-bordered .table-striped } -|Name |Type |Description |Notes | -| ------------ | ------------ | ------------ |------------ | -| fledgeEnabled | Boolean | Enable/disable a bidder to participate in FLEDGE | Defaults to `false` | -|defaultForSlots | Number |Default value for `imp.ext.ae` in requests for specified bidders |Should be 1| - -In addition to enabling PAAPI at the module level, individual bidders can also be enabled. This allows publishers to -selectively test with one or more bidders as they desire. To enable one or more bidders, use the `setBidderConfig` method -of Prebid.js: - -```js -pbjs.setBidderConfig({ - bidders: ["bidderA"], - config: { - fledgeEnabled: true, - defaultForSlots: 1 - } -}); -``` - ### AdUnit Configuration All adunits can be opted-in to PAAPI in the global config via the `defaultForSlots` parameter. @@ -124,6 +101,18 @@ pbjs.addAdUnits({ }); ``` + +### Advanced usage: publisher-managed component auction + +Bid adapters typically act as PAAPI sellers, each providing one or more [component auctions](https://github.com/WICG/turtledove/blob/main/FLEDGE.md#24-scoring-bids-in-component-auctions) in a multi-seller PAAPI auction. +Some adapters may act as PAAPI buyers: instead of a full component auction, they can reply directly with buyer information. By configuring `componentSeller`, these buyers are collected into one or more publisher-managed component auctions. + +{: .table .table-bordered .table-striped } +|Name |Type |Description | +| ------------ | ------------ | ------------ | +|componentSeller.auctionConfig | Object | [AuctionConfig](https://github.com/WICG/turtledove/blob/main/FLEDGE.md#21-initiating-an-on-device-auction) object to use for the component auction(s) | +|componentSeller.separateAuctions | Boolean | If `true`, generate a component auction for each bid adapter. If `false` (the default), buyers are collected into as few component auctions as possible (typically one, but multiple are possible if multiple bidders reply with the same buyer) | + ## Bid Adapter Integration Chrome has enabled a two-tier auction in PAAPI. This allows multiple sellers (frequently SSPs) to act on behalf of the publisher with @@ -134,49 +123,62 @@ bids to the final layer. To learn more about Component Auctions, go [here](https 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 -`AuctionConfig` object, Prebid.js will make it available through [`getPAAPIConfig`](/dev-docs/publisher-api-reference/getPAAPIConfig.html), as well as other PAAPI modules such as [fledgeForGpt](/dev-docs/modules/fledgeForGpt.html). +`AuctionConfig` object, Prebid.js will make it available through [`getPAAPIConfig`](/dev-docs/publisher-api-reference/getPAAPIConfig.html), as well as other PAAPI modules such as [paapiForGpt](/dev-docs/modules/paapiForGpt.html). + +{: .alert.alert-warning :} +If your adapter interfaces with an ORTB backend, you may take advantage of Prebid's [ORTB conversion library](https://github.com/prebid/Prebid.js/blob/master/libraries/ortbConverter/README.md), which implements the following using [protected audience community extensions](https://github.com/InteractiveAdvertisingBureau/openrtb/blob/main/extensions/community_extensions/Protected%20Audience%20Support.md) Modifying a bid adapter to support PAAPI is a straightforward process and consists of the following steps: 1. Detecting when a bid request is PAAPI eligible -2. Responding with AuctionConfig +2. Responding with AuctionConfig or InterestGroupBuyer in addition to (or instead of) bids + +### Input parameters + +When PAAPI is configured, the following fields are made available to adapters' [`buildRequests`](/dev-docs/bidder-adaptor.html#building-the-request): + +{: .table .table-bordered .table-striped } +|Name |Type |Description |Notes | +| ------------ | ------------ | ------------ | +| `validBidRequests[].ortb2Imp.ext.ae` | Integer | `1` when the PAAPI is enabled for the request | +| `validBidRequests[].ortb2Imp.ext.igs` | Object | [InterestGroupSupport](https://github.com/InteractiveAdvertisingBureau/openrtb/blob/main/extensions/community_extensions/Protected%20Audience%20Support.md#object-interestgroupauctionsupport) object| +| `validBidRequests[].ortb2Imp.ext.igs.ae` | Integer | duplicate of `ortb2Imp.ext.ae` | +| `validBidRequests[].ortb2Imp.ext.igs.biddable` | Integer | `1` when `ae` is `1` | +| `validBidRequests[].ortb2Imp.ext.paapi.requestedSize` | Object | Size (as an object `{width, height}`) that will be passed as `requestedSize` to [`runAdAuction`](https://github.com/WICG/turtledove/blob/main/FLEDGE.md#21-initiating-an-on-device-auction) | +| `bidderRequest.paapi.enabled` | Boolean | `true` if the publisher has enabled PAAPI and the browser supports it | +| `bidderRequest.paapi.componentSeller` | Boolean | `true` if the publisher can act as a component seller and accept `igb` objects instead of auction configs | -PAAPI eligibility is made available to bid adapters' [`buildRequests`](/dev-docs/bidder-adaptor.html#building-the-request) method through the `ortb2Imp.ext.ae` property of bid requests; it is set to `1` when the browser supports PAAPI and publisher configuration has enabled it as described above. Bid adapters -who wish to participate should read this flag and pass it to their server. +### Output values -When a bid request is PAAPI enabled, a bid adapter can return a tuple consisting of bids and AuctionConfig objects rather than just a list of bids: +When a bid request is PAAPI enabled, a bid adapter can return a tuple consisting of bids and PAAPI objects rather than just a list of bids: ```js function interpretResponse(resp, req) { // Load the bids from the response - this is adapter specific const bids = parseBids(resp); - // Load the auctionConfigs from the response - also adapter specific - const fledgeAuctionConfigs = parseAuctionConfigs(resp); - - if (fledgeAuctionConfigs) { - // Return a tuple of bids and auctionConfigs. It is possible that bids could be null. - return {bids, fledgeAuctionConfigs}; - } else { - return bids; - } + // Load auction configs or igb from the response - also adapter specific + const paapi = parsePaapi(resp); + return {bids, paapi}; } ``` -An AuctionConfig must be associated with an adunit and auction, and this is accomplished using the value in the `bidId` field from the objects in the -`validBidRequests` array passed to the `buildRequests` function - see [here](/dev-docs/bidder-adaptor.html#ad-unit-params-in-the-validbidrequests-array) -for more details. This means that the AuctionConfig objects returned from `interpretResponse` must contain a `bidId` field whose value corresponds to -the request it should be associated with. This may raise the question: why isn't the AuctionConfig object returned as part of the bid? The -answer is that it's possible to participate in the PAAPI auction without returning a contextual bid. +`paapi` must be an array of objects containing: -An example of this can be seen in the OpenX bid adapter [here](https://github.com/prebid/Prebid.js/blob/master/modules/openxBidAdapter.js) or RTB House bid adapter [here](https://github.com/prebid/Prebid.js/blob/master/modules/rtbhouseBidAdapter.js). +{: .table .table-bordered .table-striped } +|Name |Type |Description |Notes | +| ------------ | ------------ | ------------ | +| `bidId` | String | one of the input requests' `bidId`. Used to identify the slot that this object refers to. | +| `igb` | Object | [InterestGroupBuyer](https://github.com/InteractiveAdvertisingBureau/openrtb/blob/main/extensions/community_extensions/Protected%20Audience%20Support.md#object-interestgroupauctionsupport) object| +| `config` | Object | [AuctionConfig](https://github.com/WICG/turtledove/blob/main/FLEDGE.md#21-initiating-an-on-device-auction) object | + +Each object must specify exactly one of `igb` or `config`. -Other than the addition of the `bidId` field, the `AuctionConfig` object should adhere to the requirements set forth in PAAPI. The details of creating an -`AuctionConfig` object are beyond the scope of this document. +An example of this can be seen in the OpenX bid adapter [here](https://github.com/prebid/Prebid.js/blob/master/modules/openxBidAdapter.js) or RTB House bid adapter [here](https://github.com/prebid/Prebid.js/blob/master/modules/rtbhouseBidAdapter.js). ## Related Reading -- [fledgeForGpt module](/dev-docs/modules/fledgeForGpt.html) +- [paapiForGpt module](/dev-docs/modules/paapiForGpt.html) - [Protected Audience API (PAAPI)](https://github.com/WICG/turtledove/blob/main/FLEDGE.md), formerly FLEDGE - [Component Auctions](https://github.com/WICG/turtledove/blob/main/FLEDGE.md#21-initiating-an-on-device-auction) - [getPAAPIConfig](/dev-docs/publisher-api-reference/getPAAPIConfig.html) diff --git a/dev-docs/modules/fledgeForGpt.md b/dev-docs/modules/paapiForGpt.md similarity index 77% rename from dev-docs/modules/fledgeForGpt.md rename to dev-docs/modules/paapiForGpt.md index 82d725f0d2..5e13485bdb 100644 --- a/dev-docs/modules/fledgeForGpt.md +++ b/dev-docs/modules/paapiForGpt.md @@ -1,7 +1,7 @@ --- layout: page_v2 page_type: module -title: Module - fledgeForGpt +title: Module - paapiForGpt description: how to use PAAPI with GPT module_code : paapiForGpt display_name : Fledge (PAAPI) for GPT @@ -30,30 +30,27 @@ To use PAAPI with GPT: - [configure PAAPI](/dev-docs/modules/paapi.html#config) - (optional) invoke [setPAAPIConfigForGPT](/dev-docs/publisher-api-reference/setPAAPIConfigForGPT.html) at end of auction. -By default, Prebid.js attempts to configure GPT slots for PAAPI at the end of each auction. This requires GPT to be loaded before the first Prebid auction is started; to avoid this requirement, or for more control in general over GPT slot configuration, you can use [`setPAAPIConfigForGPT`](/dev-docs/publisher-api-reference/setPAAPIConfigForGPT.html). - ## Explicit configuration -First, disable automatic configuration of GPT slots: +By default, Prebid.js attempts to configure GPT slots for PAAPI together with their targeting (that is, when [setTargetingForGPTAsync](/dev-docs/publisher-api-reference/setTargetingForGPTAsync.html) is called). + +For more control how GPT slots are configured, you can set `configWithTargeting: false` and explicitly call [setPAAPIConfigForGPT](/dev-docs/publisher-api-reference/setPAAPIConfigForGPT.html). For example: ```js pbjs.setConfig({ paapi: { + enabled: true, + defaultForSlots: 1, gpt: { - autoconfig: false + configWithTargeting: false } } }) -``` - -You may then use `setPAAPIConfigForGPT`, typically from a `bidsBackHandler`: - -```js pbjs.requestBids({ // ... - bidsBackHandler: function(bids, timedOut, auctionId) { - pbjs.setPAAPIConfigForGPT(); - // ... + bidsBackHandler: function(bids, timedOut, auctionId) { + pbjs.setPAAPIConfigForGPT(); + // ... } }) ``` diff --git a/dev-docs/publisher-api-reference/setPAAPIConfigForGPT.md b/dev-docs/publisher-api-reference/setPAAPIConfigForGPT.md index cf47f90a4c..e1b882cffc 100644 --- a/dev-docs/publisher-api-reference/setPAAPIConfigForGPT.md +++ b/dev-docs/publisher-api-reference/setPAAPIConfigForGPT.md @@ -7,7 +7,7 @@ sidebarType: 1 Configure GPT slots to use PAAPI. -**Kind**: static method of pbjs API. Only available when the [fledgeForGpt module](/dev-docs/modules/fledgeForGpt.html) is installed. +**Kind**: static method of pbjs API. Only available when the [paapiForGpt module](/dev-docs/modules/paapiForGpt.html) is installed. **Parameters**: @@ -17,6 +17,7 @@ Configure GPT slots to use PAAPI. | 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) | **Example**: diff --git a/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.md b/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.md index da42122863..6b74968ab4 100644 --- a/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.md +++ b/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.md @@ -120,7 +120,7 @@ Prebid Server's support for Fledge is a passthrough: 1. If the request contains `imp.ext.ae: 1` 2. Bid adapters may respond with 'auction config' that's placed in `ext.prebid.fledge.auctionconfigs[]`. -The auction config must then be used by the client. See the Prebid.js [Fledge for GPT](/dev-docs/modules/fledgeForGpt.html) module for more information. +The auction config must then be used by the client. See the Prebid.js [PAAPI for GPT](/dev-docs/modules/paapiForGpt.html) module for more information. ### OpenRTB Fields diff --git a/support/privacy-resources.md b/support/privacy-resources.md index 5fafff1e87..5666071a65 100644 --- a/support/privacy-resources.md +++ b/support/privacy-resources.md @@ -76,7 +76,7 @@ the contextual auction. If the in-browser auction wins, it can override the ad c See [Chrome's PAAPI documentation](https://developers.google.com/privacy-sandbox/relevance/protected-audience) for the full background. -To enable Interest Group bidding in Prebid, you can add the Prebid [Fledge For GPT Module](/dev-docs/modules/fledgeForGpt.html). +To enable Interest Group bidding in Prebid, you can add the Prebid [PAAPI For GPT Module](/dev-docs/modules/paapiForGpt.html). {: .alert.alert-info :} Note that 'FLEDGE' was the original name of the Protected Audience feature. The name of the Prebid.js module may change in the future. @@ -84,7 +84,7 @@ Note that 'FLEDGE' was the original name of the Protected Audience feature. The ##### Prebid.js and the PAA Test Period During the first part of 2024, Chrome and GAM are running a test of PAAPI on a limited subset of traffic. However, the -[Fledge For GPT Module](/dev-docs/modules/fledgeForGpt.html) enables Interest Group auctions 100% of the time. During the test +[PAAPI For GPT Module](/dev-docs/modules/paapiForGpt.html) enables Interest Group auctions 100% of the time. During the test period, publishers can better align browser and programmatic ad behavior by only enabling Prebid interest group bids for the relevant Chrome testing labels. @@ -93,7 +93,7 @@ If you want to gather interest group bids only when InterestGroup (IG) auctions ```javascript Promise.resolve(navigator.cookieDeprecationLabel?.getValue?.()).then(label => { pbjs.setConfig({ - fledgeForGpt: { + paapi: { enabled: !label || label.startsWith("treatment_") || label === 'label_only_5' } }); @@ -105,7 +105,7 @@ If you want to gather interest group bids whenever when IG auctions _might_ run, ```javascript Promise.resolve(navigator.cookieDeprecationLabel?.getValue?.()).then(label => { pbjs.setConfig({ - fledgeForGpt: { + paapi: { enabled: !label || label.startsWith("treatment_") || label != 'label_only_1' } }); @@ -126,8 +126,8 @@ This table may be useful to publishers trying to decide which version of Prebid. | Prebid.js Version | Notes | |-------------------|-------| | 8.22| Makes Prebid FPD available to the PAAPI generateBid, scoreAds, and reportResult functions | -| 8.15| Added floor signal to the fledgeForGpt module | -| 8.9| Initial release of the fledgeForGpt module, Sec-Browsing-Topics header enabled | +| 8.15| Added floor signal to the paapiForGpt module | +| 8.9| Initial release of the paapiForGpt module, Sec-Browsing-Topics header enabled | | 8.8| The topicsFpd module is released, allowing bidders to share topics | #### Prebid Server Versions Supporting Privacy Sandbox