Declared ID Variables

Describes the configuration variables used to pass declared IDs through DIL to Audience Manager.

DIL Uses the Visitor ID Service to Pass Declared IDs

When used with the Visitor ID Service, you no longer need to pass in a declared IDs with the deprecated dpid and dpuuid variables. Instead, the current versions of DIL rely on the visitorService function to get the declared IDs from the setCustomerIDs function in the Visitor ID Service. For more information, see Customer IDs and Authentication States. You would call visitorService in DIL.createas shown below.

var vDil = DIL.create({
  partner:"partner name",
  visitorService:{
    namespace:"INSERT-MCORG-ID-HERE"
  }
});

In the namespace key-value pair, MCORG is your Experience Cloud Organization ID. If you don't have this ID, you can find it in the Administration section of the Experience Cloud dashboard. You need administrator permissions to view this dashboard. See Administration: Core Services.

Deprecated Functions

With the latest versions of DIL (6.2+), you don't need to use these key-value pairs to pass in declared IDs. That's because DIL now relies on the visitorService function shown in the code sample above. This function gets declared IDs from the Visitor ID Service. However, we're referencing these variables here for historical and legacy purposes. See the code below for an example of how to configure DIL.create to get a declared ID from the Visitor ID Service.

The following table describes the legacy variables used by the declaredId object:
Name Type Description
dpid String

Data partner ID assigned by Audience Manager.

dpuuid String

The data provider's unique ID for the user.

dpid and dpuuid

Audience Manager compares and matches the combined dpid and dpuuid to a corresponding user ID in our system. If an ID does not exist, Audience Manager creates a new user ID and synchronizes it to the dpid/dpuuid combination. Once Audience Manager matches or creates a user ID (the uuid) it returns that ID in the JSON response to the cookie in the client's domain (first-party cookie) or other local storage.

Call this function when you're using DIL v6.1 or earlier. However, this function has been deprecated in favor of the new version that gets delcared IDs from the Visitor ID Service.

DIL.create({
    partner : "partner name",
    declaredId : {
       dpuuid : <dpuuid>,
       dpid : <dpid>
    }
 });
Note: Note, you need to programmatically develop the code that supplies the ID values for the d_dpuuid and d_dpid keys.

Pass In IDs After DIL Instantiates

Note: If you make an API call with a different declaredID combination, the new combination will be used for that call only. Further regular event calls will use the original DIL.createdeclaredID combination.
DIL.getDil('partner name').api.signals({...}).declaredId({
  dpuuid : <dpuuid>
  dpid : <dpid>
}).submit();

Request/Response Examples

The request sends a data provider and user ID to Audience Manager:
http://my_domain.net/event?d_rtbd=json&d_cb=myCallback&key=val&d_dpuuid=1234&d_dpid=5678
The response returns the Audience Manager ID (e.g., uuid) which is written to a first-party cookie in the page domain.
myCallback({
...
   "uuid":"abc123"
})

Do Not Target and Opt-Out Calls

The declared ID process honors site visitor preferences to opt-out of Audience Manager targeting by your website. When Audience Manager receives an opt-out request, the DCS returns an empty JSON object instead of the Audience Manager user ID.