Privacy features

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

Send erasure request

public static void gdprForgetMe(final Context context)

The EU’s General Data Protection Regulation (GDPR) and similar privacy laws worldwide (CCPA, LGPD, etc.) grant data subjects comprehensive rights when it comes to the processing of their personal data. These rights include, among others, the right to erasure (see Art. 17 GDPR)(1). As a data processor, Adjust is obliged to support you (the data controller) in the processing of such requests from your (app) users.

You can send the user’s erasure request to Adjust by calling the gdprForgetMe method. Once Adjust has been notified:

Adjust will permanently delete all of the user’s historical personal data from its internal systems and database.
Adjust will no longer receive data from this user/device via the Adjust SDK.(2)

Kotlin
Java

1
Adjust.gdprForgetMe()

1
Adjust.gdprForgetMe();

You can use the Adjust SDK to record when a user changes their third-party sharing settings. Third party sharing settings are configured using the AdjustThirdPartySharing class.

Instantiate an AdjustThirdPartySharing object

public AdjustThirdPartySharing(final Boolean isEnabled)

To enable or disable third party sharing with the Adjust SDK, you need to instantiate an AdjustThirdPartySharing object. This object contains variables that control how third party sharing is handled by Adjust.

To instantiate a third party sharing object, create a new AdjustThirdPartySharing instance and pass the following parameters:

isEnabled (Boolean): Whether third party sharing is enabled. Pass true to enable third party sharing or false to disable third party sharing

1
val adjustThirdPartySharing = AdjustThirdPartySharing(true)
2
Adjust.trackThirdPartySharing(adjustThirdPartySharing)

1
AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true);
2
Adjust.trackThirdPartySharing(adjustThirdPartySharing);

1
let adjustThirdPartySharing = new AdjustThirdPartySharing(true);
2
Adjust.trackThirdPartySharing(adjustThirdPartySharing);

Once you’ve instantiated your AdjustThirdPartySharing object, you can send the information to Adjust by calling the Adjust.trackThirdPartySharing method with your AdjustThirdPartySharing instance as an argument.

1
val adjustThirdPartySharing = AdjustThirdPartySharing(true)
2
Adjust.trackThirdPartySharing(adjustThirdPartySharing)

1
AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true);
2
Adjust.trackThirdPartySharing(adjustThirdPartySharing);

1
let adjustThirdPartySharing = new AdjustThirdPartySharing(true);
2
Adjust.trackThirdPartySharing(adjustThirdPartySharing);

Send granular information

public void addGranularOption(final String partnerName,
                              final String key,
                              final String value)

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 addGranularOption method with the following parameters:

