Audience Manager API reference

Version of the Audience extension
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
iOS
React Native
Flutter
Cordova
Unity
Xamarin
Android
Java
String audienceExtensionVersion = Audience.extensionVersion();
iOS
Objective C
NSString *audienceExtensionVersion = [ACPAudience extensionVersion];
Swift
let audienceExtensionVersion  = ACPAudience.extensionVersion()
React Native
JavaScript
ACPAudience.extensionVersion().then(audienceExtensionVersion => console.log("AdobeExperienceSDK: ACPAudience version: " + audienceExtensionVersion));
Flutter
Dart
String audienceExtensionVersion = await FlutterACPAudience.extensionVersion;
Cordova
Cordova
ACPAudience.extensionVersion(function(version) {  
   console.log("ACPAudience version: " + version);
}, function(error) {  
   console.log(error);  
});
Unity
C#
string audienceExtensionVersion = ACPAudience.ExtensionVersion();
Xamarin
C#
string audienceExtensionVersion = ACPAudience.ExtensionVersion();
getVisitorProfile
Returns the visitor profile that was most recently updated. 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
iOS
React Native
Android
getVisitorProfile
This API returns the visitor profile that was most recently obtained. 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.
Syntax
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);
iOS
getVisitorProfile
Method getVisitorProfileWithCompletionHandler was added in ACPAudience version 2.1.0.
This API returns the visitor profile that was most recently obtained. For easy access across multiple launches of your app, the visitor profile is saved in NSUserDefaults. If no signal has been submitted, nil is returned.
Syntax
+ (void) getVisitorProfile: (nonnull void (^) (NSDictionary* __nullable visitorProfile)) callback;
​
+ (void) getVisitorProfileWithCompletionHandler: (nonnull void (^) (NSDictionary* __nullable visitorProfile, NSError* __nullable error)) completionHandler;
Example
Objective C
[ACPAudience getVisitorProfile:^(NSDictionary* visitorProfile){
  // handle the visitorProfile here
}];
​
[ACPAudience getVisitorProfileWithCompletionHandler:^(NSDictionary * _Nullable visitorProfile, NSError * _Nullable error) {
  if (error) {
    // handle error here
  } else {
    // handle the returned visitorProfile here
  }
}];
Swift
ACPAudience.getVisitorProfile { (visitorProfile) in
  // handle the visitorProfile here
}
​
ACPAudience.getVisitorProfile { (visitorProfile, error) in
  if let error = error {
    // handle error here
  } else {
    // handle the returned visitorProfile here
  }
}
React Native
JavaScript
getVisitorProfile
ACPAudience.getVisitorProfile().then(profile => console.log("AdobeExperienceSDK: Visitor Profile: " + profile));
registerExtension
This API registers an extension class that was derived from ACPExtension with a unique name. This call validates the parameters to ensure that the name is not empty, the name is unique, and that the parent class is ACPExtension.
Android
iOS
React Native
Android
registerExtension
Syntax
public  static void registerExtension() throws InvalidInitException
Example
Audience.registerExtension();
iOS
registerExtension
Syntax
+ (BOOL) registerExtension: (nonnull Class) extensionClass
                     error: (NSError* _Nullable* _Nullable) error;
Examples
Objective-C
[ACPAudience registerExtension];
Swift
ACPAudience.registerExtension()
React Native
JavaScript
registerExtension
ACPAudience.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
iOS
React Native
Android
reset
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.
Syntax
public static void reset()
Example
Audience.reset();
iOS
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.
Syntax
+ (void) reset;
Examples
Objective C
[ACPAudience reset];
Swift
ACPAudience.reset()
React Native
JavaScript
reset
ACPAudience.reset();
signalWithData
Use this method 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 Index of IDs in Audience Manager.
Android
iOS
React Native
Android
signalWithData
This 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.
Syntax
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);
iOS
signalWithData
Method signalWithData:withCompletionHandler was added in ACPAudience version 2.1.0.
This 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 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.
Syntax
+ (void) signalWithData: (NSDictionary<NSString*, NSString*>* __nullable) data
                       callback: (nullable void (^) (NSDictionary* __nullable visitorProfile)) callback;
​
+ (void) signalWithData: (NSDictionary<NSString*, NSString*>* __nullable) data
                        withCompletionHandler:: (nullable void (^) (NSDictionary* __nullable visitorProfile, NSError* __nullable error)) completionHandler;
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.
Examples**
Objective-C
NSDictionary *traits = @{@"key1":@"value1",@"key2":@"value2"};
[ACPAudience signalWithData:traits callback:^(NSDictionary* visitorProfile){
  // handle the visitorProfile here
}];
​
[ACPAudience signalWithData:(NSDictionary<NSString *,NSString *> * _Nonnull)
          withCompletionHandler:^(NSDictionary * _Nullable visitorProfile, NSError * _Nullable error) {
  if (error) {
    // handle error here
  } else {
    // handle the returned visitorProfile here
  }
}];
Swift
ACPAudience.signal(withData: ["key1": "value1", "key2": "value2"], callback: { (visitorProfile) in
  // handle the visitorProfile here  
})
​
ACPAudience.signal(withData: ["key1": "value1", "key2": "value2"], withCompletionHandler: { (visitorProfile, error) in
  if let error = error {
    // handle error
  } else {
    // handle the returned visitorProfile here
  }    
})
React Native
JavaScript
signalWithData
ACPAudience.signalWithData({"yourDataKey": "yourDataValue"}).then(profile => console.log("AdobeExperienceSDK: Visitor Profile: " + profile));
Release Notes
Audience Manager event reference
Last updated 2 months ago