Skip to content

Commit

Permalink
Update ix.md (#4913)
Browse files Browse the repository at this point in the history
Added protected audience API set up instructions

Co-authored-by: Muki Seiler <[email protected]>
  • Loading branch information
rimaburder-index and muuki88 authored Oct 11, 2023
1 parent 95b48ec commit f08750c
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions dev-docs/bidders/ix.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ sidebarType: 1
* [AdUnit-specific data](#adunit-specific-data)
* [Index's outstream video player](#indexs-outstream-video-player)
* [Prebid Native configuration](#prebid-native-configuration)
* [Protected Audience API support](#protected-audience-api-support)
* [Bid request parameters](#bid-request-parameters)
* [Banner](#banner)
* [Video](#video)
Expand Down Expand Up @@ -387,6 +388,29 @@ pbjs.addAdUnits({
});
```

<a name="protected-audience-api-support"></a>

## Protected Audience API support

**Before you begin:** You must have Google Ad Manager and the [fledgeForGpt](/dev-docs/modules/fledgeForGpt.html) module.

Follow these steps to configure your Prebid.js to specify that your ad slots are enabled for [Protected Audience](https://github.com/WICG/turtledove/blob/main/FLEDGE.md) auctions:
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 [Fledge (Protected Audience) for GPT Module](/dev-docs/modules/fledgeForGpt.html) documentation.
2. Enable all ad units to use the `fledgeForGpt` module in your prebid.js configuration. Index recommends that you do this in the global level configuration by using the `defaultForSlots` parameter with a value of `1`. <br />
**Note:** If you are using the `fledgeForGpt.bidders[]`, make sure that you add `ix` to the list of bidders.<br />
The following shows an example of the configuration done at the global level:

```javascript
pbjs.que.push(function() {
pbjs.setConfig({
fledgeForGpt: {
enabled: true,
defaultForSlots: 1
}
});
});
```

<a name="bid-request-parameters"></a>

## Bid request parameters
Expand Down

0 comments on commit f08750c

Please sign in to comment.