From a3aba906e4d81c50fe077e07659c6b0d9cd9f989 Mon Sep 17 00:00:00 2001 From: Jason Quaccia Date: Thu, 22 May 2025 10:39:05 -0700 Subject: [PATCH 1/2] updated gzip docs to add a few more details --- dev-docs/bidder-adaptor.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/dev-docs/bidder-adaptor.md b/dev-docs/bidder-adaptor.md index bb801437f8..57dcf2bb97 100644 --- a/dev-docs/bidder-adaptor.md +++ b/dev-docs/bidder-adaptor.md @@ -281,7 +281,12 @@ 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. From 5580907c08ae2def633bd4a1c321cd854344533f Mon Sep 17 00:00:00 2001 From: Jason Quaccia Date: Thu, 22 May 2025 10:45:07 -0700 Subject: [PATCH 2/2] fixed markdown linter error --- dev-docs/bidder-adaptor.md | 1 - 1 file changed, 1 deletion(-) diff --git a/dev-docs/bidder-adaptor.md b/dev-docs/bidder-adaptor.md index 57dcf2bb97..d331ec25df 100644 --- a/dev-docs/bidder-adaptor.md +++ b/dev-docs/bidder-adaptor.md @@ -287,7 +287,6 @@ If the above criteria is met, Prebid.js core will do the following: * 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. #### Ad Unit Params in the validBidRequests Array