Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prebid 9: PAAPI documentation changes #5401

Merged
merged 5 commits into from
Sep 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions dev-docs/bidders/ix.md
Original file line number Diff line number Diff line change
Expand Up @@ -376,33 +376,33 @@ 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
}
});
});
```

**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
Expand All @@ -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.<br />
**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.<br />
* 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.<br />
**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.<br />

```javascript
pbjs.que.push(function() {
Expand Down
6 changes: 3 additions & 3 deletions dev-docs/bidders/medianet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)
23 changes: 11 additions & 12 deletions dev-docs/bidders/rtbhouse.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <prebid@rtbhouse.com>. 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)
Expand All @@ -107,7 +107,6 @@ module documentation.
pbjs.setBidderConfig({
bidders: ["rtbhouse"],
config: {
fledgeEnabled: true,
fledgeConfig: {
seller: 'https://seller.domain',
decisionLogicUrl: 'https://seller.domain/decisionLogicFile.js',
Expand Down
22 changes: 11 additions & 11 deletions dev-docs/bidders/unruly.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading