corona_sdk: An Objective-C repository from Shchvova

Summary

This is the Corona SDK of Adjust™. You can read more about Adjust™ at adjust.com.

Example app
Basic integration
Additional features
License

Example app

There is example inside the plugin directory. In there in you can check how to integrate the Adjust SDK into your app.

Basic integration

These are the essential steps required to integrate the Adjust SDK into your Corona app project.

Get the SDK

You can get the latest version of the Adjust SDK from our releases page. Please, download both the plugin.adjust.jar and libplugin_adjust.a files, since you will need to add them to your app's projects.

Add the SDK to your app

You can now add the Adjust SDK to your Corona Enterprise app project. The Adjust SDK will soon be published to the Corona plugin marketplace. Once this happens, this chapter will be updated with integration instructions for users working from the plugin marketplace.

Add the SDK to your Android project

Inside your Android Studio app project, create a libs folder inside of your app folder and add the plugin.adjust.jar file to it. After that, please update your app's build.gradle file and add the following lines to your dependencies section:

compile 'com.adjust.sdk:adjust-android:4.13.0'
compile 'com.android.installreferrer:installreferrer:1.0'

Add the SDK to your iOS project

Inside your Xcode app project, select your app's target, go to General -> Linked Frameworks and Libraries section, press the + button and add the libplugin_adjust.a library into the list.

Integrate the SDK into your app

You should initialize the Adjust SDK as soon as possible within your application, pretty much upon app launch. Run the initialization code once per app launch: there's no need to place this code where it will be executed multiple times per app life cycle, since the Adjust SDK exists in your app as a static instance. In order to initialize the Adjust SDK in your app, please do the following:

local adjust = require "plugin.adjust"

adjust.create({
    appToken = "{YourAppToken}",
    environment = "SANDBOX"
})

Replace {YourAppToken} with your app token. You can find this in your dashboard.

Depending on whether you are building your app for testing or for production, you need to set environment with one of these string 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 before you publish the app. Set it back to SANDBOX when you start developing and testing it again.

We use this environment to distinguish between real traffic and test traffic from test devices. It is imperative that you keep this value meaningful at all times.

Adjust logging

You can increase or decrease the amount of logs you see in tests by setting the logLevel parameter value when calling the adjust.create method and assign one of the following string values to it:

"VERBOSE"   // enable all logging
"DEBUG"     // enable more logging
"INFO"      // default
"WARN"      // disable info logging
"ERROR"     // disable warnings as well
"ASSERT"    // disable errors as well
"SUPPRESS"  // disable all logging

Adjust project settings

Once the Adjust SDK has been added to your app, certain tweaks need to be performed so that the Adjust SDK can work properly. Below you can find a description of every additional thing that you need to do after you've added the Adjust SDK into to your app.

Android permissions

Please add the following permissions, which the Adjust SDK needs, if they are not already present in your AndroidManifest.xml file:

<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

If you are not targeting the Google Play Store, please also add the following permission:

<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>

The Adjust SDK might need the INTERNET permission at any point in time. The Adjust SDK needs the ACCESS_WIFI_STATE permission in case your app is not targeting the Google Play Store and doesn't use Google Play Services. If you are targeting the Google Play Store and you are using Google Play Services, the Adjust SDK doesn't need the ACCESS_WIFI_STATE permission and, if you don't need it anywhere else in your app, you can remove it.

Google Play Services

Since August 1, 2014, apps in the Google Play Store must use the Google advertising ID to uniquely identify each device. To allow the Adjust SDK to use the Google advertising ID, you must integrate Google Play Services.

Open the build.gradle file of your app and find the dependencies block. Add the following line:

compile 'com.google.android.gms:play-services-analytics:11.8.0'

To check whether the analytics part of the Google Play Services library has been successfully added to your app, you should start your app by configuring the SDK to run in SANDBOX mode and set the log level to VERBOSE. After that, track a session or some events in your app and observe the list of parameters in the verbose logs which are being read once the session or event has been tracked. If you see a parameter called gps_adid in there, you have successfully added the analytics part of the Google Play Services library to your app and our SDK is reading the necessary information from it.

Proguard settings

If you are using Proguard, add these lines to your Proguard file:

-keep public class com.adjust.sdk.** { *; }
-keep class com.google.android.gms.common.ConnectionResult {
    int SUCCESS;
}
-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient {
    com.google.android.gms.ads.identifier.AdvertisingIdClient$Info getAdvertisingIdInfo(android.content.Context);
}
-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient$Info {
    java.lang.String getId();
    boolean isLimitAdTrackingEnabled();
}
-keep public class com.android.installreferrer.** { *; }

Install referrer

In order to correctly attribute an install of your Android app to its source, Adjust needs information about the install referrer. This can be obtained by using the Google Play Referrer API or by catching the Google Play Store intent with a broadcast receiver.

