GitHub - adjust/unreal_sdk: This is the Unreal SDK of

Summary

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

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][releases].

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 InitSdk method of the Adjust class:

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void InitSdk(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 EAdjustEnvironment::Sandbox or EAdjustEnvironment::Production).

Important: Environment value should only ever be set to EAdjustEnvironment::Sandbox if you or someone else is testing your app. Make sure to set the environment to EAdjustEnvironment::Production before you publish your app. Set it back to EAdjustEnvironment::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:

EAdjustLogLevel::Verbose   // enable all logging
EAdjustLogLevel::Debug     // enable more logging
EAdjustLogLevel::Info      // default
EAdjustLogLevel::Warn      // disable info logging and below
EAdjustLogLevel::Error     // disable warnings as well
EAdjustLogLevel::Assert    // disable errors as well
EAdjustLogLevel::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

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

Send event information

You can tell Adjust about every event you want to record.

If you create a new event 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 UAdjust 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;

Event revenue

If your users can generate revenue by tapping on advertisements or making in-app purchases, then you can record those revenues with events. 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;

Event deduplication

You can also add an optional deduplication ID to avoid recording duplicate events. By default, the SDK stores the last 10 identifiers and skips revenue events with duplicate transaction IDs. In case you would like the SDK to store more than 10 identifiers, you can set the desired number of identifiers by assigning the value to EventDeduplicationIdsMaxSize property of your FAdjustConfig structure instance before SDK initialization.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
int EventDeduplicationIdsMaxSize = -1;

Deduplication ID can be assigned to DeduplicationId member of the FAdjustEvent structure.

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

Event callback identifier

You can also add custom string identifier to each event you want to record. 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 recorded or not. You can set this identifier by assigning the value to CallbackId member of FAdjustEvent structure:

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

Event 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 recorded. In that case, you can also put some 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.

Event partner parameters

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

This works 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;

User attribution

Each recorded install is getting certain attribution assigned and also, during the app lifetime, the attribution can change.

Attribution callback

You can register a callback to be notified of attribution changes. Due to the different sources considered for attribution, this information can not be provided synchronously.

Attribution callback exists in UAdjustDelegates 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:

// the campaign link token of the current attribution
UPROPERTY(BlueprintReadWrite, Category = "Adjust")
FString TrackerToken;

// the campaign link name of the current attribution
UPROPERTY(BlueprintReadWrite, Category = "Adjust")
FString TrackerName;

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

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

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

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

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

// the cost type in case cost data is part of the attribution
UPROPERTY(BlueprintReadOnly, Category = "Adjust")
FString CostType;

// the cost amount in case cost data is part of the attribution
UPROPERTY(BlueprintReadOnly, Category = "Adjust")
double CostAmount;   

// the cost currency in case cost data is part of the attribution
UPROPERTY(BlueprintReadOnly, Category = "Adjust")
FString CostCurrency;

// the FB install referrer value in case install is attributed to it (Android only)
UPROPERTY(BlueprintReadOnly, Category = "Adjust")
FString FbInstallReferrer;

// the attribution response that the backend sends to the SDK
UPROPERTY(BlueprintReadOnly, Category = "Adjust")
FString JsonResponse;

Get user attribution

If you want to access information about a user's current attribution whenever you need it, you can make a call to the GetAttribution method of the UAdjust class.

Before making this call, you need to assign a callback method to the isntance of UAdjustDelegates class:

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnAttributionGetterDelegate, const FAdjustAttribution&, Attribution);

// ...

UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = Adjust)
FOnAttributionGetterDelegate OnAttributionGetterDelegate;

Note: Information about current attribution is available after app installation has been recorded by the Adjust backend and the attribution callback has been initially 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 initialised and an attribution callback has been triggered.

Preinstalled apps

You can use the Adjust SDK to record activity from apps that came preinstalled on a user's device. This enables you to attribute these users to a custom defined campaign link instead to an organic one.

Preinstall tracking

Note: This feature is Android only.

You can enable preinstall tracking by setting the IsPreinstallTrackingEnabled property to true on your FAdjustConfig structure instance before SDK initialization. Optionally, you can also set the PreinstallFilePath property to specify the path to the file with preinstall data.

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

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

Default link token

Configuring a default link token enables you to attribute all preinstalls to a predefined Adjust link. Adjust records all information against this token until the attribution source changes. To set this up, first you need to create a new campaign link in Campaign Lab. After doing this set the default tracker member of your FAdjustConfig structure instance:

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

In case this approach is not applicable to your preinstall use case, please reach out to [email protected] to explore other ways of how the attribution for preinstalled apps can be handled.

Global parameters

Some parameters are saved to be sent in every session, event, ad revenue and subscription request 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 global parameters can be set before the Adjust SDK is launched to make sure they are sent even on install.

Global callback parameters

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.

The global callback parameters have a similar interface to the event callback parameters. Instead of adding the key and its value to an event, it's added through a call to the AddGlobalCallbackParameter method of the UAdjust class.

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

The global callback parameters will be merged with the callback parameters added to an event / ad revenue / subscription. The callback parameters added to any of these packages take precedence over the global callback parameters. Meaning that, when adding a callback parameter to any of these packages with the same key to one added globaly, the value that prevails is the callback parameter added any of these particular packages.

It's possible to remove a specific global callback parameter by passing the desired key to the method RemoveGlobalCallbackParameter of the UAdjust class.

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

If you wish to remove all keys and values from the global callback parameters, you can reset it with the method RemoveGlobalCallbackParameters of the UAdjust class.

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

Global partner parameters

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

These will be transmitted to network partners, for the integrations that have been activated in your Adjust dashboard.

The global partner parameters have a similar interface to the event / ad revenue / subscription partner parameters. Instead of adding the key and its value to an event, it's added through a call to the AddGlobalPartnerParameter method of the UAdjust class.

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

The global partner parameters will be merged with the partner parameters added to an event / ad revenue / subscription. The partner parameters added to any of thes packages take precedence over the global partner parameters. Meaning that, when adding a partner parameter to any of these packages with the same key to one added globally, the value that prevails is the partner parameter added to any of these particular packages.

It's possible to remove a specific global partner parameter by passing the desired key to the method RemoveGlobalPartnerParameter of the UAdjust class.

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

If you wish to remove all keys and values from the global partner parameters, you can reset them with the method RemoveGlobalPartnerParameters of the Adjust class.

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

Privacy features

The Adjust SDK contains features that you can use to handle user privacy in your app.

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 no requests from this device will be sent to Adjust in the future.

Third-party sharing for specific users

