UID2 module: Add documentation for cstg #10629
Conversation
jingyi-gao-ttd
changed the title
| } | ||
| }); | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Do we need to add the description of the new CSTG specific params in the
Parameter Descriptions for the usersync Configuration Section
at the bottom of the page?
There was a problem hiding this comment.
I've addressed the changes and added CSTG specific params to the parameter description table
There was a problem hiding this comment.
Thanks let's wait for Kimberley to come back to confirm the CSTG feature naming and then we can further modify this PR if necessary
There was a problem hiding this comment.
let's push ahead with current naming until PMs can decide on the final naming
| } | ||
| }); | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Thanks let's wait for Kimberley to come back to confirm the CSTG feature naming and then we can further modify this PR if necessary
modules/uid2IdSystem.md
Outdated
| 1. Set `parmas.serverPublicKey` and `params.subscriptionId` | ||
| 2. Provide **ONLY ONE DII** by setting **ONLY ONE** of `params.email`/`params.phone`/`params.emailHash`/`params.phoneHash` | ||
|
|
||
| For the correct way to generate email and phone hash, refer to this [UID2 documentation](https://unifiedid.com/docs/getting-started/gs-normalization-encoding). |
There was a problem hiding this comment.
Matt has just now created this table earlier. Maybe you can tweak it and add to here to tell pubs clearly they may need to do normalisation/hashing depending on the param input type?
You can still tweak and add these lines too?
_Note that setIdentityFromEmail will normalize email addresses, but setIdentityFromPhone requires phone numbers to be normalized.
Refer to this page Normalization and Encoding on unifiedid.com for details on email address normalization, SHA-256 hashing and Base64 encoding._
There was a problem hiding this comment.
Thanks @jingyi-gao-ttd latest changes looks good!
modules/uid2IdSystem.md
Outdated
|
|
||
| *Note that setIdentityFromEmail will normalize email addresses, but setIdentityFromPhone requires phone numbers to be normalized.* | ||
|
|
||
| Refer to this page [Normalization and Encoding](https://unifiedid.com/docs/getting-started/gs-normalization-encoding) on [unifiedid.com](https://unifiedid.com/) for details on email address normalization, SHA-256 hashing and Base64 encoding. |
There was a problem hiding this comment.
I'm nervous this link might break, is it possible to replicate here?
There was a problem hiding this comment.
I've put that to the end
modules/uid2IdSystem.md
Outdated
| ``` | ||
| $ gulp build --modules=uid2IdSystem --disable UID2_CSTG | ||
| ``` | ||
| If you do plan to use Client-Side Token Generation (CSTG) mode, we strongly recommend consulting with the UID2 Team before implementing it in your integration. |
There was a problem hiding this comment.
Maybe change to:
If you do plan to use Client-Side Token Generation (CSTG) mode, please consult the UID2 Team first as they will provide required configuration values for you to use (see the Client-Side Token Generation (CSTG) mode section below for details)
| } | ||
| }); | ||
| ``` | ||
|
|
There was a problem hiding this comment.
let's push ahead with current naming until PMs can decide on the final naming
| **Important information:** UID2 is not designed to be used where GDPR applies. The module checks the passed-in consent data and will not operate if the `gdprApplies` flag is true. | ||
|
|
||
| ## Client-Side Token Generation (CSTG) mode | ||
|
|
There was a problem hiding this comment.
Maybe add a note in bold:
This mode is currently in the alpha stage of development. Please consult UID2 Team first as they will provide required configuration values for you to use.
….js into uid2-cstg-document
Type of change
Description of change
Update documentation for Client-Side Token Generation feature
Other information
PR for this feature: #10510