Skip to content

Commit 058fcf4

Browse files
patmmccannbretg
andauthored
USP API Doc was wrong (prebid#3667)
* Update consentManagementUsp.md * fixing table Co-authored-by: bretg <bgorsline@gmail.com>
1 parent d402774 commit 058fcf4

1 file changed

Lines changed: 15 additions & 4 deletions

File tree

dev-docs/modules/consentManagementUsp.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,19 @@ Here's a summary of the interaction process:
3838
2. Incorporate this data into the auction objects for adapters to collect.
3939
3. Proceed with the auction.
4040

41-
In the the case of a new user, the USP-API will generally respond only after there is notice and opt-out status information available (i.e., the user has made their choices).
42-
Making these selections can take some time for the average user, so the module provides timeout settings.
41+
The IAB USP-API will respond immediately if it is available. The module timeout settings are not related to user selection, but only to API availability.
4342

43+
If the timeout period expires or an error from the USP-API is thrown, the auction proceeds without a US Privacy string attached.
4444

45-
If the timeout period expires or an error from the USP-API is thrown, the auction proceeds without the user's notice and opt-out status information.
45+
The string has four characters:
46+
47+
{: .table .table-bordered .table-striped }
48+
| String Component | Values |
49+
| --- | --- |
50+
| 1) Specification Version| 1|
51+
| 2) Explicit Notice/Opportunity to Opt Out| (N = No,Y = Yes,– = Not Applicable)|
52+
| 3) Has user opted-out of the sale of his or her personal information?| (N = No,Y = Yes,– = Not Applicable)|
53+
| 4) Publisher is a signatory to the IAB Limited Service Provider Agreement| (N = No,Y = Yes,– = Not Applicable)|
4654

4755
## Page Integration
4856

@@ -60,13 +68,16 @@ Here are the parameters supported in the `consentManagement` object:
6068
| --- | --- | --- | --- |
6169
| usp | `Object` | | |
6270
| usp.cmpApi | `string` | The USP-API interface that is in use. Supported values are **'iab'** or **'static'**. Static allows integrations where IAB-formatted strings are provided in a non-standard way. Default is `'iab'`. | `'iab'` |
63-
| usp.timeout | `integer` | Length of time (in milliseconds) to allow the USP-API to obtain the CCPA string. Default is `10000`. | `10000` |
71+
| usp.timeout | `integer` | Length of time (in milliseconds) to allow the USP-API to obtain the CCPA string. Default is `50`. | `50` |
6472
| usp.consentData | `Object` | An object representing the CCPA notice and opt-out status data being passed directly; only used when cmpApi is 'static'. Default is `undefined`. | |
6573

6674
{: .alert.alert-info :}
6775
Note that the term 'CMP' (Consent Management Platform) was chosen in Prebid to keep the interface similar
6876
to the GDPR implementation, though US-Privacy doesn't specifically use that term.
6977

78+
79+
80+
7081
### Examples
7182

7283
Example 1: Support both US Privacy and GDPR

0 commit comments

Comments
 (0)