Adobe Audience Manager API reference

extensionVersion

The extensionVersion() API returns the version of the Audience extension that is registered with the Mobile Core extension.

To get the version of the Audience extension, use the following code sample:

Android

Java

Syntax

public static String extensionVersion()
Copied to your clipboard
public static String extensionVersion()

Example

String audienceExtensionVersion = Audience.extensionVersion();
Copied to your clipboard
String audienceExtensionVersion = Audience.extensionVersion();

Kotlin

Example

val extensionVersion = Audience.extensionVersion();
Copied to your clipboard
val extensionVersion = Audience.extensionVersion();

iOS

Swift

Syntax

static var extensionVersion: String
Copied to your clipboard
static var extensionVersion: String

Example

let audienceExtensionVersion  = Audience.extensionVersion()
Copied to your clipboard
let audienceExtensionVersion  = Audience.extensionVersion()

Objective-C

Syntax

+ (nonnull NSString*) extensionVersion;
Copied to your clipboard
+ (nonnull NSString*) extensionVersion;

Example

NSString *audienceExtensionVersion = [AEPMobileAudience extensionVersion];
Copied to your clipboard
NSString *audienceExtensionVersion = [AEPMobileAudience extensionVersion];

Java

Syntax

public static String extensionVersion()
Copied to your clipboard
public static String extensionVersion()

Example

String audienceExtensionVersion = Audience.extensionVersion();
Copied to your clipboard
String audienceExtensionVersion = Audience.extensionVersion();

Kotlin

Example

val extensionVersion = Audience.extensionVersion();
Copied to your clipboard
val extensionVersion = Audience.extensionVersion();

Swift

Syntax

static var extensionVersion: String
Copied to your clipboard
static var extensionVersion: String

Example

let audienceExtensionVersion  = Audience.extensionVersion()
Copied to your clipboard
let audienceExtensionVersion  = Audience.extensionVersion()

Objective-C

Syntax

+ (nonnull NSString*) extensionVersion;
Copied to your clipboard
+ (nonnull NSString*) extensionVersion;

Example

NSString *audienceExtensionVersion = [AEPMobileAudience extensionVersion];
Copied to your clipboard
NSString *audienceExtensionVersion = [AEPMobileAudience extensionVersion];

getVisitorProfile

This API returns the most recently obtained visitor profile. The visitor profile is saved in the SDK's local storage for access across multiple launches of your app. If no audience signal has been sent before, when this API is called, a null value is returned.

Android

This API returns the most recently obtained visitor profile. For easy access across multiple launches of your app, the visitor profile is saved in SharedPreferences. If no signal has been submitted, null is returned.

When an AdobeCallbackWithError is provided, an AdobeError can be returned in the eventuality of an unexpected error or if the default timeout (5000ms) is met before the callback is returned with the visitor profile.

Java

Syntax

public static void getVisitorProfile(final AdobeCallback<Map<String, String>> adobeCallback)
Copied to your clipboard
public static void getVisitorProfile(final AdobeCallback<Map<String, String>> adobeCallback)

Example

AdobeCallback<Map<String, String>> visitorProfileCallback = new AdobeCallback<Map<String, String>>() {
    @Override
    public void call(final Map<String, String> visitorProfile) {
        // your own customized code
    }
};

Audience.getVisitorProfile(visitorProfileCallback);
Copied to your clipboard
AdobeCallback<Map<String, String>> visitorProfileCallback = new AdobeCallback<Map<String, String>>() {
    @Override
    public void call(final Map<String, String> visitorProfile) {
        // your own customized code
    }
};

Audience.getVisitorProfile(visitorProfileCallback);

Kotlin

Example

Audience.getVisitorProfile { visitorProfile ->
    // provide code to process the visitorProfile
}
Copied to your clipboard
Audience.getVisitorProfile { visitorProfile ->
    // provide code to process the visitorProfile
}

iOS

This API returns the most recently obtained visitor profile.

Swift

Syntax

