Adobe Experience Platform - Analytics plugin for Unity apps

End of support

Effective March 30, 2022, support for Adobe Experience Platform Mobile SDKs on Unity is no longer active. While you may continue using our libraries, Adobe no longer plans to update, modify, or provide support for these libraries. Please contact your Adobe CSM for detail.

• Prerequisites
• Installation
• Usage
  • Initialization
  • Analytics methods
• Running Tests
• Sample App
• Contributing
• Licensing

Prerequisites

The Unity Hub application is required for development and testing. Inside of Unity Hub, you will be required to download the Unity app. The ACPAnalytics Unity package is built using Unity version 2019.4.

Download the Unity Hub. The free version works for development and testing, but a Unity Pro license is required for distribution. See Distribution below for details.

FOLDER STRUCTURE

Plugins for a Unity project use the following folder structure:

{Project}/Assets/Plugins/{Platform}

Installation

Installing the ACPCore Unity Package

• Download ACPCore-1.0.1-Unity.zip
• Unzip ACPCore-1.0.1-Unity.zip
• Import ACPCore.unitypackage via Assets->Import Package

Installing the ACPAnalytics Unity Package

• Download ACPAnalytics-1.0.0-Unity.zip
• UnzipACPAnalytics-1.0.0-Unity.zip
• Import ACPAnalytics.unitypackage via Assets->Import Package

Android installation

No additional steps are required for Android installation.

iOS installation

ACPCore 1.0.0 and above is shipped with XCFrameworks. Follow these steps to add them to the Xcode project generated when building and running for iOS platform in Unity.

1. Go to File -> Project Settings -> Build System and select New Build System.
2. Download ACPCore.xcframework, ACPIdentity.xcframework, ACPLifecycle.xcframework and ACPSignal.xcframework.
3. Download ACPAnalytics.xcframework.
4. Select the UnityFramework target -> Go to Build Phases tab -> Add the XCFrameworks downloaded in Steps 2 and 3 to Link Binary with Libraries.
5. Select the Unity-iPhone target -> Go to Build Phases tab -> Add the XCFrameworks downloaded in Steps 2 and 3 to Link Binary with Libraries and Embed Frameworks. Alternatively, select Unity-iPhone target -> Go to General tab -> Add the XCFrameworks downloaded in Steps 2 and 3 to Frameworks, Libraries, and Embedded Content -> Select Embed and sign option.

Usage

Analytics

Initialization

Initialize by registering the extensions and calling the start function for core

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

[MonoPInvokeCallback(typeof(AdobeStartCallback))]
public static void HandleStartAdobeCallback()
{
    ACPCore.ConfigureWithAppID("1423ae38-8385-8963-8693-28375403491d");    
}

public class MainScript : MonoBehaviour
{
    // Start is called before the first frame update
    void Start()
    {   
        if (Application.platform == RuntimePlatform.Android) {
            ACPCore.SetApplication();
        }
        
        ACPCore.SetLogLevel(ACPCore.ACPMobileLogLevel.VERBOSE);
        ACPCore.SetWrapperType();
        ACPIdentity.RegisterExtension();
        ACPAnalytics.RegisterExtension();
        ACPCore.Start(HandleStartAdobeCallback);
    }
}

Analytics methods

Getting Analytics version:

ACPAnalytics.ExtensionVersion();

Send queued hits:

ACPAnalytics.SendQueuedHits();

Clear queued hits:

ACPAnalytics.ClearQueue();

Get the queue size:

[MonoPInvokeCallback(typeof(AdobeGetQueueSizeCallback))]
public static void HandleAdobeGetQueueSizeCallback(long queueSize)
{
    Debug.Log("Queue size is : " + queueSize);
}
ACPAnalytics.GetQueueSize(HandleAdobeGetQueueSizeCallback);

Get the tracking identifier

[MonoPInvokeCallback(typeof(AdobeGetTrackingIdentifierCallback))]
public static void HandleAdobeGetTrackingIdentifierCallback(string trackingIdentifier)
{
    Debug.Log("Tracking identifier is : " + trackingIdentifier);
}
ACPAnalytics.GetTrackingIdentifier(HandleAdobeGetTrackingIdentifierCallback);

Set the custom visitor identifier

ACPAnalytics.SetVisitorIdentifier("VisitorIdentifier");

Get the custom visitor identifier

[MonoPInvokeCallback(typeof(AdobeGetVisitorIdentifierCallback))]
public static void HandleAdobeGetVisitorIdentifierCallback(string visitorIdentifier)
{
    Debug.Log("Visitor identifier is : " + visitorIdentifier);
}
ACPAnalytics.GetVisitorIdentifier(HandleAdobeGetVisitorIdentifierCallback);

Running Tests

1. Open the demo app in unity.
2. Open the test runner from Window -> General -> TestRunner.
3. Click on the PlayMode tab.
4. Connect an Android or iOS device as we run the tests on a device in play mode.
5. Select the platform for which the tests need to be run from File -> Build Settings -> Platform.
6. Click Run all in player (platform) to run the tests.

Sample App

Sample App is located at unity-acpanalytics/ACPAnalytics/Assets/Demo. To build demo app for specific platform follow the below instructions.

Add core plugin

• Download ACPCore-1.0.0-Unity.zip
• Unzip ACPCore-1.0.0-Unity.zip
• Import ACPCore.unitypackage via Assets->Import Package

Android

1. Make sure you have an Android device connected.
2. From the menu of the Unity app, select File > Build Settings...
3. Select Android from the Platform window
4. If Android is not the active platform, hit the button that says Switch Platform (it will only be available if you actually need to switch active platforms)
5. Press the Build And Run button
6. You will be asked to provide a location to save the build. Make a new directory at unity-acpanalytics/ACPAnalytics/Builds (this folder is in the .gitignore file)
7. Name build whatever you want and press Save
8. Unity will build an apk file and automatically deploy it to the connected device

iOS

1. From the menu of the Unity app, select File > Build Settings...
2. Select iOS from the Platform window
3. If iOS is not the active platform, hit the button that says Switch Platform (it will only be available if you actually need to switch active platforms)
4. Press the Build And Run button
5. You will be asked to provide a location to save the build. Make a new directory at unity-acpanalytics/ACPAnalytics/Builds (this folder is in the .gitignore file)
6. Name build whatever you want and press Save
7. Unity will create and open an Xcode project
8. Add XCFrameworks to the Xcode project.
9. From the Xcode project run the app on a simulator.

Additional Cordova Plugins

Below is a list of additional Unity plugins from the AEP SDK suite:

Extension	GitHub	Unity Package
ACPCore	https://github.com/adobe/unity-acpcore	ACPCore
AEPAssurance	https://github.com/adobe/unity-aepassurance	AEPAssurance
ACPUserProfile	https://github.com/adobe/unity_acpuserprofile	ACPUserProfile

Contributing

Looking to contribute to this project? Please review our Contributing guidelines prior to opening a pull request.

We look forward to working with you!

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.