Skip to content

Commit 4e4a35a

Browse files
mkomorskiMarcin Komorski
andauthored
alwaysHasCapacity flag (#6395)
Co-authored-by: Marcin Komorski <[email protected]>
1 parent adc4af1 commit 4e4a35a

File tree

3 files changed

+12
-1
lines changed

3 files changed

+12
-1
lines changed

dev-docs/bidder-adaptor.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,8 @@ export const spec = {
238238
onSetTargeting: function(bid) {},
239239
onBidderError: function({ error, bidderRequest }) {},
240240
onAdRenderSucceeded: function(bid) {},
241-
supportedMediaTypes: [BANNER, VIDEO, NATIVE, AUDIO]
241+
supportedMediaTypes: [BANNER, VIDEO, NATIVE, AUDIO],
242+
alwaysHasCapacity: true // When true, this bidder will be omitted in checking if origin has http capacity
242243
}
243244
registerBidder(spec);
244245

@@ -1190,6 +1191,7 @@ export const spec = {
11901191
code: BIDDER_CODE,
11911192
gvlid: 0000000000,
11921193
supportedMediaTypes: [BANNER, VIDEO, NATIVE],
1194+
alwaysHasCapacity: true,
11931195
aliases: [{code: "myAlias", gvlid: 99999999999} ],
11941196
/**
11951197
* Determines whether or not the given bid request is valid.

dev-docs/modules/prebidServer.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ There are many configuration options for s2sConfig:
9999
| `customHeaders` | Optional | Object | These custom headers will be included in the XHR call to the bidder's endpoint. This will allow you to send data specific to your use case. The format consists of an object where the keys represent the header names and the values correspond to the respective header values. Here is an example how a customHeader object might look like - `{"Header1": "Value1", "Header2": "Value2"}`|
100100
| `endpointCompression` | Optional | Boolean | Gzip compress the auction request payload when supported and debug mode is off. Adds `gzip=1` to the request URL. |
101101
| `filterBidderlessCalls` | Optional | Boolean | When `true`, ad units that have no bidders defined are excluded from Prebid Server requests. Defaults to `false`. | `true` |
102+
| `alwaysHasCapacity` | Optional | Boolean | When `true`, this prebid server instance will be omitted in checking if origin has http capacity, defaults to `false` |
102103

103104
If `endpoint` and `syncEndpoint` are objects, these are the supported properties:
104105

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,14 @@ pbjs.setConfig({ maxRequestsPerOrigin: 6 });
115115
pbjs.setConfig({ maxRequestsPerOrigin: 1 });
116116
```
117117

118+
Note: Prebid adapters or Prebid Server instances can be omitted from this capacity check if they declare `alwaysHasCapacity: true`. See [bidder adapter configuration](/dev-docs/bidder-adaptor.html) and [Prebid Server configuration](/dev-docs/modules/prebidServer.html) for more details.
119+
120+
Although, `maxRequestsPerOrigin` can still be forced by the publisher using:
121+
122+
```javascript
123+
pbjs.setConfig({ maxRequestsPerOrigin: 1, forceMaxRequestsPerOrigin: true });
124+
```
125+
118126
### Disable Ajax Timeout
119127

120128
<a name="setConfig-Disable-Ajax-Timeout"></a>

0 commit comments

Comments
 (0)