You can notify Adjust when a user disables, enables, and re-enables data sharing with third-party partners.

Disable third-party sharing for specific users

In order to change third party sharing settings for your users, you need to invoke TrackThirdPartySharing method of the UAdjust class:

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void TrackThirdPartySharing(const FAdjustThirdPartySharing& ThirdPartySharing);

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

FAdjustThirdPartySharing adjustThirdPartySharing;
adjustThirdPartySharing.Sharing = EAdjustThirdPartySharingState::Disable;

UAdjust::TrackThirdPartySharing(adjustThirdPartySharing);

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.

Enable or re-enable third-party sharing for specific users

Call the following method to instruct the Adjust SDK to communicate the user's choice to share data or change data sharing, to the Adjust backend:

FAdjustThirdPartySharing adjustThirdPartySharing;
adjustThirdPartySharing.Sharing = EAdjustThirdPartySharingState::Enable;

UAdjust::TrackThirdPartySharing(adjustThirdPartySharing);

Upon receiving this information, Adjust changes sharing the specific user's data to partners. The Adjust SDK will continue to work as expected.

Send granular options

You can attach granular information when a user updates their third-party sharing preferences. Use this information to communicate more detail about a user’s decision. To do this, call the GranularOption.Add method like this:

FAdjustThirdPartySharing adjustThirdPartySharing;
adjustThirdPartySharing.Sharing = EAdjustThirdPartySharingState::Current;

FAdjustGranularOption GranularOptions;
GranularOptions.GranularOption.Add("key", "value");
adjustThirdPartySharing.GranularOptions.Add("partnerName", GranularOptions);

UAdjust::TrackThirdPartySharing(adjustThirdPartySharing);

The following partners are available:

Partner name	String value
AppleAds	apple_ads
Facebook	facebook
GoogleAds	adwords
GoogleMarketingPlatform	google_marketing_platform
Snapchat	snapchat
Tencent	tencent
TikTokSan	tiktok_san
X (formerly Twitter)	twitter
YahooGemini	yahoo_gemini
YahooJapanSearch	yahoo_japan_search

Manage Facebook Limited Data Use

Facebook provides a feature called Limited Data Use (LDU) to comply with the California Consumer Privacy Act (CCPA). This feature enables you to notify Facebook when a California-based user is opted out of the sale of data. You can also use it if you want to opt all users out by default.

You can update the Facebook LDU status by passing arguments following arguments:

Parameter	Description
`partner_name`	Use `facebook` to toggle LDU.
`data_processing_options_country`	The country in which the user is located.
	- `0`: Request that Facebook use geolocation.
	- `1`: United States of America.
`data_processing_options_state`	Notifies Facebook in which state the user is located.
	- `0`: Request that Facebook use geolocation.
	- `1000`: California.
	- `1001`: Colorado.
	- `1002`: Connecticut.

Note: If you call this method with a 0 value for either data_processing_options_country or data_processing_options_state, the Adjust SDK passes both fields back as 0.

FAdjustThirdPartySharing adjustThirdPartySharing;
adjustThirdPartySharing.Sharing = EAdjustThirdPartySharingState::Current;

FAdjustGranularOption GranularOptions;
GranularOptions.GranularOption.Add("data_processing_options_country", "1");
GranularOptions.GranularOption.Add("data_processing_options_state", "1000");
adjustThirdPartySharing.GranularOptions.Add("facebook", GranularOptions);

UAdjust::TrackThirdPartySharing(adjustThirdPartySharing);

Provide consent data to Google (Digital Markets Act compliance)

Important: Passing these options is required if you use Google Ads or Google Marketing Platform and have users located in the European Economic Area (EEA).

To comply with the EU’s Digital Markets Act (DMA), Google Ads and the Google Marketing Platform require explicit consent to receive Adjust’s attribution requests to their APIs. To communicate this consent, you need to add the following granular options to your third party sharing instance for the partner google_dma.

Key	Value	Description
`eea`	`1` (positive) \| `0` (negative)	Informs Adjust whether users installing the app are within the European Economic Area. Includes EU member states, Switzerland, Norway, Iceland, and Slovenia.
`ad_personalization`	`1` (positive) \| `0` (negative)	Informs Adjust whether users consented with being served personalized ads via Google Ads and/or Google Marketing Platform. This parameter also informs the `npa` parameter reserved for Google Marketing Platform.
`ad_user_data`	`1` (positive) \| `0` (negative)	Informs Adjust whether users consented with their advertiser ID being leveraged for attribution purposes.

FAdjustThirdPartySharing adjustThirdPartySharing;
adjustThirdPartySharing.Sharing = EAdjustThirdPartySharingState::Current;

FAdjustGranularOption GranularOptions;
GranularOptions.GranularOption.Add("eea", "1");
GranularOptions.GranularOption.Add("ad_personalization", "1");
GranularOptions.GranularOption.Add("ad_user_data", "1");
adjustThirdPartySharing.GranularOptions.Add("google_dma", GranularOptions);

UAdjust::TrackThirdPartySharing(adjustThirdPartySharing);

Update partner sharing settings

By default, Adjust shares all metrics with any partners you’ve configured in your app settings. You can use the Adjust SDK to update your third party sharing settings on a per-partner basis. To do this, call the PartnerSharingSetting.Add method by passing the partner sharing structure where you will need to set following parameters:

Argument	Data type	Description
`partnerName`	String	The name of the partner. Download the full list of available partners.
`key`	String	The metric to share with the partner.
`value`	Boolean	The user’s decision.

You can use the key to specify which metrics you want to disable or re-enable. If you want to enable/disable sharing all metrics, you can use the all key. The full list of available metrics is available below:

ad_revenue
all
attribution
update
att_update
cost_update
event
install
reattribution
reattribution_reinstall
reinstall
rejected_install
rejected_reattribution
sdk_click
sdk_info
session
subscription
uninstall

When you set a false value against a metric for a partner, Adjust stops sharing the metric with the partner.

Tip: If you only want to share a few metrics with a partner, you can pass the all key with a false value to disable all sharing and then pass individual metrics with a true value to limit what you share.

Examples:

If you want to stop sharing all metrics with a specific partner, pass the all key with a false value.

FAdjustThirdPartySharing adjustThirdPartySharing;
adjustThirdPartySharing.Sharing = EAdjustThirdPartySharingState::Current;

FAdjustPartnerSharingSetting PartnerSettings;
PartnerSettings.PartnerSharingSetting.Add("all", false);
adjustThirdPartySharing.PartnerSharingSettings.Add("PartnerA", PartnerSettings);