Important: The Google Play Referrer API is newly introduced by Google with the express purpose of providing a more reliable and secure way of obtaining install referrer information and to aid attribution providers in the fight against click injection. It is strongly advised that you support this in your application. The Google Play Store intent is a less secure way of obtaining install referrer information. It will continue to exist in parallel with the new Google Play Referrer API temporarily, but it is set to be deprecated in future.

Google Play Referrer API

In order to support this in your app, please make sure that you have followed the Add the SDK to your Android project chapter properly and that you have following line added to your build.gradle file:

compile 'com.android.installreferrer:installreferrer:1.0'

Also, make sure that you have paid attention to the Proguard settings chapter and that you have added all the rules mentioned in it, especially the one needed for this feature:

-keep public class com.android.installreferrer.** { *; }

This feature is supported if you are using the Adjust SDK v4.12.0 or above.

Google Play Store intent

The Google Play Store INSTALL_REFERRER intent should be captured with a broadcast receiver. If you are not using your own broadcast receiver to receive the INSTALL_REFERRER intent, add the following receiver tag inside the application tag in your AndroidManifest.xml.

<receiver
    android:name="com.adjust.sdk.AdjustReferrerReceiver"
    android:exported="true" >
    <intent-filter>
        <action android:name="com.android.vending.INSTALL_REFERRER" />
    </intent-filter>
</receiver>

We use this broadcast receiver to retrieve the install referrer and pass it to our backend.

Please bear in mind that, if you are using your own broadcast receiver which handles the INSTALL_REFERRER intent, you don't need the Adjust broadcast receiver to be added to your manifest file. You can remove it, but, inside your own receiver, add the call to the Adjust broadcast receiver as described in our Android guide.

Huawei Referrer API

As of v4.23.0, the Adjust SDK supports install tracking on Huawei devices with Huawei App Gallery version 10.4 and higher. No additional integration steps are needed to start using the Huawei Referrer API.

iOS frameworks

You can add following iOS frameworks to your generated Xcode project to take advantage of additional features:

iAd.framework - in case you are running iAd campaigns
AdSupport.framework - for reading iOS Advertising Id (IDFA)
CoreTelephony.framework - for reading MCC and MNC information
StoreKit.framework - for communication with SKAdNetwork framework
AppTrackingTransparency.framework - to ask for user's consent to be tracked and obtain status of that consent

Additional features

You can take advantage of the following features once you have integrated the Adjust SDK into your project.

AppTrackingTransparency framework

Note: This feature exists only in iOS platform.

For each package sent, the Adjust backend receives one of the following four (4) states of consent for access to app-related data that can be used for tracking the user or the device:

Authorized
Denied
Not Determined
Restricted

After a device receives an authorization request to approve access to app-related data, which is used for user device tracking, the returned status will either be Authorized or Denied.

Before a device receives an authorization request for access to app-related data, which is used for tracking the user or device, the returned status will be Not Determined.

If authorization to use app tracking data is restricted, the returned status will be Restricted.

The SDK has a built-in mechanism to receive an updated status after a user responds to the pop-up dialog, in case you don't want to customize your displayed dialog pop-up. To conveniently and efficiently communicate the new state of consent to the backend, Adjust SDK offers a wrapper around the app tracking authorization method described in the following chapter, App-tracking authorization wrapper.

App-tracking authorisation wrapper

Note: This feature exists only in iOS platform.

Adjust SDK offers the possibility to use it for requesting user authorization in accessing their app-related data. Adjust SDK has a wrapper built on top of the requestTrackingAuthorizationWithCompletionHandler: method, where you can as well define the callback method to get information about a user's choice. Also, with the use of this wrapper, as soon as a user responds to the pop-up dialog, it's then communicated back using your callback method. The SDK will also inform the backend of the user's choice. Integer value will be delivered via your callback method with the following meaning:

0: ATTrackingManagerAuthorizationStatusNotDetermined
1: ATTrackingManagerAuthorizationStatusRestricted
2: ATTrackingManagerAuthorizationStatusDenied
3: ATTrackingManagerAuthorizationStatusAuthorized

To use this wrapper, you can call it as such:

adjust.requestTrackingAuthorizationWithCompletionHandler(function(event)
    print("[Adjust]: Authorization status = " .. event.message)
    if     event.message == "0" then print("[Adjust]: ATTrackingManagerAuthorizationStatusNotDetermined")
    elseif event.message == "1" then print("[Adjust]: ATTrackingManagerAuthorizationStatusRestricted")
    elseif event.message == "2" then print("[Adjust]: ATTrackingManagerAuthorizationStatusDenied")
    elseif event.message == "3" then print("[Adjust]: ATTrackingManagerAuthorizationStatusAuthorized")
    end
end)

SKAdNetwork framework

Note: This feature exists only in iOS platform.