static func getVisitorProfile(completion: @escaping ([String: String]?, Error?) -> Void)
Copied to your clipboard
static func getVisitorProfile(completion: @escaping ([String: String]?, Error?) -> Void)

Example

Audience.getVisitorProfile { (visitorProfile, error) in
   if error != nil {
    // handle the error here
   } else {
    // handle the retrieved visitorProfile here
   }
  }
Copied to your clipboard
Audience.getVisitorProfile { (visitorProfile, error) in
   if error != nil {
    // handle the error here
   } else {
    // handle the retrieved visitorProfile here
   }
  }

Objective-C

Syntax

+  (void) getVisitorProfile:^(NSDictionary<NSString *,NSString *> * _Nullable, NSError * _Nullable)completion
Copied to your clipboard
+  (void) getVisitorProfile:^(NSDictionary<NSString *,NSString *> * _Nullable, NSError * _Nullable)completion

Example

[AEPMobileAudience getVisitorProfile:^(NSDictionary<NSString *,NSString *> * _Nullable visitorProfile, NSError * _Nullable error) {
   if (error) {
    // handle the error here
   } else {
    // handle the returned visitorProfile dictionary here
   }
}];
Copied to your clipboard
[AEPMobileAudience getVisitorProfile:^(NSDictionary<NSString *,NSString *> * _Nullable visitorProfile, NSError * _Nullable error) {
   if (error) {
    // handle the error here
   } else {
    // handle the returned visitorProfile dictionary here
   }
}];

Java

Syntax

public static void getVisitorProfile(final AdobeCallback<Map<String, String>> adobeCallback)
Copied to your clipboard
public static void getVisitorProfile(final AdobeCallback<Map<String, String>> adobeCallback)

Example

AdobeCallback<Map<String, String>> visitorProfileCallback = new AdobeCallback<Map<String, String>>() {
    @Override
    public void call(final Map<String, String> visitorProfile) {
        // your own customized code
    }
};

Audience.getVisitorProfile(visitorProfileCallback);
Copied to your clipboard
AdobeCallback<Map<String, String>> visitorProfileCallback = new AdobeCallback<Map<String, String>>() {
    @Override
    public void call(final Map<String, String> visitorProfile) {
        // your own customized code
    }
};

Audience.getVisitorProfile(visitorProfileCallback);

Kotlin

Example

Audience.getVisitorProfile { visitorProfile ->
    // provide code to process the visitorProfile
}
Copied to your clipboard
Audience.getVisitorProfile { visitorProfile ->
    // provide code to process the visitorProfile
}

This API returns the most recently obtained visitor profile.

Swift

Syntax

static func getVisitorProfile(completion: @escaping ([String: String]?, Error?) -> Void)
Copied to your clipboard
static func getVisitorProfile(completion: @escaping ([String: String]?, Error?) -> Void)

Example

Audience.getVisitorProfile { (visitorProfile, error) in
   if error != nil {
    // handle the error here
   } else {
    // handle the retrieved visitorProfile here
   }
  }
Copied to your clipboard
Audience.getVisitorProfile { (visitorProfile, error) in
   if error != nil {
    // handle the error here
   } else {
    // handle the retrieved visitorProfile here
   }
  }

Objective-C

Syntax

+  (void) getVisitorProfile:^(NSDictionary<NSString *,NSString *> * _Nullable, NSError * _Nullable)completion
Copied to your clipboard
+  (void) getVisitorProfile:^(NSDictionary<NSString *,NSString *> * _Nullable, NSError * _Nullable)completion

Example

[AEPMobileAudience getVisitorProfile:^(NSDictionary<NSString *,NSString *> * _Nullable visitorProfile, NSError * _Nullable error) {
   if (error) {
    // handle the error here
   } else {
    // handle the returned visitorProfile dictionary here
   }
}];
Copied to your clipboard
[AEPMobileAudience getVisitorProfile:^(NSDictionary<NSString *,NSString *> * _Nullable visitorProfile, NSError * _Nullable error) {
   if (error) {
    // handle the error here
   } else {
    // handle the returned visitorProfile dictionary here
   }
}];

registerExtension