UAdjust::TrackThirdPartySharing(adjustThirdPartySharing);

To re-enable sharing, pass the all key with a true value.

FAdjustThirdPartySharing adjustThirdPartySharing;
adjustThirdPartySharing.Sharing = EAdjustThirdPartySharingState::Current;

FAdjustPartnerSharingSetting PartnerSettings;
PartnerSettings.PartnerSharingSetting.Add("all", true);
adjustThirdPartySharing.PartnerSharingSettings.Add("PartnerA", PartnerSettings);

UAdjust::TrackThirdPartySharing(adjustThirdPartySharing);

You can stop or start sharing specific metrics by calling the PartnerSharingSetting.Add method multiple times with different keys. For example, if you only want to share event information with a partner, you can pass:

all with a false value to disable sharing all information
event with a true value to enable event sharing

Note: Specific keys always take priority over all. If you pass all with other keys, the individual key values override the all setting.

FAdjustThirdPartySharing adjustThirdPartySharing;
adjustThirdPartySharing.Sharing = EAdjustThirdPartySharingState::Current;

FAdjustPartnerSharingSetting PartnerSettings;
PartnerSettings.PartnerSharingSetting.Add("all", false);
PartnerSettings.PartnerSharingSetting.Add("event", true);
adjustThirdPartySharing.PartnerSharingSettings.Add("PartnerA", PartnerSettings);

UAdjust::TrackThirdPartySharing(adjustThirdPartySharing);

Consent measurement for specific users

If you’re using Data Privacy settings in your Adjust dashboard, you need to set up the Adjust SDK to work with them. This includes settings such as consent expiry period and user data retention period.

To toggle this feature, call the TrackMeasurementConsent method of UAdjust class with the boolean argument which indicates whether consent measurement is enabled (true) or not (false).

When enabled, the SDK communicates the data privacy settings to Adjust’s servers. Adjust’s servers then applies your data privacy rules to the user. The Adjust SDK continues to work as expected.

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void TrackMeasurementConsent(bool MeasurementConsent);

COPPA compliance

f you need your app to be compliant with the Children’s Online Privacy Protection Act (COPPA), set the IsCoppaComplianceEnabled field on your FAdjustConfig structure to true before initializing the SDK. This performs the following actions:

Disables third-party sharing before the user launches their first session.
Prevents the SDK from reading device and advertising IDs (for example: gps_adid, idfa, and android_id).

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

By default, the SDK is not being launched in COPPA compliance mode.

Play Store kids apps

If your app targets users under the age of 13, and the install region isn’t the USA, you need to mark it as a Kids App. This prevents the SDK from reading device and advertising IDs (for example: idfa, gps_adid and android_id).

To mark your app as a Play Store Kids App, set the IsPlayStoreKidsComplianceEnabled field on your FAdjustConfig structure to true before initializing the SDK.

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

By deafult, the SDK is not being launched in Play Store Kids compliance mode.

Deep linking

If you are using the Adjust campaign link URL with an option to deep link into your app from the URL, there is the possibility to get information 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).

Standard deep linking scenario

The standard deep linking scenario is a platform specific feature in which an app gets opened when user clicks on the deep link. This guide is going to assume that you are aware how deep linking should be set up in your app for both, iOS and Android platforms.

Deferred deep linking scenario

While deferred deep linking is not supported out of the box on Android and iOS, our Adjust SDK makes it possible.

In order to get information about the URL content in a deferred deep linking scenario, you should set a callback method on the UAdjustDelegates object to be able to

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnDeferredDeeplinkDelegate, const FString&, Deeplink);

// ...

UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = Adjust)
FOnDeferredDeeplinkDelegate OnDeferredDeeplinkDelegate;

In a deferred deep linking scenario, there is one additional setting which can be set on the FAdjustConfig structure. Once the Adjust SDK gets the deferred deep link information, you have the possibility to choose whether our SDK should open this URL or not. You can influence default SDK behavior by setting the IsDeferredDeeplinkOpeningEnabled field on the FAdjustConfig instance to false

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

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

Reattribution via deep links

Adjust enables you to run re-engagement campaigns through deep links.

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

Once you have received deep link content information in your app, add a call to the ProcessDeeplink method of UAdjust class. By making this call, the Adjust SDK will try to find if there is any new attribution information inside of the deep link. If there is any, it will be sent to the Adjust backend. If your user should be reattributed due to a click on the Adjust campaign link URL with deep link content, you will see the attribution callback in your app being triggered with new attribution info for this user.

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void ProcessDeeplink(const FAdjustDeeplink& Deeplink);

FAdjustDeeplink adjustDeeplink;
adjustDeeplink.Deeplink = "your-app-scheme://deep-link-content";
UAdjust::ProcessDeeplink(adjustDeeplink);

Resolve Adjust short links

To resolve an Adjust shortened deep link, instantiate an FAdjustDeeplink structure with your shortened deep link and pass it to the ProcessAndResolveDeeplink method of the UAdjust class. In addition to this, you need to declare a callback method on the UAdjustDelegates object that will get triggered once the link gets resolved.

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void ProcessAndResolveDeeplink(const FAdjustDeeplink& Deeplink);

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnDeeplinkResolutionDelegate, const FString&, ResolvedLink);

// ...

UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = Adjust)
FOnDeeplinkResolutionDelegate OnDeeplinkResolutionDelegate;

Note: If the link passed to the ProcessAndResolveDeeplink method was shortened, the callback function receives the extended original link. Otherwise, the callback function receives the link you passed.

Link resolution

You need to set up link resolution for deep linking via email, SMS, QR codes, and platforms that shorten links. If you don't set up link resolution for such cases, a redirect from a universal link sends all users to the App Store, even if they have your app installed. With link resolution, the redirect to the universal link occurs within your app, and existing users aren't sent to the App Store.

Note: Check with your marketing team to see if link resolution is needed for the app. You can then set up link resolution domains for different use cases.

How it works

Link resolution is only applicable when users that have your app installed click on a redirect URL. You need to configure the domain in the redirect URL as a universal link domain in your app.

Link resolution works as follows:

When an existing user clicks a redirect link, iOS opens your app.
Your app passes the redirect URL to the ResolveLink method in the Adjust SDK.
The link resolution method in the Adjust SDK compares the domain in the redirect URL against the link resolution domain that the developer has set in the Adjust SDK, and one of the following happens:
- Domains don't match - The method forwards the deep link URL as is.
- Domains match - The method resolves the link and returns the resulting deep link.
The Adjust SDK will follow up to ten redirects when attempting to resolve a URL. If there are more than ten redirects, the SDK will return the tenth redirect URL.
Your app receives the returned URL and opens deep link content and displays it to the user. Your app also calls the ProcessDeeplink method in the Adjust SDK with the returned URL. This sends the resolved URL to Adjust's servers to be recorded.