If you have implemented the Adjust iOS SDK v4.23.0 or above and your app is running on iOS 14, the communication with SKAdNetwork will be set on by default, although you can choose to turn it off. When set on, Adjust automatically registers for SKAdNetwork attribution when the SDK is initialized. If events are set up in the Adjust dashboard to receive conversion values, the Adjust backend sends the conversion value data to the SDK. The SDK then sets the conversion value. After Adjust receives the SKAdNetwork callback data, it is then displayed in the dashboard.

In case you don't want the Adjust SDK to automatically communicate with SKAdNetwork, you can disable that by setting the following key in configuration map:

local adjust = require "plugin.adjust"

adjust.create({
    appToken = "{YourAppToken}",
    environment = "SANDBOX",
    logLevel = "VERBOSE",
    handleSkAdNetwork = false
})

Event tracking

You can use Adjust to track all kinds of events. Let's say you want to track every tap on a button. If you create a new event token in your dashboard - let's say that event token is abc123 - you can add the following line in your button’s click handler method to track the click:

local adjust = require "plugin.adjust"

adjust.trackEvent({
    eventToken = "abc123"
})

Revenue tracking

If your users can generate revenue by tapping on advertisements or making in-app purchases, then you can track that revenue with events. Let's say a tap is worth €0.01. You could track the revenue event like this:

local adjust = require "plugin.adjust"

adjust.trackEvent({
    eventToken = "abc123",
    revenue = 0.01,
    currency = "EUR"
})

When you set a currency token, Adjust will automatically convert the incoming revenue into a reporting revenue of your choice. Read more about currency conversion here.

Revenue deduplication

You can also add an optional transaction ID to avoid tracking duplicate revenue. 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 trackEvent only when the transaction is completed and an item is purchased. That way you can avoid tracking revenue that is not actually being generated.

local adjust = require "plugin.adjust"

adjust.trackEvent({
    eventToken = "abc123",
    revenue = 0.01,
    currency = "EUR",
    transactionId = "YourTransactionId"
})

Note: Transaction ID is the iOS term. The unique identifier for completed Android in-app purchases is Order ID.

Callback parameters

You can register a callback URL for an event in your dashboard, and we will send a GET request to that URL whenever the event is tracked. You can also put some key-value pairs in an object and pass them 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:

local adjust = require "plugin.adjust"

adjust.trackEvent({
    eventToken = "abc123",
    callbackParameters = {
        {
            key = "key",
            value = "value",
        },
        {
            key = "foo",
            value = "bar",
        }
    }
})

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 advertising 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.

You can read more about using URL callbacks, including a full list of available values, in our callbacks guide.

Partner parameters

Similarly to the callback parameters mentioned above, you can also add parameters that Adjust will transmit to network partners of your choice. You can activate these networks in your Adjust Dashboard.

These work similarly to the callback parameters mentioned above but parameter name used for them is partnerParameters:

local adjust = require "plugin.adjust"

adjust.trackEvent({
    eventToken = "abc123",
    partnerParameters = {
        {
            key = "key",
            value = "value",
        },
        {
            key = "foo",
            value = "bar",
        }
    }
})

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

Callback identifier

You can also add custom string identifier to each event you want to track. This identifier will later be reported in event success and/or event failure callbacks to enable you to keep track on which event was successfully tracked or not. You can set this identifier by passing the callbackId field when tracking event:

local adjust = require "plugin.adjust"

adjust.trackEvent({
    eventToken = "abc123",
    callbackId = "Your-Custom-Id"
})

Subscription tracking

Note: This feature is only available in the SDK v4.23.0 and above.

You can track App Store and Play Store subscriptions and verify their validity with the Adjust SDK. After a subscription has been successfully purchased, make the following call to the Adjust SDK:

For App Store subscription:

local adjust = require "plugin.adjust"

adjust.trackAppStoreSubscription({
    price = "6.66",
    currency = "EUR",
    transactionId = "your-transaction-id",
    receipt = "your-receipt",
    transactionDate = "unix-timestamp",
    salesRegion = "your-sales-region",
})

For Play Store subscription:

adjust.trackPlayStoreSubscription({
    price = "6",
    currency = "EUR",
    orderId = "your-order-id",
    signature = "your-signature",
    purchaseToken = "your-purchase-token",
    purchaseTime = "unix-timestamp",
})

Subscription tracking parameters for App Store subscription:

price
currency (you need to pass currencyCode of the priceLocale object)
transactionId
receipt
transactionDate
salesRegion (you need to pass countryCode of the priceLocale object)

Subscription tracking parameters for Play Store subscription:

Note: Subscription tracking API offered by Adjust SDK expects all parameters to be passed as string values. Parameters described above are the ones which API exects you to pass to subscription object prior to tracking subscription. There are various libraries which are handling in app purchases in Corona and each one of them should return information described above in some form upon successfully completed subscription purchase. You should locate where these parameters are placed in response you are getting from library you are using for in app purchases, extract those values and pass them to Adjust API as string values.

