Skip to content

Document the IAB GPP UserDefaults keys the SDK now reads #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jrosendahl-opt merged 2 commits into from
Nov 3, 2026
Merged

Document the IAB GPP UserDefaults keys the SDK now reads #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e13d733
Document the IAB GPP UserDefaults keys the SDK now reads
jrosendahl-opt Oct 30, 2026
89b5426
Merge branch 'master' into docs/gpp-userdefaults-keys
jrosendahl-opt Nov 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/usage-objc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,11 +114,13 @@ If you don't set them, the SDK reads the values that an IAB-compliant consent ma
| Config property | `NSUserDefaults` fallback key | Sent as |
|---|---|---|
| `gdpr` + `gdprConsent` | `IABTCF_gdprApplies` + `IABTCF_TCString` | `gdpr`, `gdpr_consent` |
| `gpp` | `IABGPP_2_TCString` | `gpp` |
| `gppSid` | none | `gpp_sid` |
| `gpp` | `IABGPP_HDR_GppString` | `gpp` |
| `gppSid` | `IABGPP_GppSID` | `gpp_sid` |
| `reg` | none | `reg` |

`gdpr` and `gdprConsent` are used together: if either one is missing from the config, the SDK ignores both and uses the `NSUserDefaults` values instead. `gppSid` has no `NSUserDefaults` fallback, so if you rely on your CMP for `gpp`, set `gppSid` yourself.
`gdpr` and `gdprConsent` are used together: if either one is missing from the config, the SDK ignores both and uses the `NSUserDefaults` values instead. `gppSid` falls back to `IABGPP_GppSID` only when `gpp` also comes from `NSUserDefaults`, so the section IDs always match the string they describe: if you set `gpp` in the config, set `gppSid` too. The CMP stores section IDs separated by underscores (`2_7`); the SDK sends them comma-separated (`2,7`).

If `IABGPP_HDR_GppString` is not set, the SDK also reads `gpp` from `IABGPP_2_TCString`, a key that earlier versions of the SDK used.

### Identify API

Expand Down
8 changes: 5 additions & 3 deletions docs/usage-swift.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,13 @@ If you don't set them, the SDK reads the values that an IAB-compliant consent ma
| Config property | `UserDefaults` fallback key | Sent as |
|---|---|---|
| `gdpr` + `gdprConsent` | `IABTCF_gdprApplies` + `IABTCF_TCString` | `gdpr`, `gdpr_consent` |
| `gpp` | `IABGPP_2_TCString` | `gpp` |
| `gppSid` | none | `gpp_sid` |
| `gpp` | `IABGPP_HDR_GppString` | `gpp` |
| `gppSid` | `IABGPP_GppSID` | `gpp_sid` |
| `reg` | none | `reg` |

`gdpr` and `gdprConsent` are used together: if either one is missing from the config, the SDK ignores both and uses the `UserDefaults` values instead. `gppSid` has no `UserDefaults` fallback, so if you rely on your CMP for `gpp`, set `gppSid` yourself.
`gdpr` and `gdprConsent` are used together: if either one is missing from the config, the SDK ignores both and uses the `UserDefaults` values instead. `gppSid` falls back to `IABGPP_GppSID` only when `gpp` also comes from `UserDefaults`, so the section IDs always match the string they describe: if you set `gpp` in the config, set `gppSid` too. The CMP stores section IDs separated by underscores (`2_7`); the SDK sends them comma-separated (`2,7`).

If `IABGPP_HDR_GppString` is not set, the SDK also reads `gpp` from `IABGPP_2_TCString`, a key that earlier versions of the SDK used.

### Identify API

Expand Down
Loading