diff --git a/src/code-snippets/ios/examples/ADJAdRevenue/addCallbackParameter.mdx b/src/code-snippets/ios/examples/ADJAdRevenue/addCallbackParameter.mdx deleted file mode 100644 index b6cd8de44..000000000 --- a/src/code-snippets/ios/examples/ADJAdRevenue/addCallbackParameter.mdx +++ /dev/null @@ -1,20 +0,0 @@ - - - -```swift {2} -let adRevenue = ADJAdRevenue(source: source); -adRevenue.addCallbackParameter(key, value: value); -Adjust.trackAdRevenue(adRevenue); -``` - - - - -```objc {2} -ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source]; -[adRevenue addCallbackParameter:key value:value]; -[Adjust trackAdRevenue:adRevenue]; -``` - - - diff --git a/src/code-snippets/ios/examples/ADJAdRevenue/addPartnerParameter.mdx b/src/code-snippets/ios/examples/ADJAdRevenue/addPartnerParameter.mdx deleted file mode 100644 index 0786d3e9f..000000000 --- a/src/code-snippets/ios/examples/ADJAdRevenue/addPartnerParameter.mdx +++ /dev/null @@ -1,20 +0,0 @@ - - - -```swift {2} -let adRevenue = ADJAdRevenue(source: source); -adRevenue.addPartnerParameter(key, value: value); -Adjust.trackAdRevenue(adRevenue); -``` - - - - -```objc {2} -ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source]; -[adRevenue addPartnerParameter:key value:value]; -[Adjust trackAdRevenue:adRevenue]; -``` - - - diff --git a/src/code-snippets/ios/examples/ADJAdRevenue/constructor.mdx b/src/code-snippets/ios/examples/ADJAdRevenue/constructor.mdx deleted file mode 100644 index f61a57541..000000000 --- a/src/code-snippets/ios/examples/ADJAdRevenue/constructor.mdx +++ /dev/null @@ -1,20 +0,0 @@ - - - -```swift {1} -let adRevenue = ADJAdRevenue(source: source); -//... -Adjust.trackAdRevenue(adRevenue); -``` - - - - -```objc {1} -ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source]; -//... -[Adjust trackAdRevenue:adRevenue]; -``` - - - diff --git a/src/code-snippets/ios/examples/ADJAdRevenue/setAdImpressionsCount.mdx b/src/code-snippets/ios/examples/ADJAdRevenue/setAdImpressionsCount.mdx deleted file mode 100644 index c6a92b6df..000000000 --- a/src/code-snippets/ios/examples/ADJAdRevenue/setAdImpressionsCount.mdx +++ /dev/null @@ -1,20 +0,0 @@ - - - -```swift {2} -let adRevenue = ADJAdRevenue(source: source); -adRevenue?.adImpressionsCount = 1; -Adjust.trackAdRevenue(adRevenue); -``` - - - - -```objc {2} -ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source]; -[adRevenue setAdImpressionsCount:1]; -[Adjust trackAdRevenue:adRevenue]; -``` - - - diff --git a/src/code-snippets/ios/examples/ADJAdRevenue/setAdRevenueNetwork.mdx b/src/code-snippets/ios/examples/ADJAdRevenue/setAdRevenueNetwork.mdx deleted file mode 100644 index 4cd1a24c7..000000000 --- a/src/code-snippets/ios/examples/ADJAdRevenue/setAdRevenueNetwork.mdx +++ /dev/null @@ -1,20 +0,0 @@ - - - -```swift {2} -let adRevenue = ADJAdRevenue(source: source); -adRevenue?.adRevenueNetwork = "network1"; -Adjust.trackAdRevenue(adRevenue); -``` - - - - -```objc {2} -ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source]; -[adRevenue setAdRevenueNetwork:@"network1"]; -[Adjust trackAdRevenue:adRevenue]; -``` - - - diff --git a/src/code-snippets/ios/examples/ADJAdRevenue/setAdRevenuePlacement.mdx b/src/code-snippets/ios/examples/ADJAdRevenue/setAdRevenuePlacement.mdx deleted file mode 100644 index f2c664f4a..000000000 --- a/src/code-snippets/ios/examples/ADJAdRevenue/setAdRevenuePlacement.mdx +++ /dev/null @@ -1,20 +0,0 @@ - - - -```swift {2} -let adRevenue = ADJAdRevenue(source: source); -adRevenue?.adRevenuePlacement = "banner"; -Adjust.trackAdRevenue(adRevenue); -``` - - - - -```objc {2} -ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source]; -[adRevenue setAdRevenuePlacement:@"banner"]; -[Adjust trackAdRevenue:adRevenue]; -``` - - - diff --git a/src/code-snippets/ios/examples/ADJAdRevenue/setAdRevenueUnit.mdx b/src/code-snippets/ios/examples/ADJAdRevenue/setAdRevenueUnit.mdx deleted file mode 100644 index 115c10d0a..000000000 --- a/src/code-snippets/ios/examples/ADJAdRevenue/setAdRevenueUnit.mdx +++ /dev/null @@ -1,20 +0,0 @@ - - - -```swift {2} -let adRevenue = ADJAdRevenue(source: source); -adRevenue?.adRevenueUnit = "unit1"; -Adjust.trackAdRevenue(adRevenue); -``` - - - - -```objc {2} -ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source]; -[adRevenue setAdRevenueUnit:@"unit1"]; -[Adjust trackAdRevenue:adRevenue]; -``` - - - diff --git a/src/code-snippets/ios/examples/ADJAdRevenue/setRevenue.mdx b/src/code-snippets/ios/examples/ADJAdRevenue/setRevenue.mdx deleted file mode 100644 index 5d9adc5c3..000000000 --- a/src/code-snippets/ios/examples/ADJAdRevenue/setRevenue.mdx +++ /dev/null @@ -1,20 +0,0 @@ - - - -```swift {2} -let adRevenue = ADJAdRevenue(source: source); -adRevenue.setRevenue(1.6, currency: "USD"); -Adjust.trackAdRevenue(adRevenue); -``` - - - - -```objc {2} -ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source]; -[adRevenue setRevenue:1.6 currency:@"USD"]; -[Adjust trackAdRevenue:adRevenue]; -``` - - - diff --git a/src/code-snippets/ios/examples/ADJConfig/constructor.mdx b/src/code-snippets/ios/examples/ADJConfig/constructor.mdx deleted file mode 100644 index c55df7823..000000000 --- a/src/code-snippets/ios/examples/ADJConfig/constructor.mdx +++ /dev/null @@ -1,34 +0,0 @@ - - - -```swift {3-5} -let yourAppToken = "{YourAppToken}" -let environment = ADJEnvironmentSandbox as? String -let adjustConfig = ADJConfig( - appToken: yourAppToken, - environment: environment) -``` - - - - -```objective-c {3-4} -NSString *yourAppToken = @"{YourAppToken}"; -NSString *environment = ADJEnvironmentSandbox; -*adjustConfig = [ADJConfig configWithAppToken:yourAppToken - environment:environment]; -``` - - - - -```javascript {4} -setupWebViewJavascriptBridge(function(bridge) { - var yourAppToken = yourAppToken; - var environment = AdjustConfig.EnvironmentSandbox; - var adjustConfig = new AdjustConfig(yourAppToken, environment); -}); -``` - - - diff --git a/src/code-snippets/ios/examples/ADJConfig/deactivateSKAdNetworkHandling.mdx b/src/code-snippets/ios/examples/ADJConfig/deactivateSKAdNetworkHandling.mdx deleted file mode 100644 index eb1762dbe..000000000 --- a/src/code-snippets/ios/examples/ADJConfig/deactivateSKAdNetworkHandling.mdx +++ /dev/null @@ -1,28 +0,0 @@ - - - -```swift {7} -let yourAppToken = "{YourAppToken}" -let environment = ADJEnvironmentSandbox as? String -let adjustConfig = ADJConfig( - appToken: yourAppToken, - environment: environment) -//... -adjustConfig.deactivateSKAdNetworkHandling() -//... -Adjust.appDidLaunch(adjustConfig) -``` - - - - -```objective-c {3} -*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}" - environment:ADJEnvironmentSandbox]; -[adjustConfig.deactivateSKAdNetworkHandling]; -/// ... -[Adjust appDidLaunch:adjustConfig]; -``` - - - diff --git a/src/code-snippets/ios/examples/ADJConfig/sendInBackground.mdx b/src/code-snippets/ios/examples/ADJConfig/sendInBackground.mdx deleted file mode 100644 index fa2a7023e..000000000 --- a/src/code-snippets/ios/examples/ADJConfig/sendInBackground.mdx +++ /dev/null @@ -1,40 +0,0 @@ - - - -```swift {7} -let yourAppToken = "{YourAppToken}" -let environment = ADJEnvironmentSandbox as? String -let adjustConfig = ADJConfig( - appToken: yourAppToken, - environment: environment) -// ... -adjustConfig?.sendInBackground = true -``` - - - - -```objc {6} -NSString *yourAppToken = @"{YourAppToken}"; -NSString *environment = ADJEnvironmentSandbox; -*adjustConfig = [ADJConfig configWithAppToken:yourAppToken - environment:environment]; -// ... -[adjustConfig setSendInBackground:YES]; -``` - - - - -```js {6} -setupWebViewJavascriptBridge(function(bridge) { - // ... - var yourAppToken = yourAppToken; - var environment = AdjustConfig.EnvironmentSandbox; - var adjustConfig = new AdjustConfig(yourAppToken, environment); - adjustConfig.setSendInBackground(true); -}); -``` - - - diff --git a/src/code-snippets/ios/examples/ADJConfig/setAllowAdServicesInfoReading.mdx b/src/code-snippets/ios/examples/ADJConfig/setAllowAdServicesInfoReading.mdx deleted file mode 100644 index 6aa34de86..000000000 --- a/src/code-snippets/ios/examples/ADJConfig/setAllowAdServicesInfoReading.mdx +++ /dev/null @@ -1,27 +0,0 @@ - - - -```swift {6} -let yourAppToken = "{YourAppToken}" -let environment = ADJEnvironmentSandbox as? String -let adjustConfig = ADJConfig( - appToken: yourAppToken, - environment: environment) -adjustConfig?.allowAdServicesInfoReading = true; -//... -Adjust.appDidLaunch(adjustConfig) -``` - - - - -```objc {3} -*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}" - environment:ADJEnvironmentSandbox]; -[adjustConfig.setAllowAdServicesInfoReading:YES]; -//... -[Adjust appDidLaunch:adjustConfig]; -``` - - - diff --git a/src/code-snippets/ios/examples/ADJConfig/setAllowIdfaReading.mdx b/src/code-snippets/ios/examples/ADJConfig/setAllowIdfaReading.mdx deleted file mode 100644 index 4b3561580..000000000 --- a/src/code-snippets/ios/examples/ADJConfig/setAllowIdfaReading.mdx +++ /dev/null @@ -1,27 +0,0 @@ - - - -```swift {6} -let yourAppToken = "{YourAppToken}" -let environment = ADJEnvironmentSandbox as? String -let adjustConfig = ADJConfig( - appToken: yourAppToken, - environment: environment) -adjustConfig?.allowIdfaReading = true; -//... -Adjust.appDidLaunch(adjustConfig) -``` - - - - -```objc {3} -*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}" - environment:ADJEnvironmentSandbox]; -[adjustConfig.setAllowIdfaReading:YES]; -//... -[Adjust appDidLaunch:adjustConfig]; -``` - - - diff --git a/src/code-snippets/ios/examples/ADJConfig/setDefaultTracker.mdx b/src/code-snippets/ios/examples/ADJConfig/setDefaultTracker.mdx deleted file mode 100644 index 56dca2f2b..000000000 --- a/src/code-snippets/ios/examples/ADJConfig/setDefaultTracker.mdx +++ /dev/null @@ -1,37 +0,0 @@ - - - -```swift {6} -let yourAppToken = "{YourAppToken}" -let environment = ADJEnvironmentSandbox as? String -let adjustConfig = ADJConfig( - appToken: yourAppToken, - environment: environment) -adjustConfig?.defaultTracker = "{Token}" -Adjust.appDidLaunch(adjustConfig) -``` - - - - -```objective-c {3} -*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}" - environment:ADJEnvironmentSandbox]; -[adjustConfig setDefaultTracker:@"{Token}"]; -[Adjust appDidLaunch:adjustConfig]; -``` - - - - -```javascript {5} -setupWebViewJavascriptBridge(function(bridge) { - var yourAppToken = yourAppToken; - var environment = AdjustConfig.EnvironmentSandbox; - var adjustConfig = new AdjustConfig(yourAppToken, environment); - adjustConfig.setDefaultTracker("{Token}"); -}); -``` - - - diff --git a/src/code-snippets/ios/examples/ADJConfig/setDelayStart.mdx b/src/code-snippets/ios/examples/ADJConfig/setDelayStart.mdx deleted file mode 100644 index 70a6dea42..000000000 --- a/src/code-snippets/ios/examples/ADJConfig/setDelayStart.mdx +++ /dev/null @@ -1,39 +0,0 @@ - - - -```swift {6} -let yourAppToken = "{YourAppToken}" -let environment = ADJEnvironmentSandbox as? String -let adjustConfig = ADJConfig( - appToken: yourAppToken, - environment: environment) -adjustConfig?.delayStart = 5.5 -// ... -Adjust.appDidLaunch(adjustConfig) -``` - - - - -```objc {3} -*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}" - environment:ADJEnvironmentSandbox]; -[adjustConfig setDelayStart:5.5]; -/// ... -[Adjust appDidLaunch:adjustConfig]; -``` - - - - -```js {5} -setupWebViewJavascriptBridge(function(bridge) { - var yourAppToken = yourAppToken; - var environment = AdjustConfig.EnvironmentSandbox; - var adjustConfig = new AdjustConfig(yourAppToken, environment); - adjustConfig.setDelayStart(5.5); -}); -``` - - - diff --git a/src/code-snippets/ios/examples/ADJConfig/setDelegate.mdx b/src/code-snippets/ios/examples/ADJConfig/setDelegate.mdx deleted file mode 100644 index 56be7a25f..000000000 --- a/src/code-snippets/ios/examples/ADJConfig/setDelegate.mdx +++ /dev/null @@ -1,49 +0,0 @@ - - - -```swift {6} -let yourAppToken = "{YourAppToken}" -let environment = ADJEnvironmentSandbox as? String -let adjustConfig = ADJConfig( - appToken: yourAppToken, - environment: environment) -adjustConfig?.delegate = self -//... -Adjust.appDidLaunch(adjustConfig) -``` - - - - -```objc {3} -*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}" - environment:ADJEnvironmentSandbox]; -[adjustConfig setDelegate:self]; -/// ... -[Adjust appDidLaunch:adjustConfig]; -``` - - - - -```javascript {5-15} -setupWebViewJavascriptBridge(function(bridge) { - var yourAppToken = yourAppToken; - var environment = AdjustConfig.EnvironmentSandbox; - var adjustConfig = new AdjustConfig(yourAppToken, environment); - adjustConfig.setAttributionCallback(function(attribution) { - // In this example, we're just displaying alert with attribution content. - alert('Tracker token = ' + attribution.trackerToken + '\n' + - 'Tracker name = ' + attribution.trackerName + '\n' + - 'Network = ' + attribution.network + '\n' + - 'Campaign = ' + attribution.campaign + '\n' + - 'Adgroup = ' + attribution.adgroup + '\n' + - 'Creative = ' + attribution.creative + '\n' + - 'Click label = ' + attribution.clickLabel + '\n' + - 'Adid = ' + attribution.adid); - }); -}); -``` - - - diff --git a/src/code-snippets/ios/examples/ADJConfig/setEventBufferingEnabled.mdx b/src/code-snippets/ios/examples/ADJConfig/setEventBufferingEnabled.mdx deleted file mode 100644 index 8660efd6a..000000000 --- a/src/code-snippets/ios/examples/ADJConfig/setEventBufferingEnabled.mdx +++ /dev/null @@ -1,37 +0,0 @@ - - - -```swift {6} -let yourAppToken = "{YourAppToken}" -let environment = ADJEnvironmentSandbox as? String -let adjustConfig = ADJConfig( - appToken: yourAppToken, - environment: environment) -adjustConfig?.eventBufferingEnabled = true -Adjust.appDidLaunch(adjustConfig) -``` - - - - -```objc {3} -*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}" - environment:ADJEnvironmentSandbox]; -[adjustConfig setEventBufferingEnabled:YES]; -[Adjust appDidLaunch:adjustConfig]; -``` - - - - -```js {5} -setupWebViewJavascriptBridge(function(bridge) { - var yourAppToken = yourAppToken; - var environment = AdjustConfig.EnvironmentSandbox; - var adjustConfig = new AdjustConfig(yourAppToken, environment); - adjustConfig.setEventBufferingEnabled(true); -}); -``` - - - diff --git a/src/code-snippets/ios/examples/ADJConfig/setExternalDeviceId.mdx b/src/code-snippets/ios/examples/ADJConfig/setExternalDeviceId.mdx deleted file mode 100644 index 3a3e13043..000000000 --- a/src/code-snippets/ios/examples/ADJConfig/setExternalDeviceId.mdx +++ /dev/null @@ -1,39 +0,0 @@ - - - -```swift {7} -let yourAppToken = "{YourAppToken}" -let environment = ADJEnvironmentSandbox as? String -let adjustConfig = ADJConfig( - appToken: yourAppToken, - environment: environment) -// ... -adjustConfig?.externalDeviceId = "yourExternalDeviceId" -``` - - - - -```objc {6} -NSString *yourAppToken = @"{YourAppToken}"; -NSString *environment = ADJEnvironmentSandbox; -*adjustConfig = [ADJConfig configWithAppToken:yourAppToken - environment:environment]; -// ... -[adjustConfig setExternalDeviceId:@"yourExternalDeviceId"]; -``` - - - - -```js {5} -setupWebViewJavascriptBridge(function(bridge) { - var yourAppToken = yourAppToken; - var environment = AdjustConfig.EnvironmentSandbox; - var adjustConfig = new AdjustConfig(yourAppToken, environment); - adjustConfig.setExternalDeviceId("yourExternalDeviceId"); -}); -``` - - - diff --git a/src/code-snippets/ios/examples/ADJConfig/setLinkMeEnabled.mdx b/src/code-snippets/ios/examples/ADJConfig/setLinkMeEnabled.mdx deleted file mode 100644 index 114cf3e55..000000000 --- a/src/code-snippets/ios/examples/ADJConfig/setLinkMeEnabled.mdx +++ /dev/null @@ -1,40 +0,0 @@ - - - -```swift {7} -let yourAppToken = "{YourAppToken}" -let environment = ADJEnvironmentSandbox as? String -let adjustConfig = ADJConfig( - appToken: yourAppToken, - environment: environment) -// ... -adjustConfig?.linkMeEnabled = true -``` - - - - -```objc {6} -NSString *yourAppToken = @"{YourAppToken}"; -NSString *environment = ADJEnvironmentSandbox; -*adjustConfig = [ADJConfig configWithAppToken:yourAppToken - environment:environment]; -/// ... -[adjustConfig setLinkMeEnabled:YES]; -``` - - - - -```js {6} -setupWebViewJavascriptBridge(function(bridge) { - // ... - var yourAppToken = yourAppToken; - var environment = AdjustConfig.EnvironmentSandbox; - var adjustConfig = new AdjustConfig(yourAppToken, environment); - adjustConfig.setLinkMeEnabled(true); -}); -``` - - - diff --git a/src/code-snippets/ios/examples/ADJConfig/setLogLevel.mdx b/src/code-snippets/ios/examples/ADJConfig/setLogLevel.mdx deleted file mode 100644 index d43c6a35e..000000000 --- a/src/code-snippets/ios/examples/ADJConfig/setLogLevel.mdx +++ /dev/null @@ -1,40 +0,0 @@ - - - -```swift {7} -let yourAppToken = "{YourAppToken}" -let environment = ADJEnvironmentSandbox as? String -let adjustConfig = ADJConfig( - appToken: yourAppToken, - environment: environment) -// ... -adjustConfig?.logLevel = ADJLogLevelVerbose -``` - - - - -```objective-c {6} -NSString *yourAppToken = @"{YourAppToken}"; -NSString *environment = ADJEnvironmentSandbox; -*adjustConfig = [ADJConfig configWithAppToken:yourAppToken - environment:environment]; -// ... -[adjustConfig setLogLevel:ADJLogLevelVerbose]; -``` - - - - -```javascript {6} -setupWebViewJavascriptBridge(function(bridge) { - // ... - var yourAppToken = yourAppToken; - var environment = AdjustConfig.EnvironmentSandbox; - var adjustConfig = new AdjustConfig(yourAppToken, environment); - adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose); -}); -``` - - - diff --git a/src/code-snippets/ios/examples/ADJConfig/setNeedsCost.mdx b/src/code-snippets/ios/examples/ADJConfig/setNeedsCost.mdx deleted file mode 100644 index f5691728a..000000000 --- a/src/code-snippets/ios/examples/ADJConfig/setNeedsCost.mdx +++ /dev/null @@ -1,39 +0,0 @@ - - - -```swift {7} -let yourAppToken = "{YourAppToken}" -let environment = ADJEnvironmentSandbox as? String -let adjustConfig = ADJConfig( - appToken: yourAppToken, - environment: environment) -// ... -adjustConfig?.needsCost = true -``` - - - - -```objc {6} -NSString *yourAppToken = @"{YourAppToken}"; -NSString *environment = ADJEnvironmentSandbox; -*adjustConfig = [ADJConfig configWithAppToken:yourAppToken - environment:environment]; -// ... -[adjustConfig setNeedsCost:YES]; -``` - - - - -```js {5} -setupWebViewJavascriptBridge(function(bridge) { - var yourAppToken = yourAppToken; - var environment = AdjustConfig.EnvironmentSandbox; - var adjustConfig = new AdjustConfig(yourAppToken, environment); - adjustConfig.setNeedsCost(true); -}); -``` - - - diff --git a/src/code-snippets/ios/examples/ADJConfig/setUrlStrategy.mdx b/src/code-snippets/ios/examples/ADJConfig/setUrlStrategy.mdx deleted file mode 100644 index 8ccb6dfc4..000000000 --- a/src/code-snippets/ios/examples/ADJConfig/setUrlStrategy.mdx +++ /dev/null @@ -1,40 +0,0 @@ - - - -```swift {7} -let yourAppToken = "{YourAppToken}" -let environment = ADJEnvironmentSandbox as? String -let adjustConfig = ADJConfig( - appToken: yourAppToken, - environment: environment) -// ... -adjustConfig?.urlStrategy = ADJDataResidencyEU -``` - - - - -```objective-c {6} -NSString *yourAppToken = @"{YourAppToken}"; -NSString *environment = ADJEnvironmentSandbox; -*adjustConfig = [ADJConfig configWithAppToken:yourAppToken - environment:environment]; -// ... -[adjustConfig setUrlStrategy:ADJDataResidencyEU]; -``` - - - - -```javascript {6} -setupWebViewJavascriptBridge(function(bridge) { - // ... - var yourAppToken = yourAppToken; - var environment = AdjustConfig.EnvironmentSandbox; - var adjustConfig = new AdjustConfig(yourAppToken, environment); - adjustConfig.setUrlStrategy(ADJDataResidencyEU); -}); -``` - - - diff --git a/src/code-snippets/ios/examples/ADJEvent/addCallbackParameter.mdx b/src/code-snippets/ios/examples/ADJEvent/addCallbackParameter.mdx deleted file mode 100644 index 90645a40a..000000000 --- a/src/code-snippets/ios/examples/ADJEvent/addCallbackParameter.mdx +++ /dev/null @@ -1,32 +0,0 @@ - - - -```swift -let event = ADJEvent(eventToken: "abc123") -event?.addCallbackParameter("key", value: "value") -event?.addCallbackParameter("foo", value: "bar") -Adjust.trackEvent(event) -``` - - - - -```objc -ADJEvent *event = [ADJEvent eventWithEventToken:@"abc123"]; -[event addCallbackParameter:@"key" value:@"value"]; -[event addCallbackParameter:@"foo" value:@"bar"]; -[Adjust trackEvent:event]; -``` - - - - -```js -var adjustEvent = new AdjustEvent(eventToken); -adjustEvent.addCallbackParameter('key', 'value'); -adjustEvent.addCallbackParameter('foo', 'bar'); -Adjust.trackEvent(adjustEvent); -``` - - - diff --git a/src/code-snippets/ios/examples/ADJEvent/addPartnerParameter.mdx b/src/code-snippets/ios/examples/ADJEvent/addPartnerParameter.mdx deleted file mode 100644 index 32cc97810..000000000 --- a/src/code-snippets/ios/examples/ADJEvent/addPartnerParameter.mdx +++ /dev/null @@ -1,32 +0,0 @@ - - - -```swift -let event = ADJEvent(eventToken: "abc123") -event?.addPartnerParameter("key", value: "value") -event?.addPartnerParameter("foo", value: "bar") -Adjust.trackEvent(event) -``` - - - - -```objc -ADJEvent *event = [ADJEvent eventWithEventToken:@"abc123"]; -[event addPartnerParameter:@"key" value:@"value"]; -[event addPartnerParameter:@"foo" value:@"bar"]; -[Adjust trackEvent:event]; -``` - - - - -```js -var adjustEvent = new AdjustEvent(eventToken); -adjustEvent.addPartnerParameter('key', 'value'); -adjustEvent.addPartnerParameter('foo', 'bar'); -Adjust.trackEvent(adjustEvent); -``` - - - diff --git a/src/code-snippets/ios/examples/ADJEvent/constructor.mdx b/src/code-snippets/ios/examples/ADJEvent/constructor.mdx deleted file mode 100644 index 6d820ea47..000000000 --- a/src/code-snippets/ios/examples/ADJEvent/constructor.mdx +++ /dev/null @@ -1,26 +0,0 @@ - - - -```swift -let event = ADJEvent(eventToken: "abc123") -Adjust.trackEvent(event) -``` - - - - -```objc -ADJEvent *event = [ADJEvent eventWithEventToken:@"abc123"]; -[Adjust trackEvent:event]; -``` - - - - -```js -var adjustEvent = new AdjustEvent('abc123'); -Adjust.trackEvent(adjustEvent); -``` - - - diff --git a/src/code-snippets/ios/examples/ADJEvent/setCallbackId.mdx b/src/code-snippets/ios/examples/ADJEvent/setCallbackId.mdx deleted file mode 100644 index aa37b4dc8..000000000 --- a/src/code-snippets/ios/examples/ADJEvent/setCallbackId.mdx +++ /dev/null @@ -1,29 +0,0 @@ - - - -```swift -let event = ADJEvent(eventToken: "abc123") -event?.setCallbackId("Your-Custom-ID") -Adjust.trackEvent(event) -``` - - - - -```objc -ADJEvent *event = [ADJEvent eventWithEventToken:@"abc123"]; -[event setCallbackId:@"Your-Custom-ID"]; -[Adjust trackEvent:event]; -``` - - - - -```js -var adjustEvent = new AdjustEvent('abc123') -adjustEvent.setCallbackId('Your-Custom-ID') -Adjust.trackEvent(adjustEvent) -``` - - - diff --git a/src/code-snippets/ios/examples/ADJEvent/setRevenue.mdx b/src/code-snippets/ios/examples/ADJEvent/setRevenue.mdx deleted file mode 100644 index fcfba0923..000000000 --- a/src/code-snippets/ios/examples/ADJEvent/setRevenue.mdx +++ /dev/null @@ -1,29 +0,0 @@ - - - -```swift -let event = ADJEvent(eventToken: "abc123") -event?.setRevenue(0.01, currency: "EUR") -Adjust.trackEvent(event) -``` - - - - -```objc -ADJEvent *event = [ADJEvent eventWithEventToken:@"abc123"]; -[event setRevenue:0.01 currency:@"EUR"]; -[Adjust trackEvent:event]; -``` - - - - -```js -var adjustEvent = new AdjustEvent(eventToken); -adjustEvent.setRevenue(0.01, 'EUR'); -Adjust.trackEvent(adjustEvent); -``` - - - diff --git a/src/code-snippets/ios/examples/ADJEvent/setTransactionId.mdx b/src/code-snippets/ios/examples/ADJEvent/setTransactionId.mdx deleted file mode 100644 index 92ecae45f..000000000 --- a/src/code-snippets/ios/examples/ADJEvent/setTransactionId.mdx +++ /dev/null @@ -1,29 +0,0 @@ - - - -```swift -let event = ADJEvent(eventToken: "abc123") -event?.setTransactionId(eventIdentifier) -Adjust.trackEvent(event) -``` - - - - -```objc -ADJEvent *event = [ADJEvent eventWithEventToken:@"abc123"]; -[event setTransactionId:eventIdentifier]; -[Adjust trackEvent:event]; -``` - - - - -```js -var adjustEvent = new AdjustEvent(eventToken); -adjustEvent.setTransactionId(eventIdentifier); -Adjust.trackEvent(adjustEvent); -``` - - - diff --git a/src/code-snippets/ios/examples/ADJLinkResolution/resolveLinkWithUrl.mdx b/src/code-snippets/ios/examples/ADJLinkResolution/resolveLinkWithUrl.mdx deleted file mode 100644 index dda3c4839..000000000 --- a/src/code-snippets/ios/examples/ADJLinkResolution/resolveLinkWithUrl.mdx +++ /dev/null @@ -1,27 +0,0 @@ - - - -```swift -ADJLinkResolution.resolveLink( - withUrl: url, - resolveUrlSuffixArray: ["example.com"], - callback: { resolvedLink in - Adjust.appWillOpen(resolvedLink) - }) -``` - - - - -```objective-c -[ADJLinkResolution - resolveLinkWithUrl:url - resolveUrlSuffixArray:@[@"example.com"] - callback:^(NSURL * _Nullable resolvedLink) - { - [Adjust appWillOpenUrl:resolvedLink]; - }]; -``` - - - diff --git a/src/code-snippets/ios/examples/ADJSubscription/addCallbackParameter.mdx b/src/code-snippets/ios/examples/ADJSubscription/addCallbackParameter.mdx deleted file mode 100644 index 730ff2bb2..000000000 --- a/src/code-snippets/ios/examples/ADJSubscription/addCallbackParameter.mdx +++ /dev/null @@ -1,29 +0,0 @@ - - - -```swift {7,8} -let subscription = ADJSubscription( - price: price, - currency: currency, - transactionId: transactionId, - andReceipt: receipt) -// ... -subscription.addCallbackParameter("key1", value: "value1") -subscription.addCallbackParameter("key2", value: "value2") -``` - - - - -```objc {6,7} -ADJSubscription *subscription = [[ADJSubscription alloc] initWithPrice:price - currency:currency - transactionId:transactionId - andReceipt:receipt]; -/// ... -[subscription addCallbackParameter:@"key1" value:@"value1"]; -[subscription addCallbackParameter:@"key2" value:@"value2"]; -``` - - - diff --git a/src/code-snippets/ios/examples/ADJSubscription/addPartnerParameter.mdx b/src/code-snippets/ios/examples/ADJSubscription/addPartnerParameter.mdx deleted file mode 100644 index 78a70a0b4..000000000 --- a/src/code-snippets/ios/examples/ADJSubscription/addPartnerParameter.mdx +++ /dev/null @@ -1,29 +0,0 @@ - - - -```swift {7,8} -let subscription = ADJSubscription( - price: price, - currency: currency, - transactionId: transactionId, - andReceipt: receipt) -// ... -subscription.addParameterParameter("key1", value: "value1") -subscription.addParameterParameter("key2", value: "value2") -``` - - - - -```objc {6,7} -ADJSubscription *subscription = [[ADJSubscription alloc] initWithPrice:price - currency:currency - transactionId:transactionId - andReceipt:receipt]; -/// ... -[subscription addParameterParameter:@"key1" value:@"value1"]; -[subscription addParameterParameter:@"key2" value:@"value2"]; -``` - - - diff --git a/src/code-snippets/ios/examples/ADJSubscription/constructor.mdx b/src/code-snippets/ios/examples/ADJSubscription/constructor.mdx deleted file mode 100644 index 8022996be..000000000 --- a/src/code-snippets/ios/examples/ADJSubscription/constructor.mdx +++ /dev/null @@ -1,23 +0,0 @@ - - - -```swift -let subscription = ADJSubscription( - price: price, - currency: currency, - transactionId: transactionId, - andReceipt: receipt) -``` - - - - -```objc -ADJSubscription *subscription = [[ADJSubscription alloc] initWithPrice:price - currency:currency - transactionId:transactionId - andReceipt:receipt]; -``` - - - diff --git a/src/code-snippets/ios/examples/ADJSubscription/setSalesRegion.mdx b/src/code-snippets/ios/examples/ADJSubscription/setSalesRegion.mdx deleted file mode 100644 index 2f6c12dd8..000000000 --- a/src/code-snippets/ios/examples/ADJSubscription/setSalesRegion.mdx +++ /dev/null @@ -1,27 +0,0 @@ - - - -```swift {7} -let subscription = ADJSubscription( - price: price, - currency: currency, - transactionId: transactionId, - andReceipt: receipt) -// ... -subscription.setSalesRegion(salesRegion) -``` - - - - -```objc {6} -ADJSubscription *subscription = [[ADJSubscription alloc] initWithPrice:price - currency:currency - transactionId:transactionId - andReceipt:receipt]; -/// ... -[subscription setSalesRegion:salesRegion]; -``` - - - diff --git a/src/code-snippets/ios/examples/ADJSubscription/setTransactionDate.mdx b/src/code-snippets/ios/examples/ADJSubscription/setTransactionDate.mdx deleted file mode 100644 index 1017539ac..000000000 --- a/src/code-snippets/ios/examples/ADJSubscription/setTransactionDate.mdx +++ /dev/null @@ -1,27 +0,0 @@ - - - -```swift {7} -let subscription = ADJSubscription( - price: price, - currency: currency, - transactionId: transactionId, - andReceipt: receipt) -// ... -subscription.setTransactionDate(transactionDate) -``` - - - - -```objc {6} -ADJSubscription *subscription = [[ADJSubscription alloc] initWithPrice:price - currency:currency - transactionId:transactionId - andReceipt:receipt]; -/// ... -[subscription setTransactionDate:transactionDate]; -``` - - - diff --git a/src/code-snippets/ios/examples/ADJThirdPartySharing/addGranularOption.mdx b/src/code-snippets/ios/examples/ADJThirdPartySharing/addGranularOption.mdx deleted file mode 100644 index 6568a3ac7..000000000 --- a/src/code-snippets/ios/examples/ADJThirdPartySharing/addGranularOption.mdx +++ /dev/null @@ -1,29 +0,0 @@ - - - -```swift -let adjustThirdPartySharing = ADJThirdPartySharing.initWithIsEnabledNumberBool(nil) -adjustThirdPartySharing.addGranularOption("PartnerA", key: "foo", value: "bar") -Adjust.trackThirdPartySharing(adjustThirdPartySharing) -``` - - - - -```objc -ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabledNumberBool:nil]; -[adjustThirdPartySharing addGranularOption:@"PartnerA" key:@"foo" value:@"bar"]; -[Adjust trackThirdPartySharing:adjustThirdPartySharing]; -``` - - - - -```js -var adjustThirdPartySharing = new AdjustThirdPartySharing(null); -adjustThirdPartySharing.addGranularOption('PartnerA', 'foo', 'bar'); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - - - diff --git a/src/code-snippets/ios/examples/ADJThirdPartySharing/addGranularOptionFacebook.mdx b/src/code-snippets/ios/examples/ADJThirdPartySharing/addGranularOptionFacebook.mdx deleted file mode 100644 index 1137c6890..000000000 --- a/src/code-snippets/ios/examples/ADJThirdPartySharing/addGranularOptionFacebook.mdx +++ /dev/null @@ -1,32 +0,0 @@ - - - -```swift -let tps = ADJThirdPartySharing.initWithIsEnabledNumberBool(nil) -tps.addGranularOption("facebook", key: "data_processing_options_country", value: "1") -tps.addGranularOption("facebook", key: "data_processing_options_state", value: "1000") -Adjust.trackThirdPartySharing(tps) -``` - - - - -```objc -ADJThirdPartySharing *tps = [[ADJThirdPartySharing alloc] initWithIsEnabledNumberBool:@YES]; -[tps addGranularOption:@"facebook" key:@"data_processing_options_country" value:@"1"]; -[tps addGranularOption:@"facebook" key:@"data_processing_options_state" value:@"1000"]; -[Adjust trackThirdPartySharing:tps]; -``` - - - - -```js -var tps = new AdjustThirdPartySharing(null); -tps.addGranularOption('facebook', 'data_processing_options_country', '1'); -tps.addGranularOption('facebook', 'data_processing_options_state', '1000'); -Adjust.trackThirdPartySharing(tps); -``` - - - diff --git a/src/code-snippets/ios/examples/ADJThirdPartySharing/addPartnerSharingSetting.mdx b/src/code-snippets/ios/examples/ADJThirdPartySharing/addPartnerSharingSetting.mdx deleted file mode 100644 index cb9c4d4e1..000000000 --- a/src/code-snippets/ios/examples/ADJThirdPartySharing/addPartnerSharingSetting.mdx +++ /dev/null @@ -1,29 +0,0 @@ - - - -```swift -let adjustThirdPartySharing = ADJThirdPartySharing.initWithIsEnabledNumberBool(nil) -adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", key: "foo", value: false) -Adjust.trackThirdPartySharing(adjustThirdPartySharing) -``` - - - - -```objc -ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabledNumberBool:nil]; -[adjustThirdPartySharing addPartnerSharingSetting:@"PartnerA" key:@"foo" value:@NO]; -[Adjust trackThirdPartySharing:adjustThirdPartySharing]; -``` - - - - -```js -var adjustThirdPartySharing = new AdjustThirdPartySharing(null); -adjustThirdPartySharing.addPartnerSharingSetting('PartnerA', 'foo', false); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - - - diff --git a/src/code-snippets/ios/examples/ADJThirdPartySharing/initWithIsEnabledNumberBoolFalse.mdx b/src/code-snippets/ios/examples/ADJThirdPartySharing/initWithIsEnabledNumberBoolFalse.mdx deleted file mode 100644 index f7bd6153c..000000000 --- a/src/code-snippets/ios/examples/ADJThirdPartySharing/initWithIsEnabledNumberBoolFalse.mdx +++ /dev/null @@ -1,26 +0,0 @@ - - - -```swift -let adjustThirdPartySharing = ADJThirdPartySharing.initWithIsEnabledNumberBool(0) -Adjust.trackThirdPartySharing(adjustThirdPartySharing) -``` - - - - -```objc -ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabledNumberBool:0]; -[Adjust trackThirdPartySharing:adjustThirdPartySharing]; -``` - - - - -```js -var adjustThirdPartySharing = new AdjustThirdPartySharing(0); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - - - diff --git a/src/code-snippets/ios/examples/ADJThirdPartySharing/initWithIsEnabledNumberBoolTrue.mdx b/src/code-snippets/ios/examples/ADJThirdPartySharing/initWithIsEnabledNumberBoolTrue.mdx deleted file mode 100644 index bcdff367e..000000000 --- a/src/code-snippets/ios/examples/ADJThirdPartySharing/initWithIsEnabledNumberBoolTrue.mdx +++ /dev/null @@ -1,26 +0,0 @@ - - - -```swift -let adjustThirdPartySharing = ADJThirdPartySharing.initWithIsEnabledNumberBool(1) -Adjust.trackThirdPartySharing(adjustThirdPartySharing) -``` - - - - -```objc -ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabledNumberBool:1]; -[Adjust trackThirdPartySharing:adjustThirdPartySharing]; -``` - - - - -```js -var adjustThirdPartySharing = new AdjustThirdPartySharing(1); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/addSessionCallbackParameter.mdx b/src/code-snippets/ios/examples/Adjust/addSessionCallbackParameter.mdx deleted file mode 100644 index d6cdf82f3..000000000 --- a/src/code-snippets/ios/examples/Adjust/addSessionCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)addSessionCallbackParameter:(nonnull NSString *)key value:(nonnull NSString *)value; -``` diff --git a/src/code-snippets/ios/examples/Adjust/addSessionPartnerParameter.mdx b/src/code-snippets/ios/examples/Adjust/addSessionPartnerParameter.mdx deleted file mode 100644 index bde380c56..000000000 --- a/src/code-snippets/ios/examples/Adjust/addSessionPartnerParameter.mdx +++ /dev/null @@ -1,23 +0,0 @@ - - - -```swift -Adjust.addSessionPartnerParameter("foo", value: "bar") -``` - - - - -```objc -[Adjust addSessionPartnerParameter:@"foo" value:@"bar"]; -``` - - - - -```js -Adjust.addSessionPartnerParameter('foo', 'bar'); -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/adid.mdx b/src/code-snippets/ios/examples/Adjust/adid.mdx deleted file mode 100644 index 641ac90f9..000000000 --- a/src/code-snippets/ios/examples/Adjust/adid.mdx +++ /dev/null @@ -1,23 +0,0 @@ - - - -```swift -let adid = Adjust.adid() -``` - - - - -```objc -NSString *adid = [Adjust adid]; -``` - - - - -```js -var adid = Adjust.getAdid(); -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/appTrackingAuthorizationStatus.mdx b/src/code-snippets/ios/examples/Adjust/appTrackingAuthorizationStatus.mdx deleted file mode 100644 index 063b358b9..000000000 --- a/src/code-snippets/ios/examples/Adjust/appTrackingAuthorizationStatus.mdx +++ /dev/null @@ -1,24 +0,0 @@ - - - -```swift -let authorizationStatus = Adjust.appTrackingAuthorizationStatus(); -``` - - - - -```objc -int authorizationStatus = [Adjust appTrackingAuthorizationStatus]; -``` - - - - - -```js -var authorizationStatus = Adjust.appTrackingAuthorizationStatus(); -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/appWillOpenUrl.mdx b/src/code-snippets/ios/examples/Adjust/appWillOpenUrl.mdx deleted file mode 100644 index 1c05d4188..000000000 --- a/src/code-snippets/ios/examples/Adjust/appWillOpenUrl.mdx +++ /dev/null @@ -1,16 +0,0 @@ - - - -```swift -Adjust.appWillOpenUrl(url) -``` - - - - -```objc -[Adjust appWillOpenUrl:url]; -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/attribution.mdx b/src/code-snippets/ios/examples/Adjust/attribution.mdx deleted file mode 100644 index ff850c76f..000000000 --- a/src/code-snippets/ios/examples/Adjust/attribution.mdx +++ /dev/null @@ -1,23 +0,0 @@ - - - -```swift -let attribution = Adjust.attribution() -``` - - - - -```objc -ADJAttribution *attribution = [Adjust attribution]; -``` - - - - -```js -var attribution = Adjust.getAttribution(); -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/checkForNewAttStatus.mdx b/src/code-snippets/ios/examples/Adjust/checkForNewAttStatus.mdx deleted file mode 100644 index dfe74fa6b..000000000 --- a/src/code-snippets/ios/examples/Adjust/checkForNewAttStatus.mdx +++ /dev/null @@ -1,16 +0,0 @@ - - - -```swift -Adjust.checkForNewAttStatus(); -``` - - - - -```objc -[Adjust checkForNewAttStatus]; -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/disableThirdPartySharing.mdx b/src/code-snippets/ios/examples/Adjust/disableThirdPartySharing.mdx deleted file mode 100644 index f87ecb119..000000000 --- a/src/code-snippets/ios/examples/Adjust/disableThirdPartySharing.mdx +++ /dev/null @@ -1,23 +0,0 @@ - - - -```swift -Adjust.disableThirdPartySharing() -``` - - - - -```objc -[Adjust disableThirdPartySharing]; -``` - - - - -```js -Adjust.disableThirdPartySharing(); -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/gdprForgetMe.mdx b/src/code-snippets/ios/examples/Adjust/gdprForgetMe.mdx deleted file mode 100644 index cd1474005..000000000 --- a/src/code-snippets/ios/examples/Adjust/gdprForgetMe.mdx +++ /dev/null @@ -1,23 +0,0 @@ - - - -```swift -Adjust.gdprForgetMe(); -``` - - - - -```objc -[Adjust gdprForgetMe]; -``` - - - - -```js -Adjust.gdprForgetMe(); -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/idfa.mdx b/src/code-snippets/ios/examples/Adjust/idfa.mdx deleted file mode 100644 index a30c02d9b..000000000 --- a/src/code-snippets/ios/examples/Adjust/idfa.mdx +++ /dev/null @@ -1,25 +0,0 @@ - - - -```swift -let idfa = Adjust.idfa() -``` - - - - -```objc -NSString *idfa = [Adjust idfa]; -``` - - - - -```js -Adjust.getIdfa(function(idfa) { - // … -}); -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/isEnabled.mdx b/src/code-snippets/ios/examples/Adjust/isEnabled.mdx deleted file mode 100644 index 4bb80c9dd..000000000 --- a/src/code-snippets/ios/examples/Adjust/isEnabled.mdx +++ /dev/null @@ -1,23 +0,0 @@ - - - -```swift -Adjust.isEnabled() -``` - - - - -```objc -[Adjust isEnabled]; -``` - - - - -```js -Adjust.isEnabled(); -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/removeSessionCallbackParameter.mdx b/src/code-snippets/ios/examples/Adjust/removeSessionCallbackParameter.mdx deleted file mode 100644 index 6e25c8b65..000000000 --- a/src/code-snippets/ios/examples/Adjust/removeSessionCallbackParameter.mdx +++ /dev/null @@ -1,23 +0,0 @@ - - - -```swift -Adjust.removeSessionCallbackParameter("foo") -``` - - - - -```objc -[Adjust removeSessionCallbackParameter:@"foo"]; -``` - - - - -```js -Adjust.removeSessionCallbackParameter('foo'); -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/removeSessionPartnerParameter.mdx b/src/code-snippets/ios/examples/Adjust/removeSessionPartnerParameter.mdx deleted file mode 100644 index db121cfe5..000000000 --- a/src/code-snippets/ios/examples/Adjust/removeSessionPartnerParameter.mdx +++ /dev/null @@ -1,23 +0,0 @@ - - - -```swift -Adjust.removeSessionPartnerParameter("foo") -``` - - - - -```objc -[Adjust removeSessionPartnerParameter:@"foo"]; -``` - - - - -```js -Adjust.removeSessionPartnerParameter('foo'); -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/requestTrackingAuthorization.mdx b/src/code-snippets/ios/examples/Adjust/requestTrackingAuthorization.mdx deleted file mode 100644 index b18d5c8f7..000000000 --- a/src/code-snippets/ios/examples/Adjust/requestTrackingAuthorization.mdx +++ /dev/null @@ -1,48 +0,0 @@ - - - -```swift -Adjust.requestTrackingAuthorization() { status in - switch status { - case 0: - // ATTrackingManagerAuthorizationStatusNotDetermined case - break - case 1: - // ATTrackingManagerAuthorizationStatusRestricted case - break - case 2: - // ATTrackingManagerAuthorizationStatusDenied case - break - case 3: - // ATTrackingManagerAuthorizationStatusAuthorized case - break - default: - break - } -} -``` - - - - -```objc -[Adjust requestTrackingAuthorizationWithCompletionHandler:^(NSUInteger status) { - switch (status) { - case 0: - // ATTrackingManagerAuthorizationStatusNotDetermined case - break; - case 1: - // ATTrackingManagerAuthorizationStatusRestricted case - break; - case 2: - // ATTrackingManagerAuthorizationStatusDenied case - break; - case 3: - // ATTrackingManagerAuthorizationStatusAuthorized case - break; - } -}]; -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/resetSessionCallbackParameters.mdx b/src/code-snippets/ios/examples/Adjust/resetSessionCallbackParameters.mdx deleted file mode 100644 index 27524d425..000000000 --- a/src/code-snippets/ios/examples/Adjust/resetSessionCallbackParameters.mdx +++ /dev/null @@ -1,23 +0,0 @@ - - - -```swift -Adjust.resetSessionCallbackParameters() -``` - - - - -```objc -[Adjust resetSessionCallbackParameters]; -``` - - - - -```js -Adjust.resetSessionCallbackParameters(); -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/resetSessionPartnerParameters.mdx b/src/code-snippets/ios/examples/Adjust/resetSessionPartnerParameters.mdx deleted file mode 100644 index cd25833cb..000000000 --- a/src/code-snippets/ios/examples/Adjust/resetSessionPartnerParameters.mdx +++ /dev/null @@ -1,23 +0,0 @@ - - - -```swift -Adjust.resetSessionPartnerParameters() -``` - - - - -```objc -[Adjust resetSessionPartnerParameters]; -``` - - - - -```js -Adjust.resetSessionPartnerParameters(); -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/sendFirstPackages.mdx b/src/code-snippets/ios/examples/Adjust/sendFirstPackages.mdx deleted file mode 100644 index 8283c8132..000000000 --- a/src/code-snippets/ios/examples/Adjust/sendFirstPackages.mdx +++ /dev/null @@ -1,23 +0,0 @@ - - - -```swift -Adjust.sendFirstPackages() -``` - - - - -```objc -[Adjust sendFirstPackages]; -``` - - - - -```js -Adjust.sendFirstPackages(); -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/setDeviceToken.mdx b/src/code-snippets/ios/examples/Adjust/setDeviceToken.mdx deleted file mode 100644 index efc9d4e92..000000000 --- a/src/code-snippets/ios/examples/Adjust/setDeviceToken.mdx +++ /dev/null @@ -1,27 +0,0 @@ - - - -```swift {2} -func application(_ app: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) { - Adjust.deviceToken = deviceToken -} -``` - - - - -```objc {2} -- (void)application:(UIApplication *)app didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken { - [Adjust setDeviceToken:deviceToken]; -} -``` - - - - -```js -Adjust.setDeviceToken(deviceToken); -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/setEnabled.mdx b/src/code-snippets/ios/examples/Adjust/setEnabled.mdx deleted file mode 100644 index 97acb90ef..000000000 --- a/src/code-snippets/ios/examples/Adjust/setEnabled.mdx +++ /dev/null @@ -1,23 +0,0 @@ - - - -```swift -Adjust.setEnabled(true) -``` - - - - -```objc -[Adjust setEnabled:NO]; -``` - - - - -```js -Adjust.setEnabled(false); -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/setOfflineMode.mdx b/src/code-snippets/ios/examples/Adjust/setOfflineMode.mdx deleted file mode 100644 index c97aa953a..000000000 --- a/src/code-snippets/ios/examples/Adjust/setOfflineMode.mdx +++ /dev/null @@ -1,24 +0,0 @@ - - - -```swift -Adjust.setOfflineMode(true); -``` - - - - -```objc -[Adjust setOfflineMode:YES]; -``` - - - - - -```js -Adjust.setOfflineMode(true); -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/trackAdRevenue.mdx b/src/code-snippets/ios/examples/Adjust/trackAdRevenue.mdx deleted file mode 100644 index 7156f7939..000000000 --- a/src/code-snippets/ios/examples/Adjust/trackAdRevenue.mdx +++ /dev/null @@ -1,19 +0,0 @@ - - - -```swift -let adRevenue = ADJAdRevenue(source: source); -Adjust.trackAdRevenue(adRevenue); -``` - - - - -```objc -ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source]; -///... -[Adjust trackAdRevenue:adRevenue]; -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/trackEvent.mdx b/src/code-snippets/ios/examples/Adjust/trackEvent.mdx deleted file mode 100644 index 6d820ea47..000000000 --- a/src/code-snippets/ios/examples/Adjust/trackEvent.mdx +++ /dev/null @@ -1,26 +0,0 @@ - - - -```swift -let event = ADJEvent(eventToken: "abc123") -Adjust.trackEvent(event) -``` - - - - -```objc -ADJEvent *event = [ADJEvent eventWithEventToken:@"abc123"]; -[Adjust trackEvent:event]; -``` - - - - -```js -var adjustEvent = new AdjustEvent('abc123'); -Adjust.trackEvent(adjustEvent); -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/trackMeasurementConsent.mdx b/src/code-snippets/ios/examples/Adjust/trackMeasurementConsent.mdx deleted file mode 100644 index ba72f26ff..000000000 --- a/src/code-snippets/ios/examples/Adjust/trackMeasurementConsent.mdx +++ /dev/null @@ -1,23 +0,0 @@ - - - -```swift -Adjust.trackMeasurementConsent(true) -``` - - - - -```objc -[Adjust trackMeasurementConsent:YES]; -``` - - - - -```js -Adjust.trackMeasurementConsent(false); -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/trackSubscription.mdx b/src/code-snippets/ios/examples/Adjust/trackSubscription.mdx deleted file mode 100644 index 47b75adc2..000000000 --- a/src/code-snippets/ios/examples/Adjust/trackSubscription.mdx +++ /dev/null @@ -1,50 +0,0 @@ - - - -```swift {20} -let subscription = ADJSubscription( - price: price, - currency: currency, - transactionId: transactionId, - andReceipt: receipt) - -subscription.setTransactionDate(transactionDate) -subscription.setSalesRegion(salesRegion) - -// Add callback parameters - -subscription.addCallbackParameter("key1", value: "value1") -subscription.addCallbackParameter("key2", value: "value2") - -// Add partner parameters - -subscription.addPartnerParameter("key1", value: "value1") -subscription.addCallbackParameter("key2", value: "value2") - -Adjust.trackSubscription(subscription) -``` - - - - -```objc {16} -ADJSubscription *subscription = [[ADJSubscription alloc] initWithPrice:price - currency:currency - transactionId:transactionId - andReceipt:receipt]; -[subscription setTransactionDate:transactionDate]; -[subscription setSalesRegion:salesRegion]; - -/// Add callback parameters -[subscription addCallbackParameter:@"key1" value:@"value1"]; -[subscription addCallbackParameter:@"key2" value:@"value2"]; - -/// Add partner parameters -[subscription addPartnerParameter:@"key1" value:@"value1"]; -[subscription addPartnerParameter:@"key2" value:@"value2"]; - -[Adjust trackSubscription:subscription]; -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/trackThirdPartySharing.mdx b/src/code-snippets/ios/examples/Adjust/trackThirdPartySharing.mdx deleted file mode 100644 index 94f44c3b5..000000000 --- a/src/code-snippets/ios/examples/Adjust/trackThirdPartySharing.mdx +++ /dev/null @@ -1,26 +0,0 @@ - - - -```swift {2} -let adjustThirdPartySharing = ADJThirdPartySharing.initWithIsEnabledNumberBool(true) -Adjust.trackThirdPartySharing(adjustThirdPartySharing) -``` - - - - -```objc {2} -ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabledNumberBool:@YES]; -[Adjust trackThirdPartySharing:adjustThirdPartySharing]; -``` - - - - -```javascript {2} -var adjustThirdPartySharing = new AdjustThirdPartySharing(true); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - - - diff --git a/src/code-snippets/ios/examples/Adjust/updateConversionValue.mdx b/src/code-snippets/ios/examples/Adjust/updateConversionValue.mdx deleted file mode 100644 index b291cfc9d..000000000 --- a/src/code-snippets/ios/examples/Adjust/updateConversionValue.mdx +++ /dev/null @@ -1,16 +0,0 @@ - - - -```swift -Adjust.updateConversionValue(value) -``` - - - - -```objc -[Adjust updateConversionValue:value]; -``` - - - diff --git a/src/code-snippets/ios/signatures/ADJAdRevenue/addCallbackParameter.mdx b/src/code-snippets/ios/signatures/ADJAdRevenue/addCallbackParameter.mdx deleted file mode 100644 index e66af2fa7..000000000 --- a/src/code-snippets/ios/signatures/ADJAdRevenue/addCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -- (void)addCallbackParameter:(nonnull NSString *)key value:(nonnull NSString *)value; -``` diff --git a/src/code-snippets/ios/signatures/ADJAdRevenue/addPartnerParameter.mdx b/src/code-snippets/ios/signatures/ADJAdRevenue/addPartnerParameter.mdx deleted file mode 100644 index 8035ddf3a..000000000 --- a/src/code-snippets/ios/signatures/ADJAdRevenue/addPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -- (void)addPartnerParameter:(nonnull NSString *)key value:(nonnull NSString *)value; -``` diff --git a/src/code-snippets/ios/signatures/ADJAdRevenue/constructor.mdx b/src/code-snippets/ios/signatures/ADJAdRevenue/constructor.mdx deleted file mode 100644 index 17cb8a097..000000000 --- a/src/code-snippets/ios/signatures/ADJAdRevenue/constructor.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -- (nullable id)initWithSource:(nonnull NSString *)source; -``` diff --git a/src/code-snippets/ios/signatures/ADJAdRevenue/setAdImpressionsCount.mdx b/src/code-snippets/ios/signatures/ADJAdRevenue/setAdImpressionsCount.mdx deleted file mode 100644 index df7d50e95..000000000 --- a/src/code-snippets/ios/signatures/ADJAdRevenue/setAdImpressionsCount.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -- (void)setAdImpressionsCount:(int)adImpressionsCount; -``` diff --git a/src/code-snippets/ios/signatures/ADJAdRevenue/setAdRevenueNetwork.mdx b/src/code-snippets/ios/signatures/ADJAdRevenue/setAdRevenueNetwork.mdx deleted file mode 100644 index a37378b9b..000000000 --- a/src/code-snippets/ios/signatures/ADJAdRevenue/setAdRevenueNetwork.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -- (void)setAdRevenueNetwork:(nonnull NSString *)adRevenueNetwork; -``` diff --git a/src/code-snippets/ios/signatures/ADJAdRevenue/setAdRevenuePlacement.mdx b/src/code-snippets/ios/signatures/ADJAdRevenue/setAdRevenuePlacement.mdx deleted file mode 100644 index 11dc34e8e..000000000 --- a/src/code-snippets/ios/signatures/ADJAdRevenue/setAdRevenuePlacement.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -- (void)setAdRevenuePlacement:(nonnull NSString *)adRevenuePlacement; -``` diff --git a/src/code-snippets/ios/signatures/ADJAdRevenue/setAdRevenueUnit.mdx b/src/code-snippets/ios/signatures/ADJAdRevenue/setAdRevenueUnit.mdx deleted file mode 100644 index dc07e35ca..000000000 --- a/src/code-snippets/ios/signatures/ADJAdRevenue/setAdRevenueUnit.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -- (void)setAdRevenueUnit:(nonnull NSString *)adRevenueUnit; -``` diff --git a/src/code-snippets/ios/signatures/ADJAdRevenue/setRevenue.mdx b/src/code-snippets/ios/signatures/ADJAdRevenue/setRevenue.mdx deleted file mode 100644 index 156d74917..000000000 --- a/src/code-snippets/ios/signatures/ADJAdRevenue/setRevenue.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -- (void)setRevenue:(double)amount currency:(nonnull NSString *)currency; -``` diff --git a/src/code-snippets/ios/signatures/ADJConfig/constructor.mdx b/src/code-snippets/ios/signatures/ADJConfig/constructor.mdx deleted file mode 100644 index 910140038..000000000 --- a/src/code-snippets/ios/signatures/ADJConfig/constructor.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```objc -+ (nullable ADJConfig *)configWithAppToken:(nonnull NSString *)appToken - environment:(nonnull NSString *)environment - allowSuppressLogLevel:(BOOL)allowSuppressLogLevel; -``` diff --git a/src/code-snippets/ios/signatures/ADJConfig/deactivateSKAdNetworkHandling.mdx b/src/code-snippets/ios/signatures/ADJConfig/deactivateSKAdNetworkHandling.mdx deleted file mode 100644 index 3d848835a..000000000 --- a/src/code-snippets/ios/signatures/ADJConfig/deactivateSKAdNetworkHandling.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -- (void)deactivateSKAdNetworkHandling; -``` diff --git a/src/code-snippets/ios/signatures/ADJConfig/setAllowAdServicesInfoReading.mdx b/src/code-snippets/ios/signatures/ADJConfig/setAllowAdServicesInfoReading.mdx deleted file mode 100644 index 729d0e485..000000000 --- a/src/code-snippets/ios/signatures/ADJConfig/setAllowAdServicesInfoReading.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -@property (nonatomic, assign) BOOL allowAdServicesInfoReading; -``` diff --git a/src/code-snippets/ios/signatures/ADJConfig/setAllowIdfaReading.mdx b/src/code-snippets/ios/signatures/ADJConfig/setAllowIdfaReading.mdx deleted file mode 100644 index 3d86feebf..000000000 --- a/src/code-snippets/ios/signatures/ADJConfig/setAllowIdfaReading.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -@property (nonatomic, assign) BOOL allowIdfaReading; -``` diff --git a/src/code-snippets/ios/signatures/ADJConfig/setDefaultTracker.mdx b/src/code-snippets/ios/signatures/ADJConfig/setDefaultTracker.mdx deleted file mode 100644 index d78bf94e5..000000000 --- a/src/code-snippets/ios/signatures/ADJConfig/setDefaultTracker.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -@property (nonatomic, copy, nullable) NSString *defaultTracker; -``` diff --git a/src/code-snippets/ios/signatures/ADJConfig/setDelayStart.mdx b/src/code-snippets/ios/signatures/ADJConfig/setDelayStart.mdx deleted file mode 100644 index 98aaa93fa..000000000 --- a/src/code-snippets/ios/signatures/ADJConfig/setDelayStart.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -@property (nonatomic, assign) double delayStart; -``` diff --git a/src/code-snippets/ios/signatures/ADJConfig/setDelegate.mdx b/src/code-snippets/ios/signatures/ADJConfig/setDelegate.mdx deleted file mode 100644 index 9cf26af2f..000000000 --- a/src/code-snippets/ios/signatures/ADJConfig/setDelegate.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -@property (nonatomic, weak, nullable) NSObject *delegate; -``` diff --git a/src/code-snippets/ios/signatures/ADJConfig/setEventBufferingEnabled.mdx b/src/code-snippets/ios/signatures/ADJConfig/setEventBufferingEnabled.mdx deleted file mode 100644 index 30ee3683a..000000000 --- a/src/code-snippets/ios/signatures/ADJConfig/setEventBufferingEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -@property (nonatomic, assign) BOOL eventBufferingEnabled; -``` diff --git a/src/code-snippets/ios/signatures/ADJConfig/setExternalDeviceId.mdx b/src/code-snippets/ios/signatures/ADJConfig/setExternalDeviceId.mdx deleted file mode 100644 index b1fbc750f..000000000 --- a/src/code-snippets/ios/signatures/ADJConfig/setExternalDeviceId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -@property (nonatomic, copy, nullable) NSString *externalDeviceId; -``` diff --git a/src/code-snippets/ios/signatures/ADJConfig/setLinkMeEnabled.mdx b/src/code-snippets/ios/signatures/ADJConfig/setLinkMeEnabled.mdx deleted file mode 100644 index 873477ad5..000000000 --- a/src/code-snippets/ios/signatures/ADJConfig/setLinkMeEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -@property (nonatomic, assign) BOOL linkMeEnabled; -``` diff --git a/src/code-snippets/ios/signatures/ADJConfig/setLogLevel.mdx b/src/code-snippets/ios/signatures/ADJConfig/setLogLevel.mdx deleted file mode 100644 index a5b1fab2a..000000000 --- a/src/code-snippets/ios/signatures/ADJConfig/setLogLevel.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -@property (nonatomic, assign) ADJLogLevel logLevel; -``` diff --git a/src/code-snippets/ios/signatures/ADJConfig/setNeedsCost.mdx b/src/code-snippets/ios/signatures/ADJConfig/setNeedsCost.mdx deleted file mode 100644 index a68870539..000000000 --- a/src/code-snippets/ios/signatures/ADJConfig/setNeedsCost.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -@property (nonatomic, assign) BOOL needsCost; -``` diff --git a/src/code-snippets/ios/signatures/ADJConfig/setSendInBackground.mdx b/src/code-snippets/ios/signatures/ADJConfig/setSendInBackground.mdx deleted file mode 100644 index 200a56456..000000000 --- a/src/code-snippets/ios/signatures/ADJConfig/setSendInBackground.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -@property (nonatomic, assign) BOOL sendInBackground; -``` diff --git a/src/code-snippets/ios/signatures/ADJConfig/setUrlStrategy.mdx b/src/code-snippets/ios/signatures/ADJConfig/setUrlStrategy.mdx deleted file mode 100644 index 9e25b89a7..000000000 --- a/src/code-snippets/ios/signatures/ADJConfig/setUrlStrategy.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -@property (nonatomic, copy, readwrite, nullable) NSString *urlStrategy; -``` diff --git a/src/code-snippets/ios/signatures/ADJEvent/addCallbackParameter.mdx b/src/code-snippets/ios/signatures/ADJEvent/addCallbackParameter.mdx deleted file mode 100644 index e66af2fa7..000000000 --- a/src/code-snippets/ios/signatures/ADJEvent/addCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -- (void)addCallbackParameter:(nonnull NSString *)key value:(nonnull NSString *)value; -``` diff --git a/src/code-snippets/ios/signatures/ADJEvent/addPartnerParameter.mdx b/src/code-snippets/ios/signatures/ADJEvent/addPartnerParameter.mdx deleted file mode 100644 index 8035ddf3a..000000000 --- a/src/code-snippets/ios/signatures/ADJEvent/addPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -- (void)addPartnerParameter:(nonnull NSString *)key value:(nonnull NSString *)value; -``` diff --git a/src/code-snippets/ios/signatures/ADJEvent/constructor.mdx b/src/code-snippets/ios/signatures/ADJEvent/constructor.mdx deleted file mode 100644 index f7d6af260..000000000 --- a/src/code-snippets/ios/signatures/ADJEvent/constructor.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (nullable ADJEvent *)eventWithEventToken:(nonnull NSString *)eventToken; -``` diff --git a/src/code-snippets/ios/signatures/ADJEvent/setCallbackId.mdx b/src/code-snippets/ios/signatures/ADJEvent/setCallbackId.mdx deleted file mode 100644 index 3d8f5476e..000000000 --- a/src/code-snippets/ios/signatures/ADJEvent/setCallbackId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -- (void)setCallbackId:(nonnull NSString *)callbackId; -``` diff --git a/src/code-snippets/ios/signatures/ADJEvent/setRevenue.mdx b/src/code-snippets/ios/signatures/ADJEvent/setRevenue.mdx deleted file mode 100644 index 156d74917..000000000 --- a/src/code-snippets/ios/signatures/ADJEvent/setRevenue.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -- (void)setRevenue:(double)amount currency:(nonnull NSString *)currency; -``` diff --git a/src/code-snippets/ios/signatures/ADJEvent/setTransactionId.mdx b/src/code-snippets/ios/signatures/ADJEvent/setTransactionId.mdx deleted file mode 100644 index 6c5371d99..000000000 --- a/src/code-snippets/ios/signatures/ADJEvent/setTransactionId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -- (void)setTransactionId:(nonnull NSString *)transactionId; -``` diff --git a/src/code-snippets/ios/signatures/ADJLinkResolution/resolveLinkWithUrl.mdx b/src/code-snippets/ios/signatures/ADJLinkResolution/resolveLinkWithUrl.mdx deleted file mode 100644 index 90cc4657d..000000000 --- a/src/code-snippets/ios/signatures/ADJLinkResolution/resolveLinkWithUrl.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```objc -+ (void)resolveLinkWithUrl:(nonnull NSURL *)url - resolveUrlSuffixArray:(nullable NSArray *)resolveUrlSuffixArray - callback:(nonnull void (^)(NSURL *_Nullable resolvedLink))callback; -``` diff --git a/src/code-snippets/ios/signatures/ADJSubscription/addCallbackParameter.mdx b/src/code-snippets/ios/signatures/ADJSubscription/addCallbackParameter.mdx deleted file mode 100644 index e66af2fa7..000000000 --- a/src/code-snippets/ios/signatures/ADJSubscription/addCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -- (void)addCallbackParameter:(nonnull NSString *)key value:(nonnull NSString *)value; -``` diff --git a/src/code-snippets/ios/signatures/ADJSubscription/addPartnerParameter.mdx b/src/code-snippets/ios/signatures/ADJSubscription/addPartnerParameter.mdx deleted file mode 100644 index 8035ddf3a..000000000 --- a/src/code-snippets/ios/signatures/ADJSubscription/addPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -- (void)addPartnerParameter:(nonnull NSString *)key value:(nonnull NSString *)value; -``` diff --git a/src/code-snippets/ios/signatures/ADJSubscription/constructor.mdx b/src/code-snippets/ios/signatures/ADJSubscription/constructor.mdx deleted file mode 100644 index 9376fcc8a..000000000 --- a/src/code-snippets/ios/signatures/ADJSubscription/constructor.mdx +++ /dev/null @@ -1,6 +0,0 @@ -```objc -- (nullable id)initWithPrice:(nonnull NSDecimalNumber *)price - currency:(nonnull NSString *)currency - transactionId:(nonnull NSString *)transactionId - andReceipt:(nonnull NSData *)receipt; -``` diff --git a/src/code-snippets/ios/signatures/ADJSubscription/setSalesRegion.mdx b/src/code-snippets/ios/signatures/ADJSubscription/setSalesRegion.mdx deleted file mode 100644 index 3beb58ce6..000000000 --- a/src/code-snippets/ios/signatures/ADJSubscription/setSalesRegion.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -- (void)setSalesRegion:(nonnull NSString *)salesRegion; -``` diff --git a/src/code-snippets/ios/signatures/ADJSubscription/setTransactionDate.mdx b/src/code-snippets/ios/signatures/ADJSubscription/setTransactionDate.mdx deleted file mode 100644 index 3e5f6502c..000000000 --- a/src/code-snippets/ios/signatures/ADJSubscription/setTransactionDate.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -- (void)setTransactionDate:(nonnull NSDate *)transactionDate; -``` diff --git a/src/code-snippets/ios/signatures/ADJThirdPartySharing/addGranularOption.mdx b/src/code-snippets/ios/signatures/ADJThirdPartySharing/addGranularOption.mdx deleted file mode 100644 index 87f897504..000000000 --- a/src/code-snippets/ios/signatures/ADJThirdPartySharing/addGranularOption.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```objc -- (void)addGranularOption:(nonnull NSString *)partnerName - key:(nonnull NSString *)key - value:(nonnull NSString *)value; -``` diff --git a/src/code-snippets/ios/signatures/ADJThirdPartySharing/addPartnerSharingSetting.mdx b/src/code-snippets/ios/signatures/ADJThirdPartySharing/addPartnerSharingSetting.mdx deleted file mode 100644 index 7ef567846..000000000 --- a/src/code-snippets/ios/signatures/ADJThirdPartySharing/addPartnerSharingSetting.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```objc -- (void)addPartnerSharingSetting:(nonnull NSString *)partnerName - key:(nonnull NSString *)key - value:(BOOL)value; -``` diff --git a/src/code-snippets/ios/signatures/ADJThirdPartySharing/constructor.mdx b/src/code-snippets/ios/signatures/ADJThirdPartySharing/constructor.mdx deleted file mode 100644 index 554d5550b..000000000 --- a/src/code-snippets/ios/signatures/ADJThirdPartySharing/constructor.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -- (nullable id)initWithIsEnabledNumberBool:(nullable NSNumber *)isEnabledNumberBool; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/addSessionCallbackParameter.mdx b/src/code-snippets/ios/signatures/Adjust/addSessionCallbackParameter.mdx deleted file mode 100644 index d6cdf82f3..000000000 --- a/src/code-snippets/ios/signatures/Adjust/addSessionCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)addSessionCallbackParameter:(nonnull NSString *)key value:(nonnull NSString *)value; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/addSessionPartnerParameter.mdx b/src/code-snippets/ios/signatures/Adjust/addSessionPartnerParameter.mdx deleted file mode 100644 index 2df13f991..000000000 --- a/src/code-snippets/ios/signatures/Adjust/addSessionPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)addSessionPartnerParameter:(nonnull NSString *)key value:(nonnull NSString *)value; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/adid.mdx b/src/code-snippets/ios/signatures/Adjust/adid.mdx deleted file mode 100644 index ff88747a9..000000000 --- a/src/code-snippets/ios/signatures/Adjust/adid.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (nullable NSString *)adid; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/appTrackingAuthorizationStatus.mdx b/src/code-snippets/ios/signatures/Adjust/appTrackingAuthorizationStatus.mdx deleted file mode 100644 index e216ac5d6..000000000 --- a/src/code-snippets/ios/signatures/Adjust/appTrackingAuthorizationStatus.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (int)appTrackingAuthorizationStatus; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/appWillOpenUrl.mdx b/src/code-snippets/ios/signatures/Adjust/appWillOpenUrl.mdx deleted file mode 100644 index 5e45c4f77..000000000 --- a/src/code-snippets/ios/signatures/Adjust/appWillOpenUrl.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)appWillOpenUrl:(nonnull NSURL *)url; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/attribution.mdx b/src/code-snippets/ios/signatures/Adjust/attribution.mdx deleted file mode 100644 index 1165a0cce..000000000 --- a/src/code-snippets/ios/signatures/Adjust/attribution.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (nullable ADJAttribution *)attribution; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/checkForNewAttStatus.mdx b/src/code-snippets/ios/signatures/Adjust/checkForNewAttStatus.mdx deleted file mode 100644 index 0a340ecae..000000000 --- a/src/code-snippets/ios/signatures/Adjust/checkForNewAttStatus.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)checkForNewAttStatus; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/disableThirdPartySharing.mdx b/src/code-snippets/ios/signatures/Adjust/disableThirdPartySharing.mdx deleted file mode 100644 index d79ae203d..000000000 --- a/src/code-snippets/ios/signatures/Adjust/disableThirdPartySharing.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)disableThirdPartySharing; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/gdprForgetMe.mdx b/src/code-snippets/ios/signatures/Adjust/gdprForgetMe.mdx deleted file mode 100644 index e4bc920e4..000000000 --- a/src/code-snippets/ios/signatures/Adjust/gdprForgetMe.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)gdprForgetMe; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/idfa.mdx b/src/code-snippets/ios/signatures/Adjust/idfa.mdx deleted file mode 100644 index 07e50f4f6..000000000 --- a/src/code-snippets/ios/signatures/Adjust/idfa.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (nullable NSString *)idfa; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/isEnabled.mdx b/src/code-snippets/ios/signatures/Adjust/isEnabled.mdx deleted file mode 100644 index 817b04f9d..000000000 --- a/src/code-snippets/ios/signatures/Adjust/isEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (BOOL)isEnabled; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/removeSessionCallbackParameter.mdx b/src/code-snippets/ios/signatures/Adjust/removeSessionCallbackParameter.mdx deleted file mode 100644 index 3bcc0e7c3..000000000 --- a/src/code-snippets/ios/signatures/Adjust/removeSessionCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)removeSessionCallbackParameter:(nonnull NSString *)key; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/removeSessionPartnerParameter.mdx b/src/code-snippets/ios/signatures/Adjust/removeSessionPartnerParameter.mdx deleted file mode 100644 index b1edd2a63..000000000 --- a/src/code-snippets/ios/signatures/Adjust/removeSessionPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)removeSessionPartnerParameter:(nonnull NSString *)key; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/requestTrackingAuthorization.mdx b/src/code-snippets/ios/signatures/Adjust/requestTrackingAuthorization.mdx deleted file mode 100644 index 2d112483d..000000000 --- a/src/code-snippets/ios/signatures/Adjust/requestTrackingAuthorization.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)requestTrackingAuthorizationWithCompletionHandler:(void (^_Nullable)(NSUInteger status))completion; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/resetSessionCallbackParameters.mdx b/src/code-snippets/ios/signatures/Adjust/resetSessionCallbackParameters.mdx deleted file mode 100644 index a1b1bd6e7..000000000 --- a/src/code-snippets/ios/signatures/Adjust/resetSessionCallbackParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)resetSessionCallbackParameters; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/resetSessionPartnerParameters.mdx b/src/code-snippets/ios/signatures/Adjust/resetSessionPartnerParameters.mdx deleted file mode 100644 index b3d665006..000000000 --- a/src/code-snippets/ios/signatures/Adjust/resetSessionPartnerParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)resetSessionPartnerParameters; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/sendFirstPackages.mdx b/src/code-snippets/ios/signatures/Adjust/sendFirstPackages.mdx deleted file mode 100644 index fbc781493..000000000 --- a/src/code-snippets/ios/signatures/Adjust/sendFirstPackages.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)sendFirstPackages; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/setDeviceToken.mdx b/src/code-snippets/ios/signatures/Adjust/setDeviceToken.mdx deleted file mode 100644 index 71d46d0c6..000000000 --- a/src/code-snippets/ios/signatures/Adjust/setDeviceToken.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)setDeviceToken:(nonnull NSData *)deviceToken; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/setEnabled.mdx b/src/code-snippets/ios/signatures/Adjust/setEnabled.mdx deleted file mode 100644 index 3e0f5c34e..000000000 --- a/src/code-snippets/ios/signatures/Adjust/setEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)setEnabled:(BOOL)enabled; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/setOfflineMode.mdx b/src/code-snippets/ios/signatures/Adjust/setOfflineMode.mdx deleted file mode 100644 index ae618da09..000000000 --- a/src/code-snippets/ios/signatures/Adjust/setOfflineMode.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)setOfflineMode:(BOOL)enabled; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/trackAdRevenue.mdx b/src/code-snippets/ios/signatures/Adjust/trackAdRevenue.mdx deleted file mode 100644 index 72950d413..000000000 --- a/src/code-snippets/ios/signatures/Adjust/trackAdRevenue.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)trackAdRevenue:(nonnull NSString *)source payload:(nonnull NSData *)payload; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/trackEvent.mdx b/src/code-snippets/ios/signatures/Adjust/trackEvent.mdx deleted file mode 100644 index 5edf6cb89..000000000 --- a/src/code-snippets/ios/signatures/Adjust/trackEvent.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)trackEvent:(nullable ADJEvent *)event; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/trackMeasurementConsent.mdx b/src/code-snippets/ios/signatures/Adjust/trackMeasurementConsent.mdx deleted file mode 100644 index f735937eb..000000000 --- a/src/code-snippets/ios/signatures/Adjust/trackMeasurementConsent.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)trackMeasurementConsent:(BOOL)enabled; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/trackSubscription.mdx b/src/code-snippets/ios/signatures/Adjust/trackSubscription.mdx deleted file mode 100644 index 6c6c779b8..000000000 --- a/src/code-snippets/ios/signatures/Adjust/trackSubscription.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)trackSubscription:(nonnull ADJSubscription *)subscription; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/trackThirdPartySharing.mdx b/src/code-snippets/ios/signatures/Adjust/trackThirdPartySharing.mdx deleted file mode 100644 index 42505e290..000000000 --- a/src/code-snippets/ios/signatures/Adjust/trackThirdPartySharing.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)trackThirdPartySharing:(nonnull ADJThirdPartySharing *)thirdPartySharing; -``` diff --git a/src/code-snippets/ios/signatures/Adjust/updateConversionValue.mdx b/src/code-snippets/ios/signatures/Adjust/updateConversionValue.mdx deleted file mode 100644 index 19facc730..000000000 --- a/src/code-snippets/ios/signatures/Adjust/updateConversionValue.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```objc -+ (void)updateConversionValue:(NSInteger)conversionValue; -``` diff --git a/src/content/docs/kitchen-sink/typography.mdx b/src/content/docs/kitchen-sink/typography.mdx index 0bbbf1bd3..728169218 100644 --- a/src/content/docs/kitchen-sink/typography.mdx +++ b/src/content/docs/kitchen-sink/typography.mdx @@ -169,7 +169,3 @@ import ResolveLinkWithUrl from "@ios-signatures/ADJLinkResolution/resolveLinkWit `resolveLinkWithUrl` method || ``` - -import ResolveLinkWithUrl from "@ios-signatures/ADJLinkResolution/resolveLinkWithUrl.mdx" - -`resolveLinkWithUrl` method || diff --git a/src/content/docs/sdk/android/features/privacy.mdx b/src/content/docs/sdk/android/features/privacy.mdx index a0b8b4451..9c41f6185 100644 --- a/src/content/docs/sdk/android/features/privacy.mdx +++ b/src/content/docs/sdk/android/features/privacy.mdx @@ -189,54 +189,6 @@ Adjust.trackThirdPartySharing(adjustThirdPartySharing); -### Update partner settings - -```java title="Method signature" -public void addPartnerSharingSetting(final String partnerName, - final String key, - final boolean value) -``` - -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 your partner name and your options. - - - - -```kotlin {2-4} -val adjustThirdPartySharing = AdjustThirdPartySharing(true) -adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "install", true) -adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "events", true) -adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "sessions", true) -Adjust.trackThirdPartySharing(adjustThirdPartySharing) -``` - - - - - -```java {2-4} -AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true); -adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "install", true); -adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "events", true); -adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "sessions", true); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - - - - - -```js {2-4} -let adjustThirdPartySharing = new AdjustThirdPartySharing(true); -adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "install", true); -adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "events", true); -adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "sessions", true); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - - - - #### Manage Facebook Limited Data Use @@ -372,6 +324,54 @@ Adjust.trackThirdPartySharing(adjustThirdPartySharing); +### Update partner settings + +```java title="Method signature" +public void addPartnerSharingSetting(final String partnerName, + final String key, + final boolean value) +``` + +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 your partner name and your options. + + + + +```kotlin {2-4} +val adjustThirdPartySharing = AdjustThirdPartySharing(true) +adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "install", true) +adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "events", true) +adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "sessions", true) +Adjust.trackThirdPartySharing(adjustThirdPartySharing) +``` + + + + + +```java {2-4} +AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true); +adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "install", true); +adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "events", true); +adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "sessions", true); +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + + + + + +```js {2-4} +let adjustThirdPartySharing = new AdjustThirdPartySharing(true); +adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "install", true); +adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "events", true); +adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "sessions", true); +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + + + + ## Disable third-party sharing ```java title="Method signature" diff --git a/src/content/docs/sdk/flutter/features/privacy.mdx b/src/content/docs/sdk/flutter/features/privacy.mdx index 114f22682..7fdf0a933 100644 --- a/src/content/docs/sdk/flutter/features/privacy.mdx +++ b/src/content/docs/sdk/flutter/features/privacy.mdx @@ -95,22 +95,6 @@ adjustThirdPartySharing.addGranularOption("PartnerA", "key", "value"); Adjust.trackThirdPartySharing(adjustThirdPartySharing); ``` -### Update partner settings - -```dart title="Method signature" -void addPartnerSharingSetting(String partnerName, String key, bool value) -``` - -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 your partner name and your options. - -```dart {3} -AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(null); -//... -adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "foo", false); -//... -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - #### Manage Facebook Limited Data Use @@ -180,6 +164,22 @@ adjustThirdPartySharing.addGranularOption('google_dma', 'ad_user_data', '1'); Adjust.trackThirdPartySharing(adjustThirdPartySharing); ``` +### Update partner settings + +```dart title="Method signature" +void addPartnerSharingSetting(String partnerName, String key, bool value) +``` + +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 your partner name and your options. + +```dart {3} +AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(null); +//... +adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "foo", false); +//... +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + ## Disable third-party sharing ```dart title="Method signature" diff --git a/src/content/docs/sdk/flutter/features/skad.mdx b/src/content/docs/sdk/flutter/features/skad.mdx index 2204c09ce..211c09776 100644 --- a/src/content/docs/sdk/flutter/features/skad.mdx +++ b/src/content/docs/sdk/flutter/features/skad.mdx @@ -10,8 +10,7 @@ This feature is only available on devices running iOS 14 and above. -StoreKit Ad Network (SKAdNetwork) is Apple's attribution framework for -app install and reinstall attribution. The SKAdNetwork workflow goes like this: +StoreKit Ad Network (SKAdNetwork) is Apple's attribution framework for app install and reinstall attribution. The SKAdNetwork workflow goes like this: 1. Apple gathers attribution information and notifies the relevant ad network. 2. The network sends a postback with this information to Adjust. diff --git a/src/content/docs/sdk/ios/configuration.mdx b/src/content/docs/sdk/ios/configuration.mdx new file mode 100644 index 000000000..fd71639f6 --- /dev/null +++ b/src/content/docs/sdk/ios/configuration.mdx @@ -0,0 +1,613 @@ +--- +title: Configuration +description: Follow the guides in this section to configure the Adjust SDK. +category-title: Configuration +slug: en/sdk/ios/configuration +sidebar-position: 1 +--- + +se the methods in this document to configure the behavior of the Adjust SDK. + +## Instantiate your config object + +```objc title="Method signature" ++ (nullable ADJConfig *)configWithAppToken:(nonnull NSString *)appToken + environment:(nonnull NSString *)environment + allowSuppressLogLevel:(BOOL)allowSuppressLogLevel; +``` + +To configure the Adjust SDK, you need to instantiate an `ADJConfig` object. This object contains the **read-only** configuration options that you need to pass to the Adjust SDK. + +To instantiate your config object, create a new `ADJConfig` instance and pass the following parameters: + +- `appToken` (**NSString**): Your [Adjust app token](https://help.adjust.com/en/article/app-token-and-reporting-currency#view-your-app-details). +- `environment` (**NSString**): The environment you want to run the SDK in. Pass `ADJEnvironmentSandbox` to run the SDK in sandbox mode for testing. Pass `ADJEnvironmentProduction` to run the SDK in production mode for release. +- `allowSuppressLogLevel` (**BOOL**): Whether to suppress all logging. Set to `true` to suppress logging or `false` to enable logging. + + + + +```swift {3-5} +let yourAppToken = "{YourAppToken}" +let environment = ADJEnvironmentSandbox as? String +let adjustConfig = ADJConfig( + appToken: yourAppToken, + environment: environment) +``` + + + + +```objective-c {3-4} +NSString *yourAppToken = @"{YourAppToken}"; +NSString *environment = ADJEnvironmentSandbox; +*adjustConfig = [ADJConfig configWithAppToken:yourAppToken + environment:environment]; +``` + + + + +```javascript {4} +setupWebViewJavascriptBridge(function (bridge) { + var yourAppToken = yourAppToken; + var environment = AdjustConfig.EnvironmentSandbox; + var adjustConfig = new AdjustConfig(yourAppToken, environment); +}); +``` + + + + +## Read-only configuration + +**Read-only** configuration options are set in your `ADJConfig` instance **before** the initialization of the SDK. They can't be changed while the SDK is running. You MUST configure any options you want to use before running `Adjust.appDidLaunch()`. + +### Set your logging level + +```objc title="Property declaration" +@property (nonatomic, assign) ADJLogLevel logLevel; +``` + +The Adjust SDK provides configurable log levels to return different amounts of information. The following log levels are available: + + + +| ADJLogLevel | Description | +| --------------------- | ------------------------------------------ | +| `ADJLogLevelVerbose` | Enable all logging | +| `ADJLogLevelDebug` | Enable debug logging | +| `ADJLogLevelInfo` | Only show info level logs (default option) | +| `ADJLogLevelWarn` | Disable info logging | +| `ADJLogLevelError` | Disable warning level logging and below | +| `ADJLogLevelAssert` | Disable error level logging and below | +| `ADJLogLevelSuppress` | Suppress all logging | + +
+ +You can set your log level by assigning an `ADJLogLevel` value to the `logLevel` property of your config instance. + +- `logLevel` (**ADJLogLevel**): The log level you want to use. + + + + +```swift {7} +let yourAppToken = "{YourAppToken}" +let environment = ADJEnvironmentSandbox as? String +let adjustConfig = ADJConfig( + appToken: yourAppToken, + environment: environment) +// ... +adjustConfig?.logLevel = ADJLogLevelVerbose +``` + + + + +```objective-c {6} +NSString *yourAppToken = @"{YourAppToken}"; +NSString *environment = ADJEnvironmentSandbox; +*adjustConfig = [ADJConfig configWithAppToken:yourAppToken + environment:environment]; +// ... +[adjustConfig setLogLevel:ADJLogLevelVerbose]; +``` + + + + +```javascript {6} +setupWebViewJavascriptBridge(function (bridge) { + // ... + var yourAppToken = yourAppToken; + var environment = AdjustConfig.EnvironmentSandbox; + var adjustConfig = new AdjustConfig(yourAppToken, environment); + adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose); +}); +``` + + + + +### Set external device identifier + +```objc title="Property declaration" +@property (nonatomic, copy, nullable) NSString *externalDeviceId; +``` + +An external device identifier is a custom value that you can assign to a device or user. They help you recognize users across sessions and platforms. They can also help you deduplicate installs by user so that a user isn't counted as duplicate new installs. Contact your Adjust representative to get started with external device IDs. + +You can use an external device ID as a custom identifier for a device. This helps you keep continuity with your other systems. Assign your external device ID to the `externalDeviceId` property on your config instance. + +- `externalDeviceId` (**NSString**): Your external device identifier. This value is **case sensitive**. If you have imported external device IDs, make sure the value you pass matches the imported value. + + + +See the [External device identifiers article](https://help.adjust.com/en/article/external-device-identifiers) in the Adjust help center for more information. + + + + + + +```swift {7} +let yourAppToken = "{YourAppToken}" +let environment = ADJEnvironmentSandbox as? String +let adjustConfig = ADJConfig( + appToken: yourAppToken, + environment: environment) +// ... +adjustConfig?.externalDeviceId = "yourExternalDeviceId" +``` + + + + +```objc {6} +NSString *yourAppToken = @"{YourAppToken}"; +NSString *environment = ADJEnvironmentSandbox; +*adjustConfig = [ADJConfig configWithAppToken:yourAppToken + environment:environment]; +// ... +[adjustConfig setExternalDeviceId:@"yourExternalDeviceId"]; +``` + + + + +```js {5} +setupWebViewJavascriptBridge(function (bridge) { + var yourAppToken = yourAppToken; + var environment = AdjustConfig.EnvironmentSandbox; + var adjustConfig = new AdjustConfig(yourAppToken, environment); + adjustConfig.setExternalDeviceId("yourExternalDeviceId"); +}); +``` + + + + +If you want to use the external device ID in your business analytics, you can pass it as a [session callback parameter](/en/sdk/ios/features/session-parameters). + +You can import existing external device IDs into Adjust. This ensures that the Adjust servers match future data to your existing device records. Contact your Adjust representative for more information. + +### Set default link token + +```objc title="Property declaration" +@property (nonatomic, copy, nullable) NSString *defaultTracker; +``` + +You can configure a default link token if your app is preinstalled on a device. When a user opens the preinstalled app for the first time, the install is attributed to the default link token. Assign your default link token to the `defaultTracker` property of your config instance. + +- `defaultTracker` (**NSString**): The [Adjust link token](https://help.adjust.com/en/article/links#adjust-link-token) you want to record preinstalled installs against. + + + + +```swift {6} +let yourAppToken = "{YourAppToken}" +let environment = ADJEnvironmentSandbox as? String +let adjustConfig = ADJConfig( + appToken: yourAppToken, + environment: environment) +adjustConfig?.defaultTracker = "{Token}" +Adjust.appDidLaunch(adjustConfig) +``` + + + + +```objective-c {3} +*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}" + environment:ADJEnvironmentSandbox]; +[adjustConfig setDefaultTracker:@"{Token}"]; +[Adjust appDidLaunch:adjustConfig]; +``` + + + + +```javascript {5} +setupWebViewJavascriptBridge(function(bridge) { + var yourAppToken = yourAppToken; + var environment = AdjustConfig.EnvironmentSandbox; + var adjustConfig = new AdjustConfig(yourAppToken, environment); + adjustConfig.setDefaultTracker("{Token}"); +}); +``` + + + + +### Enable cost data sending + +```objc title="Property declaration" +@property (nonatomic, assign) BOOL needsCost; +``` + +By default, the Adjust SDK doesn't send cost data as part of a user's attribution. You can configure the SDK to send this data by enabling cost data sending. To enable cost data sending, assign a **Boolean** value to the `needsCost` property of your config instance. + +- `needsCost` (**BOOL**): set to `true` to enable cost data sending or `false` to disable cost data sending. + +Cost data is accessible in the user's [attribution information](/en/sdk/ios/features/attribution). + + + + +```swift {7} +let yourAppToken = "{YourAppToken}" +let environment = ADJEnvironmentSandbox as? String +let adjustConfig = ADJConfig( + appToken: yourAppToken, + environment: environment) +// ... +adjustConfig?.needsCost = true +``` + + + + +```objc {6} +NSString *yourAppToken = @"{YourAppToken}"; +NSString *environment = ADJEnvironmentSandbox; +*adjustConfig = [ADJConfig configWithAppToken:yourAppToken + environment:environment]; +// ... +[adjustConfig setNeedsCost:YES]; +``` + + + + +```js {5} +setupWebViewJavascriptBridge(function(bridge) { + var yourAppToken = yourAppToken; + var environment = AdjustConfig.EnvironmentSandbox; + var adjustConfig = new AdjustConfig(yourAppToken, environment); + adjustConfig.setNeedsCost(true); +}); +``` + + + + +### Enable background recording + +```objc title="Property declaration" +@property (nonatomic, assign) BOOL sendInBackground; +``` + +By default, the Adjust SDK pauses the sending of requests when your app is running in the background. You can configure the SDK to send requests in the background by enabling the background recording. To enable background recording, assign a **Boolean** value to the `sendInBackground` property of your config instance. + +- `sendInBackground` (**BOOL**): Set to `true` to enable background sending or `false` to disable background sending. + + + + +```swift {7} +let yourAppToken = "{YourAppToken}" +let environment = ADJEnvironmentSandbox as? String +let adjustConfig = ADJConfig( + appToken: yourAppToken, + environment: environment) +// ... +adjustConfig?.sendInBackground = true +``` + + + + +```objc {6} +NSString *yourAppToken = @"{YourAppToken}"; +NSString *environment = ADJEnvironmentSandbox; +*adjustConfig = [ADJConfig configWithAppToken:yourAppToken + environment:environment]; +// ... +[adjustConfig setSendInBackground:YES]; +``` + + + + +```js {6} +setupWebViewJavascriptBridge(function(bridge) { + // ... + var yourAppToken = yourAppToken; + var environment = AdjustConfig.EnvironmentSandbox; + var adjustConfig = new AdjustConfig(yourAppToken, environment); + adjustConfig.setSendInBackground(true); +}); +``` + + + + +### Enable event buffering + +```objc title="Property declaration" +@property (nonatomic, assign) BOOL eventBufferingEnabled; +``` + +The Adjust SDK sends event information as soon as a user triggers an event in your app. You can send event information on a schedule by enabling event buffering. Event buffering stores events in a local buffer on the device and sends all requests once per minute. + +Your config object contains a boolean `eventBufferingEnabled` property that controls this behavior. To enable event buffering, assign a **Boolean** value to the `eventBufferingEnabled` property of your config instance. + +- `eventBufferingEnabled` (**BOOL**): Set to `true` to enable event buffering or `false` to disable event buffering. + + + + +```swift {6} +let yourAppToken = "{YourAppToken}" +let environment = ADJEnvironmentSandbox as? String +let adjustConfig = ADJConfig( + appToken: yourAppToken, + environment: environment) +adjustConfig?.eventBufferingEnabled = true +Adjust.appDidLaunch(adjustConfig) +``` + + + + +```objc {3} +*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}" + environment:ADJEnvironmentSandbox]; +[adjustConfig setEventBufferingEnabled:YES]; +[Adjust appDidLaunch:adjustConfig]; +``` + + + + +```js {5} +setupWebViewJavascriptBridge(function(bridge) { + var yourAppToken = yourAppToken; + var environment = AdjustConfig.EnvironmentSandbox; + var adjustConfig = new AdjustConfig(yourAppToken, environment); + adjustConfig.setEventBufferingEnabled(true); +}); +``` + + + + +### Delay the start of the SDK + +```objc title="Property declaration" +@property (nonatomic, assign) double delayStart; +``` + +By default, the Adjust SDK starts as soon as your app opens. If you want to send data that is not available at launch in [session parameters](/en/sdk/ios/features/session-parameters), you can delay the start of the SDK. This can be helpful if you are sending information such as unique identifiers. + +To configure a startup delay, assign a **Double** value to the `delayStart` property of your config instance. + +- `delayStart` (**double**): The time (in seconds) by which to delay the start of the SDK. You can delay the start of the SDK by up to **10 seconds**. + + + + +```swift {6} +let yourAppToken = "{YourAppToken}" +let environment = ADJEnvironmentSandbox as? String +let adjustConfig = ADJConfig( + appToken: yourAppToken, + environment: environment) +adjustConfig?.delayStart = 5.5 +// ... +Adjust.appDidLaunch(adjustConfig) +``` + + + + +```objc {3} +*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}" + environment:ADJEnvironmentSandbox]; +[adjustConfig setDelayStart:5.5]; +/// ... +[Adjust appDidLaunch:adjustConfig]; +``` + + + + +```js {5} +setupWebViewJavascriptBridge(function(bridge) { + var yourAppToken = yourAppToken; + var environment = AdjustConfig.EnvironmentSandbox; + var adjustConfig = new AdjustConfig(yourAppToken, environment); + adjustConfig.setDelayStart(5.5); +}); +``` + + + + +## Dynamic configuration + +**Dynamic** configuration options may be changed during the SDK's lifecycle in response to events or actions taken by the user. + +### Toggle offline mode + +```objc title="Method signature" ++ (void)setOfflineMode:(BOOL)enabled; +``` + + + +The offline mode setting isn't remembered between sessions. Offline mode is disabled at the start of each new session. + + + +The Adjust SDK sends event and session data to Adjust's servers in real time. You can pause the sending of information by putting the SDK in offline mode. In offline mode the SDK stores all data in a local file on the device. The SDK sends this information to Adjust's servers when you disable offline mode. + +You can toggle offline mode at any time by calling the `setOfflineMode` method with the following argument: + +- `enabled` (**BOOL**): Set to `true` to enable offline mode or `false` to disable offline mode. + + + + +```swift +Adjust.setOfflineMode(true); +``` + + + + +```objc +[Adjust setOfflineMode:YES]; +``` + + + + + +```js +Adjust.setOfflineMode(true); +``` + + + + +### Set push tokens + +```objc title="Method signature" ++ (void)setDeviceToken:(nonnull NSData *)deviceToken; +``` + +Push tokens are used for [Audience Builder](https://help.adjust.com/en/article/audience-builder) and client callbacks. They're also required for [Uninstall and reinstall tracking](https://help.adjust.com/en/article/uninstalls-reinstalls). + +Your config object contains a `deviceToken` property that you can use to store your push token. You can update this property at any time by calling the `setDeviceToken` method and passing the following arguments: + +- `deviceToken` (**NSData**): Your push token. + + + +If you have access to the push token from the web view, you can call the `setPushToken` method in Javascript. + + + + + + +```swift {2} +func application(_ app: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) { + Adjust.deviceToken = deviceToken +} +``` + + + + +```objc {2} +- (void)application:(UIApplication *)app didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken { + [Adjust setDeviceToken:deviceToken]; +} +``` + + + + +```js +Adjust.setDeviceToken(deviceToken); +``` + + + + +### Disable or enable the SDK + + + +You can only call this method after the first session. This setting persists between sessions. + + + +```objc title="Method signature" ++ (void)setEnabled:(BOOL)enabled; +``` + +The Adjust SDK runs by default when your app is open. You can disable and re-enable the Adjust SDK to pause and resume recording. When you disable the Adjust SDK, it doesn't send any data to Adjust's servers. + +You can enable or disable the SDK at any time by calling the `setEnabled` method with the following argument: + +- `enabled` (**BOOL**): Set to `true` to enable the SDK or `false` to disable the SDK. + + + + +```swift +Adjust.setEnabled(true) +``` + + + + +```objc +[Adjust setEnabled:NO]; +``` + + + + +```js +Adjust.setEnabled(false); +``` + + + + +#### Check enabled status + +```objc title="Method signature" ++ (BOOL)isEnabled; +``` + +You can check if the Adjust SDK is enabled at any time by calling the `isEnabled` method. This method returns a **boolean** value indicating if the SDK is **enabled** (`true`) or **disabled** (`false`). + + + + +```swift +Adjust.isEnabled() +``` + + + + +```objc +[Adjust isEnabled]; +``` + + + + +```js +Adjust.isEnabled(); +``` + + + diff --git a/src/content/docs/sdk/ios/configuration/background.mdx b/src/content/docs/sdk/ios/configuration/background.mdx deleted file mode 100644 index 74ab62859..000000000 --- a/src/content/docs/sdk/ios/configuration/background.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Record activity in the background -description: Configure the SDK to send requests in the background. -slug: en/sdk/ios/configuration/background ---- - -import SetSendInBackgroundSig from "@ios-signatures/ADJConfig/setSendInBackground.mdx" -import SetSendInBackground from "@ios-examples/ADJConfig/sendInBackground.mdx" - -By default, the Adjust SDK pauses the sending of requests when your app is running in the background. You can configure the SDK to send requests in the background by enabling the background recording feature. - -Your config object contains a boolean `sendInBackground` property that controls this behavior. You can set this property by calling the `setSendInBackground` method on your config instance with a boolean value. - - - -You must set the `sendInBackground` property *before* you initialize the Adjust SDK. - - - - diff --git a/src/content/docs/sdk/ios/configuration/deep-links/index.mdx b/src/content/docs/sdk/ios/configuration/deep-links/index.mdx deleted file mode 100644 index 4816a88da..000000000 --- a/src/content/docs/sdk/ios/configuration/deep-links/index.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Deep linking -description: Follow the guides in this section to set up deep linking. -category-title: Deep linking -slug: en/sdk/ios/configuration/deep-links ---- - -Deep links are URIs (Uniform Resource Identifiers) that direct users to a specific page in your app without any additional navigation. You can use them throughout your marketing funnel to improve user acquisition, engagement, and retention. - -The Adjust SDK uses different logic depending on whether the user already has your app installed on their device: - -Direct deep linking: Occurs if the user already has your app installed. The link takes the user to the page specified in the link - -Deferred deep linking: Occurs if the user doesn't have your app installed. The link takes the user to a storefront to install your app first. After the user installs the app, it opens to the page specified in the link. - -To get started, follow these steps. diff --git a/src/content/docs/sdk/ios/configuration/delay.mdx b/src/content/docs/sdk/ios/configuration/delay.mdx deleted file mode 100644 index 0381177f5..000000000 --- a/src/content/docs/sdk/ios/configuration/delay.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Delay recording -description: Configure the SDK to delay the sending of information to Adjust's servers. -slug: en/sdk/ios/configuration/delay ---- - -import SetOfflineMode from "@ios-examples/Adjust/setOfflineMode.mdx" -import SetOfflineModeSig from "@ios-signatures/Adjust/setOfflineMode.mdx" -import SetEventBufferingEnabled from "@ios-examples/ADJConfig/setEventBufferingEnabled.mdx" -import SetEventBufferingEnabledSig from "@ios-signatures/ADJConfig/setEventBufferingEnabled.mdx" - - - -The offline mode setting isn't remembered between sessions. Offline mode is disabled at the start of each new session. - - - -The Adjust SDK sends event and session data to Adjust's servers in real time. You can pause the sending of information by putting the SDK in offline mode. In offline mode the SDK stores all data in a local file on the device. The SDK sends this information to Adjust's servers when you disable offline mode. - -Your config object contains a boolean `isOffline` property that controls this behavior. You can update this property at any time by calling the `setOfflineMode` method with a boolean argument. The SDK sends all saved information to Adjust's servers when you deactivate offline mode. - - - -## Event buffering - -The Adjust SDK sends event information as soon as a user triggers an event in your app. You can send event information on a schedule by enabling event buffering. Event buffering stores events in a local buffer on the device and sends all requests once per minute. - -Your config object contains a boolean `eventBufferingEnabled` property that controls this behavior. You can set this property by calling the `setEventBufferingEnabled` method on your config object with a boolean argument. - - diff --git a/src/content/docs/sdk/ios/configuration/disable.mdx b/src/content/docs/sdk/ios/configuration/disable.mdx deleted file mode 100644 index 8d0393783..000000000 --- a/src/content/docs/sdk/ios/configuration/disable.mdx +++ /dev/null @@ -1,160 +0,0 @@ ---- -title: Disable the Adjust SDK -description: Disable the Adjust SDK to pause recording. -slug: en/sdk/ios/configuration/disable ---- - -import SetEnabled from "@ios-examples/Adjust/setEnabled.mdx" -import SetEnabledSig from "@ios-signatures/Adjust/setEnabled.mdx" -import IsEnabled from "@ios-examples/Adjust/isEnabled.mdx" -import IsEnabledSig from "@ios-signatures/Adjust/isEnabled.mdx" - -The Adjust SDK runs by default when your app is open. You can disable and re-enable the Adjust SDK to pause and resume recording. When you disable the Adjust SDK, it doesn't send any data to Adjust's servers. - -You can enable or disable the SDK at any time by calling the `setEnabled` method with a boolean argument. - - - -You can only call this method after the first session. This setting persists between sessions. - - - - - -## Check enabled status - -You can check if the Adjust SDK is enabled at any time by calling the `isEnabled` method. This method returns a boolean value. - - - -## Example - -This example shows how to create buttons to enable or disable the SDK. A third button logs the current status of the SDK. - - - - -```swift -import Adjust -import UIKit - -class ViewControllerSwift: UIViewController { - @IBOutlet weak var btnEnableSDK: UIButton? - @IBOutlet weak var btnDisableSDK: UIButton? - - @IBAction func btnEnableSDKTapped(_sender: UIButton) { - Adjust.setEnabled(true); - } - - @IBAction func btnDisableSDKTapped(_sender: UIButton) { - Adjust.setEnabled(false); - } - - @IBAction func btnIsSDKEnabledTapped(_sender: UIButton) { - let isSDKEnabled = Adjust.isEnabled(); - if (isSDKEnabled) { - NSLog("SDK is enabled!"); - } else { - NSLog("SDK is disabled"); - } - } -} -``` - - - - -```objective-c -#import "Adjust.h" -#import "Constants.h" -#import "ViewControllerObjC.h" - -@interface ViewControllerObjC () - -@property (weak, nonatomic) IBOutlet UIButton *btnEnableSdk; -@property (weak, nonatomic) IBOutlet UIButton *btnDisableSdk; -@property (weak, nonatomic) IBOutlet UIButton *btnIsSdkEnabled; - -@end - -@implementation ViewControllerObjC - -- (IBAction)clickEnableSdk:(id)sender { - [Adjust setEnabled:YES]; -} - -- (IBAction)clickDisableSdk:(id)sender { - [Adjust setEnabled:NO]; -} - -- (IBAction)clickIsSdkEnabled:(id)sender { - NSString *message; - if ([Adjust isEnabled]) { - message = @"SDK is ENABLED!"; - } else { - message = @"SDK is DISABLED!"; - } - - UIAlertController *alert = [UIAlertController alertControllerWithTitle:@"Is SDK Enabled?" - message:message - preferredStyle:UIAlertControllerStyleAlert]; - UIAlertAction *defaultAction = [UIAlertAction actionWithTitle:@"OK" style:UIAlertActionStyleDefault - handler:^(UIAlertAction *action) {}]; - [alert addAction:defaultAction]; - [self presentViewController:alert animated:YES completion:nil]; -} - -@end -``` - - - - -```html - - - -
-
- -
-
- -
-
- -
-
- - -``` - - - diff --git a/src/content/docs/sdk/ios/configuration/external-device-id.mdx b/src/content/docs/sdk/ios/configuration/external-device-id.mdx deleted file mode 100644 index 8e8e3668f..000000000 --- a/src/content/docs/sdk/ios/configuration/external-device-id.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Set external device identifiers -description: Configure an external device ID as a custom identifier for a device. -slug: en/sdk/ios/configuration/external-device-id ---- - -import SetExternalDeviceId from "@ios-examples/ADJConfig/setExternalDeviceId.mdx" -import SetExternalDeviceIdSig from "@ios-signatures/ADJConfig/setExternalDeviceId.mdx" - -An external device identifier is a custom value that you can assign to a device or user. They help you recognize users across sessions and platforms. They can also help you deduplicate installs by user so that a user isn't counted as duplicate new installs. Contact your Adjust representative to get started with external device IDs. - -You can use an external device ID as a custom identifier for a device. This helps you keep continuity with your other systems. - - - -See the [External device identifiers article](https://help.adjust.com/en/article/external-device-identifiers) in the Adjust help center for more information. - - - -Your config object contains a **string** `externalDeviceId` property that you can use to store your external device ID. You can set property calling the `setExternalDeviceId` method with your ID as an argument. - - - -You must set your external device ID **before** initializing the Adjust SDK. - - - -The external device ID is case-sensitive. If you have imported external device IDs, make sure the value you pass matches the imported value. - - - -If you want to use the external device ID in your business analytics, you can pass it as a session callback parameter. - - - -See [Session parameters](/en/sdk/ios/features/session-parameters) for more information. - - - -You can import existing external device IDs into Adjust. This ensures that the Adjust servers match future data to your existing device records. Contact your Adjust representative for more information. diff --git a/src/content/docs/sdk/ios/configuration/index.mdx b/src/content/docs/sdk/ios/configuration/index.mdx deleted file mode 100644 index beb6868d5..000000000 --- a/src/content/docs/sdk/ios/configuration/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Configuration -description: Follow the guides in this section to configure the Adjust SDK. -category-title: Configuration -slug: en/sdk/ios/configuration -type: category ---- - -Follow the guides in this section to configure the Adjust SDK. diff --git a/src/content/docs/sdk/ios/configuration/log-level.mdx b/src/content/docs/sdk/ios/configuration/log-level.mdx deleted file mode 100644 index 3b0eac4bb..000000000 --- a/src/content/docs/sdk/ios/configuration/log-level.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Set log level -description: Configure the Adjust SDK's logging verbosity. -slug: en/sdk/ios/configuration/log-level ---- - -import SetLogLevel from "@ios-examples/ADJConfig/setLogLevel.mdx" -import SetLogLevelSig from "@ios-signatures/ADJConfig/setLogLevel.mdx" - -The Adjust SDK provides configurable log levels to return different amounts of information. The following log levels are available: - - - -| ADJLogLevel | Description | -| --------------------- | ------------------------------------------ | -| `ADJLogLevelVerbose` | Enable all logging | -| `ADJLogLevelDebug` | Enable debug logging | -| `ADJLogLevelInfo` | Only show info level logs (default option) | -| `ADJLogLevelWarn` | Disable info logging | -| `ADJLogLevelError` | Disable warning level logging and below | -| `ADJLogLevelAssert` | Disable error level logging and below | -| `ADJLogLevelSuppress` | Suppress all logging | - -
- -You can set your log level by calling the `setLogLevel` method on your `ADJConfig` instance. - - diff --git a/src/content/docs/sdk/ios/configuration/preinstalled.mdx b/src/content/docs/sdk/ios/configuration/preinstalled.mdx deleted file mode 100644 index 7840b41e0..000000000 --- a/src/content/docs/sdk/ios/configuration/preinstalled.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Send preinstalled app activity -description: Configure a campaign to send information from preinstalled apps. -slug: en/sdk/ios/configuration/preinstalled ---- - -import SetDefaultTracker from "@ios-examples/ADJConfig/setDefaultTracker.mdx" -import SetDefaultTrackerSig from "@ios-signatures/ADJConfig/setDefaultTracker.mdx" - -You can use the Adjust SDK to record activity from apps that came preinstalled on a user's device. This enables you to send information from users who didn't download your app from a campaign. - -Configuring a default campaign enables you to attribute all preinstalls to a predefined campaign token. Adjust records all information against this token until the attribution source changes. To set this up: - -1. Create a new link in Adjust. - -```http "{token}" -https://app.adjust.com/{token} -``` - -2. Copy this token and pass it to the `setDefaultTracker` method in your app delegate file. - - - -3. Build and run your app. If you have logging enabled, you should see a message in your log - -```text -Default tracker: 'abc123'. -``` diff --git a/src/content/docs/sdk/ios/configuration/privacy.mdx b/src/content/docs/sdk/ios/configuration/privacy.mdx deleted file mode 100644 index 7fa4e8e8f..000000000 --- a/src/content/docs/sdk/ios/configuration/privacy.mdx +++ /dev/null @@ -1,149 +0,0 @@ ---- -title: Set up privacy features -description: Configure features that you can use to handle user privacy in your app. -slug: en/sdk/ios/configuration/privacy ---- - -import GdprForgetMe from "@ios-examples/Adjust/gdprForgetMe.mdx"; -import GdprForgetMeSig from "@ios-signatures/Adjust/gdprForgetMe.mdx"; -import InitWithIsEnabledNumberBoolFalse from "@ios-examples/ADJThirdPartySharing/initWithIsEnabledNumberBoolFalse.mdx"; -import InitWithIsEnabledNumberBoolTrue from "@ios-examples/ADJThirdPartySharing/initWithIsEnabledNumberBoolTrue.mdx"; -import ConstructorSig from "@ios-signatures/ADJThirdPartySharing/constructor.mdx"; -import AddGranularOption from "@ios-examples/ADJThirdPartySharing/addGranularOption.mdx"; -import AddGranularOptionSig from "@ios-signatures/ADJThirdPartySharing/addGranularOption.mdx"; -import AddPartnerSharingSetting from "@ios-examples/ADJThirdPartySharing/addPartnerSharingSetting.mdx"; -import AddPartnerSharingSettingSig from "@ios-signatures/ADJThirdPartySharing/addPartnerSharingSetting.mdx"; -import AddGranularOptionFacebook from "@ios-examples/ADJThirdPartySharing/addGranularOptionFacebook.mdx"; -import DisableThirdPartySharing from "@ios-examples/Adjust/disableThirdPartySharing.mdx"; -import DisableThirdPartySharingSig from "@ios-signatures/Adjust/disableThirdPartySharing.mdx"; -import SetUrlStrategy from "@ios-examples/ADJConfig/setUrlStrategy.mdx"; -import SetUrlStrategySig from "@ios-signatures/ADJConfig/setUrlStrategy.mdx"; -import TrackMeasurementConsent from "@ios-examples/Adjust/trackMeasurementConsent.mdx"; -import TrackMeasurementConsentSig from "@ios-signatures/Adjust/trackMeasurementConsent.mdx"; - -The Adjust SDK contains features that you can use to handle user privacy in your app. - -## GDPR right to be forgotten - -Article 17 of the European Union's GDPR (General Data Protection Regulation) grants users the right to be forgotten. When Adjust's servers receive an RTBF (Right to be Forgotten) request, Adjust erases the user's data. The SDK also stops sending requests from the device for the app in question. - -You can send the user's RTBF request to Adjust by calling the `gdprForgetMe` method. - - - -## Third-party sharing for specific users - -You can use the Adjust SDK to record when a user changes their third-party sharing settings. - -### Disable third-party sharing - -Some users may want to opt-out of sharing their data with third-parties. To communicate this to Adjust, call the `trackThirdPartySharing` method with an [`ADJThirdPartySharing` object](/en/sdk/ios/reference/adjthirdpartysharing) initialized with a `false` value. 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. - - - -### Enable third-party sharing - - - -### Send granular information - -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 your partner name and your options. - - - -### Update partner 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 your partner name and your options. - - - -#### Manage Facebook Limited Data Use - - - -The Adjust SDK sends information to Facebook as soon as the app is installed. You need to make sure you call this method **before** initializing the SDK. - - - -Facebook provides a feature called LDU (Limited Data Use) to comply with the CCPA (California Consumer Privacy Act). 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 to the `addGranularOption` method. - - - - - -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`. - - - -#### Provide consent data to Google (Digital Markets Act compliance) - - - -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.
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. | - -
- - - - -```swift -let adjustThirdPartySharing = ADJThirdPartySharing.initWithIsEnabledNumberBool(nil) -adjustThirdPartySharing.addGranularOption("google_dma", key: "eea", value: "1") -adjustThirdPartySharing.addGranularOption("google_dma", key: "ad_personalization", value: "1") -adjustThirdPartySharing.addGranularOption("google_dma", key: "ad_user_data", value: "1") -Adjust.trackThirdPartySharing(adjustThirdPartySharing) -``` - - - - -```objc -ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabledNumberBool:nil]; -[adjustThirdPartySharing addGranularOption:@"google_dma" key:@"eea" value:@"1"]; -[adjustThirdPartySharing addGranularOption:@"google_dma" key:@"ad_personalization" value:@"1"]; -[adjustThirdPartySharing addGranularOption:@"google_dma" key:@"ad_user_data" value:@"1"]; -[Adjust trackThirdPartySharing:adjustThirdPartySharing]; -``` - - - - -## Disable third-party sharing - -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. - - - -## Data residency - -The data residency feature allows you to choose the country in which Adjust stores your data. This is useful if you're operating in a country with strict privacy requirements. When you set up data residency, Adjust stores your data in a data center located in the region your have chosen. - -To set your country of data residency, call the `setUrlStrategy` method on your `ADJConfig` instance. - - - -## Consent measurement for specific users - -If you are using [Data Privacy settings](https://help.adjust.com/en/article/manage-data-collection-and-retention) 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. 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. - - diff --git a/src/content/docs/sdk/ios/configuration/push-tokens.mdx b/src/content/docs/sdk/ios/configuration/push-tokens.mdx deleted file mode 100644 index 4ad63b3f2..000000000 --- a/src/content/docs/sdk/ios/configuration/push-tokens.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Set up push tokens -description: Configure push tokens for your app. -slug: en/sdk/ios/configuration/push-tokens ---- - -import SetDeviceToken from "@ios-examples/Adjust/setDeviceToken.mdx" -import SetDeviceTokenSig from "@ios-signatures/Adjust/setDeviceToken.mdx" - -Push tokens are used for [Audience Builder](https://help.adjust.com/en/article/audience-builder) and client callbacks. They're also required for [Uninstall and reinstall tracking](https://help.adjust.com/en/article/uninstalls-reinstalls). - -Your config object contains a string `pushToken` property that you can use to store your push token. You can update this property at any time by calling the `setDeviceToken` method inside the `didRegisterForRemoveNotificationsWithDeviceToken` method and passing your token as an argument. - - - -If you have access to the push token from the web view, you can call the `setDeviceToken` method in Javascript. - - - - diff --git a/src/content/docs/sdk/ios/features/ad-revenue.mdx b/src/content/docs/sdk/ios/features/ad-revenue.mdx index 0a1178bc1..e606098c2 100644 --- a/src/content/docs/sdk/ios/features/ad-revenue.mdx +++ b/src/content/docs/sdk/ios/features/ad-revenue.mdx @@ -4,23 +4,6 @@ description: Record ad revenue information for supported network partners using slug: en/sdk/ios/features/ad-revenue --- -import TrackAdRevenue from "@ios-examples/Adjust/trackAdRevenue.mdx"; -import TrackAdRevenueSig from "@ios-signatures/Adjust/trackAdRevenue.mdx"; -import SetRevenue from "@ios-examples/ADJAdRevenue/setRevenue.mdx"; -import SetRevenueSig from "@ios-signatures/ADJAdRevenue/setRevenue.mdx"; -import SetAdImpressionsCount from "@ios-examples/ADJAdRevenue/setAdImpressionsCount.mdx"; -import SetAdImpressionsCountSig from "@ios-signatures/ADJAdRevenue/setAdImpressionsCount.mdx"; -import SetAdRevenueNetwork from "@ios-examples/ADJAdRevenue/setAdRevenueNetwork.mdx"; -import SetAdRevenueNetworkSig from "@ios-signatures/ADJAdRevenue/setAdRevenueNetwork.mdx"; -import SetAdRevenueUnit from "@ios-examples/ADJAdRevenue/setAdRevenueUnit.mdx"; -import SetAdRevenueUnitSig from "@ios-signatures/ADJAdRevenue/setAdRevenueUnit.mdx"; -import SetAdRevenuePlacement from "@ios-examples/ADJAdRevenue/setAdRevenuePlacement.mdx"; -import SetAdRevenuePlacementSig from "@ios-signatures/ADJAdRevenue/setAdRevenuePlacement.mdx"; -import AddCallbackParameter from "@ios-examples/ADJAdRevenue/addCallbackParameter.mdx"; -import AddCallbackParameterSig from "@ios-signatures/ADJAdRevenue/addCallbackParameter.mdx"; -import AddPartnerParameter from "@ios-examples/ADJAdRevenue/addPartnerParameter.mdx"; -import AddPartnerParameterSig from "@ios-signatures/ADJAdRevenue/addPartnerParameter.mdx"; - You can record ad revenue for [supported network partners](https://help.adjust.com/en/article/ad-revenue) using the Adjust SDK. @@ -29,14 +12,17 @@ You need to perform some extra setup steps in your Adjust dashboard to measure a -To send ad revenue to Adjust: +## Instantiate an ADJAdRevenue object + +```objc title="Method signature" +- (nullable id)initWithSource:(nonnull NSString *)source; +``` -1. Create a new Adjust ad revenue instance and pass your ad revenue source as an argument. -2. Call the `trackAdRevenue` method with your ad revenue instance as an argument. +To send ad revenue information with the Adjust SDK, you need to instantiate an `ADJAdRevenue` object. This object contains variables that are sent to Adjust when ad revenue is recorded in your app. - +To instantiate an ad revenue object, create a new `ADJAdRevenue` instance and pass the following parameters: -## Sources +- `source` (**NSString**): The source of the ad revenue. See the table below for available sources @@ -46,23 +32,72 @@ To send ad revenue to Adjust: | `ADJAdRevenueSourceMopub` | Mopub | | `ADJAdRevenueSourceAdMob` | AdMob | | `ADJAdRevenueSourceIronSource` | ironSource | -| `ADJAdRevenueSourceAdMost` | AdMost | +| `ADJAdRevenueSourceAdmost` | AdMost | | `ADJAdRevenueSourceUnity` | Unity | | `ADJAdRevenueSourceHeliumChartboost` | Helium Chartboost | | `ADJAdRevenueSourcePublisher` | Generic source | -| `ADJAdRevenueSourceADX` | Ad(X) |
-## Record ad revenue amount + + + +```swift {1} +let adRevenue = ADJAdRevenue(source: source); +//... +Adjust.trackAdRevenue(adRevenue); +``` + + + + +```objc {1} +ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source]; +//... +[Adjust trackAdRevenue:adRevenue]; +``` + + + + +## Send ad revenue + +```objc title="Method signature" ++ (void)trackAdRevenue:(nonnull NSString *)source payload:(nonnull NSData *)payload; +``` + +To send ad revenue to Adjust, call the `trackAdRevenue` method with your ad revenue instance as an argument. + + + + +```swift +let adRevenue = ADJAdRevenue(source: source); +Adjust.trackAdRevenue(adRevenue); +``` + + + + +```objc +ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source]; +///... +[Adjust trackAdRevenue:adRevenue]; +``` -You can record ad revenue by setting the `revenue` and `currency` properties on your ad revenue instance. + + -To set these properties, call the `setRevenue` method and pass the following arguments: +## Record ad revenue amount + +```objc title="Method signature" +- (void)setRevenue:(double)amount currency:(nonnull NSString *)currency; +``` -`revenue` **number**: The amount of revenue +To send the ad revenue amount, call the `setRevenue` method and pass the following arguments: -`currency` **string**: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of your reporting currency +- `revenue` (**double**): The amount of revenue +- `currency` (**NSString**): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of your reporting currency @@ -70,38 +105,161 @@ Check the [guide to tracking purchases in different currencies](https://help.adj - + + + +```swift {2} +let adRevenue = ADJAdRevenue(source: source); +adRevenue.setRevenue(1.6, currency: "USD"); +Adjust.trackAdRevenue(adRevenue); +``` + + + + +```objc {2} +ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source]; +[adRevenue setRevenue:1.6 currency:@"USD"]; +[Adjust trackAdRevenue:adRevenue]; +``` + + + ## Record ad campaign details -The ad revenue object contains properties you can use to report on your ad campaigns. +The `ADJAdRevenue` class contains properties you can use to report on your ad campaigns. ### Ad impressions -Record the number of ad impressions by passing an **integer** value to the `setAdImpressionsCount` method. +```objc title="Method signature" +- (void)setAdImpressionsCount:(int)adImpressionsCount; +``` + +To send the number of recorded ad impressions, call the `setAdImpressionsCount` method and pass the following arguments: - +- `adImpressionsCount` (**int**): The number of ad impressions. + + + + +```swift {2} +let adRevenue = ADJAdRevenue(source: source); +adRevenue?.adImpressionsCount = 1; +Adjust.trackAdRevenue(adRevenue); +``` + + + + +```objc {2} +ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source]; +[adRevenue setAdImpressionsCount:1]; +[Adjust trackAdRevenue:adRevenue]; +``` + + + ### Ad revenue network -Record which network generated the revenue by passing a **string** value to the `setAdRevenueNetwork` method. +```objc title="Method signature" +- (void)setAdRevenueNetwork:(nonnull NSString *)adRevenueNetwork; +``` + +To send the ad revenue network, call the `setAdRevenueNetwork` method and pass the following arguments: + +- `adRevenueNetwork` (**NSString**): The network name. + + + + +```swift {2} +let adRevenue = ADJAdRevenue(source: source); +adRevenue?.adRevenueNetwork = "network1"; +Adjust.trackAdRevenue(adRevenue); +``` + + + + +```objc {2} +ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source]; +[adRevenue setAdRevenueNetwork:@"network1"]; +[Adjust trackAdRevenue:adRevenue]; +``` - + + ### Ad revenue unit -Record which ad revenue unit generated the revenue by passing a **string** value to the `setAdRevenueUnit` method. +```objc title="Method signature" +- (void)setAdRevenueUnit:(nonnull NSString *)adRevenueUnit; +``` + +To send the ad revenue unit, call the `setAdRevenueUnit` method and pass the following arguments: + +- `adRevenueUnit` (**NSString**): The ad unit. + + + + +```swift {2} +let adRevenue = ADJAdRevenue(source: source); +adRevenue?.adRevenueUnit = "unit1"; +Adjust.trackAdRevenue(adRevenue); +``` + + + + +```objc {2} +ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source]; +[adRevenue setAdRevenueUnit:@"unit1"]; +[Adjust trackAdRevenue:adRevenue]; +``` - + + ### Ad revenue placement -Record the placement of your ad by passing a **string** value to the `setAdRevenuePlacement` method. +```objc title="Method signature" +- (void)setAdRevenuePlacement:(nonnull NSString *)adRevenuePlacement; +``` + +To send the ad revenue placement, call the `setAdRevenuePlacement` method and pass the following arguments: - +- `adRevenuePlacement` (**NSString**): The ad placement. + + + + +```swift {2} +let adRevenue = ADJAdRevenue(source: source); +adRevenue?.adRevenuePlacement = "banner"; +Adjust.trackAdRevenue(adRevenue); +``` + + + + +```objc {2} +ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source]; +[adRevenue setAdRevenuePlacement:@"banner"]; +[Adjust trackAdRevenue:adRevenue]; +``` + + + ## Add callback parameters +```objc title="Method signature" +- (void)addCallbackParameter:(nonnull NSString *)key value:(nonnull NSString *)value; +``` + If you [register a callback URL](https://help.adjust.com/en/article/recommended-placeholders-callbacks) in the Adjust dashboard, the SDK sends a GET request to your callback URL when it records an event. You can configure callback parameters to your servers. Once you configure parameters on an event, the SDK appends them to your [callback URL](https://help.adjust.com/en/article/raw-data-exports). You can use this information to analyze your users' in-app behavior with your BI system. @@ -110,7 +268,7 @@ Add callback parameters to your event by calling the `addCallbackParameter` meth The Adjust SDK measures the event and sends a request to your URL with the callback parameters. For example, if you register the URL `https://www.mydomain.com/callback`, your callback looks like this: -```http +```http "key=value" "foo=bar" https://www.mydomain.com/callback?key=value&foo=bar ``` @@ -130,10 +288,33 @@ You can read more about using URL callbacks, including a full list of available - + + + +```swift {2} +let adRevenue = ADJAdRevenue(source: source); +adRevenue.addCallbackParameter(key, value: value); +Adjust.trackAdRevenue(adRevenue); +``` + + + + +```objc {2} +ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source]; +[adRevenue addCallbackParameter:key value:value]; +[Adjust trackAdRevenue:adRevenue]; +``` + + + ## Add partner parameters +```objc title="Method signature" +- (void)addPartnerParameter:(nonnull NSString *)key value:(nonnull NSString *)value; +``` + You can send extra information to your network partners by adding [partner parameters](https://help.adjust.com/en/article/data-sharing-ad-network#map-parameters). Adjust sends partner parameters to [external partners](https://help.adjust.com/en/article/integrated-partners) you have set up. This information is useful for more granular analysis and retargeting purposes. Adjust's servers forward these parameters once you have set them up and enabled them for a partner. @@ -146,7 +327,27 @@ Partner parameters don't appear in raw data by default. You can add the `{partne Add partner parameters to your event by calling the `addPartnerParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times. - + + + +```swift {2} +let adRevenue = ADJAdRevenue(source: source); +adRevenue.addPartnerParameter(key, value: value); +Adjust.trackAdRevenue(adRevenue); +``` + + + + +```objc {2} +ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source]; +[adRevenue addPartnerParameter:key value:value]; +[Adjust trackAdRevenue:adRevenue]; +``` + + + + ## Example diff --git a/src/content/docs/sdk/ios/configuration/att.mdx b/src/content/docs/sdk/ios/features/att.mdx similarity index 54% rename from src/content/docs/sdk/ios/configuration/att.mdx rename to src/content/docs/sdk/ios/features/att.mdx index a2efc4a6a..4a09ea56d 100644 --- a/src/content/docs/sdk/ios/configuration/att.mdx +++ b/src/content/docs/sdk/ios/features/att.mdx @@ -1,16 +1,10 @@ --- title: Set up App Tracking Transparency description: Configure your app to use Apple's App Tracking Transparency framework -slug: en/sdk/ios/configuration/att +slug: en/sdk/ios/features/att --- -import RequestTrackingAuthorization from "@ios-examples/Adjust/requestTrackingAuthorization.mdx" -import AppTrackingAuthorizationStatus from "@ios-examples/Adjust/appTrackingAuthorizationStatus.mdx" -import AppTrackingAuthorizationStatusSig from "@ios-signatures/Adjust/appTrackingAuthorizationStatus.mdx" -import CheckForNewAttStatus from "@ios-examples/Adjust/checkForNewAttStatus.mdx" -import CheckForNewAttStatusSig from "@ios-signatures/Adjust/checkForNewAttStatus.mdx" - -If you want to record the device's IDFA (ID for Advertisers), you must display a prompt to get your user's authorization. To do this, you need to include Apple's ATT (App Tracking Transparency) framework in your app. The Adjust SDK stores the user's authorization status and sends it to Adjust's servers with each request. +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. ## Authorization statuses @@ -27,12 +21,16 @@ If you want to record the device's IDFA (ID for Advertisers), you must display a -You might receive a status code of `-1` if the SDK is unable to retrieve the ATT (App Tracking Transparency) status. +You might receive a status code of `-1` if the SDK is unable to retrieve the ATT status. ## App-tracking authorization wrapper +```objc title="Method signature" ++ (void)requestTrackingAuthorizationWithCompletionHandler:(void (^_Nullable)(NSUInteger status))completion; +``` + The Adjust SDK contains a wrapper around [Apple's `requestTrackingAuthorizationWithCompletionHandler` method](https://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/3547037-requesttrackingauthorizationwith). You can use this wrapper if you don't want to customize 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. @@ -45,16 +43,109 @@ The Adjust SDK also records the consent status if you use a custom prompt. If yo - + + + +```swift +Adjust.requestTrackingAuthorization() { status in + switch status { + case 0: + // ATTrackingManagerAuthorizationStatusNotDetermined case + break + case 1: + // ATTrackingManagerAuthorizationStatusRestricted case + break + case 2: + // ATTrackingManagerAuthorizationStatusDenied case + break + case 3: + // ATTrackingManagerAuthorizationStatusAuthorized case + break + default: + break + } +} +``` + + + + +```objc +[Adjust requestTrackingAuthorizationWithCompletionHandler:^(NSUInteger status) { + switch (status) { + case 0: + // ATTrackingManagerAuthorizationStatusNotDetermined case + break; + case 1: + // ATTrackingManagerAuthorizationStatusRestricted case + break; + case 2: + // ATTrackingManagerAuthorizationStatusDenied case + break; + case 3: + // ATTrackingManagerAuthorizationStatusAuthorized case + break; + } +}]; +``` + + + ## Get current authorization status -You can retrieve a user's current authorization status at any time. Call the `appTrackingAuthorizationStatus` method to return the authorization status code as an **integer**. +```objc title="Method signature" ++ (int)appTrackingAuthorizationStatus; +``` + +You can retrieve a user's current authorization status at any time. Call the `getAppTrackingAuthorizationStatus` method to return the authorization status code as an **integer**. + + + + +```swift +let authorizationStatus = Adjust.appTrackingAuthorizationStatus(); +``` + + + + +```objc +int authorizationStatus = [Adjust appTrackingAuthorizationStatus]; +``` + + - + + +```js +var authorizationStatus = Adjust.appTrackingAuthorizationStatus(); +``` + + + ## Check for authorization status changes +```objc title="Method signature" ++ (void)checkForNewAttStatus; +``` + If you use a custom ATT prompt, you need to inform the Adjust SDK of changes to the user's authorization status. Call the `checkForNewAttStatus` method to send the authorization status to Adjust's servers. - + + + +```swift +Adjust.checkForNewAttStatus(); +``` + + + + +```objc +[Adjust checkForNewAttStatus]; +``` + + + diff --git a/src/content/docs/sdk/ios/features/attribution.mdx b/src/content/docs/sdk/ios/features/attribution.mdx index 9c3b26b42..9f9a21938 100644 --- a/src/content/docs/sdk/ios/features/attribution.mdx +++ b/src/content/docs/sdk/ios/features/attribution.mdx @@ -4,11 +4,47 @@ description: Listen for attribution changes using the Adjust SDK slug: en/sdk/ios/features/attribution --- -import SetDelegate from "@ios-examples/ADJConfig/setDelegate.mdx"; -import Attribution from "@ios-examples/Adjust/attribution.mdx"; -import AttributionSig from "@ios-signatures/Adjust/attribution.mdx"; +When a user interacts with an Adjust link, their attribution information updates. This can happen if the user interacts with a [deep link](https://help.adjust.com/en/article/deep-links). Information about a user's attribution is represented in the `AdjustAttribution` class. -When a user interacts with a campaign link, their attribution information updates. This can happen if the user interacts with a [deep link](https://help.adjust.com/en/article/deep-links). The SDK can listen for attribution changes and call a function when it detects an update. +## ADJAttribution class properties + +The `AdjustAttribution` class contains details about the current attribution status of the device. Any values that aren't populated for the user are returned as a `null` value. + + + +The following values can only be accessed if the `needsCost` property on your `ADJConfig` instance is `true`: + +- `costType` +- `costAmount` +- `costCurrency` + + + + + +| Values | Data type | Description | +| -------------- | --------- | -------------------------------------------------------------------------------------------------------------- | +| `trackerToken` | String | The token of the tracker to which the device is currently attributed | +| `trackerName` | String | The name of the tracker to which the device is currently attributed | +| `network` | String | The name of the network to which the device is currently attributed | +| `campaign` | String | The name of the campaign to which the device is currently attributed | +| `adgroup` | String | The name of the adgroup to which the device is currently attributed | +| `creative` | String | The name of the creative to which the device is currently attributed | +| `clickLabel` | String | The [click label](https://help.adjust.com/en/article/user-rewards) that the install is tagged with | +| `adid` | String | The unique Adjust ID assigned to the device | +| `costType` | String | The campaign pricing model (for example cpi) | +| `costAmount` | Number | The cost of the install. | +| `costCurrency` | String | The [3 character ISO 4217 code](https://www.iban.com/currency-codes) of the currency associated with the cost. | + +
+ +## Trigger a function when attribution changes + +```objc title="Property declaration" +@property (nonatomic, weak, nullable) NSObject *delegate; +``` + +The SDK can listen for attribution changes and call a function when it detects an update. To configure your delegate function: 1. If you aren't using web views, add the `AdjustDelegate` declaration to your `AppDelegate` header file. @@ -57,14 +93,86 @@ class AppDelegate: UIResponder, UIApplicationDelegate, AdjustDelegate { 3. Set the delegate with your Adjust config instance. - + + + +```swift {6} +let yourAppToken = "{YourAppToken}" +let environment = ADJEnvironmentSandbox as? String +let adjustConfig = ADJConfig( + appToken: yourAppToken, + environment: environment) +adjustConfig?.delegate = self +//... +Adjust.appDidLaunch(adjustConfig) +``` -Within your delegate function, you have access to the user's `Attribution` information. See the [`ADJAttribution` class reference](/en/sdk/ios/reference/adjattribution) for a list of available properties. + + + +```objc {3} +*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}" + environment:ADJEnvironmentSandbox]; +[adjustConfig setDelegate:self]; +/// ... +[Adjust appDidLaunch:adjustConfig]; +``` + + + + +```javascript {5-15} +setupWebViewJavascriptBridge(function(bridge) { + var yourAppToken = yourAppToken; + var environment = AdjustConfig.EnvironmentSandbox; + var adjustConfig = new AdjustConfig(yourAppToken, environment); + adjustConfig.setAttributionCallback(function(attribution) { + // In this example, we're just displaying alert with attribution content. + alert('Tracker token = ' + attribution.trackerToken + '\n' + + 'Tracker name = ' + attribution.trackerName + '\n' + + 'Network = ' + attribution.network + '\n' + + 'Campaign = ' + attribution.campaign + '\n' + + 'Adgroup = ' + attribution.adgroup + '\n' + + 'Creative = ' + attribution.creative + '\n' + + 'Click label = ' + attribution.clickLabel + '\n' + + 'Adid = ' + attribution.adid); + }); +}); +``` + + + + +Within your delegate function, you have access to the user's `Attribution` information. See the [`ADJAttribution` class properties](#adjattribution-class-properties) for a list of available properties. ## Get current attribution information -When a user installs your app, Adjust attributes the install to a campaign. The Adjust SDK gives you access to campaign attribution details for your install. To return this information, call the `attribution` method. +```objc title="Method signature" ++ (nullable ADJAttribution *)attribution; +``` + +When a user installs your app, Adjust attributes the install to a campaign. The Adjust SDK gives you access to campaign attribution details for your install. To return this information, call the `attribution` method to return the attribution information as an `ADJAttribution` object. + + + + +```swift +let attribution = Adjust.attribution() +``` + + + -This method returns an Attribution object. See the [`ADJAttribution` class reference](/en/sdk/ios/reference/adjattribution) for a list of available properties. +```objc +ADJAttribution *attribution = [Adjust attribution]; +``` - + + + +```js +var attribution = Adjust.getAttribution(); +``` + + + diff --git a/src/content/docs/sdk/ios/configuration/deep-links/data-points.mdx b/src/content/docs/sdk/ios/features/deep-links/data-points.mdx similarity index 98% rename from src/content/docs/sdk/ios/configuration/deep-links/data-points.mdx rename to src/content/docs/sdk/ios/features/deep-links/data-points.mdx index 24122fffb..d3a2ab2e1 100644 --- a/src/content/docs/sdk/ios/configuration/deep-links/data-points.mdx +++ b/src/content/docs/sdk/ios/features/deep-links/data-points.mdx @@ -1,7 +1,7 @@ --- title: Retrieve data points description: Retrieve the data required to set up deep links. -slug: en/sdk/ios/configuration/deep-links/data-points +slug: en/sdk/ios/features/deep-links/data-points sidebar-position: 1 --- diff --git a/src/content/docs/sdk/ios/configuration/deep-links/deep-link.mdx b/src/content/docs/sdk/ios/features/deep-links/deep-link.mdx similarity index 98% rename from src/content/docs/sdk/ios/configuration/deep-links/deep-link.mdx rename to src/content/docs/sdk/ios/features/deep-links/deep-link.mdx index b196c0fde..b5afaf226 100644 --- a/src/content/docs/sdk/ios/configuration/deep-links/deep-link.mdx +++ b/src/content/docs/sdk/ios/features/deep-links/deep-link.mdx @@ -1,7 +1,7 @@ --- title: Enable deep links in Adjust description: Configure your app in Adjust to enable deep linking. -slug: en/sdk/ios/configuration/deep-links/deep-link +slug: en/sdk/ios/features/deep-links/deep-link sidebar-position: 2 --- diff --git a/src/content/docs/sdk/ios/configuration/deep-links/deferred.mdx b/src/content/docs/sdk/ios/features/deep-links/deferred.mdx similarity index 83% rename from src/content/docs/sdk/ios/configuration/deep-links/deferred.mdx rename to src/content/docs/sdk/ios/features/deep-links/deferred.mdx index 0441e225e..9413cf1ea 100644 --- a/src/content/docs/sdk/ios/configuration/deep-links/deferred.mdx +++ b/src/content/docs/sdk/ios/features/deep-links/deferred.mdx @@ -1,13 +1,10 @@ --- title: Set up deferred deep linking description: Configure deferred deep linking for your app. -slug: en/sdk/ios/configuration/deep-links/deferred +slug: en/sdk/ios/features/deep-links/deferred sidebar-position: 4 --- -import SetLinkMeEnabled from "@ios-examples/ADJConfig/setLinkMeEnabled.mdx" -import SetLinkMeEnabledSig from "@ios-signatures/ADJConfig/setLinkMeEnabled.mdx" - A deferred deep link sends a user to a place in your app after routing them via the App Store to install the app first. ## How it works @@ -131,6 +128,10 @@ func adjustDeeplinkResponse(_ deeplink: URL?) -> Bool { ## Set up Adjust LinkMe +```objc title="Property declaration" +@property (nonatomic, assign) BOOL linkMeEnabled; +``` + Discuss with your marketing team whether you need to implement LinkMe in your app. @@ -149,4 +150,43 @@ When a user clicks on a LinkMe URL they have the option to copy the link informa To enable pasteboard checking in your app, pass a **true** value to the `setLinkMeEnabled` method on your `ADJConfig` object: - + + + +```swift {7} +let yourAppToken = "{YourAppToken}" +let environment = ADJEnvironmentSandbox as? String +let adjustConfig = ADJConfig( + appToken: yourAppToken, + environment: environment) +// ... +adjustConfig?.linkMeEnabled = true +``` + + + + +```objc {6} +NSString *yourAppToken = @"{YourAppToken}"; +NSString *environment = ADJEnvironmentSandbox; +*adjustConfig = [ADJConfig configWithAppToken:yourAppToken + environment:environment]; +/// ... +[adjustConfig setLinkMeEnabled:YES]; +``` + + + + +```js {6} +setupWebViewJavascriptBridge(function(bridge) { + // ... + var yourAppToken = yourAppToken; + var environment = AdjustConfig.EnvironmentSandbox; + var adjustConfig = new AdjustConfig(yourAppToken, environment); + adjustConfig.setLinkMeEnabled(true); +}); +``` + + + diff --git a/src/content/docs/sdk/ios/configuration/deep-links/direct.mdx b/src/content/docs/sdk/ios/features/deep-links/direct.mdx similarity index 99% rename from src/content/docs/sdk/ios/configuration/deep-links/direct.mdx rename to src/content/docs/sdk/ios/features/deep-links/direct.mdx index a47f81cae..f33556753 100644 --- a/src/content/docs/sdk/ios/configuration/deep-links/direct.mdx +++ b/src/content/docs/sdk/ios/features/deep-links/direct.mdx @@ -1,7 +1,7 @@ --- title: Set up direct deep linking description: Configure direct deep linking for your app. -slug: en/sdk/ios/configuration/deep-links/direct +slug: en/sdk/ios/features/deep-links/direct sidebar-position: 3 --- diff --git a/src/content/docs/sdk/ios/features/deep-links/index.mdx b/src/content/docs/sdk/ios/features/deep-links/index.mdx new file mode 100644 index 000000000..b426a1047 --- /dev/null +++ b/src/content/docs/sdk/ios/features/deep-links/index.mdx @@ -0,0 +1,14 @@ +--- +title: Deep linking +description: Follow the guides in this section to set up deep linking. +category-title: Deep linking +slug: en/sdk/ios/features/deep-links +type: category +--- + +You can create deep links to take users to specific pages in your app. The Adjust SDK uses different logic depending on if the user already has your app installed on their device: + +- Direct deep linking: occurs if the user already has your app installed. The link takes the user to the page specified in the link +- Deferred deep linking: occurs if the user doesn't have your app installed. The link takes the user to a storefront to install your app first. After the user installs the app, it opens to the page specified in the link. + +The SDK can read deep link data after a user opens your app from a link. Follow the steps in this section to get started. diff --git a/src/content/docs/sdk/ios/configuration/deep-links/resolution.mdx b/src/content/docs/sdk/ios/features/deep-links/resolution.mdx similarity index 98% rename from src/content/docs/sdk/ios/configuration/deep-links/resolution.mdx rename to src/content/docs/sdk/ios/features/deep-links/resolution.mdx index a6cf5513b..b40c5ca63 100644 --- a/src/content/docs/sdk/ios/configuration/deep-links/resolution.mdx +++ b/src/content/docs/sdk/ios/features/deep-links/resolution.mdx @@ -1,13 +1,10 @@ --- title: Link resolution description: Set up link resolution for deep linking via email, SMS, QR codes, and platforms that shorten links. -slug: en/sdk/ios/configuration/deep-links/resolution +slug: en/sdk/ios/features/deep-links/resolution sidebar-position: 5 --- -import ResolveLinkWithUrl from "@ios-signatures/ADJLinkResolution/resolveLinkWithUrl.mdx" -import AppWillOpenUrl from "@ios-signatures/Adjust/appWillOpenUrl.mdx" - 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. diff --git a/src/content/docs/sdk/ios/configuration/deep-links/testing.mdx b/src/content/docs/sdk/ios/features/deep-links/testing.mdx similarity index 98% rename from src/content/docs/sdk/ios/configuration/deep-links/testing.mdx rename to src/content/docs/sdk/ios/features/deep-links/testing.mdx index f15511e8a..bf6cf5625 100644 --- a/src/content/docs/sdk/ios/configuration/deep-links/testing.mdx +++ b/src/content/docs/sdk/ios/features/deep-links/testing.mdx @@ -1,12 +1,10 @@ --- title: Test deep linking description: Test your deep links to ensure they work as expected. -slug: en/sdk/ios/configuration/deep-links/testing +slug: en/sdk/ios/features/deep-links/testing sidebar-position: 6 --- -import AppWillOpenUrl from "@ios-signatures/Adjust/appWillOpenUrl.mdx" - Before your marketing team goes live with your deep links in a campaign, it's important to test them. This ensures that: * They're set up correctly. @@ -21,7 +19,7 @@ Here's what you need to do before getting started. 2. Build and run your app in Xcode. 3. Obtain an example deep link from your marketing team. - Example: `https://example.go.link/summer-clothes?promo=beach + Example: `https://example.go.link/summer-clothes?promo=beach` ## Create a test link diff --git a/src/content/docs/sdk/ios/features/device-info.mdx b/src/content/docs/sdk/ios/features/device-info.mdx index 9d1072422..e6b2a6b39 100644 --- a/src/content/docs/sdk/ios/features/device-info.mdx +++ b/src/content/docs/sdk/ios/features/device-info.mdx @@ -4,21 +4,70 @@ description: Use these methods to add details to your callbacks and improve your slug: en/sdk/ios/features/device-info --- -import Idfa from "@ios-examples/Adjust/idfa.mdx" -import IdfaSig from "@ios-signatures/Adjust/idfa.mdx" -import Adid from "@ios-examples/Adjust/adid.mdx" -import AdidSig from "@ios-signatures/Adjust/adid.mdx" - The Adjust SDK contains helper methods that return device information. Use these methods to add details to your callbacks and improve your reporting. +## Adjust device identifier + +```objc title="Method signature" ++ (nullable NSString *)adid; +``` + +Adjust generates a unique Adjust Device ID (ADID) for each device. Call the `adid` method to return this ID as a **string**. + + + + +```swift +let adid = Adjust.adid() +``` + + + + +```objc +NSString *adid = [Adjust adid]; +``` + + + + +```js +var adid = Adjust.getAdid(); +``` + + + + ## ID For Advertisers +```objc title="Method signature" ++ (nullable NSString *)idfa; +``` + The IDFA (ID for Advertisers) is a device-specific identifier for Apple devices. Call the `idfa` method to return this ID as a **string**. - + + -## Adjust device identifier +```swift +let idfa = Adjust.idfa() +``` + + + + +```objc +NSString *idfa = [Adjust idfa]; +``` + + + -Adjust generates a unique ADID (Adjust Device ID) for each device. Call the `adid` method to return this ID as a **string**. +```js +Adjust.getIdfa(function(idfa) { + // … +}); +``` - + + diff --git a/src/content/docs/sdk/ios/features/events.mdx b/src/content/docs/sdk/ios/features/events.mdx index 0c2a0bfcb..60e87d13f 100644 --- a/src/content/docs/sdk/ios/features/events.mdx +++ b/src/content/docs/sdk/ios/features/events.mdx @@ -4,23 +4,86 @@ description: Use these methods send event information to Adjust. slug: en/sdk/ios/features/events --- -import TrackEvent from "@ios-examples/Adjust/trackEvent.mdx" -import TrackEventSig from "@ios-signatures/Adjust/trackEvent.mdx" -import SetRevenue from "@ios-examples/ADJEvent/setRevenue.mdx" -import SetRevenueSig from "@ios-signatures/ADJEvent/setRevenue.mdx" -import SetCallbackId from "@ios-examples/ADJEvent/setCallbackId.mdx" -import SetCallbackIdSig from "@ios-signatures/ADJEvent/setCallbackId.mdx" -import AddCallbackParameter from "@ios-examples/ADJEvent/addCallbackParameter.mdx" -import AddCallbackParameterSig from "@ios-signatures/ADJEvent/addCallbackParameter.mdx" -import AddPartnerParameter from "@ios-examples/ADJEvent/addPartnerParameter.mdx" -import AddPartnerParameterSig from "@ios-signatures/ADJEvent/addPartnerParameter.mdx" +The Adjust SDK provides an `ADJEvent` object which can be used to structure and send event information from your app to Adjust's servers. + +## Instantiate an ADJEvent object + +```objc title="Method signature" ++ (nullable ADJEvent *)eventWithEventToken:(nonnull NSString *)eventToken; +``` + +To send event information with the Adjust SDK, you need to instantiate an `ADJEvent` object. This object contains variables that are sent to Adjust when an event occurs in your app. + +To instantiate an event object, create a new `ADJEvent` instance and pass the following parameters: + +- `eventToken` (**NSString**): Your Adjust [event token](https://help.adjust.com/en/article/add-events#manage-your-events). + + + + +```swift {1} +let event = ADJEvent(eventToken: "abc123") +Adjust.trackEvent(event) +``` + + + + +```objc {1} +ADJEvent *event = [ADJEvent eventWithEventToken:@"abc123"]; +[Adjust trackEvent:event]; +``` + + + + +```js {1} +var adjustEvent = new AdjustEvent("abc123"); +Adjust.trackEvent(adjustEvent); +``` + + + + +## Send an event + +```objc title="Method signature" ++ (void)trackEvent:(nullable ADJEvent *)event; +``` You can associate your [Adjust event tokens](https://help.adjust.com/en/article/add-events#add-event) to actions in your app to record them. To record an event: -* Create a new Adjust event instance and pass your event token as a string argument. -* Call the `trackEvent` method with your event instance as an argument. +- Create a new Adjust event instance and pass your event token as a string argument. +- Call the `trackEvent` method with your event instance as an argument. - + + + +```swift {2} +let event = ADJEvent(eventToken: "abc123") +Adjust.trackEvent(event) +``` + + + + +```objc {2} +ADJEvent *event = [ADJEvent eventWithEventToken:@"abc123"]; +[Adjust trackEvent:event]; +``` + + + + +```js {2} +var adjustEvent = new AdjustEvent("abc123"); +Adjust.trackEvent(adjustEvent); +``` + + + + +### Example This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. @@ -87,10 +150,10 @@ class ViewControllerSwift: UIViewController { } } -
-
- -
+
+
+ +
@@ -144,13 +207,16 @@ Parameters: ## Record event revenue +```objc title="Method signature" +- (void)setRevenue:(double)amount currency:(nonnull NSString *)currency; +``` + You can record revenue associated with an event by setting the revenue and currency properties on your event instance. Use this feature to record revenue-generating actions in your app. To set these properties, call the `setRevenue` method and pass the following arguments: -`revenue` (**number**): The amount of revenue generated by the event - -`currency` (**string**): The [ISO 4217 code](https://www.iban.com/currency-codes) of the event currency. +- `revenue` (**Number**): The amount of revenue generated by the event +- `currency` (**String**): The [ISO 4217 code](https://www.iban.com/currency-codes) of the event currency. @@ -158,7 +224,35 @@ Check the guide to [tracking purchases in different currencies](https://help.adj - + + + +```swift {2} +let event = ADJEvent(eventToken: "abc123") +event?.setRevenue(0.01, currency: "EUR") +Adjust.trackEvent(event) +``` + + + + +```objc {2} +ADJEvent *event = [ADJEvent eventWithEventToken:@"abc123"]; +[event setRevenue:0.01 currency:@"EUR"]; +[Adjust trackEvent:event]; +``` + + + + +```js {2} +var adjustEvent = new AdjustEvent(eventToken); +adjustEvent.setRevenue(0.01, "EUR"); +Adjust.trackEvent(adjustEvent); +``` + + + ### Example @@ -229,10 +323,10 @@ class ViewControllerSwift: UIViewController { } } -
-
- -
+
+
+ +
@@ -260,11 +354,9 @@ If you've enabled [purchase verification](https://help.adjust.com/en/article/pur -`transactionId` (NSString): The [`transactionIdentifier` value](https://developer.apple.com/documentation/storekit/skpaymenttransaction/1411288-transactionidentifier) of the successfully completed purchase - -`productId` (NSString): The product identifier of the item that was successfully purchased - -`receipt` (NSData): The [signed receipt](https://developer.apple.com/documentation/foundation/bundle/1407276-appstorereceipturl) containing the information about the successfully completed purchase +- `transactionId` (**NSString**): The [`transactionIdentifier` value](https://developer.apple.com/documentation/storekit/skpaymenttransaction/1411288-transactionidentifier) of the successfully completed purchase +- `productId` (**NSString**): The product identifier of the item that was successfully purchased +- `receipt` (**NSData**): The [signed receipt](https://developer.apple.com/documentation/foundation/bundle/1407276-appstorereceipturl) containing the information about the successfully completed purchase @@ -300,13 +392,48 @@ ADJEvent *event = [ADJEvent eventWithEventToken::@"your-event-token"]; ## Add callback parameters +```objc title="Method signature" +- (void)addCallbackParameter:(nonnull NSString *)key value:(nonnull NSString *)value; +``` + If you [register a callback URL](https://help.adjust.com/en/article/set-up-callbacks) in the Adjust dashboard, the SDK sends a GET request to your callback URL when it records an event. You can configure callback parameters to send to your servers. Once you configure parameters on an event, the SDK appends them to your [callback URL](https://help.adjust.com/en/article/raw-data-exports). You can use this information to analyze your users' in-app behavior with your BI system. Add callback parameters to your event by calling the `addCallbackParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times. - + + + +```swift +let event = ADJEvent(eventToken: "abc123") +event?.addCallbackParameter("key", value: "value") +event?.addCallbackParameter("foo", value: "bar") +Adjust.trackEvent(event) +``` + + + + +```objc +ADJEvent *event = [ADJEvent eventWithEventToken:@"abc123"]; +[event addCallbackParameter:@"key" value:@"value"]; +[event addCallbackParameter:@"foo" value:@"bar"]; +[Adjust trackEvent:event]; +``` + + + + +```js +var adjustEvent = new AdjustEvent(eventToken); +adjustEvent.addCallbackParameter("key", "value"); +adjustEvent.addCallbackParameter("foo", "bar"); +Adjust.trackEvent(adjustEvent); +``` + + + The Adjust SDK measures the event and sends a request to your URL with the callback parameters. For example, if you register the URL `https://www.mydomain.com/callback`, your callback looks like this: @@ -334,8 +461,8 @@ You can read more about using URL callbacks, including a full list of available This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. The following callback parameters are added: -* The `event_token` -* The `revenue_amount` generated by the event +- The `event_token` +- The `revenue_amount` generated by the event The resulting callback URL looks like this: @@ -412,10 +539,12 @@ class ViewControllerSwift: UIViewController { } } -
-
- -
+
+
+ +
@@ -436,6 +565,10 @@ Parameters: ## Add partner parameters +```objc title="Method signature" +- (void)addPartnerParameter:(nonnull NSString *)key value:(nonnull NSString *)value; +``` + You can send extra information to your network partners by adding [partner parameters](https://help.adjust.com/en/article/data-sharing-ad-network#map-parameters). Adjust sends partner parameters to [external partners](https://help.adjust.com/en/article/integrated-partners) you have set up. This information is useful for more granular analysis and retargeting purposes. Adjust's servers forward these parameters once you have set them up and enabled them for a partner. @@ -448,14 +581,45 @@ Partner parameters don't appear in raw data by default. You can add the `{partne Add partner parameters to your event by calling the `addPartnerParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times. - + + + +```swift {2,3} +let event = ADJEvent(eventToken: "abc123") +event?.addPartnerParameter("key", value: "value") +event?.addPartnerParameter("foo", value: "bar") +Adjust.trackEvent(event) +``` + + + + +```objc {2,3} +ADJEvent *event = [ADJEvent eventWithEventToken:@"abc123"]; +[event addPartnerParameter:@"key" value:@"value"]; +[event addPartnerParameter:@"foo" value:@"bar"]; +[Adjust trackEvent:event]; +``` + + + + +```js {2,3} +var adjustEvent = new AdjustEvent(eventToken); +adjustEvent.addPartnerParameter('key', 'value'); +adjustEvent.addPartnerParameter('foo', 'bar'); +Adjust.trackEvent(adjustEvent); +``` + + + ### Example This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. The following partner parameters are added: -* The `product_id` of the associated product -* The `user_id` of the user who triggered the event +- The `product_id` of the associated product +- The `user_id` of the user who triggered the event @@ -525,10 +689,12 @@ class ViewControllerSwift: UIViewController { } } -
-
- -
+
+
+ +
@@ -549,15 +715,47 @@ Parameters: ## Add a callback identifier +```objc title="Method signature" +- (void)setCallbackId:(nonnull NSString *)callbackId; +``` + You can add a custom string identifier to each event you want to measure. Adjust's servers can report on this identifier in event callbacks. This enables you to keep track of which events have been successfully measured. Set up this identifier by calling the `setCallbackId` method with your ID as a **string** argument. - + + + +```swift {2} +let event = ADJEvent(eventToken: "abc123") +event?.setCallbackId("Your-Custom-ID") +Adjust.trackEvent(event) +``` + + + + +```objc {2} +ADJEvent *event = [ADJEvent eventWithEventToken:@"abc123"]; +[event setCallbackId:@"Your-Custom-ID"]; +[Adjust trackEvent:event]; +``` + + + + +```js {2} +var adjustEvent = new AdjustEvent('abc123') +adjustEvent.setCallbackId('Your-Custom-ID') +Adjust.trackEvent(adjustEvent) +``` + + + ### Example -This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. In this example, the `callbackId` is set to `f2e728d8-271b-49ab-80ea-27830a215147`. +This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. In this example, the `callbackId` is set to `f2e728d8-271b-49ab-80ea-27830a215147`. @@ -624,10 +822,12 @@ class ViewControllerSwift: UIViewController { } } -
-
- -
+
+
+ +
diff --git a/src/content/docs/sdk/ios/features/index.mdx b/src/content/docs/sdk/ios/features/index.mdx index 6bc5e35e7..9f9829a0e 100644 --- a/src/content/docs/sdk/ios/features/index.mdx +++ b/src/content/docs/sdk/ios/features/index.mdx @@ -4,6 +4,7 @@ description: Use the Adjust SDK to send in-app information to Adjust's servers. category-title: Features slug: en/sdk/ios/features type: category +sidebar-position: 2 --- Use the Adjust SDK to send in-app information to Adjust's servers. diff --git a/src/content/docs/sdk/ios/features/preinstalled.mdx b/src/content/docs/sdk/ios/features/preinstalled.mdx new file mode 100644 index 000000000..32ca5586d --- /dev/null +++ b/src/content/docs/sdk/ios/features/preinstalled.mdx @@ -0,0 +1,61 @@ +--- +title: Send preinstalled app activity +description: Configure a campaign to send information from preinstalled apps. +slug: en/sdk/ios/features/preinstalled +--- + +You can use the Adjust SDK to record activity from apps that came preinstalled on a user's device. This enables you to send information from users who didn't download your app from a campaign. + +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: + +1. [Create a new campaign link in Campaign Lab](https://help.adjust.com/en/article/links). + + ```text "{token}" + https://app.adjust.com/{token} + ``` + +2. Copy this token and assign it to the [`defaultTracker` property](/en/sdk/ios/configuration#set-default-link-token) of your config object. + + + + +```swift {6} +let yourAppToken = "{YourAppToken}" +let environment = ADJEnvironmentSandbox as? String +let adjustConfig = ADJConfig( + appToken: yourAppToken, + environment: environment) +adjustConfig?.defaultTracker = "{Token}" +Adjust.appDidLaunch(adjustConfig) +``` + + + + +```objective-c {3} +*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}" + environment:ADJEnvironmentSandbox]; +[adjustConfig setDefaultTracker:@"{Token}"]; +[Adjust appDidLaunch:adjustConfig]; +``` + + + + +```javascript {5} +setupWebViewJavascriptBridge(function(bridge) { + var yourAppToken = yourAppToken; + var environment = AdjustConfig.EnvironmentSandbox; + var adjustConfig = new AdjustConfig(yourAppToken, environment); + adjustConfig.setDefaultTracker("{Token}"); +}); +``` + + + + +3. Build and run your app. If you have logging enabled, you should see a message in your log + + ```text + Default tracker: 'abc123'. + ``` diff --git a/src/content/docs/sdk/ios/features/privacy.mdx b/src/content/docs/sdk/ios/features/privacy.mdx new file mode 100644 index 000000000..21099b075 --- /dev/null +++ b/src/content/docs/sdk/ios/features/privacy.mdx @@ -0,0 +1,478 @@ +--- +title: Set up privacy features +description: Configure features that you can use to handle user privacy in your app. +slug: en/sdk/ios/features/privacy +--- + +The Adjust SDK contains features that you can use to handle user privacy in your app. + +## Send right to be forgotten request + +```objc title="Method signature" ++ (void)gdprForgetMe; +``` + +Article 17 of the European Union's General Data Protection Regulation (GDPR) grants users the right to be forgotten. When Adjust's servers receive a Right to be Forgotten (RTBF) request, Adjust erases the user's data. The SDK also stops sending requests from the device for the app in question. + +You can send the user's RTBF request to Adjust by calling the `gdprForgetMe` method. + + + + +```swift +Adjust.gdprForgetMe(); +``` + + + + +```objc +[Adjust gdprForgetMe]; +``` + + + + +```js +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 `AdjustThirdPartySharing` class. + +### Instantiate an AdjustThirdPartySharing object + +```objc title="Method signature" +- (nullable id)initWithIsEnabledNumberBool:(nullable NSNumber *)isEnabledNumberBool; +``` + +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` (**NSNumber**): Whether third party sharing is enabled. Pass `1` to enable third party sharing or `0` to disable third party sharing + + + + +```swift {1} +let adjustThirdPartySharing = ADJThirdPartySharing.initWithIsEnabledNumberBool(1) +Adjust.trackThirdPartySharing(adjustThirdPartySharing) +``` + + + + +```objc {1} +ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabledNumberBool:1]; +[Adjust trackThirdPartySharing:adjustThirdPartySharing]; +``` + + + + +```js {2} +var adjustThirdPartySharing = new AdjustThirdPartySharing(1); +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + + + + + + +If you set the `isEnabled` property to `0`, Adjust stops sharing the user's data with third parties. The Adjust SDK continues to work as expected. + + + +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. + + + + +```swift {2} +let adjustThirdPartySharing = ADJThirdPartySharing.initWithIsEnabledNumberBool(0) +Adjust.trackThirdPartySharing(adjustThirdPartySharing) +``` + + + + +```objc {2} +ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabledNumberBool:0]; +[Adjust trackThirdPartySharing:adjustThirdPartySharing]; +``` + + + + +```js {2} +var adjustThirdPartySharing = new AdjustThirdPartySharing(0); +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + + + + +### Send granular information + +```objc title="Method signature" +- (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: + + + +| Partner name | String value | +| ----------------------- | --------------------------- | +| AppleAds | `apple_ads` | +| Facebook | `facebook` | +| GoogleAds | `adwords` | +| GoogleMarketingPlatform | `google_marketing_platform` | +| Snapchat | `snapchat` | +| Tencent | `tencent` | +| TikTokSan | `tiktok_san` | +| Twitter | `twitter` | +| YahooGemini | `yahoo_gemini` | +| YahooJapanSearch | `yahoo_japan_search` | + +
+ + + + +```swift {2} +let adjustThirdPartySharing = ADJThirdPartySharing.initWithIsEnabledNumberBool(nil) +adjustThirdPartySharing.addGranularOption("PartnerA", key: "foo", value: "bar") +Adjust.trackThirdPartySharing(adjustThirdPartySharing) +``` + + + + +```objc {2} +ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabledNumberBool:nil]; +[adjustThirdPartySharing addGranularOption:@"PartnerA" key:@"foo" value:@"bar"]; +[Adjust trackThirdPartySharing:adjustThirdPartySharing]; +``` + + + + +```js {2} +var adjustThirdPartySharing = new AdjustThirdPartySharing(null); +adjustThirdPartySharing.addGranularOption("PartnerA", "foo", "bar"); +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + + + + +#### Manage Facebook Limited Data Use + + + +The Adjust SDK sends information to Facebook as soon as the app is installed. You need to make sure you call this method **before** initializing the SDK. + + + +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
| + +
+ + + +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`. + + + + + + +```swift {2,3} +let tps = ADJThirdPartySharing.initWithIsEnabledNumberBool(nil) +tps.addGranularOption("facebook", key: "data_processing_options_country", value: "1") +tps.addGranularOption("facebook", key: "data_processing_options_state", value: "1000") +Adjust.trackThirdPartySharing(tps) +``` + + + + +```objc {2,3} +ADJThirdPartySharing *tps = [[ADJThirdPartySharing alloc] initWithIsEnabledNumberBool:@YES]; +[tps addGranularOption:@"facebook" key:@"data_processing_options_country" value:@"1"]; +[tps addGranularOption:@"facebook" key:@"data_processing_options_state" value:@"1000"]; +[Adjust trackThirdPartySharing:tps]; +``` + + + + +```js {2,3} +var tps = new AdjustThirdPartySharing(null); +tps.addGranularOption("facebook", "data_processing_options_country", "1"); +tps.addGranularOption("facebook", "data_processing_options_state", "1000"); +Adjust.trackThirdPartySharing(tps); +``` + + + + + + +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`. + + + +#### Provide consent data to Google (Digital Markets Act compliance) + + + +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.
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. | + +
+ + + + +```swift {2-4} +let adjustThirdPartySharing = ADJThirdPartySharing.initWithIsEnabledNumberBool(nil) +adjustThirdPartySharing.addGranularOption("google_dma", key: "eea", value: "1") +adjustThirdPartySharing.addGranularOption("google_dma", key: "ad_personalization", value: "1") +adjustThirdPartySharing.addGranularOption("google_dma", key: "ad_user_data", value: "1") +Adjust.trackThirdPartySharing(adjustThirdPartySharing) +``` + + + + +```objc {2-4} +ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabledNumberBool:nil]; +[adjustThirdPartySharing addGranularOption:@"google_dma" key:@"eea" value:@"1"]; +[adjustThirdPartySharing addGranularOption:@"google_dma" key:@"ad_personalization" value:@"1"]; +[adjustThirdPartySharing addGranularOption:@"google_dma" key:@"ad_user_data" value:@"1"]; +[Adjust trackThirdPartySharing:adjustThirdPartySharing]; +``` + + + + +### Update partner settings + +```objc title="Method signature" +- (void)addPartnerSharingSetting:(nonnull NSString *)partnerName + key:(nonnull NSString *)key + value:(BOOL)value; +``` + +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 your partner name and your options. + + + + +```swift {2} +let adjustThirdPartySharing = ADJThirdPartySharing.initWithIsEnabledNumberBool(nil) +adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", key: "foo", value: false) +Adjust.trackThirdPartySharing(adjustThirdPartySharing) +``` + + + + +```objc {2} +ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabledNumberBool:nil]; +[adjustThirdPartySharing addPartnerSharingSetting:@"PartnerA" key:@"foo" value:@NO]; +[Adjust trackThirdPartySharing:adjustThirdPartySharing]; +``` + + + + +```js {2} +var adjustThirdPartySharing = new AdjustThirdPartySharing(null); +adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "foo", false); +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + + + + +## Disable third-party sharing + +```objc title="Method signature" ++ (void)disableThirdPartySharing; +``` + +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. + + + + +```swift +Adjust.disableThirdPartySharing() +``` + + + + +```objc +[Adjust disableThirdPartySharing]; +``` + + + + +```js +Adjust.disableThirdPartySharing(); +``` + + + + +## Data residency + +```objc title="Method signature" +@property (nonatomic, copy, readwrite, nullable) NSString *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, assign one of the following URL strategies to the `urlStrategy` property of your config instance. + + + +| Value | Description | +| ---------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| `ADJDataResidencyEU` | Sets the area of data residency to the EU | +| `ADJDataResidencyTR` | Sets the area of data residency to Turkey | +| `ADJDataResidencyUS` | Sets the area of data residency to the USA | +| `ADJUrlStrategyChina` | Points the URL strategy to the `app.adjust.world` domain | +| `ADJUrlStrategyCn` | Points the URL strategy to the `app.adjust.cn` domain | +| `ADJUrlStrategyCnOnly` | Points the URL strategy to the `app.adjust.cn` domain but **doesn't** fall back to another domain if the request fails. | +| `ADJUrlStrategyIndia` | Points the URL strategy to the `app.adjust.net.in` domain | + +
+ + + + +```swift {7} +let yourAppToken = "{YourAppToken}" +let environment = ADJEnvironmentSandbox as? String +let adjustConfig = ADJConfig( + appToken: yourAppToken, + environment: environment) +// ... +adjustConfig?.urlStrategy = ADJDataResidencyEU +``` + + + + +```objective-c {6} +NSString *yourAppToken = @"{YourAppToken}"; +NSString *environment = ADJEnvironmentSandbox; +*adjustConfig = [ADJConfig configWithAppToken:yourAppToken + environment:environment]; +// ... +[adjustConfig setUrlStrategy:ADJDataResidencyEU]; +``` + + + + +```javascript {6} +setupWebViewJavascriptBridge(function (bridge) { + // ... + var yourAppToken = yourAppToken; + var environment = AdjustConfig.EnvironmentSandbox; + var adjustConfig = new AdjustConfig(yourAppToken, environment); + adjustConfig.setUrlStrategy(ADJDataResidencyEU); +}); +``` + + + + +## Consent measurement for specific users + +```objc title="Method signature" ++ (void)trackMeasurementConsent:(BOOL)enabled; +``` + +If you're using [Data Privacy settings](https://help.adjust.com/en/article/manage-data-collection-and-retention) 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. + + + + +```swift +Adjust.trackMeasurementConsent(true) +``` + + + + +```objc +[Adjust trackMeasurementConsent:YES]; +``` + + + + +```js +Adjust.trackMeasurementConsent(true); +``` + + + diff --git a/src/content/docs/sdk/ios/features/session-parameters.mdx b/src/content/docs/sdk/ios/features/session-parameters.mdx index 05ce365c1..e3e887974 100644 --- a/src/content/docs/sdk/ios/features/session-parameters.mdx +++ b/src/content/docs/sdk/ios/features/session-parameters.mdx @@ -4,26 +4,9 @@ description: Send information to your callback URL with each session. slug: en/sdk/ios/features/session-parameters --- -import AddSessionCallbackParameter from "@ios-examples/Adjust/addSessionCallbackParameter.mdx" -import AddSessionCallbackParameterSig from "@ios-signatures/Adjust/addSessionCallbackParameter.mdx" -import RemoveSessionCallbackParameter from "@ios-examples/Adjust/removeSessionCallbackParameter.mdx" -import RemoveSessionCallbackParameterSig from "@ios-signatures/Adjust/removeSessionCallbackParameter.mdx" -import ResetSessionCallbackParameters from "@ios-examples/Adjust/resetSessionCallbackParameters.mdx" -import ResetSessionCallbackParametersSig from "@ios-signatures/Adjust/resetSessionCallbackParameters.mdx" -import AddSessionPartnerParameter from "@ios-examples/Adjust/addSessionPartnerParameter.mdx" -import AddSessionPartnerParameterSig from "@ios-signatures/Adjust/addSessionPartnerParameter.mdx" -import RemoveSessionPartnerParameter from "@ios-examples/Adjust/removeSessionPartnerParameter.mdx" -import RemoveSessionPartnerParameterSig from "@ios-signatures/Adjust/removeSessionPartnerParameter.mdx" -import ResetSessionPartnerParameters from "@ios-examples/Adjust/resetSessionPartnerParameters.mdx" -import ResetSessionPartnerParametersSig from "@ios-signatures/Adjust/resetSessionPartnerParameters.mdx" -import SetDelayStart from "@ios-examples/ADJConfig/setDelayStart.mdx" -import SetDelayStartSig from "@ios-signatures/ADJConfig/setDelayStart.mdx" -import SendFirstPackages from "@ios-examples/Adjust/sendFirstPackages.mdx" -import SendFirstPackagesSig from "@ios-signatures/Adjust/sendFirstPackages.mdx" - If you [register a callback URL](https://help.adjust.com/en/article/recommended-placeholders-callbacks) in the Adjust dashboard, Adjust sends a GET request to your callback URL when the SDK measures a session. -You can configure callback parameters to your servers. Once you configure parameters on an event, the SDK appends them to your callback URL. You can use this information to analyze your users' in-app behavior with your BI system. +## Session callback parameters @@ -31,17 +14,102 @@ The Adjust SDK merges session callback parameters with event callback parameters +You can configure callback parameters to your servers. Once you configure parameters on an event, the SDK appends them to your callback URL. You can use this information to analyze your users' in-app behavior with your BI system. + +### Add session callback parameters + +```objc title="Method signature" ++ (void)addSessionCallbackParameter:(nonnull NSString *)key value:(nonnull NSString *)value; +``` + Add callback parameters to your event by calling the `addSessionCallbackParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times. + + + +```swift +Adjust.addSessionCallbackParameter("foo", value: "bar") +``` + + + + +```objc +[Adjust addSessionCallbackParameter:@"foo" value:@"bar"]; +``` + + + + +```js +Adjust.addSessionCallbackParameter('foo', 'bar'); +``` + + + + +### Remove session callback parameters + +```objc title="Method signature" ++ (void)removeSessionCallbackParameter:(nonnull NSString *)key; +``` + +You can remove specific session callback parameters if they're no longer required. To do this, pass the parameter `key` to the `removeSessionCallbackParameter` method. - + + -You can remove specific session callback parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionCallbackParameter` method. +```swift +Adjust.removeSessionCallbackParameter("foo") +``` - + + + +```objc +[Adjust removeSessionCallbackParameter:@"foo"]; +``` + + + + +```js +Adjust.removeSessionCallbackParameter('foo'); +``` + + + + +### Reset session callback parameters + +```objc title="Method signature" ++ (void)resetSessionCallbackParameters; +``` You can remove all session parameters if they're no longer required. To do this, call the `resetSessionCallbackParameters` method. - + + + +```swift +Adjust.resetSessionCallbackParameters() +``` + + + + +```objc +[Adjust resetSessionCallbackParameters]; +``` + + + + +```js +Adjust.resetSessionCallbackParameters(); +``` + + + ## Session partner parameters @@ -55,17 +123,102 @@ Partner parameters don't appear in raw data by default. You can add the `{partne -Add partner parameters to your event by calling the `addSessionPartnerParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times. +### Add session partner parameters + +```objc title="Method signature" ++ (void)addSessionPartnerParameter:(nonnull NSString *)key value:(nonnull NSString *)value; +``` + +Send partner parameters with your session by calling the `addSessionPartnerParameter` method with **string** key-value arguments. You can add multiple parameters by calling this method multiple times. + + + - +```swift +Adjust.addSessionPartnerParameter("foo", value: "bar") +``` + + + + +```objc +[Adjust addSessionPartnerParameter:@"foo" value:@"bar"]; +``` + + + + +```js +Adjust.addSessionPartnerParameter('foo', 'bar'); +``` + + + + + +### Remove session partner parameters + +```objc title="Method signature" ++ (void)removeSessionPartnerParameter:(nonnull NSString *)key; +``` You can remove specific session partner parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionPartnerParameter` method. - + + + +```swift +Adjust.removeSessionPartnerParameter("foo") +``` + + + + +```objc +[Adjust removeSessionPartnerParameter:@"foo"]; +``` + + + + +```js +Adjust.removeSessionPartnerParameter('foo'); +``` + + + + +### Reset session partner parameters + +```objc title="Method signature" ++ (void)resetSessionPartnerParameters; +``` You can remove all session partner parameters if they're no longer required. To do this, call the `resetSessionPartnerParameters` method. - + + + +```swift +Adjust.resetSessionPartnerParameters() +``` + + + + +```objc +[Adjust resetSessionPartnerParameters]; +``` + + + + +```js +Adjust.resetSessionPartnerParameters(); +``` + + + ## Delay start @@ -75,10 +228,70 @@ You can delay the startup of the SDK by up to **10 seconds**. -The Adjust SDK starts as soon as your app opens. If you want to send data that's not available at launch in session parameters, you can delay the start of the SDK. To do this, pass the delay time in seconds to the `setDelayStart` method on your config object. - - +The Adjust SDK starts as soon as your app opens. If you want to send data that's not available at launch in session parameters, you can delay the start of the SDK. To do this, assign a delay time in seconds to the [`delayStart` property](/en/sdk/ios/configuration#delay-the-start-of-the-sdk) on your config object. + + + + +```swift {6} +let yourAppToken = "{YourAppToken}" +let environment = ADJEnvironmentSandbox as? String +let adjustConfig = ADJConfig( + appToken: yourAppToken, + environment: environment) +adjustConfig?.delayStart = 5.5 +// ... +Adjust.appDidLaunch(adjustConfig) +``` + + + + +```objc {3} +*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}" + environment:ADJEnvironmentSandbox]; +[adjustConfig setDelayStart:5.5]; +/// ... +[Adjust appDidLaunch:adjustConfig]; +``` + + + + +```js {5} +setupWebViewJavascriptBridge(function(bridge) { + var yourAppToken = yourAppToken; + var environment = AdjustConfig.EnvironmentSandbox; + var adjustConfig = new AdjustConfig(yourAppToken, environment); + adjustConfig.setDelayStart(5.5); +}); +``` + + + After this time has elapsed, the SDK sends the information to Adjust's servers. You can send the information before the timeout by calling the `sendFirstPackages` method. - + + + +```swift +Adjust.sendFirstPackages() +``` + + + + +```objc +[Adjust sendFirstPackages]; +``` + + + + +```js +Adjust.sendFirstPackages(); +``` + + + diff --git a/src/content/docs/sdk/ios/configuration/skad.mdx b/src/content/docs/sdk/ios/features/skad.mdx similarity index 89% rename from src/content/docs/sdk/ios/configuration/skad.mdx rename to src/content/docs/sdk/ios/features/skad.mdx index 0bf3b821c..3476220e4 100644 --- a/src/content/docs/sdk/ios/configuration/skad.mdx +++ b/src/content/docs/sdk/ios/features/skad.mdx @@ -1,30 +1,33 @@ --- title: Set up SKAdNetwork and conversion values description: Configure SKAdNetwork features for your iOS apps. -slug: en/sdk/ios/configuration/skad +slug: en/sdk/ios/features/skad --- -import DeactivateSKAdNetworkHandling from "@ios-examples/ADJConfig/deactivateSKAdNetworkHandling.mdx"; -import DeactivateSKAdNetworkHandlingSig from "@ios-signatures/ADJConfig/deactivateSKAdNetworkHandling.mdx"; -import UpdateConversionValue from "@ios-examples/Adjust/updateConversionValue.mdx"; -import UpdateConversionValueSig from "@ios-signatures/Adjust/updateConversionValue.mdx"; - This feature is only available on devices running iOS 14 and above. -SKAdNetwork (StoreKit Ad Network) is Apple's attribution framework for app install and reinstall attribution. The SKAdNetwork workflow goes like this: +StoreKit Ad Network (SKAdNetwork) is Apple's attribution framework for app install and reinstall attribution. The SKAdNetwork workflow goes like this: 1. Apple gathers attribution information and notifies the relevant ad network. 2. The network sends a postback with this information to Adjust. -3. Adjust displays SKAdNetwork data in [Datascape](https://help.adjust.com/en/article/datascape) and [Data Canvas](https://help.adjust.com/en/classic/article/data-canvas-classic). +3. Adjust displays SKAdNetwork data in [Datascape](https://help.adjust.com/en/suite/article/datascape) and [Data Canvas](https://help.adjust.com/en/classic/article/data-canvas-classic). ## Disable SKAdNetwork communication +```objc title="Method signature" +- (void)deactivateSKAdNetworkHandling; +``` + + + The Adjust SDK communicates with SKAdNetwork by default on v4.23.0 and above. The SDK registers for SKAdNetwork attribution upon initialization. + + Your config object contains a boolean `isSKAdNetworkHandlingActive` property that controls this behavior. You can disable SKAdNetwork communication by calling the `deactivateSKAdNetworkHandling` method with no argument. @@ -33,15 +36,61 @@ You must call the `deactivateSKAdNetworkHandling` method _before_ initializing t - + + + +```swift {7} +let yourAppToken = "{YourAppToken}" +let environment = ADJEnvironmentSandbox as? String +let adjustConfig = ADJConfig( + appToken: yourAppToken, + environment: environment) +//... +adjustConfig.deactivateSKAdNetworkHandling() +//... +Adjust.appDidLaunch(adjustConfig) +``` + + + + +```objective-c {3} +*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}" + environment:ADJEnvironmentSandbox]; +[adjustConfig.deactivateSKAdNetworkHandling]; +/// ... +[Adjust appDidLaunch:adjustConfig]; +``` + + + ## Update conversion values +```objc title="Method signature" ++ (void)updateConversionValue:(NSInteger)conversionValue; +``` + Conversion values are a mechanism used to track user behavior in SKAdNetwork. You can map 64 conditions to values from 0 through 63 and send this integer value to SKAdNetwork on user install. This gives you insight into how your users interact with your app in the first few days. If you manage your conversion values with Adjust, the servers update this value in the SDK. You can also update this value by using the `updateConversionValue` method. This method wraps [Apple's `updateConversionValue` method](https://developer.apple.com/documentation/storekit/skadnetwork/3566697-updateconversionvalue). It accepts an integer argument representing your updated conversion value. - + + + +```swift +Adjust.updateConversionValue(value) +``` + + + + +```objc +[Adjust updateConversionValue:value]; +``` + + + ### Example diff --git a/src/content/docs/sdk/ios/features/subscriptions.mdx b/src/content/docs/sdk/ios/features/subscriptions.mdx index 157abb3d1..833d30e5f 100644 --- a/src/content/docs/sdk/ios/features/subscriptions.mdx +++ b/src/content/docs/sdk/ios/features/subscriptions.mdx @@ -4,19 +4,6 @@ description: Use these methods send subscription information to Adjust. slug: en/sdk/ios/features/subscriptions --- -import InitWithPrice from "@ios-examples/ADJSubscription/constructor.mdx" -import InitWithPriceSig from "@ios-signatures/ADJSubscription/constructor.mdx" -import SetTransactionDate from "@ios-examples/ADJSubscription/setTransactionDate.mdx" -import SetTransactionDateSig from "@ios-signatures/ADJSubscription/setTransactionDate.mdx" -import SetSalesRegion from "@ios-examples/ADJSubscription/setSalesRegion.mdx" -import SetSalesRegionSig from "@ios-signatures/ADJSubscription/setSalesRegion.mdx" -import AddCallbackParameter from "@ios-examples/ADJSubscription/addCallbackParameter.mdx" -import AddCallbackParameterSig from "@ios-signatures/ADJSubscription/addCallbackParameter.mdx" -import AddPartnerParameter from "@ios-examples/ADJSubscription/addPartnerParameter.mdx" -import AddPartnerParameterSig from "@ios-signatures/ADJSubscription/addPartnerParameter.mdx" -import TrackSubscription from "@ios-examples/Adjust/trackSubscription.mdx" -import TrackSubscriptionSig from "@ios-signatures/Adjust/trackSubscription.mdx" - The following steps only set up subscription tracking within the Adjust SDK. To enable the feature, Adjust need to set up app-specific information. Contact support@adjust.com or talk to your Technical Account manager to set this up. @@ -25,38 +12,255 @@ The following steps only set up subscription tracking within the Adjust SDK. To You can record App Store subscriptions and verify their validity with the Adjust SDK. After the user purchases a subscription, create an `ADJSubscription` instance containing the details. -## 1. Set up your subscription object +## 1. Instantiate a subscription object + +```objc title="Method signature" +- (nullable id)initWithPrice:(nonnull NSDecimalNumber *)price + currency:(nonnull NSString *)currency + transactionId:(nonnull NSString *)transactionId + andReceipt:(nonnull NSData *)receipt; +``` + +To get started, you need to create a subscription object containing details of the subscription purchase. To do this, initialize an `ADJSubscription` object using the `initWithPrice` method. Pass the following arguments: + + + +| Parameter | Data type | Description | +| --------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `price` | Number | The price of the subscription | +| `currency` | String | The currency of the subscription. Formatted as the [`currencyCode`](https://developer.apple.com/documentation/foundation/nslocale/1642836-currencycode?language=objc) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=objc) object | +| `transactionId` | String | Your ID for the transaction | +| `receipt` | String | The receipt information | + +
-To get started, you need to create a subscription object containing details of the subscription purchase. To do this, initialize an `ADJSubscription` object using the `initWithPrice` method. + + - +```swift +let subscription = ADJSubscription( + price: price, + currency: currency, + transactionId: transactionId, + andReceipt: receipt) +``` + + + + +```objc +ADJSubscription *subscription = [[ADJSubscription alloc] initWithPrice:price + currency:currency + transactionId:transactionId + andReceipt:receipt]; +``` + + + ### Record the purchase date +```objc title="Method signature" +- (void)setTransactionDate:(nonnull NSDate *)transactionDate; +``` + You can record the date on which the user purchased a subscription. The SDK returns this data for you to report on. Call the `setTransactionDate` method with a timestamp to record this information. - + + + +```swift {7} +let subscription = ADJSubscription( + price: price, + currency: currency, + transactionId: transactionId, + andReceipt: receipt) +// ... +subscription.setTransactionDate(transactionDate) +``` + + + + +```objc {6} +ADJSubscription *subscription = [[ADJSubscription alloc] initWithPrice:price + currency:currency + transactionId:transactionId + andReceipt:receipt]; +/// ... +[subscription setTransactionDate:transactionDate]; +``` + + + ### Record the purchase region +```objc title="Method signature" +- (void)setSalesRegion:(nonnull NSString *)salesRegion; +``` + You can record the region in which the user purchased a subscription. To do this, call the `setSalesRegion` method on your subscription object and pass the country code as a **string**. This needs to be formatted as the [`countryCode`](https://developer.apple.com/documentation/foundation/nslocale/1643060-countrycode?language=swift) of the [`priceLocale`](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=swift) object. - + + + +```swift {7} +let subscription = ADJSubscription( + price: price, + currency: currency, + transactionId: transactionId, + andReceipt: receipt) +// ... +subscription.setSalesRegion(salesRegion) +``` + + + + +```objc {6} +ADJSubscription *subscription = [[ADJSubscription alloc] initWithPrice:price + currency:currency + transactionId:transactionId + andReceipt:receipt]; +/// ... +[subscription setSalesRegion:salesRegion]; +``` + + + ### Add callback parameters +```objc title="Method signature" +- (void)addCallbackParameter:(nonnull NSString *)key value:(nonnull NSString *)value; +``` + You can add callback parameters to your subscription object. The SDK appends these parameters to your callback URL. To add callback parameters, call the `addCallbackParameter` method on your subscription object. You can add multiple callback parameters by calling this method multiple times. - + + + +```swift {7,8} +let subscription = ADJSubscription( + price: price, + currency: currency, + transactionId: transactionId, + andReceipt: receipt) +// ... +subscription.addCallbackParameter("key1", value: "value1") +subscription.addCallbackParameter("key2", value: "value2") +``` + + + + +```objc {6,7} +ADJSubscription *subscription = [[ADJSubscription alloc] initWithPrice:price + currency:currency + transactionId:transactionId + andReceipt:receipt]; +/// ... +[subscription addCallbackParameter:@"key1" value:@"value1"]; +[subscription addCallbackParameter:@"key2" value:@"value2"]; +``` + + + ### Add partner parameters +```objc title="Method signature" +- (void)addPartnerParameter:(nonnull NSString *)key value:(nonnull NSString *)value; +``` + You can add partner parameters to your subscription object. The SDK sends these to Adjust's servers when the user purchases a subscription. Adjust's servers forward the information on to your network partner. To add partner parameters, call the `addPartnerParameter` method on your subscription object. You can add multiple partner parameters by calling this method multiple times. - + + + +```swift {7,8} +let subscription = ADJSubscription( + price: price, + currency: currency, + transactionId: transactionId, + andReceipt: receipt) +// ... +subscription.addParameterParameter("key1", value: "value1") +subscription.addParameterParameter("key2", value: "value2") +``` + + + + +```objc {6,7} +ADJSubscription *subscription = [[ADJSubscription alloc] initWithPrice:price + currency:currency + transactionId:transactionId + andReceipt:receipt]; +/// ... +[subscription addParameterParameter:@"key1" value:@"value1"]; +[subscription addParameterParameter:@"key2" value:@"value2"]; +``` + + + ## 2. Send subscription information +```objc title="Method signature" ++ (void)trackSubscription:(nonnull ADJSubscription *)subscription; +``` + Once you have set up your subscription object, you can send it to Adjust using the Adjust SDK. Pass your completed object to the `trackSubscription` method to record the user's subscription purchase. - + + + +```swift {20} +let subscription = ADJSubscription( + price: price, + currency: currency, + transactionId: transactionId, + andReceipt: receipt) + +subscription.setTransactionDate(transactionDate) +subscription.setSalesRegion(salesRegion) + +// Add callback parameters + +subscription.addCallbackParameter("key1", value: "value1") +subscription.addCallbackParameter("key2", value: "value2") + +// Add partner parameters + +subscription.addPartnerParameter("key1", value: "value1") +subscription.addCallbackParameter("key2", value: "value2") + +Adjust.trackSubscription(subscription) +``` + + + + +```objc {16} +ADJSubscription *subscription = [[ADJSubscription alloc] initWithPrice:price + currency:currency + transactionId:transactionId + andReceipt:receipt]; +[subscription setTransactionDate:transactionDate]; +[subscription setSalesRegion:salesRegion]; + +/// Add callback parameters +[subscription addCallbackParameter:@"key1" value:@"value1"]; +[subscription addCallbackParameter:@"key2" value:@"value2"]; + +/// Add partner parameters +[subscription addPartnerParameter:@"key1" value:@"value1"]; +[subscription addPartnerParameter:@"key2" value:@"value2"]; + +[Adjust trackSubscription:subscription]; +``` + + + diff --git a/src/content/docs/sdk/ios/index.mdx b/src/content/docs/sdk/ios/index.mdx index 6f34eb043..1793ff78e 100644 --- a/src/content/docs/sdk/ios/index.mdx +++ b/src/content/docs/sdk/ios/index.mdx @@ -258,9 +258,8 @@ The Adjust SDK depends on frameworks to access certain device information. To en To initialize the Adjust SDK, you need to create a config object. This object contains configuration options that control how the Adjust SDK behaves. Pass the following arguments for a minimal setup: -`appToken`: Your [app's token](https://help.adjust.com/en/article/app-settings#view-your-app-token). - -`environment`: The environment you want to run the SDK in. Set this to `ADJEnvironmentSandbox`. +- `appToken`: Your [app's token](https://help.adjust.com/en/article/app-settings#view-your-app-token). +- `environment`: The environment you want to run the SDK in. Set this to `ADJEnvironmentSandbox`. To initialize the Adjust SDK with this config object: @@ -504,7 +503,7 @@ Once you've finished your testing, you can build your app for production. To do Update the following values: - `environment`: Set this to `ADJEnvironmentProduction`. -- `logLevel`: Choose a [logging level](/en/sdk/ios/configuration/log-level), or disable logging completely by passing an `allowSuppressLogLevel` argument in your config object. +- `logLevel`: Choose a [logging level](/en/sdk/ios/configuration#set-your-logging-level), or disable logging completely by passing an `allowSuppressLogLevel` argument in your config object. diff --git a/src/content/docs/sdk/ios/integrations/index.mdx b/src/content/docs/sdk/ios/integrations/index.mdx index 6e70e75fc..1ea872658 100644 --- a/src/content/docs/sdk/ios/integrations/index.mdx +++ b/src/content/docs/sdk/ios/integrations/index.mdx @@ -4,6 +4,7 @@ description: Use SDK to SDK integrations to pass information from third-party SD category-title: Integrations slug: en/sdk/ios/integrations type: category +sidebar-position: 3 --- Use SDK to SDK integrations to pass information from third-party SDKs to Adjust. diff --git a/src/content/docs/sdk/ios/plugins/facebook-pixel.mdx b/src/content/docs/sdk/ios/plugins/facebook-pixel.mdx index 0ed0dd193..c825d0544 100644 --- a/src/content/docs/sdk/ios/plugins/facebook-pixel.mdx +++ b/src/content/docs/sdk/ios/plugins/facebook-pixel.mdx @@ -23,7 +23,7 @@ As described in [Facebook's iOS SDK guide](https://developers.facebook.com/docs/ 1. In Xcode, right click on your project's `Info.plist` file and select **Open As --> Source Code**. 2. Insert the following XML snippet into the body of your file just before the final `` element: -```xml +```xml title="Info.plist" FacebookAppID {your-app-id} diff --git a/src/content/docs/sdk/ios/plugins/index.mdx b/src/content/docs/sdk/ios/plugins/index.mdx index d8f562894..3ec88d186 100644 --- a/src/content/docs/sdk/ios/plugins/index.mdx +++ b/src/content/docs/sdk/ios/plugins/index.mdx @@ -4,6 +4,7 @@ description: Use third-party plugins to pass information from third-party SDKs t category-title: Plugins slug: en/sdk/ios/plugins type: category +sidebar-position: 4 --- Use plugins to pass information to third-party plugins. diff --git a/src/content/docs/sdk/ios/reference/adjadrevenue.mdx b/src/content/docs/sdk/ios/reference/adjadrevenue.mdx deleted file mode 100644 index ebd404a33..000000000 --- a/src/content/docs/sdk/ios/reference/adjadrevenue.mdx +++ /dev/null @@ -1,269 +0,0 @@ ---- -title: ADJAdRevenue class -description: Use this class to store ad revenue information. -category-title: ADJAdRevenue class -slug: en/sdk/ios/reference/adjadrevenue ---- - -Use this class to store ad revenue information. - - - -## Constructor - -Instantiates an ad revenue object initialized with an external ad revenue source. - - - -import ConstructorSig from "@ios-signatures/ADJAdRevenue/constructor.mdx"; - - - - - - - -import Constructor from "@ios-examples/ADJAdRevenue/constructor.mdx"; - - - - - - - -`source` (NSString): The source of the ad revenue. - - - -| Parameter | Source | -| ------------------------------------ | ----------------- | -| `ADJAdRevenueSourceAppLovinMAX` | AppLovin MAX | -| `ADJAdRevenueSourceMopub` | Mopub | -| `ADJAdRevenueSourceAdMob` | AdMob | -| `ADJAdRevenueSourceIronSource` | ironSource | -| `ADJAdRevenueSourceAdMost` | AdMost | -| `ADJAdRevenueSourceUnity` | Unity | -| `ADJAdRevenueSourceHeliumChartboost` | Helium Chartboost | -| `ADJAdRevenueSourcePublisher` | Generic source | - -
- - - - - - - -## setRevenue - -Set the revenue amount associated with the ad revenue object. - - - -import SetRevenueSig from "@ios-signatures/ADJAdRevenue/setRevenue.mdx" - - - - - - - -import SetRevenue from "@ios-examples/ADJAdRevenue/setRevenue.mdx" - - - - - - - -`amount` (double): The amount of currency units associated with the ad. - -`currency` (NSString): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit. - - - - - - - -## setAdImpressionsCount - -Sets the number of impressions received for an ad. - - - -import SetAdImpressionsCountSig from "@ios-signatures/ADJAdRevenue/setAdImpressionsCount.mdx" - - - - - - - -import SetAdImpressionsCount from "@ios-examples/ADJAdRevenue/setAdImpressionsCount.mdx" - - - - - - - -`adImpressionsCaount`: The number of impressions associated with the ad. - - - - - - - -## setAdRevenueNetwork - -Sets the network associated with the ad revenue. - - - -import SetAdRevenueNetworkSig from "@ios-signatures/ADJAdRevenue/setAdRevenueNetwork.mdx" - - - - - - - -import SetAdRevenueNetwork from "@ios-examples/ADJAdRevenue/setAdRevenueNetwork.mdx" - - - - - - - -`adRevenueNetwork` (NSString): The network associated with the ad revenue. - - - - - - - -## setAdRevenueUnit - -Sets the ad unit ID associated with the ad revenue. - - - -import SetAdRevenueUnitSig from "@ios-signatures/ADJAdRevenue/setAdRevenueUnit.mdx" - - - - - - - -import SetAdRevenueUnit from "@ios-examples/ADJAdRevenue/setAdRevenueUnit.mdx" - - - - - - - -`unit` (NSString): The ad unit ID associated with the ad revenue. - - - - - - - -## setAdRevenuePlacement - -Sets the placement of the ad associated with the ad revenue. - - - -import SetAdRevenuePlacementSig from "@ios-signatures/ADJAdRevenue/setAdRevenuePlacement.mdx" - - - - - - - -import SetAdRevenuePlacement from "@ios-examples/ADJAdRevenue/setAdRevenuePlacement.mdx" - - - - - - - -`adRevenuePlacement` (NSString): The placement of the ad associated with the revenue. - - - - - - - -## addCallbackParameter - -Adds key-value information to send to your callback URL. - - - -import AddCallbackParameterSig from "@ios-signatures/ADJAdRevenue/addCallbackParameter.mdx" - - - - - - - -import AddCallbackParameter from "@ios-examples/ADJAdRevenue/addCallbackParameter.mdx" - - - - - - - -`key` (NSString): The data key. - -`value` (NSString): The data value. - - - - - - - -## addPartnerParameter - -Adds key-value information to share with partners. - - - -import AddPartnerParameterSig from "@ios-signatures/ADJAdRevenue/addPartnerParameter.mdx" - - - - - - - -import AddPartnerParameter from "@ios-examples/ADJAdRevenue/addPartnerParameter.mdx" - - - - - - - -`key` (NSString): The data key. - -`value` (NSString): The data value. - - - - diff --git a/src/content/docs/sdk/ios/reference/adjattribution.mdx b/src/content/docs/sdk/ios/reference/adjattribution.mdx deleted file mode 100644 index 1df41f7a5..000000000 --- a/src/content/docs/sdk/ios/reference/adjattribution.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ADJAttribution class -description: Use this class to see attribution information. -category-title: ADJAttribution class -slug: en/sdk/ios/reference/adjattribution ---- - -import Attribution from "@ios-signatures/Adjust/attribution.mdx"; -import SetNeedsCost from "@ios-signatures/ADJConfig/setNeedsCost.mdx"; - -The `ADJAttribution` class contains details about the current attribution status of the device. - -## Properties - -The following properties can be accessed by calling the `attribution` method. Any values that aren't populated for the user are returned as a null value. - - - -The following values can only be accessed if the `needsCost` property on your `ADJConfig` instance is `true`: - -- `costType` -- `costAmount` -- `costCurrency` - - - - - -| Values | Data type | Description | -| -------------- | --------- | -------------------------------------------------------------------------------------------------------------- | -| `trackerToken` | String | The token of the tracker to which the device is currently attributed | -| `trackerName` | String | The name of the tracker to which the device is currently attributed | -| `network` | String | The name of the network to which the device is currently attributed | -| `campaign` | String | The name of the campaign to which the device is currently attributed | -| `adgroup` | String | The name of the adgroup to which the device is currently attributed | -| `creative` | String | The name of the creative to which the device is currently attributed | -| `clickLabel` | String | The [click label](https://help.adjust.com/en/article/user-rewards) that the install is tagged with | -| `adid` | String | The unique Adjust ID assigned to the device | -| `costType` | String | The campaign pricing model (for example cpi) | -| `costAmount` | Number | The cost of the install. | -| `costCurrency` | String | The [3 character ISO 4217 code](https://www.iban.com/currency-codes) of the currency associated with the cost. | - -
diff --git a/src/content/docs/sdk/ios/reference/adjconfig/index.mdx b/src/content/docs/sdk/ios/reference/adjconfig/index.mdx deleted file mode 100644 index 1550a4111..000000000 --- a/src/content/docs/sdk/ios/reference/adjconfig/index.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: ADJConfig class -description: Use the methods in this class to set up the Adjust SDK. -category-title: ADJConfig class -slug: en/sdk/ios/reference/adjconfig -type: category ---- - -Use the methods in this class to set up the Adjust SDK. - - - - -The methods in this class must be called **before** you initialize the SDK. - - - - - -Instantiate the configuration object with your Adjust app token. - - - -import ConstructorSig from "@ios-signatures/ADJConfig/constructor.mdx" - - - - - - - -import Constructor from "@ios-examples/ADJConfig/constructor.mdx" - - - - - - - -`appToken` (NSString): Your Adjust app token. - -`environment` (NSString): The environment your app is running in. Available options:: - `ADJEnvironmentSandbox`: - `ADJEnvironmentProduction` - -`allowSuppressLogLevel` (BOOL): Whether to allow all logging to be suppressed. - - - - - -`config` (ADJConfig): A config object initialized with the provided params. - - - - diff --git a/src/content/docs/sdk/ios/reference/adjconfig/setup.mdx b/src/content/docs/sdk/ios/reference/adjconfig/setup.mdx deleted file mode 100644 index 4b593e083..000000000 --- a/src/content/docs/sdk/ios/reference/adjconfig/setup.mdx +++ /dev/null @@ -1,438 +0,0 @@ ---- -title: Setup methods -description: Configure these properties to set up the Adjust SDK. -slug: en/sdk/ios/reference/adjconfig/setup -sidebar-position: 1 ---- - -Configure these properties to set up the Adjust SDK. - - - -## setLogLevel - -Set the verbosity of logs you want to receive from the Adjust SDK. - - - -import SetLogLevelSig from "@ios-signatures/ADJConfig/setLogLevel.mdx"; - - - - - - - -import SetLogLevel from "@ios-examples/ADJConfig/setLogLevel.mdx"; - - - - - - - -`logLevel` (ADJLogLevel): The level of logging output by the SDK. - - - -| Log level | Description | -| --------------------- | --------------------------------------------- | -| `ADJLogLevelVerbose` | Enable all logging | -| `AdjLogLevelDebug` | Enable debug logging | -| `ADJLogLevelInfo` | Only show info level logging (default option) | -| `ADJLogLevelWarn` | Disable informational warnings | -| `ADJLogLevelError` | Disable warning level logging and below | -| `ADJLogLevelAssert` | Disable error level logging and below | -| `ADJLogLevelSuppress` | Suppress all logging | - -
- - - - - - - -## setDefaultTracker - -Sets a default token to record installs against. - - - -import SetDefaultTrackerSig from "@ios-signatures/ADJConfig/setDefaultTracker.mdx"; - - - - - - - -import SetDefaultTracker from "@ios-examples/ADJConfig/setDefaultTracker.mdx"; - - - - - - - -`defaultTracker` (NSString): The token to which all preinstalled sessions are attributed. - - - - - - - -## setDelegate - -Sets a delegate function that the SDK calls when the user's attribution changes. - - - -import SetDelegateSig from "@ios-signatures/ADJConfig/setDelegate.mdx"; - - - - - - - -import SetDelegate from "@ios-examples/ADJConfig/setDelegate.mdx"; - - - - - - - -`delegate` (NSObject): The delegate function that's called when attribution changes. - - - - - - - -## setDelayStart - -Sets a delay before the SDK starts to allow data to load before session information is sent to Adjust's servers. - - - -You can delay the start of the SDK by up to **10 seconds**. - - - - - -import SetDelayStartSig from "@ios-signatures/ADJConfig/setDelayStart.mdx"; - - - - - - - -import SetDelayStart from "@ios-examples/ADJConfig/setDelayStart.mdx"; - - - - - - - -`delayStart` (double): The time (in seconds) to delay the start of the SDK by. - - - - - - - -## setExternalDeviceId - -Sets an external device identifier for reporting purposes. - - - -import SetExternalDeviceIdSig from "@ios-signatures/ADJConfig/setExternalDeviceId.mdx"; - - - - - - - -import SetExternalDeviceId from "@ios-examples/ADJConfig/setExternalDeviceId.mdx"; - - - - - - - -`externalDeviceId` (NSString): The external device ID associated with the device. - - - - - - - -## setEventBufferingEnabled - -Sets event buffering. If enabled, the SDK stores events on the device and sends all requests once per minute. - - - -import SetEventBufferingEnabledSig from "@ios-signatures/ADJConfig/setEventBufferingEnabled.mdx"; - - - - - - - -import SetEventBufferingEnabled from "@ios-examples/ADJConfig/setEventBufferingEnabled.mdx"; - - - - - - - -`eventBufferingEnabled` (BOOL): Whether event buffering is enabled. - - - - - - - -## setSendInBackground - -Sets whether the SDK should send data while the app is running in the background. - - - -import SetSendInBackgroundSig from "@ios-signatures/ADJConfig/setSendInBackground.mdx"; - - - - - - - -import SetSendInBackground from "@ios-examples/ADJConfig/sendInBackground.mdx"; - - - - - - - -`sendInBackground` (BOOL): Whether the SDK should send information to Adjust when the app is running in the background. - - - - - - - -## setNeedsCost - -Sets whether the SDK should gather cost data. This is accessible in the user's attribution information. - - - -import SetNeedsCostSig from "@ios-signatures/ADJConfig/setNeedsCost.mdx"; - - - - - - - -import SetNeedsCost from "@ios-examples/ADJConfig/setNeedsCost.mdx"; - - - - - - - -`needsCost` (BOOL): Whether the SDK should gather cost data - - - - - -Optional slot for method return values - - - - - - - -## setLinkMeEnabled - -Toggle support for Adjust's [LinkMe solution](https://help.adjust.com/en/article/linkme) for deep linking. - - - -import SetLinkMeEnabledSig from "@ios-signatures/ADJConfig/setLinkMeEnabled.mdx"; - - - - - - - -import SetLinkMeEnabled from "@ios-examples/ADJConfig/setLinkMeEnabled.mdx"; - - - - - - - -`linkMeEnabled` (BOOL): Whether to enable LinkMe. - - - - - - - -## deactivateSKAdNetworkHandling - -Turns off communication with SKAdNetwork. - - - -SKAdNetwork communication is enabled by default. - - - - - -import DeactivateSKAdNetworkHandlingSig from "@ios-signatures/ADJConfig/deactivateSKAdNetworkHandling.mdx"; - - - - - - - -import DeactivateSKAdNetworkHandling from "@ios-examples/ADJConfig/deactivateSKAdNetworkHandling.mdx"; - - - - - - - - - -## setAllowIdfaReading - -Sets whether the Adjust SDK can read the device IDFA (ID for Advertisers). - - - -import SetAllowIdfaReadingSig from "@ios-signatures/ADJConfig/setAllowIdfaReading.mdx"; - - - - - - - -import SetAllowIdfaReading from "@ios-examples/ADJConfig/setAllowIdfaReading.mdx"; - - - - - - - -`allowIdfaReading` (BOOL): Whether to allow the SDK to read the device's IDFA. - - - - - - - -## setAllowAdServicesInfoReading - -Sets whether the Adjust SDK can read AdServices framework data. Required for attribution. - - - -import SetAllowAdServicesInfoReadingSig from "@ios-signatures/ADJConfig/setAllowAdServicesInfoReading.mdx"; - - - - - - - -import SetAllowAdServicesInfoReading from "@ios-examples/ADJConfig/setAllowAdServicesInfoReading.mdx"; - - - - - - - -`allowAdServicesInfoReading` (BOOL): Whether to allow the SDK to read AdServices information. - - - - - - - -## setUrlStrategy - -Sets the country or region of data residency. If called with a `URL_STRATEGY` parameter, sets the country/region where data will be sent preferentially. - - - -import SetUrlStrategySig from "@ios-signatures/ADJConfig/setUrlStrategy.mdx"; - - - - - - - -import SetUrlStrategy from "@ios-examples/ADJConfig/setUrlStrategy.mdx"; - - - - - - - -`urlStrategy` (String): The data residency target - - - -| Value | Description | -| ---------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `ADJDataResidencyEU` | Sets the area of data residency to the EU | -| `ADJDataResidencyTR` | Sets the area of data residency to Turkey | -| `ADJDataResidencyUS` | Sets the area of data residency to the USA | -| `ADJUrlStrategyChina` | Points the URL strategy to the `app.adjust.world` domain | -| `ADJUrlStrategyCn` | Points the URL strategy to the `app.adjust.cn` domain | -| `ADJUrlStrategyCnOnly` | Points the URL strategy to the `app.adjust.cn` domain but **doesn't** fall back to another domain if the request fails. | -| `ADJUrlStrategyIndia` | Points the URL strategy to the `app.adjust.net.in` domain | - -
- - - - diff --git a/src/content/docs/sdk/ios/reference/adjevent.mdx b/src/content/docs/sdk/ios/reference/adjevent.mdx deleted file mode 100644 index c441f9d39..000000000 --- a/src/content/docs/sdk/ios/reference/adjevent.mdx +++ /dev/null @@ -1,196 +0,0 @@ ---- -title: ADJEvent class -description: Record information about events to send to Adjust. -category-title: ADJEvent class -slug: en/sdk/ios/reference/adjevent ---- - -import TrackEvent from "@ios-signatures/Adjust/trackEvent.mdx" - -This class contains information about events triggered in your application. You can send this information to Adjust's servers by passing an `ADJEvent` object to the `trackEvent` method. - - - -## Constructor - -Instantiates an event object with an Adjust event token. - - - -import ConstructorSig from "@ios-signatures/ADJEvent/constructor.mdx" - - - - - - - -import Constructor from "@ios-examples/ADJEvent/constructor.mdx" - - - - - - - -`eventToken` (NSString): A 6 character Adjust event token. - - - - - - - -## setRevenue - -Sets the revenue and currency associated with an event. - - - -import SetRevenueSig from "@ios-signatures/ADJEvent/setRevenue.mdx" - - - - - - - -import SetRevenue from "@ios-examples/ADJEvent/setRevenue.mdx" - - - - - - - -`amount` (double): The amount of currency units associated with the event. - -`currency` (NSString): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit. - - - - - - - -## setTransactionId - -Sets a deduplication ID on your event to avoid recording duplicates. The SDK stores the last ten identifiers and skips revenue events with duplicate IDs. - - - -import SetTransactionIdSig from "@ios-signatures/ADJEvent/setTransactionId.mdx" - - - - - - - -import SetTransactionId from "@ios-examples/ADJEvent/setTransactionId.mdx" - - - - - - - -`transactionId` (NSString): A unique identifier used to deduplicate events. - - - - - - - -## setCallbackId - -Sets a custom identifier for your event object. Adjust's servers can report on this identifier in event callbacks. - - - -import SetCallbackIdSig from "@ios-signatures/ADJEvent/setCallbackId.mdx" - - - - - - - -import SetCallbackId from "@ios-examples/ADJEvent/setCallbackId.mdx" - - - - - - - -`callbackId` (NSString): A custom identifier for your event object. - - - - - - - -## addCallbackParameter - -Adds key-value information to send to your callback URL. - - - -import AddCallbackParameterSig from "@ios-signatures/ADJEvent/addCallbackParameter.mdx" - - - - - - - -import AddCallbackParameter from "@ios-examples/ADJEvent/addCallbackParameter.mdx" - - - - - - - -`key` (NSString): The data key. - -`value` (NSString): The data value. - - - - - - - -## addPartnerParameter - -Adds key-value information to share with partners. - - - -import AddPartnerParameterSig from "@ios-signatures/ADJEvent/addPartnerParameter.mdx" - - - - - - - -import AddPartnerParameter from "@ios-examples/ADJEvent/addPartnerParameter.mdx" - - - - - - - -`key` (NSString): The data key. - -`value` (NSString): The data value. - - - - diff --git a/src/content/docs/sdk/ios/reference/adjlinkresolution.mdx b/src/content/docs/sdk/ios/reference/adjlinkresolution.mdx deleted file mode 100644 index ded9beb8a..000000000 --- a/src/content/docs/sdk/ios/reference/adjlinkresolution.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ADJLinkResolution class -description: A helper class that assists with resolution of links which wrap Adjust deep links. -category-title: ADJLinkResolution class -slug: en/sdk/ios/reference/adjlinkresolution ---- - -A helper class that assists with resolution of links which wrap Adjust deep links. - - - -## resolveLinkWithUrl - -Enables the Adjust SDK to follow redirects to resolve email campaign links. This method follows up to 10 redirects and returns either the final domain or the 10th domain returned depending on which comes first. - - - -import ResolveLinkWithUrlSig from "@ios-signatures/ADJLinkResolution/resolveLinkWithUrl.mdx" - - - - - - - -import ResolveLinkWithUrl from "@ios-examples/ADJLinkResolution/resolveLinkWithUrl.mdx" - - - - - - - -`url` (NSURL): A URL containing deep link information. - -`resolveUrlSuffixArray` (NSArray\): The custom domains of the configured campaigns that need to be resolved. - -`callback` (void function): The callback that will contain the final URL. - - - - diff --git a/src/content/docs/sdk/ios/reference/adjsubscription.mdx b/src/content/docs/sdk/ios/reference/adjsubscription.mdx deleted file mode 100644 index 6af899cc5..000000000 --- a/src/content/docs/sdk/ios/reference/adjsubscription.mdx +++ /dev/null @@ -1,168 +0,0 @@ ---- -title: ADJSubscription class -description: Use this class to send subscription information to Adjust. -category-title: ADJSubscription class -slug: en/sdk/ios/reference/adjsubscription ---- - -import TrackSusbcription from "@ios-signatures/Adjust/trackSubscription.mdx" - -Use this class to store subscription information. You can pass this to Adjust's servers using the `trackSubscription` method. - - - -## Constructor - -Instantiates a subscription object with key information. - - - -import ConstructorSig from "@ios-signatures/ADJSubscription/constructor.mdx" - - - - - - - -import Constructor from "@ios-examples/ADJSubscription/constructor.mdx" - - - - - - - -`price` (NSDecimalNumber): The price of the subscription. - -`currency` (NSString): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit. - -`transactionId` (NSString): The unique ID of the purchase transaction. - -`receipt` (NSData): A data object containing receipt information. - - - - - - - -Sets the date of the transaction in the subscription object. - - - -import SetTransactionDateSig from "@ios-signatures/ADJSubscription/setTransactionDate.mdx" - - - - - - - -import SetTransactionDate from "@ios-examples/ADJSubscription/setTransactionDate.mdx" - - - - - - - -`transactionDate` (NSDate): The date on which the subscription was purchased. - - - - - - - -## setSalesRegion - -Sets the region in which the subscription purchase was made. - - - -import SetSalesRegionSig from "@ios-signatures/ADJSubscription/setSalesRegion.mdx" - - - - - - - -import SetSalesRegion from "@ios-examples/ADJSubscription/setSalesRegion.mdx" - - - - - - - -`salesRegion` (NSString): The region in which the subscription was purchased. - - - - - - - -## addCallbackParameter - -Adds key-value information to send to your callback URL. - - - -import AddCallbackParameterSig from "@ios-signatures/ADJSubscription/addCallbackParameter.mdx" - - - - - - - -import AddCallbackParameter from "@ios-examples/ADJSubscription/addCallbackParameter.mdx" - - - - - - - -`key` (NSString): The data key. - -`value` (NSString): The data value. - - - - - - - -## addPartnerParameter - -Adds key-value information to share with partners. - - - -import AddPartnerParameterSig from "@ios-signatures/ADJSubscription/addPartnerParameter.mdx" - - - - - - - -import AddPartnerParameter from "@ios-examples/ADJSubscription/addPartnerParameter.mdx" - - - - - - - -`key` (NSString): The data key. - -`value` (NSString): The data value. - - - - diff --git a/src/content/docs/sdk/ios/reference/adjthirdpartysharing.mdx b/src/content/docs/sdk/ios/reference/adjthirdpartysharing.mdx deleted file mode 100644 index ef467f3bc..000000000 --- a/src/content/docs/sdk/ios/reference/adjthirdpartysharing.mdx +++ /dev/null @@ -1,139 +0,0 @@ ---- -title: ADJThirdPartySharing class -description: Use this class to communicate a user's third party sharing preferences. -category-title: ADJThirdPartySharing class -slug: en/sdk/ios/reference/adjthirdpartysharing ---- - -import TrackThirdPartySharing from "@ios-signatures/Adjust/trackThirdPartySharing.mdx" - -Use this class to communicate a user's third party sharing preferences. Send this information to Adjust's servers using the `trackThirdPartySharing` method. - - - -## Constructor - -Creates a third party sharing object initialized with a **nullable boolean** value. - - - -import ConstructorSig from "@ios-signatures/ADJThirdPartySharing/constructor.mdx" - - - - - - - -import InitWithIsEnabledNumberBool from "@ios-examples/ADJThirdPartySharing/initWithIsEnabledNumberBoolTrue.mdx"; - - - - - - - -`isEnabledNumberBool` (NSNumber): A number boolean value. - - - - - - - -## addGranularOption - -Adds additional key-value pairs of information to share with third parties. You can add multiple parameters by calling this method multiple times. - - - -import AddGranularOptionSig from "@ios-signatures/ADJThirdPartySharing/addGranularOption.mdx" - - - - - - - -import AddGranularOption from "@ios-examples/ADJThirdPartySharing/addGranularOption.mdx"; - - - -You can use this method to toggle Facebook data processing options. - -import Facebook from "@ios-examples/ADJThirdPartySharing/addGranularOptionFacebook.mdx"; - - - - - -| 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.
| - -
- - - - - -`partnerName` (NSString): The name of the partner you want to share information with. - -`key` (NSString): The data key. - -`value` (NSString): The data value. - - - - - - - -## addPartnerSharingSetting - -Adds additional key-value pairs of settings to share with third parties. You can add multiple settings by calling this method multiple times. - - - -import AddPartnerSharingSettingSig from "@ios-signatures/ADJThirdPartySharing/addPartnerSharingSetting.mdx"; - - - - - - - -import AddPartnerSharingSetting from "@ios-examples/ADJThirdPartySharing/addPartnerSharingSetting.mdx"; - - - - - - - -`partnerName` (NSString): The name of the partner whose settings you want to update. See the table of available partners below. -`key` (NSString): The setting you want to update. -`value` (BOOL): Whether the setting is enabled. - - - -| Partner name | String value | -| ----------------------- | --------------------------- | -| AppleAds | `apple_ads` | -| Facebook | `facebook` | -| GoogleAds | `adwords` | -| GoogleMarketingPlatform | `google_marketing_platform` | -| Snapchat | `snapchat` | -| Tencent | `tencent` | -| TikTokSan | `tiktok_san` | -| Twitter | `twitter` | -| YahooGemini | `yahoo_gemini` | -| YahooJapanSearch | `yahoo_japan_search` | - -
- - - - diff --git a/src/content/docs/sdk/ios/reference/adjust/config.mdx b/src/content/docs/sdk/ios/reference/adjust/config.mdx deleted file mode 100644 index 81ff70204..000000000 --- a/src/content/docs/sdk/ios/reference/adjust/config.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: Configuration methods -description: Use these methods to update the Adjust SDK's configuration. -slug: en/sdk/ios/reference/adjust/config -sidebar-position: 1 ---- - -Use these methods to update the Adjust SDK's configuration. - - - -## setEnabled - -Enable or disable the Adjust SDK. The SDK doesn't send any information while disabled. - - - -import SetEnabledSig from "@ios-signatures/Adjust/setEnabled.mdx" - - - - - - - -import SetEnabled from "@ios-examples/Adjust/setEnabled.mdx" - - - - - - - -`enabled` (BOOL): Whether the SDK is enabled - - - - - - - -## isEnabled - -Call this method to check whether the Adjust SDK is enabled. - - - -import IsEnabledSig from "@ios-signatures/Adjust/isEnabled.mdx" - - - - - - - -import IsEnabled from "@ios-examples/Adjust/isEnabled.mdx" - - - - - - - -`enabled` (BOOL): Whether the SDK is enabled - - - - - - - -## sendFirstPackages - - - -This method has an effect only if you delay the start of the Adjust SDK. - - - -The Adjust SDK sends information to Adjust's servers as soon as it starts. If you delay the start of the SDK, you can use this method to send packages before the delay ends. - - - -import SendFirstPackagesSig from "@ios-signatures/Adjust/sendFirstPackages.mdx" - - - - - - - -import SendFirstPackages from "@ios-examples/Adjust/sendFirstPackages.mdx" - - - - - - - - - -## setOfflineMode - -Controls whether the SDK is in offline mode. When in offline mode, the SDK queues all events in a file until offline mode is disabled. When offline mode is disabled, the SDK sends all queued events. - - - -import SetOfflineModeSig from "@ios-signatures/Adjust/setOfflineMode.mdx" - - - - - - - -import SetOfflineMode from "@ios-examples/Adjust/setOfflineMode.mdx" - - - - - - - -`enabled` (BOOL): Whether the SDK is in offline mode - - - - - - - -## setDeviceToken - -Set your [push token](https://help.adjust.com/en/article/push-notifications) to record [uninstalls and reattributions](https://help.adjust.com/en/article/uninstalls-reinstalls). You can update this value at any time. - - - -import SetDeviceTokenSig from "@ios-signatures/Adjust/setDeviceToken.mdx" - - - - - - - -import SetDeviceToken from "@ios-examples/Adjust/setDeviceToken.mdx" - - - - - - - -`deviceToken` (NSData): Your Apple push token - - - - diff --git a/src/content/docs/sdk/ios/reference/adjust/device-info.mdx b/src/content/docs/sdk/ios/reference/adjust/device-info.mdx deleted file mode 100644 index 4b188ef03..000000000 --- a/src/content/docs/sdk/ios/reference/adjust/device-info.mdx +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: Device information methods -description: Use these methods to retrieve device information. -slug: en/sdk/ios/reference/adjust/device-info -sidebar-position: 2 ---- - -Use these methods to retrieve device information. - - - -## getAdid - - - -The ADID is available only after the install has been recorded. - - - -Returns the ADID (Adjust Device ID) associated with the device. - - - -import AdidSig from "@ios-signatures/Adjust/adid.mdx" - - - - - - - -import Adid from "@ios-examples/Adjust/adid.mdx" - - - - - - - -`adid` (NSString): The Adjust identifier associated with the device - - - - - - - -## getIdfa - -Returns the IDFA (ID for advertisers) associated with the device. - - - -import IdfaSig from "@ios-signatures/Adjust/idfa.mdx" - - - - - - - -import Idfa from "@ios-examples/Adjust/idfa.mdx" - - - - - - - -`idfa` (NSString): The IDFA associated with the device - - - - diff --git a/src/content/docs/sdk/ios/reference/adjust/index.mdx b/src/content/docs/sdk/ios/reference/adjust/index.mdx deleted file mode 100644 index 5f800cc1f..000000000 --- a/src/content/docs/sdk/ios/reference/adjust/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Adjust class -description: Use the Adjust class send information about your application and users to Adjust -category-title: Adjust class -slug: en/sdk/ios/reference/adjust -type: category ---- - -The Adjust class can be used to send information about your application and users to Adjust. This can be used for attribution as well as recording events for analytics. diff --git a/src/content/docs/sdk/ios/reference/adjust/privacy.mdx b/src/content/docs/sdk/ios/reference/adjust/privacy.mdx deleted file mode 100644 index c063b2b7f..000000000 --- a/src/content/docs/sdk/ios/reference/adjust/privacy.mdx +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: Privacy methods -description: Use these methods to handle user privacy in your app. -slug: en/sdk/ios/reference/adjust/privacy -sidebar-position: 3 ---- - -Use these methods to handle user privacy in your app. - - - -## disableThirdPartySharing - -Disable sharing of information with third parties for all users. - - - -import DisableThirdPartySharingSig from "@ios-signatures/Adjust/disableThirdPartySharing.mdx" - - - - - - - -import DisableThirdPartySharing from "@ios-examples/Adjust/disableThirdPartySharing.mdx" - - - - - - - - - -## trackThirdPartySharing - -Disable or enable sharing of information with third parties on a per-user basis. Accepts a third party sharing object initialized with a **boolean** value. - - - -import TrackThirdPartySharingSig from "@ios-signatures/Adjust/trackThirdPartySharing.mdx" - - - - - - - -import TrackThirdPartySharing from "@ios-examples/Adjust/trackThirdPartySharing.mdx" - - - - - - - -`thirdPartySharing` (ADJThirdPartySharing): The third party sharing object - - - - - - - -## trackMeasurementConsent - -Set whether [data collection and retention rules](https://help.adjust.com/en/article/manage-data-collection-and-retention) apply to a user. - - - -import TrackMeasurementConsentSig from "@ios-signatures/Adjust/trackMeasurementConsent.mdx" - - - - - - - -import TrackMeasurementConsent from "@ios-examples/Adjust/trackMeasurementConsent.mdx" - - - - - - - -`enabled` (BOOL): Whether data collection and retention rules apply for the user. - - - - - - - -## gdprForgetMe - -Send an RTBF (Right To Be Forgotten) request to Adjust's servers. This erases all information about the user the source app. The SDK stops sending requests for the user. - - - -import GdprForgetMeSig from "@ios-signatures/Adjust/gdprForgetMe.mdx" - - - - - - - -import GdprForgetMe from "@ios-examples/Adjust/gdprForgetMe.mdx" - - - - - - diff --git a/src/content/docs/sdk/ios/reference/adjust/recording.mdx b/src/content/docs/sdk/ios/reference/adjust/recording.mdx deleted file mode 100644 index dbabe004b..000000000 --- a/src/content/docs/sdk/ios/reference/adjust/recording.mdx +++ /dev/null @@ -1,330 +0,0 @@ ---- -title: Recording methods -description: Use these methods to send information about your app to Adjust. -slug: en/sdk/ios/reference/adjust/recording -sidebar-position: 4 ---- - -Use these methods to send information about your app to Adjust. - - - -## trackEvent - -Record event information using an `ADJEvent` object and an [Adjust event token](https://help.adjust.com/en/article/add-events#add-event). - - - -import TrackEventSig from "@ios-signatures/Adjust/trackEvent.mdx" - - - - - - - -import TrackEvent from "@ios-examples/Adjust/trackEvent.mdx" - - - - - - - -`event` (ADJEvent): An event object containing the information you want to send to Adjust. - - - - - - - -## addSessionCallbackParameter - -Adds callback parameters to send with each session recorded by the Adjust SDK. You can add extra parameters by calling on this method multiple times. - - - -import AddSessionCallbackParameterSig from "@ios-signatures/Adjust/addSessionCallbackParameter.mdx" - - - - - - - -import AddSessionCallbackParameter from "@ios-examples/Adjust/addSessionCallbackParameter.mdx" - - - - - - - -`key` (NSString): The data key - -`value` (NSString): The data value - - - - - - - -## removeSessionCallbackParameter - -Remove a session callback parameter. - - - -import RemoveSessionCallbackParameterSig from "@ios-signatures/Adjust/removeSessionCallbackParameter.mdx" - - - - - - - -import RemoveSessionCallbackParameter from "@ios-examples/Adjust/removeSessionCallbackParameter.mdx" - - - - - - - -`key` (NSString): The data key of the parameter you want to remove. - - - - - - - -## resetSessionCallbackParameters - -Removes all session callback parameters. - - - -import ResetSessionCallbackParametersSig from "@ios-signatures/Adjust/resetSessionCallbackParameters.mdx" - - - - - - - -import ResetSessionCallbackParameters from "@ios-examples/Adjust/resetSessionCallbackParameters.mdx" - - - - - - - - - -## addSessionPartnerParameter - -Adds partner parameters to send with each session recorded by the Adjust SDK. You can add extra parameters by calling on this method multiple times. - - - -import AddSessionPartnerParameterSig from "@ios-signatures/Adjust/addSessionPartnerParameter.mdx" - - - - - - - -import AddSessionPartnerParameter from "@ios-examples/Adjust/addSessionPartnerParameter.mdx" - - - - - - - -`key` (NSString): The data key - -`value` (NSString): The data value - - - - - - - -## removeSessionPartnerParameter - -Remove a session partner parameter. - - - -import RemoveSessionPartnerParameterSig from "@ios-signatures/Adjust/removeSessionPartnerParameter.mdx" - - - - - - - -import RemoveSessionPartnerParameter from "@ios-examples/Adjust/removeSessionPartnerParameter.mdx" - - - - - - - -`key` (NSString): The data key of the parameter you want to remove. - - - - - - - -## resetSessionPartnerParameters - -Removes all session partner parameters. - - - -import ResetSessionPartnerParametersSig from "@ios-signatures/Adjust/resetSessionPartnerParameters.mdx" - - - - - - - -import ResetSessionPartnerParameters from "@ios-examples/Adjust/resetSessionPartnerParameters.mdx" - - - - - - - - - -## appWillOpenUrl - -Instructs the Adjust SDK to search for attribution information in a URL. If the SDK finds valid information, it sends this information to Adjust's servers. - - - -import AppWillOpenUrlSig from "@ios-signatures/Adjust/appWillOpenUrl.mdx" - - - - - - - -import AppWillOpenUrl from "@ios-examples/Adjust/appWillOpenUrl.mdx" - - - - - - - -`url` (NSURL): A URL containing deep link information. - - - - - - - -## getAttribution - -Fetches attribution data about the device. - - - -import AttributionSig from "@ios-signatures/Adjust/attribution.mdx" - - - - - - - -import Attribution from "@ios-examples/Adjust/attribution.mdx" - - - - - - - -`attribution` (ADJAttribution): An attribution object containing attribution data associated with the device. - - - - - - - -## trackSubscription - -Send subscription details to Adjust in an ADJSubscription object. - - - -import TrackSubscriptionSig from "@ios-signatures/Adjust/trackSubscription.mdx" - - - - - - - -import TrackSubscription from "@ios-examples/Adjust/trackSubscription.mdx" - - - - - - - -`subscription` (ADJSubscription): The subscription object containing the purchase details. - - - - - - - -## trackAdRevenue - -Send ad revenue information to Adjust in an ADJAdRevenue object. - - - -import TrackAdRevenueSig from "@ios-signatures/Adjust/trackAdRevenue.mdx" - - - - - - - -import TrackAdRevenue from "@ios-examples/Adjust/trackAdRevenue.mdx" - - - - - - - -`adRevenue` (ADJAdRevenue): The ad revenue object containing the revenue details. - - - - diff --git a/src/content/docs/sdk/ios/reference/adjust/skan-att.mdx b/src/content/docs/sdk/ios/reference/adjust/skan-att.mdx deleted file mode 100644 index 7c9abbe14..000000000 --- a/src/content/docs/sdk/ios/reference/adjust/skan-att.mdx +++ /dev/null @@ -1,122 +0,0 @@ ---- -title: SKAdNetwork and ATT methods -description: Use these methods to send information about your app to Adjust. -slug: en/sdk/ios/reference/adjust/skan-att -sidebar-position: 5 ---- - -Use these methods to manage your [SKAdNetwork](https://help.adjust.com/en/article/skadnetwork) and [App Tracking Transparency](https://help.adjust.com/en/article/app-tracking-transparency-att-framework) logic. - - - -## requestTrackingAuthorizationWithCompletionHandler - -Receives the user's authorization status from the ATT prompt and passes it to a completion function. - - - -import RequestTrackingAuthorizationSig from "@ios-signatures/Adjust/requestTrackingAuthorization.mdx" - - - - - - - -import RequestTrackingAuthorization from "@ios-examples/Adjust/requestTrackingAuthorization.mdx" - - - - - - - -`completion` (void function): Completion handler to which the status is passed. - - - - - - - -## appTrackingAuthorizationStatus - -Retrieves the user's current authorization status. - - - -import AppTrackingAuthorizationStatusSig from "@ios-signatures/Adjust/appTrackingAuthorizationStatus.mdx" - - - - - - - -import AppTrackingAuthorizationStatus from "@ios-examples/Adjust/appTrackingAuthorizationStatus.mdx" - - - - - - - -`status` (int): The user's authorization status. - - - - - - - -## checkForNewAttStatus - -Prompts the SDK to check the current state of `att_status`. - - - -import CheckForNewAttStatusSig from "@ios-signatures/Adjust/checkForNewAttStatus.mdx" - - - - - - - -import CheckForNewAttStatus from "@ios-examples/Adjust/checkForNewAttStatus.mdx" - - - - - - - - - -## updateConversionValue - -Updates the [conversion value](https://help.adjust.com/en/suite/article/conversion-hub). - - - -import UpdateConversionValueSig from "@ios-signatures/Adjust/updateConversionValue.mdx" - - - - - - - -import UpdateConversionValue from "@ios-examples/Adjust/updateConversionValue.mdx" - - - - - - - -conversionValue (NSInteger): The new conversion value. - - - - diff --git a/src/content/docs/sdk/ios/reference/index.mdx b/src/content/docs/sdk/ios/reference/index.mdx deleted file mode 100644 index b33428793..000000000 --- a/src/content/docs/sdk/ios/reference/index.mdx +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: SDK reference -description: SDK reference information for the iOS SDK -category-title: Reference -slug: en/sdk/ios/reference -type: category ---- diff --git a/src/content/docs/sdk/react-native/features/privacy.mdx b/src/content/docs/sdk/react-native/features/privacy.mdx index 2140f39bd..16e655d8b 100644 --- a/src/content/docs/sdk/react-native/features/privacy.mdx +++ b/src/content/docs/sdk/react-native/features/privacy.mdx @@ -95,21 +95,6 @@ adjustThirdPartySharing.addGranularOption("PartnerA", "key", "value"); Adjust.trackThirdPartySharing(adjustThirdPartySharing); ``` -### Update partner settings - -```ts title="Method signature" -public addPartnerSharingSetting(partnerName: string, key: string, value: boolean): void -``` - -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 your partner name and your options. - -```jsx {3} -var adjustThirdPartySharing = new AdjustThirdPartySharing(null); -//... -adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "foo", false); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - #### Manage Facebook Limited Data Use @@ -203,6 +188,21 @@ To disable third-party sharing for all users, call the `disableThirdPartySharing Adjust.disableThirdPartySharing(); ``` +### Update partner settings + +```ts title="Method signature" +public addPartnerSharingSetting(partnerName: string, key: string, value: boolean): void +``` + +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 your partner name and your options. + +```jsx {3} +var adjustThirdPartySharing = new AdjustThirdPartySharing(null); +//... +adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "foo", false); +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + ## Data residency ```ts title="Method signature"