Skip to content

Commit 3f71f1c

Browse files
Merge branch 'prebid:master' into master
2 parents b46c47a + 9ff579f commit 3f71f1c

6 files changed

Lines changed: 126 additions & 3 deletions

File tree

dev-docs/analytics/agma.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
layout: analytics
3+
title: agma
4+
description: agma Analytics Adapter
5+
modulecode: agma
6+
tcfeu_supported: true
7+
usp_supported: false
8+
coppa_supported: false
9+
prebid_member: false
10+
gvl_id: 1122
11+
---
12+
13+
#### Analytics Options
14+
15+
{: .table .table-bordered .table-striped }
16+
| Name | Scope | Description | Example | Type |
17+
|-------------|---------|--------------------|-----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|------------------|
18+
| code | required | Provided by agma | `'my-code'` | string |
19+
20+
### Example Configuration
21+
22+
```javascript
23+
pbjs.enableAnalytics({
24+
provider: 'agma',
25+
options: {
26+
code: 'provided-by-agma' // change to the code you received from agma
27+
}
28+
});
29+
```
30+
31+
#### Registration
32+
33+
Please contact [team-internet@agma-mmc.de](mailto:team-internet@agma-mmc.de) for signup.

dev-docs/bidders/connatix.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,24 @@ var adUnits = [
5757
// Define more ad units here if necessary
5858
];
5959
```
60+
61+
### Configuration
62+
63+
To maximize revenue efficiency, please enable ```iframe``` user syncing.
64+
65+
Connatix strongly recommends enabling user syncing through iFrames. This functionality improves DSP user match rates and increases the bid rate and bid price. Make sure to call `pbjs.setConfig()` only once. This configuration is optional in Prebid, but required by Connatix.
66+
67+
#### Example configuration
68+
69+
```js
70+
pbjs.setConfig({
71+
userSync: {
72+
filterSettings: {
73+
iframe: {
74+
bidders: ['connatix'],
75+
filter: 'include'
76+
}
77+
}
78+
}
79+
});
80+
```

dev-docs/bidders/ix.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -392,11 +392,16 @@ pbjs.addAdUnits({
392392

393393
## Protected Audience API support
394394

395-
**Before you begin:** You must have Google Ad Manager and the [fledgeForGpt](/dev-docs/modules/fledgeForGpt.html) module.
395+
**Before you begin:**
396+
397+
* You must have Google Ad Manager and the [fledgeForGpt](/dev-docs/modules/fledgeForGpt.html) module.
398+
* You must be using Prebid.js version 8.18.0 or later.
396399

397400
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:
398-
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.
399-
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 />
401+
402+
1. Confirm that you have opted in to use the Protected Audience API in your Google Ad Manager configuration. For more information about how to opt-in, 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).
403+
2. 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.
404+
3. Enable all ad units to use the `fledgeForGpt` module in your prebid.js configuration. You can do this in the global-level configuration, bidder level, or ad-unit level. For more information about the configurations, see Prebid's [Fledge (Protected Audience) 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`. <br />
400405
**Note:** If you are using the `fledgeForGpt.bidders[]`, make sure that you add `ix` to the list of bidders.<br />
401406
The following shows an example of the configuration done at the global level:
402407