Just like with event tracking, you can attach callback and partner parameters to the subscription object as well:

For App Store subscription:

local adjust = require "plugin.adjust"

adjust.trackAppStoreSubscription({
    price = "6.66",
    currency = "EUR",
    transactionId = "your-transaction-id",
    receipt = "your-receipt",
    transactionDate = "unix-timestamp",
    salesRegion = "your-sales-region",
    callbackParameters = {
        {
            key = "callback_key1",
            value = "callback_value1",
        },
        {
            key = "callback_key2",
            value = "callback_value2",
        },
    },
    partnerParameters = {
        {
            key = "callback_key3",
            value = "callback_value3",
        },
        {
            key = "callback_key6",
            value = "callback_value6",
        },
    },
})

For Play Store subscription:

adjust.trackPlayStoreSubscription({
    price = "6",
    currency = "EUR",
    orderId = "your-order-id",
    signature = "your-signature",
    purchaseToken = "your-purchase-token",
    purchaseTime = "unix-timestamp",
    callbackParameters = {
        {
            key = "callback_key1",
            value = "callback_value1",
        },
        {
            key = "callback_key2",
            value = "callback_value2",
        },
    },
    partnerParameters = {
        {
            key = "callback_key3",
            value = "callback_value3",
        },
        {
            key = "callback_key6",
            value = "callback_value6",
        },
    },
})

Session parameters

Some parameters are saved to be sent with every event and session of the Adjust SDK. Once you have added any of these parameters, you don't need to add them every time, since they will be saved locally. If you add the same parameter twice, there will be no effect.

These session parameters can be called before the Adjust SDK is launched to make sure they are sent even on install. If you need to send them with an install but can only obtain the needed values after launch, it's possible to delay the first launch of the Adjust SDK to allow for this behavior.

Session callback parameters

The same callback parameters that are registered for events can also be saved to be sent with every event or session of the Adjust SDK.

Session callback parameters have a similar interface to event callback parameters, except that, instead of adding the key and its value to an event, they are added through a call to the addSessionCallbackParameter method of the adjust instance:

local adjust = require "plugin.adjust"

adjust.addSessionCallbackParameter("foo", "bar")

Session callback parameters will be merged with the callback parameters added to an event. The callback parameters added to an event take precedence over the session callback parameters. This means that, when adding a callback parameter to an event with the same key as one added from the session, the callback parameter added to the event will prevail.

It's possible to remove a specific session callback parameter by passing the desired key to the removeSessionCallbackParameter method of the adjust instance:

local adjust = require "plugin.adjust"

adjust.removeSessionCallbackParameter("foo")

If you wish to remove all keys and values from the session callback parameters, you can reset them with the resetSessionCallbackParameters method of the adjust instance:

local adjust = require "plugin.adjust"

adjust.resetSessionCallbackParameters()

Session partner parameters

In the same way that there are session callback parameters that are sent with every event or session of the Adjust SDK, there are also session partner parameters.

These will be transmitted to network partners that you have integrated and activated in your Adjust dashboard.

Session partner parameters have a similar interface to event partner parameters. Except that, instead of adding the key and its value to an event, they are added through a call to the addSessionPartnerParameter method of the adjust instance:

local adjust = require "plugin.adjust"

adjust.addSessionPartnerParameter("foo", "bar")

The session partner parameters will be merged with the partner parameters added to an event. The partner parameters added to an event take precedence over the session partner parameters. This means that, when adding a partner parameter to an event with the same key as one added from the session, the partner parameter added to the event will prevail.

It's possible to remove a specific session partner parameter by passing the desired key to the removeSessionPartnerParameter method of the adjust instance:

local adjust = require "plugin.adjust"

adjust.removeSessionPartnerParameter("foo")

If you wish to remove all keys and values from the session partner parameters, you can reset them with the resetSessionPartnerParameters method of the adjust instance:

local adjust = require "plugin.adjust"

adjust.resetSessionPartnerParameters()

Delay start

Delaying the start of the Adjust SDK allows your app some time to obtain session parameters, such as unique identifiers, to be sent on install.

Set the initial delay time, in seconds, with the delayStart parameter of the adjust.create method:

local adjust = require "plugin.adjust"

adjust.create({
    appToken = "{YourAppToken}",
    environment = "SANDBOX",
    logLevel = "VERBOSE",
    delayStart = 5.5
})

In this case, the Adjust SDK not send the initial install session and any events created for 5.5 seconds. Once this time has elapsed, or if you call sendFirstPackages() of the adjust instance in the meantime, every session parameter will be added to the delayed install session and events and the Adjust SDK will resume as usual.

