Skip to content
This is the Unreal SDK of
C++ Objective-C Objective-C++ C# C
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Adjust Plugin state after successful loading in the app Oct 2, 2019
doc/korean Update README.md Sep 26, 2019
.gitignore .gitignore update Jan 24, 2019
CHANGELOG.md Update CHANGELOG.md Oct 2, 2019
README.md Update README.md Jan 24, 2019
VERSION New version 4.18.0 Oct 2, 2019

README.md

Summary

This is the Unreal Engine SDK of Adjust™. You can read more about Adjust™ at Adjust.com.

Table of contents

Basic integration

These are the minimal steps required to integrate the Adjust SDK into your Unreal Engine project.

Get the SDK

Download the latest version from our releases page.

Add the SDK to your project

Adjust SDK plugin is located inside of the Adjust folder inside the archive you just downloaded. Copy Adjust folder inside of your app Plugins folder.

Add Adjust as a dependency to PublicDependencyModuleNames array inside of your app's APPNAME.Build.cs file:

PublicDependencyModuleNames.AddRange(new string[] { "Core", "CoreUObject", "Engine", "InputCore", "Adjust" });

Integrate the SDK into your app

It is recommended that you initialise Adjust SDK as soon as possible inside of your app. You can do this by invoking Initialize method of the Adjust class:

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void Initialize(const FAdjustConfig& Config);

In order to successfully initialise SDK, it is mandatory that you set at least following properties of FAdjustConfig structure:

  • AppToken - Your app token which you can obtain from Adjust dashboard.
  • Environment - Environment in which you want to start Adjust SDK (either Sandbox or Production).

Important: Environment value should only ever be set to Sandbox if you or someone else is testing your app. Make sure to set the environment to Production before you publish your app. Set it back to Sandbox again when you start developing and testing your app. 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 LogLevel field on your FAdjustConfig structure instance with one of the following values:

Verbose   // enable all logging
Debug     // enable more logging
Info      // default
Warn      // disable info logging and below
Error     // disable warnings as well
Assert    // disable errors as well
Suppress  // disable all log output

In Android, you can check for log output from Adjust SDK by seaching for lines with tag Adjust. In iOS, you can find Adjust SDK log lines by looking the ones that start with [Adjust] string.

Additional features

Once you integrate the Adjust SDK into your project, you can take advantage of the following features.

Event tracking

With Adjust, you can track any event that you want.

If you create a new event token in your dashboard - let's say that event token is abc123 - you can assign that token to EventToken field of the FAdjustEvent structure and invoke TrackEvent method of the Adjust class:

// Adjust method to invoke for event tracking.
UFUNCTION(BlueprintCallable, Category = "Adjust")
static void TrackEvent(const FAdjustEvent& Event);
// FAdjustEvent structure EventToken member.
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString EventToken;

Revenue tracking

If your users can generate revenue by tapping on advertisements or making in-app purchases, then you can track that revenue as well. Let's say a tap is worth €0.01. You could track the revenue by setting this info on Revenue and Currency fields on the FAdjustEvent structure:

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
float Revenue;

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Currency;

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

You can read more about revenue and event tracking in the event tracking guide.

Revenue deduplication

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. Transaction ID can be assigned to TransactionId member of the FAdjustEvent structure.

If you want to track in-app purchases, please make sure to call TrackEvent only when the transaction has been completed. That way you can avoid tracking revenue that is not actually being generated.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString TransactionId;

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

Callback parameters

You can register a callback URL for an event in your dashboard. We will send a GET request to that URL whenever the event is tracked. You can add callback parameters to an event by adding key-value pairs to CallbackParameters map member of the FAdjustEvent structure before tracking the event. We will then append these parameters to your callback URL.

For example, suppose you have registered the URL http://www.adjust.com/callback for your event and that you add two key-value pairs (("key", "value") and ("foo", "bar")) to CallbackParameters member:

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
TMap<FString, FString> CallbackParameters;

In this 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

For any integrations that you have activated in your Adjust dashboard, you can add parameters to send to these network partners.

Partner parameters work similarly to the callback parameters mentioned above, by adding key-value pairs to PartnerParameters map member of the FAdjustEvent structure.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
TMap<FString, FString> PartnerParameters;

You can read more about special partners and how to integrate them 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 assigning the value to CallbackId member of FAdjustEvent structure:

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString CallbackId;

Session parameters

Some parameters are saved to be sent in every event and session of the Adjust SDK. Once you have added any of these parameters, you don't need to add them again, 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.

Session callback parameters

