The ID service functions idSyncByURL and idSyncByDataSource let you manually implement an ID sync in the Destination Publishing iFrame. These are available in VisitorAPI.js versions 1.10, or higher.
Syntax
Code | Synchronizes User IDs |
---|---|
visitor.idSyncByURL(); |
Between different data partners and Audience Manager by using a custom ID sync URL. |
visitor.idSyncByDataSource(); |
When you already know the DPID and DPUUID and want to send it to Audience Manager in the standard ID sync URL format. |
Properties
The following table lists and defines the properties available to both functions.
Name | Type | Description |
---|---|---|
dpid | String | Data provider ID assigned by Audience Manager. |
dpuuid | String | The data provider's unique ID for the user. |
minutesToLive | Number | (Optional) Sets the cookie expiration time. Must be an integer. Default is 20160 minutes (14 days). |
url | String | Destination URL. |
Macros
Both functions accept the following macros:
%TIMESTAMP%
: Generates a timestamp (in milliseconds). Used for cache busting.%DID%
: Inserts the Audience Manager ID for the user.%HTTP_PROTO%
: Sets the communication protocol (http
or https
).Both functions return Successfully queued
if successful. They return an error message string if not.
Sample Code
//Instatiate Visitor
var visitor = Visitor.getInstance
("MARKETING-CLOUD-ORG-ID-HERE",{});
// Fires url with macros replaced
visitor.idSyncByURL({
dpid: '24', // must be a string
url: '//su.addthis.com/red/usync?pid=16&puid=%DID%&url=%HTTP_PROTO%://
dpm.demdex.net/ibs:dpid=420&dpuuid={{uid}}',
minutesToLive: 20160 // optional, defaults to 20160 minutes (14 days) });
Sample Output
http://su.addthis.com/red/usync?pid=16&puid=28777806459181003670799219185178493848&url=http%3A%2F%2Fdpm.demdex.net%2Fibs%3Adpid%3D420%26dpuuid%3D%7B%7Buid%7D%7D
Sample Code
//Instantiate Visitor
var visitor = Visitor.getInstance
("MARKETING-CLOUD-ORG-ID-HERE",{});
// Fires 'http:/https:' + '//dpm.demdex.net/ibs:dpid=&dpuuid='
visitor.idSyncByDataSource({
dpid: '24', // must be a string
dp minutesToLive: 20160 // optional, defaults to 20160 minutes (14 days) });
Sample Output
http://dpm.demdex.net/ibs:dpid=24&dpuuid=98765