profile

Profile

You can use the Profile extension to store attributes about your user on the client. This information can be used later to target and personalize messages during online or offline scenarios, without having to connect to a server for optimal performance. The Profile extension manages the Client-Side Operation Profile (CSOP) and provides a way to react to APIs, updates user profile attributes, and shares the user profile attributes with the rest of the system as a generated event.

The Profile data is used by other extensions to perform profile-related actions. An example is the Rules Engine extension that consumes the profile data and runs rules based on the profile data.

Important: The Profile extension does not require any configuration.

To get started with the Profile extension:

1. Configure the Profile Extension in Launch.
2. Add the Profile extension to your app.
3. Implement Profile APIs to:
   • Update user attributes.
   • Remove user attributes.

Install the Profile extension in the Data Collection UI

1. In the Data Collection UI, in your mobile property, select the Extensions tab.
2. On the Catalog tab, locate or search for the Profile extension, and select Install.
3. There are no configuration settings for Profile.
4. Select Save.
5. Follow the publishing process to update SDK configuration.

Add the Profile extension to your app

To add the Profile extension to your app:

{% tabs %} {% tab title="Android" %}

Java

1. Add the UserProfile library to your project using the app's gradle file.

2. Import the UserProfile library and any other SDK library in your application's main activity.

   import com.adobe.marketing.mobile.*;

{% endtab %}

{% tab title="iOS (AEP 3.x)" %}

1. Add the Mobile Core and Profile extensions to your project using Cocoapods. Add following pods in your Podfile:

use_frameworks!
target 'YourTargetApp' do
    pod 'AEPCore', '~> 3.0'
    pod 'AEPUserProfile', '~> 3.0'
end

2. Import the UserProfile library.

Swift

   import AEPCore
   import AEPUserProfile

Objective-C

   @import AEPCore;
   @import AEPUserProfile;

{% endtab %}

{% tab title="iOS (ACP 2.x)" %}

Objective-C

1. Add the Mobile Core and Profile extensions to your project using Cocoapods. Add following pods in your Podfile:

use_frameworks!
target 'YourTargetApp' do
    pod 'ACPCore'
    pod 'ACPUserProfile'
end

2. Import the UserProfile library.

Swift

   import ACPCore
   import ACPUserProfile

Objective-C

   #import "ACPCore.h"
   #import "ACPUserProfile.h"

{% endtab %}

{% tab title="Cordova" %}

Cordova

After creating your Cordova app and adding the Android and iOS platforms, the UserProfile extension for Cordova can be added with this command:

cordova plugin add https://github.com/adobe/cordova-acpuserprofile.git

{% endtab %}

{% tab title="Unity" %}

C#

After importing the ACPUserProfile.unitypackage, the UserProfile extension for Unity can be added with following code in the MainScript

using com.adobe.marketing.mobile;

{% endtab %}

{% tab title="Xamarin" %}

C#

After adding the iOS ACPUserProfile NuGet package or the Android ACPUserProfile NuGet package, the UserProfile extension can be added by this import statement

using Com.Adobe.Marketing.Mobile;

{% endtab %}

{% endtabs %}

Register the extension

{% tabs %} {% tab title="Android" %}

Java

Required: The setApplication() method must be called once in the onCreate() method of your main activity.

1. The UserProfile extension must be registered with Mobile Core before calling an UserProfile API.

   This can be done after calling setApplication() in the onCreate() method. Here is a code sample, which calls these set up methods:

   public class MobileApp extends Application {

       @Override
       public void onCreate() {
           super.onCreate();
           MobileCore.setApplication(this);
           try {
               // register other extensions
               UserProfile.registerExtension();
               MobileCore.start(new AdobeCallback () {
                   @Override
                   public void call(Object o) {
                       MobileCore.configureWithAppID("yourAppId");
                   }
               });    
           } catch (Exception e) {
               //Log the exception
            }
       }
   }

{% endtab %}

{% tab title="iOS (AEP 3.x)" %}

Swift

// AppDelegate.swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    MobileCore.registerExtensions([UserProfile.self], {
  })
  ...
}

Objective-C

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [AEPMobileCore registerExtensions:@AEPMobileUserProfile.class] completion:^{
    ...
  }];
  ...
  // Override point for customization after application launch.
  return YES;
}

{% endtab %}

{% tab title="iOS (ACP 2.x)" %}

Swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
     ACPCore.configure(withAppId: "yourAppId")   
     ACPUserProfile.registerExtension() 
     ACPCore.start(nil)
     // Override point for customization after application launch. 
     return true;
}

Objective-C

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  [ACPUserProfile registerExtension];
  // Override point for customization after application launch.
  return YES;
}

{% endtab %}

{% tab title="React Native" %}

JavaScript

When using React Native, register Profile with Mobile Core in native code as shown on the Android and iOS tabs. {% endtab %}

{% tab title="Cordova" %}

Cordova

When using Cordova, register Profile with Mobile Core in native code as shown on the Android and iOS tabs. {% endtab %}

{% tab title="Flutter" %}

Flutter

When using Flutter, register Profile with Mobile Core in native code as shown on the Android and iOS tabs. {% endtab %}

{% tab title="Unity" %}

C#

Register the extension in the start() function:

using com.adobe.marketing.mobile;
using using AOT;

public class MainScript : MonoBehaviour
{
    [MonoPInvokeCallback(typeof(AdobeStartCallback))]
    public static void HandleStartAdobeCallback()
    {   
        ACPCore.ConfigureWithAppID("yourAppId"); 
    }

    // Start is called before the first frame update
    void Start()
    {   
        ACPUserProfile.registerExtension();
        ACPCore.Start(HandleStartAdobeCallback);
    }
}

{% endtab %}

{% tab title="Xamarin" %}

C#

iOS

Register the User Profile extension in your app's FinishedLaunching() function:

public override bool FinishedLaunching(UIApplication app, NSDictionary options)
{
  global::Xamarin.Forms.Forms.Init();
  LoadApplication(new App());
  ACPUserProfile.RegisterExtension();
  // start core
  ACPCore.Start(startCallback);
  return base.FinishedLaunching(app, options);
}

private void startCallback()
{
  // set launch config
  ACPCore.ConfigureWithAppID("yourAppId");
}

Android

Register the User Profile extension in your app's OnCreate() function:

protected override void OnCreate(Bundle savedInstanceState)
{
  base.OnCreate(savedInstanceState);
  global::Xamarin.Forms.Forms.Init(this, savedInstanceState);
  LoadApplication(new App());
  ACPUserProfile.RegisterExtension();

  // start core
  ACPCore.Start(new CoreStartCompletionCallback());
}

class CoreStartCompletionCallback : Java.Lang.Object, IAdobeCallback
{
  public void Call(Java.Lang.Object callback)
  {
    // set launch config
    ACPCore.ConfigureWithAppID("yourAppId");
  }
}

{% endtab %} {% endtabs %}