You can save the same callback parameters that are registered for events to be sent in 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 class.

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void AddSessionCallbackParameter(const FString& Key, const FString& Value);

Session callback parameters will be merged with the callback parameters you have added to an event. Callback parameters that have been added to an event take precedence over session callback parameters. If you add 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 class.

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void RemoveSessionCallbackParameter(const FString& Key);

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

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void ResetSessionCallbackParameters();

Session partner parameters

In the same way that there are session callback parameters that are sent for every event or session of the Adjust SDK, there are also session partner parameters. These will be transmitted to any network partners that have been 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 class.

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void AddSessionPartnerParameter(const FString& Key, const FString& Value);

Session partner parameters will be merged with the partner parameters that you have added to an event. The partner parameters that have been added to an event take precedence over session partner parameters. This means that if you add a partner parameter to an event with the same key as one added from the session, the partner parameter will prevail.

It is possible to remove a specific session partner parameter by passing the desired key to the RemoveSessionPartnerParameter method of the Adjust class.

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void RemoveSessionPartnerParameter(const FString& Key);

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

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void ResetSessionPartnerParameters();

Delay start

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

Set the initial delay time, in seconds, with the DelayStart member of the FAdjustConfig structure:

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString DelayStart;

After this time has elapsed, or if you call SendFirstPackages method of the Adjust class in the meantime, every session parameter will be added to the delayed install session and events, and the Adjust SDK will resume as usual.

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void SendFirstPackages();

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

Attribution callback

Adjust can also send you a callback upon any change in attribution. Due to the different sources considered for attribution, this information cannot be provided synchronously.

Attribution callback exists in AdjustDelegates class and has following signature:

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnAttributionChangedDelegate, const FAdjustAttribution&, Attribution);

// ...

UPROPERTY(BlueprintAssignable, Category = Adjust)
FOnAttributionChangedDelegate OnAttributionChangedDelegate;

Once implemented in your app and triggered, you can access following attribution information inside FAdjustAttribution struct instance:

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString TrackerToken; // The tracker token of the current attribution.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString TrackerName;  // The tracker name of the current attribution.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Network;      // The network grouping level of the current attribution.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Campaign;     // The campaign grouping level of the current attribution.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Adgroup;      // The ad group grouping level of the current attribution.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Creative;     // The creative grouping level of the current attribution.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString ClickLabel;   // The click label of the current attribution.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Adid;         // The Adjust device identifier.

Please make sure to consider the applicable attribution data policies.

Session and event callbacks

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

Follow the same steps as in the attribution callback section above if you want to implement the callback function for successfully tracked events:

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnEventSuccessDelegate, const FAdjustEventSuccess&, EventSuccess);

// ...

UPROPERTY(BlueprintAssignable, Category = Adjust)
FOnEventSuccessDelegate OnEventSuccessDelegate;

Once implemented in your app and triggered, you can access following information inside FAdjustEventSuccess struct instance:

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString EventToken;   // The event token.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString CallbackId;   // The callback ID of the event.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Message;      // The message from the server or the error logged by the SDK.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Timestamp;    // The timestamp from the server.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Adid;         // A unique device identifier provided by Adjust.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString JsonResponse; // The JSON object with the response from the server.

The following callback function is used for failed events:

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnEventFailureDelegate, const FAdjustEventFailure&, EventFailure);

// ...

UPROPERTY(BlueprintAssignable, Category = Adjust)
FOnEventFailureDelegate OnEventFailureDelegate;

Once implemented in your app and triggered, you can access following information inside FAdjustEventFailure struct instance:

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString EventToken;   // The event token.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString CallbackId;   // The callback ID of the event.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Message;      // The message from the server or the error logged by the SDK.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Timestamp;    // The timestamp from the server.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Adid;         // A unique device identifier provided by Adjust.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString JsonResponse; // The JSON object with the response from the server.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
bool WillRetry;       // Indicates there will be an attempt to resend the package at a later time.

For successfully tracked sessions:

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnSessionSuccessDelegate, const FAdjustSessionSuccess&, SessionSuccess);

// ...

UPROPERTY(BlueprintAssignable, Category = Adjust)
FOnSessionSuccessDelegate OnSessionSuccessDelegate;

Once implemented in your app and triggered, you can access following information inside FAdjustSessionSuccess struct instance:

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Message;      // The message from the server or the error logged by the SDK.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Timestamp;    // The timestamp from the server.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Adid;         // A unique device identifier provided by Adjust.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString JsonResponse; // The JSON object with the response from the server.