The maximum start time delay of the Adjust SDK is 10 seconds.

Attribution callback

You can register a listener to be notified of tracker attribution changes. Due to the different sources considered for attribution, this information cannot be provided synchronously. The simplest way to achieve this is to create a single anonymous listener which is going to be called each time a user's attribution value changes. Use the setAttributionListener method of the adjust instance to set the listener before starting the SDK:

local adjust = require "plugin.adjust"
local json = require "json"

local function attributionListener(event)
    local json_attribution = json.decode(event.message)
    print("Attribution changed!")
    print("Tracker token: " .. json_attribution.trackerToken)
    print("Tracker name: " .. json_attribution.trackerName)
    print("Campaign: " .. json_attribution.campaign)
    print("Network: " .. json_attribution.network)
    print("Creative: " .. json_attribution.creative)
    print("Adgroup: " .. json_attribution.adgroup)
    print("Click label: " .. json_attribution.clickLabel)
    print("ADID: " .. json_attribution.adid)
end

-- ...

adjust.setAttributionListener(attributionListener)

-- ...

adjust.create({
    appToken = "{YourAppToken}",
    environment = "SANDBOX",
    logLevel = "VERBOSE"
})

Within the listener function you have access to the attribution parameters. Here is a quick summary of their properties:

trackerToken the tracker token of the current attribution
trackerName the tracker name of the current attribution
network the network grouping level of the current attribution
campaign the campaign grouping level of the current attribution
adgroup the ad group grouping level of the current attribution
creative the creative grouping level of the current attribution
clickLabel the click label of the current attribution
adid the Adjust device identifier

Please make sure to consider our applicable attribution data policies.

Session and event callbacks

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

Follow the same steps as for attribution callbacks to implement the following callback function for successfully tracked events:

local adjust = require "plugin.adjust"
local json = require "json"

local function eventTrackingSuccessListener(event)
    local json_event_success = json.decode(event.message)
    print("Event tracking success!")
    print("Event token: " .. json_event_success.eventToken)
    print("Message: " .. json_event_success.message)
    print("Timestamp: " .. json_event_success.timestamp)
    print("Callback Id: " .. json_event_success.callbackId)
    print("Adid: " .. json_event_success.adid)
    print("JSON response: " .. json_event_success.jsonResponse)
end

-- ...

adjust.setEventTrackingSuccessListener(eventTrackingSuccessListener)

-- ...

adjust.create({
    appToken = "{YourAppToken}",
    environment = "SANDBOX",
    logLevel = "VERBOSE"
})

The following callback function for failed events:

local adjust = require "plugin.adjust"
local json = require "json"

local function eventTrackingFailureListener(event)
    local json_event_failure = json.decode(event.message)
    print("Event tracking failure!")
    print("Event token: " .. json_event_failure.eventToken)
    print("Message: " .. json_event_failure.message)
    print("Timestamp: " .. json_event_failure.timestamp)
    print("Callback Id: " .. json_event_failure.callbackId)
    print("Adid: " .. json_event_failure.adid)
    print("Will retry: " .. json_event_failure.willRetry)
    print("JSON response: " .. json_event_failure.jsonResponse)
end

-- ...

adjust.setEventTrackingFailureListener(eventTrackingFailureListener)

-- ...

adjust.create({
    appToken = "{YourAppToken}",
    environment = "SANDBOX",
    logLevel = "VERBOSE"
})

For successfully tracked sessions:

local adjust = require "plugin.adjust"
local json = require "json"

local function sessionTrackingSuccessListener(event)
    local json_session_success = json.decode(event.message)
    print("Session tracking success!")
    print("Message: " .. json_session_success.message)
    print("Timestamp: " .. json_session_success.timestamp)
    print("Adid: " .. json_session_success.adid)
    print("JSON response: " .. json_session_success.jsonResponse)
end

-- ...

adjust.setSessionTrackingSuccessListener(sessionTrackingSuccessListener)

-- ...

adjust.create({
    appToken = "{YourAppToken}",
    environment = "SANDBOX",
    logLevel = "VERBOSE"
})

And for failed sessions:

local adjust = require "plugin.adjust"
local json = require "json"

local function sessionTrackingFailureListener(event)
    local json_session_failure = json.decode(event.message)
    print("Session tracking failure!")
    print("Message: " .. json_session_failure.message)
    print("Timestamp: " .. json_session_failure.timestamp)
    print("Adid: " .. json_session_failure.adid)
    print("Will retry: " .. json_session_failure.adid)
    print("JSON response: " .. json_session_failure.jsonResponse)
end

-- ...

adjust.setSessionTrackingFailureListener(sessionTrackingFailureListener)

-- ...

adjust.create({
    appToken = "{YourAppToken}",
    environment = "SANDBOX",
    logLevel = "VERBOSE"
})

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:

