Regs Object

Note

Fields marked with asterisk (*) are optional.

Regs Object Properties

Value

Type

Description

coppa*

integer

Flag indicating whether or not this request falls under the COPPA regulations established by the USA FTC.

  • 0 = No.

  • 1 = Yes.

gdpr*

integer

Indicates whether the request falls under GDPR regulations:

  • 0 = No

  • 1 = Yes

  • Under OpenRTB conventions for optional attributes, omission indicates Unknown

If consent is given, you should check if the user.ext.consent field is present to ascertain what form of consent was given, see the User Object section

us_privacy*

string

Passes the user privacy status for requests which fall under CCPA regulations. The string uses 4 characters, e.g. "1YN-", passed in the following order.

  1. Version Number The IAB CCPA Specification version that applies to this string, passed as an integer. Currently only 1 is available.

  2. Explicit Notice (N = No, Y = Yes, - = Not Applicable)

    Indicates whether explicit notice has been provided to the user as required by 1798.115 (d) of the CCPA and whether they have had the opportunity to opt-out of the sale of their data pursuant to 1798.120 and 1798.135 of the CCPA.

  3. Opted-Out (N = No, Y = Yes, - = Not Applicable)

    Indicates whether the user has opted-out of the sale of their personal information pursuant to 1798.120 and 1798.135.

  4. LSPA (N = No, Y = Yes, - = Not Applicable)

    Indicates whether the publisher is a signatory to the IAB Limited Service Provider Agreement (LSPA) and that the publisher declares the transaction should be treated as a “Covered Opt Out Transaction” or a “Non Opt Out Transaction” as defined in the agreement.

gpp*

string

Contains the Global Privacy Platform’s consent string. See the Global Privacy Platform specification for more details.

gpp_sid*

array of integers

Array of the section(s) of the string which should be applied for this transaction. Generally will contain one and only one value, but there are edge cases where more than one may apply. GPP Section 3 (Header) and 4 (Signal Integrity) do not need to be included. See the GPP Section Information for more details.

 
{
  "regs":{
    "coppa":1,
    "gdpr":1,
    "us_privacy":"1YN-",
    "gpp": "DBABBgAA~BVoIgAAQ.QAAA",
    "gpp_sid": 1, 2, 5,
  }
}