Updated documentation for Yahoo ConnectID UserID module (prebid#4456)

Co-authored-by: slimkrazy <sam@slimkrazy.com>
eskimi · May 23, 2023 · f202f42 · f202f42
1 parent e0328f4
commit f202f42
Showing 1 changed file with 38 additions and 56 deletions.
diff --git a/dev-docs/modules/userid-submodules/yahoo.md b/dev-docs/modules/userid-submodules/yahoo.md
@@ -5,104 +5,86 @@ description: Yahoo ConnectID User ID sub-module
 useridmodule: connectIdSystem
 ---
 
-Yahoo ConnectID is a person based ID and does not depend on 3rd party cookies. It enables ad tech platforms to recognize and match users consistently across the open web. Built on top of Yahoo’s robust and proprietary ID Graph it delivers a higher find rate of audiences on publishers’ sites user targeting that respects privacy.
+Yahoo ConnectID is a person based ID and does not depend on 3rd party cookies. It enables ad tech platforms to recognize and match users consistently across the open web. Built on top of Yahoo's robust and proprietary ID Graph it delivers higher monetization while respecting user privacy via multiple controls.
 
-## Honoring Privacy Choices
-
-Yahoo ConnectID provides multiple mechanisms for users to manage their privacy choices. Users can manage their choices via [ConnectID Control Portal](http://connectid.yahoo.com), on the [Yahoo Privacy Dashboard](https://legal.yahoo.com/us/en/yahoo/privacy/dashboard/index.html) and [NAI’s Audience Matched Opt Out page](https://optout.networkadvertising.org/optout/email).  No further actions are required by Publishers as Yahoo will ensure that privacy choices selected by users via one of these methods are honored. We will automatically stop generating ConnectIDs for users who have opted-out.
-
-When desired, additional privacy control can be provided to your users. Within your privacy policy or website privacy settings, [Create an Easy Opt-in Opt-out Toggle](https://documentation.help.yahooinc.com/platform/SSP/Sellers/Integrate/Create-an-Easy-OptIn-Optout-Toggle.htm) for ConnectID.
-
-Finally, ConnectID follows all global privacy laws (such as the CCPA) and industry frameworks (such as NAI, DAA and IAB). Yahoo will auto-detect most privacy signals present on the page (including those set by prebid libraries) and not generate a ConnectID for users that have opted-out.
+Add support for Yahoo ConnectID to your Prebid.js package using:
 
+{: .alert.alert-info :}
+gulp build --modules=userId,connectIdSystem
 
 ## Yahoo ConnectID Registration
 
-A Yahoo supplied publisher specific pixel Id is required. Please reach out to your account manager for assistance with setup.
-
-Add support for Yahoo ConnectID to your Prebid.js package with:
-
-{: .alert.alert-info :}
-gulp build --modules=userId,connectIdSystem
+A Yahoo-supplied publisher-specific pixel ID is required. Reach out to [connectid.support@yahooinc.com](mailto:connectid.support@yahooinc.com) for assistance with setup.
 
 
 ## Yahoo ConnectID Configuration
+Note: Parameters are case-sensitive. ConnectID is the proper name of our product, however, when used in code it is spelled as connect**I**d. Follow the example in the table below.
 
 <div class="table-responsive" markdown="1">
 | Param under userSync.userIds[] | Scope | Type | Description | Example |
 | --- | --- | --- | --- | --- |
-| name | Required | String | The name of this module. | `'connectId'` |
+| name | Required | String | The name of this module. | `"connectId"` |
 | params | Required | Object | Container of all module params. ||
-| params.pixelId | Required | Number | The Yahoo supplied publisher specific pixel Id  | `8976` |
-| params.he | Optional | String | The SHA-256 hashed user email address. One of either the `he` parameter or the `puid` parameter must be supplied. |`'ed8ddbf5a171981db8ef938596ca297d5e3f84bcc280041c5880dba3baf9c1d4'`|
-| params.puid | Optional | String | The publisher-supplied user identifier. One of either the `he` parameter or the `puid` parameter must be supplied. | `"P-975484817"` |
-| storage | Required | Object | Defines where and for how long the results of the call to get a user ID will be stored. | |
-| storage.type | Required | String | Defines where the resolved user ID will be stored (either `'cookie'` or `'html5'` localstorage).| `'html5'` |
-| storage.name | Required | String | The name of the cookie or html5 localstorage where the resolved user ID will be stored. | `'connectId'` |
-| storage.expires | Recommended | Integer | How long (in days) the user ID information will be stored. The recommended value is `15` | `15` |
+| params.pixelId | Required | Number |
+The Yahoo-supplied publisher-specific pixel ID. | `"0000"` |
+| params.he | Optional | String | The SHA-256 hashed user email address which has been lowercased prior to hashing. Pass both `he` and `puid` params if present, otherwise pass either of the two that is available. |`"ed8ddbf5a171981db8ef938596ca297d5e3f84bcc280041c5880dba3baf9c1d4"`|
+| params.puid | Optional | String | The publisher supplied user identifier such as a first-party cookie. Pass both `he` and `puid` params if present, otherwise pass either of the two that is available. | `"ab9iibf5a231ii1db8ef911596ca297d5e3f84biii00041c5880dba3baf9c1da"` |
 {: .table .table-bordered .table-striped }
 </div>
 
 
 ## Yahoo ConnectID Examples
 
 ```
-// [Sample #1]: Using a hashed email.
+// [Sample #1]: Using a hashed email only.
+
 pbjs.setConfig({
     userSync: {
         userIds: [{
             name: "connectId",
             params: {
-              pixelId: 8976,
+              pixelId: "0000",
               he: "ed8ddbf5a171981db8ef938596ca297d5e3f84bcc280041c5880dba3baf9c1d4"
-            },
-            storage: {
-              type: "html5",
-              name: "connectId",
-              expires: 15
             }
         }]
     }
 })
 ```
 
 ```
-// [Sample #2]: Using a publisher-supplied user identifier.
-pbjs.setConfig({
-    userSync: {
-        userIds: [{
-            name: "connectId",
-            params: {
-              pixelId: 8976,
-              puid: "P-975484817"
-            },
-            storage: {
-              type: "html5",
-              name: "connectId",
-              expires: 15
-            }
-        }]
-    }
-})
-```
+// [Sample #2]: Using a hashed email and a publisher-supplied user identifier such as a first-party cookie.
 
-```
-// [Sample #3]: Using a hashed email and a publisher-supplied user identifier.
 pbjs.setConfig({
     userSync: {
         userIds: [{
             name: "connectId",
             params: {
-              pixelId: 8976,
+              pixelId: "0000",
               he: "ed8ddbf5a171981db8ef938596ca297d5e3f84bcc280041c5880dba3baf9c1d4",
-              puid: "P-975484817"
-            },
-            storage: {
-              type: "html5",
-              name: "connectId",
-              expires: 15
+              puid: "ab9iibf5a231ii1db8ef911596ca297d5e3f84biii00041c580dba3baf9c1da"
             }
         }]
     }
 })
 ```
+
+## Honoring Privacy Choices
+
+Yahoo ConnectID provides multiple mechanisms for users to manage their privacy choices. Users can manage their choices via [ConnectID Control Portal](http://connectid.yahoo.com), on the [Yahoo Privacy Dashboard](https://legal.yahoo.com/us/en/yahoo/privacy/dashboard/index.html) and [NAI’s Audience Matched Opt Out page](https://optout.networkadvertising.org/optout/email).  No further actions are required by Publishers as Yahoo will ensure that privacy choices selected by users via one of these methods are honored. We will automatically stop generating ConnectIDs for users who have opted-out.
+
+When desired, additional privacy control can be provided to your users. Within your privacy policy or website privacy settings, [Create an Easy Opt-in Opt-out Toggle](https://documentation.help.yahooinc.com/platform/SSP/Sellers/Integrate/Create-an-Easy-OptIn-Optout-Toggle.htm) for ConnectID.
+
+Finally, ConnectID follows all global privacy laws (such as the CCPA) and industry frameworks (such as NAI, DAA and IAB). Yahoo will auto-detect most privacy signals present on the page (including those set by Prebid libraries) and not generate a ConnectID for users that have opted-out.
+
+## Yahoo ConnectID Optional Parameters
+Please note that the storage related parameters are optional. We recommend that you omit them, since ConnectID module is pre-configured with the most optimal storage parameters already.
+
+<div class="table-responsive" markdown="1">
+| Param under userSync.userIds[] | Scope | Type | Description | Example |
+| --- | --- | --- | --- | --- |
+| storage | Optional | Object | Defines where and for how long the results of the call to get a user ID will be stored. | |
+| storage.type | Optional | String | Defines where the resolved user ID will be stored (either `'cookie'` or `'html5'` local storage).| `'cookie'` |
+| storage.name | Optional | String | The name of the cookie or html5 local storage where the resolved user ID will be stored. | `'connectId'` |
+| storage.expires | Optional | Integer | How long (in days) the user ID information will be stored. | `15` |
+{: .table .table-bordered .table-striped }
+</div>