You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: dev-docs/modules/gppControl_usnat.md
+22Lines changed: 22 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,6 +32,28 @@ Prebid functionality created to address regulatory requirements does not replace
32
32
33
33
This module activates if the `gpp` object in the consent management configuration section exists and the consentManagementGpp module exists. See that [module's documentation](/dev-docs/modules/consentManagementGpp.html) for parameter definitions. This module does **not** work with static GPP section 7 strings provided in the first-party data `regs.gpp` object, but **does** work if the `gpp.cmpApi` is set to `static` and `gpp.consentData` is appropriately populated via setConfig.
34
34
35
+
Optional configuration options are:
36
+
37
+
{: .table .table-bordered .table-striped }
38
+
| Param | Type | Description | Example |
39
+
| --- | --- | --- | --- |
40
+
| gpp.mspa |`Object`|||
41
+
| gpp.mspa.restrictActivities |`Array`| A list of [activities](/dev-docs/activity-controls.html#activities) to be restricted in addition to the [default restrictions](/features/mspa-usnat.html#usnat-activity-restrictions). If specified, and if not already restricted, they will be treated similarly to `syncUser`. |`['accessDevice']`|
42
+
43
+
### Example: disable device access on user opt-out
Follow the basic build instructions in the GitHub Prebid.js repo's main [README](https://github.com/prebid/Prebid.js/blob/master/README.md). To include the consent management module and the GPP Control - USNat module, an additional option must be added to the **gulp build** command:
| gpp.mspa.restrictActivities |`Array`| A list of [activities](/dev-docs/activity-controls.html#activities) to be restricted in addition to the [default restrictions](/features/mspa-usnat.html#usnat-activity-restrictions). If specified, and if not already restricted, they will be treated similarly to `syncUser`. |`['accessDevice']`|
39
40
| gpp.mspa.sids |`Array`| GPP SIDs that should be covered by activity restrictions. Defaults to all US state SIDs (`[8, 9, 10, 11, 12]`). This is the only value needed for normal operation. Other options are for special cases and future-proofing. |`[8, 9]`|
40
41
| gpp.mspa.sections |`Object`| Map from section ID to per-section configuration options |`{8: {name: 'usca'}}`|
41
42
| gpp.mspa.sections.name |`String`| GPP API name to use for the section. Defaults to the names given listed under [section information -> section IDs](https://github.com/InteractiveAdvertisingBureau/Global-Privacy-Platform/blob/main/Sections/Section%20Information.md#section-ids). This option would only be used if your CMP has named their sections in a non-standard way. |`uscav3`|
42
43
| gpp.mspa.sections.normalizeAs |`integer`| Normalize the flags for this section as if it were the number provided. See [example](#normalize-example). Each section defaults to its own ID. |`8`|
#### Enable activity controls for certain sections only
47
62
48
63
```javascript
@@ -117,7 +132,7 @@ You can also use the [Prebid.js Download](/download.html) page.
117
132
118
133
-[IAB Global Privacy Platform Full Specification Repository](https://github.com/InteractiveAdvertisingBureau/Global-Privacy-Platform)
119
134
-[IAB Global Privacy Platform CMP API Specification](https://github.com/InteractiveAdvertisingBureau/Global-Privacy-Platform/blob/main/Core/CMP%20API%20Specification.md)
120
-
-[IAB Global Privacy Platform USNat string Specification](https://github.com/InteractiveAdvertisingBureau/Global-Privacy-Platform/blob/main/Sections/US-National/IAB%20Privacy%E2%80%99s%20Multi-State%20Privacy%20Agreement%20(MSPA)%20US%20National%20Technical%20Specification.md
135
+
-[IAB Global Privacy Platform USNat string Specification](https://github.com/InteractiveAdvertisingBureau/Global-Privacy-Platform/blob/main/Sections/US-National/IAB%20Privacy%E2%80%99s%20Multi-State%20Privacy%20Agreement%20(MSPA)%20US%20National%20Technical%20Specification.md)
121
136
-[Prebid US Compliance Support](/features/mspa-usnat.html)
0 commit comments