Skip to content

Commit

Permalink
Merge branch 'master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
gguridi committed Jul 9, 2024
2 parents 676887a + c6eed11 commit 91a97a6
Show file tree
Hide file tree
Showing 130 changed files with 2,179 additions and 763 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ jobs:
name: run markdownlint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: tj-actions/changed-files@v41
- uses: tj-actions/changed-files@v44
id: changed-files
with:
files: '**/*.md'
separator: ","
- uses: DavidAnson/markdownlint-cli2-action@v15
- uses: DavidAnson/markdownlint-cli2-action@v16
if: steps.changed-files.outputs.any_changed == 'true'
with:
globs: "${{ steps.changed-files.outputs.all_changed_files }},!_includes"
Expand Down
18 changes: 1 addition & 17 deletions _data/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -257,14 +257,6 @@
sectionTitle:
subgroup: 1

- sbSecId: 1
title: Legacy Browser Example
link: /dev-docs/examples/legacy-browser-example.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 1

- sbSecId: 1
title: Using Prebid.js with Microsoft Monetize Ad Server
link: /dev-docs/examples/use-prebid-with-appnexus-ad-server.html
Expand Down Expand Up @@ -1486,14 +1478,6 @@
sectionTitle:
subgroup: 3

- sbSecId: 5
title: Programmatic Guaranteed
link: /prebid-server/features/pg/pbs-pg-idx.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 3

- sbSecId: 5
title: Modules
link: /prebid-server/pbs-modules/
Expand Down Expand Up @@ -1801,7 +1785,7 @@
subgroup: 1

- sbSecId: 7
title: Prebid and MSPA
title: Prebid US Compliance
link: /features/mspa-usnat.html
isHeader: 0
isSectionHeader: 0
Expand Down
21 changes: 19 additions & 2 deletions assets/js/download.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
// show all adapters
$(".adapters .col-md-4").show();
setPrepickedModules();

document.getElementById('download-button').addEventListener('click', function (event) {
event.preventDefault();
submit_download();
Expand Down Expand Up @@ -112,6 +112,23 @@
});
}

const renameModules = (function() {
const RENAMES = [
[
/^8\./,
{
tcfControl: 'gdprEnforcement',
consentManagementTcf: 'consentManagement',
paapiForGpt: 'fledgeForGpt'
}
]
];
return function(version, modules) {
const renames = RENAMES.find(([pat]) => pat.test(version))?.[1] || {};
return modules.map(mod => renames.hasOwnProperty(mod) ? renames[mod] : mod)
}
})();

function get_form_data() {
var modules = [];
var version = $(".selectpicker").val();
Expand All @@ -138,7 +155,7 @@
});

return {
modules,
modules: renameModules(version, modules),
version,
removedModules,
};
Expand Down
4 changes: 2 additions & 2 deletions dev-docs/activity-controls.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ For example, this rule would allow bidderX to perform the activity if no higher
Activity control rules in Prebid.js can be created by two main sources:

