498 lines
16 KiB
Objective-C
498 lines
16 KiB
Objective-C
//
|
|
// Adjust.h
|
|
// Adjust SDK
|
|
//
|
|
// V4.38.0
|
|
// Created by Christian Wellenbrock (@wellle) on 23rd July 2013.
|
|
// Copyright (c) 2012-2021 Adjust GmbH. All rights reserved.
|
|
//
|
|
|
|
#import "ADJEvent.h"
|
|
#import "ADJConfig.h"
|
|
#import "ADJAttribution.h"
|
|
#import "ADJSubscription.h"
|
|
#import "ADJThirdPartySharing.h"
|
|
#import "ADJAdRevenue.h"
|
|
#import "ADJLinkResolution.h"
|
|
#import "ADJPurchase.h"
|
|
#import "ADJPurchaseVerificationResult.h"
|
|
|
|
typedef void(^AdjustResolvedDeeplinkBlock)(NSString * _Nonnull resolvedLink);
|
|
|
|
@interface AdjustTestOptions : NSObject
|
|
|
|
@property (nonatomic, copy, nullable) NSString *urlOverwrite;
|
|
@property (nonatomic, copy, nullable) NSString *extraPath;
|
|
@property (nonatomic, copy, nullable) NSNumber *timerIntervalInMilliseconds;
|
|
@property (nonatomic, copy, nullable) NSNumber *timerStartInMilliseconds;
|
|
@property (nonatomic, copy, nullable) NSNumber *sessionIntervalInMilliseconds;
|
|
@property (nonatomic, copy, nullable) NSNumber *subsessionIntervalInMilliseconds;
|
|
@property (nonatomic, copy, nullable) NSNumber *attStatusInt;
|
|
@property (nonatomic, copy, nullable) NSString *idfa;
|
|
@property (nonatomic, assign) BOOL teardown;
|
|
@property (nonatomic, assign) BOOL deleteState;
|
|
@property (nonatomic, assign) BOOL noBackoffWait;
|
|
@property (nonatomic, assign) BOOL adServicesFrameworkEnabled;
|
|
@property (nonatomic, assign) BOOL enableSigning;
|
|
@property (nonatomic, assign) BOOL disableSigning;
|
|
|
|
@end
|
|
|
|
/**
|
|
* Constants for our supported tracking environments.
|
|
*/
|
|
extern NSString * __nonnull const ADJEnvironmentSandbox;
|
|
extern NSString * __nonnull const ADJEnvironmentProduction;
|
|
|
|
/**
|
|
* Constants for supported ad revenue sources.
|
|
*/
|
|
extern NSString * __nonnull const ADJAdRevenueSourceAppLovinMAX;
|
|
extern NSString * __nonnull const ADJAdRevenueSourceMopub;
|
|
extern NSString * __nonnull const ADJAdRevenueSourceAdMob;
|
|
extern NSString * __nonnull const ADJAdRevenueSourceIronSource;
|
|
extern NSString * __nonnull const ADJAdRevenueSourceAdMost;
|
|
extern NSString * __nonnull const ADJAdRevenueSourceUnity;
|
|
extern NSString * __nonnull const ADJAdRevenueSourceHeliumChartboost;
|
|
extern NSString * __nonnull const ADJAdRevenueSourcePublisher;
|
|
extern NSString * __nonnull const ADJAdRevenueSourceTopOn;
|
|
extern NSString * __nonnull const ADJAdRevenueSourceADX;
|
|
extern NSString * __nonnull const ADJAdRevenueSourceTradplus;
|
|
|
|
/**
|
|
* Constants for country app's URL strategies.
|
|
*/
|
|
extern NSString * __nonnull const ADJUrlStrategyIndia;
|
|
extern NSString * __nonnull const ADJUrlStrategyChina;
|
|
extern NSString * __nonnull const ADJUrlStrategyCn;
|
|
extern NSString * __nonnull const ADJUrlStrategyCnOnly;
|
|
extern NSString * __nonnull const ADJDataResidencyEU;
|
|
extern NSString * __nonnull const ADJDataResidencyTR;
|
|
extern NSString * __nonnull const ADJDataResidencyUS;
|
|
|
|
/**
|
|
* @brief The main interface to Adjust.
|
|
*
|
|
* @note Use the methods of this class to tell Adjust about the usage of your app.
|
|
* See the README for details.
|
|
*/
|
|
@interface Adjust : NSObject
|
|
|
|
/**
|
|
* @brief Tell Adjust that the application did launch.
|
|
* This is required to initialize Adjust. Call this in the didFinishLaunching
|
|
* method of your AppDelegate.
|
|
*
|
|
* @note See ADJConfig.h for more configuration options
|
|
*
|
|
* @param adjustConfig The configuration object that includes the environment
|
|
* and the App Token of your app. This unique identifier can
|
|
* be found it in your dashboard at http://adjust.com and should always
|
|
* be 12 characters long.
|
|
*/
|
|
+ (void)appDidLaunch:(nullable ADJConfig *)adjustConfig;
|
|
|
|
/**
|
|
* @brief Tell Adjust that a particular event has happened.
|
|
*
|
|
* @note See ADJEvent.h for more event options.
|
|
*
|
|
* @param event The Event object for this kind of event. It needs a event token
|
|
* that is created in the dashboard at http://adjust.com and should be six
|
|
* characters long.
|
|
*/
|
|
+ (void)trackEvent:(nullable ADJEvent *)event;
|
|
|
|
/**
|
|
* @brief Tell adjust that the application resumed.
|
|
*
|
|
* @note Only necessary if the native notifications can't be used
|
|
* or if they will happen before call to appDidLaunch: is made.
|
|
*/
|
|
+ (void)trackSubsessionStart;
|
|
|
|
/**
|
|
* @brief Tell adjust that the application paused.
|
|
*
|
|
* @note Only necessary if the native notifications can't be used.
|
|
*/
|
|
+ (void)trackSubsessionEnd;
|
|
|
|
/**
|
|
* @brief Enable or disable the adjust SDK. This setting is saved for future sessions.
|
|
*
|
|
* @param enabled The flag to enable or disable the adjust SDK.
|
|
*/
|
|
+ (void)setEnabled:(BOOL)enabled;
|
|
|
|
/**
|
|
* @brief Check if the SDK is enabled or disabled.
|
|
*
|
|
* return Boolean indicating whether SDK is enabled or not.
|
|
*/
|
|
+ (BOOL)isEnabled;
|
|
|
|
/**
|
|
* @brief Read the URL that opened the application to search for an adjust deep link.
|
|
*
|
|
* @param url URL object which contains info about adjust deep link.
|
|
*/
|
|
+ (void)appWillOpenUrl:(nonnull NSURL *)url;
|
|
|
|
/**
|
|
* @brief Process the deep link that has opened an app and potentially get a resolved link.
|
|
*
|
|
* @param deeplink URL object which contains info about adjust deep link.
|
|
* @param completionHandler Completion handler where either resolved or echoed deep link will be sent.
|
|
*/
|
|
+ (void)processDeeplink:(nonnull NSURL *)deeplink
|
|
completionHandler:(void (^_Nonnull)(NSString * _Nonnull resolvedLink))completionHandler;
|
|
|
|
/**
|
|
* @brief Set the device token used by push notifications.
|
|
*
|
|
* @param deviceToken Apple push notification token for iOS device as NSData.
|
|
*/
|
|
+ (void)setDeviceToken:(nonnull NSData *)deviceToken;
|
|
|
|
/**
|
|
* @brief Set the device token used by push notifications.
|
|
* This method is only used by Adjust non native SDKs. Don't use it anywhere else.
|
|
*
|
|
* @param pushToken Apple push notification token for iOS device as NSString.
|
|
*/
|
|
+ (void)setPushToken:(nonnull NSString *)pushToken;
|
|
|
|
/**
|
|
* @brief Enable or disable offline mode. Activities won't be sent but they are saved when
|
|
* offline mode is disabled. This feature is not saved for future sessions.
|
|
*
|
|
* @param enabled The flag to enable or disable offline mode.
|
|
*/
|
|
+ (void)setOfflineMode:(BOOL)enabled;
|
|
|
|
/**
|
|
* @brief Retrieve iOS device IDFA value.
|
|
*
|
|
* @return Device IDFA value.
|
|
*/
|
|
+ (nullable NSString *)idfa;
|
|
|
|
/**
|
|
* @brief Retrieve iOS device IDFV value.
|
|
*
|
|
* @return Device IDFV value.
|
|
*/
|
|
+ (nullable NSString *)idfv;
|
|
|
|
|
|
/**
|
|
* @brief Get current adjust identifier for the user.
|
|
*
|
|
* @note Adjust identifier is available only after installation has been successfully tracked.
|
|
*
|
|
* @return Current adjust identifier value for the user.
|
|
*/
|
|
+ (nullable NSString *)adid;
|
|
|
|
/**
|
|
* @brief Get current attribution for the user.
|
|
*
|
|
* @note Attribution information is available only after installation has been successfully tracked
|
|
* and attribution information arrived after that from the backend.
|
|
*
|
|
* @return Current attribution value for the user.
|
|
*/
|
|
+ (nullable ADJAttribution *)attribution;
|
|
|
|
/**
|
|
* @brief Get current Adjust SDK version string.
|
|
*
|
|
* @return Adjust SDK version string (iosX.Y.Z).
|
|
*/
|
|
+ (nullable NSString *)sdkVersion;
|
|
|
|
/**
|
|
* @brief Convert a universal link style URL to a deeplink style URL with the corresponding scheme.
|
|
*
|
|
* @param url URL object which contains info about adjust deep link.
|
|
* @param scheme Desired scheme to which you want your resulting URL object to be prefixed with.
|
|
*
|
|
* @return URL object in custom URL scheme style prefixed with given scheme name.
|
|
*/
|
|
+ (nullable NSURL *)convertUniversalLink:(nonnull NSURL *)url scheme:(nonnull NSString *)scheme;
|
|
|
|
/**
|
|
* @brief Tell the adjust SDK to stop waiting for delayed initialisation timer to complete but rather to start
|
|
* upon this call. This should be called if you have obtained needed callback/partner parameters which you
|
|
* wanted to put as default ones before the delayedStart value you have set on ADJConfig has expired.
|
|
*/
|
|
+ (void)sendFirstPackages;
|
|
|
|
/**
|
|
* @brief Tell adjust to send the request to Google and check if the installation
|
|
* belongs to Google AdWords campaign.
|
|
*
|
|
* @note Deprecated method, should not be used.
|
|
*/
|
|
+ (void)sendAdWordsRequest;
|
|
|
|
/**
|
|
* @brief Add default callback parameter key-value pair which is going to be sent with each tracked session and event.
|
|
*
|
|
* @param key Default callback parameter key.
|
|
* @param value Default callback parameter value.
|
|
*/
|
|
+ (void)addSessionCallbackParameter:(nonnull NSString *)key value:(nonnull NSString *)value;
|
|
|
|
/**
|
|
* @brief Add default partner parameter key-value pair which is going to be sent with each tracked session.
|
|
*
|
|
* @param key Default partner parameter key.
|
|
* @param value Default partner parameter value.
|
|
*/
|
|
+ (void)addSessionPartnerParameter:(nonnull NSString *)key value:(nonnull NSString *)value;
|
|
|
|
/**
|
|
* @brief Remove default callback parameter from the session packages.
|
|
*
|
|
* @param key Default callback parameter key.
|
|
*/
|
|
+ (void)removeSessionCallbackParameter:(nonnull NSString *)key;
|
|
|
|
/**
|
|
* @brief Remove default partner parameter from the session packages.
|
|
*
|
|
* @param key Default partner parameter key.
|
|
*/
|
|
+ (void)removeSessionPartnerParameter:(nonnull NSString *)key;
|
|
|
|
/**
|
|
* @brief Remove all default callback parameters from the session packages.
|
|
*/
|
|
+ (void)resetSessionCallbackParameters;
|
|
|
|
/**
|
|
* @brief Remove all default partner parameters from the session packages.
|
|
*/
|
|
+ (void)resetSessionPartnerParameters;
|
|
|
|
/**
|
|
* @brief Give right user to be forgotten in accordance with GDPR law.
|
|
*/
|
|
+ (void)gdprForgetMe;
|
|
|
|
/**
|
|
* @brief Track ad revenue for given source.
|
|
*
|
|
* @param source Ad revenue source.
|
|
* @param payload Ad revenue payload.
|
|
*/
|
|
+ (void)trackAdRevenue:(nonnull NSString *)source payload:(nonnull NSData *)payload;
|
|
|
|
/**
|
|
* @brief Give right user to disable sharing data to any third-party.
|
|
*/
|
|
+ (void)disableThirdPartySharing;
|
|
|
|
/**
|
|
* @brief Track third paty sharing with possibility to allow or disallow it.
|
|
*
|
|
* @param thirdPartySharing Third party sharing choice.
|
|
*/
|
|
+ (void)trackThirdPartySharing:(nonnull ADJThirdPartySharing *)thirdPartySharing;
|
|
|
|
/**
|
|
* @brief Track measurement consent.
|
|
*
|
|
* @param enabled Value of the consent.
|
|
*/
|
|
+ (void)trackMeasurementConsent:(BOOL)enabled;
|
|
|
|
/**
|
|
* @brief Track ad revenue.
|
|
*
|
|
* @param adRevenue Ad revenue object instance containing all the relevant ad revenue tracking data.
|
|
*/
|
|
+ (void)trackAdRevenue:(nonnull ADJAdRevenue *)adRevenue;
|
|
|
|
/**
|
|
* @brief Track subscription.
|
|
*
|
|
* @param subscription Subscription object.
|
|
*/
|
|
+ (void)trackSubscription:(nonnull ADJSubscription *)subscription;
|
|
|
|
/**
|
|
* @brief Adjust wrapper for requestTrackingAuthorizationWithCompletionHandler: method.
|
|
*
|
|
* @param completion Block which value of tracking authorization status will be delivered to.
|
|
*/
|
|
+ (void)requestTrackingAuthorizationWithCompletionHandler:(void (^_Nullable)(NSUInteger status))completion;
|
|
|
|
/**
|
|
* @brief Getter for app tracking authorization status.
|
|
*
|
|
* @return Value of app tracking authorization status.
|
|
*/
|
|
+ (int)appTrackingAuthorizationStatus;
|
|
|
|
/**
|
|
* @brief Adjust wrapper for SKAdNetwork's updateConversionValue: method.
|
|
*
|
|
* @param conversionValue Conversion value you would like SDK to set for given user.
|
|
*/
|
|
+ (void)updateConversionValue:(NSInteger)conversionValue;
|
|
|
|
/**
|
|
* @brief Adjust wrapper for SKAdNetwork's updatePostbackConversionValue:completionHandler: method.
|
|
*
|
|
* @param conversionValue Conversion value you would like SDK to set for given user.
|
|
* @param completion Completion handler you can provide to catch and handle any errors.
|
|
*/
|
|
+ (void)updatePostbackConversionValue:(NSInteger)conversionValue
|
|
completionHandler:(void (^_Nullable)(NSError *_Nullable error))completion;
|
|
|
|
/**
|
|
* @brief Adjust wrapper for SKAdNetwork's updatePostbackConversionValue:coarseValue:completionHandler: method.
|
|
*
|
|
* @param fineValue Conversion value you would like SDK to set for given user.
|
|
* @param coarseValue One of the possible SKAdNetworkCoarseConversionValue values.
|
|
* @param completion Completion handler you can provide to catch and handle any errors.
|
|
*/
|
|
+ (void)updatePostbackConversionValue:(NSInteger)fineValue
|
|
coarseValue:(nonnull NSString *)coarseValue
|
|
completionHandler:(void (^_Nullable)(NSError *_Nullable error))completion;
|
|
|
|
/**
|
|
* @brief Adjust wrapper for SKAdNetwork's updatePostbackConversionValue:coarseValue:lockWindow:completionHandler: method.
|
|
*
|
|
* @param fineValue Conversion value you would like SDK to set for given user.
|
|
* @param coarseValue One of the possible SKAdNetworkCoarseConversionValue values.
|
|
* @param lockWindow A Boolean value that indicates whether to send the postback before the conversion window ends.
|
|
* @param completion Completion handler you can provide to catch and handle any errors.
|
|
*/
|
|
+ (void)updatePostbackConversionValue:(NSInteger)fineValue
|
|
coarseValue:(nonnull NSString *)coarseValue
|
|
lockWindow:(BOOL)lockWindow
|
|
completionHandler:(void (^_Nullable)(NSError *_Nullable error))completion;
|
|
|
|
/**
|
|
* @brief Instruct to Adjust SDK to check current state of att_status.
|
|
*/
|
|
+ (void)checkForNewAttStatus;
|
|
|
|
/**
|
|
* @brief Get the last deep link which has opened the app.
|
|
*
|
|
* @return Last deep link which has opened the app.
|
|
*/
|
|
+ (nullable NSURL *)lastDeeplink;
|
|
|
|
/**
|
|
* @brief Verify in-app-purchase.
|
|
*
|
|
* @param purchase Purchase object.
|
|
* @param completionHandler Callback where verification result will be repoted.
|
|
*/
|
|
+ (void)verifyPurchase:(nonnull ADJPurchase *)purchase
|
|
completionHandler:(void (^_Nonnull)(ADJPurchaseVerificationResult * _Nonnull verificationResult))completionHandler;
|
|
|
|
/**
|
|
* @brief Method used for internal testing only. Don't use it in production.
|
|
*/
|
|
+ (void)setTestOptions:(nullable AdjustTestOptions *)testOptions;
|
|
|
|
/**
|
|
* Obtain singleton Adjust object.
|
|
*/
|
|
+ (nullable instancetype)getInstance;
|
|
|
|
- (void)appDidLaunch:(nullable ADJConfig *)adjustConfig;
|
|
|
|
- (void)trackEvent:(nullable ADJEvent *)event;
|
|
|
|
- (void)setEnabled:(BOOL)enabled;
|
|
|
|
- (void)teardown;
|
|
|
|
- (void)appWillOpenUrl:(nonnull NSURL *)url;
|
|
|
|
- (void)processDeeplink:(nonnull NSURL *)deeplink
|
|
completionHandler:(void (^_Nonnull)(NSString * _Nonnull resolvedLink))completionHandler;
|
|
|
|
- (void)setOfflineMode:(BOOL)enabled;
|
|
|
|
- (void)setDeviceToken:(nonnull NSData *)deviceToken;
|
|
|
|
- (void)setPushToken:(nonnull NSString *)pushToken;
|
|
|
|
- (void)sendFirstPackages;
|
|
|
|
- (void)trackSubsessionEnd;
|
|
|
|
- (void)trackSubsessionStart;
|
|
|
|
- (void)resetSessionPartnerParameters;
|
|
|
|
- (void)resetSessionCallbackParameters;
|
|
|
|
- (void)removeSessionPartnerParameter:(nonnull NSString *)key;
|
|
|
|
- (void)removeSessionCallbackParameter:(nonnull NSString *)key;
|
|
|
|
- (void)addSessionPartnerParameter:(nonnull NSString *)key value:(nonnull NSString *)value;
|
|
|
|
- (void)addSessionCallbackParameter:(nonnull NSString *)key value:(nonnull NSString *)value;
|
|
|
|
- (void)gdprForgetMe;
|
|
|
|
- (void)trackAdRevenue:(nonnull NSString *)source payload:(nonnull NSData *)payload;
|
|
|
|
- (void)trackSubscription:(nonnull ADJSubscription *)subscription;
|
|
|
|
- (BOOL)isEnabled;
|
|
|
|
- (nullable NSString *)adid;
|
|
|
|
- (nullable NSString *)idfa;
|
|
|
|
- (nullable NSString *)sdkVersion;
|
|
|
|
- (nullable ADJAttribution *)attribution;
|
|
|
|
- (nullable NSURL *)convertUniversalLink:(nonnull NSURL *)url scheme:(nonnull NSString *)scheme;
|
|
|
|
- (void)requestTrackingAuthorizationWithCompletionHandler:(void (^_Nullable)(NSUInteger status))completion;
|
|
|
|
- (int)appTrackingAuthorizationStatus;
|
|
|
|
- (void)updateConversionValue:(NSInteger)conversionValue;
|
|
|
|
- (void)updatePostbackConversionValue:(NSInteger)conversionValue
|
|
completionHandler:(void (^_Nullable)(NSError *_Nullable error))completion;
|
|
|
|
- (void)updatePostbackConversionValue:(NSInteger)fineValue
|
|
coarseValue:(nonnull NSString *)coarseValue
|
|
completionHandler:(void (^_Nullable)(NSError *_Nullable error))completion;
|
|
|
|
- (void)updatePostbackConversionValue:(NSInteger)fineValue
|
|
coarseValue:(nonnull NSString *)coarseValue
|
|
lockWindow:(BOOL)lockWindow
|
|
completionHandler:(void (^_Nullable)(NSError *_Nullable error))completion;
|
|
|
|
- (void)trackThirdPartySharing:(nonnull ADJThirdPartySharing *)thirdPartySharing;
|
|
|
|
- (void)trackMeasurementConsent:(BOOL)enabled;
|
|
|
|
- (void)trackAdRevenue:(nonnull ADJAdRevenue *)adRevenue;
|
|
|
|
- (void)checkForNewAttStatus;
|
|
|
|
- (nullable NSURL *)lastDeeplink;
|
|
|
|
- (void)verifyPurchase:(nonnull ADJPurchase *)purchase
|
|
completionHandler:(void (^_Nonnull)(ADJPurchaseVerificationResult * _Nonnull verificationResult))completionHandler;
|
|
|
|
@end
|