Skip to content

Commit

Permalink
Update consentManagement.md to add AC string (#2219)
Browse files Browse the repository at this point in the history
* Update consentManagement.md

* Update bidder-adaptor.md
  • Loading branch information
patmmccann authored Aug 20, 2020
1 parent 7c242ea commit e8f224d
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
2 changes: 1 addition & 1 deletion dev-docs/bidder-adaptor.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ Here is a sample bidderRequest object:
Notes on parameters in the bidderRequest object:
- **auctionID** is unique per call to `requestBids()`, but is the same across ad units.
- **refererInfo** is provided so you don't have to call any utils functions. See below for more information.
- **gdprConsent** is the object containing data from the [GDPR ConsentManagement](/dev-docs/modules/consentManagement.html) module
- **gdprConsent** is the object containing data from the [GDPR ConsentManagement](/dev-docs/modules/consentManagement.html) module. For TCF2+, it will contain both the tcfString and the addtlConsent string if the CMP sets the latter as part of the TCData object.
- **uspConsent** is the object containing data from the [US Privacy ConsentManagement](/dev-docs/modules/consentManagementUsp.html) module

<a name="std-param-location"></a>
Expand Down
9 changes: 7 additions & 2 deletions dev-docs/modules/consentManagement.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ Prebid functionality created to address regulatory requirements does not replace

This base EU GDPR consent management module performs these actions:

1. Fetch the user's GDPR consent data from the CMP.
1. Fetch the user's GDPR & Google additional consent data from the CMP.
2. Incorporate this data into the auction objects for adapters to collect.

The optional [GDPR enforcement module](/dev-docs/modules/gdprEnforcement.html) adds on these actions:

3. Allows the page to define which activities should be enforced at the Prebid.js level.
4. Actively enforces those activities based on user consent data.
4. Actively enforces those activities based on user consent data (in the TCF string, not the AC string).

In the case of a new user, CMPs will generally respond only after there is consent information available (i.e., the user has made their consent choices).
Making these selections can take some time for the average user, so the module provides timeout settings.
Expand Down Expand Up @@ -76,6 +76,7 @@ but we recommend migrating to the new config structure as soon as possible.
| gdpr.allowAuctionWithoutConsent | `boolean` | (TCF v1.1 only) Determines what will happen if obtaining consent information from the CMP fails; either allow the auction to proceed (`true`) or cancel the auction (`false`). Default is `true` | `true` |
| gdpr.consentData | `Object` | An object representing the GDPR consent data being passed directly; only used when cmpApi is 'static'. Default is `undefined`. | |
| gdpr.consentData.getTCData.tcString | `string` | (TCF v2.0 only) Base64url-encoded TCF v2.0 string with segments. | |
| gdpr.consentData.getTCData.addtlConsent | `string` | (TCF v2.0 only) Additional consent string if available from the cmp TCData object | |
| gdpr.consentData.getTCData.gdprApplies | `boolean` | (TCF v2.0 only) Defines whether or not this pageview is in GDPR scope. | |
| gdpr.consentData.getConsentData.gdprApplies | `boolean` | (TCF v1.1 only) Defines whether or not this pageview is in GDPR scope. | |
| gdpr.consentData.getConsentData.hasGlobalScope | `boolean` | (TCF v1.1 only) True if consent data is global, false if it's publisher specific. | |
Expand Down Expand Up @@ -226,6 +227,10 @@ Here is a sample of how the data is structured in the `bidderRequest` object:

This field contains the user's choices on consent, represented as an encoded string value. In certain scenarios, this field might come to you with an `undefined` value; normally this happens when there was an error during the CMP interaction and the publisher had the config option `allowAuctionWithoutConsent` set to `true`. If you don't want to pass `undefined` to your system, you can check for this value and replace it with a valid consent string. See the *consent_required* code in the example below (under "gdprApplies") for a possible approach to checking and replacing values.

**_addtlConsent_**

If the CMP responds with additional consent data as proposed at https://support.google.com/admanager/answer/9681920?hl=en then the corresponding string is stored here.

**_vendorData_**

This field contains the raw vendor data in relation to the user's choices on consent. This object will hold a map of all available vendors for any potential adapters that want to read the data directly. One use-case for reading from this field would be when an adapter wants to be omitted from a request where they were not given consent. Adapters are able to read through the object to find their appropriate information.
Expand Down

0 comments on commit e8f224d

Please sign in to comment.