From 1a3f650fa5fb4ac882b06abd8c2cfe79f9b206ec Mon Sep 17 00:00:00 2001 From: bretg Date: Mon, 16 Dec 2024 09:31:25 -0500 Subject: [PATCH] Update pbs-endpoint-auction.md (#5779) changed imp.ext to imp[].ext --- .../openrtb2/pbs-endpoint-auction.md | 33 ++++++++++--------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.md b/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.md index b885c64890..c6d3d950f3 100644 --- a/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.md +++ b/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.md @@ -117,7 +117,7 @@ This is a corresponding sample response to a sample bid request: Prebid Server's support for Fledge is a passthrough: -1. If the request contains `imp.ext.ae: 1` +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 [PAAPI for GPT](/dev-docs/modules/paapiForGpt.html) module for more information. @@ -140,7 +140,7 @@ Prebid Server accepts all OpenRTB 2.x fields and passes them in the request to a | regs.gdpr | 2.6 | Bidders supporting 2.5 only: downgraded to regs.ext.gdpr | | regs.us_privacy | 2.6 | Bidders supporting 2.5 only: downgraded to regs.ext.us_privacy | | user.consent | 2.6 | Bidders supporting 2.5 only: downgraded to user.ext.consent | -| imp.rwdd | 2.6 | Bidders supporting 2.5 only: downgraded to imp.ext.prebid.is_rewarded_inventory | +| imp.rwdd | 2.6 | Bidders supporting 2.5 only: downgraded to imp[].ext.prebid.is_rewarded_inventory | | user.eids | 2.6 | Bidders supporting 2.5 only: downgraded to user.ext.eids | | source.schain | 2.6 | Bidders supporting 2.5 only: downgraded to source.ext.schain | | wlangb, {content, device}.langb, cattax, {site, app, publisher, content, producer}.cattax, ssai, {app, site}.content.{network, channel}, {app, content, site, user}.kwarray, device.sua | 2.6 | Bidders supporting 2.5 only: these fields are removed | @@ -771,7 +771,7 @@ For example, if the Request defines an alias like this: } ``` -then any `imp.ext.appnexus` params will actually go to the **rubicon** adapter. +then any `imp[].ext.appnexus` params will actually go to the **rubicon** adapter. It will become impossible to fetch bids from AppNexus within that Request. ##### Bidder Alias GVL IDs @@ -1072,7 +1072,7 @@ ext.prebid.data.eidpermissions is an array of objects that can contain these att To be deprecated for `request.imp[].rwdd` introduced in OpenRTB 2.6. Rewarded video is a way to incentivize users to watch ads by giving them 'points' for viewing an ad. A Prebid Server -client can declare a given adunit as eligible for rewards by declaring `imp.ext.prebid.is_rewarded_inventory:1`. +client can declare a given adunit as eligible for rewards by declaring `imp[].ext.prebid.is_rewarded_inventory:1`. ##### Create Transaction ID @@ -1119,7 +1119,7 @@ Provides a way to override multiple bidder responses for this impression, retrie When a storedauctionresponse ID is specified: -- the rest of the imp.ext.prebid block is irrelevant and ignored +- the rest of the imp[].ext.prebid block is irrelevant and ignored - nothing is sent to any bidder adapter for that imp - the response retrieved is assumed to be the entire contents of the seatbid object corresponding to that impression. @@ -1227,7 +1227,7 @@ Provides a way to override multiple bidder responses for this impression, with t When storedauctionresponse JSON is specified: -- the rest of the imp.ext.prebid block is irrelevant and ignored +- the rest of the imp[].ext.prebid block is irrelevant and ignored - nothing is sent to any bidder adapter for that imp - the JSON in the request is assumed to be the entire contents of the seatbid object corresponding to that impression. @@ -1302,7 +1302,7 @@ Provides a way to override the entire bid response, with the contents supplied o When storedauctionresponse JSON is specified at the global level: -- all imp.ext.prebid.storedauctionresponse blocks are irrelevant and ignored +- all imp[].ext.prebid.storedauctionresponse blocks are irrelevant and ignored - nothing is sent to any bidder adapter - the JSON in the request is assumed to be the entire contents of the seatbid response @@ -1362,9 +1362,9 @@ Note: the `##PBSIMPID##` macro is only supported in PBS-Java. Please use `"repla In contrast to the stored**auction**responses above, using a stored**bid**response lets real auctions take place while the actual bidder response is overridden in such a way that it still exercises adapter code. -PBS removes imp.ext.prebid.bidder parameters for those +PBS removes imp[].ext.prebid.bidder parameters for those bidders specified in storedbidresponse but if there's a bidder present -in imp.ext.prebid.bidder that's doesn't have a storedbidresponse specified, +in imp[].ext.prebid.bidder that's doesn't have a storedbidresponse specified, the adapter will be called as usual. For example, this request: @@ -1458,7 +1458,7 @@ Prebid defines several types of First Party Data (FPD): 1. Cross-impression contextual information. e.g. the content category of the page. This data goes in the `site.ext.data` object or the `app.ext.data` object. 1. User-level information. e.g. whether the user is a registered user. This data goes in `user.ext.data`. -1. Impression-level information. e.g. the Global Placement ID. This data goes in the `imp.ext.data` object. +1. Impression-level information. e.g. the Global Placement ID. This data goes in the `imp[].ext.data` object. 1. Seller-Defined Audience (SDA) contextual data. This goes in `site.data[]` or `app.data[]` in accordance with the [IAB segment taxonomy conventions](https://github.com/InteractiveAdvertisingBureau/openrtb/blob/main/extensions/community_extensions/segtax.md). 1. SDA user data goes in `user.data[]` with the same [conventions](https://github.com/InteractiveAdvertisingBureau/openrtb/blob/main/extensions/community_extensions/segtax.md) as the contextual data. @@ -1566,10 +1566,10 @@ When Prebid Server sees `imp[].ext.prebid.imp.BIDDER`, the behavior is to: 1. When passing this imp to that bidder, merge the contents of BIDDER into the imp 1. Remove the imp[].ext.prebid.imp object 1. Leave any imp[].ext.prebid.storedrequest object -1. The imp.ext.prebid.imp.BIDDER object name is case insensitive and supports aliases -1. If imp.ext.prebid.imp.BIDDER does not resolve to an actual bidder or alias in a case-insensitive way, it is ignored with a warning when in debug mode. -1. No validation is done on imp.ext.prebid.imp.BIDDER.ext except that imp.ext.prebid.imp.BIDDER.ext.prebid.BIDDER is removed. -1. The contents of imp.ext.prebid.imp.BIDDER takes precedence in the merge if the field already exists in the request. +1. The imp[].ext.prebid.imp.BIDDER object name is case insensitive and supports aliases +1. If imp[].ext.prebid.imp.BIDDER does not resolve to an actual bidder or alias in a case-insensitive way, it is ignored with a warning when in debug mode. +1. No validation is done on imp[].ext.prebid.imp.BIDDER.ext except that imp[].ext.prebid.imp.BIDDER.ext.prebid.BIDDER is removed. +1. The contents of imp[].ext.prebid.imp.BIDDER takes precedence in the merge if the field already exists in the request. 1. The resulting imp object must be valid OpenRTB per the system schema. Here's an example showing a scenario showing a storedrequest-based scenario: @@ -2133,7 +2133,9 @@ The Prebid SDK version comes from: | imp[].ext.prebid.storedrequest.id | Look up the defined stored request and merge the DB contents with this imp, see [stored requests](/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.html#stored-requests). | object | no (yes with [issue 2292](https://github.com/prebid/prebid-server/issues/2292) | | imp[].ext.prebid.is_rewarded_inventory | (deprecated) Passed through to bid adapters, see [rewarded video](/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.html#rewarded-video). (use imp.rwdd in ORTB 2.6) | integer | yes | | imp[].ext.prebid.passthrough | Copied to the response in seatbid.bid.ext.prebid.passthrough. Allows an application to pass a value through to the response, see [request passthrough](#request-passthrough). | object | no | -| imp.ext.prebid.adunitcode | Prebid.js adunit code | string | yes | +| imp[].ext.prebid.adunitcode | Prebid.js adunit code | string | yes | +| imp[].ext.igs.ae | If 1, signals bid adapters that Protected Audience config is accepted on the response. Note: 'ae' stands for 'auction environment'. | integer | yes | +| imp[].ext.ae | If 1, signals bid adapters that Fledge auction config is accepted on the response. Note: this parameter has been replaced with imp[].ext.igs.ae | integer | yes | | device.ext.prebid.interstitial | PBS-core will adjust the sizes on a request for interstitials,see [interstitial support](/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.html#interstitial-support). | object | yes | | user.ext.prebid.buyeruids | An alternate to [/cookie_sync](/prebid-server/endpoints/pbs-endpoint-cookieSync.html), the request can supply bidder ID values, see [buyer uid](#buyer-uid). | object | no | | ext.prebid.adservertargeting | advanced targeting value rules, see [custom targeting](/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.html#custom-targeting). | object | no | @@ -2164,7 +2166,6 @@ The Prebid SDK version comes from: | ext.prebid.returnallbidstatus | If true, PBS returns [ext.seatnonbid](#seat-non-bid) with details about bidders that didn't bid. | boolean | no | | ext.prebid.analytics | Arguments that can be passed through to individual analytics adapters | object | no | | ext.prebid.analytics.options.enableclientdetails | Requests that [aTags](/prebid-server/developers/module-atags.html) be sent to the client-side for analytics. | boolean | no | -| imp.ext.ae | If 1, signals bid adapters that Fledge auction config is accepted on the response. (ae stands for auction environment) | integer | yes | | app.ext.prebid.source | The client that created this ORTB. Normally "prebid-mobile" | string | yes | | app.ext.prebid.version | The version of the client that created this ORTB. e.g. "1.1" | string | yes | | ext.prebid.biddercontrols.BIDDERCODE.prefmtype | Override the mediatype sent to the named bidder if they don't support multiformat. | string | no |