Skip to content

Commit

Permalink
Markdown lint fixes #2
Browse files Browse the repository at this point in the history
  • Loading branch information
@muuki88
muuki88 committed Jun 15, 2023
1 parent 36141da commit 4dcc7ee
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 30 deletions.
8 changes: 5 additions & 3 deletions dev-docs/modules/zeusPrimeRtdProvider.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ sidebarType: 1

# Zeus Prime Real Time Data Module

# NOTE: ZEUS PRIME HAS BEEN DEPRECATED!
# NOTE: ZEUS PRIME HAS BEEN DEPRECATED

# THIS MODULE NO LONGER FUNCTIONS AND WILL BE REMOVED FROM A
# FUTURE VERSION OF PREBID.

# FUTURE VERSION OF PREBID

The Zeus Prime RTD Provider provides integration of Zeus Prime onto sites with Prebid. This module will request information from Zeus Prime servers to add the page level targeting required for Prime into the customer's ad setup.

Expand All @@ -27,7 +29,7 @@ For more information and help with setting up Zeus Prime, see the [onboarding do

To use Zeus Prime, add `zeusPrimeRtdProvider` into your Prebid build:

```
```bash
gulp build --modules=rtdModule,zeusPrimeRtdProvider
```

Expand Down
12 changes: 6 additions & 6 deletions dev-docs/pb7-notes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Details on all of these below.

## Removed Modules

The following modules have been removed from Prebid.js as part of the 7.0 release. Publishers building with one of them will need to point to its replacement or remove the module from their build.
The following modules have been removed from Prebid.js as part of the 7.0 release. Publishers building with one of them will need to point to its replacement or remove the module from their build.

{: .table .table-bordered .table-striped }

Expand All @@ -45,15 +45,15 @@ The following modules have been removed from Prebid.js as part of the 7.0 releas

## Adapter Interface

Following the precedent of Prebid 5, bidders must read additional values from the ad unit, global config, or the ortb2 object. Bidders may still take these values as parameters, but must also support the Prebid conventions; publishers do not want to set these values multiple times, one for each bid parter. Publishers can now rely on certain parameters no longer needing to be set in bidder configuration, including (a) the instl flag on an ad unit, (b) the position parameter, and (c) the banned categories (bcats). Bidders should consider that if they are accepting any openrtb field in their configuration, they should also check the ortb2 object for that parameter.
Following the precedent of Prebid 5, bidders must read additional values from the ad unit, global config, or the ortb2 object. Bidders may still take these values as parameters, but must also support the Prebid conventions; publishers do not want to set these values multiple times, one for each bid parter. Publishers can now rely on certain parameters no longer needing to be set in bidder configuration, including (a) the instl flag on an ad unit, (b) the position parameter, and (c) the banned categories (bcats). Bidders should consider that if they are accepting any openrtb field in their configuration, they should also check the ortb2 object for that parameter.

In the Prebid 5 release notes, it was noted that publishers should no longer use publisherDomain as a setConfig parameter, and instead prefer PageURL. Adapters no longer read from this location. Also, the object presented to bidders with the page url and that page's referring page url has been re-implemented. Our goal was that adapters can rely on ortb2.site.page and ortb2.site.ref, with flags for when top is not reached, the canonical link is used, setConfig('pageUrl') is used, or when window.location.href is used for ortb2.site.page. Many bidders had disparate logic for this and the refererInfo.referer had different meanings in different contexts.

Also, Bid Adapters (not other types of modules) no longer have access to the storage manager unless explicitly allowed by the publisher. We believe bidding functionality should rarely (if ever) need this access and that this extra functionality included in bid adapters must be consented to by the installer in their configuration. The following bid adapters' unit tests were affected by this change: Adagio, Adnuntius, AP Stream, Concert, Conversant, Craft, Criteo, E-Planning, Invibes, Kargo, Quantcast, Trion, Unicorn, and Vidazoo. Adapters simply setting a random identifier in the first party local storage or cookie should consider if the popular shared id user id submodule can fully achieve this functionality for them. See storageAllowed in the [BidderSettings Reference](/dev-docs/publisher-api-reference/bidderSettings.html#2-bidder-setting-attributes)
Also, Bid Adapters (not other types of modules) no longer have access to the storage manager unless explicitly allowed by the publisher. We believe bidding functionality should rarely (if ever) need this access and that this extra functionality included in bid adapters must be consented to by the installer in their configuration. The following bid adapters' unit tests were affected by this change: Adagio, Adnuntius, AP Stream, Concert, Conversant, Craft, Criteo, E-Planning, Invibes, Kargo, Quantcast, Trion, Unicorn, and Vidazoo. Adapters simply setting a random identifier in the first party local storage or cookie should consider if the popular shared id user id submodule can fully achieve this functionality for them. See storageAllowed in the [BidderSettings Reference](/dev-docs/publisher-api-reference/bidderSettings.html#2-bidder-setting-attributes)

Adapters are no longer allowed to return alternate bidder codes unless allowed by the publisher. See allowAlternateBidderCodes in the [BidderSettings Reference](/dev-docs/publisher-api-reference/bidderSettings.html#2-bidder-setting-attributes).

Finally, adapters known to use HTTP-1 bidding endpoints may now have notices appended to their documentation.
Finally, adapters known to use HTTP-1 bidding endpoints may now have notices appended to their documentation.

## Regulatory and Consent Strings

Expand All @@ -63,11 +63,11 @@ TCF1 is no longer supported by the Consent Management (GDPR) module. The Consent

Support has been removed for `setConfig('fpd')`, `config.getLegacyFpd`, `config.convertAdUnitFpd` and related relics of legacy first party data. Publishers should use the methods described in [First Party Data]({{site.baseurl}}/features/firstPartyData.html).

First party data can also now be set on a specific auction. This is useful for example on infinite scroll pages when contextual segments change, or when the publisher wishes to express the context of an instream video ad but not the display advertising. As part of this change the ortb2 object is now made a part of bid requests, instead of necesitating a getConfig call by an adapter. This has led to slight changes in many dozens of bid adapters and substantial changes to all of the RTD adapters.
First party data can also now be set on a specific auction. This is useful for example on infinite scroll pages when contextual segments change, or when the publisher wishes to express the context of an instream video ad but not the display advertising. As part of this change the ortb2 object is now made a part of bid requests, instead of necesitating a getConfig call by an adapter. This has led to slight changes in many dozens of bid adapters and substantial changes to all of the RTD adapters.

## Prebid Server Adapter

An undocumented feature "Stored Auction Response" has been deprecated.
An undocumented feature "Stored Auction Response" has been deprecated.

The Prebid Server committee moved the ortb2 location of bidder parameters from `imp[].ext.BIDDER` to `imp[].ext.prebid.bidder.BIDDER`. PBS versions before PBS-Go 0.66 (April 2019) and PBS-Java 1.55 (Feb 2021) are not compatible with Prebid 7+.

Expand Down
37 changes: 19 additions & 18 deletions dev-docs/pb8-notes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebarType: 1
---

# Prebid.js 8.0 Bidder Interface and Publisher API Changes

{:.no_toc}

This document describes the changes included for Prebid.js version 8.0.
Expand All @@ -24,7 +25,7 @@ Details on all of these below.

## Removed Modules

The following modules have been removed from Prebid.js as part of the 8.0 release. Publishers building with one of them will need to point to its replacement or remove the module from their build.
The following modules have been removed from Prebid.js as part of the 8.0 release. Publishers building with one of them will need to point to its replacement or remove the module from their build.

{: .table .table-bordered .table-striped }
| Module | Replacement |
Expand All @@ -49,36 +50,36 @@ The following modules have been removed from Prebid.js as part of the 8.0 releas

## Transaction identifiers are now reliable and opt in

Following the [OpenRTB 2.6 spec](https://github.com/InteractiveAdvertisingBureau/openrtb2.x/blob/main/2.6.md) and the [imp.ext.tid](https://github.com/InteractiveAdvertisingBureau/openrtb/blob/master/extensions/community_extensions/per-imp-tids.md) community extensions, several fields in Prebid have equivalents in OpenRTB.
Following the [OpenRTB 2.6 spec](https://github.com/InteractiveAdvertisingBureau/openrtb2.x/blob/main/2.6.md) and the [imp.ext.tid](https://github.com/InteractiveAdvertisingBureau/openrtb/blob/master/extensions/community_extensions/per-imp-tids.md) community extensions, several fields in Prebid have equivalents in OpenRTB.

- $.id, the top level id, is now unique to each bid request. It may come from a bidder `getUUID` call or from the `bidderRequestId`.
- $.imp.ext.tid is the same for each bidder and differs for each slot in the auction. It is the request object `transactionId`. It can be set by the publisher to sync with other header bidding libraries on the page.
- $.source.tid is the same for each bidder and differs for each auction. We understand from buyer platform members that it is losing utility in favor of `imp.ext.tid`. It is the request object `auctionId`. It can be set by the publisher to sync with other header bidding libraries on the page.
- $.source.schain.nodes[0].rid is not generated by the Prebid.js core library nor the schain module and may vary unexpectedly.
* $.id, the top level id, is now unique to each bid request. It may come from a bidder `getUUID` call or from the `bidderRequestId`.
* $.imp.ext.tid is the same for each bidder and differs for each slot in the auction. It is the request object `transactionId`. It can be set by the publisher to sync with other header bidding libraries on the page.
* $.source.tid is the same for each bidder and differs for each auction. We understand from buyer platform members that it is losing utility in favor of `imp.ext.tid`. It is the request object `auctionId`. It can be set by the publisher to sync with other header bidding libraries on the page.
* $.source.schain.nodes[0].rid is not generated by the Prebid.js core library nor the schain module and may vary unexpectedly.

These identifiers are extremely powerful for discrepancy reconciliation, ad quality investigations, consent audits, and a huge range of other applications. They also allow data appended to different requests (eg dealIds) to be commingled downstream. For this reason, our publisher committee and Prebid.org counsel have decided to require publisher opt-in to their inclusion in the bid stream. This means Prebid engineering changed every openrtb request in the project to potentially transmit a null in these fields. Comments were added to bid adapters not using OpenRTB that send them over the wire to confirm they can accept null values. Publishers can use `pbjs.setConfig({enableTIDs: true})` to opt-in.
These identifiers are extremely powerful for discrepancy reconciliation, ad quality investigations, consent audits, and a huge range of other applications. They also allow data appended to different requests (eg dealIds) to be commingled downstream. For this reason, our publisher committee and Prebid.org counsel have decided to require publisher opt-in to their inclusion in the bid stream. This means Prebid engineering changed every openrtb request in the project to potentially transmit a null in these fields. Comments were added to bid adapters not using OpenRTB that send them over the wire to confirm they can accept null values. Publishers can use `pbjs.setConfig({enableTIDs: true})` to opt-in.

## Activity Controls

[Activity controls](/dev-docs/activity-controls.html) were very recently released, and are even more powerful in Prebid.js 8. `transmitTid` is a new control added.
[Activity controls](/dev-docs/activity-controls.html) were very recently released, and are even more powerful in Prebid.js 8. `transmitTid` is a new control added.

Also, in order to allow publishers to better comply with regulations around precise location, bid adapters must read location from the global, not from their own parameters.

RTD Modules were also updated to require that they do not have bidder specific handling, and that all their bid enrichment data is routed through the global. This will make those enrichments subject to the data controller module settings as well as activity controls.
RTD Modules were also updated to require that they do not have bidder specific handling, and that all their bid enrichment data is routed through the global. This will make those enrichments subject to the data controller module settings as well as activity controls.

Several activity control translation modules will be released in the near future, translating consent strings into suppressed behaviors and restricted information in the library. Your contributions on these modules and feedback are very welcome.
Several activity control translation modules will be released in the near future, translating consent strings into suppressed behaviors and restricted information in the library. Your contributions on these modules and feedback are very welcome.

## Size Mapping

Users of the [label](/dev-docs/conditional-ad-units.html) feature should be careful to examine the new size mapping module. We moved it out of core to improve the build size. See [https://github.com/prebid/Prebid.js/issue/9597](https://github.com/prebid/Prebid.js/issue/9597)

## Misc changes

- `auctionInit` event payload is now less bloated. See [https://github.com/prebid/Prebid.js/pull/9897](https://github.com/prebid/Prebid.js/pull/9897)
- Bidder `categoryTranslation` is no longer in core. See [https://github.com/prebid/Prebid.js/pull/9898](https://github.com/prebid/Prebid.js/pull/9898)
- `bidderCode` can no longer come from the bid response, as this was breaking aliasing. See [https://github.com/prebid/Prebid.js/pull/9905](https://github.com/prebid/Prebid.js/pull/9905)
- `onBidWon` was often listened to by client side bid adapters and would get fired when a server side bid was won. This has been cleaned up. See [https://github.com/prebid/Prebid.js/pull/9919](https://github.com/prebid/Prebid.js/pull/9919)
- `ext.prebid.floorMin` has been dropped in favor of `ext.prebid.floors.floorMin` as a parameter on the PBS Bid adapter call See [https://github.com/prebid/Prebid.js/pull/9899](https://github.com/prebid/Prebid.js/pull/9899)
- `bidResponse` is emitted immediately after adding the bidResponse instead of immediately before. See [https://github.com/prebid/Prebid.js/pull/9847](https://github.com/prebid/Prebid.js/pull/9847)
- PBS bid adapter now supports native javascript trackers. See [https://github.com/prebid/Prebid.js/pull/9900](https://github.com/prebid/Prebid.js/pull/9900)
- `NO_BID` events no longer occur on bid rejections and zero-cpm bids. See [https://github.com/prebid/Prebid.js/pull/9902](https://github.com/prebid/Prebid.js/pull/9902)
* `auctionInit` event payload is now less bloated. See [https://github.com/prebid/Prebid.js/pull/9897](https://github.com/prebid/Prebid.js/pull/9897)
* Bidder `categoryTranslation` is no longer in core. See [https://github.com/prebid/Prebid.js/pull/9898](https://github.com/prebid/Prebid.js/pull/9898)
* `bidderCode` can no longer come from the bid response, as this was breaking aliasing. See [https://github.com/prebid/Prebid.js/pull/9905](https://github.com/prebid/Prebid.js/pull/9905)
* `onBidWon` was often listened to by client side bid adapters and would get fired when a server side bid was won. This has been cleaned up. See [https://github.com/prebid/Prebid.js/pull/9919](https://github.com/prebid/Prebid.js/pull/9919)
* `ext.prebid.floorMin` has been dropped in favor of `ext.prebid.floors.floorMin` as a parameter on the PBS Bid adapter call See [https://github.com/prebid/Prebid.js/pull/9899](https://github.com/prebid/Prebid.js/pull/9899)
* `bidResponse` is emitted immediately after adding the bidResponse instead of immediately before. See [https://github.com/prebid/Prebid.js/pull/9847](https://github.com/prebid/Prebid.js/pull/9847)
* PBS bid adapter now supports native javascript trackers. See [https://github.com/prebid/Prebid.js/pull/9900](https://github.com/prebid/Prebid.js/pull/9900)
* `NO_BID` events no longer occur on bid rejections and zero-cpm bids. See [https://github.com/prebid/Prebid.js/pull/9902](https://github.com/prebid/Prebid.js/pull/9902)
3 changes: 1 addition & 2 deletions dev-docs/publisher-api-reference/setConfig.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ Core config:
* [Generic Configuration](#setConfig-Generic-Configuration)
* [Troubleshooting configuration](#setConfig-Troubleshooting-your-configuration)


Module config: other options to `setConfig()` are available if the relevant module is included in the Prebid.js build.

* [Currency module](/dev-docs/modules/currency.html)
Expand Down Expand Up @@ -71,7 +70,7 @@ pbjs.setConfig({ debug: true });
{: .alert.alert-warning :}
Note that turning on debugging for Prebid Server causes most server-side adapters to consider it a test request, meaning that they won't count on reports.

<a name="setConfig-deviceAccess"</a>
<a name="setConfig-deviceAccess"></a>

#### Device Access

Expand Down
1 change: 0 additions & 1 deletion guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,6 @@ The base CSS file used is Bootstrap (version 3.7.1) Custom CSS and modifications

The JS directory contains the Javascript files required for the Prebid.org site. It includes JQuery and Bootstrap javascript frameworks as well as other third party libraries and custom javascript written specifically for the Prebid site. For JQuery and Bootstrap both the expanded and minified versions of the javascript files are included but only the minified files are linked from the site header.


#### CSS

1. Styles all come from /assets/css/main-bundle.css
Expand Down

0 comments on commit 4dcc7ee

Please sign in to comment.