Skip to content

updated gzip docs to add a few more details #6046

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

Merged
pm-harshad-mane merged 2 commits into from
May 22, 2025
Merged

updated gzip docs to add a few more details #6046

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3aba90
updated gzip docs to add a few more details
jlquaccia May 22, 2025
5580907
fixed markdown linter error
jlquaccia May 22, 2025
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
6 changes: 5 additions & 1 deletion dev-docs/bidder-adaptor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,11 @@ Prebid will pass compressed payloads if the following criteria are met:
* Once server-side support is present, `request.options.endpointCompression = true` needs to be set for a bidder's outgoing requests within their Prebid.js bid adapter (An example of this can be viewed [here](https://github.com/prebid/Prebid.js/blob/master/modules/pubmaticBidAdapter.js#L730))
* The browser must support gzip compression (Prebid core has a built-in utility function to check this)

If the above criteria is met, the new Gzip compression can be utilized.
If the above criteria is met, Prebid.js core will do the following:

* Gzip compress the request payload
* Set the `Content-Type` header to `plain/text` (to avoid a preflight request)
* Append the `gzip=1` query param to the bidder request (to signal to a bidder's server-side endpoint that the request is compressed)

Note: If the Prebid.js debugging query param `?pbjs_debug=true` is present in the URL or `debug: true` has been configured in `pbjs.setConfig()`, the gzip compression feature will be disabled and all bidder requests will be sent uncompressed.

Expand Down