var message the message from the server or the error logged by the SDK
var timestamp timestamp from the server
var adid a unique device identifier provided by Adjust
var jsonResponse the JSON object with the response from the server

Both event response data objects contain:

var eventToken the event token, if the package tracked was an event
var callbackId the custom defined callback ID set on event object

And both event and session failed objects also contain:

var 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 setEnabled method of the adjust instance with the enabled parameter set to false. This setting is remembered between sessions, but it can only be activated after the first session.

local adjust = require "plugin.adjust"

adjust.setEnabled(false)

You can verify if the Adjust SDK is currently active with the isEnabled method of the adjust instance:

local adjust = require "plugin.adjust"

adjust.isEnabled(function(event) 
    print("isEnabled = " .. event.message) 
end)

It is always possible to activate the Adjust SDK by invoking setEnabled with the parameter set to true.

Offline mode

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

You can activate offline mode by calling the setOfflineMode method of the adjust instance with true.

local adjust = require "plugin.adjust"

adjust.setOfflineMode(true)

Conversely, you can deactivate offline mode by calling setOfflineMode withfalse. When the Adjust SDK is put back in online mode, all saved information is sent 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 by passing the eventBufferingEnabled parameter into the adjust.create method call:

local adjust = require "plugin.adjust"

adjust.create({
    appToken = "{YourAppToken}",
    environment = "SANDBOX",
    logLevel = "VERBOSE",
    eventBufferingEnabled = true
})

GDPR right to be forgotten

In accordance with article 17 of the EU's General Data Protection Regulation (GDPR), you can notify Adjust when a user has exercised their right to be forgotten. Calling the following method will instruct the Adjust SDK to communicate the user's choice to be forgotten to the Adjust backend:

local adjust = require "plugin.adjust"

adjust.gdprForgetMe();

Upon receiving this information, Adjust will erase the user's data and the Adjust SDK will stop tracking the user. No requests from this device will be sent to Adjust in the future.

Disable third-party sharing for specific users

You can now notify Adjust when a user has exercised their right to stop sharing their data with partners for marketing purposes, but has allowed it to be shared for statistics purposes.

Call the following method to instruct the Adjust SDK to communicate the user's choice to disable data sharing to the Adjust backend:

local adjust = require "plugin.adjust"

adjust.disableThirdPartySharing();

Upon receiving this information, Adjust will block the sharing of that specific user's data to partners and the Adjust SDK will continue to work as usual.

SDK signature

An account manager must activate the Adjust SDK signature. Contact Adjust support (support@adjust.com) if you are interested in using this feature.

If the SDK signature has already been enabled on your account and you have access to App Secrets in your Adjust Dashboard, please use the method below to integrate the SDK signature into your app.

An App Secret is set by passing all secret parameters (secretId, info1, info2, info3, info4) when making the adjust.create method call:

local adjust = require "plugin.adjust"

adjust.create({
    appToken = "{YourAppToken}",
    environment = "SANDBOX",
    logLevel = "VERBOSE",
    secretId = aaa,
    info1 = bbb,
    info2 = ccc,
    info3 = ddd,
    info4 = eee
})

Background tracking

The default behavior of the Adjust SDK is to pause sending HTTP requests while the app is in the background. You can change this by passing the sendInBackground parameter into the adjust.create method call:

local adjust = require "plugin.adjust"

adjust.create({
    appToken = "{YourAppToken}",
    environment = "SANDBOX",
    logLevel = "VERBOSE",
    sendInBackground = true
})

If nothing is set here, sending in background is disabled by default.

Device IDs

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

iOS Advertising Identifier

To obtain the IDFA, call the getIdfa method of the adjust instance. You need to pass a callback to that method in order to obtain the value:

local adjust = require "plugin.adjust"

adjust.getIdfa(function(event) 
    print("idfa = " .. event.message) 
end)

Google Play Services advertising identifier

If you need to obtain the Google advertising ID, you can call the getGoogleAdId method of the adjust instance. You need to pass a callback to that method in order to obtain the value:

local adjust = require "plugin.adjust"

adjust.getGoogleAdId(function(event) 
    print("googleAdId = " .. event.message) 
end)

Amazon advertising identifier

If you need to obtain the Amazon advertising ID, you can call the getAmazonAdId method on adjust instance:

local adjust = require "plugin.adjust"

adjust.getAmazonAdId(function(event) 
    print("amazonAdId = " .. event.message) 
end)

Adjust device identifier

For every device with your app installed on it, the Adjust backend generates a unique Adjust device identifier (adid). In order to obtain this identifier, call the getAdid method of the adjust instance. You need to pass a callback to that method in order to obtain the value:

local adjust = require "plugin.adjust"

adjust.getAdid(function(event) 
    print("adid = " .. event.message) 
end)

