Skip to content

ID5 UserId - added docs for gamTargetingPrefix #6178

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
ChrisHuie merged 4 commits into from
Aug 29, 2025
Merged

ID5 UserId - added docs for gamTargetingPrefix #6178

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8341be4
ID5 UserId - added docs for gamTargetingPrefix
abazylewicz-id5 Jul 25, 2025
ebf3c98
ID5 UserId - add examples of GAM targeting tags
abazylewicz-id5 Jul 28, 2025
2e98e15
ID5 UserId - update documentation to use GPID
abazylewicz-id5 Jul 28, 2025
2484c6c
ID5 UserId - fix lint
abazylewicz-id5 Jul 28, 2025
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
4 changes: 3 additions & 1 deletion dev-docs/modules/userid-submodules/id5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ The following configuration parameters are available:
| params.disableExtensions | Optional | Boolean | Set this to `true` to force turn off extensions call. Default `false` | `true` or `false` |
| params.canCookieSync | Optional | Boolean | Set this to `true` to enable cookie syncing with other ID5 partners. See [our documentation](https://wiki.id5.io/docs/initiate-cookie-sync-to-id5) for details. Default `false` | `true` or `false` |
| params.provider | Optional | String | An identifier provided by ID5 to technology partners who manage API deployments on behalf of their clients. Reach out to ID5 if you have questions about this parameter. | `"providerName"` |
| params.gamTargetingPrefix | Optional | String | When this parameter is set the ID5 module will set appropriate GAM pubads targeting tags | `"id5"` |

{: .alert.alert-info :}
**NOTE:** The ID5 ID that is delivered to Prebid will be encrypted by ID5 with a rotating key to avoid unauthorized usage and to enforce privacy requirements. Therefore, we strongly recommend setting `storage.refreshInSeconds` to `2` hours (`7200` seconds) or less to ensure all demand partners receive an ID that has been encrypted with the latest key, has up-to-date privacy signals, and allows them to transact against it.
Expand Down Expand Up @@ -72,7 +73,8 @@ pbjs.setConfig({
enabled: true, // false by default
controlGroupPct: 0.1 // valid values are 0.0 - 1.0 (inclusive)
},
canCookieSync: true // optional, has effect only when externalModuleUrl is used
canCookieSync: true, // optional, has effect only when externalModuleUrl is used
gamTargetingPrefix: "id5" // optional, when set the ID5 module will set gam targeting paramaters with this prefix
},
storage: {
type: 'html5', // "html5" is the recommended storage type
Expand Down