Set up privacy features

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

Send erasure request

+ (void)gdprForgetMe;

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)

1
Adjust.gdprForgetMe()

1
[Adjust gdprForgetMe];

Third-party sharing for specific users

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

Instantiate an ADJThirdPartySharing object

- (nullable id)initWithIsEnabled:(nullable NSNumber *)isEnabled;

To enable or disable third party sharing with the Adjust SDK, you need to instantiate an ADJThirdPartySharing 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 ADJThirdPartySharing instance and pass the following parameters:

• isEnabled (NSNumber): Whether third party sharing is enabled. Pass 1 to enable third party sharing or 0 to disable third party sharing

1
guard let adjustThirdPartySharing = ADJThirdPartySharing(isEnabled: 1) else { return }
2
Adjust.trackThirdPartySharing(adjustThirdPartySharing)

1
ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabled:@1];
2
[Adjust trackThirdPartySharing:adjustThirdPartySharing];

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

1
guard let adjustThirdPartySharing = ADJThirdPartySharing(isEnabled: 0) else { return }
2
Adjust.trackThirdPartySharing(adjustThirdPartySharing)

1
ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabled:@0];
2
[Adjust trackThirdPartySharing:adjustThirdPartySharing];

Send granular information

- (void)addGranularOption:(nonnull NSString *)partnerName
                      key:(nonnull NSString *)key
                    value:(nonnull NSString *)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 (NSString): The name of the partner for whom the granular option applies.
• key (NSString): The option key.
• value (NSString): The option value.

The following partners are available:

1
guard let adjustThirdPartySharing = ADJThirdPartySharing(isEnabled:nil) else { return }
2
adjustThirdPartySharing.addGranularOption("PartnerA", key: "foo", value: "bar")
3
Adjust.trackThirdPartySharing(adjustThirdPartySharing)

1
ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabled:nil];
2
[adjustThirdPartySharing addGranularOption:@"PartnerA" key:@"foo" value:@"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:

1
guard let tps = ADJThirdPartySharing(isEnabled:nil) else { return }
2
tps.addGranularOption("facebook", key: "data_processing_options_country", value: "1")
3
tps.addGranularOption("facebook", key: "data_processing_options_state", value: "1000")
4
Adjust.trackThirdPartySharing(tps)

1
ADJThirdPartySharing *tps = [[ADJThirdPartySharing alloc] initWithIsEnabled:@1];
2
[tps addGranularOption:@"facebook" key:@"data_processing_options_country" value:@"1"];
3
[tps addGranularOption:@"facebook" key:@"data_processing_options_state" value:@"1000"];
4
[Adjust trackThirdPartySharing:tps];

Provide consent data to Google (Digital Markets Act compliance)

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.

1
guard let adjustThirdPartySharing = ADJThirdPartySharing(isEnabled:nil) else { return }
2
adjustThirdPartySharing.addGranularOption("google_dma", key: "eea", value: "1")
3
adjustThirdPartySharing.addGranularOption("google_dma", key: "ad_personalization", value: "1")
4
adjustThirdPartySharing.addGranularOption("google_dma", key: "ad_user_data", value: "1")
5
Adjust.trackThirdPartySharing(adjustThirdPartySharing)

1
ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc]
2
                                                     initWithIsEnabled:nil];
3
[adjustThirdPartySharing addGranularOption:@"google_dma" key:@"eea" value:@"1"];
4
[adjustThirdPartySharing addGranularOption:@"google_dma" key:@"ad_personalization" value:@"1"];
5
[adjustThirdPartySharing addGranularOption:@"google_dma" key:@"ad_user_data" value:@"1"];
6
[Adjust trackThirdPartySharing:adjustThirdPartySharing];

Update partner sharing settings

- (void)addPartnerSharingSetting:(nonnull NSString *)partnerName
                             key:(nonnull NSString *)key
                           value:(BOOL)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:

You can use the partnerName to specify which partner you want to disable or re-enable sharing of specific metrics. Here,

• If you want to enable/disable sharing metrics with all the partners that includes SAN, module and dynamic, you can pass all keyword as a partnerName.
• If you want to enable/disable sharing metrics only with SAN partners, you can pass the name of the SAN partner as a partnerName.
• If you want to enable/disable sharing metrics with all the partners except SAN partners, you must pass the partner ID as a partnerName.
• If you want to enable/disable sharing metrics to dynamic partners, you can pass dynamic_callback as a partnerName.

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:

Metrics group

When you set a false value against a metric for a partner, Adjust stops sharing the metric along with all the child metrics under the group with the partner. These nested groups are:

• session
  • install
    • rejected_install
  • reinstall
  • reattribution
  • rejected_reattribution
  • reattribution_reinstall

Here,

• If you disable sharing of session, all its child metrics will also be disabled.
• If you disable sharing of session but enable reattribution, all its child metrics except reattribution will be disabled.
• If you disable sharing of session but enable install, all the child metrics of session except install will be disabled. Child metrics of install will remain enabled.
• If you enable sharing of session but disable install, all its child metrics of session except install will be enabled. Child metrics of install will remain disabled.

