Declared IDs declared-ids

How declared IDs work, set up procedures, code examples, and variables.

Declared ID Targeting declared-id-targeting

Exchange and synchronize user IDs with Audience Manager from devices or browsers that do not use or accept persistent storage mechanisms, such as third-party cookies.

Purpose of Declared ID Targeting declared-id-targeting-purpose

Some browsers, and most mobile devices, do not accept third-party cookies. This makes it difficult to retain information about site visitors or assign persistent IDs. To resolve this issue, Audience Manager uses DIL to let you pass in declared IDs on an event call. Also, a declared ID can act as a universal ID that applies to the same user across all the solutions in the Experience Cloud. The following table describes the ID targeting/matching process:

To get started, you need to configure the Experience Cloud ID service and DIL across the pages on your site that you want to use for data collection. See DIL create and Declared ID Variables.

Opt-out Calls 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 JSON returned by the DCS contains the error code 171, with the message Encountered opt out tag, instead of the Audience Manager user ID.

See Data Privacy for more information about opting-out of data collection.

Declared ID Opt-Out Examples opt-out-examples

You can make a declared ID opt-out requests with the d_cid and d_cid_ic key-value pairs. The legacy parameters like d_dpid and d_dpuuid still work, but are considered deprecated. See CID Replaces DPID and DPUUID. In the examples, italics indicates a variable placeholder.

Opt-Outs With CID and CID_IC

For a description and syntax, see URL Variables and Syntax for Declared IDs.

Opt-Outs With DPID, DPUUID, and UUID (Deprecated)

These methods still work but are considered deprecated. This information is provided for legacy purposes and reference. Legacy opt-outs include:

Variables and Syntax for Declared IDs variables-and-syntax

The following table lists the key-value pairs that pass in your Audience Manager data provider ID and user IDs or integration codes, if used. Note, italics indicates a variable placeholder. Spaces have been added to make these easier to read.

In each key-value pair:

Sample Event Calls sample-event-calls

Given these key-value pairs and their required syntax, you would make event calls as shown below.

Declared ID Variables declared-id-variables

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

DIL uses the Adobe Experience Platform Identity Service to Pass Declared IDs dil-id-service-pass-declared-ids

When used with the Adobe Experience Platform Identity Service, you no longer need to pass in 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 Adobe Experience Platform Identity Service. For more information, see Customer IDs and Authentication States. You would call visitorService in DIL.create as 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 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 Adobe Experience Platform Identity 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:

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 declared IDs from the Adobe Experience Platform Identity Service.

DIL.create({
    partner : "partner name",
    declaredId : {
       dpuuid : dpuuid,
       DPID : dpid
    }
 });

Pass In IDs After DIL Instantiates

DIL.getDil('partner name').api.signals({...}).declaredId({
  dpuuid : dpuuid
  dpid : dpid
}).submit();

Request/Response Examples request-response-examples

The request sends a data provider and user ID to Audience Manager:

https://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 do-not-target

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.