Skip to content

docs for gzip support for bid requests #6011

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 5 commits into from
May 22, 2025
Merged

docs for gzip support for bid requests #6011

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0263a51
docs for gzip support for bid requests
jlquaccia Apr 25, 2025
8d7d6b7
fixed linter error
jlquaccia Apr 25, 2025
c552e6d
updated docs for the pubmatic bid adapter supporting endpoint compres…
jlquaccia May 9, 2025
fb24eed
updated gzip compression docs
jlquaccia May 21, 2025
3e9277c
updated text for gzip docs
jlquaccia May 21, 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
14 changes: 14 additions & 0 deletions dev-docs/bidder-adaptor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,20 @@ Building the request will use data from several places:
* **BidRequest Params**: Several important parameters such as first-party data, userId, GDPR, USP, and supply chain values are on the `bidderRequest` object.
* **Prebid Config**: Publishers can set a number of config values that bid adapters should consider reading.

#### Compression Support for Outgoing Requests

Prebid.js core now includes support for gzip compression of bidder request payloads (This helps reduce payload size and improve performance).

Prebid will pass compressed payloads if the following criteria are met:

* `request.options.endpointCompression = true` is set by a bidder with outgoing requests (An example of this can be viewed [here](https://github.com/prebid/Prebid.js/blob/master/modules/pubmaticBidAdapter.js#L730))
* The browser supports gzip compression (Prebid core has a built-in utility function to check this)
* Participating bidders have implemented compression support on their server-side endpoint

If the above criteria is met, the new Gzip compression can be utilized.

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.

#### Ad Unit Params in the validBidRequests Array

Here is a sample array entry for `validBidRequests[]`:
Expand Down
4 changes: 4 additions & 0 deletions dev-docs/bidders/pubmatic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,4 +226,8 @@ Publishers should use the `ortb2` method of setting [First Party Data](https://d
- `ortb2.user.*`

AdUnit-specific data is supported using `AdUnit.ortb2Imp.ext.*`

### Endpoint Compression

This adapter utilizes gzip compression support built into Prebid.js core. For more information, see [Compression Support for Outgoing Requests](https://docs.prebid.org/dev-docs/bidder-adaptor.html#compression-support-for-outgoing-requests)
<!-- workaround bug where code blocks at end of a file are incorrectly formatted-->