And for session failures:

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnSessionFailureDelegate, const FAdjustSessionFailure&, SessionFailure);

//...

UPROPERTY(BlueprintAssignable, Category = Adjust)
FOnSessionFailureDelegate OnSessionFailureDelegate;

Once implemented in your app and triggered, you can access following information inside FAdjustSessionFailure struct instance:

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Message;      // The message from the server or the error logged by the SDK.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Timestamp;    // The timestamp from the server.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Adid;         // A unique device identifier provided by Adjust.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString JsonResponse; // The JSON object with the response from the server.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
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 SetEnabled method of the Adjust class with the enabled parameter set to false. This setting is remembered between sessions, but it can only be activated after the first session.

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void SetEnabled(bool Enable);

You can verify if the Adjust SDK is currently active by using the IsEnabled() method of the Adjust class.

UFUNCTION(BlueprintCallable, Category = "Adjust")
static bool IsEnabled();

It is always possible to activate the Adjust SDK by invoking SetEnabled method of the Adjust class with the parameter set to true.

Offline mode

You can put the Adjust SDK into offline mode, suspending 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 while in offline mode.

You can activate offline mode by calling SetOfflineMode method of the Adjust class with the parameter set to true.

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void SetOfflineMode(bool Offline);

Conversely, you can deactivate offline mode by calling SetOfflineMode method of the Adjust class with the parameter set to false. When the Adjust SDK is put back in online mode, all saved information is sent to our servers with the correct time information.

Unlike when disabling tracking, this setting is not remembered between sessions. This means that the Adjust SDK always starts in online mode, 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 through your FAdjustConfig structure instance by setting the EventBuffering member to true:

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
bool EventBuffering;

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

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:

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void 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.

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) to FAdjustConfig structure instance before initialising the SDK:

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString SecretId;

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Info1;

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Info2;

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Info3;

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FString Info4;

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 in your FAdjustConfig structure instance by setting the SendInBackground member to true:

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
bool SendInBackground;

If nothing is set here, sending in the 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

You can access the IDFA value on an iOS device by invoking the GetIdfa() method of the Adjust class.

UFUNCTION(BlueprintCallable, Category = "Adjust")
static FString GetIdfa();

Google Play Services advertising identifier

The Adjust SDK allows you to read the Google Advertising Identifier of the Android device on which your app is running. To do this, set the callback method which receives the FString parameter. This callback is, like all previous callbacks, part of the AdjustDelegates class.

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnGoogleAdvertisingIdDelegate, const FString&, GoogleAdId);

// ...

UPROPERTY(BlueprintAssignable, Category = Adjust)
FOnGoogleAdvertisingIdDelegate OnGoogleAdvertisingIdDelegate;

Next, invoke the GetGoogleAdId() method of the Adjust class. You will then get the Google Advertising Identifier value in your previously set callback:

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void GetGoogleAdId();

Amazon advertising identifier

If you need to obtain the Amazon advertising ID, you can call the GetAmazonAdId() method of the Adjust class:

UFUNCTION(BlueprintCallable, Category = "Adjust")
static FString GetAmazonAdId();

Adjust device identifier

For each device with your app installed, the Adjust backend generates a unique Adjust device identifier (adid). In order to obtain this identifier, you can call the following method on the Adjust class:

UFUNCTION(BlueprintCallable, Category = "Adjust")
static FString GetAdid();

Note: Information about the adid is only available after the Adjust backed has tracked your app's installation. 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 before the SDK has been initialized and the installation of your app has been tracked successfully.

User attribution

Attribution callbacks are triggered via the method described in the attribution callback section. They provide you with information about any changes to your users’ attribution values. If you wish to access information about a user's current attribution value at any other time, you can make a call to the following method of the Adjust class:

UFUNCTION(BlueprintCallable, Category = "Adjust")
static FAdjustAttribution GetAttribution();

Note: Information about a user’s current attribution value is only available after the Adjust backed has tracked your app's installation and an initial attribution callback has been triggered. From that moment on, the Adjust SDK has information about the user's attribution value 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 initial attribution callback has been triggered.

Push token

To send us a push notification token, add the following call to Adjust whenever your app receives the token or it is updated:

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void SetPushToken(const FString& PushToken);

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

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.

  • Set the default tracker member of your FAdjustConfig structure instance:

    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
    FString DefaultTracker;

    Replace {TrackerToken} with the tracker token you created in step one. 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'
    

License

The Adjust SDK is licensed under the MIT License.

Copyright (c) 2019 Adjust GmbH, http://www.adjust.com

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.

You can’t perform that action at this time.