Note: If a user who doesn't have your app installed clicks on the redirect URL, iOS handles this as a normal web URL and redirects the user to the App Store. In this case, link resolution isn't applicable.

Use cases

Link resolution is applicable for the following cases:

Email marketing
Platforms that shorten URLs

Email marketing

When email marketers run campaigns, the email marketing platform typically wraps all links in the emails with its own click measurement redirect URL. This lets email marketers view click-through statistics in the email marketing platform. However, if the emails contain universal links, the redirect URL causes iOS to not resolve the universal links.

Example: An email marketer builds their email using a template. This template contains a link or an image with a universal link:

https://example.go.link/summer-clothes?promo=beach&adj_t=abc123

Before the email is sent, the email marketing platform wraps the universal link with its own redirect URL:

https://email.example.com/2wuTnQvU

A user, who has your app installed, clicks on the redirect URL in the email. iOS opens your app and passes the redirect URL to your app. Your app passes the redirect URL to the link resolution method in the Adjust SDK. The Adjust SDK resolves the redirect URL from within your app, so https://email.example.com/2wuTnQvU redirects to https://example.go.link/summer-clothes?promo=beach&adj_t=abc123. The link resolution method returns the resolved URL. Your app handles the returned URL and calls the ProcessDeeplink method in the Adjust SDK with the returned URL.

URL shorteners

When marketers run certain types of campaigns, sometimes a short URL is required. For example, SMS has a 160 character limit. Sometimes, customers want to shorten a link and share it on team communication platforms, such as Slack. However, if the short URL redirects to a universal link, iOS doesn't resolve the universal link.

Example: A marketer creates a universal link:

https://example.go.link/summer-clothes?promo=beach&adj_t=abc123

The marketer uses a URL shortener service to generate a shortened link:

https://short.example.com/2wuTnQvU

A user, who has your app installed, clicks on the short URL in the SMS message. iOS opens your app and passes the short URL to your app. Your app passes the short URL to the link resolution method in the Adjust SDK. The Adjust SDK resolves the short URL from within your app, so https://short.example.com/2wuTnQvU redirects to https://example.go.link/summer-clothes?promo=beach&adj_t=abc123. The link resolution method returns the resolved URL. Your app handles the returned URL and calls the ProcessDeeplink method in the Adjust SDK with the returned URL.

Setup

To resolve a link, call the ResolveLink method of the UAdjust class with the URL you want to resolve and an array of URL suffixes to match against.

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void ResolveLink(const FString& Url, const TArray<FString>& ResolveUrlSuffixArray);

Before making this call, you need to assign a callback method to the instance of UAdjustDelegates class:

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnLinkResolutionDelegate, const FString&, ResolvedLink);

// ...

UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = Adjust)
FOnLinkResolutionDelegate OnLinkResolutionDelegate;

Example: Email marketing

TArray<FString> ResolveUrlSuffixArray;
ResolveUrlSuffixArray.Add(TEXT("email.example.com"));
UAdjust::ResolveLink(TEXT("https://email.example.com/2wuTnQvU"), ResolveUrlSuffixArray);

Example: URL shorteners

TArray<FString> ResolveUrlSuffixArray;
ResolveUrlSuffixArray.Add(TEXT("short.example.com"));
UAdjust::ResolveLink(TEXT("https://short.example.com/2wuTnQvU"), ResolveUrlSuffixArray);

After receiving the resolved link in the callback, your app should call ProcessDeeplink with the resolved URL:

void AYourGameMode::OnLinkResolved(const FString& ResolvedLink)
{
    if (!ResolvedLink.IsEmpty())
    {
        FAdjustDeeplink adjustDeeplink;
        adjustDeeplink.Deeplink = ResolvedLink;
        UAdjust::ProcessDeeplink(adjustDeeplink);
    }
}

Note: For more detailed information on this topic in iOS and Android, check native guides: iOS and Android.

Get last deeplink

You can retrieve the last processed deeplink at any time. Call the GetLastDeeplink method of the UAdjust class to return the last deeplink as a string.

Before making this call, you need to assign a callback method to the instance of UAdjustDelegates class:

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

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnLastDeeplinkGetterDelegate, const FString&, LastDeeplink);

// ...

UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = Adjust)
FOnLastDeeplinkGetterDelegate OnLastDeeplinkGetterDelegate;

Handling deeplinks with referrer

An optional referrer URL can be used to track the source of the deeplink or app open for better attribution or reattribution and deep linking. For example, channels like SEO / Organic Search, Adjust links are not directly used. If the client's root domain has Android App Links implemented and triggers an app opening, for such channels, we may have to rely on signals coming from the referrer URL to attribute or reattribute users.

If your app is able to obtain this information internally, you can pass the referrer information to the SDK by setting the Referrer property of your FAdjustDeeplink structure instance:

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

FAdjustDeeplink adjustDeeplink;
adjustDeeplink.Deeplink = TEXT("your-app-scheme://deep-link-content");
adjustDeeplink.Referrer = TEXT("https://example.com/referrer");
UAdjust::ProcessDeeplink(adjustDeeplink);

App Tracking Transparency

Note: This feature is iOS only.

If you want to record the device's ID for Advertisers (IDFA), you must display a prompt to get your user's authorization. To do this, you need to include Apple's App Tracking Transparency (ATT) framework in your app. The Adjust SDK stores the user's authorization status and sends it to Adjust's servers with each request.

Below, you can find the list of possible ATT status values:

Status	Code	Description
`ATTrackingManagerAuthorizationStatusNotDetermined`	`0`	The user hasn’t responded to the access prompt yet
`ATTrackingManagerAuthorizationStatusRestricted`	`1`	Access to app-related data is blocked at the device level
`ATTrackingManagerAuthorizationStatusDenied`	`2`	The user has denied access to app-related data for device measurement
`ATTrackingManagerAuthorizationStatusAuthorized`	`3`	The user has approved access to app-related data for device measurement

Note: You might receive a status code of -1 if the SDK is unable to retrieve the ATT (App Tracking Transparency) status.

ATT authorization wrapper

Note: This feature is iOS only.

The Adjust SDK contains a wrapper around Apple's requestTrackingAuthorizationWithCompletionHandler: method. You can use this wrapper if you don't want to use the ATT prompt.

The callback method triggers when your user responds to the consent dialog. This method sends the user’s consent status code to Adjust’s servers. You can define responses to each status code within the callback function.

