Skip to content

Commit c4d415f

Browse files
authored
updated gzip docs to add a few more details (prebid#6046)
* updated gzip docs to add a few more details * fixed markdown linter error
1 parent caba1c6 commit c4d415f

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

dev-docs/bidder-adaptor.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,11 @@ Prebid will pass compressed payloads if the following criteria are met:
281281
* 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))
282282
* The browser must support gzip compression (Prebid core has a built-in utility function to check this)
283283

284-
If the above criteria is met, the new Gzip compression can be utilized.
284+
If the above criteria is met, Prebid.js core will do the following:
285+
286+
* Gzip compress the request payload
287+
* Set the `Content-Type` header to `plain/text` (to avoid a preflight request)
288+
* Append the `gzip=1` query param to the bidder request (to signal to a bidder's server-side endpoint that the request is compressed)
285289

286290
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.
287291

0 commit comments

Comments
 (0)