Skip to content

Commit c552e6d

Browse files
committed
updated docs for the pubmatic bid adapter supporting endpoint compression
1 parent 8d7d6b7 commit c552e6d

File tree

2 files changed

+6
-27
lines changed

2 files changed

+6
-27
lines changed

dev-docs/bidders/pubmatic.md

+6
Original file line numberDiff line numberDiff line change
@@ -226,4 +226,10 @@ Publishers should use the `ortb2` method of setting [First Party Data](https://d
226226
- `ortb2.user.*`
227227

228228
AdUnit-specific data is supported using `AdUnit.ortb2Imp.ext.*`
229+
230+
### Endpoint Compression
231+
232+
If the browser a Prebid auction is running in supports gzip compression, the PubMatic bid adapter will automatically compress all outgoing bid requests to the PubMatic server-side endpoint (which provides support for receiving gzip compressed requests). If gzip compression is not supported by the browser, bid requests will be sent uncompressed.
233+
234+
Note: If the Prebid.js debugging query param, `?pbjs_debug=true`, is present in the URL, the feature will be disabled and all bid requests will be sent uncompressed.
229235
<!-- workaround bug where code blocks at end of a file are incorrectly formatted-->

dev-docs/publisher-api-reference/bidderSettings.md

-27
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ Some sample scenarios where publishers may wish to alter the default settings:
4848
| allowAlternateBidderCodes | standard or adapter-specific | 6.23.0 | true in v6.x <br /> false from v7.0| Allow adapters to bid with alternate bidder codes. |
4949
| allowedAlternateBidderCodes | standard or adapter-specific | 6.23.0 | n/a | Array of bidder codes for which an adapter can bid. <br />`undefined` or `['*']` will allow adapter to bid with any bidder code. |
5050
| adjustAlternateBids | standard or adapter-specific | 7.48.0 | false | Optionally allow alternate bidder codes to use an adapter's bidCpmAdjustment function by default instead of the standard bidCpmAdjustment function if present (note: if a bidCpmAdjustment function exists for the alternate bidder code within bidderSettings, then this will be used instead of falling back to the adapter's bidCpmAdjustment function). |
51-
| endpointCompression | standard or adapter-specific | 9.42.0 | false | Compresses bid requests sent to bidder endpoints using gzip if browser supports it (`note: bidder endpoints must support gzip compressed bid requests`). |
5251

5352
##### 2.1. adserverTargeting
5453

@@ -345,30 +344,4 @@ pbjs.bidderSettings = {
345344

346345
In the above example, if PubMatic were to return the "groupm" bidder code then the bidCpmAdjustment function under `pubmatic` would be used instead of what is available under `standard`.
347346

348-
##### 2.11. endpointCompression
349-
350-
{: .alert.alert-warning :}
351-
Note: The bidder's endpoint must already support receiving gzip compressed bid requests (otherwise this feature will not work and most likely throw an error with the bidder's endpoint).
352-
353-
If this setting is enabled (`true`), Prebid.js will attempt to gzip-compress bid requests sent to bidder endpoints when possible.
354-
355-
Compression is performed client-side using the browser's [CompressionStream](https://developer.mozilla.org/en-US/docs/Web/API/CompressionStream) API, if available. If CompressionStream is not supported by the user's browser, the bid request will be sent uncompressed.
356-
357-
This setting can be enabled either:
358-
359-
* globally for all bidders (under the `standard` section), or
360-
* specifically for one or more bidders.
361-
362-
The default value is `false`, meaning requests are not compressed unless explicitly configured by the publisher.
363-
364-
**Example enabling endpoint compression for a specific bidder (PubMatic):**
365-
366-
```javascript
367-
pbjs.bidderSettings = {
368-
pubmatic: {
369-
endpointCompression: true
370-
}
371-
};
372-
```
373-
374347
<hr class="full-rule" />

0 commit comments

Comments
 (0)