Regs.us_privacy

The IAB US Privacy string for CCPA, four characters such as 1YNN: a version digit, then Y, N, or a hyphen for notice given, opt-out of sale, and coverage by the Limited Service Provider Agreement. A core field since 2.6.

CurrentstringOptionalSince 2.6-202204

Field facts

Path
regs.us_privacy
Object
Regs
Type
string
Requirement
Optional
Added
OpenRTB 2.6-202204
Spec section
3.2.3

How it is used

Before 2.6 the string traveled as regs.ext.us_privacy under the IAB CCPA extension. IAB Tech Lab has deprecated the US Privacy string in favor of GPP, so new work should send Regs.gpp with the right Regs.gpp_sid. Keep parsing us_privacy, because live traffic still carries it, and keep the two signals consistent when you send both.

Example

Where the field sits in a payload, with everything else left out:

{
  "id": "req-1",
  "regs": {
    "us_privacy": "1YNN"
  }
}

Common mistakes

  • A value that is not exactly four characters from the allowed alphabet, such as yes or 1YN (openrtb.regs.us_privacy_malformed).
  • Reading 1--- as an opt-out. Hyphens mean the question does not apply, not that the user objected.

Version history

Added in OpenRTB 2.6-202204, and present in the latest snapshot. The table shows how each version's spec text types the field.

VersionsType in the specRequiredDeprecated
2.6-202204Added in the first 2.6 release, published without a structured text archive; the 2.6-202210 republication is the first tagged text.
2.6-202210 to 2.6-202606stringNoNo

Related fields

Other Regs fields

For a walkthrough of the whole object, read Privacy signals.