GitHub - JackHCS/unity_sdk: This is the Unity SDK of

Summary

This is the Unity SDK of adjust™. It supports iOS, Android, Windows 8.1 and Windows phone 8.1 targets. You can read more about adjust™ at adjust.com.

Basic integration

These are the minimal steps required to integrate the adjust SDK into your Unity project.

Get the SDK

Download the latest version from our releases page. In there you will find two Unity packages:

Adjust_vX.Y.Z_Unity_4.unitypackage - Use this package if you are using Unity IDE version 4.
Adjust_vX.Y.Z_Unity_5.unitypackage - Use this package if you are using Unity IDE version 5.

Add the SDK to your project

Open your project in the Unity Editor and navigate to Assets → Import Package → Custom Package and select the downloaded Unity package file.

Integrate the SDK into your app

Add the prefab located at Assets/Adjust/Adjust.prefab to the first scene.

Edit the parameters of the Adjust script in the Inspector menu of the added prefab.

You have the possibility to set up the following options on the Adjust prefab:

Start Manually
Event Buffering
Print Attribution
Send In Background
Launch Deferred Deep Link
App Token
Log Level
Environment

Replace {YourAppToken} with your actual App Token. You can find in your dashboard.

Depending on whether or not you build your app for testing or for production you must change Environment with one of these values:

    'Sandbox'
    'Production'

Important: This value should be set to Sandbox if and only if you or someone else is testing your app. Make sure to set the environment to Production just before you publish the app. Set it back to Sandbox when you start testing it again.

We use this environment to distinguish between real traffic and artificial traffic from test devices. It is very important that you keep this value meaningful at all times! Especially if you are tracking revenue.

If you don't want to start the adjust SDK at the Awake event of the app, untick the box Start Manually. Call the method Adjust.start with the AdjustConfig object as a parameter to start the adjust SDK instead.

For an example of scene with of a button menu with these options and others, open the example scene located at Assets/Adjust/ExampleGUI/ExampleGUI.unity. The source for this scene is located at Assets/Adjust/ExampleGUI/ExampleGUI.cs.

Adjust logging

You can increase or decrease the amount of logs you see by changing the value of Log Level to one of the following:

Verbose - enable all logging
Debug - enable more logging
Info - the default
Warn - disable info logging
Error - disable warnings as well
Assert - disable errors as well

If your target is Windows based, to see the compiled logs from our library in released mode, it is necessary to redirect the log output to your app while it's being tested in debug mode.

Call the method setLogDelegate in the AdjustConfig instance before starting the sdk.

//...
adjustConfig.setLogDelegate(msg => Debug.Log(msg));
//...
Adjust.start (adjustConfig);

Google Play Services

Since August 1st, 2014, apps in the Google Play Store must use the Google Advertising ID to uniquely identify devices. To allow the adjust SDK to use the Google Advertising ID, you must integrate the Google Play Services. If you haven't done this yet, you should copy google-play-services_lib folder into the Assets/Plugins/Android folder of your Unity project and after building your app, Google Play Services should be integrated.

google-play-services_lib is part of the Android SDK, which you may already have installed.

There are two main ways to download the Android SDK. If you are using any tool which has the Android SDK Manager, you should download Android SDK Tools. Once installed, you can find the libraries in the SDK_FOLDER/extras/google/google_play_services/libproject/ folder.

If you are not using any tool which has Android SDK Manager, you should download the standalone version of Android SDK from official page. By downloading this, you will have only a basic version of the Android SDK which doesn't include the Android SDK Tools. There are more detailed instructions on how to download these in the readme file provided by Google, called SDK Readme.txt, which is placed in Android SDK folder.

Build scripts

To facilitate the build process we integrated build scripts for both Android and iOS. The script runs after each build and is called by the file Assets/Editor/AdjustEditor.cs. They require at least python 2.7 installed to work.

It's possible to disable the post processing by clicking on the menu Assets → Adjust → Change post processing status. Press the same button to re-enable it.

iOS build script

The iOS build script is located at Assets/Editor/PostprocessBuildPlayer_AdjustPostBuildiOS.py. It changes the Unity iOS generated project in the following ways:

Adds the iAd.framework and AdSupport.framework to the project. This is required by the adjust SDK - check out the official iOS SDK README for more details.
Adds the other linker flag -ObjC. This allows the adjust Objective-C categories to be recognized during build time.

If you have a custom build that puts the Unity iOS generated project in a different location, inform the script by clicking on the menu Assets → Adjust → Set iOS build path and choosing the build path of the iOS project.

After running, the script writes the log file AdjustPostBuildiOSLog.txt at the root of the Unity project with log messages of the script run.

Android build script

The Android build script is located at Assets/Editor/PostprocessBuildPlayer_AdjustPostBuildAndroid.py. It changes the AndroidManifest.xml file located at Assets/Plugins/Android/. The problem with this approach is that the manifest file used for the Android package was the same one as before the build process ended.

To mitigate this, simply run the build again, using the manifest created or changed by the previous run, or click on the menu Assets → Adjust → Fix AndroidManifest.xml so the script can run before the build process. Either way, it is only necessary to do this step once, as long the manifest file remains compatible with the adjust SDK.

If there is no AndroidManifest.xml file at Assets/Plugins/Android/ it creates a copy from our compatible manifest file AdjustAndroidManifest.xml. If there is already an AndroidManifest.xml file, it checks and changes the following:

Adds the adjust broadcast receiver. For more details, consult the official Android SDK README. Please, have in mind that if you are using your own broadcast receiver which handles INSTALL_REFERRER intent, you don't need the adjust broadcast receiver to be added in your manifest file. Remove it, but inside your own receiver add the call to the adjust broadcast receiver like described in Android guide.
Adds the permission to connect to the internet.
Adds the permission to access information about Wi-Fi networks.

After running, the script writes the log file AdjustPostBuildAndroidLog.txt at the root of the Unity project with log messages of the script run.

Additional features

Once you integrated the adjust SDK into your project, you can take advantage of the following features.

Event tracking

You can tell adjust about any event you wish. Suppose you want to track every tap on a button. You would just need to create a new Event Token in your dashboard. Let's say that Event Token is abc123. In your button's click handler method you could then add the following lines to track the click:

AdjustEvent adjustEvent = new AdjustEvent ("abc123");
Adjust.trackEvent (adjustEvent);

Revenue tracking

If your users can generate revenue by tapping on advertisements or making In-App Purchases you can track those revenues with events. Let's say a tap is worth one Euro cent. You could then track the revenue event like this:

AdjustEvent adjustEvent = new AdjustEvent ("abc123");
adjustEvent.setRevenue (0.01, "EUR");
Adjust.trackEvent (adjustEvent);

Revenue deduplication

At the moment, this is an iOS feature only.

You can also add an optional transaction ID to avoid tracking duplicate revenues. The last ten transaction IDs are remembered, and revenue events with duplicate transaction IDs are skipped. This is especially useful for In-App Purchase tracking. You can see an example below.

If you want to track in-app purchases, please make sure to call the trackEvent only if the transaction is finished and item is purchased. That way you can avoid tracking revenue that is not actually being generated.

AdjustEvent adjustEvent = new AdjustEvent ("abc123");

adjustEvent.setRevenue (0.01, "EUR");
adjustEvent.setTransactionId ("transactionId");

Adjust.trackEvent (adjustEvent);

In-App Purchase verification

If you want to check the validity of In-App Purchases made in your app using Purchase Verification, adjust's server side receipt verification tool, then check out our Unity purchase SDK and read more about it here.

Callback parameters

You can also register a callback URL for that event in your dashboard and we will send a GET request to that URL whenever the event gets tracked. In that case you can also put some key-value pairs in an object and pass it to the trackEvent method. We will then append these named parameters to your callback URL.

For example, suppose you have registered the URL http://www.adjust.com/callback for your event with Event Token abc123 and execute the following lines:

AdjustEvent adjustEvent = new AdjustEvent ("abc123");

adjustEvent.addCallbackParameter ("key", "value");
adjustEvent.addCallbackParameter ("foo", "bar");

