Release Notes: (1.1.0)
  • Added iOS arm64 support.

Integration Guide - Adx Analytics Plugin

Platforms: Android & iOS
Plugin version: 1.1.0
AdX iOS SDK version: 2.4.6
AdX Android SDK version: 3.1

Generally you don't have to dive into the documentation from Adx, simply follow a few steps below to get the plugin integrated in your App in minutes:

[1] Import the AdxAnalytics[Android|IOS|Universal].unitypackage file to your unity project;

[2] Follow the instructions below to configure the plugin.

· >>> For Android platform, click on the menu item of Unity top menu bar: NeatPlug -> AdxAnalytics -> Patch Android Configuration. This is for generating a valid AndroidManifest.xml or patching the existing file with AdxAnalytics support.


· >>> For iOS platform, click on the menu item of Unity top menu bar: NeatPlug -> AdxAnalytics -> Patch iOS Configuration. This is for automatically adding iOS SDK frameworks, libraries or patching the Info.plist file (if needed) as long as the Xcode project is generated by Unity.

[3] Find AdxAnalyticsAgent Prefab in Assets/Plugins/NeatPlug/Analytics/AdxAnalytics/Prefabs/, open the first scene of your game, drag & drop the prefab into the scene.

[4] Okay, the integration is done here. Now set up Adx Tracker by filling in a few properties of the AdxAnalyticsAgent gameObject which you just dropped in the Hierarchy window. To do this, simply select that gameObject, and look at its properties in the Inspector window, you need to fill in:

   · App Id [Android|IOS] - The App ID of your App (You can get it from Adx).

   · Client Id [Android|IOS] - The Client ID (You can get it from Adx).

   · Url Scheme IOS - The URL Scheme of your App (You can get it from Adx).

   · Enable Debugging - Set this to true if you want to see debug info in the log.

Now it's the time to do reporting!

[5] Call below functions to log an event, error or pageview:

   · AdxAnalytics.Instance().Init(string appId, ... ) - Required if you don't apply "App Id" or "Client Id" property value for AdxAnalyticsAgent.

   · AdxAnalytics.Instance().LogEvent(...) - Log and send an event to Adx.

  There are other useful public methods that AdxAnalytics provides, to use them, call AdxAnalytics.Instance().method().
Show All   
public void Init(string appId, string clientId, bool enableDebugging)
/**
 * Initialization.
 * 
 * @param appId
 *            string - Your App ID.	
 * 
 * @param clientId
 *            string - Your Client ID.	
 * 
 * @param enableDebugging
 *            bool - True for printing debug info in the log, false for not.
 * 
 */
public void Init(string appId, string clientId, bool enableDebugging)
public void LogEvent(string eventId, string val, string currency)
/**
 * Log an event and send to Ad-X.	
 * 
 * @param eventId
 *          string - The eventId for identifying the event.	
 * 
 * @param val
 *          string - The value string.
 * 
 * @param currency
 *          string - The currency string. (e.g. GBP)
 * 	
 */
public void LogEvent(string eventId, string val, string currency)
public string GetReferral()
/**
 * Get the referral code.
 */ 
public void GetReferral()

[6] Build your App now. To compile for iOS platform, you need to have Xcode installed.

[7] Test and verify if events can be logged on Adx's servers as expected, generally reports will appear in your Adx adtracker account in minutes. If you encounter any exceptions, it would be helpful for you to address issues if you take a look at the logcat output (Android) or xcode debug console (iOS) to find the debug / error / warning messages.

[EOF] Should you have any questions or encounter any problems while integrating the plugin, please do not hesitate to shoot us an email at support@neatplug.com, we will be more than happy to help you. Thanks for choosing NeatPlug solutions!