Regs.gpp
The Global Privacy Platform consent string, which can bundle sections for several jurisdictions (TCF EU, TCF Canada, the US national section, US states) into one value. Added in 2.6-202211.
Field facts
- Path
regs.gpp- Object
- Regs
- Type
- string
- Requirement
- Optional
- Added
- OpenRTB 2.6-202211
- Spec section
- 3.2.3
How it is used
A GPP string is a header followed by one payload per section, separated by tildes. The header lists the sections the string contains, and Regs.gpp_sid tells bidders which of them apply to this transaction. Take the string from a consent management platform or the IAB encoder rather than assembling it by hand.
Example
Where the field sits in a payload, with everything else left out:
{
"id": "req-1",
"regs": {
"gpp": "DBABLA~BAAAAAAAQA"
}
}Common mistakes
- Sending
gppwithoutgpp_sid, which leaves bidders guessing which section governs the user (openrtb.regs.gpp_without_gpp_sid). - Concatenating a TCF string and a US Privacy string by hand produces something that does not decode as GPP (
openrtb.regs.gpp_malformed). - Sending
gppon a request declared as 2.6-202210 or earlier, where the field does not exist yet.
Version history
Added in OpenRTB 2.6-202211, and present in the latest snapshot. The table shows how each version's spec text types the field.
| Versions | Type in the spec | Required | Deprecated |
|---|---|---|---|
| 2.6-202211 to 2.6-202606 | string | No | No |
Versioned rules that name this field
openrtb.2.6-202211.regs.gppOpenRTB 2.6-202211 added GPP consent signaling to the regs object.
Related fields
Other Regs fields
For a walkthrough of the whole object, read Privacy signals.