@@ -411,6 +416,20 @@ pbjs.que.push(function() {
411416
});
412417
```
413418

419+
The following shows an example of the configuration done at the ad-unit level:
420+
421+
```javascript
422+
pbjs.addAdUnits({
423+
code: "my-adunit-div",
424+
// other config here
425+
ortb2Imp: {
426+
ext: {
427+
ae: 1
428+
}
429+
}
430+
});
431+
```
432+
414433
<a name="bid-request-parameters"></a>
415434

416435
## Bid request parameters

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Core config:
1616
* [Debugging](#setConfig-Debugging)
1717
* [Device Access](#setConfig-deviceAccess)
1818
* [Bidder Timeouts](#setConfig-Bidder-Timeouts)
19+
* [Enable sharing of transaction IDs](#setConfig-enableTIDs)
1920
* [Max Requests Per Origin](#setConfig-Max-Requests-Per-Origin)
2021
* [Disable Ajax Timeout](#setConfig-Disable-Ajax-Timeout)
2122
* [Set Timeout Buffer](#setConfig-timeoutBuffer)
@@ -99,6 +100,16 @@ Note that it's possible for the timeout to be triggered later than expected, lea
99100
With a busy page load, bids can be included in the auction even if the time to respond is greater than the timeout set by Prebid.js. However, we do close the auction immediately if the threshold is greater than 200ms, so you should see a drop off after that period.
100101
For more information about the asynchronous event loop and `setTimeout`, see [How JavaScript Timers Work](https://johnresig.com/blog/how-javascript-timers-work/).
101102

103+
<a id="setConfig-enableTIDs"></a>
104+
105+
#### Enable sharing of transaction IDs
106+
107+
Prebid generates unique IDs for both auctions and ad units within auctions; these can be used by DSPs to correlate requests from different sources, which is useful for many applications but also a potential privacy concern. Since version 8 they are disabled by default (see [release notes](/dev-docs/pb8-notes.html)), and can be re-enabled with `enableTIDs`:
108+
109+
```javascript
110+
pbjs.setConfig({ enableTIDs: true });
111+
```
112+
102113
#### Max Requests Per Origin
103114

104115
<a name="setConfig-Max-Requests-Per-Origin"></a>

prebid-server/endpoints/openrtb2/pbs-endpoint-auction.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,8 @@ if $.id contains "{{UUID}}", replace that macro with a random value
168168

169169
##### request.source.tid
170170

171+
PBS-Go - this will change once [issue 2727](https://github.com/prebid/prebid-server/issues/2727) is implemented to link the transmitTid activity.
172+
171173
```text
172174
if source.tid is not set:
173175
set source.tid to a random UUID
@@ -176,6 +178,16 @@ if host config auto_gen_source_tid (Go) / generate-storedrequest-bidrequest-id (
176178
if $.source.tid contains "{{UUID}}", replace that macro with a random value
177179
```
178180

181+
PBS-Java
182+
183+
```text
184+
if source.tid is not set and the transmitTid activity is allowed:
185+
set source.tid to a random UUID
186+
if host config generate-storedrequest-bidrequest-id config is true and the transmitTid activity is allowed
187+
if the storedrequest is from AMP or from a top-level stored request (ext.prebid.storedrequest), then replace any existing $.source.tid with a random value
188+
if $.source.tid contains "{{UUID}}", replace that macro with a random value
189+
```
190+
179191
##### request.imp[].id
180192

181193
```text
@@ -186,6 +198,8 @@ if host config generate-storedrequest-bidrequest-id config is true
186198

187199
##### request.imp[].ext.tid
188200

201+
PBS-Go - this will change once [issue 2727](https://github.com/prebid/prebid-server/issues/2727) is implemented to link the transmitTid activity.
202+
189203
```text
190204
if imp[n].ext.tid is not set:
191205
set imp[n].ext.tid to a randomly generated UUID
@@ -194,6 +208,17 @@ if imp[n].ext.tid is not set:
194208
if $.imp[n].ext.tid contains "{{UUID}}", replace that macro with a random value
195209
```
196210

211+
PBS-Java
212+
213+
```text
214+
for each imp:
215+
if imp[n].ext.tid is not set and the transmitTid activity is allowed:
216+
set imp[n].ext.tid to a randomly generated UUID
217+
if host config generate-storedrequest-bidrequest-id config is true and the transmitTid activity is allowed
218+
if the storedrequest is from AMP or from a top-level stored request (ext.prebid.storedrequest), then replace any existing $.imp[n].ext.tid with a random value
219+
if $.imp[n].ext.tid contains "{{UUID}}", replace that macro with a random value
220+
```
221+
197222
#### Expiration
198223

199224
The `imp[].exp` field is an "Advisory as to the number of seconds that may elapse
@@ -906,6 +931,18 @@ To be deprecated for `request.imp[].rwdd` introduced in OpenRTB 2.6.
906931
Rewarded video is a way to incentivize users to watch ads by giving them 'points' for viewing an ad. A Prebid Server
907932
client can declare a given adunit as eligible for rewards by declaring `imp.ext.prebid.is_rewarded_inventory:1`.
908933

934+
##### Create Transaction ID
935+
936+
The request can contain the global `createtid` flag to control the `transmitTid` [Activity Control](/prebid-server/features/pbs-activitycontrols.html).
937+
938+
```text
939+
ext.request.createtid: false
940+
```
941+
942+
If the value is `false`, the `transmitTid` activity is overridden to "denied", which means bid adapters will not get unique transaction IDs. If not specified, then the value of the transmitTid activity for the account is used. The overall default value it `true`, which translates to "allow" the generation of TIDs.
943+
944+
See the [endpoint documentation on IDs](/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.html#ids) for details on how PBS creates the various IDs including transaction IDs.
945+
909946
##### Debug Flag
910947

911948
The OpenRTB `test` flag has a special meaning that bidders may react to: they may not perform a normal auction, or may not pay for test requests.
@@ -1734,6 +1771,7 @@ The Prebid SDK version comes from:
17341771
| ext<wbr>.prebid<wbr>.server | additional Prebid Server metadata | object | yes |
17351772
| ext<wbr>.prebid<wbr>.pbs.endpoint | additional Prebid Server metadata | string | yes |
17361773
| ext<wbr>.prebid<wbr>.floors | PBS floors data | object | no |
1774+
| ext<wbr>.prebid<wbr>.createtid | Ties to the transmitTid activity. If false, transmitTid is denied. | boolean | no |
17371775
| ext<wbr>.prebid<wbr>.returnallbidstatus | If true, PBS returns [ext.seatnonbid](#seat-non-bid) with details about bidders that didn't bid. | boolean | no |
17381776
| ext<wbr>.prebid<wbr>.analytics | Arguments that can be passed through to individual analytics adapters | object | no |
17391777
| imp<wbr>.ext<wbr>.ae | If 1, signals bid adapters that Fledge auction config is accepted on the response. (ae stands for auction environment) | integer | yes |

prebid-server/features/pbs-activitycontrols.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,7 @@ Here's the list of the 'potentially restricted activities' that Prebid Server co
189189
| `reportAnalytics` | The [/auction](/prebid-server/endpoints/openrtb2/pbs-endpoint-auction.html), [/amp](/prebid-server/endpoints/openrtb2/pbs-endpoint-amp.html), or [/event](/prebid-server/endpoints/pbs-endpoint-event.html) endpoint is about to call an analytics adapter. | Adapter is not called. |
190190
| `transmitUfpd` | A bid adapter, analytics adapter, or module wants to access and/or transmit user FPD or EIDs to their endpoint. (Note: this differs from Prebid.js where these are separate activities.) | User FPD and EIDs are hidden from the adapter or module: `user.data`, `user.ext.data`, `user.{id, buyeruid, yob, gender}`, `user.eids`, `device.{device.ifa, macsha1, macmd5, dpidsha1, dpidmd5, didsha1, didmd5}` |
191191
| `transmitPreciseGeo` | A bid adapter, analytics adapter, or module wants to access and/or transmit precise geolocation data to their endpoint | Latitude, longitude, and IP address are rounded off. Specifically, lat and long are truncated to two decimal places, IPv4 masks rightmost 8 bits, IPv6 masks the rightmost bits based on a configured value. |
192+
| `transmitTid` | (PBS-Java only) The source.tid and imp.ext.tid fields can be generated or suppressed by PBS before going to bidders. The ext.prebid.createtid request parameter overrides the allow state of this activity. If `ext.prebid.createtid:false`, transmitTid is "denied". | If "allowed", then source.tid and imp.ext.tid will be generated by PBS. Otherwise, they won't be generated. |
192193

193194
<a id="rules"></a>
194195

0 commit comments

Comments
 (0)