You must specify text content for the ATT. To do this, add your text to the NSUserTrackingUsageDescription key in your Info.plist file.

 <key>NSUserTrackingUsageDescription</key>
 <string>Your custom message explaining why is access to IDFA necessary.</string>

You can trigger ATT prompt via Adjust SDK wrapper method like described below.

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

UAdjust::RequestAppTrackingAuthorization();

In order to obtain the ATT prompt response, you need to define a callback method and set it on UAdjustDelegates object before invoking the RequestAppTrackingAuthorization method.

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnRequestTrackingAuthorizationDelegate, const int, AuthorizationStatus);

// ...

UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = Adjust)
FOnRequestTrackingAuthorizationDelegate OnRequestTrackingAuthorizationDelegate;

Get current authorization status

You can retrieve a user’s current authorization status at any time. Call the GetAppTrackingAuthorizationStatus method to return the authorization status and make sure to set the callback method on UAdjustDelegates object before you make this call.

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

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnAuthorizationStatusGetterDelegate, const int, AuthorizationStatus);

// ...

UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = Adjust)
FOnAuthorizationStatusGetterDelegate OnAuthorizationStatusGetterDelegate;

ATT prompt waiting interval

If your app includes an onboarding process or a tutorial, you may want to delay sending your user's ATT consent status until after the user has completed this process. To do this, you can set the AttConsentWaitingInterval method of your FAdjustConfig structure to delay the sending of data for up to 360 seconds to give the user time to complete the initial onboarding. After the timeout ends or the user sets their consent status, the SDK sends all information it has recorded during the delay to Adjust's servers along with the user's consent status.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
int AttConsentWaitingInterval = 0;

Disable the usage of App Tracking Transparency

Note: This feature is iOS only.

In case you want to disable Adjust SDK's automatic interaction with AppTrackingTransparency.framework, you need to set the IsAppTrackingTransparencyUsageEnabled property on your FAdjustConfig structure instance to false before SDK initialization.

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

Note: Even with this setup, the SDK will still allow you to use RequestAppTrackingAuthorization and GetAppTrackingAuthorizationStatus methods.

SKAdNetwork and conversion values

Important: This feature is only available on devices running iOS 14 and above.

SKAdNetwork is Apple’s attribution framework for app install and reinstall attribution. The SKAdNetwork workflow goes like this:

Apple gathers attribution information and notifies the relevant ad network.
The network sends a postback with this information to Adjust.
Adjust displays SKAdNetwork data in Datascape.

Disable SKAdNetwork communication

The Adjust SDK communicates with SKAdNetwork by default. The SDK registers for SKAdNetwork attribution upon initialization.

You can change this behavior by setting the IsSkanAttributionEnabled field of your FAdjustConfig structure to false.

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

Set up direct install postbacks

Note: Direct install postbacks contain only SKAdNetwork information. Information such as campaign data isn't included in these postbacks.

You can configure your app to send a copy of winning SKAdNetwork callbacks to Adjust. This enables you to use SKAdNetwork information in your analytics.

To set up direct install postbacks, you need to add the Adjust callback URL to your Info.plist file:

<key>NSAdvertisingAttributionReportEndpoint</key>
<string>https://adjust-skadnetwork.com</string>

See also: See Apple's guide on Configuring an Advertised App for more information.

SKAdNetwork conversion value updated callback

Note: This feature is iOS only.

You can register a callback to be notified whenever the Adjust SDK updates the SKAdNetwork conversion value. This callback provides a dictionary containing the conversion value data set by the SDK and any possible API invocation errors.

The dictionary may contain the following keys:

conversion_value: The conversion value that was set by the Adjust SDK
coarse_value: The coarse value that was set by the Adjust SDK
lock_window: Whether the postback will be sent before the conversion window ends
error: Any error that occurred during the conversion value update

You can use this callback even while using pre 4.0 SKAdNetwork. In that case, the dictionary will contain only the conversion_value key.

To implement the callback, bind to the OnSkanConversionValueUpdatedDelegate on your UAdjustDelegates instance:

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnSkanConversionValueUpdatedDelegate, const FAdjustSkanConversionDataMap&, ConversionData);

// ...

UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = Adjust)
FOnSkanConversionValueUpdatedDelegate OnSkanConversionValueUpdatedDelegate;

The FAdjustSkanConversionDataMap struct contains a Data property of type TMap<FString, FString> which holds the conversion value data dictionary.

Example implementation:

void AMyGameMode::OnSkanConversionValueUpdated(const FAdjustSkanConversionDataMap& ConversionData)
{
    for (const auto& Pair : ConversionData.Data)
    {
        UE_LOG(LogTemp, Log, TEXT("SKAN Conversion Data - %s: %s"), *Pair.Key, *Pair.Value);
    }
}

// In BeginPlay or similar:
AdjustDelegatesInstance->OnSkanConversionValueUpdatedDelegate.AddDynamic(this, &AMyGameMode::OnSkanConversionValueUpdated);

Record ad revenue information

You can record ad revenue for supported network partners using the Adjust SDK.

Important: You need to perform some extra setup steps in your Adjust dashboard to measure ad revenue. Contact your Technical Account Manager or [email protected] to get started.

To send ad revenue information with the Adjust SDK, you need to instantiate an FAdjustAdRevenue structure. This structure contains variables that are sent to Adjust when ad revenue is recorded in your app.

You can set the following parameters:

Source: The source of the ad revenue. This parameter is mandatory. See the table below for available sources.

Argument	Ad revenue Source
`"applovin_max_sdk"`	AppLovin MAX
`"admob_sdk"`	AdMob
`"ironsource_sdk"`	ironSource
`"admost_sdk"`	AdMost
`"unity_sdk"`	Unity
`"helium_chartboost_sdk"`	Helium Chartboost
`"adx_sdk"`	Ad(X)
`"tradplus_sdk"`	TradPlus
`"topon_sdk"`	TopOn
`"publisher_sdk"`	Generic source

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

Ad revenue amount

To send the ad revenue amount, set the Revenue and Currency fields of your FAdjustAdRevenue structure:

Revenue: The amount of revenue
Currency: The 3 character ISO 4217 code of your reporting currency

See also: Check the guide to recording purchases in different currencies for more information.

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

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

Ad revenue network

To record the network associated with the ad revenue, set AdRevenueNetwork field of your FAdjustAdRevenue structure with the network name.

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

Ad revenue unit

To send the ad revenue unit, set AdRevenueUnit field of your FAdjustAdRevenue structure with the unit value.

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

Ad revenue placement

