Configure external device ID

An external device identifier is a custom value that you can assign to a device or user. This helps you recognize users across sessions and platforms. External device IDs also help you deduplicate installs by user, to avoid counting multiple new installs assoiciated with the same user.

Using external device IDs can produce different results depending on your setup. If you want to use them, contact your Adjust representative. They will talk you through the best approach for your use case.

You must set your external device ID in your AdjustAdobeExtensionConfig instance before you call setConfiguration. You can't change this property after you've initialized the extension.

Reference

To set an external device ID, call the setExternalDeviceId method of your AdjustAdobeExtensionConfig instance with the following argument:

externalDeviceId: NSString: Your external device identifier.

Tutorial: Set an external device ID

To set an external device ID, you need to set the ID using your AdjustAdobeExtensionConfig instance. If you followed the integration guide, your App Delegate should look something like this:

Swift
Objective-C

1
import UIKit
2
import AEPCore
3
import AEPServices
4
import AdjustAdobeExtension
5

6
@main
7
class AppDelegate: UIResponder, UIApplicationDelegate {
8

9
   func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
10
      MobileCore.setLogLevel(LogLevel.trace)
11
      let appState = application.applicationState
12

13
      if let config = AdjustAdobeExtensionConfig(environment: ADJEnvironmentSandbox) {
14
         AdjustAdobeExtension.setConfiguration(config)
15
      }
16

17
      MobileCore.registerExtensions([AdjustAdobeExtension.self]) {
18
         MobileCore.configureWith(appId: "{your_adobe_app_id}")
19
         if appState != .background {
20
               MobileCore.lifecycleStart(additionalContextData: nil)
21
         }
22
      }
23
      return true
24
   }
25

26
    func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
27
        if let deeplink = ADJDeeplink(deeplink: url) {
28
            Adjust.processDeeplink(deeplink)
29
        }
30
        return true
31
    }
32

33
    func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
34
        if userActivity.activityType == NSUserActivityTypeBrowsingWeb {
35
            if let incomingUrl = userActivity.webpageUrl {
36
                if let deeplink = ADJDeeplink(deeplink: incomingUrl) {
37
                    Adjust.processDeeplink(deeplink)
38
                }
39
            }
40
        }
41
        return true
42
    }
43
}

1
#import "AppDelegate.h"
2
@import AEPCore;
3
@import AEPServices;
4
#import <AdjustAdobeExtension/AdjustAdobeExtension.h>
5

6
@implementation AppDelegate
7

8
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
9
    [AEPMobileCore setLogLevel: AEPLogLevelTrace];
10
    const UIApplicationState appState = application.applicationState;
11

12
    AdjustAdobeExtensionConfig *config = [AdjustAdobeExtensionConfig configWithEnvironment:ADJEnvironmentSandbox];
13
    [AdjustAdobeExtension setConfiguration:config];
14

15
    [AEPMobileCore registerExtensions:@[AdjustAdobeExtension.class]
16
                           completion:^{
17
        [AEPMobileCore configureWithAppId: @"{your_adobe_app_id}"];
18

19
        if (appState != UIApplicationStateBackground) {
20
            [AEPMobileCore lifecycleStart:nil];
21
        }
22
    }];
23

24
    return YES;
25
}
26

27
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
28
   [Adjust processDeeplink: [[ADJDeeplink alloc] initWithDeeplink:url]];
29
   return YES;
30
}
31

32
- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray<id<UIUserActivityRestoring>> * _Nullable))restorationHandler {
33
   if ([[userActivity activityType] isEqualToString:NSUserActivityTypeBrowsingWeb]) {
34
     [Adjust proceessDeeplink:[[ADJDeeplink alloc] initWithDeeplink:[userActivity webpageURL]]];
35
   }
36
   return YES;
37
}
38
@end

To set a default link token for preinstalled apps, pass the link token to the setExternalDeviceId method of the AdjustAdobeExtensionConfig instance. The ID is sent to Adjust with each session.

In this example, the external device ID is set to 1a42b171-faa5-46da-b5ae-6f4be6d05167.

Swift
Objective-C

13
if let config = AdjustAdobeExtensionConfig(environment: ADJEnvironmentSandbox) {
14
   config.setExternalDeviceId("1a42b171-faa5-46da-b5ae-6f4be6d05167")
15
   AdjustAdobeExtension.setConfiguration(config)
16
}

12
AdjustAdobeExtensionConfig *config = [AdjustAdobeExtensionConfig configWithEnvironment:ADJEnvironmentSandbox];
13
[config setExternalDeviceId:@"1a42b171-faa5-46da-b5ae-6f4be6d05167"];
14
[AdjustAdobeExtension setConfiguration:config];