Examples

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

1
guard let adjustThirdPartySharing = ADJThirdPartySharing(isEnabled:nil) else { return }
2
adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", key: "all", value: false)
3
Adjust.trackThirdPartySharing(adjustThirdPartySharing)

1
ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabled:nil];
2
[adjustThirdPartySharing addPartnerSharingSetting:@"PartnerA" key:@"all" value:@NO];
3
[Adjust trackThirdPartySharing:adjustThirdPartySharing];

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

1
guard let adjustThirdPartySharing = ADJThirdPartySharing(isEnabled:nil) else { return }
2
adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", key: "all", value: true)
3
Adjust.trackThirdPartySharing(adjustThirdPartySharing)

1
ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabled:nil];
2
[adjustThirdPartySharing addPartnerSharingSetting:@"PartnerA" key:@"all" value:@YES];
3
[Adjust trackThirdPartySharing:adjustThirdPartySharing];

If you want to share data only with PartnerA, you need to pass:

• all key for all partners with a false value to disable sharing all information for all the partners.
• all key for PartnerA with a true value to enable sharing all the information for PartnerA explicitly.

1
guard let adjustThirdPartySharing = ADJThirdPartySharing(isEnabled:nil) else { return }
2
adjustThirdPartySharing.addPartnerSharingSetting("all", key: "all", value: false)
3
adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", key: "all", value: true)
4
Adjust.trackThirdPartySharing(adjustThirdPartySharing)

1
ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabled:nil];
2
[adjustThirdPartySharing addPartnerSharingSetting:@"all" key:@"all" value:@No];
3
[adjustThirdPartySharing addPartnerSharingSetting:@"PartnerA" key:@"all" value:@YES];
4
[Adjust trackThirdPartySharing:adjustThirdPartySharing];

If you want to share only session data with all the partners, you need to pass:

• all key for all partners with a false value to disable sharing all information for all the partners.
• session key for all partners with a true value to enable sharing session data and all its related “child” metrics for all the partners.

1
guard let adjustThirdPartySharing = ADJThirdPartySharing(isEnabled:nil) else { return }
2
adjustThirdPartySharing.addPartnerSharingSetting("all", key: "all", value: false)
3
adjustThirdPartySharing.addPartnerSharingSetting("all", key: "session", value: true)
4
Adjust.trackThirdPartySharing(adjustThirdPartySharing)

1
ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabled:nil];
2
[adjustThirdPartySharing addPartnerSharingSetting:@"all" key:@"all" value:@No];
3
[adjustThirdPartySharing addPartnerSharingSetting:@"all" key:@"session" value:@YES];
4
[Adjust trackThirdPartySharing:adjustThirdPartySharing];

If you want to share only session data with PartnerA, you need to pass:

• all key for all partners with a false value to disable sharing all information for all the partners.
• session key for PartnerA partners with a true value to enable sharing session data and all its related “child” metrics for PartnerA the partners.

1
guard let adjustThirdPartySharing = ADJThirdPartySharing(isEnabled:nil) else { return }
2
adjustThirdPartySharing.addPartnerSharingSetting("all", key: "all", value: false)
3
adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", key: "session", value: true)
4
Adjust.trackThirdPartySharing(adjustThirdPartySharing)

1
ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabled:nil];
2
[adjustThirdPartySharing addPartnerSharingSetting:@"all" key:@"all" value:@No];
3
[adjustThirdPartySharing addPartnerSharingSetting:@"PartnerA" key:@"session" value:@YES];
4
[Adjust trackThirdPartySharing:adjustThirdPartySharing];

If you want to disable dynamic_callbacks, pass the all key with a false value.

1
guard let adjustThirdPartySharing = ADJThirdPartySharing(isEnabled:nil) else { return }
2
adjustThirdPartySharing.addPartnerSharingSetting("dynamic_callbacks", key: "all", value: false)
3
Adjust.trackThirdPartySharing(adjustThirdPartySharing)

1
ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabled:nil];
2
[adjustThirdPartySharing addPartnerSharingSetting:@"dynamic_callbacks" key:@"all" value:@No];
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

1
guard let adjustThirdPartySharing = ADJThirdPartySharing(isEnabled:nil) else { return }
2
adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", key: "all", value: false)
3
adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", key: "event", value: true)
4
Adjust.trackThirdPartySharing(adjustThirdPartySharing)

1
ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabled:nil];
2
[adjustThirdPartySharing addPartnerSharingSetting:@"PartnerA" key:@"all" value:@NO];
3
[adjustThirdPartySharing addPartnerSharingSetting:@"PartnerA" key:@"event" value:@YES];
4
[Adjust trackThirdPartySharing:adjustThirdPartySharing];

Set URL strategy

