From 819f581996f4716f0603e2fd62d83be031927385 Mon Sep 17 00:00:00 2001 From: Alex Maltsev Date: Tue, 27 Jul 2021 11:41:10 +0300 Subject: [PATCH 01/11] Fixed typo --- overview/intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/overview/intro.md b/overview/intro.md index 914e35f5d9..23342c615b 100644 --- a/overview/intro.md +++ b/overview/intro.md @@ -31,7 +31,7 @@ Our flagship product, Prebid.js, is sometimes referred to as simply *Prebid*, bu ### What is Header Bidding? -Header bidding is a response to a fragmented and inefficient process for digital ad display. It is an alternative to the "waterfall" method, in which impressions impressions are offered to one sales channel at a time, moving down an inflexible stack of sources. +Header bidding is a response to a fragmented and inefficient process for digital ad display. It is an alternative to the "waterfall" method, in which impressions are offered to one sales channel at a time, moving down an inflexible stack of sources. With header bidding, the publisher creates a short delay in their ad serving to obtain bids from many SSPs and ad exchanges. In this way, publishers can receive high value bids on their inventory that may be unavailable through their primary ad server and exchange. The returned bids are then passed into the ad server so they can compete with direct demand and the primary ad server's exchange on a level playing field. From 52097e3762d77f65309598725c6ae3867653cc9e Mon Sep 17 00:00:00 2001 From: Alex Maltsev Date: Tue, 17 Aug 2021 12:20:10 +0300 Subject: [PATCH 02/11] Updated docs to match with current PBJ state. --- prebid-server/developers/add-new-bidder-java.md | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/prebid-server/developers/add-new-bidder-java.md b/prebid-server/developers/add-new-bidder-java.md index 692954b274..d0bd336fcc 100644 --- a/prebid-server/developers/add-new-bidder-java.md +++ b/prebid-server/developers/add-new-bidder-java.md @@ -78,13 +78,7 @@ Create a file with the path `static/bidder-info/{bidder}.yaml` and begin with th ```yaml adapters: yourBidderCode: - enabled: false endpoint: http://possible.endpoint - pbs-enforces-gdpr: true - pbs-enforces-ccpa: true - modifying-vast-xml-allowed: true - deprecated-names: - aliases: meta-info: maintainer-email: maintainer@email.com app-media-types: @@ -109,8 +103,10 @@ adapters: Modify this template for your bid adapter: - Change the maintainer email address to a group distribution list on your ad server's domain. A distribution list is preferred over an individual mailbox to allow for robustness, as roles and team members naturally change. -- Change the `modifyingVastXmlAllowed` value to `true` if you'd like to opt-in for video impression tracking. -- Change the `enabled` value to `true` if you'd like to make your bid adapter enabled. +- Change the `modifying-vast-xml-allowed` value to `true` if you'd like to opt-in for video impression tracking, can be omitted (defaults to `true`). +- Change the `enabled` value to `true` if you'd like to make your bid adapter enabled, can be omitted (defaults to `false`). +- Change the `pbs-enforces-gdpr` to `true` if you'd like to enable gdpr enforcement, can be omitted (defaults to `true`). +- Change the `pbs-enforces-ccpa` to `true` if you'd like to enable ccpa enforcement, can be omitted (defaults to `true`). - Change the `vendor-id` value to id of your bidding server as registered with the [GDPR Global Vendor List (GVL)](https://iabeurope.eu/vendor-list-tcf-v2-0/). Leave this as `0` if you are not registered with IAB Europe. - Remove the `capabilities` (app/site) and `mediaTypes` (banner/video/audio/native) combinations which your adapter does not support. - Change the `cookie-family-name` to the name which will be used for storing your user sync id within the federated cookie. Please keep this the same as your bidder name. @@ -131,12 +127,7 @@ Example of adding bidder alias: ```yaml adapters: yourBidderCode: - enabled: false endpoint: http://possible.endpoint - pbs-enforces-gdpr: true - pbs-enforces-ccpa: true - modifying-vast-xml-allowed: true - deprecated-names: aliases: yourBidderAlias: endpoint: http://possible.alias/endpoint From 924053ada833398962ec0293386a407b62b94f55 Mon Sep 17 00:00:00 2001 From: Alex Maltsev Date: Tue, 17 Aug 2021 13:40:56 +0300 Subject: [PATCH 03/11] Added default configuration section --- prebid-server/developers/add-new-bidder-java.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/prebid-server/developers/add-new-bidder-java.md b/prebid-server/developers/add-new-bidder-java.md index d0bd336fcc..d212d2dac5 100644 --- a/prebid-server/developers/add-new-bidder-java.md +++ b/prebid-server/developers/add-new-bidder-java.md @@ -120,6 +120,23 @@ The url of your user syncer can make use of the following privacy policy macros - Change the `usersync:type` value to `redirect` or `iframe` specific to your bidder. +### Default bidder configuration + +Prebid Server has default configuration for common bidder properties, which can be overriden by bidders in their +configurations. + +Default configuration: + +```yaml +adapter-defaults: + enabled: false + pbs-enforces-gdpr: true + pbs-enforces-ccpa: true + deprecated-names: + aliases: { } + modifying-vast-xml-allowed: true +``` + ### Create bidder alias If you want to add bidder that is an alias of existing bidder, you need just to update configuration of parent bidder: From 1abb46d3b552a7841c9744a7e2019bfdec678e75 Mon Sep 17 00:00:00 2001 From: Alex Maltsev Date: Tue, 17 Aug 2021 16:36:09 +0300 Subject: [PATCH 04/11] Removed redundant space between parentheses --- prebid-server/developers/add-new-bidder-java.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/prebid-server/developers/add-new-bidder-java.md b/prebid-server/developers/add-new-bidder-java.md index d212d2dac5..51424933b6 100644 --- a/prebid-server/developers/add-new-bidder-java.md +++ b/prebid-server/developers/add-new-bidder-java.md @@ -133,7 +133,7 @@ adapter-defaults: pbs-enforces-gdpr: true pbs-enforces-ccpa: true deprecated-names: - aliases: { } + aliases: {} modifying-vast-xml-allowed: true ``` From f0d270827ea3d02787ce06f3e03879bfd00f1f44 Mon Sep 17 00:00:00 2001 From: bretg Date: Thu, 19 Aug 2021 14:27:49 -0400 Subject: [PATCH 05/11] tweaked default configs --- prebid-server/developers/add-new-bidder-java.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/prebid-server/developers/add-new-bidder-java.md b/prebid-server/developers/add-new-bidder-java.md index 51424933b6..2346a3c238 100644 --- a/prebid-server/developers/add-new-bidder-java.md +++ b/prebid-server/developers/add-new-bidder-java.md @@ -103,10 +103,9 @@ adapters: Modify this template for your bid adapter: - Change the maintainer email address to a group distribution list on your ad server's domain. A distribution list is preferred over an individual mailbox to allow for robustness, as roles and team members naturally change. -- Change the `modifying-vast-xml-allowed` value to `true` if you'd like to opt-in for video impression tracking, can be omitted (defaults to `true`). -- Change the `enabled` value to `true` if you'd like to make your bid adapter enabled, can be omitted (defaults to `false`). -- Change the `pbs-enforces-gdpr` to `true` if you'd like to enable gdpr enforcement, can be omitted (defaults to `true`). -- Change the `pbs-enforces-ccpa` to `true` if you'd like to enable ccpa enforcement, can be omitted (defaults to `true`). +- Change the `modifying-vast-xml-allowed` value to `false` if you'd like to opt out of video impression tracking. It defaults to `true`. +- Change the `pbs-enforces-gdpr` to `false` if you'd like to disable gdpr enforcement. Defaults to `true`. +- Change the `pbs-enforces-ccpa` to `false` if you'd like to disable ccpa enforcement. Defaults to `true`. - Change the `vendor-id` value to id of your bidding server as registered with the [GDPR Global Vendor List (GVL)](https://iabeurope.eu/vendor-list-tcf-v2-0/). Leave this as `0` if you are not registered with IAB Europe. - Remove the `capabilities` (app/site) and `mediaTypes` (banner/video/audio/native) combinations which your adapter does not support. - Change the `cookie-family-name` to the name which will be used for storing your user sync id within the federated cookie. Please keep this the same as your bidder name. From 46dd9888b946f88e47049f35904cc40ad7593fd1 Mon Sep 17 00:00:00 2001 From: Alex Maltsev Date: Tue, 21 Sep 2021 16:28:57 +0300 Subject: [PATCH 06/11] Updated default config documentation to match with pbj --- prebid-server/developers/add-new-bidder-java.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/prebid-server/developers/add-new-bidder-java.md b/prebid-server/developers/add-new-bidder-java.md index 2346a3c238..611666bc78 100644 --- a/prebid-server/developers/add-new-bidder-java.md +++ b/prebid-server/developers/add-new-bidder-java.md @@ -79,6 +79,8 @@ Create a file with the path `static/bidder-info/{bidder}.yaml` and begin with th adapters: yourBidderCode: endpoint: http://possible.endpoint + deprecated-names: + aliases: {} meta-info: maintainer-email: maintainer@email.com app-media-types: @@ -131,8 +133,6 @@ adapter-defaults: enabled: false pbs-enforces-gdpr: true pbs-enforces-ccpa: true - deprecated-names: - aliases: {} modifying-vast-xml-allowed: true ``` @@ -144,6 +144,7 @@ Example of adding bidder alias: adapters: yourBidderCode: endpoint: http://possible.endpoint + deprecated-names: aliases: yourBidderAlias: endpoint: http://possible.alias/endpoint From 8255288f2e2a99a3179993cece2b48509381a4a0 Mon Sep 17 00:00:00 2001 From: MartianTribe Date: Tue, 21 Sep 2021 09:37:10 -0400 Subject: [PATCH 07/11] Update add-new-bidder-java.md --- prebid-server/developers/add-new-bidder-java.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/prebid-server/developers/add-new-bidder-java.md b/prebid-server/developers/add-new-bidder-java.md index 611666bc78..34f3d412e7 100644 --- a/prebid-server/developers/add-new-bidder-java.md +++ b/prebid-server/developers/add-new-bidder-java.md @@ -137,7 +137,7 @@ adapter-defaults: ``` ### Create bidder alias -If you want to add bidder that is an alias of existing bidder, you need just to update configuration of parent bidder: +If you want to add a bidder that is an alias of an existing bidder, you need to update the configuration of the parent bidder: Example of adding bidder alias: ```yaml From 4942514a8a496bd3983934d19075f066b8dc40bf Mon Sep 17 00:00:00 2001 From: Alex Maltsev Date: Tue, 21 Sep 2021 16:51:20 +0300 Subject: [PATCH 08/11] Reverted invalid changes --- prebid-server/developers/add-new-bidder-java.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/prebid-server/developers/add-new-bidder-java.md b/prebid-server/developers/add-new-bidder-java.md index d4e5227a50..d1c769b943 100644 --- a/prebid-server/developers/add-new-bidder-java.md +++ b/prebid-server/developers/add-new-bidder-java.md @@ -137,7 +137,7 @@ adapter-defaults: ``` ### Create bidder alias -If you want to add a bidder that is an alias of an existing bidder, you need to update the configuration of the parent bidder: +If you want to add bidder that is an alias of existing bidder, you need just to update configuration of parent bidder: Example of adding bidder alias: ```yaml From 545e6b5a7003c7cf43b1f6d6242242370defefd0 Mon Sep 17 00:00:00 2001 From: Alex Maltsev Date: Wed, 22 Sep 2021 11:22:59 +0300 Subject: [PATCH 09/11] Synced with pbj --- prebid-server/developers/add-new-bidder-java.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/prebid-server/developers/add-new-bidder-java.md b/prebid-server/developers/add-new-bidder-java.md index d1c769b943..da5a867739 100644 --- a/prebid-server/developers/add-new-bidder-java.md +++ b/prebid-server/developers/add-new-bidder-java.md @@ -79,8 +79,6 @@ Create a file with the path `static/bidder-info/{bidder}.yaml` and begin with th adapters: yourBidderCode: endpoint: http://possible.endpoint - deprecated-names: - aliases: {} meta-info: maintainer-email: maintainer@email.com app-media-types: @@ -144,7 +142,6 @@ Example of adding bidder alias: adapters: yourBidderCode: endpoint: http://possible.endpoint - deprecated-names: aliases: yourBidderAlias: endpoint: http://possible.alias/endpoint From f9c63554778f6f5432f97c7d0cc2eedc0afc4c70 Mon Sep 17 00:00:00 2001 From: Alex Maltsev Date: Wed, 22 Sep 2021 11:33:51 +0300 Subject: [PATCH 10/11] Added information about unmodifiable defaults, cleaned up bidder alias example. --- .../developers/add-new-bidder-java.md | 27 +++++-------------- 1 file changed, 6 insertions(+), 21 deletions(-) diff --git a/prebid-server/developers/add-new-bidder-java.md b/prebid-server/developers/add-new-bidder-java.md index da5a867739..c324d11e54 100644 --- a/prebid-server/developers/add-new-bidder-java.md +++ b/prebid-server/developers/add-new-bidder-java.md @@ -134,6 +134,11 @@ adapter-defaults: modifying-vast-xml-allowed: true ``` +There are also some default properties which can't be overridden in adapter-defaults, but rather in particular adapter's config: +- `aliases`: Defaults to empty +- `deprecated-names`: Defaults to empty +- `extra-info`: Defaults to empty + ### Create bidder alias If you want to add bidder that is an alias of existing bidder, you need just to update configuration of parent bidder: @@ -141,7 +146,7 @@ Example of adding bidder alias: ```yaml adapters: yourBidderCode: - endpoint: http://possible.endpoint + ... aliases: yourBidderAlias: endpoint: http://possible.alias/endpoint @@ -153,26 +158,6 @@ adapters: - video usersync: cookie-family-name: yourBidderCode - meta-info: - maintainer-email: maintainer@email.com - app-media-types: - - banner - - video - - audio - - native - site-media-types: - - banner - - video - - audio - - native - supported-vendors: - vendor-id: your_vendor_id - usersync: - url: your_bid_adapter_usersync_url - redirect-url: /setuid?bidder=yourBidderCode&gdpr={%raw%}{{gdpr}}{%endraw%}&gdpr_consent={%raw%}{{gdpr_consent}}{%endraw%}&us_privacy={%raw%}{{us_privacy}}{%endraw%} - cookie-family-name: yourBidderCode - type: redirect - support-cors: false ``` Aliases are configured by adding child configuration object at `adapters.yourBidderCode.aliases.yourBidderAlias` From c6909c24fc3e49bacc44c079deb06b22c15dba17 Mon Sep 17 00:00:00 2001 From: Alex Maltsev Date: Thu, 23 Sep 2021 15:00:36 +0300 Subject: [PATCH 11/11] Removed obsolete field pbs-enforces-gdpr --- prebid-server/developers/add-new-bidder-java.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/prebid-server/developers/add-new-bidder-java.md b/prebid-server/developers/add-new-bidder-java.md index c324d11e54..99c3d2a78f 100644 --- a/prebid-server/developers/add-new-bidder-java.md +++ b/prebid-server/developers/add-new-bidder-java.md @@ -104,7 +104,6 @@ adapters: Modify this template for your bid adapter: - Change the maintainer email address to a group distribution list on your ad server's domain. A distribution list is preferred over an individual mailbox to allow for robustness, as roles and team members naturally change. - Change the `modifying-vast-xml-allowed` value to `false` if you'd like to opt out of video impression tracking. It defaults to `true`. -- Change the `pbs-enforces-gdpr` to `false` if you'd like to disable gdpr enforcement. Defaults to `true`. - Change the `pbs-enforces-ccpa` to `false` if you'd like to disable ccpa enforcement. Defaults to `true`. - Change the `vendor-id` value to id of your bidding server as registered with the [GDPR Global Vendor List (GVL)](https://iabeurope.eu/vendor-list-tcf-v2-0/). Leave this as `0` if you are not registered with IAB Europe. - Remove the `capabilities` (app/site) and `mediaTypes` (banner/video/audio/native) combinations which your adapter does not support. @@ -129,7 +128,6 @@ Default configuration: ```yaml adapter-defaults: enabled: false - pbs-enforces-gdpr: true pbs-enforces-ccpa: true modifying-vast-xml-allowed: true ``` @@ -797,7 +795,6 @@ Go to `test-application.properties` file and add folowing properties ```yaml adapters.{bidder}.enabled=true adapters.{bidder}.endpoint=http://localhost:8090/{bidder}-exchange -adapters.{bidder}.pbs-enforces-gdpr=true adapters.{bidder}.usersync.url=//{bidder}-usersync ```