This API has been deprecated starting in v2.0.0 and removed in v3.0.0 of the Android mobile extension.

Use MobileCore.registerExtensions() API instead.

Registers the Audience Manager extension with the Mobile Core SDK.

Android

Java

Syntax

public  static void registerExtension()
Copied to your clipboard
public  static void registerExtension()

Example

Audience.registerExtension();
Copied to your clipboard
Audience.registerExtension();

Kotlin

Example

Audience.registerExtension()
Copied to your clipboard
Audience.registerExtension()

Java

Syntax

public  static void registerExtension()
Copied to your clipboard
public  static void registerExtension()

Example

Audience.registerExtension();
Copied to your clipboard
Audience.registerExtension();

Kotlin

Example

Audience.registerExtension()
Copied to your clipboard
Audience.registerExtension()

reset

This API helps you reset the Audience Manager UUID and purges the current visitor profile.

For more information about the UUID, the DPID, the DPUUID and other Audience Manager identifiers, see Index of IDs in Audience Manager.

Android

This API resets the Audience Manager UUID and purges the current visitor profile from android.content.SharedPreferences. The Audience reset also clears the current in-memory DPID and DPUUID variables.

Java

Syntax

public static void reset()
Copied to your clipboard
public static void reset()

Example

Audience.reset();
Copied to your clipboard
Audience.reset();

Kotlin

Example

Audience.reset()
Copied to your clipboard
Audience.reset()

iOS

This API resets the Audience Manager UUID and purges the current visitor profile from UserDefaults. The Audience reset also clears the current in-memory DPID and DPUUID variables.

Swift

Syntax

static func reset()
Copied to your clipboard
static func reset()

Example

Audience.reset()
Copied to your clipboard
Audience.reset()

Objective-C

Syntax

+ (void) reset
Copied to your clipboard
+ (void) reset

Example

[AEPMobileAudience reset];
Copied to your clipboard
[AEPMobileAudience reset];

Java

Syntax

public static void reset()
Copied to your clipboard
public static void reset()

Example

Audience.reset();
Copied to your clipboard
Audience.reset();

Kotlin

Example

Audience.reset()
Copied to your clipboard
Audience.reset()

This API resets the Audience Manager UUID and purges the current visitor profile from UserDefaults. The Audience reset also clears the current in-memory DPID and DPUUID variables.

Swift

Syntax

static func reset()
Copied to your clipboard
static func reset()

Example

Audience.reset()
Copied to your clipboard
Audience.reset()

Objective-C

Syntax

+ (void) reset
Copied to your clipboard
+ (void) reset

Example

[AEPMobileAudience reset];
Copied to your clipboard
[AEPMobileAudience reset];

signalWithData

This method is used to send a signal with traits to Audience Manager and get the matching segments returned in a block callback. Audience Manager sends the UUID in response to an initial signal call. The UUID is persisted on local SDK storage and is sent by the SDK to Audience Manager in all subsequent signal requests.

If you are using the Experience Cloud ID (ECID) Service (formerly MCID), the ECID and other custom identifiers for the same visitor are sent with each signal request. The visitor profile that is returned by Audience Manager is saved in SDK local storage and is updated with subsequent signal calls.

For more information about the UUID and other Audience Manager identifiers, see the index of IDs in Audience Manager.

Android

The signalWithData API sends Audience Manager a signal with traits and returns the matching segments for the visitor in a callback.

Audience Manager sends the AAM UUID in response in initial signal call. The AAM UUID is persisted in SharedPreferences and is sent by the SDK in all subsequent signal requests. If available, the ECID is also sent in each signal request with the DPID and the DPUUID. The visitor profile that Audience Manager returns is saved in SharedPreferences and is updated with every signal call.

When an AdobeCallbackWithError is provided, an AdobeError can be returned in the eventuality of an unexpected error or if the default timeout (5000ms) is met before the callback is returned with the visitor profile.

Java

Syntax

public static void signalWithData(final Map<String, String> data, final AdobeCallback<Map<String, String>> callback)
Copied to your clipboard
public static void signalWithData(final Map<String, String> data, final AdobeCallback<Map<String, String>> callback)

