Prebid.js: new PAAPI module documentation #5135

dgirardi · 2024-02-06T23:16:31Z

Prebid.js paapi and fledgeForGpt module doc updates - prebid/Prebid.js#10930

🏷 Type of documentation

new feature

📋 Checklist

Related pull requests in prebid.js or server are linked -> Paste link in this list or reference it on the PR itself

netlify · 2024-02-06T23:16:36Z

✅ Deploy Preview for prebid-docs-preview ready!

Name	Link
🔨 Latest commit	`c00f566`
🔍 Latest deploy log	https://app.netlify.com/sites/prebid-docs-preview/deploys/65dca941d3ed8a0008d23784
😎 Deploy Preview	https://deploy-preview-5135--prebid-docs-preview.netlify.app/dev-docs/modules/fledgeforgpt
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

dev-docs/modules/fledgeForGpt.md

jdwieland8282 · 2024-02-14T22:22:28Z

I thought this module was meant to run independently from gpt.js / GAM?

rdgordon-index · 2024-02-15T13:44:45Z

dev-docs/modules/paapi.md

+  pbjs.setConfig({
+    paapi: {
+      enabled: true,
+      bidders: ['openx', 'rtbhouse'],


suggestion: given that the default is "all bidders", shouldn't the example omit this parameter?

rdgordon-index · 2024-02-15T13:46:18Z

dev-docs/modules/paapi.md

+
+```js
+pbjs.setBidderConfig({
+    bidders: ["openx"],


question: should this be a generic bidder adapter name, like we have for other parameters?

dmdabbs · 2024-02-21T21:42:35Z

dev-docs/modules/fledgeForGpt.md

-selectively test with one or more bidders as they desire. To enable one or more bidders, use the `setBidderConfig` method
-of Prebid.js:
+    ```bash
+   gulp build --modules=fledgeForGpt,...     


Verifying that this module name is correct.

it's an existing module so renaming it is a breaking change and needs to wait for a major version release.

dmdabbs · 2024-02-21T21:46:12Z

dev-docs/modules/fledgeForGpt.md

-| ------------ | ------------ | ------------ |------------ |
-| 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|
+- include this module with your Prebid.js bundle; this also automatically includes the [PAAPI module](/dev-docs/modules/paapi.html)


I find the the two similarly named modules confusing. Perhaps it is clear to folks that swim with modules regularly, but is there an explanation or diagram?

One provides support for paapi; the other adds integration between paapi and gpt. This is stated in the overview. I'm not sure if you mean that's not clear enough, or if something else still needs to be explained (what?)

I missed that flipping between source and rich diff.

dmdabbs · 2024-02-21T21:55:16Z

dev-docs/modules/paapi.md

+{: .table .table-bordered .table-striped }
+|Name |Type |Description |Notes |
+| ------------ | ------------ | ------------ |------------ |
+| fledgeEnabled | Boolean | Enable/disable a bidder to participate in FLEDGE | Defaults to `false` |


I assume this can't be renamed since it would break existing deployed configs.
Could a future looking replacement be introduced, e.g. paapiEnabled, with fledgeEnabled deprecated down the road?

I think we eventually should deprecate this entirely; it's redundant with paapi.enabled (and fledge.enabled). If for consistency we also introduce paapiEnabled, we'll have two things to deprecate.

dmdabbs · 2024-02-21T22:10:12Z

dev-docs/modules/paapi.md

+## Related Reading
+
+- [fledgeForGpt module](/dev-docs/modules/fledgeForGpt.html)
+- [FLEDGE](https://github.com/WICG/turtledove/blob/main/FLEDGE.md)


FLEDGE

suggest

Protected Audience API (PAAPI), formerly FLEDGE

dmdabbs · 2024-02-21T22:12:54Z

dev-docs/publisher-api-reference/setPAAPIConfigForGPT.md

+
+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.


The sibling pbjs.getPAAPIConfig method above indicates this is associated with the PAAPI module.

but setPAAPIConfigForGpt is, as the name suggests, specific to GPT and requires the fledgeForGpt module.

dmdabbs · 2024-02-21T22:13:44Z

dev-docs/modules/paapi.md

+layout: page_v2
+page_type: module
+title: Module - PAAPI
+description: Protected audience API


Protected audience API

s/b

Protected Audience API

from prebid#5128

rdgordon-index · 2024-02-26T17:19:15Z

@dgirardi -- the fact that the module creates an auctionSignals.prebid object -- and what's included therein (added in prebid/Prebid.js#10649) is not mentioned in the documentation -- this PR seems like a good opportunity to capture what setFPDSignals(componentAuctionConfig, {ortb2, ortb2Imp}) actually does, as this in made directly available to all PAAPI functions.

lksharma · 2024-03-13T04:10:47Z

dev-docs/modules/fledgeForGpt.md

-        ext: {
-            ae: 1
+pbjs.setConfig({
+    paapi: {


fledgeForGpt.autoconfig is also supported for now. I think it worth mentioning it since it backwards compatible in the current versions.

pbjs.setConfig({ fledgeForGpt: { autoconfig: false } })

That being said, it does produce a warning.

lksharma · 2024-03-18T18:04:36Z

dev-docs/modules/fledgeForGpt.md

-3. Publisher Prebid.js configuration (detailed above)
-
-When a bid request is FLEDGE enabled, a bid adapter can return a tuple consisting of bids and AuctionConfig objects rather than just a list of bids:
+You may then use `setPAAPIConfigForGPT`, typically from a `bidsBackHandler`:


We should add more context here to ensure pbjs.setPAAPIConfigForGPT(); function is invoked within the bidsBackHandler whenever new bids are requested, such as when refreshing adSlots. This is important because auctionConfig needs to be linked with a GPT slot manually when autoconfig is disabled.

cf. prebid/Prebid.js#11242

muuki88 · 2024-03-21T14:16:10Z

@ChrisHuie will take a look at your comments @lksharma and make the requested changes.

We would then like to merge this to have some documentation at all. @dgirardi , @patmmccann , @dmdabbs would that be fine with you folks?

jdwieland8282 · 2024-03-27T16:27:20Z

@muuki88 , I'd like to make sure @rdgordon-index signs off before we merge this PR, he's been very close to the testing and has been keeping the ID PMC abreast of our progress here.

Prebid.js: new PAAPI module documentation

0e235e5

dgirardi force-pushed the paapi branch from f7b510e to 0e235e5 Compare February 6, 2024 23:20

muuki88 added the not merged yet label Feb 11, 2024

remove references to reuse

bb012b9

patmmccann mentioned this pull request Feb 14, 2024

PAAPI/fledgeForGpt: make auction configs available independently from GPT prebid/Prebid.js#10930

Merged

1 task

dmdabbs reviewed Feb 14, 2024

View reviewed changes

dev-docs/modules/fledgeForGpt.md Outdated Show resolved Hide resolved

dmdabbs reviewed Feb 14, 2024

View reviewed changes

dev-docs/modules/fledgeForGpt.md Outdated Show resolved Hide resolved

rdgordon-index reviewed Feb 15, 2024

View reviewed changes

dgirardi and others added 2 commits February 15, 2024 07:47

feedback

2fb8081

Update paapi.md

4b470e0

jdwieland8282 approved these changes Feb 21, 2024

View reviewed changes

dmdabbs reviewed Feb 21, 2024

View reviewed changes

Update paapi.md

6653fe1

bretg mentioned this pull request Feb 22, 2024

Module fledgeForGpt: Document AuctionConfig fields #5128

Closed

added auctionconfig note

c00f566

from prebid#5128

lksharma reviewed Mar 13, 2024

View reviewed changes

lksharma reviewed Mar 18, 2024

View reviewed changes

muuki88 assigned ChrisHuie Mar 21, 2024

patmmccann merged commit 8bac533 into prebid:master Apr 19, 2024
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prebid.js: new PAAPI module documentation #5135

Prebid.js: new PAAPI module documentation #5135

dgirardi commented Feb 6, 2024

netlify bot commented Feb 6, 2024 •

edited

Loading

jdwieland8282 commented Feb 14, 2024

rdgordon-index Feb 15, 2024

rdgordon-index Feb 15, 2024

dmdabbs Feb 21, 2024

dgirardi Feb 21, 2024

dmdabbs Feb 21, 2024

dgirardi Feb 21, 2024

dmdabbs Feb 21, 2024

dmdabbs Feb 21, 2024

dgirardi Feb 21, 2024

dmdabbs Feb 21, 2024

dmdabbs Feb 21, 2024

dgirardi Feb 21, 2024

dmdabbs Feb 21, 2024

rdgordon-index commented Feb 26, 2024

lksharma Mar 13, 2024

rdgordon-index Apr 21, 2024

lksharma Mar 18, 2024

rdgordon-index Mar 23, 2024

muuki88 commented Mar 21, 2024

jdwieland8282 commented Mar 27, 2024


		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.

Prebid.js: new PAAPI module documentation #5135

Prebid.js: new PAAPI module documentation #5135

Conversation

dgirardi commented Feb 6, 2024

🏷 Type of documentation

📋 Checklist

netlify bot commented Feb 6, 2024 • edited Loading

✅ Deploy Preview for prebid-docs-preview ready!

jdwieland8282 commented Feb 14, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rdgordon-index commented Feb 26, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

muuki88 commented Mar 21, 2024

jdwieland8282 commented Mar 27, 2024

netlify bot commented Feb 6, 2024 •

edited

Loading