Note: Information about the adid is only available after an app installation has been tracked by the Adjust backend. From that moment on, the Adjust SDK has information about the device adid and you can access it with this method. So, it is not possible to access the adid value before the SDK has been initialized and installation of your app has been successfully tracked.

User attribution

As described in the attribution callback section, this callback is triggered to provide you with information about a new attribution whenever it changes. If you want to access information about a user's current attribution at any other time, you can make a call to the getAttribution method of the adjust instance:

local adjust = require "plugin.adjust"
local json = require "json"

adjust.getAttribution(function(event) 
    local json_attribution = json.decode(event.message)
    print("Tracker token: " .. json_attribution.trackerToken)
    print("Tracker name: " .. json_attribution.trackerName)
    print("Campaign: " .. json_attribution.campaign)
    print("Network: " .. json_attribution.network)
    print("Creative: " .. json_attribution.creative)
    print("Adgroup: " .. json_attribution.adgroup)
    print("Click label: " .. json_attribution.clickLabel)
    print("ADID: " .. json_attribution.adid)
end)

Note: Information about current attribution is only available after an app installation has been tracked by the Adjust backend and the attribution callback has been triggered. From that moment on, the Adjust SDK has information about a user's attribution and you can access it with this method. So, it is not possible to access a user's attribution value before the SDK has been initialized and an attribution callback has been triggered.

Push token

To send us the push notification token, add the following call to Adjust whenever you get your token in the app or when it gets updated:

local adjust = require "plugin.adjust"

adjust.setPushToken("YourPushNotificationToken");

Push tokens are used for Audience Builder and client callbacks, and they are required for the upcoming uninstall tracking feature.

Track additional device identifiers

If you are distributing your Android app outside of the Google Play Store and would like to track additional device identifiers (IMEI and MEID), you need to explicitly instruct the Adjust SDK to do so. You can do that by passing the readMobileEquipmentIdentity parameter when making the call to adjust.create method. The Adjust SDK does not collect these identifiers by default.

local adjust = require "plugin.adjust"

adjust.create({
    appToken = "{YourAppToken}",
    environment = "SANDBOX",
    logLevel = "VERBOSE",
    readMobileEquipmentIdentity = true
})

You will also need to add the READ_PHONE_STATE permission to your AndroidManifest.xml file:

<uses-permission android:name="android.permission.READ_PHONE_STATE"/>

In order to use this feature, additional steps are required within your Adjust Dashboard. For more information, please contact your dedicated account manager or write an email to support@adjust.com.

Pre-installed trackers

If you want to use the Adjust SDK to recognize users whose devices came with your app pre-installed, follow these steps.

Create a new tracker in your dashboard.

Open your app delegate and set the default tracker by passing the defaultTracker parameter to the adjust.create method call:

local adjust = require "plugin.adjust"

adjust.create({
    appToken = "{YourAppToken}",
    environment = "SANDBOX",
    logLevel = "VERBOSE",
    defaultTracker = "abc123"
})