partnerName (String): The name of the partner for whom the granular option applies.
key (String): The option key.
value (String): The option value.

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`

1
val adjustThirdPartySharing = AdjustThirdPartySharing(true)
2
adjustThirdPartySharing.addGranularOption("PartnerA", "foo", "bar")
3
Adjust.trackThirdPartySharing(adjustThirdPartySharing)

1
AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true);
2
adjustThirdPartySharing.addGranularOption("PartnerA", "foo", "bar");
3
Adjust.trackThirdPartySharing(adjustThirdPartySharing);

1
let adjustThirdPartySharing = new AdjustThirdPartySharing(true);
2
adjustThirdPartySharing.addGranularOption("PartnerA", "foo", "bar");
3
Adjust.trackThirdPartySharing(adjustThirdPartySharing);

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 the following arguments to the addGranularOption method:

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

1
val adjustThirdPartySharing = AdjustThirdPartySharing(true)
2
adjustThirdPartySharing.addGranularOption("facebook", "data_processing_options_country", "1")
3
adjustThirdPartySharing.addGranularOption("facebook", "data_processing_options_state", "1000")
4
Adjust.trackThirdPartySharing(adjustThirdPartySharing)

1
AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true);
2
adjustThirdPartySharing.addGranularOption("facebook", "data_processing_options_country", "1");
3
adjustThirdPartySharing.addGranularOption("facebook", "data_processing_options_state", "1000");
4
Adjust.trackThirdPartySharing(adjustThirdPartySharing);

1
let adjustThirdPartySharing = new AdjustThirdPartySharing(true);
2
adjustThirdPartySharing.addGranularOption(
3
   "facebook",
4
   "data_processing_options_country",
5
   "1",
6
);
7
adjustThirdPartySharing.addGranularOption(
8
   "facebook",
9
   "data_processing_options_state",
10
   "1000",
11
);
12
Adjust.trackThirdPartySharing(adjustThirdPartySharing);

Added in v4.26.0

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

1
val adjustThirdPartySharing = AdjustThirdPartySharing(true)
2
adjustThirdPartySharing.addGranularOption("google_dma", "eea", "1");
3
adjustThirdPartySharing.addGranularOption("google_dma", "ad_personalization", "1");
4
adjustThirdPartySharing.addGranularOption("google_dma", "ad_user_data", "1");
5
Adjust.trackThirdPartySharing(adjustThirdPartySharing)

1
AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(null);
2
adjustThirdPartySharing.addGranularOption("google_dma", "eea", "1");
3
adjustThirdPartySharing.addGranularOption("google_dma", "ad_personalization", "1");
4
adjustThirdPartySharing.addGranularOption("google_dma", "ad_user_data", "1");
5
Adjust.trackThirdPartySharing(adjustThirdPartySharing);

1
let adjustThirdPartySharing = new AdjustThirdPartySharing(true);
2
adjustThirdPartySharing.addGranularOption("google_dma", "eea", "1");
3
adjustThirdPartySharing.addGranularOption(
4
   "google_dma",
5
   "ad_personalization",
6
   "1",
7
);
8
adjustThirdPartySharing.addGranularOption("google_dma", "ad_user_data", "1");
9
Adjust.trackThirdPartySharing(adjustThirdPartySharing);

Update partner sharing settings

public void addPartnerSharingSetting(final String partnerName,
                                     final String key,
                                     final boolean value)

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 addPartnerSharingSetting method with the following arguments:

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.

Examples

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

Kotlin
Java

1
val adjustThirdPartySharing = AdjustThirdPartySharing(true)
2
adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "all", false)
3
Adjust.trackThirdPartySharing(adjustThirdPartySharing)

1
AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true);
2
adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "all", false);
3
Adjust.trackThirdPartySharing(adjustThirdPartySharing);

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

Kotlin
Java

1
val adjustThirdPartySharing = AdjustThirdPartySharing(true)
2
adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "all", true)
3
Adjust.trackThirdPartySharing(adjustThirdPartySharing)

1
AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true);
2
adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "all", true);
3
Adjust.trackThirdPartySharing(adjustThirdPartySharing);

You can stop or start sharing specific metrics by calling the addPartnerSharingSetting 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

Kotlin
Java

1
val adjustThirdPartySharing = AdjustThirdPartySharing(true)
2
adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "all", false)
3
adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "event", true)
4
Adjust.trackThirdPartySharing(adjustThirdPartySharing)

1
AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true);
2
adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "all", false);
3
adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "event", true);
4
Adjust.trackThirdPartySharing(adjustThirdPartySharing);

public static void disableThirdPartySharing(final Context context)

To disable third-party sharing for all users, call the disableThirdPartySharing method. When Adjust’s servers receive this information, Adjust stops sharing the user’s data with third parties. The Adjust SDK continues to work as expected.

1
Adjust.disableThirdPartySharing()

1
Adjust.disableThirdPartySharing();

1
Adjust.disableThirdPartySharing();

Set URL strategy

public void setUrlStrategy(String urlStrategy)

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 country of data residency, call the setUrlStrategy method on your AdjustConfig instance with the following parameter:

urlStrategy (String): The country of data residence or endpoint to which you want to send SDK traffic.

Value	Description
`AdjustConfig.DATA_RESIDENCY_EU`	Sets the area of data residency to the EU
`AdjustConfig.DATA_RESIDENCY_TR`	Sets the area of data residency to Turkey
`AdjustConfig.DATA_RESIDENCY_US`	Sets the area of data residency to the USA
`URL_STRATEGY_CHINA`	Points the URL strategy to the `app.adjust.world` domain
`URL_STRATEGY_CN`	Points the URL strategy to the `app.adjust.cn` domain
`URL_STRATEGY_CN_ONLY`	Points the URL strategy to the `app.adjust.cn` domain but doesn’t fall back to another domain if the request fails.
`URL_STRATEGY_INDIA`	Points the URL strategy to the `app.adjust.net.in` domain

1
val appToken = "{YourAppToken}"
2
val environment = AdjustConfig.ENVIRONMENT_SANDBOX
3
val config = AdjustConfig(this, appToken, environment)
4
config.setUrlStrategy(AdjustConfig.DATA_RESIDENCY_EU)
5
//...
6
Adjust.onCreate(config)

1
String appToken = "{YourAppToken}";
2
String environment = AdjustConfig.ENVIRONMENT_SANDBOX;
3
AdjustConfig config = new AdjustConfig(this, appToken, environment);
4
config.setUrlStrategy(AdjustConfig.DATA_RESIDENCY_EU);
5
//...
6
Adjust.onCreate(config);

1
var yourAppToken = yourAppToken;
2
var environment = AdjustConfig.EnvironmentSandbox;
3
var adjustConfig = new AdjustConfig(yourAppToken, environment);
4
adjustConfig.setUrlStrategy(AdjustConfig.DATA_RESIDENCY_EU);

public static void trackMeasurementConsent(final boolean consentMeasurement)

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 with the following argument:

consentMeasurement (Boolean): 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.

1
Adjust.trackMeasurementConsent(true)

1
Adjust.trackMeasurementConsent(true);

1
Adjust.trackMeasurementConsent(true);

COPPA compliance

public void setCoppaCompliantEnabled(boolean coppaCompliantEnabled)

If you need your app to be compliant with the Children’s Online Privacy Protection Act (COPPA), call the setCoppaCompliantEnabled method. This method 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 and android_id).

1
val appToken = "{YourAppToken}"
2
val environment = AdjustConfig.ENVIRONMENT_SANDBOX
3
val config = AdjustConfig(this, appToken, environment)
4
config.setCoppaCompliantEnabled(true)
5
//...
6
Adjust.onCreate(config)

1
String appToken = "{YourAppToken}";
2
String environment = AdjustConfig.ENVIRONMENT_SANDBOX;
3
AdjustConfig config = new AdjustConfig(this, appToken, environment);
4
config.setCoppaCompliantEnabled(true);
5
//...
6
Adjust.onCreate(config);

1
var yourAppToken = yourAppToken;
2
var environment = AdjustConfig.EnvironmentSandbox;
3
var adjustConfig = new AdjustConfig(yourAppToken, environment);
4
adjustConfig.setCoppaCompliantEnabled(true);

You can disable COPPA compliance by calling this method with a false argument.

Play Store Kids Apps

public void setPlayStoreKidsAppEnabled(boolean playStoreKidsAppEnabled)

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: gps_adid and android_id).

To mark your app as a Kids App, call the setPlayStoreKidsAppEnabled method with the following argument:

playStoreKidsAppEnabled (Boolean): set to true to mark the app as a Kids App, or false to mark the app as a non-Kids App.

1
val appToken = "{YourAppToken}"
2
val environment = AdjustConfig.ENVIRONMENT_SANDBOX
3
val config = AdjustConfig(this, appToken, environment)
4
config.setPlayStoreKidsAppEnabled(true)
5
//...
6
Adjust.onCreate(config)

1
String appToken = "{YourAppToken}";
2
String environment = AdjustConfig.ENVIRONMENT_SANDBOX;
3
AdjustConfig config = new AdjustConfig(this, appToken, environment);
4
config.setPlayStoreKidsAppEnabled(true);
5
//...
6
Adjust.onCreate(config);

1
var yourAppToken = yourAppToken;
2
var environment = AdjustConfig.EnvironmentSandbox;
3
var adjustConfig = new AdjustConfig(yourAppToken, environment);
4
adjustConfig.setPlayStoreKidsAppEnabled(true);