From 16b48af2388e85efcb444c598b979538dff045e5 Mon Sep 17 00:00:00 2001 From: Nitin Shirsat Date: Fri, 31 Oct 2025 11:52:45 +0530 Subject: [PATCH 1/2] Consent Management reset --- dev-docs/modules/consentManagementGpp.md | 18 ++++++++++++++++++ dev-docs/modules/consentManagementTcf.md | 17 +++++++++++++++++ 2 files changed, 35 insertions(+) diff --git a/dev-docs/modules/consentManagementGpp.md b/dev-docs/modules/consentManagementGpp.md index fe72296cdd..1eefbd9d2e 100644 --- a/dev-docs/modules/consentManagementGpp.md +++ b/dev-docs/modules/consentManagementGpp.md @@ -58,6 +58,7 @@ Here are the parameters supported in the `consentManagement` object specific for | Param | Type | Description | Example | | --- | --- | --- | --- | | gpp | `Object` | | | +| gpp.enabled | `boolean` | Enables or disables the GPP consent management module. When set to `false`, Prebid does not initialize the CMP integration, does not delay auctions for consent, removes any active CMP event listeners. Defaults to `true` if not specified. | `false` | | gpp.cmpApi | `string` | The CMP interface that is in use. Supported values are **'iab'** or **'static'**. Static allows integrations where IAB-formatted consent strings are provided in a non-standard way. Default is `'iab'`. | `'iab'` | | gpp.timeout | `integer` | Length of time (in milliseconds) to allow the CMP to obtain the GPP consent information. Default is `10000`. | `10000` | | gpp.actionTimeout | `integer` | Length of time (in milliseconds) to allow the user to take action to consent if they have not already done so. The actionTimer first waits for the CMP to load, then the actionTimeout begins for the specified duration. Default is `undefined`. | `10000` | @@ -117,6 +118,23 @@ Example 2: Static CMP using custom data passing. }); ``` +Example 3: Disabling the module. When disabled, Prebid.js will not fetch GPP data, will not wait for the CMP. Existing CMP listeners (if any were previously active) are cleaned up. + +```javascript + var pbjs = pbjs || {}; + pbjs.que = pbjs.que || []; + pbjs.que.push(function() { + pbjs.setConfig({ + consentManagement: { + gpp: { + enabled: false + } + } + }); + }); +``` + + ## Build the Package 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, an additional option must be added to the **gulp build** command: diff --git a/dev-docs/modules/consentManagementTcf.md b/dev-docs/modules/consentManagementTcf.md index e4963fd332..f766a94aa9 100644 --- a/dev-docs/modules/consentManagementTcf.md +++ b/dev-docs/modules/consentManagementTcf.md @@ -66,6 +66,7 @@ but we recommend migrating to the new config structure as soon as possible. | Param | Type | Description | Example | | --- | --- | --- | --- | | gdpr | `Object` | | | +| gdpr.enabled | `boolean` | Enables or disables the TCF consent management module. When set to `false`, Prebid does not initialize the CMP integration, does not delay auctions for consent, removes any active CMP event listeners. Defaults to `true` if not specified. | `false` | | gdpr.cmpApi | `string` | The CMP interface that is in use. Supported values are **'iab'** or **'static'**. Static allows integrations where IAB-formatted consent strings are provided in a non-standard way. Default is `'iab'`. | `'iab'` | | gdpr.timeout | `integer` | Length of time (in milliseconds) to allow the CMP to obtain the GDPR consent string. Default is `10000`. | `10000` | | gdpr.actionTimeout | `integer` | Length of time (in milliseconds) to allow the user to take action to consent if they have not already done so. The actionTimer first waits for the CMP to load, then the actionTimeout begins for the specified duration. Default is `undefined`. | `10000` | @@ -171,6 +172,22 @@ Example 3: Static CMP using custom data passing. }); ``` +Example 4: Disabling the module. When disabled, Prebid.js will not fetch TCF data, will not wait for the CMP. Existing CMP listeners (if any were previously active) are cleaned up. + +```javascript + var pbjs = pbjs || {}; + pbjs.que = pbjs.que || []; + pbjs.que.push(function() { + pbjs.setConfig({ + consentManagement: { + gdpr: { + enabled: false + } + } + }); + }); +``` + ## Build the Package 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, an additional option must be added to the **gulp build** command: From 8d9b97153e2cf19cc271b4eb3f8f5af5b539ce80 Mon Sep 17 00:00:00 2001 From: Nitin Shirsat Date: Fri, 31 Oct 2025 12:44:50 +0530 Subject: [PATCH 2/2] Fix line lint issue --- dev-docs/modules/consentManagementGpp.md | 1 - 1 file changed, 1 deletion(-) diff --git a/dev-docs/modules/consentManagementGpp.md b/dev-docs/modules/consentManagementGpp.md index 1eefbd9d2e..80c3bd77b8 100644 --- a/dev-docs/modules/consentManagementGpp.md +++ b/dev-docs/modules/consentManagementGpp.md @@ -134,7 +134,6 @@ Example 3: Disabling the module. When disabled, Prebid.js will not fetch GPP dat }); ``` - ## Build the Package 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, an additional option must be added to the **gulp build** command: