Skip to content

Commit

Permalink
ID5 UserId - added docs for canCookieSync param (#5890)
Browse files Browse the repository at this point in the history
  • Loading branch information
abazylewicz-id5 authored Feb 24, 2025
1 parent a9e3f5b commit 7fdc856
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion dev-docs/modules/userid-submodules/id5.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ The following configuration parameters are available:
| params.abTesting.enabled | Optional | Boolean | Set this to `true` to turn on this feature | `true` or `false` |
| params.abTesting.controlGroupPct | Optional | Number | Must be a number between `0.0` and `1.0` (inclusive) and is used to determine the percentage of requests that fall into the control group (and thus not exposing the ID5 ID). For example, a value of `0.20` will result in 20% of requests without an ID5 ID and 80% with an ID. | `0.1` |
| 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"` |

{: .alert.alert-info :}
Expand Down Expand Up @@ -70,7 +71,8 @@ pbjs.setConfig({
abTesting: { // optional
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
},
storage: {
type: 'html5', // "html5" is the recommended storage type
Expand Down

0 comments on commit 7fdc856

Please sign in to comment.