* Publisher `setConfig({allowActivities})` as in the examples shown here. When set this way, rules are considered the highest priority value of 1.
* Modules can set activity control rules, e.g. [usersync](/dev-docs/publisher-api-reference/setConfig.html#setConfig-Configure-User-Syncing), [bidderSettings](/dev-docs/publisher-api-reference/bidderSettings.html), the [GPP](/dev-docs/modules/consentManagementGpp.html) or [GDPR](/dev-docs/modules/gdprEnforcement.html) modules. Rules set by modules have a less urgent priority of 10.
* Modules can set activity control rules, e.g. [usersync](/dev-docs/publisher-api-reference/setConfig.html#setConfig-Configure-User-Syncing), [bidderSettings](/dev-docs/publisher-api-reference/bidderSettings.html), the [GPP](/dev-docs/modules/consentManagementGpp.html) or [GDPR](/dev-docs/modules/tcfControl.html) modules. Rules set by modules have a less urgent priority of 10.

When rules are processed, they are sorted by priority, and all rules of the same priority are considered to happen at the same time. The details:

Expand Down Expand Up @@ -234,7 +234,7 @@ If `allow` is not defined, the rule is assumed to assert **true** (i.e. allow th

#### Always include a particular bidder in auctions

This is similiar to the 'vendor exception' feature of the [GDPR Enforcement Module](/dev-docs/modules/gdprEnforcement.html). This would always allow bidderA to participate in the auction, even without explicit consent in GDPR scenarios. It might indicate, for instance, that this is a 'first party bidder'.
This is similiar to the 'vendor exception' feature of the [TCF Control Module](/dev-docs/modules/tcfControl.html). This would always allow bidderA to participate in the auction, even without explicit consent in GDPR scenarios. It might indicate, for instance, that this is a 'first party bidder'.

```javascript
pbjs.setConfig({
Expand Down
2 changes: 1 addition & 1 deletion dev-docs/add-rtd-submodule.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ submodule('realTimeData', subModuleObject);

Several of the interfaces get a `userConsent` object. It's an object that carries these attributes:

* [gdpr](/dev-docs/modules/consentManagement.html#bidder-adapter-gdpr-integration) - GDPR
* [gdpr](/dev-docs/modules/consentManagementTcf.html#bidder-adapter-gdpr-integration) - GDPR
* [usp](/dev-docs/modules/consentManagementUsp.html#bidder-adapter-us-privacy-integration) - US Privacy (aka CCPA)
* [coppa](/dev-docs/publisher-api-reference/setConfig.html#setConfig-coppa) - the Child Online Privacy Protection Act

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: analytics
title: PrebidManager
description: PrebidManager Analytics Adapter
modulecode: prebidmanager
title: Asteriobid PBM
description: Asteriobid PBM Analytics Adapter
modulecode: asteriobidpbm
---

#### Registration
Expand Down
15 changes: 14 additions & 1 deletion dev-docs/analytics/concert.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,21 @@ title: Concert
description: Concert Analytics Adapter
modulecode: concert
enable_download: false
prebid_member: false
tcfeu_supported: false
usp_supported: true
gvl_id: N/A
coppa_supported: false
---

#### Registration

Please visit [concert.io](https://concert.io/) for more information.
The Concert analytics adapter requires setup and approval from the Concert team. Please reach out to <[email protected]> or visit [concert.io](https://concert.io/) for more information.

### Example Configuration

```javascript
pbjs.enableAnalytics({
provider: 'concert',
});
```
1 change: 1 addition & 0 deletions dev-docs/analytics/eplanning.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ layout: analytics
title: ePlanning
description: ePlanning Analytics Adapter
modulecode: eplanning
pbjs_version_notes: removed in 9.0
---

#### Registration
Expand Down
1 change: 1 addition & 0 deletions dev-docs/analytics/growthcode.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Please visit [growthcode.io](https://growthcode.io/) for more information.

#### Analytics Options

{: .table .table-bordered .table-striped }
| Param enableAnalytics | Scope | Type | Description | Example |
|-----------------------|----------|--------|---------------------------------------------------------|--------------------------|
| provider | Required | String | The name of this Adapter. | `"growthCodeAnalytics"` |
Expand Down
10 changes: 0 additions & 10 deletions dev-docs/analytics/marsmedia.md

This file was deleted.

2 changes: 1 addition & 1 deletion dev-docs/analytics/sharethrough.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ gulp bundle --modules=gptPreAuction,sharethroughBidAdapter,sharethroughAnalytics
Please note that the above snippet is a "bare bones" example - you will likely want to include other modules as well. A more realistic example might look something like the example below (with other bid adapters also included in the list as needed):

```sh
gulp bundle --modules=gptPreAuction,consentManagement,consentManagementGpp,consentManagementUsp,enrichmentFpdModule,gdprEnforcement,sharethroughBidAdapter,sharethroughAnalyticsAdapter
gulp bundle --modules=gptPreAuction,consentManagementTcf,consentManagementGpp,consentManagementUsp,enrichmentFpdModule,tcfControl,sharethroughBidAdapter,sharethroughAnalyticsAdapter
```

Enable the Sharethrough Analytics Adapter in Prebid.js using the analytics provider `sharethrough` as seen in the **Example Configuration** section.
1 change: 1 addition & 0 deletions dev-docs/analytics/sigmoid.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
layout: analytics
title: Sigmoid
description: Sigmoid Analytics Adapter
pbjs_version_notes: removed in 9.0
modulecode: sigmoid
---

Expand Down
16 changes: 16 additions & 0 deletions dev-docs/analytics/smartyads.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
layout: analytics
title: Smartyads
description: Smartyads Analytics Adapter
modulecode: smartyads
---

#### Example Configuration

```javascript
pbjs.que.push(function () {
pbjs.enableAnalytics({
provider: 'smartyads'
});
});
```
1 change: 1 addition & 0 deletions dev-docs/analytics/sonobi.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ layout: analytics
title: Sonobi
description: Sonobi Analytics Adapter
modulecode: sonobi
pbjs_version_notes: removed in 9.0
enable_download: false
---

Expand Down
1 change: 1 addition & 0 deletions dev-docs/analytics/sovrn.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: Sovrn
description: Sovrn Analytics Adapter
modulecode: sovrn
prebid_member: true
pbjs_version_notes: removed in 9.0
enable_download: false
---

Expand Down
1 change: 1 addition & 0 deletions dev-docs/analytics/staq.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
layout: analytics
title: STAQ
description: STAQ Analytics Adapter
pbjs_version_notes: removed in 9.0
modulecode: staq
---

Expand Down
2 changes: 1 addition & 1 deletion dev-docs/bidder-adaptor.md
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ Notes on parameters in the bidderRequest object:
Some of the data in `ortb2` is also made available through other `bidderRequest` fields:
* **refererInfo** is provided so you don't have to call any utils functions. See below for more information.
* **gdprConsent** is the object containing data from the [GDPR ConsentManagement](/dev-docs/modules/consentManagement.html) module. For TCF2+, it will contain both the tcfString and the addtlConsent string if the CMP sets the latter as part of the TCData object.
* **gdprConsent** is the object containing data from the [TCF ConsentManagement](/dev-docs/modules/consentManagementTcf.html) module. For TCF2+, it will contain both the tcfString and the addtlConsent string if the CMP sets the latter as part of the TCData object.
* **uspConsent** is the object containing data from the [US Privacy ConsentManagement](/dev-docs/modules/consentManagementUsp.html) module.
<a id="tid-warning"></a>
Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/adbookpsp.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ coppa_supported: true
usp_supported: true
pbjs: true
pbs: false
pbjs_version_notes: removed in 9.0
sidebarType: 1
---

Expand Down
19 changes: 17 additions & 2 deletions dev-docs/bidders/adnuntius.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,9 @@ pbjs.setBidderConfig({
});
```

### Disable cookies for adnuntius
### Disable cookies for Adnuntius

You have the option to tell adnuntius not to set cookies in your browser. This does not mean that third party ads being served through the ad server will not set cookies. Just that Adnuintius will not set it for internal ads.
You have the option to tell adnuntius not to set cookies in your browser. This does not mean that third party ads being served through the ad server will not set cookies. Just that Adnuntius will not set it for internal ads.

```js
pbjs.setBidderConfig({
Expand All @@ -101,6 +101,21 @@ pbjs.setBidderConfig({

Use cookie will always be set to true by default. Changing it to false will disable cookies.

### Trigger Advertiser Transparency Mode in Adnuntius

You have the option to tell Adnuntius to only serve ads that have their Advertiser's legal name specified.

```js
pbjs.setBidderConfig({
bidders: ['adnuntius'],
config: {
advertiserTransparency: true
}
});
```

By default, `advertiserTransparency` is set to `false`, meaning there is no restriction on which ads can deliver. By setting `advertiserTransparency` to `true`, ad delivery is restricted to those that have their Advertiser's legal name specified.

### Prebid Server Test Request

The following test parameters can be used to verify that Prebid Server is working properly with the server-side Adnuntius adapter. the `auId` below will not return a creative. Please substitute it with your own.
Expand Down
4 changes: 2 additions & 2 deletions dev-docs/bidders/aidem.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ This module is GDPR and CCPA compliant, and no 3rd party userIds are allowed.
{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|--------|----------|--------------------------------------------------------------------------------------------------|---------|----------|
| `gdpr` | optional | GDPR Object see [Prebid.js doc](https://docs.prebid.org/dev-docs/modules/consentManagement.html) | `{}` | `Object` |
| `gdpr` | optional | GDPR Object see [Prebid.js doc](https://docs.prebid.org/dev-docs/modules/consentManagementTcf.html) | `{}` | `Object` |
| `usp` | optional | USP Object see [Prebid.js doc](https://docs.prebid.org/dev-docs/modules/consentManagementUsp.html) | `{}` | `Object` |

#### Example Banner ad unit
Expand Down Expand Up @@ -212,7 +212,7 @@ For video: gulp serve --modules=aidemBidAdapter,dfpAdServerVideo

## FAQs

#### How do I view AIDEM bid request?
### How do I view AIDEM bid request?

Navigate to a page where AIDEM is setup to bid. In the network tab,
search for requests to `zero.aidemsrv.com/bid/request`.
3 changes: 3 additions & 0 deletions dev-docs/bidders/appnexus.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ All AppNexus (Xandr) placements included in a single call to `requestBids` must

#### Bid Params

{: .alert.alert-danger :}
Starting with Prebid.js version 9.0, an update was made to the `appnexusBidAdapter.js` file to remove the support for the `transformBidParams` function. Previously this standard adapter function was used in conjunction of Prebid.js > PBS requests to modify any bid params for that bidder to the bid param format used by the PBS endpoint. Part of the changes for 9.0 in general were to remove these functions from the client-side adapter files, in order to reduce the build size of Prebid.js for those publishers who wanted to make the PBS requests. In the case of our adapter, we instead created a new module named `anPspParamsConverter` that would mimic behavior of the `transformBidParams` function. There's no setup instructions needed on the Prebid.js configs, the module only needs to be included in the Prebid.js build file and it will perform the needed steps. If you have any questions on this change, please reach out to your Microsoft representative and they can help.

{: .alert.alert-danger :}
Starting with Prebid.js version 7.36.0, an update was made to the `appnexusBidAdapter.js` file to support bid params in a lower-case underscore format (eg `invCode` to `inv_code`) similar to how the params are formatted for the Prebid Server AppNexus bidder. This change was implemented to streamline publisher setups for both projects instead of maintaining separate versions of the same params depending on what setup is used.
To avoid breaking changes, the old 'camelCase' format is still currently supported for all AppNexus bid params in the `appnexusBidAdapter.js` file. If you are using an older version of Prebid.js, you will need to continue to use the older 'camelCase' format as appropriate.
Expand Down
47 changes: 0 additions & 47 deletions dev-docs/bidders/bizzclick.md

This file was deleted.

Loading

0 comments on commit 91a97a6

Please sign in to comment.