data is the traits data for the current visitor.
callback is the void method that is invoked with the visitor's profile as a parameter.

Example

AdobeCallback<Map<String, String>> visitorProfileCallback = new AdobeCallback<Map<String, String>>() {
    @Override
    public void call(final Map<String, String> visitorProfile) {
        // handle the returned visitorProfile here
    }
};

Map<String, String> traits = new HashMap<String, String>();
traits.put("trait", "xyz");
Audience.signalWithData(traits, visitorProfileCallback);
Copied to your clipboard
AdobeCallback<Map<String, String>> visitorProfileCallback = new AdobeCallback<Map<String, String>>() {
    @Override
    public void call(final Map<String, String> visitorProfile) {
        // handle the returned visitorProfile here
    }
};
Map<String, String> traits = new HashMap<String, String>();
traits.put("trait", "xyz");
Audience.signalWithData(traits, visitorProfileCallback);

Kotlin

Example

val traits: Map<String, String?> = mapOf(
    "trait1" to "value1",
    "trait2" to "value2"
)

Audience.signalWithData(traits) { visitorProfile ->
    // handle the returned visitorProfile
}
Copied to your clipboard
val traits: Map<String, String?> = mapOf(
    "trait1" to "value1",
    "trait2" to "value2"
)

Audience.signalWithData(traits) { visitorProfile ->
    // handle the returned visitorProfile
}

iOS

The signalWithData API sends Audience Manager a signal with traits and returns the matching segments for the visitor in a closure.

Audience Manager sends the AAM UUID in response in initial signal call. The AAM UUID is persisted in NSUserDefaults and is sent by the SDK in all subsequent signal requests. If available, the Experience Cloud ID (MID) is also sent in each signal request with the DPID and the DPUUID. The visitor profile that Audience Manager returns is saved in NSUserDefaults and is updated with every signal call.

Swift

Syntax

static func signalWithData(data: [String: String], completion: @escaping ([String: String]?, Error?) -> Void)
Copied to your clipboard
static func signalWithData(data: [String: String], completion: @escaping ([String: String]?, Error?) -> Void)

data is the traits data for the current visitor.
callback is the void method that is invoked with the visitor's profile as a parameter.

Example

Audience.signalWithData(data: ["trait": "trait value"]) { (traits, error) in
  if error != nil {
     // handle the error here
     } else {
     // handle the returned visitorProfile here
     }
}
Copied to your clipboard
Audience.signalWithData(data: ["trait": "trait value"]) { (traits, error) in
  if error != nil {
     // handle the error here
     } else {
     // handle the returned visitorProfile here
     }
}

Objective-C

Syntax

+ (void) signalWithData:(NSDictionary<NSString *,NSString *> * _Nonnull) completion:^(NSDictionary<NSString *,NSString *> * _Nullable, NSError * _Nullable)completion
Copied to your clipboard
+ (void) signalWithData:(NSDictionary<NSString *,NSString *> * _Nonnull) completion:^(NSDictionary<NSString *,NSString *> * _Nullable, NSError * _Nullable)completion

Example

NSDictionary *traits = @{@"key1":@"value1",@"key2":@"value2"};
[AEPMobileAudience signalWithData:traits completion:^(NSDictionary<NSString *,NSString *> * _Nullable visitorProfile, NSError* _Nullable error) {
  if (error) {
     // handle the error here
     } else {
     // handle the returned visitorProfile dictionary here
     }
}];
Copied to your clipboard
NSDictionary *traits = @{@"key1":@"value1",@"key2":@"value2"};
[AEPMobileAudience signalWithData:traits completion:^(NSDictionary<NSString *,NSString *> * _Nullable visitorProfile, NSError* _Nullable error) {
  if (error) {
     // handle the error here
     } else {
     // handle the returned visitorProfile dictionary here
     }
}];

The signalWithData API sends Audience Manager a signal with traits and returns the matching segments for the visitor in a callback.

Java

Syntax

