You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-`auction.video.stored-required` - flag forces to merge with stored request
111
-
-`auction.blocklisted-accounts` - comma separated list of blocklisted account IDs.
115
+
-`video.stored-request-required` - flag forces to merge with stored request
112
116
-`video.stored-requests-timeout-ms` - timeout for stored requests fetching.
113
-
-`auction.ad-server-currency` - default currency for video auction, if its value was not specified in request. Important note: PBS uses ISO-4217 codes for the representation of currencies.
117
+
-`auction.blocklisted-accounts` - comma separated list of blocklisted account IDs.
114
118
-`auction.video.escape-log-cache-regex` - regex to remove from cache debug log xml.
119
+
-`auction.ad-server-currency` - default currency for video auction, if its value was not specified in request. Important note: PBS uses ISO-4217 codes for the representation of currencies.
115
120
116
121
## Setuid
117
122
-`setuid.default-timeout-ms` - default operation timeout for requests to `/setuid` endpoint.
@@ -126,6 +131,7 @@ Removes and downloads file again if depending service cant process probably corr
126
131
## Vtrack
127
132
-`vtrack.allow-unknown-bidder` - flag that allows servicing requests with bidders who were not configured in Prebid Server.
128
133
-`vtrack.modify-vast-for-unknown-bidder` - flag that allows modifying the VAST value and adding the impression tag to it, for bidders who were not configured in Prebid Server.
134
+
-`vtrack.default-timeout-ms` - a default timeout in ms for the vtrack request
129
135
130
136
## Adapters
131
137
-`adapters.*` - the section for bidder specific configuration options.
@@ -160,9 +166,8 @@ Also, each bidder could have its own bidder-specific options.
160
166
161
167
## Logging
162
168
-`logging.http-interaction.max-limit` - maximum value for the number of interactions to log in one take.
163
-
164
-
## Logging
165
169
-`logging.change-level.max-duration-ms` - maximum duration (in milliseconds) for which logging level could be changed.
170
+
-`logging.sampling-rate` - a percentage of messages that are logged
166
171
167
172
## Currency Converter
168
173
-`currency-converter.external-rates.enabled` - if equals to `true` the currency conversion service will be enabled to fetch updated rates and convert bid currencies from external source. Also enables `/currency-rates` endpoint on admin port.
@@ -213,6 +218,11 @@ Also, each bidder could have its own bidder-specific options.
213
218
-`admin-endpoints.collected-metrics.on-application-port` - when equals to `false` endpoint will be bound to `admin.port`.
214
219
-`admin-endpoints.collected-metrics.protected` - when equals to `true` endpoint will be protected by basic authentication configured in `admin-endpoints.credentials`
215
220
221
+
-`admin-endpoints.logging-changelevel.enabled` - if equals to `true` the endpoint will be available.
222
+
-`admin-endpoints.logging-changelevel.path` - the server context path where the endpoint will be accessible
223
+
-`admin-endpoints.logging-changelevel.on-application-port` - when equals to `false` endpoint will be bound to `admin.port`.
224
+
-`admin-endpoints.logging-changelevel.protected` - when equals to `true` endpoint will be protected by basic authentication configured in `admin-endpoints.credentials`
225
+
216
226
-`admin-endpoints.credentials` - user and password for access to admin endpoints if `admin-endpoints.[NAME].protected` is true`.
217
227
218
228
## Metrics
@@ -264,6 +274,9 @@ See [metrics documentation](metrics.md) for complete list of metrics submitted a
264
274
-`metrics.accounts.basic-verbosity` - a list of accounts for which only basic metrics will be submitted.
265
275
-`metrics.accounts.detailed-verbosity` - a list of accounts for which all metrics will be submitted.
266
276
277
+
For `JVM` metrics
278
+
-`metrics.jmx.enabled` - if equals to `true` then `jvm.gc` and `jvm.memory` metrics will be submitted
279
+
267
280
## Cache
268
281
-`cache.scheme` - set the external Cache Service protocol: `http`, `https`, etc.
269
282
-`cache.host` - set the external Cache Service destination in format `host:port`.
@@ -367,6 +380,19 @@ contain 'WHERE last_updated > ?' for MySQL and 'WHERE last_updated > $1' for Pos
367
380
- `settings.in-memory-cache.database-update.refresh-rate`- refresh period in ms for stored request updates.
368
381
- `settings.in-memory-cache.database-update.timeout`- timeout for obtaining stored request updates.
369
382
383
+
For S3 storage configuration
384
+
- `settings.in-memory-cache.s3-update.refresh-rate`- refresh period in ms for stored request updates in S3
385
+
- `settings.s3.access-key-id`- an access key
386
+
- `settings.s3.secret-access-key`- a secret access key
387
+
- `settings.s3.region`- a region, AWS_GLOBAL by default
388
+
- `settings.s3.endpoint`- an endpoint
389
+
- `settings.s3.bucket`- a bucket name
390
+
- `settings.s3.force-path-style`- forces the S3 client to use path-style addressing for buckets.
391
+
- `settings.s3.accounts-dir`- a directory with stored accounts
392
+
- `settings.s3.stored-imps-dir`- a directory with stored imps
393
+
- `settings.s3.stored-requests-dir`- a directory with stored requests
394
+
- `settings.s3.stored-responses-dir`- a directory with stored responses
395
+
370
396
For targeting available next options:
371
397
- `settings.targeting.truncate-attr-chars`- set the max length for names of targeting keywords (0 means no truncation).
372
398
@@ -399,6 +425,7 @@ If not defined in config all other Health Checkers would be disabled and endpoin
399
425
- `gdpr.eea-countries`- comma separated list of countries in European Economic Area (EEA).
400
426
- `gdpr.default-value`- determines GDPR in scope default value (if no information in request and no geolocation data).
401
427
- `gdpr.host-vendor-id`- the organization running a cluster of Prebid Servers.
428
+
- `datacenter-region`- the datacenter region of a cluster of Prebid Servers
- `gdpr.purposes.pN.enforce-purpose` - define type of enforcement confirmation: `no`/`basic`/`full`. Default `full`
404
431
- `gdpr.purposes.pN.enforce-vendors`- if equals to `true`, user must give consent to use vendors. Purposes will be omitted. Default `true`
@@ -428,9 +455,30 @@ If not defined in config all other Health Checkers would be disabled and endpoin
428
455
- `geolocation.type`- set the geo location service provider, can be `maxmind` or custom provided by hosting company.
429
456
- `geolocation.maxmind`- section for [MaxMind](https://www.maxmind.com) configuration as geo location service provider.
430
457
- `geolocation.maxmind.remote-file-syncer`- use RemoteFileSyncer component for downloading/updating MaxMind database file. See [RemoteFileSyncer](#remote-file-syncer) section for its configuration.
458
+
- `geolocation.configurations[]`- a list of geo-lookup configurations for the `configuration` `geolocation.type`
459
+
- `geolocation.configurations[].address-pattern`- an address pattern for matching an IP to look up
460
+
- `geolocation.configurations[].geo-info.continent`- a continent to return on the `configuration` geo-lookup
461
+
- `geolocation.configurations[].geo-info.country`- a country to return on the `configuration` geo-lookup
462
+
- `geolocation.configurations[].geo-info.region`- a region to return on the `configuration` geo-lookup
463
+
- `geolocation.configurations[].geo-info.region-code`- a region code to return on the `configuration` geo-lookup
464
+
- `geolocation.configurations[].geo-info.city`- a city to return on the `configuration` geo-lookup
465
+
- `geolocation.configurations[].geo-info.metro-google`- a metro Google to return on the `configuration` geo-lookup
466
+
- `geolocation.configurations[].geo-info.metro-nielsen`- a metro Nielsen to return on the `configuration` geo-lookup
467
+
- `geolocation.configurations[].geo-info.zip`- a zip to return on the `configuration` geo-lookup
468
+
- `geolocation.configurations[].geo-info.connection-speed`- a connection-speed to return on the `configuration` geo-lookup
469
+
- `geolocation.configurations[].geo-info.lat`- a lat to return on the `configuration` geo-lookup
470
+
- `geolocation.configurations[].geo-info.lon`- a lon to return on the `configuration` geo-lookup
471
+
- `geolocation.configurations[].geo-info.time-zone`- a time zone to return on the `configuration` geo-lookup
472
+
473
+
## IPv6
474
+
- `ipv6.always-mask-right`- a bit mask for masking an IPv6 address of the device
475
+
- `ipv6.anon-left-mask-bits`- a bit mask for anonymizing an IPv6 address of the device
476
+
- `ipv6.private-networks`- a list of known private/local networks to skip masking of an IP address of the device
431
477
432
478
## Analytics
433
479
- `analytics.global.adapters`- Names of analytics adapters that will work for each request, except those disabled at the account level.
480
+
481
+
For the `pubstack` analytics adapter
434
482
- `analytics.pubstack.enabled`- if equals to `true` the Pubstack analytics module will be enabled. Default value is `false`.
435
483
- `analytics.pubstack.endpoint`- url for reporting events and fetching configuration.
436
484
- `analytics.pubstack.scopeid`- defined the scope provided by the Pubstack Support Team.
@@ -440,6 +488,26 @@ If not defined in config all other Health Checkers would be disabled and endpoin
440
488
- `analytics.pubstack.buffers.count`- threshold in events count for buffer to send events
441
489
- `analytics.pubstack.buffers.report-ttl-ms`- max period between two reports.
442
490
491
+
For the `greenbids` analytics adapter
492
+
- `analytics.greenbids.enabled`- if equals to `true` the Greenbids analytics module will be enabled. Default value is `false`.
493
+
- `analytics.greenbids.analytics-server-version`- a server version to add to the event
494
+
- `analytics.greenbids.analytics-server`- url for reporting events
495
+
- `analytics.greenbids.timeout-ms`- timeout in milliseconds for report requests.
496
+
- `analytics.greenbids.exploratory-sampling-split`- a sampling rate for report requests
497
+
- `analytics.greenbids.default-sampling-rate`- a default sampling rate for report requests
498
+
499
+
For the `agma` analytics adapter
500
+
- `analytics.agma.enabled`- if equals to `true` the Agma analytics module will be enabled. Default value is `false`.
501
+
- `analytics.agma.endpoint.url`- url for reporting events
502
+
- `analytics.agma.endpoint.timeout-ms`- timeout in milliseconds for report requests.
503
+
- `analytics.agma.endpoint.gzip`- if equals to `true` the Agma analytics module enables gzip encoding. Default value is `false`.
504
+
- `analytics.agma.buffers.size-bytes`- threshold in bytes for buffer to send events.
505
+
- `analytics.agma.buffers.count`- threshold in events count for buffer to send events.
506
+
- `analytics.agma.buffers.timeout-ms`- max period between two reports.
507
+
- `analytics.agma.accounts[].code`- an account code to send with an event
508
+
- `analytics.agma.accounts[].publisher-id`- a publisher id to match an event to send
509
+
- `analytics.agma.accounts[].site-app-id`- a site or app id to match an event to send
510
+
443
511
## Modules
444
512
- `hooks.admin.module-execution`- a key-value map, where a key is a module name and a value is a boolean, that defines whether modules hooks should/should not be always executed; if the module is not specified it is executed by default when it's present in the execution plan
445
513
- `settings.modules.require-config-to-invoke`- when enabled it requires a runtime config to exist for a module.
@@ -450,3 +518,20 @@ If not defined in config all other Health Checkers would be disabled and endpoin
450
518
To override (force enable) account and/or bidder adapter debug setting, a client must include `x-pbs-debug-override`
451
519
HTTP header in the auction call containing same token as in the `debug.override-token` property. This will make Prebid
452
520
Server ignore account `auction.debug-allow` and/or `adapters.<BIDDER_NAME>.debug.allow` properties.
521
+
522
+
## Privacy Sandbox
523
+
- `auction.privacysandbox.topicsdomain`- the list of Sec-Browsing-Topics for the Privacy Sandbox
524
+
525
+
## AMP
526
+
- `amp.custom-targeting`- a list of bidders that support custom targeting
527
+
528
+
## Hooks
529
+
- `hooks.host-execution-plan`- a host execution plan for modules
530
+
- `hooks.default-account-execution-plan`- a default account execution plan
531
+
532
+
## Price Floors Debug
533
+
- `price-floors.enabled`- enables price floors for account if true. Defaults to true.
534
+
- `price-floors.min-max-age-sec`- a price floors fetch data time to live in cache.
535
+
- `price-floors.min-period-sec`- a refresh period for fetching price floors data.
536
+
- `price-floors.min-timeout-ms`- a min timeout in ms for fetching price floors data.
537
+
- `price-floors.max-timeout-ms`- a max timeout in ms for fetching price floors data.
0 commit comments