Adjust.trackEvent (adjustEvent);

In that case we would track the event and send a request to:

http://www.adjust.com/callback?key=value&foo=bar

It should be mentioned that we support a variety of placeholders like {idfa} for iOS or {gps_adid} for Android that can be used as parameter values. In the resulting callback the {idfa} placeholder would be replaced with the ID for Advertisers of the current device for iOS and the {gps_adid} would be replaced with the Google Play Services ID of the current device for Android. Also note that we don't store any of your custom parameters, but only append them to your callbacks. If you haven't registered a callback for an event, these parameters won't even be read.

Partner parameters

You can also add parameters to be transmitted to network partners, for the integrations that have been activated in your adjust dashboard.

This works similarly to the callback parameters mentioned above, but can be added by calling the addPartnerParameter method on your AdjustEvent instance.

AdjustEvent adjustEvent = new AdjustEvent ("abc123");

adjustEvent.addPartnerParameter ("key", "value");
adjustEvent.addPartnerParameter ("foo", "bar");

Adjust.trackEvent (adjustEvent);

You can read more about special partners and these integrations in our guide to special partners.

Attribution callback

You can register a callback to be notified of tracker attribution changes. Due to the different sources considered for attribution, this information cannot be provided synchronously. Follow these steps to implement the optional callback in your application:

Please make sure to consider applicable attribution data policies.

Create a method with the signature of the delegate Action<AdjustAttribution>.
After creating the AdjustConfig object, call the adjustConfig.setAttributionChangedDelegate with the previously created method. It is also be possible to use a lambda with the same signature.
If instead of using the Adjust.prefab, the Adjust.cs script was added to another GameObject. Don't forget to pass the name of that GameObject as the second parameter of AdjustConfig.setAttributionChangedDelegate.

As the callback is configured using the AdjustConfig instance, you should call adjustConfig.setAttributionChangedDelegate before calling Adjust.start.

The callback function will get called when the SDK receives final attribution data. Within the callback function you have access to the attribution parameter. Here is a quick summary of its properties:

string trackerToken the tracker token of the current install.
string trackerName the tracker name of the current install.
string network the network grouping level of the current install.
string campaign the campaign grouping level of the current install.
string adgroup the ad group grouping level of the current install.
string creative the creative grouping level of the current install.
string clickLabel the click label of the current install.

using com.adjust.sdk;