To send the ad revenue placement, set AdRevenuePlacement field of your FAdjustAdRevenue structure with the placement value.

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

Ad impressions count

To send the number of recorded ad impressions, set AdImpressionsCount field of your FAdjustAdRevenue structure with the number of ad impressions.

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
int AdImpressionsCount = 0;

Ad revenue callback parameters

Similar to how one can set event callback parameters, the same can be done for ad revenue:

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

Ad revenue partner parameters

Similar to how one can set event partner parameters, the same can be done for ad revenue:

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

Device IDs

The Adjust SDK contains helper methods that return device information. Use these methods to add details to your callbacks and improve your reporting.

IDFA

To obtain the IDFA, call the function GetIdfa of the UAdjust class. You need to set callback method on the UAdjustDelegates object where the IDFA value will be delivered to.

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

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnIdfaGetterDelegate, const FString&, Idfa);

// ...

UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = Adjust)
FOnIdfaGetterDelegate OnIdfaGetterDelegate;

IDFV

To obtain the IDFV, call the function GetIdfv of the UAdjust class. You need to set callback method on the UAdjustDelegates object where the IDFV value will be delivered to.

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

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnIdfvGetterDelegate, const FString&, Idfv);

// ...

UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = Adjust)
FOnIdfvGetterDelegate OnIdfvGetterDelegate;

Google advertising identifier

To obtain Google advertising ID, call the function GetGoogleAdId of the UAdjust class. You need to set callback method on the UAdjustDelegates object where the Google advertising ID value will be delivered to.

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

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnGoogleAdIdGetterDelegate, const FString&, GoogleAdId);

// ...

UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = Adjust)
FOnGoogleAdIdGetterDelegate OnGoogleAdIdGetterDelegate;

Amazon advertising identifier

If you need to obtain the Amazon advertising ID, you can call the GetAmazonAdId method of the UAdjust class. You need to set callback method on the UAdjustDelegates object where the Amazon advertising ID value will be delivered to.

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

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnAmazonAdIdGetterDelegate, const FString&, AmazonAdId);

// ...

UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = Adjust)
FOnAmazonAdIdGetterDelegate OnAmazonAdIdGetterDelegate;

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, you can make a call to GetAdid method of the UAdjust class. You need to set callback method on the UAdjustDelegates object where the Adjust device ID value will be delivered to.

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

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnAdidGetterDelegate, const FString&, Adid);

// ...

UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = Adjust)
FOnAdidGetterDelegate OnAdidGetterDelegate;

Note: Information about the adid is available after app installation has been recorded 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 initialised and installation of your app has been successfully recorded.

Session and event callbacks

You can register a callback to be notified of successful and failed recorded 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 the SDK

You can disable the Adjust SDK from recording any activity by invoking the method Disable of the UAdjust class. This setting is remembered between sessions.

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

You can verify if the Adjust SDK is currently active with the method IsEnabled of the UAdjust class. To obtain this value, you need to define callback on the UAdjustDelegates object to obtain it.

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

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnIsEnabledGetterDelegate, bool, IsEnabled);

// ...

UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = Adjust)
FOnIsEnabledGetterDelegate OnIsEnabledGetterDelegate;

It is always possible to activate the Adjust SDK by invoking Enable method of the UAdjust class.

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

Offline mode

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

You can activate offline mode by calling the method WwitchToOfflineMode of the UAdjust class.

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

Conversely, you can deactivate the offline mode by calling SwitchBackToOnlineMode method of the UAdjust class.

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

When the Adjust SDK is put back in online mode, all saved information is sent to our servers with the correct timestamps.

Unlike disabling the SDK, 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.

Sending from background

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 FAdjustConfig structure by setting the IsSendingInBackgroundEnabled field to true.

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

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

Set external device ID

Note If you want to use external device IDs, please contact your Adjust representative. They will talk you through the best approach for your use case.

An external device identifier is a custom value that you can assign to a device or user. They can help you to recognize users across sessions and platforms. They can also help you to deduplicate installs by user so that a user isn't counted as multiple new installs.

You can also use an external device ID as a custom identifier for a device. This can be useful if you use these identifiers elsewhere and want to keep continuity.

Check out our external device identifiers article for more information.

To set an external device ID, assign the identifier to the ExternalDeviceId field of your FAdjustConfig structure. Do this before you initialize the Adjust SDK.

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

Important: You need to make sure this ID is unique to the user or device depending on your use-case. Using the same ID across different users or devices could lead to duplicated data. Talk to your Adjust representative for more information.

If you want to use the external device ID in your business analytics, you can pass it as a session callback parameter. See the section on session callback parameters for more information.

You can import existing external device IDs into Adjust. This ensures that the backend matches future data to your existing device records. If you want to do this, please contact your Adjust representative.

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:

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

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

Disable AdServices information reading

Note: This feature is iOS only.

The SDK is enabled by default to try to communicate with AdServices.framework on iOS in order to try to obtain attribution token which is later being used for handling Apple Search Ads attribution. In case you would not like Adjust to show information from Apple Search Ads campaigns, you can disable this in the SDK by setting IsAdServicesEnabled field of your FAdjustConfig structure to false:

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

First session delay

The First Session Delay feature allows you to delay SDK initialization during the very first SDK session only. While in this delay mode, the Adjust SDK records all activity (such as installs and events) in memory, but does not transmit any data to Adjust servers.

This gives your app an opportunity to gather additional data that may not be available at launch and, if needed, modify the SDK configuration before any data is sent. Once the delay ends, SDK will apply all the settings configured during the delay before tracking an install.

When and why to use first session delay

Use this feature if you need to:

Show the App Tracking Transparency (ATT) dialog and act on the user's response.
Set third-party sharing settings.
Set DMA consent parameters.
Set COPPA compliance for the user.
Indicate that the user falls under the Play Store's "Designed for Families" (kids) category.
Assign an external device ID.
Set consent measurement for specific users.
Set global partner or callback parameters.

Note: This feature can effectively replace the ATT waiting interval. If both are used in parallel, the first session delay takes precedence, and the ATT waiting interval will be ignored.

Enabling first session delay

To initialize the SDK in delayed mode, set the IsFirstSessionDelayEnabled property to true on your FAdjustConfig structure instance before SDK initialization:

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

FAdjustConfig adjustConfig;
adjustConfig.AppToken = TEXT("{YourAppToken}");
adjustConfig.Environment = EAdjustEnvironment::Sandbox;
adjustConfig.IsFirstSessionDelayEnabled = true;

UAdjust::InitSdk(adjustConfig);

