docs for gzip support for bid requests#6011
Merged
pm-harshad-mane merged 5 commits intoMay 22, 2025
Merged
Conversation
✅ Deploy Preview for prebid-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
muuki88
approved these changes
May 2, 2025
muuki88
reviewed
May 2, 2025
jlquaccia
force-pushed
the
docs_for_gzip_support_for_bid_requests
branch
from
3bf32b1 to
c552e6d
Compare
muuki88
approved these changes
May 14, 2025
Contributor
muuki88
left a comment
muuki88
left a comment
There was a problem hiding this comment.
Awesome. Waiting for the change to be merged and released, then we can merge this.
|
|
||
| #### Compression Support for Outgoing Requests | ||
|
|
||
| Prebid.js core now includes support for gzip compression of bidder request payloads (This can help reduce payload size and improve performance). |
Contributor
There was a problem hiding this comment.
"This can help reduce payload" ---> "This helps reduce payload"
|
|
||
| The following criteria must be met for a request to be compressed: | ||
|
|
||
| * Browser supports gzip compression |
Contributor
There was a problem hiding this comment.
we should calrify that browser compatability check is conducted by prebid core/util
| * Participating bidders have enabled compression support within their bid adapter by updating their outgoing bidder requests to include `request.options.endpointCompression = true` | ||
| * Participating bidders have implemented compression support on their server-side endpoint | ||
|
|
||
| If the above criteria is met, Prebid core will automatically compress outgoing data payloads. |
Contributor
There was a problem hiding this comment.
Prebid will pass the compressed payload if request.options.endpointCompression = true is set by bidder and browser is compatible
Contributor
There was a problem hiding this comment.
we can even mention that PubMatic bidder already utilizes this feature, refer the code.
pm-harshad-mane
approved these changes
May 22, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds documentation for the PBJS endpointCompression bidderSettings feature. This feature allows Publishers to optionally enables bid requests to be Gzip compressed before being sent out to bid adapter endpoints.
🏷 Type of documentation
📋 Checklist
GH Issue: prebid/Prebid.js#12973
PR: prebid/Prebid.js#13033