Integrate with Yahoo ConnectID: Prebid Method
  • 3 Minutes to read

    Integrate with Yahoo ConnectID: Prebid Method


      Article summary

      Publishers need a privacy-centric solution to bridge the identity gap while continuing to generate revenue amidst the changes in signal loss and privacy regulations due to the ongoing evolution of the identity landscape. Built on the robust and proprietary Yahoo Identity Graph, Yahoo ConnectID is a future-proofed solution designed to enable ad tech platforms to consistently recognize and match users across the open web.

      Add support for Yahoo ConnectID to your Prebid.js package using:

      gulp build –modules=userId,ConnectIdSystem

      Yahoo ConnectID Registration

      A Yahoo-supplied publisher-specific pixel ID is required. Reach out to [email protected] 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 connectId. Follow the example in the table below.

      Params under userSync.userIds[]

      Scope

      Type

      Description

      Example

      name

      Required

      String

      The name of this module

      “connectId”

      params

      Required

      Object

      Container of all module params.

      params.pixelId

      Required

      String

      The Yahoo-supplied publisher-specific pixel ID

      “0000”

      params.pixelId

      Required

      String

      The Yahoo-supplied publisher-specific pixel ID

      “0000”

      params.he

      Optional (Required if using prebid version below 7.52)

      String

      The SHA-256 hashed user email address which has been lowercased prior to hashing.

      “ed8dd…” (should be 64 characters)

      params.puid

      Optional

      String

      A domain-specific user identifier such as a first-party cookie. If not passed, a puid value will be auto-generated and stored in local and / or cookie storage.

      “ab9ii…” (should be 64 characters)

      Samples

      We recommend loading ConnectID identity module all the time. Populate the “he” parameter when the value is available.

      // [Sample #1]: Using a hashed email only.
      
      
      pbjs.setConfig({
          userSync: {
              userIds: [{
                  name: "connectId",
                  params: {
                    pixelId: “0000”,
                    he: "ed8ddbf5a171981db8ef938596ca297d5e3f84bcc280041c5880dba3baf9c1d4"
                  }
              }]
          }
      })
      // [Sample #2]: Neither a hashed email nor a publisher user identifier is passed.
      
      
      pbjs.setConfig({
          userSync: {
              userIds: [{
                  name: "connectId",
                  params: {
                    pixelId: "0000",
                  }
              }]
          }
      })
      // [Sample #3]: Using a hashed email and a publisher user identifier such as a first-party cookie.
      
      
      pbjs.setConfig({
          userSync: {
              userIds: [{
                  name: "connectId",
                  params: {
                    pixelId: "0000",
                    he: "ed8ddbf5a171981db8ef938596ca297d5e3f84bcc280041c5880dba3baf9c1d4",
      	puid: "ab9iibf5a231ii1db8ef911596ca297d5e3f84biii00041c580dba3baf9c1da"
                  }
              }]
          }
      })

      To learn more about ConnectID using the Prebid method go to Prebid.org.

      Implementation Verification

      Follow the steps below to check that ConnectIDs are being successfully retrieved and included on ad requests.

      1. Open a Prebid-enabled page on the website.

      2. Open the browser console and enter pbjs.getUserIds().

      3. Verify connectId is in the list.

        • If connectId is not in the list, the correct pixelId parameter is likely not being passed. Verify you are using the correct value provided by Yahoo. Reach out to [email protected] for assistance.

      4. Verify that ConnectID is successfully included in the ad requests.

        • Go to the Network tab and search for an ad call event to any of the SSPs that you are using (e.g., “prebid-client”).

        • Navigate to the Payload tab. Check that yahoo.com is listed as a source in the user.ext.eids array.

      5. Repeat steps 1-4 after an email is provided via login or some other mechanism used to collect user registration on the website.

      Honoring Privacy Choices

      Yahoo ConnectID provides multiple mechanisms for users to manage their privacy choices. Users can manage their choices via ConnectID Control Portal, on the Yahoo Privacy Dashboard and NAI’s Audience Matched Opt Out page. 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 for ConnectID.

      Finally, ConnectID follows all global privacy laws (such as the CPRA) 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.

      Params 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


      Was this article helpful?