Replace abc123 with the tracker token you created in step 1. Please note that the dashboard displays a tracker URL (including http://app.adjust.com/). In your source code, you should specify only the six-character token and not the entire URL.

Build and run your app. You should see a line like the following in the app's log output:
```
Default tracker: 'abc123'
```

Deep linking

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 information about the deeplink URL and its content. There are two scenarios when it comes to deeplinking: standard and deferred:

Standard deeplinking is when a user already has your app installed.
Deferred deeplinking is when a user does not have your app installed.

Note: At this moment, due to Corona framework limitations, standard deeplinking is currently fully supported only on the Android platform. Deferred deeplinking works well on both the iOS and Android platforms.

Standard deeplinking

Standard deeplinking is a platform-specific feature and, in order to support it, you need to add some additional settings to your app. If your user already has the app installed and hits a tracker URL with deeplink information in it, your application will be opened and the content of the deep link will be sent to your app so that you can parse it and decide what to do next.

Note for iOS: With the introduction of iOS 9, Apple has changed the way deeplinking is handled in apps. Depending on which deeplinking scenario you want to use for your app (or if you want to use them both to support a wide range of devices), you need to set up your app to handle one or both of the following scenarios.

Like mentioned above, standard deeplinking is currently not supported due to Corona platform limitations, but, nevertheless, setting it up in your Xcode project as described in the chapters below is still required for deferred deep linking.

Deeplinking on iOS 8 and earlier

To support deeplink handling in your app for iOS 8 and earlier versions, you need to set a Custom URL Scheme setting for your iOS app. In order to do this, please follow our official iOS SDK README instructions. There is no need to override methods inside of AppDelegate.m (in Corona's case: AppCoronaDelegate.mm), just follow the Xcode project setting part of the instructions.

Deeplinking on iOS 9 and later

Starting from iOS 9, Apple introduced suppressed support for the old style deeplinking with custom URL schemes, as described above, in favor of universal links. If you want to support deeplinking in your app for iOS 9 and higher, you need to add support for universal link handling. In order to do this, please follow our official iOS SDK README instructions. There is no need to override methods inside of AppDelegate.m (in Corona's case: AppCoronaDelegate.mm), just follow the Xcode project setting part of the instructions.

Deeplinking on Android

In order to support deeplinking in your Android app, you need to add support for handling the custom URL scheme that you want to use to open your Android app. In order to do this, please follow our official Android SDK README instructions.

In order to obtain information about the link that caused your app to open, you need to add some additional code to your main.lua file:

local function onSystemEvent(event)
    if event.type == "applicationOpen" and event.url then
        print("url = " .. event.url)
    end
end

The value of the event.url variable in the above example (if available) represents the actual link that opened your Android app.

By completing this, you should be able to handle direct deeplinking on Android.

Deferred deeplinking

While deferred deeplinking is not supported out of the box on Android or iOS, the Adjust SDK makes it possible.

In order to get information about the URL content through deferred deeplinking, you should set a callback method on the the adjust instance which will receive one parameter where the content of the URL will be delivered. You should set this method on the config object by calling the setDeferredDeeplinkListener method:

local adjust = require "plugin.adjust"
local json = require "json"

local function deferredDeeplinkListener(event)
    print("deeplink = " .. event.message)
end

-- ...

adjust.setDeferredDeeplinkListener(deferredDeeplinkListener)

-- ...

adjust.create({
    appToken = "{YourAppToken}",
    environment = "SANDBOX",
    logLevel = "VERBOSE"
})

In deferred deeplinking, there is one additional setting available to pass to the adjust.create method call. Once the Adjust SDK gets the deferred deeplink information, you can choose whether our SDK opens this URL or not. You can choose to set this option by passing the shouldLaunchDeeplink parameter to the adjust.create method call:

local adjust = require "plugin.adjust"
local json = require "json"

local function deferredDeeplinkListener(event)
    print("deeplink = " .. event.message)
end

-- ...

adjust.setDeferredDeeplinkListener(deferredDeeplinkListener)

-- ...

adjust.create({
    appToken = "{YourAppToken}",
    environment = "SANDBOX",
    logLevel = "VERBOSE",
    shouldLaunchDeeplink = false
})

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

Reattribution via deeplinks

Adjust enables you to run re-engagement campaigns by using deeplinks. For more information on this, please check our official docs.

If you are using this feature, in order for your users to be properly reattributed, you need to make one additional call to the Adjust SDK in your app.

Once you have received information about the deeplink content in your app, add a call to the appWillOpenUrl method of the adjust instance. By making this call, the Adjust SDK will try to find if there is any new attribution information inside of the deeplink, and, if there is any, it will be sent to the Adjust backend. If a user should be reattributed through a click on an Adjust tracker URL with deeplink content in it, you will see the attribution callback in your app being triggered with new attribution information for this user.

In the code examples described above, a call to the appWillOpenUrl method should be done like this:

local function onSystemEvent(event)
    if event.type == "applicationOpen" and event.url then
        print("url = " .. event.url)
        
        adjust.appWillOpenUrl(event.url)
    end
end

Having added these calls, if the deeplink that opened your app contains any reattribution parameters, our SDK will pass that information to the backend, which will decide whether the user is going to be reattributed or not. As already mentioned, if a user gets reattributed, an attribution callback (if implemented) will be triggered with the new attribution value, and you will have this information in your app, as well.

License

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.

Shchvova/corona_sdk

Summary

Table of contents

Example app

Basic integration

Get the SDK

Add the SDK to your app

Add the SDK to your Android project

Add the SDK to your iOS project

Integrate the SDK into your app

Adjust logging

Adjust project settings

Android permissions

Google Play Services

Proguard settings

Install referrer

Google Play Referrer API

Google Play Store intent

Huawei Referrer API

iOS frameworks

Additional features

AppTrackingTransparency framework

App-tracking authorisation wrapper

SKAdNetwork framework

Event tracking

Revenue tracking

Revenue deduplication

Callback parameters

Partner parameters

Callback identifier

Subscription tracking

Session parameters

Session callback parameters

Session partner parameters

Delay start

Attribution callback

Session and event callbacks

Disable tracking

Offline mode

Event buffering

GDPR right to be forgotten

Disable third-party sharing for specific users

SDK signature

Background tracking

Device IDs

iOS Advertising Identifier

Google Play Services advertising identifier

Amazon advertising identifier

Adjust device identifier

User attribution

Push token

Track additional device identifiers

Pre-installed trackers

Deep linking

Standard deeplinking

Deeplinking on iOS 8 and earlier

Deeplinking on iOS 9 and later

Deeplinking on Android

Deferred deeplinking

Reattribution via deeplinks

License