Skip to content

Commit 2f91e36

Browse files
dgirardijlaso
authored andcommitted
Document bidderSettings.storageAllowed (prebid#3540)
* Document bidderSettings.storageAllowed See PBJS issue: prebid/Prebid.js#7280 (and PR: prebid/Prebid.js#7992) * Update `bidderSettings.storageAllowed` documentation to make it clear how it interacts with other storage management settings * Update version for introduction of `bidderSettings.storageAllowed`
1 parent 96585a2 commit 2f91e36

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

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

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ Some sample scenarios where publishers may wish to alter the default settings:
4343
| bidCpmAdjustment | standard or adapter-specific | all | n/a | Could, for example, adjust a bidder's gross-price bid to net price. |
4444
| sendStandardTargeting | adapter-specific | 0.13.0 | true | If adapter-specific targeting is specified, can be used to suppress the standard targeting for that adapter. |
4545
| suppressEmptyKeys | standard or adapter-specific | 0.13.0 | false | If custom adserverTargeting functions are specified that may generate empty keys, this can be used to suppress them. |
46-
| allowZeroCpmBids | standard of adapter-specific | 6.2.0 | false | Would allow bids with a 0 CPM to be accepted by Prebid.js and could be passed to the ad server. |
46+
| allowZeroCpmBids | standard or adapter-specific | 6.2.0 | false | Would allow bids with a 0 CPM to be accepted by Prebid.js and could be passed to the ad server. |
47+
| storageAllowed | standard or adapter-specific | 6.13.0 | true | Allow use of cookies and local storage. |
4748

4849
##### 2.1. adserverTargeting
4950

@@ -225,4 +226,12 @@ By default, 0 CPM bids are ignored by Prebid.js entirely. However if there's a
225226
either specific bid adapter(s) or all bid adapters the permission for these bids to be processed by Prebid.js and potentially sent to the respective ad server
226227
(depending on the Prebid.js auction results).
227228

229+
##### 2.6. storageAllowed
230+
231+
By default, bid adapters can access browser cookies and local storage. This can be disabled by setting `storageAllowed` to `false`.
232+
233+
Note that:
234+
- [Disabling device access](/dev-docs/publisher-api-reference/setConfig.html#setConfig-deviceAccess) will prevent access to storage regardless of this setting;
235+
- `storageAllowed` will only affect bid adapters and not any other type of module (such as analytics or RTD).
236+
228237
<hr class="full-rule" />

0 commit comments

Comments
 (0)