Skip to content

Commit

Permalink
Update docs to match with pbj (#3280)
Browse files Browse the repository at this point in the history
* Fixed typo

* Updated docs to match with current PBJ state.

* Added default configuration section

* Removed redundant space between parentheses

* tweaked default configs

* Updated default config documentation to match with pbj

* Update add-new-bidder-java.md

* Reverted invalid changes

* Synced with pbj

* Added information about unmodifiable defaults, cleaned up bidder alias example.

* Removed obsolete field pbs-enforces-gdpr

Co-authored-by: bretg <bgorsline@gmail.com>
Co-authored-by: MartianTribe <steve@martiantribe.com>
  • Loading branch information
3 people authored Sep 29, 2021
1 parent b9a8e72 commit 58bc4fc
Showing 1 changed file with 6 additions and 26 deletions.
32 changes: 6 additions & 26 deletions prebid-server/developers/add-new-bidder-java.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -129,21 +128,23 @@ Default configuration:
```yaml
adapter-defaults:
enabled: false
pbs-enforces-gdpr: true
pbs-enforces-ccpa: true
deprecated-names:
aliases: {}
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:

Example of adding bidder alias:
```yaml
adapters:
yourBidderCode:
endpoint: http://possible.endpoint
...
aliases:
yourBidderAlias:
endpoint: http://possible.alias/endpoint
Expand All @@ -155,26 +156,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`
Expand Down Expand Up @@ -814,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
```

Expand Down

0 comments on commit 58bc4fc

Please sign in to comment.