public class ExampleGUI : MonoBehaviour {
{
    void OnGUI () {
    {
        if (GUI.Button (new Rect (0, 0, Screen.width, Screen.height), "callback")) 
        {
            AdjustConfig adjustConfig = new AdjustConfig ("{Your App Token}", AdjustEnvironment.Sandbox);
            adjustConfig.setLogLevel (AdjustLogLevel.Verbose);
            adjustConfig.setAttributionChangedDelegate (this.attributionChangedDelegate);

            Adjust.start (adjustConfig);
        }
    }
    
    public void attributionChangedDelegate (AdjustAttribution attribution)
    {
        Debug.Log ("Attribution changed");
        
        // ...
    }
}

Session and event callbacks

You can register a callback to be notified of successful and failed events and/or sessions.

Follow the same steps to implement the following callback function for successful tracked events:

// ...

AdjustConfig adjustConfig = new AdjustConfig ("{Your App Token}", AdjustEnvironment.Sandbox);
adjustConfig.setLogLevel (AdjustLogLevel.Verbose);
adjustConfig.setEventSuccessDelegate (EventSuccessCallback);

Adjust.start (adjustConfig);

// ...

public void EventSuccessCallback (AdjustEventSuccess eventSuccessData)
{
    // ...
}

The following callback function for failed tracked events:

// ...

AdjustConfig adjustConfig = new AdjustConfig ("{Your App Token}", AdjustEnvironment.Sandbox);
adjustConfig.setLogLevel (AdjustLogLevel.Verbose);
adjustConfig.setEventFailureDelegate (EventFailureCallback);

Adjust.start (adjustConfig);

// ...

public void EventFailureCallback (AdjustEventFailure eventFailureData)
{
    // ...
}

For successful tracked sessions:

// ...

AdjustConfig adjustConfig = new AdjustConfig ("{Your App Token}", AdjustEnvironment.Sandbox);
adjustConfig.setLogLevel (AdjustLogLevel.Verbose);
adjustConfig.setSessionSuccessDelegate (SessionSuccessCallback);

Adjust.start (adjustConfig);

// ...

public void SessionSuccessCallback (AdjustSessionSuccess sessionSuccessData)
{
    // ...
}

And for failed tracked sessions:

// ...

AdjustConfig adjustConfig = new AdjustConfig ("{Your App Token}", AdjustEnvironment.Sandbox);
adjustConfig.setLogLevel (AdjustLogLevel.Verbose);
adjustConfig.setSessionFailureDelegate (SessionFailureCallback);

Adjust.start (adjustConfig);

// ...

public void SessionFailureCallback (AdjustSessionFailure sessionFailureData)
{
    // ...
}

The callback functions will be called after the SDK tries to send a package to the server. Within the callback you have access to a response data object specifically for the callback. Here is a quick summary of the session response data properties:

string Message the message from the server or the error logged by the SDK.
string Timestamp timestamp from the server.
string Adid a unique device identifier provided by adjust.
Dictionary<string, object> JsonResponse the JSON object with the response from the server.

Both event response data objects contain:

string EventToken the event token, if the package tracked was an event.

And both event and session failed objects also contain:

bool WillRetry indicates there will be an attempt to resend the package at a later time.

Disable tracking

You can disable the adjust SDK from tracking by invoking the method setEnabled with the enabled parameter as false. This setting is remembered between sessions, but it can only be activated after the first session.

Adjust.setEnabled(false);

You can verify if the adjust SDK is currently active with the method isEnabled. It is always possible to activate the adjust SDK by invoking setEnabled with the enabled parameter set to true.

Offline mode

You can put the adjust SDK in offline mode to suspend transmission to our servers, while retaining tracked data to be sent later. When in offline mode, all information is saved in a file, so be careful not to trigger too many events.

You can activate offline mode by calling setOfflineMode with the parameter true.

Adjust.setOfflineMode(true);

Conversely, you can deactivate offline mode by calling setOfflineMode with false. When the adjust SDK is put back in online mode, all saved information is send to our servers with the correct time information.

Unlike disabling tracking, this setting is not remembered between sessions. This means that the SDK is in online mode whenever it is started, even if the app was terminated in offline mode.

Event buffering

If your app makes heavy use of event tracking, you might want to delay some HTTP requests in order to send them in one batch every minute. You can enable event buffering with your AdjustConfig instance:

AdjustConfig adjustConfig = new AdjustConfig ("{YourAppToken", "{YourEnvironment}");

adjustConfig.setEventBufferingEnabled (true);

Adjust.start (adjustConfig);

If nothing is set, event buffering is disabled by default.

Background tracking

The default behaviour of the adjust SDK is to pause sending HTTP requests while the app is in the background. You can change this in your AdjustConfig instance:

AdjustConfig adjustConfig = new AdjustConfig ("{YourAppToken", "{YourEnvironment}");

adjustConfig.setSendInBackground (true);

Adjust.start (adjustConfig);

Device IDs

Certain services (such as Google Analytics) require you to coordinate Device and Client IDs in order to prevent duplicate reporting.

Android

If you need to obtain the Google Advertising ID, There is a restriction that only allows it to be read in a background thread. If you call the function getGoogleAdId with a Action<string> delegate, it will work in any situation:

Adjust.getGoogleAdId((string googleAdId) => {
    // ...
});

Inside the method onGoogleAdIdRead of the OnDeviceIdsRead instance, you will have access to the Google Advertising ID as the variable googleAdId.

iOS

To obtain the IDFA, call the function getIdfa:

Adjust.getIdfa ()

Deep linking

Deep linking is supported only on iOS and Android platforms.

If you are using the adjust tracker URL with an option to deep link into your app from the URL, there is the possibility to get info about the deep link URL and its content. Hitting the URL can happen when the user has your app already installed (standard deep linking scenario) or if they don't have the app on their device (deferred deep linking scenario). In the standard deep linking scenario, Android platform natively offers the possibility for you to get the info about the deep link content. Deferred deep linking scenario is something which Android platform doesn't support out of box and for this case, the adjust SDK will offer you the mechanism to get the info about the deep link content.

You need to set up deep linking handling in your app on native level - in your generated Xcode project (for iOS) and Android Studio / Eclipse project (for Android).

Standard deep linking scenario

Unfortunatelly, in this scenario the information about the deep link can not be delivered to you in your Unity C# code. Once you enable your app to handle deep linking, you will get information about the deep link on native level. For more information check our chapters below on how to enable deep linking for Android and iOS apps.

Deferred deep linking scenario

In order to get info about the URL content in a deferred deep linking scenario, you should set a callback method on the AdjustConfig object which will receive one string parameter where the content of the URL will be delivered. You should set this method on the config object by calling the method setDeferredDeeplinkDelegate:

// ...

private void DeferredDeeplinkCallback (string deeplinkURL)
{
   Debug.Log ("Deeplink URL: " + deeplinkURL);

   // ...
}

AdjustConfig adjustConfig = new AdjustConfig ("{YourAppToken", "{YourEnvironment}");

adjustConfig.setDeferredDeeplinkDelegate (DeferredDeeplinkCallback);

Adjust.start (adjustConfig);

In deferred deep linking scenario, there is one additional setting which can be set on the AdjustConfig object. Once the adjust SDK gets the deferred deep link info, we are offering you the possibility to choose whether our SDK should open this URL or not. You can choose to set this option by calling the setLaunchDeferredDeeplink method on the config object:

// ...

private void DeferredDeeplinkCallback (string deeplinkURL)
{
   Debug.Log ("Deeplink URL: " + deeplinkURL);

   // ...
}

AdjustConfig adjustConfig = new AdjustConfig ("{YourAppToken", "{YourEnvironment}");

adjustConfig.setLaunchDeferredDeeplink (true);
adjustConfig.setDeferredDeeplinkDelegate (DeferredDeeplinkCallback);

Adjust.start (adjustConfig);

If nothing is set, the adjust SDK will always try to launch the URL by default.

To enable your apps to support deep linking, you should set up schemes for each supported platform.

Deep linking handling in Android app

This should be done in native Android Studio / Eclipse project.

To set up your Android app to handle deep linking on native level, please follow our guide in the official Android SDK README.

Deep linking handling in iOS app

This should be done in native Xcode project.

To set up your iOS app to handle deep linking on native level, please follow our guide in the official iOS SDK README.

Troubleshooting

Debug information in iOS

Even with the post build script it is possible that the project is not ready to run out of the box.

If needed, disable dSYM File. In the Project Navigator, select the Unity-iPhone project. Click the Build Settings tab and search for debug information. There should be an Debug Information Format or DEBUG_INFORMATION_FORMAT option. Change it from DWARF with dSYM File to DWARF.

Build scripts fails to be executed

The post build scripts require execute permissions to be able to run. If the build process freezes in the end and opens one of the script files, this may be that your system is configured to not allow scripts to run by default. If this is the case, use the chmod tool in both Assets/Editor/PostprocessBuildPlayer_AdjustPostBuildiOS.py and Assets/Editor/PostprocessBuildPlayer_AdjustPostBuildAndroid.py to add execute privileges.

License

The file mod_pbxproj.py is licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

The adjust SDK is licensed under the MIT License.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Name		Name	Last commit message	Last commit date
Latest commit History 270 Commits
Assets		Assets
Scripts		Scripts
doc		doc
ext		ext
.gitattributes		.gitattributes
.gitignore		.gitignore
.gitmodules		.gitmodules
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
VERSION		VERSION
adjust_uninstall.py		adjust_uninstall.py

License

JackHCS/unity_sdk

Folders and files

Latest commit

History

Repository files navigation

Summary

Table of contents

Revenue deduplication

Android

iOS

About

Resources

License

Stars

Watchers

Forks

Languages