After this, the SDK will be initialized in memory and will not process anything until you explicitly call:

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

Note: The delay only occurs during the install session of the SDK (i.e., the first-ever SDK initialization). The delay will end only when EndFirstSessionDelay is called. If it is not called during the app's runtime, any delayed calls will be lost upon app restart. The next SDK initialization will then be treated as a first session again, and the SDK will initialize in delayed mode once more. Once the delay has ended or is no longer applicable (e.g., in subsequent sessions), any attempts to call EndFirstSessionDelay will be ignored.

Configuration changing while on delay

While the SDK is in first session delay mode, it is possible to change various SDK settings as if they were set in the config during InitSdk:

Enable COPPA compliance:

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

Disable COPPA compliance:

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

Enable Play Store kids compliance:

Note: This feature is Android only.

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

Disable Play Store kids compliance:

Note: This feature is Android only.

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

Set external device ID:

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void SetExternalDeviceIdInDelay(const FString& ExternalDeviceId);

Note: Similar to the methods for configuring and ending the first session delay, once the delay has ended or is no longer applicable (e.g., in subsequent sessions), any calls to methods that allow configuration changes during the delay will be ignored.

Store information

You can use the Adjust SDK to record information about the store from which an app was installed on a user's device. Adjust supports a predefined list of store types.

To configure store information, set the StoreInfo property on your FAdjustConfig structure instance before SDK initialization:

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
FAdjustStoreInfo StoreInfo;

The FAdjustStoreInfo structure contains the following properties:

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

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

URL strategy and data residency

The URL strategy feature allows you to set either:

The country in which Adjust stores your data (data residency).
The endpoint to which the Adjust SDK sends traffic (URL strategy).

This is useful if you're operating in a country with strict privacy requirements. When you set your URL strategy, Adjust stores data in the selected data residency region or sends traffic to the chosen domain.

To set your URL strategy, configure the following properties on your FAdjustConfig structure instance before SDK initialization:

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Adjust")
TArray<FString> UrlStrategyDomains;

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

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

UrlStrategyDomains (TArray<FString>): The country or countries of data residence, or the endpoints to which you want to send SDK traffic.
ShouldUseSubdomains (bool): Whether the domain should be treated as an Adjust domain. If true, the SDK will prefix the domains with Adjust-specific subdomains. If false, the SDK will use the provided domain as-is, without adding any prefixes.
IsDataResidency (bool): Whether the domain should be used for data residency.

The following table shows all available URL strategy and data residency configurations:

Strategy	Main and fallback domain	Use subdomains	Is data residency
EU data residency	`eu.adjust.com`	`true`	`true`
Turkish data residency	`tr.adjust.com`	`true`	`true`
US data residency	`us.adjust.com`	`true`	`true`
China global URL strategy	`adjust.world`, `adjust.com`	`true`	`false`
China URL strategy	`adjust.cn`, `adjust.com`	`true`	`false`
China only URL strategy	`adjust.cn`	`true`	`false`
India URL strategy	`adjust.net.in`, `adjust.com`	`true`	`false`

Example: EU data residency

FAdjustConfig adjustConfig;
adjustConfig.UrlStrategyDomains.Add(TEXT("eu.adjust.com"));
adjustConfig.ShouldUseSubdomains = true;
adjustConfig.IsDataResidency = true;

Example: Turkish data residency

FAdjustConfig adjustConfig;
adjustConfig.UrlStrategyDomains.Add(TEXT("tr.adjust.com"));
adjustConfig.ShouldUseSubdomains = true;
adjustConfig.IsDataResidency = true;

Example: US data residency

FAdjustConfig adjustConfig;
adjustConfig.UrlStrategyDomains.Add(TEXT("us.adjust.com"));
adjustConfig.ShouldUseSubdomains = true;
adjustConfig.IsDataResidency = true;

Example: China global URL strategy

FAdjustConfig adjustConfig;
adjustConfig.UrlStrategyDomains.Add(TEXT("adjust.world"));
adjustConfig.UrlStrategyDomains.Add(TEXT("adjust.com"));
adjustConfig.ShouldUseSubdomains = true;
adjustConfig.IsDataResidency = false;

Example: China URL strategy

FAdjustConfig adjustConfig;
adjustConfig.UrlStrategyDomains.Add(TEXT("adjust.cn"));
adjustConfig.UrlStrategyDomains.Add(TEXT("adjust.com"));
adjustConfig.ShouldUseSubdomains = true;
adjustConfig.IsDataResidency = false;

Example: China only URL strategy

FAdjustConfig adjustConfig;
adjustConfig.UrlStrategyDomains.Add(TEXT("adjust.cn"));
adjustConfig.ShouldUseSubdomains = true;
adjustConfig.IsDataResidency = false;

Example: India URL strategy

FAdjustConfig adjustConfig;
adjustConfig.UrlStrategyDomains.Add(TEXT("adjust.net.in"));
adjustConfig.UrlStrategyDomains.Add(TEXT("adjust.com"));
adjustConfig.ShouldUseSubdomains = true;
adjustConfig.IsDataResidency = false;

Facebook App ID

Note: This feature is Android only.

You can set the Facebook App ID by setting the FbAppId property on your FAdjustConfig structure instance before SDK initialization:

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

Purchase verification

If you've enabled purchase verification, you can use the Adjust SDK to request purchase verification. There are two ways to verify purchases with the Adjust SDK:

Create an FAdjustEvent object that represents your purchase and configure purchase properties for the target store.
Create an FAdjustAppStorePurchase (Apple App Store) or FAdjustPlayStorePurchase (Google Play Store) object representing the purchase.

Tip: If you use revenue events to measure your purchases in Adjust, you should use the FAdjustEvent class. If you only want to verify a purchase but don't want to associate it with an event, use the FAdjustAppStorePurchase or FAdjustPlayStorePurchase class.

When you send purchase information with the Adjust SDK, Adjust does the following:

Sends the information to the relevant store and waits for a status response.
Forwards the status response to the Adjust SDK.

You can access the purchase verification status by using a callback. Results are returned as FAdjustPurchaseVerificationResult objects containing the following properties:

VerificationStatus (FString): The status of the purchase.
Code (int): The status code of the purchase.
Message (FString): Any message returned by the store.

Verify purchase and record event

To send a revenue event for verification and listen for the purchase verification status, follow these steps:

For App Store:

Instantiate an FAdjustEvent object with your event token and set the following parameters:
- ProductId (FString): The product identifier of the item that was successfully purchased.
- TransactionId (FString): The ID of the transaction you want to verify.
Call the VerifyAndTrackAppStorePurchase method with your event object.

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void VerifyAndTrackAppStorePurchase(const FAdjustEvent& Event);

