Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Extended account properties doc (#2783) #2783

Merged
merged 2 commits into from
Nov 30, 2023
Merged

Docs: Extended account properties doc (#2783) #2783

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
67d7696
Extended application-settings.md, section "Account properties"
VeryExtraordinaryUsername Nov 21, 2023
ed83736
Post-review updates
VeryExtraordinaryUsername Nov 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/application-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,16 @@ There are two ways to configure application settings: database and file. This do
the bid and log an operational warning.
- `auction.events.enabled` - enables events for account if true
- `auction.debug-allow` - enables debug output in the auction response. Default `true`.
- `auction.targeting.includewinners` - whether to include targeting for the winning bids in response. Default `false`.
- `auction.targeting.includebidderkeys` - whether to include targeting for the best bid from each bidder in response. Default `false`.
- `auction.targeting.includeformat` - whether to include the “hb_format” targeting key. Default `false`.
- `auction.targeting.preferdeals` - if targeting is returned and this is `true`, PBS will choose the highest value deal before choosing the highest value non-deal. Default `false`.
- `auction.targeting.alwaysincludedeals` - PBS-Java only. If true, generate `hb_ATTR_BIDDER` values for all bids that have a `dealid`. Default to `false`.
- `auction.targeting.prefix` - defines prefix for targeting keywords. Default `hb`.
Keep in mind following restrictions:
- this prefix value may be overridden by correspond property from bid request
- prefix length is limited by `auction.truncate-target-attr`
- if custom prefix may produce keywords that exceed `auction.truncate-target-attr`, prefix value will drop to default `hb`
- `privacy.ccpa.enabled` - enables gdpr verifications if true. Has higher priority than configuration in application.yaml.
- `privacy.ccpa.channel-enabled.web` - overrides `ccpa.enforce` property behaviour for web requests type.
- `privacy.ccpa.channel-enabled.amp` - overrides `ccpa.enforce` property behaviour for amp requests type.
Expand Down Expand Up @@ -108,6 +118,13 @@ Here's an example YAML file containing account-specific settings:
enabled: true
price-floors:
enabled: false
targeting:
includewinners: false
includebidderkeys: false
includeformat: false
preferdeals: false
alwaysincludedeals: false
prefix: hb
debug-allow: true
metrics:
verbosity-level: basic
Expand Down