public static void signalWithData(final Map<String, String> data, final AdobeCallback<Map<String, String>> callback)
Copied to your clipboard
public static void signalWithData(final Map<String, String> data, final AdobeCallback<Map<String, String>> callback)

data is the traits data for the current visitor.
callback is the void method that is invoked with the visitor's profile as a parameter.

Example

AdobeCallback<Map<String, String>> visitorProfileCallback = new AdobeCallback<Map<String, String>>() {
    @Override
    public void call(final Map<String, String> visitorProfile) {
        // handle the returned visitorProfile here
    }
};

Map<String, String> traits = new HashMap<String, String>();
traits.put("trait", "xyz");
Audience.signalWithData(traits, visitorProfileCallback);
Copied to your clipboard
AdobeCallback<Map<String, String>> visitorProfileCallback = new AdobeCallback<Map<String, String>>() {
    @Override
    public void call(final Map<String, String> visitorProfile) {
        // handle the returned visitorProfile here
    }
};
Map<String, String> traits = new HashMap<String, String>();
traits.put("trait", "xyz");
Audience.signalWithData(traits, visitorProfileCallback);

Kotlin

Example

val traits: Map<String, String?> = mapOf(
    "trait1" to "value1",
    "trait2" to "value2"
)

Audience.signalWithData(traits) { visitorProfile ->
    // handle the returned visitorProfile
}
Copied to your clipboard
val traits: Map<String, String?> = mapOf(
    "trait1" to "value1",
    "trait2" to "value2"
)

Audience.signalWithData(traits) { visitorProfile ->
    // handle the returned visitorProfile
}

The signalWithData API sends Audience Manager a signal with traits and returns the matching segments for the visitor in a closure.

Swift

Syntax

static func signalWithData(data: [String: String], completion: @escaping ([String: String]?, Error?) -> Void)
Copied to your clipboard
static func signalWithData(data: [String: String], completion: @escaping ([String: String]?, Error?) -> Void)

data is the traits data for the current visitor.
callback is the void method that is invoked with the visitor's profile as a parameter.

Example

Audience.signalWithData(data: ["trait": "trait value"]) { (traits, error) in
  if error != nil {
     // handle the error here
     } else {
     // handle the returned visitorProfile here
     }
}
Copied to your clipboard
Audience.signalWithData(data: ["trait": "trait value"]) { (traits, error) in
  if error != nil {
     // handle the error here
     } else {
     // handle the returned visitorProfile here
     }
}

Objective-C

Syntax

+ (void) signalWithData:(NSDictionary<NSString *,NSString *> * _Nonnull) completion:^(NSDictionary<NSString *,NSString *> * _Nullable, NSError * _Nullable)completion
Copied to your clipboard
+ (void) signalWithData:(NSDictionary<NSString *,NSString *> * _Nonnull) completion:^(NSDictionary<NSString *,NSString *> * _Nullable, NSError * _Nullable)completion

Example

NSDictionary *traits = @{@"key1":@"value1",@"key2":@"value2"};
[AEPMobileAudience signalWithData:traits completion:^(NSDictionary<NSString *,NSString *> * _Nullable visitorProfile, NSError* _Nullable error) {
  if (error) {
     // handle the error here
     } else {
     // handle the returned visitorProfile dictionary here
     }
}];
Copied to your clipboard
NSDictionary *traits = @{@"key1":@"value1",@"key2":@"value2"};
[AEPMobileAudience signalWithData:traits completion:^(NSDictionary<NSString *,NSString *> * _Nullable visitorProfile, NSError* _Nullable error) {
  if (error) {
     // handle the error here
     } else {
     // handle the returned visitorProfile dictionary here
     }
}];

Overview

Event reference

Last updated 4/5/2024

Was this helpful?

Yes

Adobe Audience Manager API reference

extensionVersion.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Java.css-jmmyhj{margin-left:var(--spectrum-global-dimension-size-50);}

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

getVisitorProfile

Java

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

registerExtension

Java

Kotlin

Java

Kotlin

reset

Java

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

signalWithData

Java

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

extensionVersion

Java