- (void)setUrlStrategy:(nullable NSArray *)urlStrategyDomains
        useSubdomains:(BOOL)useSubdomains
        isDataResidency:(BOOL)isDataResidency;

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 AdjustConfig.setUrlStrategy method following parameters:

• urlStrategyDomains (NSArray): The country or countries of data residence, or the endpoints to which you want to send SDK traffic.
• useSubdomains (BOOL): Whether the source should prefix a subdomain.
• isDataResidency (BOOL): Whether the domain should be used for data residency.

See the table below for a list of mappings.

1
let domain = [] as [String]
2
adjustConfig.setUrlStrategy(domain, useSubdomains: true, isDataResidency: false)

1
NSArray *domain = [];
2
[adjustConfig setUrlStrategy:domain useSubdomains:YES
3
                     isDataResidency:YES];

Examples

let domain = ["adjust.net.in", "adjust.com"]
adjustConfig?.setUrlStrategy(domain, useSubdomains: true, isDataResidency: false)

let domain = ["adjust.world", "adjust.com"]
adjustConfig?.setUrlStrategy(domain, useSubdomains: true, isDataResidency: false)

let domain = ["adjust.cn"]
adjustConfig?.setUrlStrategy(domain, useSubdomains: true, isDataResidency: false)

let domain = ["eu.adjust.com"]
adjustConfig?.setUrlStrategy(domain, useSubdomains: true, isDataResidency: true)

let domain = ["tr.adjust.com"]
adjustConfig?.setUrlStrategy(domain, useSubdomains: true, isDataResidency: true)

let domain = ["us.adjust.com"]
adjustConfig?.setUrlStrategy(domain, useSubdomains: true, isDataResidency: true)

NSArray *domain = [[NSArray alloc]
                       initWithObjects:@"adjust.net.in", @"adjust.com", nil];
[adjustConfig setUrlStrategy:domain useSubdomains:YES isDataResidency:NO];

NSArray *domain = [[NSArray alloc]
                       initWithObjects:@"adjust.world", @"adjust.com", nil];
[adjustConfig setUrlStrategy:domain useSubdomains:YES isDataResidency:NO];

NSArray *domain = [[NSArray alloc]
                       initWithObjects:@"adjust.cn", nil];
[adjustConfig setUrlStrategy:domain useSubdomains:YES isDataResidency:NO];

NSArray *domain = [[NSArray alloc]
                       initWithObjects:@"eu.adjust.com", nil];
[adjustConfig setUrlStrategy:domain useSubdomains:YES isDataResidency:YES];

NSArray *domain = [[NSArray alloc]
                       initWithObjects:@"tr.adjust.com", nil];
[adjustConfig setUrlStrategy:domain useSubdomains:YES isDataResidency:YES];

NSArray *domain = [[NSArray alloc]
                       initWithObjects:@"us.adjust.com", nil];
[adjustConfig setUrlStrategy:domain useSubdomains:YES isDataResidency:YES];

Consent measurement for specific users

+ (void)trackMeasurementConsent:(BOOL)enabled;

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:

• measurementConsent (BOOL): 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:YES];

COPPA compliance

+ (void)enableCoppaCompliance;

If you need your app to be compliant with the Children’s Online Privacy Protection Act (COPPA), call the enableCoppaCompliance method on your ADJConfig instance before SDK intialization. This method performs the following actions:

1. Disables third-party sharing.
2. Prevents the SDK from reading device and advertising IDs (for example: idfa).

1
let yourAppToken = "{YourAppToken}"
2
let environment = ADJEnvironmentSandbox as? String
3
let adjustConfig = ADJConfig(
4
      appToken: yourAppToken,
5
      environment: environment)
6
adjustConfig?.enableCoppaCompliance()
7
Adjust.initSdk(adjustConfig)

1
#import "Adjust.h"
2

3
NSString *yourAppToken = @"{YourAppToken}";
4
NSString *environment = ADJEnvironmentSandbox;
5
ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:yourAppToken
6
                                                  environment:environment];
7

8
[adjustConfig enableCoppaCompliance];
9
[Adjust initSdk:adjustConfig];

Disable reading of IDFV

- (void)disableIdfvReading;

You can prevent the Adjust SDK from reading a device’s IDFV by calling the disableIdfvReading method on your ADJConfig instance. When you call this method, the Adjust SDK is prevented from reading the device’s IDFV and sending it to Adjust.

1
let yourAppToken = "{YourAppToken}"
2
let environment = ADJEnvironmentSandbox
3
let adjustConfig = ADJConfig(
4
    appToken: yourAppToken,
5
    environment: environment)
6

7
adjustConfig?.disableIdfvReading();

1
NSString *yourAppToken = @"{YourAppToken}";
2
NSString *environment = ADJEnvironmentSandbox;
3
ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:@"{YourAppToken}"
4
                                              environment:ADJEnvironmentSandbox];
5

6
[adjustConfig disableIdfvReading];