For Play Store:

Instantiate an FAdjustEvent object with your event token and set the following parameters:
- ProductId (FString): The ID of the product that has been purchased.
- PurchaseToken (FString): The purchase token associated with the purchase.
Call the VerifyAndTrackPlayStorePurchase method with your event object.

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void VerifyAndTrackPlayStorePurchase(const FAdjustEvent& Event);

Before making these calls, you need to assign a callback method to the instance of UAdjustDelegates class:

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnPurchaseVerificationFinishedDelegate, const FAdjustPurchaseVerificationResult&, VerificationResult);

// ...

UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = Adjust)
FOnPurchaseVerificationFinishedDelegate OnPurchaseVerificationFinishedDelegate;

Only verify purchase

To send a standalone purchase and listen for the purchase verification status, follow these steps:

For App Store:

Instantiate an FAdjustAppStorePurchase object with the following arguments:
- ProductId (FString): The product identifier of the item that was successfully purchased.
- TransactionId (FString): The ID of the transaction you want to verify.
Call the VerifyAppStorePurchase method with your purchase object.

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void VerifyAppStorePurchase(const FAdjustAppStorePurchase& Purchase);

For Play Store:

Instantiate an FAdjustPlayStorePurchase object with the following arguments:
- ProductId (FString): The ID of the product that has been purchased.
- PurchaseToken (FString): The purchase token associated with the purchase.
Call the VerifyPlayStorePurchase method with your purchase object.

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void VerifyPlayStorePurchase(const FAdjustPlayStorePurchase& Purchase);

The same callback delegate (OnPurchaseVerificationFinishedDelegate) is used for both methods.

Subscription tracking

Important: The following steps only set up subscription measurement within the Adjust SDK. To enable the feature, follow the steps at Set up subscriptions for your app.

You can record App Store and Play Store subscriptions with the Adjust SDK. After the user purchases a subscription, create an FAdjustAppStoreSubscription or FAdjustPlayStoreSubscription instance containing the details.

App Store subscription

Create an FAdjustAppStoreSubscription object with the following properties:

Price (double): The price of the subscription.
Currency (FString): The currency of the subscription.
TransactionId (FString): Your ID for the transaction.
TransactionDate (FString): The date on which the user purchased a subscription (Unix timestamp string). This field is optional.
SalesRegion (FString): The region in which the user purchased a subscription (country code). This field is optional.
CallbackParameters (TMap<FString, FString>): Callback parameters to append to your callback URL.
PartnerParameters (TMap<FString, FString>): Partner parameters to send to network partners.

FAdjustAppStoreSubscription Subscription;
Subscription.Price = 9.99;
Subscription.Currency = TEXT("USD");
Subscription.TransactionId = TEXT("transaction-id");
Subscription.TransactionDate = TEXT("1234567890");
Subscription.SalesRegion = TEXT("US");
Subscription.CallbackParameters.Add(TEXT("key1"), TEXT("value1"));
Subscription.PartnerParameters.Add(TEXT("key1"), TEXT("value1"));

UAdjust::TrackAppStoreSubscription(Subscription);

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void TrackAppStoreSubscription(const FAdjustAppStoreSubscription& Subscription);

Play Store subscription

Create an FAdjustPlayStoreSubscription object with the following properties:

Price (int64): The price of the subscription (in micros).
Currency (FString): The currency of the subscription.
Sku (FString): The ID of the product.
OrderId (FString): Your ID for the transaction.
Signature (FString): The signature of the purchase data.
PurchaseToken (FString): The unique token of the transaction.
PurchaseTime (int64): The date on which the user purchased a subscription (Unix timestamp in milliseconds). This field is optional.
CallbackParameters (TMap<FString, FString>): Callback parameters to append to your callback URL.
PartnerParameters (TMap<FString, FString>): Partner parameters to send to network partners.

FAdjustPlayStoreSubscription Subscription;
Subscription.Price = 9990000; // 9.99 in micros
Subscription.Currency = TEXT("USD");
Subscription.Sku = TEXT("sku-id");
Subscription.OrderId = TEXT("order-id");
Subscription.Signature = TEXT("signature");
Subscription.PurchaseToken = TEXT("purchase-token");
Subscription.PurchaseTime = 1234567890000;
Subscription.CallbackParameters.Add(TEXT("key1"), TEXT("value1"));
Subscription.PartnerParameters.Add(TEXT("key1"), TEXT("value1"));

UAdjust::TrackPlayStoreSubscription(Subscription);

UFUNCTION(BlueprintCallable, Category = "Adjust")
static void TrackPlayStoreSubscription(const FAdjustPlayStoreSubscription& Subscription);

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.

Name		Name	Last commit message	Last commit date
Latest commit History 97 Commits
Adjust		Adjust
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
MIGRATION.md		MIGRATION.md
README.md		README.md
VERSION		VERSION

adjust/unreal_sdk

Folders and files

Latest commit

History

Repository files navigation

Summary

Table of contents

Basic integration

Get the SDK

Add the SDK to your project

Integrate the SDK into your app

Adjust logging

Additional features

Send event information

Event revenue

Event deduplication

Event callback identifier

Event callback parameters

Event partner parameters

User attribution

Attribution callback

Get user attribution

Preinstalled apps

Preinstall tracking

Default link token

Global parameters

Global callback parameters

Session callback parameters

Global partner parameters

Privacy features

GDPR right to be forgotten

Third-party sharing for specific users

Disable third-party sharing for specific users

Consent measurement for specific users

COPPA compliance

Play Store kids apps

Deep linking

Standard deep linking scenario

Deferred deep linking scenario

Reattribution via deep links

Resolve Adjust short links

Link resolution

How it works

Use cases

Email marketing

URL shorteners

Setup

Get last deeplink

Handling deeplinks with referrer

App Tracking Transparency

ATT authorization wrapper

Get current authorization status

ATT prompt waiting interval

Disable the usage of App Tracking Transparency

SKAdNetwork and conversion values

Disable SKAdNetwork communication

Set up direct install postbacks

SKAdNetwork conversion value updated callback

Record ad revenue information

Ad revenue amount

Ad revenue network

Ad revenue unit

Ad revenue placement

Ad impressions count

Ad revenue callback parameters

Ad revenue partner parameters

Device IDs

IDFA

IDFV

Google advertising identifier

Amazon advertising identifier

Adjust device identifier

Session and event callbacks

Disable the SDK

Offline mode

Sending from background

Set external device ID

Push token

Disable AdServices information reading

First session delay