From 3969c60a0e350fc1b3fea600075037303fd0d1a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Tue, 20 Feb 2024 17:14:04 +0100 Subject: [PATCH 1/8] Update Android documentation --- .../ADJAdRevenue/addCallbackParameter.mdx | 31 - .../ADJAdRevenue/addPartnerParameter.mdx | 31 - .../examples/ADJAdRevenue/constructor.mdx | 28 - .../ADJAdRevenue/setAdImpressionsCount.mdx | 31 - .../ADJAdRevenue/setAdRevenueNetwork.mdx | 31 - .../ADJAdRevenue/setAdRevenuePlacement.mdx | 31 - .../ADJAdRevenue/setAdRevenueUnit.mdx | 31 - .../examples/ADJAdRevenue/setRevenue.mdx | 31 - .../examples/ADJConfig/constructor.mdx | 11 - .../ADJConfig/setCoppaCompliantEnabled.mdx | 36 -- .../examples/ADJConfig/setDefaultTracker.mdx | 36 -- .../examples/ADJConfig/setDelayStart.mdx | 29 - .../ADJConfig/setEventBufferingEnabled.mdx | 36 -- .../ADJConfig/setExternalDeviceId.mdx | 38 -- .../examples/ADJConfig/setLogLevel.mdx | 36 -- .../examples/ADJConfig/setNeedsCost.mdx | 29 - .../setOnAttributionChangedListener.mdx | 40 -- ...etOnAttributionChangedListenerFacebook.mdx | 50 -- .../setOnDeeplinkResponseListener.mdx | 53 -- .../setOnEventTrackingFailedListener.mdx | 45 -- ...etOnEventTrackingFailedListenerExample.mdx | 47 -- .../setOnEventTrackingSucceededListener.mdx | 45 -- ...nEventTrackingSucceededListenerExample.mdx | 47 -- .../setOnSessionTrackingFailedListener.mdx | 45 -- ...OnSessionTrackingFailedListenerExample.mdx | 47 -- .../setOnSessionTrackingSucceededListener.mdx | 45 -- ...essionTrackingSucceededListenerExample.mdx | 47 -- .../ADJConfig/setPlayStoreKidsAppEnabled.mdx | 36 -- .../ADJConfig/setPreinstallFilePath.mdx | 36 -- .../setPreinstallTrackingEnabled.mdx | 36 -- .../ADJConfig/setSendInBackground.mdx | 36 -- .../examples/ADJConfig/setUrlStrategy.mdx | 36 -- .../ADJEvent/addCallbackParameter.mdx | 33 - .../ADJEvent/addCallbackParameterExample.mdx | 43 -- .../examples/ADJEvent/addPartnerParameter.mdx | 33 - .../ADJEvent/addPartnerParameterExample.mdx | 43 -- .../android/examples/ADJEvent/constructor.mdx | 27 - .../examples/ADJEvent/setCallbackId.mdx | 30 - .../ADJEvent/setCallbackIdExample.mdx | 40 -- .../android/examples/ADJEvent/setOrderId.mdx | 33 - .../examples/ADJEvent/setOrderIdExample.mdx | 40 -- .../android/examples/ADJEvent/setRevenue.mdx | 30 - .../examples/ADJEvent/setRevenueExample.mdx | 40 -- .../addCallbackParameter.mdx | 19 - .../addPartnerParameter.mdx | 19 - .../ADJPlayStoreSubscription/constructor.mdx | 35 -- .../setPurchaseTime.mdx | 17 - .../addGranularOption.mdx | 31 - .../addGranularOptionFacebook.mdx | 34 - .../addPartnerSharingSetting.mdx | 37 -- .../adjustThirdPartySharingIsEnabledFalse.mdx | 28 - .../adjustThirdPartySharingIsEnabledTrue.mdx | 28 - .../Adjust/addSessionCallbackParameter.mdx | 25 - .../Adjust/addSessionPartnerParameter.mdx | 25 - .../android/examples/Adjust/adid.mdx | 25 - .../examples/Adjust/appWillOpenUrl.mdx | 37 -- .../android/examples/Adjust/attribution.mdx | 25 - .../Adjust/disableThirdPartySharing.mdx | 25 - .../android/examples/Adjust/gdprForgetMe.mdx | 25 - .../android/examples/Adjust/getAmazonAdId.mdx | 25 - .../android/examples/Adjust/getGoogleAdId.mdx | 32 - .../android/examples/Adjust/isEnabled.mdx | 25 - .../Adjust/removeSessionCallbackParameter.mdx | 26 - .../Adjust/removeSessionPartnerParameter.mdx | 25 - .../Adjust/resetSessionCallbackParameters.mdx | 25 - .../Adjust/resetSessionPartnerParameters.mdx | 25 - .../examples/Adjust/sendFirstPackages.mdx | 25 - .../android/examples/Adjust/setEnabled.mdx | 25 - .../examples/Adjust/setOfflineMode.mdx | 25 - .../android/examples/Adjust/setPushToken.mdx | 25 - .../examples/Adjust/setPushTokenExample.mdx | 25 - .../examples/Adjust/trackAdRevenue.mdx | 28 - .../android/examples/Adjust/trackEvent.mdx | 28 - .../examples/Adjust/trackEventExample.mdx | 37 -- .../Adjust/trackMeasurementConsent.mdx | 25 - .../Adjust/trackPlayStoreSubscription.mdx | 35 -- .../Adjust/trackThirdPartySharing.mdx | 28 - .../ADJAdRevenue/addCallbackParameter.mdx | 3 - .../ADJAdRevenue/addPartnerParameter.mdx | 3 - .../signatures/ADJAdRevenue/constructor.mdx | 3 - .../ADJAdRevenue/setAdImpressionsCount.mdx | 3 - .../ADJAdRevenue/setAdRevenueNetwork.mdx | 3 - .../ADJAdRevenue/setAdRevenuePlacement.mdx | 3 - .../ADJAdRevenue/setAdRevenueUnit.mdx | 3 - .../signatures/ADJAdRevenue/setRevenue.mdx | 3 - .../signatures/ADJConfig/constructor.mdx | 5 - .../ADJConfig/setCoppaCompliantEnabled.mdx | 3 - .../ADJConfig/setDefaultTracker.mdx | 3 - .../signatures/ADJConfig/setDelayStart.mdx | 3 - .../ADJConfig/setEventBufferingEnabled.mdx | 3 - .../ADJConfig/setExternalDeviceId.mdx | 3 - .../signatures/ADJConfig/setLogLevel.mdx | 3 - .../signatures/ADJConfig/setNeedsCost.mdx | 3 - .../setOnAttributionChangedListener.mdx | 3 - .../setOnDeeplinkResponseListener.mdx | 3 - .../setOnEventTrackingFailedListener.mdx | 3 - .../setOnEventTrackingSucceededListener.mdx | 3 - .../setOnSessionTrackingFailedListener.mdx | 3 - .../setOnSessionTrackingSucceededListener.mdx | 3 - .../ADJConfig/setPlayStoreKidsAppEnabled.mdx | 3 - .../ADJConfig/setPreinstallFilePath.mdx | 3 - .../setPreinstallTrackingEnabled.mdx | 3 - .../ADJConfig/setSendInBackground.mdx | 3 - .../signatures/ADJConfig/setUrlStrategy.mdx | 3 - .../ADJEvent/addCallbackParameter.mdx | 3 - .../ADJEvent/addPartnerParameter.mdx | 3 - .../signatures/ADJEvent/constructor.mdx | 3 - .../signatures/ADJEvent/setCallbackId.mdx | 3 - .../signatures/ADJEvent/setOrderId.mdx | 3 - .../signatures/ADJEvent/setRevenue.mdx | 3 - .../addCallbackParameter.mdx | 3 - .../addPartnerParameter.mdx | 3 - .../ADJPlayStoreSubscription/constructor.mdx | 8 - .../setPurchaseTime.mdx | 3 - .../addGranularOption.mdx | 5 - .../addPartnerSharingSetting.mdx | 5 - .../ADJThirdPartySharing/constructor.mdx | 3 - .../Adjust/addSessionCallbackParameter.mdx | 3 - .../Adjust/addSessionPartnerParameter.mdx | 3 - .../android/signatures/Adjust/adid.mdx | 3 - .../signatures/Adjust/appWillOpenUrl.mdx | 3 - .../android/signatures/Adjust/attribution.mdx | 3 - .../Adjust/disableThirdPartySharing.mdx | 3 - .../signatures/Adjust/gdprForgetMe.mdx | 3 - .../signatures/Adjust/getAmazonAdId.mdx | 3 - .../signatures/Adjust/getGoogleAdId.mdx | 3 - .../android/signatures/Adjust/isEnabled.mdx | 3 - .../Adjust/removeSessionCallbackParameter.mdx | 3 - .../Adjust/removeSessionPartnerParameter.mdx | 3 - .../Adjust/resetSessionCallbackParameters.mdx | 3 - .../Adjust/resetSessionPartnerParameters.mdx | 3 - .../signatures/Adjust/sendFirstPackages.mdx | 3 - .../android/signatures/Adjust/setEnabled.mdx | 3 - .../signatures/Adjust/setOfflineMode.mdx | 3 - .../signatures/Adjust/setPushToken.mdx | 3 - .../signatures/Adjust/trackAdRevenue.mdx | 3 - .../android/signatures/Adjust/trackEvent.mdx | 3 - .../Adjust/trackMeasurementConsent.mdx | 3 - .../Adjust/trackPlayStoreSubscription.mdx | 3 - .../Adjust/trackThirdPartySharing.mdx | 4 - .../docs/sdk/android/configuration.mdx | 580 +++++++++++++++++ .../sdk/android/configuration/background.mdx | 20 - .../docs/sdk/android/configuration/delay.mdx | 30 - .../sdk/android/configuration/disable.mdx | 28 - .../configuration/external-device-id.mdx | 40 -- .../docs/sdk/android/configuration/index.mdx | 9 - .../sdk/android/configuration/log-level.mdx | 28 - .../android/configuration/preinstalled.mdx | 94 --- .../sdk/android/configuration/privacy.mdx | 210 ------- .../sdk/android/configuration/push-tokens.mdx | 28 - .../docs/sdk/android/features/ad-revenue.mdx | 379 +++++++++-- .../docs/sdk/android/features/attribution.mdx | 177 +++++- .../docs/sdk/android/features/callbacks.mdx | 456 ++++++++++++-- .../deep-linking.mdx | 141 ++++- .../docs/sdk/android/features/device-info.mdx | 111 +++- .../docs/sdk/android/features/events.mdx | 523 ++++++++++++++-- .../docs/sdk/android/features/index.mdx | 1 + .../docs/sdk/android/features/privacy.mdx | 591 ++++++++++++++++++ .../android/features/session-parameters.mdx | 272 +++++++- .../sdk/android/features/subscriptions.mdx | 204 +++++- src/content/docs/sdk/android/index.mdx | 22 +- .../docs/sdk/android/integrations/admob.mdx | 4 +- .../sdk/android/integrations/applovin.mdx | 4 +- .../docs/sdk/android/integrations/batch.mdx | 4 +- .../docs/sdk/android/integrations/helium.mdx | 4 +- .../docs/sdk/android/integrations/index.mdx | 1 + .../sdk/android/integrations/ironsource.mdx | 4 +- .../sdk/android/integrations/mixpanel.mdx | 4 +- .../docs/sdk/android/integrations/unity.mdx | 4 +- .../docs/sdk/android/plugins/criteo.mdx | 126 +--- .../sdk/android/plugins/facebook-pixel.mdx | 53 +- .../docs/sdk/android/plugins/imei-plugin.mdx | 17 +- .../docs/sdk/android/plugins/index.mdx | 1 + .../docs/sdk/android/plugins/oaid-plugin.mdx | 50 +- .../plugins/samsung-referrer-plugin.mdx | 19 +- .../docs/sdk/android/plugins/sociomatic.mdx | 98 ++- .../docs/sdk/android/plugins/trademob.mdx | 18 +- .../android/plugins/vivo-referrer-plugin.mdx | 8 +- .../plugins/xiaomi-referrer-plugin.mdx | 14 +- .../sdk/android/reference/adjadrevenue.mdx | 269 -------- .../sdk/android/reference/adjattribution.mdx | 44 -- .../sdk/android/reference/adjconfig/index.mdx | 53 -- .../android/reference/adjconfig/privacy.mdx | 112 ---- .../sdk/android/reference/adjconfig/setup.mdx | 484 -------------- .../docs/sdk/android/reference/adjevent.mdx | 198 ------ .../reference/adjplaystoresubscription.mdx | 145 ----- .../reference/adjthirdpartysharing.mdx | 147 ----- .../sdk/android/reference/adjust/config.mdx | 193 ------ .../android/reference/adjust/device-info.mdx | 112 ---- .../sdk/android/reference/adjust/index.mdx | 9 - .../sdk/android/reference/adjust/privacy.mdx | 128 ---- .../android/reference/adjust/recording.mdx | 300 --------- .../docs/sdk/android/reference/index.mdx | 7 - src/content/docs/sdk/android/setup/index.mdx | 1 + .../sdk/android/setup/multi-processes.mdx | 12 +- .../sdk/android/setup/preinstall-tool.mdx | 4 +- .../docs/sdk/android/setup/preinstalled.mdx | 189 ++++++ .../sdk/flutter/configuration/deep-links.mdx | 2 +- src/content/docs/sdk/flutter/index.mdx | 8 +- .../docs/sdk/ios/integrations/admob.mdx | 4 +- .../docs/sdk/ios/integrations/batch.mdx | 4 +- .../docs/sdk/ios/integrations/helium.mdx | 4 +- .../docs/sdk/ios/integrations/ironsource.mdx | 4 +- .../docs/sdk/ios/integrations/mixpanel.mdx | 4 +- .../docs/sdk/ios/integrations/unity.mdx | 4 +- src/content/docs/sdk/ios/plugins/criteo.mdx | 8 +- .../docs/sdk/ios/plugins/sociomatic.mdx | 8 +- src/content/docs/sdk/ios/plugins/trademob.mdx | 8 +- .../react-native/configuration/deep-links.mdx | 2 +- src/content/docs/sdk/react-native/index.mdx | 16 +- .../sdk/unity/configuration/deep-links.mdx | 2 +- src/content/docs/sdk/unity/index.mdx | 8 +- 212 files changed, 3572 insertions(+), 6002 deletions(-) delete mode 100644 src/code-snippets/android/examples/ADJAdRevenue/addCallbackParameter.mdx delete mode 100644 src/code-snippets/android/examples/ADJAdRevenue/addPartnerParameter.mdx delete mode 100644 src/code-snippets/android/examples/ADJAdRevenue/constructor.mdx delete mode 100644 src/code-snippets/android/examples/ADJAdRevenue/setAdImpressionsCount.mdx delete mode 100644 src/code-snippets/android/examples/ADJAdRevenue/setAdRevenueNetwork.mdx delete mode 100644 src/code-snippets/android/examples/ADJAdRevenue/setAdRevenuePlacement.mdx delete mode 100644 src/code-snippets/android/examples/ADJAdRevenue/setAdRevenueUnit.mdx delete mode 100644 src/code-snippets/android/examples/ADJAdRevenue/setRevenue.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/constructor.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setCoppaCompliantEnabled.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setDefaultTracker.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setDelayStart.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setEventBufferingEnabled.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setExternalDeviceId.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setLogLevel.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setNeedsCost.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setOnAttributionChangedListener.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setOnAttributionChangedListenerFacebook.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setOnDeeplinkResponseListener.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setOnEventTrackingFailedListener.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setOnEventTrackingFailedListenerExample.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setOnEventTrackingSucceededListener.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setOnEventTrackingSucceededListenerExample.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setOnSessionTrackingFailedListener.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setOnSessionTrackingFailedListenerExample.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setOnSessionTrackingSucceededListener.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setOnSessionTrackingSucceededListenerExample.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setPlayStoreKidsAppEnabled.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setPreinstallFilePath.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setPreinstallTrackingEnabled.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setSendInBackground.mdx delete mode 100644 src/code-snippets/android/examples/ADJConfig/setUrlStrategy.mdx delete mode 100644 src/code-snippets/android/examples/ADJEvent/addCallbackParameter.mdx delete mode 100644 src/code-snippets/android/examples/ADJEvent/addCallbackParameterExample.mdx delete mode 100644 src/code-snippets/android/examples/ADJEvent/addPartnerParameter.mdx delete mode 100644 src/code-snippets/android/examples/ADJEvent/addPartnerParameterExample.mdx delete mode 100644 src/code-snippets/android/examples/ADJEvent/constructor.mdx delete mode 100644 src/code-snippets/android/examples/ADJEvent/setCallbackId.mdx delete mode 100644 src/code-snippets/android/examples/ADJEvent/setCallbackIdExample.mdx delete mode 100644 src/code-snippets/android/examples/ADJEvent/setOrderId.mdx delete mode 100644 src/code-snippets/android/examples/ADJEvent/setOrderIdExample.mdx delete mode 100644 src/code-snippets/android/examples/ADJEvent/setRevenue.mdx delete mode 100644 src/code-snippets/android/examples/ADJEvent/setRevenueExample.mdx delete mode 100644 src/code-snippets/android/examples/ADJPlayStoreSubscription/addCallbackParameter.mdx delete mode 100644 src/code-snippets/android/examples/ADJPlayStoreSubscription/addPartnerParameter.mdx delete mode 100644 src/code-snippets/android/examples/ADJPlayStoreSubscription/constructor.mdx delete mode 100644 src/code-snippets/android/examples/ADJPlayStoreSubscription/setPurchaseTime.mdx delete mode 100644 src/code-snippets/android/examples/ADJThirdPartySharing/addGranularOption.mdx delete mode 100644 src/code-snippets/android/examples/ADJThirdPartySharing/addGranularOptionFacebook.mdx delete mode 100644 src/code-snippets/android/examples/ADJThirdPartySharing/addPartnerSharingSetting.mdx delete mode 100644 src/code-snippets/android/examples/ADJThirdPartySharing/adjustThirdPartySharingIsEnabledFalse.mdx delete mode 100644 src/code-snippets/android/examples/ADJThirdPartySharing/adjustThirdPartySharingIsEnabledTrue.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/addSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/addSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/adid.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/appWillOpenUrl.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/attribution.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/disableThirdPartySharing.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/gdprForgetMe.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/getAmazonAdId.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/getGoogleAdId.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/isEnabled.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/removeSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/removeSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/resetSessionCallbackParameters.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/resetSessionPartnerParameters.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/sendFirstPackages.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/setEnabled.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/setOfflineMode.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/setPushToken.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/setPushTokenExample.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/trackAdRevenue.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/trackEvent.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/trackEventExample.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/trackMeasurementConsent.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/trackPlayStoreSubscription.mdx delete mode 100644 src/code-snippets/android/examples/Adjust/trackThirdPartySharing.mdx delete mode 100644 src/code-snippets/android/signatures/ADJAdRevenue/addCallbackParameter.mdx delete mode 100644 src/code-snippets/android/signatures/ADJAdRevenue/addPartnerParameter.mdx delete mode 100644 src/code-snippets/android/signatures/ADJAdRevenue/constructor.mdx delete mode 100644 src/code-snippets/android/signatures/ADJAdRevenue/setAdImpressionsCount.mdx delete mode 100644 src/code-snippets/android/signatures/ADJAdRevenue/setAdRevenueNetwork.mdx delete mode 100644 src/code-snippets/android/signatures/ADJAdRevenue/setAdRevenuePlacement.mdx delete mode 100644 src/code-snippets/android/signatures/ADJAdRevenue/setAdRevenueUnit.mdx delete mode 100644 src/code-snippets/android/signatures/ADJAdRevenue/setRevenue.mdx delete mode 100644 src/code-snippets/android/signatures/ADJConfig/constructor.mdx delete mode 100644 src/code-snippets/android/signatures/ADJConfig/setCoppaCompliantEnabled.mdx delete mode 100644 src/code-snippets/android/signatures/ADJConfig/setDefaultTracker.mdx delete mode 100644 src/code-snippets/android/signatures/ADJConfig/setDelayStart.mdx delete mode 100644 src/code-snippets/android/signatures/ADJConfig/setEventBufferingEnabled.mdx delete mode 100644 src/code-snippets/android/signatures/ADJConfig/setExternalDeviceId.mdx delete mode 100644 src/code-snippets/android/signatures/ADJConfig/setLogLevel.mdx delete mode 100644 src/code-snippets/android/signatures/ADJConfig/setNeedsCost.mdx delete mode 100644 src/code-snippets/android/signatures/ADJConfig/setOnAttributionChangedListener.mdx delete mode 100644 src/code-snippets/android/signatures/ADJConfig/setOnDeeplinkResponseListener.mdx delete mode 100644 src/code-snippets/android/signatures/ADJConfig/setOnEventTrackingFailedListener.mdx delete mode 100644 src/code-snippets/android/signatures/ADJConfig/setOnEventTrackingSucceededListener.mdx delete mode 100644 src/code-snippets/android/signatures/ADJConfig/setOnSessionTrackingFailedListener.mdx delete mode 100644 src/code-snippets/android/signatures/ADJConfig/setOnSessionTrackingSucceededListener.mdx delete mode 100644 src/code-snippets/android/signatures/ADJConfig/setPlayStoreKidsAppEnabled.mdx delete mode 100644 src/code-snippets/android/signatures/ADJConfig/setPreinstallFilePath.mdx delete mode 100644 src/code-snippets/android/signatures/ADJConfig/setPreinstallTrackingEnabled.mdx delete mode 100644 src/code-snippets/android/signatures/ADJConfig/setSendInBackground.mdx delete mode 100644 src/code-snippets/android/signatures/ADJConfig/setUrlStrategy.mdx delete mode 100644 src/code-snippets/android/signatures/ADJEvent/addCallbackParameter.mdx delete mode 100644 src/code-snippets/android/signatures/ADJEvent/addPartnerParameter.mdx delete mode 100644 src/code-snippets/android/signatures/ADJEvent/constructor.mdx delete mode 100644 src/code-snippets/android/signatures/ADJEvent/setCallbackId.mdx delete mode 100644 src/code-snippets/android/signatures/ADJEvent/setOrderId.mdx delete mode 100644 src/code-snippets/android/signatures/ADJEvent/setRevenue.mdx delete mode 100644 src/code-snippets/android/signatures/ADJPlayStoreSubscription/addCallbackParameter.mdx delete mode 100644 src/code-snippets/android/signatures/ADJPlayStoreSubscription/addPartnerParameter.mdx delete mode 100644 src/code-snippets/android/signatures/ADJPlayStoreSubscription/constructor.mdx delete mode 100644 src/code-snippets/android/signatures/ADJPlayStoreSubscription/setPurchaseTime.mdx delete mode 100644 src/code-snippets/android/signatures/ADJThirdPartySharing/addGranularOption.mdx delete mode 100644 src/code-snippets/android/signatures/ADJThirdPartySharing/addPartnerSharingSetting.mdx delete mode 100644 src/code-snippets/android/signatures/ADJThirdPartySharing/constructor.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/addSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/addSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/adid.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/appWillOpenUrl.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/attribution.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/disableThirdPartySharing.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/gdprForgetMe.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/getAmazonAdId.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/getGoogleAdId.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/isEnabled.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/removeSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/removeSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/resetSessionCallbackParameters.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/resetSessionPartnerParameters.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/sendFirstPackages.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/setEnabled.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/setOfflineMode.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/setPushToken.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/trackAdRevenue.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/trackEvent.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/trackMeasurementConsent.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/trackPlayStoreSubscription.mdx delete mode 100644 src/code-snippets/android/signatures/Adjust/trackThirdPartySharing.mdx create mode 100644 src/content/docs/sdk/android/configuration.mdx delete mode 100644 src/content/docs/sdk/android/configuration/background.mdx delete mode 100644 src/content/docs/sdk/android/configuration/delay.mdx delete mode 100644 src/content/docs/sdk/android/configuration/disable.mdx delete mode 100644 src/content/docs/sdk/android/configuration/external-device-id.mdx delete mode 100644 src/content/docs/sdk/android/configuration/index.mdx delete mode 100644 src/content/docs/sdk/android/configuration/log-level.mdx delete mode 100644 src/content/docs/sdk/android/configuration/preinstalled.mdx delete mode 100644 src/content/docs/sdk/android/configuration/privacy.mdx delete mode 100644 src/content/docs/sdk/android/configuration/push-tokens.mdx rename src/content/docs/sdk/android/{configuration => features}/deep-linking.mdx (64%) create mode 100644 src/content/docs/sdk/android/features/privacy.mdx delete mode 100644 src/content/docs/sdk/android/reference/adjadrevenue.mdx delete mode 100644 src/content/docs/sdk/android/reference/adjattribution.mdx delete mode 100644 src/content/docs/sdk/android/reference/adjconfig/index.mdx delete mode 100644 src/content/docs/sdk/android/reference/adjconfig/privacy.mdx delete mode 100644 src/content/docs/sdk/android/reference/adjconfig/setup.mdx delete mode 100644 src/content/docs/sdk/android/reference/adjevent.mdx delete mode 100644 src/content/docs/sdk/android/reference/adjplaystoresubscription.mdx delete mode 100644 src/content/docs/sdk/android/reference/adjthirdpartysharing.mdx delete mode 100644 src/content/docs/sdk/android/reference/adjust/config.mdx delete mode 100644 src/content/docs/sdk/android/reference/adjust/device-info.mdx delete mode 100644 src/content/docs/sdk/android/reference/adjust/index.mdx delete mode 100644 src/content/docs/sdk/android/reference/adjust/privacy.mdx delete mode 100644 src/content/docs/sdk/android/reference/adjust/recording.mdx delete mode 100644 src/content/docs/sdk/android/reference/index.mdx create mode 100644 src/content/docs/sdk/android/setup/preinstalled.mdx diff --git a/src/code-snippets/android/examples/ADJAdRevenue/addCallbackParameter.mdx b/src/code-snippets/android/examples/ADJAdRevenue/addCallbackParameter.mdx deleted file mode 100644 index 07ba931d7..000000000 --- a/src/code-snippets/android/examples/ADJAdRevenue/addCallbackParameter.mdx +++ /dev/null @@ -1,31 +0,0 @@ - - - -```kotlin -val adjustAdRevenue = AdjustAdRevenue("source") -adjustAdRevenue.addCallbackParameter("key", "value") -Adjust.trackAdRevenue(adjustAdRevenue) -``` - - - - - -```java -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -adjustAdRevenue.addCallbackParameter("key", "value"); -Adjust.trackAdRevenue(adjustAdRevenue); -``` - - - - - -```js -let adjustAdRevenue = new AdjustAdRevenue('source') -adjustAdRevenue.addCallbackParameter('key', 'value'); -Adjust.trackAdRevenue(adjustAdRevenue); -``` - - - diff --git a/src/code-snippets/android/examples/ADJAdRevenue/addPartnerParameter.mdx b/src/code-snippets/android/examples/ADJAdRevenue/addPartnerParameter.mdx deleted file mode 100644 index b1342ae42..000000000 --- a/src/code-snippets/android/examples/ADJAdRevenue/addPartnerParameter.mdx +++ /dev/null @@ -1,31 +0,0 @@ - - - -```kotlin -val adjustAdRevenue = AdjustAdRevenue("source") -adjustAdRevenue.addPartnerParameter("key", "value") -Adjust.trackAdRevenue(adjustAdRevenue) -``` - - - - - -```java -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -adjustAdRevenue.addPartnerParameter("key", "value"); -Adjust.trackAdRevenue(adjustAdRevenue); -``` - - - - - -```js -let adjustAdRevenue = new AdjustAdRevenue('source') -adjustAdRevenue.addPartnerParameter('key', 'value'); -Adjust.trackAdRevenue(adjustAdRevenue); -``` - - - diff --git a/src/code-snippets/android/examples/ADJAdRevenue/constructor.mdx b/src/code-snippets/android/examples/ADJAdRevenue/constructor.mdx deleted file mode 100644 index 03de7d7ad..000000000 --- a/src/code-snippets/android/examples/ADJAdRevenue/constructor.mdx +++ /dev/null @@ -1,28 +0,0 @@ - - - -```kotlin -val adjustAdRevenue = AdjustAdRevenue("source") -Adjust.trackAdRevenue(adjustAdRevenue) -``` - - - - - -```java -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -Adjust.trackAdRevenue(adjustAdRevenue); -``` - - - - - -```js -let adjustAdRevenue = new AdjustAdRevenue('source') -Adjust.trackAdRevenue(adjustAdRevenue); -``` - - - diff --git a/src/code-snippets/android/examples/ADJAdRevenue/setAdImpressionsCount.mdx b/src/code-snippets/android/examples/ADJAdRevenue/setAdImpressionsCount.mdx deleted file mode 100644 index 3bc5b98c7..000000000 --- a/src/code-snippets/android/examples/ADJAdRevenue/setAdImpressionsCount.mdx +++ /dev/null @@ -1,31 +0,0 @@ - - - -```kotlin -val adjustAdRevenue = AdjustAdRevenue("source") -adjustAdRevenue.setAdImpressionsCount(10) -Adjust.trackAdRevenue(adjustAdRevenue) -``` - - - - - -```java -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -adjustAdRevenue.setAdImpressionsCount(10); -Adjust.trackAdRevenue(adjustAdRevenue); -``` - - - - - -```js -let adjustAdRevenue = new AdjustAdRevenue('source') -adjustAdRevenue.setAdImpressionsCount(10); -Adjust.trackAdRevenue(adjustAdRevenue); -``` - - - diff --git a/src/code-snippets/android/examples/ADJAdRevenue/setAdRevenueNetwork.mdx b/src/code-snippets/android/examples/ADJAdRevenue/setAdRevenueNetwork.mdx deleted file mode 100644 index 24d52cf33..000000000 --- a/src/code-snippets/android/examples/ADJAdRevenue/setAdRevenueNetwork.mdx +++ /dev/null @@ -1,31 +0,0 @@ - - - -```kotlin -val adjustAdRevenue = AdjustAdRevenue("source") -adjustAdRevenue.setAdRevenueNetwork("network1") -Adjust.trackAdRevenue(adjustAdRevenue) -``` - - - - - -```java -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -adjustAdRevenue.setAdRevenueNetwork("network1"); -Adjust.trackAdRevenue(adjustAdRevenue); -``` - - - - - -```js -let adjustAdRevenue = new AdjustAdRevenue('source') -adjustAdRevenue.setAdRevenueNetwork('network1'); -Adjust.trackAdRevenue(adjustAdRevenue); -``` - - - diff --git a/src/code-snippets/android/examples/ADJAdRevenue/setAdRevenuePlacement.mdx b/src/code-snippets/android/examples/ADJAdRevenue/setAdRevenuePlacement.mdx deleted file mode 100644 index 55a337938..000000000 --- a/src/code-snippets/android/examples/ADJAdRevenue/setAdRevenuePlacement.mdx +++ /dev/null @@ -1,31 +0,0 @@ - - - -```kotlin -val adjustAdRevenue = AdjustAdRevenue("source") -adjustAdRevenue.setAdRevenuePlacement("banner") -Adjust.trackAdRevenue(adjustAdRevenue) -``` - - - - - -```java -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -adjustAdRevenue.setAdRevenuePlacement("banner"); -Adjust.trackAdRevenue(adjustAdRevenue); -``` - - - - - -```js -let adjustAdRevenue = new AdjustAdRevenue('source') -adjustAdRevenue.setAdRevenuePlacement('banner'); -Adjust.trackAdRevenue(adjustAdRevenue); -``` - - - diff --git a/src/code-snippets/android/examples/ADJAdRevenue/setAdRevenueUnit.mdx b/src/code-snippets/android/examples/ADJAdRevenue/setAdRevenueUnit.mdx deleted file mode 100644 index 5598ba0c3..000000000 --- a/src/code-snippets/android/examples/ADJAdRevenue/setAdRevenueUnit.mdx +++ /dev/null @@ -1,31 +0,0 @@ - - - -```kotlin -val adjustAdRevenue = AdjustAdRevenue("source") -adjustAdRevenue.setAdRevenueUnit("unit1") -Adjust.trackAdRevenue(adjustAdRevenue) -``` - - - - - -```java -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -adjustAdRevenue.setAdRevenueUnit("unit1"); -Adjust.trackAdRevenue(adjustAdRevenue); -``` - - - - - -```js -let adjustAdRevenue = new AdjustAdRevenue('source') -adjustAdRevenue.setAdRevenueUnit('unit1'); -Adjust.trackAdRevenue(adjustAdRevenue); -``` - - - diff --git a/src/code-snippets/android/examples/ADJAdRevenue/setRevenue.mdx b/src/code-snippets/android/examples/ADJAdRevenue/setRevenue.mdx deleted file mode 100644 index 8fc541604..000000000 --- a/src/code-snippets/android/examples/ADJAdRevenue/setRevenue.mdx +++ /dev/null @@ -1,31 +0,0 @@ - - - -```kotlin -val adjustAdRevenue = AdjustAdRevenue("source") -adjustAdRevenue.setRevenue(1.00, "EUR") -Adjust.trackAdRevenue(adjustAdRevenue) -``` - - - - - -```java -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -adjustAdRevenue.setRevenue(1.00, "EUR"); -Adjust.trackAdRevenue(adjustAdRevenue); -``` - - - - - -```js -let adjustAdRevenue = new AdjustAdRevenue('source') -adjustAdRevenue.setRevenue(1.00, 'EUR'); -Adjust.trackAdRevenue(adjustAdRevenue); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/constructor.mdx b/src/code-snippets/android/examples/ADJConfig/constructor.mdx deleted file mode 100644 index de87df99f..000000000 --- a/src/code-snippets/android/examples/ADJConfig/constructor.mdx +++ /dev/null @@ -1,11 +0,0 @@ - - - -```java {3} -String appToken = "{YourAppToken}"; -String environment = AdjustConfig.ENVIRONMENT_SANDBOX; -AdjustConfig config = new AdjustConfig(this, appToken, environment); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setCoppaCompliantEnabled.mdx b/src/code-snippets/android/examples/ADJConfig/setCoppaCompliantEnabled.mdx deleted file mode 100644 index a4b9fd8b5..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setCoppaCompliantEnabled.mdx +++ /dev/null @@ -1,36 +0,0 @@ - - - -```kotlin {4} -val appToken = "{YourAppToken}" -val environment = AdjustConfig.ENVIRONMENT_SANDBOX -val config = AdjustConfig(this, appToken, environment) -config.setCoppaCompliantEnabled(true) -//... -Adjust.onCreate(config) -``` - - - - -```java {4} -String appToken = "{YourAppToken}"; -String environment = AdjustConfig.ENVIRONMENT_SANDBOX; -AdjustConfig config = new AdjustConfig(this, appToken, environment); -config.setCoppaCompliantEnabled(true); -//... -Adjust.onCreate(config); -``` - - - - -```js {4} -var yourAppToken = yourAppToken; -var environment = AdjustConfig.EnvironmentSandbox; -var adjustConfig = new AdjustConfig(yourAppToken, environment); -adjustConfig.setCoppaCompliantEnabled(true); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setDefaultTracker.mdx b/src/code-snippets/android/examples/ADJConfig/setDefaultTracker.mdx deleted file mode 100644 index 0a52baf0d..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setDefaultTracker.mdx +++ /dev/null @@ -1,36 +0,0 @@ - - - -```kotlin {4} -val appToken = "{YourAppToken}" -val environment = AdjustConfig.ENVIRONMENT_SANDBOX -val config = AdjustConfig(this, appToken, environment) -config.setDefaultTracker("{Token}") -//... -Adjust.onCreate(config) -``` - - - - -```java {4} -String appToken = "{YourAppToken}"; -String environment = AdjustConfig.ENVIRONMENT_SANDBOX; -AdjustConfig config = new AdjustConfig(this, appToken, environment); -config.setDefaultTracker("{Token}"); -//... -Adjust.onCreate(config); -``` - - - - -```js {4} -var yourAppToken = yourAppToken; -var environment = AdjustConfig.EnvironmentSandbox; -var adjustConfig = new AdjustConfig(yourAppToken, environment); -adjustConfig.setDefaultTracker("{Token}"); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setDelayStart.mdx b/src/code-snippets/android/examples/ADJConfig/setDelayStart.mdx deleted file mode 100644 index b4870b752..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setDelayStart.mdx +++ /dev/null @@ -1,29 +0,0 @@ - - - -```kotlin {2} -val config = AdjustConfig(this, appToken, environment) -config.setDelayStart(5.5) -Adjust.onCreate(config) -``` - - - - -```java {2} -AdjustConfig config = new AdjustConfig(this, appToken, environment); -config.setDelayStart(5.5); -Adjust.onCreate(config); -``` - - - - -```js {2} -var adjustConfig = new AdjustConfig(yourAppToken, environment); -adjustConfig.setDelayStart(5.5); -Adjust.onCreate(adjustConfig); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setEventBufferingEnabled.mdx b/src/code-snippets/android/examples/ADJConfig/setEventBufferingEnabled.mdx deleted file mode 100644 index fef0d3418..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setEventBufferingEnabled.mdx +++ /dev/null @@ -1,36 +0,0 @@ - - - -```kotlin {4} -val appToken = "{YourAppToken}" -val environment = AdjustConfig.ENVIRONMENT_SANDBOX -val config = AdjustConfig(this, appToken, environment) -config.setEventBufferingEnabled(true) -//... -Adjust.onCreate(config) -``` - - - - -```java {4} -String appToken = "{YourAppToken}"; -String environment = AdjustConfig.ENVIRONMENT_SANDBOX; -AdjustConfig config = new AdjustConfig(this, appToken, environment); -config.setEventBufferingEnabled(true); -//... -Adjust.onCreate(config); -``` - - - - -```js {4} -var yourAppToken = yourAppToken; -var environment = AdjustConfig.EnvironmentSandbox; -var adjustConfig = new AdjustConfig(yourAppToken, environment); -adjustConfig.setEventBufferingEnabled(true); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setExternalDeviceId.mdx b/src/code-snippets/android/examples/ADJConfig/setExternalDeviceId.mdx deleted file mode 100644 index 7d04fc585..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setExternalDeviceId.mdx +++ /dev/null @@ -1,38 +0,0 @@ - - - - -```kotlin {4} -val appToken = "{YourAppToken}" -val environment = AdjustConfig.ENVIRONMENT_SANDBOX -val config = AdjustConfig(this, appToken, environment) -config.externalDeviceId("{YourExternalDeviceId}") -//... -Adjust.onCreate(config) -``` - - - - - -```java {4} -String appToken = "{YourAppToken}"; -String environment = AdjustConfig.ENVIRONMENT_SANDBOX; -AdjustConfig config = new AdjustConfig(this, appToken, environment); -config.externalDeviceId("{YourExternalDeviceId}"); -//... -Adjust.onCreate(config); -``` - - - - -```js {4} - var yourAppToken = yourAppToken; - var environment = AdjustConfig.EnvironmentSandbox; - var adjustConfig = new AdjustConfig(yourAppToken, environment); - adjustConfig.setExternalDeviceId("yourExternalDeviceId"); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setLogLevel.mdx b/src/code-snippets/android/examples/ADJConfig/setLogLevel.mdx deleted file mode 100644 index 27904d4c9..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setLogLevel.mdx +++ /dev/null @@ -1,36 +0,0 @@ - - - -```kotlin {4} -val appToken = "{YourAppToken}" -val environment = AdjustConfig.ENVIRONMENT_SANDBOX -val config = AdjustConfig(this, appToken, environment) -config.setLogLevel(LogLevel.VERBOSE) -//... -Adjust.onCreate(config) -``` - - - - -```java {4} -String appToken = "{YourAppToken}"; -String environment = AdjustConfig.ENVIRONMENT_SANDBOX; -AdjustConfig config = new AdjustConfig(this, appToken, environment); -config.setLogLevel(LogLevel.VERBOSE); -//... -Adjust.onCreate(config); -``` - - - - -```js {4} -var yourAppToken = yourAppToken; -var environment = AdjustConfig.EnvironmentSandbox; -var adjustConfig = new AdjustConfig(yourAppToken, environment); -adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setNeedsCost.mdx b/src/code-snippets/android/examples/ADJConfig/setNeedsCost.mdx deleted file mode 100644 index 533614a3b..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setNeedsCost.mdx +++ /dev/null @@ -1,29 +0,0 @@ - - - -```kotlin {2} -val config = AdjustConfig(this, appToken, environment) -config.setNeedsCost(true) -Adjust.onCreate(config) -``` - - - - -```java {2} -AdjustConfig config = new AdjustConfig(this, appToken, environment); -config.setNeedsCost(true); -Adjust.onCreate(config); -``` - - - - -```js {2} -var adjustConfig = new AdjustConfig(yourAppToken, environment); -adjustConfig.setNeedsCost(true); -Adjust.onCreate(adjustConfig); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setOnAttributionChangedListener.mdx b/src/code-snippets/android/examples/ADJConfig/setOnAttributionChangedListener.mdx deleted file mode 100644 index 604f6549b..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setOnAttributionChangedListener.mdx +++ /dev/null @@ -1,40 +0,0 @@ - - - -```kotlin {3-5} -val config = AdjustConfig(this, appToken, environment) -//... -config.setOnAttributionChangedListener { - override fun onAttributionChanged(attribution: AdjustAttribution) {} - } -//... -Adjust.onCreate(config) -``` - - - - -```java {3-6} -AdjustConfig config = new AdjustConfig(this, appToken, environment); -//... -config.setOnAttributionChangedListener(new OnAttributionChangedListener() { - @Override - public void onAttributionChanged(AdjustAttribution attribution) {} -}); -//... -Adjust.onCreate(config); -``` - - - - -```js -function attributionCallback(attribution) {} -//... -let adjustConfig = new AdjustConfig(yourAppToken, environment); -adjustConfig.setAttributionCallback(attributionCallback); -Adjust.onCreate(adjustConfig); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setOnAttributionChangedListenerFacebook.mdx b/src/code-snippets/android/examples/ADJConfig/setOnAttributionChangedListenerFacebook.mdx deleted file mode 100644 index 1b4091108..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setOnAttributionChangedListenerFacebook.mdx +++ /dev/null @@ -1,50 +0,0 @@ - - - -```kotlin {3-14} -val config = AdjustConfig(this, appToken, environment) -//... -config.setOnAttributionChangedListener { - val fbInstallReferrerJSONObject = extractFBInstallReferrerJSON(it) -} - -fun extractFBInstallReferrerJSON(adjustAttribution: AdjustAttribution): JSONObject? { - try { - return JSONObject(adjustAttribution.fbInstallReferrer) - } catch (e: JSONException) { - Log.d("example", e.message!!) - } - return null -} -//... -Adjust.onCreate(config) -``` - - - - -```java {3-18} -AdjustConfig config = new AdjustConfig(this, appToken, environment); -//... -config.setOnAttributionChangedListener(new OnAttributionChangedListener() { - @Override - public void onAttributionChanged(AdjustAttribution adjustAttribution) { - JSONObject fbInstallReferrerJSONObject = extractFBInstallReferrerJSON(adjustAttribution); - } -}); - -@Nullable -JSONObject extractFBInstallReferrerJSON(AdjustAttribution adjustAttribution) { - try { - return new JSONObject(adjustAttribution.fbInstallReferrer); - } catch (JSONException e) { - Log.d("example", e.getMessage()); - } - return null; -} -//... -Adjust.onCreate(config); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setOnDeeplinkResponseListener.mdx b/src/code-snippets/android/examples/ADJConfig/setOnDeeplinkResponseListener.mdx deleted file mode 100644 index 9053eb1ff..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setOnDeeplinkResponseListener.mdx +++ /dev/null @@ -1,53 +0,0 @@ - - - -```kotlin {3-7} -val config = AdjustConfig(this, appToken, environment) -//... -config.setOnDeeplinkResponseListener { deeplink -> - Log.d("example", "Deferred deep link callback called!") - Log.d("example", "Deep link URL: $deeplink") - true -} -//... -Adjust.onCreate(config) -``` - - - - -```java {3-12} -AdjustConfig config = new AdjustConfig(this, appToken, environment); -//... -// Evaluate the deeplink to be launched. -config.setOnDeeplinkResponseListener(new OnDeeplinkResponseListener() { - @Override - public boolean launchReceivedDeeplink(Uri deeplink) { - Log.d("example", "Deferred deep link callback called!"); - Log.d("example", "Deep link URL: " + deeplink); - - return true; - } -}); -//... -Adjust.onCreate(config); -``` - - - - -```js {1-4} -function deferredDeeplinkCallback(deeplink) { - console.log("Deferred deep link callback called!"); - console.log(`Deep link URL: ${deeplink}`); -} -//... -let adjustConfig = new AdjustConfig(yourAppToken, environment); -adjustConfig.setOpenDeferredDeeplink(true); -adjustConfig.setDeferredDeeplinkCallback(deferredDeeplinkCallback); -//... -Adjust.start(adjustConfig); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setOnEventTrackingFailedListener.mdx b/src/code-snippets/android/examples/ADJConfig/setOnEventTrackingFailedListener.mdx deleted file mode 100644 index c2bc88bff..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setOnEventTrackingFailedListener.mdx +++ /dev/null @@ -1,45 +0,0 @@ - - - -```kotlin {3-7} -val config = AdjustConfig(this, appToken, environment) -//... -config.setOnEventTrackingFailedListener (OnEventTrackingFailedListener() { - override fun onFinishedEventTrackingFailed(eventFailureResponseData: AdjustEventFailure) { - //... - } -}) -//... -Adjust.onCreate(config) -``` - - - - -```java {3-8} -AdjustConfig config = new AdjustConfig(this, appToken, environment); -//... -config.setOnEventTrackingFailedListener(new OnEventTrackingFailedListener() { - @Override - public void onFinishedEventTrackingFailed(AdjustEventFailure eventFailureResponseData) { - //... - } -}); -//... -Adjust.onCreate(config) -``` - - - - -```js -function eventFailureCallback(eventFailureResponseData) {} -//... -let adjustConfig = new AdjustConfig(appToken, environment); -adjustConfig.setEventFailureCallback(eventFailureCallback); -//... -Adjust.onCreate(adjustConfig); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setOnEventTrackingFailedListenerExample.mdx b/src/code-snippets/android/examples/ADJConfig/setOnEventTrackingFailedListenerExample.mdx deleted file mode 100644 index 2488a7b23..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setOnEventTrackingFailedListenerExample.mdx +++ /dev/null @@ -1,47 +0,0 @@ - - - -```kotlin -val config = AdjustConfig(this, appToken, environment) - -config.setOnEventTrackingFailedListener(new OnEventTrackingFailedListener() { - override fun eventFailure(eventFailureResponseData: AdjustEventFailure) { - Log.v("Event recording failed. Response: " + eventFailureResponseData.Message) - } -}) - -Adjust.onCreate(config) -``` - - - - -```java -AdjustConfig config = new AdjustConfig(this, appToken, environment); - -config.setOnEventTrackingFailedListener(new OnEventTrackingFailedListener() { - @Override - public void eventFailure(AdjustEventFailure eventFailureResponseData) { - Log.v("Event recording failed. Response: " + eventFailureResponseData.Message) - } -}); - -Adjust.onCreate(config) -``` - - - - -```js -function eventFailure(eventFailureResponseData) { - console.log('Event recording failed. Response: ' + eventFailureResponseData.Message) -} - -let adjustConfig = new AdjustConfig(appToken, environment); -adjustConfig.setEventFailureCallback(sessionFailure); - -Adjust.onCreate(adjustConfig); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setOnEventTrackingSucceededListener.mdx b/src/code-snippets/android/examples/ADJConfig/setOnEventTrackingSucceededListener.mdx deleted file mode 100644 index bcdc3d825..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setOnEventTrackingSucceededListener.mdx +++ /dev/null @@ -1,45 +0,0 @@ - - - -```kotlin {3-7} -val config = AdjustConfig(this, appToken, environment) -//... -config.setOnEventTrackingSucceededListener(new OnEventTrackingSucceededListener() { - override fun onFinishedEventTrackingSucceeded(eventSuccessResponseData: AdjustEventSuccess) { - //... - } -}) -//... -Adjust.onCreate(config) -``` - - - - -```java {3-8} -AdjustConfig config = new AdjustConfig(this, appToken, environment); -//... -config.setOnEventTrackingSucceededListener(new OnEventTrackingSucceededListener() { - @Override - public void onFinishedEventTrackingSucceeded(AdjustEventSuccess eventSuccessResponseData) { - //... - } -}); -//... -Adjust.onCreate(config) -``` - - - - -```js -function eventSuccessCallback(eventSuccessResponseData) {} -//... -let adjustConfig = new AdjustConfig(appToken, environment); -adjustConfig.setEventSuccessCallback(eventSuccessCallback); -//... -Adjust.onCreate(adjustConfig); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setOnEventTrackingSucceededListenerExample.mdx b/src/code-snippets/android/examples/ADJConfig/setOnEventTrackingSucceededListenerExample.mdx deleted file mode 100644 index 199d2f64a..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setOnEventTrackingSucceededListenerExample.mdx +++ /dev/null @@ -1,47 +0,0 @@ - - - -```kotlin -val config = AdjustConfig(this, appToken, environment) - -config.setOnEventTrackingSucceededListener(new OnEventTrackingSucceededListener() { - override fun eventSuccess(eventSuccessResponseData: AdjustEventSuccess) { - Log.v("Event recorded at " + eventSuccessResponseData.Timestamp) - } -}) - -Adjust.onCreate(config) -``` - - - - -```java -AdjustConfig config = new AdjustConfig(this, appToken, environment); - -config.setOnEventTrackingSucceededListener(new OnEventTrackingSucceededListener() { - @Override - public void eventSuccess(AdjustEventSuccess eventSuccessResponseData) { - Log.v("Event recorded at " + eventSuccessResponseData.Timestamp) - } -}); - -Adjust.onCreate(config) -``` - - - - -```js -function eventSuccess(eventSuccessResponseData) { - console.log('Event recorded at ' + eventSuccessResponseData.Timestamp) -} - -let adjustConfig = new AdjustConfig(appToken, environment); -adjustConfig.setEventSuccessCallback(eventSuccess); - -Adjust.onCreate(adjustConfig); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setOnSessionTrackingFailedListener.mdx b/src/code-snippets/android/examples/ADJConfig/setOnSessionTrackingFailedListener.mdx deleted file mode 100644 index 743eccc9b..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setOnSessionTrackingFailedListener.mdx +++ /dev/null @@ -1,45 +0,0 @@ - - - -```kotlin {3-7} -val config = AdjustConfig(this, appToken, environment) -//... -config.setOnSessionTrackingFailedListener(new OnSessionTrackingFailedListener() { - override fun onFinishedSessionTrackingFailed(sessionFailureResponseData: AdjustSessionFailure) { - //... - } -}) -//... -Adjust.onCreate(config) -``` - - - - -```java {3-8} -AdjustConfig config = new AdjustConfig(this, appToken, environment); -//... -config.setOnSessionTrackingFailedListener(new OnSessionTrackingFailedListener() { - @Override - public void onFinishedSessionTrackingFailed(AdjustSessionFailure sessionFailureResponseData) { - //... - } -}); -//... -Adjust.onCreate(config) -``` - - - - -```js -function sessionFailureCallback(sessionFailureResponseData) {} -//... -let adjustConfig = new AdjustConfig(appToken, environment); -adjustConfig.setSessionFailureCallback(sessionFailureCallback); -//... -Adjust.onCreate(adjustConfig); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setOnSessionTrackingFailedListenerExample.mdx b/src/code-snippets/android/examples/ADJConfig/setOnSessionTrackingFailedListenerExample.mdx deleted file mode 100644 index 7682e1ef7..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setOnSessionTrackingFailedListenerExample.mdx +++ /dev/null @@ -1,47 +0,0 @@ - - - -```kotlin -val config = AdjustConfig(this, appToken, environment) - -config.setOnSessionTrackingFailedListener(new OnSessionTrackingFailedListener() { - override fun sessionFailure(sessionFailureResponseData: AdjustSessionFailure) { - Log.v("Session recording failed. Response: " + sessionFailureResponseData.Message) - } -}) - -Adjust.onCreate(config) -``` - - - - -```java -AdjustConfig config = new AdjustConfig(this, appToken, environment); - -config.setOnSessionTrackingFailedListener(new OnSessionTrackingFailedListener() { - @Override - public void sessionFailure(AdjustSessionFailure sessionFailureResponseData) { - Log.v("Session recording failed. Response: " + sessionFailureResponseData.Message) - } -}); - -Adjust.onCreate(config) -``` - - - - -```js -function sessionFailure(sessionFailureResponseData) { - console.log('Session recording failed. Response: ' + sessionFailureResponseData.Message) -} - -let adjustConfig = new AdjustConfig(appToken, environment); -adjustConfig.setSessionFailureCallback(sessionFailure); - -Adjust.onCreate(adjustConfig); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setOnSessionTrackingSucceededListener.mdx b/src/code-snippets/android/examples/ADJConfig/setOnSessionTrackingSucceededListener.mdx deleted file mode 100644 index 1473e9c9f..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setOnSessionTrackingSucceededListener.mdx +++ /dev/null @@ -1,45 +0,0 @@ - - - -```kotlin {3-7} -val config = AdjustConfig(this, appToken, environment) -//... -config.setOnSessionTrackingSucceededListener(new OnSessionTrackingSucceededListener() { - override fun onFinishedSessionTrackingSucceeded(sessionSuccessResponseData: AdjustSessionSuccess) { - //... - } -}) -//... -Adjust.onCreate(config) -``` - - - - -```java {3-8} -AdjustConfig config = new AdjustConfig(this, appToken, environment); -//... -config.setOnSessionTrackingSucceededListener(new OnSessionTrackingSucceededListener() { - @Override - public void onFinishedSessionTrackingSucceeded(AdjustSessionSuccess sessionSuccessResponseData) { - //... - } -}); -//... -Adjust.onCreate(config) -``` - - - - -```js -function sessionSuccessCallback(sessionSuccessResponseData) {} -//... -let adjustConfig = new AdjustConfig(appToken, environment); -adjustConfig.setSessionSuccessCallback(sessionSuccessCallback); -//... -Adjust.onCreate(adjustConfig); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setOnSessionTrackingSucceededListenerExample.mdx b/src/code-snippets/android/examples/ADJConfig/setOnSessionTrackingSucceededListenerExample.mdx deleted file mode 100644 index 0cbde5413..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setOnSessionTrackingSucceededListenerExample.mdx +++ /dev/null @@ -1,47 +0,0 @@ - - - -```kotlin -val config = AdjustConfig(this, appToken, environment) - -config.setOnSessionTrackingSucceededListener(new OnSessionTrackingSucceededListener() { - override fun sessionSuccess(sessionSuccessResponseData: AdjustSessionSuccess) { - Log.v("Session recorded at " + sessionSuccessResponseData.Timestamp) - } -}) - -Adjust.onCreate(config) -``` - - - - -```java -AdjustConfig config = new AdjustConfig(this, appToken, environment); - -config.setOnSessionTrackingSucceededListener(new OnSessionTrackingSucceededListener() { - @Override - public void sessionSuccess(AdjustSessionSuccess sessionSuccessResponseData) { - Log.v("Session recorded at " + sessionSuccessResponseData.Timestamp) - } -}); - -Adjust.onCreate(config) -``` - - - - -```js -function sessionSuccess(sessionSuccessResponseData) { - console.log('Session recorded at ' + sessionSuccessResponseData.Timestamp) -} - -let adjustConfig = new AdjustConfig(appToken, environment); -adjustConfig.setSessionSuccessCallback(sessionSuccess); - -Adjust.onCreate(adjustConfig); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setPlayStoreKidsAppEnabled.mdx b/src/code-snippets/android/examples/ADJConfig/setPlayStoreKidsAppEnabled.mdx deleted file mode 100644 index 89df82528..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setPlayStoreKidsAppEnabled.mdx +++ /dev/null @@ -1,36 +0,0 @@ - - - -```kotlin {4} -val appToken = "{YourAppToken}" -val environment = AdjustConfig.ENVIRONMENT_SANDBOX -val config = AdjustConfig(this, appToken, environment) -config.setPlayStoreKidsAppEnabled(true) -//... -Adjust.onCreate(config) -``` - - - - -```java {4} -String appToken = "{YourAppToken}"; -String environment = AdjustConfig.ENVIRONMENT_SANDBOX; -AdjustConfig config = new AdjustConfig(this, appToken, environment); -config.setPlayStoreKidsAppEnabled(true); -//... -Adjust.onCreate(config); -``` - - - - -```js {4} -var yourAppToken = yourAppToken; -var environment = AdjustConfig.EnvironmentSandbox; -var adjustConfig = new AdjustConfig(yourAppToken, environment); -adjustConfig.setPlayStoreKidsAppEnabled(true); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setPreinstallFilePath.mdx b/src/code-snippets/android/examples/ADJConfig/setPreinstallFilePath.mdx deleted file mode 100644 index f0c25c9ee..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setPreinstallFilePath.mdx +++ /dev/null @@ -1,36 +0,0 @@ - - - -```kotlin {4} -val appToken = "{YourAppToken}" -val environment = AdjustConfig.ENVIRONMENT_SANDBOX -val config = AdjustConfig(this, appToken, environment) -config.setPreinstallFilePath("../EngagementFile.xml") -//... -Adjust.onCreate(config) -``` - - - - -```java {4} -String appToken = "{YourAppToken}"; -String environment = AdjustConfig.ENVIRONMENT_SANDBOX; -AdjustConfig config = new AdjustConfig(this, appToken, environment); -config.setPreinstallFilePath("../EngagementFile.xml"); -//... -Adjust.onCreate(config); -``` - - - - -```js {4} -var yourAppToken = yourAppToken; -var environment = AdjustConfig.EnvironmentSandbox; -var adjustConfig = new AdjustConfig(yourAppToken, environment); -adjustConfig.setPreinstallFilePath("../EngagementFile.xml"); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setPreinstallTrackingEnabled.mdx b/src/code-snippets/android/examples/ADJConfig/setPreinstallTrackingEnabled.mdx deleted file mode 100644 index 3d9776b7f..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setPreinstallTrackingEnabled.mdx +++ /dev/null @@ -1,36 +0,0 @@ - - - -```kotlin {4} -val appToken = "{YourAppToken}" -val environment = AdjustConfig.ENVIRONMENT_SANDBOX -val config = AdjustConfig(this, appToken, environment) -config.setPreinstallTrackingEnabled(true) -//... -Adjust.onCreate(config) -``` - - - - -```java {4} -String appToken = "{YourAppToken}"; -String environment = AdjustConfig.ENVIRONMENT_SANDBOX; -AdjustConfig config = new AdjustConfig(this, appToken, environment); -config.setPreinstallTrackingEnabled(true); -//... -Adjust.onCreate(config); -``` - - - - -```js {4} -var yourAppToken = yourAppToken; -var environment = AdjustConfig.EnvironmentSandbox; -var adjustConfig = new AdjustConfig(yourAppToken, environment); -adjustConfig.setPreinstallTrackingEnabled(true); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setSendInBackground.mdx b/src/code-snippets/android/examples/ADJConfig/setSendInBackground.mdx deleted file mode 100644 index a58406f87..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setSendInBackground.mdx +++ /dev/null @@ -1,36 +0,0 @@ - - - -```kotlin {4} -val appToken = "{YourAppToken}" -val environment = AdjustConfig.ENVIRONMENT_SANDBOX -val config = AdjustConfig(this, appToken, environment) -config.setSendInBackground(true) -//... -Adjust.onCreate(config) -``` - - - - -```java {4} -String appToken = "{YourAppToken}"; -String environment = AdjustConfig.ENVIRONMENT_SANDBOX; -AdjustConfig config = new AdjustConfig(this, appToken, environment); -config.setSendInBackground(true); -//... -Adjust.onCreate(config); -``` - - - - -```js {4} -var yourAppToken = yourAppToken; -var environment = AdjustConfig.EnvironmentSandbox; -var adjustConfig = new AdjustConfig(yourAppToken, environment); -adjustConfig.setSendInBackground(true); -``` - - - diff --git a/src/code-snippets/android/examples/ADJConfig/setUrlStrategy.mdx b/src/code-snippets/android/examples/ADJConfig/setUrlStrategy.mdx deleted file mode 100644 index e40037d34..000000000 --- a/src/code-snippets/android/examples/ADJConfig/setUrlStrategy.mdx +++ /dev/null @@ -1,36 +0,0 @@ - - - -```kotlin {4} -val appToken = "{YourAppToken}" -val environment = AdjustConfig.ENVIRONMENT_SANDBOX -val config = AdjustConfig(this, appToken, environment) -config.setUrlStrategy(AdjustConfig.DATA_RESIDENCY_EU) -//... -Adjust.onCreate(config) -``` - - - - -```java {4} -String appToken = "{YourAppToken}"; -String environment = AdjustConfig.ENVIRONMENT_SANDBOX; -AdjustConfig config = new AdjustConfig(this, appToken, environment); -config.setUrlStrategy(AdjustConfig.DATA_RESIDENCY_EU); -//... -Adjust.onCreate(config); -``` - - - - -```js {4} -var yourAppToken = yourAppToken; -var environment = AdjustConfig.EnvironmentSandbox; -var adjustConfig = new AdjustConfig(yourAppToken, environment); -adjustConfig.setUrlStrategy(AdjustConfig.DATA_RESIDENCY_EU); -``` - - - diff --git a/src/code-snippets/android/examples/ADJEvent/addCallbackParameter.mdx b/src/code-snippets/android/examples/ADJEvent/addCallbackParameter.mdx deleted file mode 100644 index 483ba3202..000000000 --- a/src/code-snippets/android/examples/ADJEvent/addCallbackParameter.mdx +++ /dev/null @@ -1,33 +0,0 @@ - - - -```kotlin -val adjustEvent = AdjustEvent("abc123") -adjustEvent.addCallbackParameter("key", "value") -adjustEvent.addCallbackParameter("foo", "bar") -Adjust.trackEvent(adjustEvent) -``` - - - - - -```java -AdjustEvent adjustEvent = new AdjustEvent("abc123"); -adjustEvent.addCallbackParameter("key", "value"); -adjustEvent.addCallbackParameter("foo", "bar"); -Adjust.trackEvent(adjustEvent); -``` - - - - -```js -let adjustEvent = new AdjustEvent('abc123'); -adjustEvent.addCallbackParameter('key', 'value'); -adjustEvent.addCallbackParameter('foo', 'bar'); -Adjust.trackEvent(adjustEvent); -``` - - - diff --git a/src/code-snippets/android/examples/ADJEvent/addCallbackParameterExample.mdx b/src/code-snippets/android/examples/ADJEvent/addCallbackParameterExample.mdx deleted file mode 100644 index 1e3238acc..000000000 --- a/src/code-snippets/android/examples/ADJEvent/addCallbackParameterExample.mdx +++ /dev/null @@ -1,43 +0,0 @@ - - - -```kotlin -fun onTrackUniqueEventClick(v: View) { - val event = AdjustEvent("g3mfiw") - event.addCallbackParameter("event_token", "g3mfiw") - event.addCallbackParameter("revenue_amount", "0.05") - Adjust.trackEvent(event) -} -``` - - - - - -```java -public void onTrackUniqueEventClick(View v) { - AdjustEvent event = new AdjustEvent("g3mfiw"); - event.addCallbackParameter("event_token", "g3mfiw"); - event.addCallbackParameter("revenue_amount", "0.05"); - Adjust.trackEvent(event); -} -``` - - - - -```js -window.onload = function() { - var btnTrackUniqueEvent = document.getElementById('btnTrackUniqueEvent') - btnTrackUniqueEvent.onclick = function(e) { - e.preventDefault(); - var adjustEvent = new AdjustEvent('g3mfiw'); - adjustEvent.addCallbackParameter('event_token', 'g3mfiw'); - adjustEvent.addCallbackParameter('revenue_amount', '0.05'); - Adjust.trackEvent(adjustEvent); - } -} -``` - - - diff --git a/src/code-snippets/android/examples/ADJEvent/addPartnerParameter.mdx b/src/code-snippets/android/examples/ADJEvent/addPartnerParameter.mdx deleted file mode 100644 index 1770da9a8..000000000 --- a/src/code-snippets/android/examples/ADJEvent/addPartnerParameter.mdx +++ /dev/null @@ -1,33 +0,0 @@ - - - -```kotlin -val adjustEvent = AdjustEvent("abc123") -adjustEvent.addPartnerParameter("key", "value") -adjustEvent.addPartnerParameter("foo", "bar") -Adjust.trackEvent(adjustEvent) -``` - - - - - -```java -AdjustEvent adjustEvent = new AdjustEvent("abc123"); -adjustEvent.addPartnerParameter("key", "value"); -adjustEvent.addPartnerParameter("foo", "bar"); -Adjust.trackEvent(adjustEvent); -``` - - - - -```js -let adjustEvent = new AdjustEvent('abc123'); -adjustEvent.addPartnerParameter('key', 'value'); -adjustEvent.addPartnerParameter('foo', 'bar'); -Adjust.trackEvent(adjustEvent); -``` - - - diff --git a/src/code-snippets/android/examples/ADJEvent/addPartnerParameterExample.mdx b/src/code-snippets/android/examples/ADJEvent/addPartnerParameterExample.mdx deleted file mode 100644 index 34fca14a1..000000000 --- a/src/code-snippets/android/examples/ADJEvent/addPartnerParameterExample.mdx +++ /dev/null @@ -1,43 +0,0 @@ - - - -```kotlin -fun onTrackUniqueEventClick(v: View) { - val event = AdjustEvent("g3mfiw") - event.addPartnerParameter("product_id", "29") - event.addPartnerParameter("user_id", "835") - Adjust.trackEvent(event) -} -``` - - - - - -```java -public void onTrackUniqueEventClick(View v) { - AdjustEvent event = new AdjustEvent("g3mfiw"); - event.addPartnerParameter("product_id", "29"); - event.addPartnerParameter("user_id", "835"); - Adjust.trackEvent(event); -} -``` - - - - -```js -window.onload = function() { - var btnTrackUniqueEvent = document.getElementById('btnTrackUniqueEvent') - btnTrackUniqueEvent.onclick = function(e) { - e.preventDefault(); - var adjustEvent = new AdjustEvent('g3mfiw'); - adjustEvent.addPartnerParameter('product_id', '29'); - adjustEvent.addPartnerParameter('user_id', '835'); - Adjust.trackEvent(adjustEvent); - } -} -``` - - - diff --git a/src/code-snippets/android/examples/ADJEvent/constructor.mdx b/src/code-snippets/android/examples/ADJEvent/constructor.mdx deleted file mode 100644 index 35c1af6af..000000000 --- a/src/code-snippets/android/examples/ADJEvent/constructor.mdx +++ /dev/null @@ -1,27 +0,0 @@ - - - -```kotlin -val adjustEvent = AdjustEvent("abc123") -Adjust.trackEvent(adjustEvent) -``` - - - - - -```java -AdjustEvent adjustEvent = new AdjustEvent("abc123"); -Adjust.trackEvent(adjustEvent); -``` - - - - -```js -let adjustEvent = new AdjustEvent('abc123'); -Adjust.trackEvent(adjustEvent); -``` - - - diff --git a/src/code-snippets/android/examples/ADJEvent/setCallbackId.mdx b/src/code-snippets/android/examples/ADJEvent/setCallbackId.mdx deleted file mode 100644 index 228fc59a2..000000000 --- a/src/code-snippets/android/examples/ADJEvent/setCallbackId.mdx +++ /dev/null @@ -1,30 +0,0 @@ - - - -```kotlin -val adjustEvent = AdjustEvent("abc123") -adjustEvent.setCallbackId("{Your-Custom-Id}") -Adjust.trackEvent(adjustEvent) -``` - - - - - -```java -AdjustEvent adjustEvent = new AdjustEvent("abc123"); -adjustEvent.setCallbackId("{Your-Custom-Id}"); -Adjust.trackEvent(adjustEvent); -``` - - - - -```js -let adjustEvent = new AdjustEvent('abc123'); -adjustEvent.setCallbackId('{Your-Custom-Id}'); -Adjust.trackEvent(adjustEvent); -``` - - - diff --git a/src/code-snippets/android/examples/ADJEvent/setCallbackIdExample.mdx b/src/code-snippets/android/examples/ADJEvent/setCallbackIdExample.mdx deleted file mode 100644 index bb09b7d74..000000000 --- a/src/code-snippets/android/examples/ADJEvent/setCallbackIdExample.mdx +++ /dev/null @@ -1,40 +0,0 @@ - - - -```kotlin -fun onTrackUniqueEventClick(v: View) { - val event = AdjustEvent("g3mfiw") - event.setCallbackId("f2e728d8-271b-49ab-80ea-27830a215147") - Adjust.trackEvent(event) -} -``` - - - - - -```java -public void onTrackUniqueEventClick(View v) { - AdjustEvent event = new AdjustEvent("g3mfiw"); - event.setCallbackId("f2e728d8-271b-49ab-80ea-27830a215147") - Adjust.trackEvent(event); -} -``` - - - - -```js -window.onload = function() { - var btnTrackUniqueEvent = document.getElementById('btnTrackUniqueEvent') - btnTrackUniqueEvent.onclick = function(e) { - e.preventDefault(); - var adjustEvent = new AdjustEvent('g3mfiw'); - adjustEvent.setCallbackId('f2e728d8-271b-49ab-80ea-27830a215147') - Adjust.trackEvent(adjustEvent); - } -} -``` - - - diff --git a/src/code-snippets/android/examples/ADJEvent/setOrderId.mdx b/src/code-snippets/android/examples/ADJEvent/setOrderId.mdx deleted file mode 100644 index 86bab681c..000000000 --- a/src/code-snippets/android/examples/ADJEvent/setOrderId.mdx +++ /dev/null @@ -1,33 +0,0 @@ - - - -```kotlin -val adjustEvent = AdjustEvent("abc123") -adjustEvent.setRevenue(0.01, "EUR") -adjustEvent.setOrderId("{OrderId}") -Adjust.trackEvent(adjustEvent) -``` - - - - - -```java -AdjustEvent adjustEvent = new AdjustEvent("abc123"); -adjustEvent.setRevenue(0.01, "EUR"); -adjustEvent.setOrderId("{OrderId}"); -Adjust.trackEvent(adjustEvent); -``` - - - - -```js -let adjustEvent = new AdjustEvent('abc123'); -adjustEvent.setRevenue(0.01, 'EUR'); -adjustEvent.setOrderId('{OrderId}'); -Adjust.trackEvent(event); -``` - - - diff --git a/src/code-snippets/android/examples/ADJEvent/setOrderIdExample.mdx b/src/code-snippets/android/examples/ADJEvent/setOrderIdExample.mdx deleted file mode 100644 index eb68d5451..000000000 --- a/src/code-snippets/android/examples/ADJEvent/setOrderIdExample.mdx +++ /dev/null @@ -1,40 +0,0 @@ - - - -```kotlin -fun onTrackUniqueEventClick(v: View) { - val event = AdjustEvent("g3mfiw") - event.setOrderId("5e85484b-1ebc-4141-aab7-25b869e54c49") - Adjust.trackEvent(event) -} -``` - - - - - -```java -public void onTrackUniqueEventClick(View v) { - AdjustEvent event = new AdjustEvent("g3mfiw"); - event.setOrderId("5e85484b-1ebc-4141-aab7-25b869e54c49") - Adjust.trackEvent(event); -} -``` - - - - -```js -window.onload = function() { - var btnTrackUniqueEvent = document.getElementById('btnTrackUniqueEvent') - btnTrackUniqueEvent.onclick = function(e) { - e.preventDefault(); - var adjustEvent = new AdjustEvent('g3mfiw'); - adjustEvent.setOrderId('5e85484b-1ebc-4141-aab7-25b869e54c49'); - Adjust.trackEvent(adjustEvent); - } -} -``` - - - diff --git a/src/code-snippets/android/examples/ADJEvent/setRevenue.mdx b/src/code-snippets/android/examples/ADJEvent/setRevenue.mdx deleted file mode 100644 index 2cb293e45..000000000 --- a/src/code-snippets/android/examples/ADJEvent/setRevenue.mdx +++ /dev/null @@ -1,30 +0,0 @@ - - - -```kotlin -val adjustEvent = AdjustEvent("abc123") -adjustEvent.setRevenue(0.01, "EUR") -Adjust.trackEvent(adjustEvent) -``` - - - - - -```java -AdjustEvent adjustEvent = new AdjustEvent("abc123"); -adjustEvent.setRevenue(0.01, "EUR"); -Adjust.trackEvent(adjustEvent); -``` - - - - -```js -let adjustEvent = new AdjustEvent('abc123'); -adjustEvent.setRevenue(0.01, 'EUR'); -Adjust.trackEvent(adjustEvent); -``` - - - diff --git a/src/code-snippets/android/examples/ADJEvent/setRevenueExample.mdx b/src/code-snippets/android/examples/ADJEvent/setRevenueExample.mdx deleted file mode 100644 index a79f7e2cd..000000000 --- a/src/code-snippets/android/examples/ADJEvent/setRevenueExample.mdx +++ /dev/null @@ -1,40 +0,0 @@ - - - -```kotlin -fun onTrackRevenueEventClick(v: View) { - val event = AdjustEvent("g3mfiw") - event.setRevenue(0.25, "EUR") - Adjust.trackEvent(event) -} -``` - - - - - -```java -public void onTrackRevenueEventClick(View v) { - AdjustEvent event = new AdjustEvent("g3mfiw"); - event.setRevenue(0.25, "EUR") - Adjust.trackEvent(event); -} -``` - - - - -```js -window.onload = function() { - var btnTrackRevenueEvent = document.getElementById('btnTrackRevenueEvent') - btnTrackRevenueEvent.onclick = function(e) { - e.preventDefault(); - var adjustEvent = new AdjustEvent('g3mfiw'); - adjustEvent.setRevenue(0.25, 'EUR'); - Adjust.trackEvent(adjustEvent); - } -} -``` - - - diff --git a/src/code-snippets/android/examples/ADJPlayStoreSubscription/addCallbackParameter.mdx b/src/code-snippets/android/examples/ADJPlayStoreSubscription/addCallbackParameter.mdx deleted file mode 100644 index 7c07fd228..000000000 --- a/src/code-snippets/android/examples/ADJPlayStoreSubscription/addCallbackParameter.mdx +++ /dev/null @@ -1,19 +0,0 @@ - - - -```kotlin -subscription.addCallbackParameter("key", "value") -subscription.addCallbackParameter("foo", "bar") -``` - - - - - -```java -subscription.addCallbackParameter("key", "value"); -subscription.addCallbackParameter("foo", "bar"); -``` - - - diff --git a/src/code-snippets/android/examples/ADJPlayStoreSubscription/addPartnerParameter.mdx b/src/code-snippets/android/examples/ADJPlayStoreSubscription/addPartnerParameter.mdx deleted file mode 100644 index afcec6878..000000000 --- a/src/code-snippets/android/examples/ADJPlayStoreSubscription/addPartnerParameter.mdx +++ /dev/null @@ -1,19 +0,0 @@ - - - -```kotlin -subscription.addPartnerParameter("key", "value") -subscription.addPartnerParameter("foo", "bar") -``` - - - - - -```java -subscription.addPartnerParameter("key", "value"); -subscription.addPartnerParameter("foo", "bar"); -``` - - - diff --git a/src/code-snippets/android/examples/ADJPlayStoreSubscription/constructor.mdx b/src/code-snippets/android/examples/ADJPlayStoreSubscription/constructor.mdx deleted file mode 100644 index 53ce72a7c..000000000 --- a/src/code-snippets/android/examples/ADJPlayStoreSubscription/constructor.mdx +++ /dev/null @@ -1,35 +0,0 @@ - - - -```kotlin -val subscription = AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken); -subscription.setPurchaseTime(purchaseTime) - -Adjust.trackPlayStoreSubscription(subscription) -``` - - - - - -```java -AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken); -subscription.setPurchaseTime(purchaseTime); - -Adjust.trackPlayStoreSubscription(subscription); -``` - - - diff --git a/src/code-snippets/android/examples/ADJPlayStoreSubscription/setPurchaseTime.mdx b/src/code-snippets/android/examples/ADJPlayStoreSubscription/setPurchaseTime.mdx deleted file mode 100644 index 59b7375da..000000000 --- a/src/code-snippets/android/examples/ADJPlayStoreSubscription/setPurchaseTime.mdx +++ /dev/null @@ -1,17 +0,0 @@ - - - -```kotlin -subscription.setPurchaseTime("1677668234") -``` - - - - - -```java -subscription.setPurchaseTime("1677668234"); -``` - - - diff --git a/src/code-snippets/android/examples/ADJThirdPartySharing/addGranularOption.mdx b/src/code-snippets/android/examples/ADJThirdPartySharing/addGranularOption.mdx deleted file mode 100644 index 25ddb33e3..000000000 --- a/src/code-snippets/android/examples/ADJThirdPartySharing/addGranularOption.mdx +++ /dev/null @@ -1,31 +0,0 @@ - - - -```kotlin -val adjustThirdPartySharing = AdjustThirdPartySharing(true) -adjustThirdPartySharing.addGranularOption("PartnerA", "foo", "bar") -Adjust.trackThirdPartySharing(adjustThirdPartySharing) -``` - - - - - -```java -AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true); -adjustThirdPartySharing.addGranularOption("PartnerA", "foo", "bar"); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - - - - - -```js -let adjustThirdPartySharing = new AdjustThirdPartySharing(true); -adjustThirdPartySharing.addGranularOption('PartnerA', 'foo', 'bar'); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - - - diff --git a/src/code-snippets/android/examples/ADJThirdPartySharing/addGranularOptionFacebook.mdx b/src/code-snippets/android/examples/ADJThirdPartySharing/addGranularOptionFacebook.mdx deleted file mode 100644 index a32be48ec..000000000 --- a/src/code-snippets/android/examples/ADJThirdPartySharing/addGranularOptionFacebook.mdx +++ /dev/null @@ -1,34 +0,0 @@ - - - -```kotlin -val adjustThirdPartySharing = AdjustThirdPartySharing(true) -adjustThirdPartySharing.addGranularOption("facebook", "data_processing_options_country", "1") -adjustThirdPartySharing.addGranularOption("facebook", "data_processing_options_state", "1000") -Adjust.trackThirdPartySharing(adjustThirdPartySharing) -``` - - - - - -```java -AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true); -adjustThirdPartySharing.addGranularOption("facebook", "data_processing_options_country", "1"); -adjustThirdPartySharing.addGranularOption("facebook", "data_processing_options_state", "1000"); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - - - - - -```js -let adjustThirdPartySharing = new AdjustThirdPartySharing(true); -adjustThirdPartySharing.addGranularOption('facebook', 'data_processing_options_country', '1'); -adjustThirdPartySharing.addGranularOption('facebook', 'data_processing_options_state', '1000'); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - - - diff --git a/src/code-snippets/android/examples/ADJThirdPartySharing/addPartnerSharingSetting.mdx b/src/code-snippets/android/examples/ADJThirdPartySharing/addPartnerSharingSetting.mdx deleted file mode 100644 index 3aef9c3a3..000000000 --- a/src/code-snippets/android/examples/ADJThirdPartySharing/addPartnerSharingSetting.mdx +++ /dev/null @@ -1,37 +0,0 @@ - - - -```kotlin -val adjustThirdPartySharing = AdjustThirdPartySharing(true) -adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "install", true) -adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "events", true) -adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "sessions", true) -Adjust.trackThirdPartySharing(adjustThirdPartySharing) -``` - - - - - -```java -AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true); -adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "install", true); -adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "events", true); -adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "sessions", true); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - - - - - -```js -let adjustThirdPartySharing = new AdjustThirdPartySharing(true); -adjustThirdPartySharing.addPartnerSharingSetting('PartnerA', 'install', true); -adjustThirdPartySharing.addPartnerSharingSetting('PartnerA', 'events', true); -adjustThirdPartySharing.addPartnerSharingSetting('PartnerA', 'sessions', true); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - - - diff --git a/src/code-snippets/android/examples/ADJThirdPartySharing/adjustThirdPartySharingIsEnabledFalse.mdx b/src/code-snippets/android/examples/ADJThirdPartySharing/adjustThirdPartySharingIsEnabledFalse.mdx deleted file mode 100644 index a6c17c4ef..000000000 --- a/src/code-snippets/android/examples/ADJThirdPartySharing/adjustThirdPartySharingIsEnabledFalse.mdx +++ /dev/null @@ -1,28 +0,0 @@ - - - -```kotlin -val adjustThirdPartySharing = AdjustThirdPartySharing(false) -Adjust.trackThirdPartySharing(adjustThirdPartySharing) -``` - - - - - -```java -AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(false); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - - - - - -```js -let adjustThirdPartySharing = new AdjustThirdPartySharing(false); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - - - diff --git a/src/code-snippets/android/examples/ADJThirdPartySharing/adjustThirdPartySharingIsEnabledTrue.mdx b/src/code-snippets/android/examples/ADJThirdPartySharing/adjustThirdPartySharingIsEnabledTrue.mdx deleted file mode 100644 index 9aab09a45..000000000 --- a/src/code-snippets/android/examples/ADJThirdPartySharing/adjustThirdPartySharingIsEnabledTrue.mdx +++ /dev/null @@ -1,28 +0,0 @@ - - - -```kotlin -val adjustThirdPartySharing = AdjustThirdPartySharing(true) -Adjust.trackThirdPartySharing(adjustThirdPartySharing) -``` - - - - - -```java -AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - - - - - -```js -let adjustThirdPartySharing = new AdjustThirdPartySharing(true); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/addSessionCallbackParameter.mdx b/src/code-snippets/android/examples/Adjust/addSessionCallbackParameter.mdx deleted file mode 100644 index e60b27619..000000000 --- a/src/code-snippets/android/examples/Adjust/addSessionCallbackParameter.mdx +++ /dev/null @@ -1,25 +0,0 @@ - - - -```kotlin -Adjust.addSessionCallbackParameter("foo", "bar") -``` - - - - - -```java -Adjust.addSessionCallbackParameter("foo", "bar"); -``` - - - - - -```js -Adjust.addSessionCallbackParameter("foo", "bar"); -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/addSessionPartnerParameter.mdx b/src/code-snippets/android/examples/Adjust/addSessionPartnerParameter.mdx deleted file mode 100644 index ac70b2a44..000000000 --- a/src/code-snippets/android/examples/Adjust/addSessionPartnerParameter.mdx +++ /dev/null @@ -1,25 +0,0 @@ - - - -```kotlin -Adjust.addSessionPartnerParameter("foo", "bar") -``` - - - - - -```java -Adjust.addSessionPartnerParameter("foo", "bar"); -``` - - - - - -```js -Adjust.addSessionPartnerParameter("foo", "bar"); -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/adid.mdx b/src/code-snippets/android/examples/Adjust/adid.mdx deleted file mode 100644 index 72abca4e5..000000000 --- a/src/code-snippets/android/examples/Adjust/adid.mdx +++ /dev/null @@ -1,25 +0,0 @@ - - - -```kotlin -val adid = Adjust.getAdid() -``` - - - - - -```java -String adid = Adjust.getAdid(); -``` - - - - - -```js -let adid = Adjust.getAdid(); -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/appWillOpenUrl.mdx b/src/code-snippets/android/examples/Adjust/appWillOpenUrl.mdx deleted file mode 100644 index c76f0a19f..000000000 --- a/src/code-snippets/android/examples/Adjust/appWillOpenUrl.mdx +++ /dev/null @@ -1,37 +0,0 @@ - - - -```kotlin -override fun onCreate(savedInstanceState: Bundle?) { - super.onCreate(savedInstanceState) - setContentView(R.layout.activity_main) - - val intent = intent - val data = intent.data - Adjust.appWillOpenUrl(data, getApplicationContext()) -} -``` - - - - -```java -@Override -protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - setContentView(R.layout.activity_main); - - Intent intent = getIntent(); - Uri data = intent.getData(); - Adjust.appWillOpenUrl(data, getApplicationContext()); -} -``` - - - - -```js -Adjust.appWillOpenUrl(deeplinkUrl); -``` - - diff --git a/src/code-snippets/android/examples/Adjust/attribution.mdx b/src/code-snippets/android/examples/Adjust/attribution.mdx deleted file mode 100644 index 433debe85..000000000 --- a/src/code-snippets/android/examples/Adjust/attribution.mdx +++ /dev/null @@ -1,25 +0,0 @@ - - - -```kotlin -val attribution = Adjust.getAttribution() -``` - - - - - -```java -AdjustAttribution attribution = Adjust.getAttribution(); -``` - - - - - -```js -let attribution = Adjust.getAttribution(); -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/disableThirdPartySharing.mdx b/src/code-snippets/android/examples/Adjust/disableThirdPartySharing.mdx deleted file mode 100644 index aef91fea1..000000000 --- a/src/code-snippets/android/examples/Adjust/disableThirdPartySharing.mdx +++ /dev/null @@ -1,25 +0,0 @@ - - - -```kotlin -Adjust.disableThirdPartySharing() -``` - - - - - -```java -Adjust.disableThirdPartySharing(); -``` - - - - - -```js -Adjust.disableThirdPartySharing(); -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/gdprForgetMe.mdx b/src/code-snippets/android/examples/Adjust/gdprForgetMe.mdx deleted file mode 100644 index aa6bd7da0..000000000 --- a/src/code-snippets/android/examples/Adjust/gdprForgetMe.mdx +++ /dev/null @@ -1,25 +0,0 @@ - - - -```kotlin -Adjust.gdprForgetMe() -``` - - - - - -```java -Adjust.gdprForgetMe(); -``` - - - - - -```js -Adjust.gdprForgetMe(); -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/getAmazonAdId.mdx b/src/code-snippets/android/examples/Adjust/getAmazonAdId.mdx deleted file mode 100644 index 0a54b3972..000000000 --- a/src/code-snippets/android/examples/Adjust/getAmazonAdId.mdx +++ /dev/null @@ -1,25 +0,0 @@ - - - -```kotlin -val amazonAdId = Adjust.getAmazonAdId(getApplicationContext()) -``` - - - - - -```java -String amazonAdId = Adjust.getAmazonAdId(getApplicationContext()); -``` - - - - - -```js -let amazonAdId = Adjust.getAmazonAdId(); -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/getGoogleAdId.mdx b/src/code-snippets/android/examples/Adjust/getGoogleAdId.mdx deleted file mode 100644 index 12cadf7d2..000000000 --- a/src/code-snippets/android/examples/Adjust/getGoogleAdId.mdx +++ /dev/null @@ -1,32 +0,0 @@ - - - -```kotlin -Adjust.getGoogleAdId(this, object : OnDeviceIdsRead { - override fun onGoogleAdIdRead(googleAdId: String) {} -}) -``` - - - - - -```java -Adjust.getGoogleAdId(this, new OnDeviceIdsRead() { - @Override - public void onGoogleAdIdRead(String googleAdId) {} -}); -``` - - - - - -```js -Adjust.getGoogleAdId(function(googleAdId) { - // ... -}); -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/isEnabled.mdx b/src/code-snippets/android/examples/Adjust/isEnabled.mdx deleted file mode 100644 index fdeae1165..000000000 --- a/src/code-snippets/android/examples/Adjust/isEnabled.mdx +++ /dev/null @@ -1,25 +0,0 @@ - - - -```kotlin -Adjust.isEnabled() -``` - - - - - -```java -Adjust.isEnabled(); -``` - - - - - -```js -Adjust.isEnabled(); -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/removeSessionCallbackParameter.mdx b/src/code-snippets/android/examples/Adjust/removeSessionCallbackParameter.mdx deleted file mode 100644 index a0ef7149d..000000000 --- a/src/code-snippets/android/examples/Adjust/removeSessionCallbackParameter.mdx +++ /dev/null @@ -1,26 +0,0 @@ - - - -```kotlin -Adjust.removeSessionCallbackParameter("foo") -``` - - - - - -```java -Adjust.removeSessionCallbackParameter("foo"); -``` - - - - - -```js -Adjust.removeSessionCallbackParameter("foo"); -``` - - - - diff --git a/src/code-snippets/android/examples/Adjust/removeSessionPartnerParameter.mdx b/src/code-snippets/android/examples/Adjust/removeSessionPartnerParameter.mdx deleted file mode 100644 index 423328229..000000000 --- a/src/code-snippets/android/examples/Adjust/removeSessionPartnerParameter.mdx +++ /dev/null @@ -1,25 +0,0 @@ - - - -```kotlin -Adjust.removeSessionPartnerParameter("foo"); -``` - - - - - -```java -Adjust.removeSessionPartnerParameter("foo"); -``` - - - - - -```js -Adjust.removeSessionPartnerParameter("foo"); -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/resetSessionCallbackParameters.mdx b/src/code-snippets/android/examples/Adjust/resetSessionCallbackParameters.mdx deleted file mode 100644 index 9e8671c6c..000000000 --- a/src/code-snippets/android/examples/Adjust/resetSessionCallbackParameters.mdx +++ /dev/null @@ -1,25 +0,0 @@ - - - -```kotlin -Adjust.resetSessionCallbackParameters() -``` - - - - - -```java -Adjust.resetSessionCallbackParameters(); -``` - - - - - -```js -Adjust.resetSessionCallbackParameters(); -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/resetSessionPartnerParameters.mdx b/src/code-snippets/android/examples/Adjust/resetSessionPartnerParameters.mdx deleted file mode 100644 index db5f411d4..000000000 --- a/src/code-snippets/android/examples/Adjust/resetSessionPartnerParameters.mdx +++ /dev/null @@ -1,25 +0,0 @@ - - - -```kotlin -Adjust.resetSessionPartnerParameters() -``` - - - - - -```java -Adjust.resetSessionPartnerParameters(); -``` - - - - - -```js -Adjust.resetSessionPartnerParameters(); -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/sendFirstPackages.mdx b/src/code-snippets/android/examples/Adjust/sendFirstPackages.mdx deleted file mode 100644 index fbb82ed87..000000000 --- a/src/code-snippets/android/examples/Adjust/sendFirstPackages.mdx +++ /dev/null @@ -1,25 +0,0 @@ - - - -```kotlin -Adjust.sendFirstPackages() -``` - - - - - -```java -Adjust.sendFirstPackages(); -``` - - - - - -```js -Adjust.sendFirstPackages(); -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/setEnabled.mdx b/src/code-snippets/android/examples/Adjust/setEnabled.mdx deleted file mode 100644 index 1c8f34c69..000000000 --- a/src/code-snippets/android/examples/Adjust/setEnabled.mdx +++ /dev/null @@ -1,25 +0,0 @@ - - - -```kotlin -Adjust.setEnabled(false) -``` - - - - - -```java -Adjust.setEnabled(false); -``` - - - - - -```js -Adjust.setEnabled(false); -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/setOfflineMode.mdx b/src/code-snippets/android/examples/Adjust/setOfflineMode.mdx deleted file mode 100644 index 238afd50e..000000000 --- a/src/code-snippets/android/examples/Adjust/setOfflineMode.mdx +++ /dev/null @@ -1,25 +0,0 @@ - - - -```kotlin -Adjust.setOfflineMode(true) -``` - - - - - -```java -Adjust.setOfflineMode(true); -``` - - - - - -```js -Adjust.setOfflineMode(true); -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/setPushToken.mdx b/src/code-snippets/android/examples/Adjust/setPushToken.mdx deleted file mode 100644 index 99b146e12..000000000 --- a/src/code-snippets/android/examples/Adjust/setPushToken.mdx +++ /dev/null @@ -1,25 +0,0 @@ - - - -```kotlin -Adjust.setPushToken("{YourPushToken}", getApplicationContext()) -``` - - - - - -```java -Adjust.setPushToken("{YourPushToken}", getApplicationContext()); -``` - - - - - -```js -Adjust.setPushToken('{YourPushToken}'); -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/setPushTokenExample.mdx b/src/code-snippets/android/examples/Adjust/setPushTokenExample.mdx deleted file mode 100644 index 089a95e0c..000000000 --- a/src/code-snippets/android/examples/Adjust/setPushTokenExample.mdx +++ /dev/null @@ -1,25 +0,0 @@ - - - -```kotlin -Adjust.setPushToken("HrFmrcq96tj723aWFfrw", getApplicationContext()) -``` - - - - - -```java -Adjust.setPushToken("HrFmrcq96tj723aWFfrw", getApplicationContext()); -``` - - - - - -```js -Adjust.setPushToken('HrFmrcq96tj723aWFfrw') -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/trackAdRevenue.mdx b/src/code-snippets/android/examples/Adjust/trackAdRevenue.mdx deleted file mode 100644 index 0467b3c89..000000000 --- a/src/code-snippets/android/examples/Adjust/trackAdRevenue.mdx +++ /dev/null @@ -1,28 +0,0 @@ - - - -```kotlin -val adjustAdRevenue = AdjustAdRevenue(AdjustConfig.AD_REVENUE_APPLOVIN_MAX) -Adjust.trackAdRevenue(adjustAdRevenue) -``` - - - - - -```java -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue(AdjustConfig.AD_REVENUE_APPLOVIN_MAX); -Adjust.trackAdRevenue(adjustAdRevenue) -``` - - - - - -```js -let adjustAdRevenue = new AdjustAdRevenue(AdjustConfig.AD_REVENUE_APPLOVIN_MAX) -Adjust.trackAdRevenue(adjustAdRevenue); -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/trackEvent.mdx b/src/code-snippets/android/examples/Adjust/trackEvent.mdx deleted file mode 100644 index 4d520b011..000000000 --- a/src/code-snippets/android/examples/Adjust/trackEvent.mdx +++ /dev/null @@ -1,28 +0,0 @@ - - - -```kotlin -val adjustEvent = AdjustEvent("abc123") -Adjust.trackEvent(adjustEvent) -``` - - - - - -```java -AdjustEvent adjustEvent = new AdjustEvent("abc123"); -Adjust.trackEvent(adjustEvent); -``` - - - - - -```js -let adjustEvent = new AdjustEvent('abc123'); -Adjust.trackEvent(adjustEvent); -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/trackEventExample.mdx b/src/code-snippets/android/examples/Adjust/trackEventExample.mdx deleted file mode 100644 index a0d5bfb57..000000000 --- a/src/code-snippets/android/examples/Adjust/trackEventExample.mdx +++ /dev/null @@ -1,37 +0,0 @@ - - - -```kotlin -fun onTrackSimpleEventClick(v: View) { - val event = AdjustEvent("g3mfiw") - Adjust.trackEvent(event) -} -``` - - - - - -```java -public void onTrackSimpleEventClick(View v) { - AdjustEvent event = new AdjustEvent("g3mfiw"); - Adjust.trackEvent(event); -``` - - - - - -```js -window.onload = function() { - var btnTrackSimpleEvent = document.getElementById('btnTrackSimpleEvent') - btnTrackSimpleEvent.onclick = function(e) { - e.preventDefault(); - var adjustEvent = new AdjustEvent('g3mfiw'); - Adjust.trackEvent(adjustEvent); - } -} -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/trackMeasurementConsent.mdx b/src/code-snippets/android/examples/Adjust/trackMeasurementConsent.mdx deleted file mode 100644 index 029b923d3..000000000 --- a/src/code-snippets/android/examples/Adjust/trackMeasurementConsent.mdx +++ /dev/null @@ -1,25 +0,0 @@ - - - -```kotlin -Adjust.trackMeasurementConsent(true) -``` - - - - - -```java -Adjust.trackMeasurementConsent(true); -``` - - - - - -```js -Adjust.trackMeasurementConsent(true); -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/trackPlayStoreSubscription.mdx b/src/code-snippets/android/examples/Adjust/trackPlayStoreSubscription.mdx deleted file mode 100644 index 678c45f9a..000000000 --- a/src/code-snippets/android/examples/Adjust/trackPlayStoreSubscription.mdx +++ /dev/null @@ -1,35 +0,0 @@ - - - -```kotlin -val subscription = AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken) -subscription.setPurchaseTime(purchaseTime) - -Adjust.trackPlayStoreSubscription(subscription) -``` - - - - - -```java -AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken); -subscription.setPurchaseTime(purchaseTime); - -Adjust.trackPlayStoreSubscription(subscription); -``` - - - diff --git a/src/code-snippets/android/examples/Adjust/trackThirdPartySharing.mdx b/src/code-snippets/android/examples/Adjust/trackThirdPartySharing.mdx deleted file mode 100644 index 9aab09a45..000000000 --- a/src/code-snippets/android/examples/Adjust/trackThirdPartySharing.mdx +++ /dev/null @@ -1,28 +0,0 @@ - - - -```kotlin -val adjustThirdPartySharing = AdjustThirdPartySharing(true) -Adjust.trackThirdPartySharing(adjustThirdPartySharing) -``` - - - - - -```java -AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - - - - - -```js -let adjustThirdPartySharing = new AdjustThirdPartySharing(true); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - - - diff --git a/src/code-snippets/android/signatures/ADJAdRevenue/addCallbackParameter.mdx b/src/code-snippets/android/signatures/ADJAdRevenue/addCallbackParameter.mdx deleted file mode 100644 index 2116b1098..000000000 --- a/src/code-snippets/android/signatures/ADJAdRevenue/addCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void addCallbackParameter(final String key, final String value) -``` diff --git a/src/code-snippets/android/signatures/ADJAdRevenue/addPartnerParameter.mdx b/src/code-snippets/android/signatures/ADJAdRevenue/addPartnerParameter.mdx deleted file mode 100644 index e1332f00a..000000000 --- a/src/code-snippets/android/signatures/ADJAdRevenue/addPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void addPartnerParameter(String key, String value) -``` diff --git a/src/code-snippets/android/signatures/ADJAdRevenue/constructor.mdx b/src/code-snippets/android/signatures/ADJAdRevenue/constructor.mdx deleted file mode 100644 index bc8d31853..000000000 --- a/src/code-snippets/android/signatures/ADJAdRevenue/constructor.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public AdjustAdRevenue(final String source) -``` diff --git a/src/code-snippets/android/signatures/ADJAdRevenue/setAdImpressionsCount.mdx b/src/code-snippets/android/signatures/ADJAdRevenue/setAdImpressionsCount.mdx deleted file mode 100644 index 620f7cdd4..000000000 --- a/src/code-snippets/android/signatures/ADJAdRevenue/setAdImpressionsCount.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setAdImpressionsCount(final Integer adImpressionsCount) -``` diff --git a/src/code-snippets/android/signatures/ADJAdRevenue/setAdRevenueNetwork.mdx b/src/code-snippets/android/signatures/ADJAdRevenue/setAdRevenueNetwork.mdx deleted file mode 100644 index 03806f801..000000000 --- a/src/code-snippets/android/signatures/ADJAdRevenue/setAdRevenueNetwork.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setAdRevenueNetwork(final String adRevenueNetwork) -``` diff --git a/src/code-snippets/android/signatures/ADJAdRevenue/setAdRevenuePlacement.mdx b/src/code-snippets/android/signatures/ADJAdRevenue/setAdRevenuePlacement.mdx deleted file mode 100644 index 2e219887e..000000000 --- a/src/code-snippets/android/signatures/ADJAdRevenue/setAdRevenuePlacement.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setAdRevenuePlacement(final String adRevenuePlacement) -``` diff --git a/src/code-snippets/android/signatures/ADJAdRevenue/setAdRevenueUnit.mdx b/src/code-snippets/android/signatures/ADJAdRevenue/setAdRevenueUnit.mdx deleted file mode 100644 index f7f979d14..000000000 --- a/src/code-snippets/android/signatures/ADJAdRevenue/setAdRevenueUnit.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setAdRevenueUnit(final String adRevenueUnit) -``` diff --git a/src/code-snippets/android/signatures/ADJAdRevenue/setRevenue.mdx b/src/code-snippets/android/signatures/ADJAdRevenue/setRevenue.mdx deleted file mode 100644 index 81f2da0c2..000000000 --- a/src/code-snippets/android/signatures/ADJAdRevenue/setRevenue.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setRevenue(final Double revenue, final String currency) -``` diff --git a/src/code-snippets/android/signatures/ADJConfig/constructor.mdx b/src/code-snippets/android/signatures/ADJConfig/constructor.mdx deleted file mode 100644 index feb34a0bd..000000000 --- a/src/code-snippets/android/signatures/ADJConfig/constructor.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```java -public AdjustConfig(Context context, String appToken, String environment, boolean allowSuppressLogLevel) { - init(context, appToken, environment, allowSuppressLogLevel); -} -``` diff --git a/src/code-snippets/android/signatures/ADJConfig/setCoppaCompliantEnabled.mdx b/src/code-snippets/android/signatures/ADJConfig/setCoppaCompliantEnabled.mdx deleted file mode 100644 index efdeb3565..000000000 --- a/src/code-snippets/android/signatures/ADJConfig/setCoppaCompliantEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setCoppaCompliantEnabled(boolean coppaCompliantEnabled) -``` diff --git a/src/code-snippets/android/signatures/ADJConfig/setDefaultTracker.mdx b/src/code-snippets/android/signatures/ADJConfig/setDefaultTracker.mdx deleted file mode 100644 index d34080180..000000000 --- a/src/code-snippets/android/signatures/ADJConfig/setDefaultTracker.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setDefaultTracker(String defaultTracker) -``` diff --git a/src/code-snippets/android/signatures/ADJConfig/setDelayStart.mdx b/src/code-snippets/android/signatures/ADJConfig/setDelayStart.mdx deleted file mode 100644 index aaedc3c3d..000000000 --- a/src/code-snippets/android/signatures/ADJConfig/setDelayStart.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setDelayStart(double delayStart) -``` diff --git a/src/code-snippets/android/signatures/ADJConfig/setEventBufferingEnabled.mdx b/src/code-snippets/android/signatures/ADJConfig/setEventBufferingEnabled.mdx deleted file mode 100644 index 9ba4aa86d..000000000 --- a/src/code-snippets/android/signatures/ADJConfig/setEventBufferingEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setEventBufferingEnabled(Boolean eventBufferingEnabled) -``` diff --git a/src/code-snippets/android/signatures/ADJConfig/setExternalDeviceId.mdx b/src/code-snippets/android/signatures/ADJConfig/setExternalDeviceId.mdx deleted file mode 100644 index 36f6f494f..000000000 --- a/src/code-snippets/android/signatures/ADJConfig/setExternalDeviceId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setExternalDeviceId(String externalDeviceId) -``` diff --git a/src/code-snippets/android/signatures/ADJConfig/setLogLevel.mdx b/src/code-snippets/android/signatures/ADJConfig/setLogLevel.mdx deleted file mode 100644 index a5f3d3977..000000000 --- a/src/code-snippets/android/signatures/ADJConfig/setLogLevel.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setLogLevel(LogLevel logLevel) -``` diff --git a/src/code-snippets/android/signatures/ADJConfig/setNeedsCost.mdx b/src/code-snippets/android/signatures/ADJConfig/setNeedsCost.mdx deleted file mode 100644 index 0cb04b166..000000000 --- a/src/code-snippets/android/signatures/ADJConfig/setNeedsCost.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setNeedsCost(boolean needsCost) -``` diff --git a/src/code-snippets/android/signatures/ADJConfig/setOnAttributionChangedListener.mdx b/src/code-snippets/android/signatures/ADJConfig/setOnAttributionChangedListener.mdx deleted file mode 100644 index 9019f8024..000000000 --- a/src/code-snippets/android/signatures/ADJConfig/setOnAttributionChangedListener.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setOnAttributionChangedListener(OnAttributionChangedListener onAttributionChangedListener) -``` diff --git a/src/code-snippets/android/signatures/ADJConfig/setOnDeeplinkResponseListener.mdx b/src/code-snippets/android/signatures/ADJConfig/setOnDeeplinkResponseListener.mdx deleted file mode 100644 index 6157b9399..000000000 --- a/src/code-snippets/android/signatures/ADJConfig/setOnDeeplinkResponseListener.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setOnDeeplinkResponseListener(OnDeeplinkResponseListener onDeeplinkResponseListener) -``` diff --git a/src/code-snippets/android/signatures/ADJConfig/setOnEventTrackingFailedListener.mdx b/src/code-snippets/android/signatures/ADJConfig/setOnEventTrackingFailedListener.mdx deleted file mode 100644 index 77b1e3e92..000000000 --- a/src/code-snippets/android/signatures/ADJConfig/setOnEventTrackingFailedListener.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setOnEventTrackingFailedListener(OnEventTrackingFailedListener onEventTrackingFailedListener) -``` diff --git a/src/code-snippets/android/signatures/ADJConfig/setOnEventTrackingSucceededListener.mdx b/src/code-snippets/android/signatures/ADJConfig/setOnEventTrackingSucceededListener.mdx deleted file mode 100644 index 6dbf09292..000000000 --- a/src/code-snippets/android/signatures/ADJConfig/setOnEventTrackingSucceededListener.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setOnEventTrackingSucceededListener(OnEventTrackingSucceededListener onEventTrackingSucceededListener) -``` diff --git a/src/code-snippets/android/signatures/ADJConfig/setOnSessionTrackingFailedListener.mdx b/src/code-snippets/android/signatures/ADJConfig/setOnSessionTrackingFailedListener.mdx deleted file mode 100644 index 98227613a..000000000 --- a/src/code-snippets/android/signatures/ADJConfig/setOnSessionTrackingFailedListener.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setOnSessionTrackingFailedListener(OnSessionTrackingFailedListener onSessionTrackingFailedListener) -``` diff --git a/src/code-snippets/android/signatures/ADJConfig/setOnSessionTrackingSucceededListener.mdx b/src/code-snippets/android/signatures/ADJConfig/setOnSessionTrackingSucceededListener.mdx deleted file mode 100644 index f9e15d87f..000000000 --- a/src/code-snippets/android/signatures/ADJConfig/setOnSessionTrackingSucceededListener.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setOnSessionTrackingSucceededListener(OnSessionTrackingSucceededListener onSessionTrackingSucceededListener) -``` diff --git a/src/code-snippets/android/signatures/ADJConfig/setPlayStoreKidsAppEnabled.mdx b/src/code-snippets/android/signatures/ADJConfig/setPlayStoreKidsAppEnabled.mdx deleted file mode 100644 index 1421fa7c6..000000000 --- a/src/code-snippets/android/signatures/ADJConfig/setPlayStoreKidsAppEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setPlayStoreKidsAppEnabled(boolean playStoreKidsAppEnabled) -``` diff --git a/src/code-snippets/android/signatures/ADJConfig/setPreinstallFilePath.mdx b/src/code-snippets/android/signatures/ADJConfig/setPreinstallFilePath.mdx deleted file mode 100644 index 27ea5e48d..000000000 --- a/src/code-snippets/android/signatures/ADJConfig/setPreinstallFilePath.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setPreinstallFilePath(String preinstallFilePath) -``` diff --git a/src/code-snippets/android/signatures/ADJConfig/setPreinstallTrackingEnabled.mdx b/src/code-snippets/android/signatures/ADJConfig/setPreinstallTrackingEnabled.mdx deleted file mode 100644 index ae14b8fd2..000000000 --- a/src/code-snippets/android/signatures/ADJConfig/setPreinstallTrackingEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setPreinstallTrackingEnabled(boolean preinstallTrackingEnabled) -``` diff --git a/src/code-snippets/android/signatures/ADJConfig/setSendInBackground.mdx b/src/code-snippets/android/signatures/ADJConfig/setSendInBackground.mdx deleted file mode 100644 index e72f880a8..000000000 --- a/src/code-snippets/android/signatures/ADJConfig/setSendInBackground.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setSendInBackground(boolean sendInBackground) -``` diff --git a/src/code-snippets/android/signatures/ADJConfig/setUrlStrategy.mdx b/src/code-snippets/android/signatures/ADJConfig/setUrlStrategy.mdx deleted file mode 100644 index 05a74675c..000000000 --- a/src/code-snippets/android/signatures/ADJConfig/setUrlStrategy.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setUrlStrategy(String urlStrategy) -``` diff --git a/src/code-snippets/android/signatures/ADJEvent/addCallbackParameter.mdx b/src/code-snippets/android/signatures/ADJEvent/addCallbackParameter.mdx deleted file mode 100644 index 80657c62d..000000000 --- a/src/code-snippets/android/signatures/ADJEvent/addCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void addCallbackParameter(String key, String value) -``` diff --git a/src/code-snippets/android/signatures/ADJEvent/addPartnerParameter.mdx b/src/code-snippets/android/signatures/ADJEvent/addPartnerParameter.mdx deleted file mode 100644 index e1332f00a..000000000 --- a/src/code-snippets/android/signatures/ADJEvent/addPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void addPartnerParameter(String key, String value) -``` diff --git a/src/code-snippets/android/signatures/ADJEvent/constructor.mdx b/src/code-snippets/android/signatures/ADJEvent/constructor.mdx deleted file mode 100644 index 2d0d51278..000000000 --- a/src/code-snippets/android/signatures/ADJEvent/constructor.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public AdjustEvent(String eventToken) -``` diff --git a/src/code-snippets/android/signatures/ADJEvent/setCallbackId.mdx b/src/code-snippets/android/signatures/ADJEvent/setCallbackId.mdx deleted file mode 100644 index 968cf575b..000000000 --- a/src/code-snippets/android/signatures/ADJEvent/setCallbackId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setCallbackId(String callbackId) -``` diff --git a/src/code-snippets/android/signatures/ADJEvent/setOrderId.mdx b/src/code-snippets/android/signatures/ADJEvent/setOrderId.mdx deleted file mode 100644 index 494e0361d..000000000 --- a/src/code-snippets/android/signatures/ADJEvent/setOrderId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setOrderId(String orderId) -``` diff --git a/src/code-snippets/android/signatures/ADJEvent/setRevenue.mdx b/src/code-snippets/android/signatures/ADJEvent/setRevenue.mdx deleted file mode 100644 index 9f741c7a1..000000000 --- a/src/code-snippets/android/signatures/ADJEvent/setRevenue.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setRevenue(double revenue, String currency) -``` diff --git a/src/code-snippets/android/signatures/ADJPlayStoreSubscription/addCallbackParameter.mdx b/src/code-snippets/android/signatures/ADJPlayStoreSubscription/addCallbackParameter.mdx deleted file mode 100644 index 80657c62d..000000000 --- a/src/code-snippets/android/signatures/ADJPlayStoreSubscription/addCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void addCallbackParameter(String key, String value) -``` diff --git a/src/code-snippets/android/signatures/ADJPlayStoreSubscription/addPartnerParameter.mdx b/src/code-snippets/android/signatures/ADJPlayStoreSubscription/addPartnerParameter.mdx deleted file mode 100644 index e1332f00a..000000000 --- a/src/code-snippets/android/signatures/ADJPlayStoreSubscription/addPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void addPartnerParameter(String key, String value) -``` diff --git a/src/code-snippets/android/signatures/ADJPlayStoreSubscription/constructor.mdx b/src/code-snippets/android/signatures/ADJPlayStoreSubscription/constructor.mdx deleted file mode 100644 index eedfb4391..000000000 --- a/src/code-snippets/android/signatures/ADJPlayStoreSubscription/constructor.mdx +++ /dev/null @@ -1,8 +0,0 @@ -```java -public AdjustPlayStoreSubscription(final long price, - final String currency, - final String sku, - final String orderId, - final String signature, - final String purchaseToken) -``` diff --git a/src/code-snippets/android/signatures/ADJPlayStoreSubscription/setPurchaseTime.mdx b/src/code-snippets/android/signatures/ADJPlayStoreSubscription/setPurchaseTime.mdx deleted file mode 100644 index 4a4d21136..000000000 --- a/src/code-snippets/android/signatures/ADJPlayStoreSubscription/setPurchaseTime.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public void setPurchaseTime(final long purchaseTime) -``` diff --git a/src/code-snippets/android/signatures/ADJThirdPartySharing/addGranularOption.mdx b/src/code-snippets/android/signatures/ADJThirdPartySharing/addGranularOption.mdx deleted file mode 100644 index ffe33551f..000000000 --- a/src/code-snippets/android/signatures/ADJThirdPartySharing/addGranularOption.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```java -public void addGranularOption(final String partnerName, - final String key, - final String value) -``` diff --git a/src/code-snippets/android/signatures/ADJThirdPartySharing/addPartnerSharingSetting.mdx b/src/code-snippets/android/signatures/ADJThirdPartySharing/addPartnerSharingSetting.mdx deleted file mode 100644 index 2c7f9b7e6..000000000 --- a/src/code-snippets/android/signatures/ADJThirdPartySharing/addPartnerSharingSetting.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```java -public void addPartnerSharingSetting(final String partnerName, - final String key, - final boolean value) -``` diff --git a/src/code-snippets/android/signatures/ADJThirdPartySharing/constructor.mdx b/src/code-snippets/android/signatures/ADJThirdPartySharing/constructor.mdx deleted file mode 100644 index 256829448..000000000 --- a/src/code-snippets/android/signatures/ADJThirdPartySharing/constructor.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public AdjustThirdPartySharing(final Boolean isEnabled) -``` diff --git a/src/code-snippets/android/signatures/Adjust/addSessionCallbackParameter.mdx b/src/code-snippets/android/signatures/Adjust/addSessionCallbackParameter.mdx deleted file mode 100644 index 10ad808f7..000000000 --- a/src/code-snippets/android/signatures/Adjust/addSessionCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static void addSessionCallbackParameter(String key, String value) -``` diff --git a/src/code-snippets/android/signatures/Adjust/addSessionPartnerParameter.mdx b/src/code-snippets/android/signatures/Adjust/addSessionPartnerParameter.mdx deleted file mode 100644 index a0afd8b1a..000000000 --- a/src/code-snippets/android/signatures/Adjust/addSessionPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static void addSessionPartnerParameter(String key, String value) -``` diff --git a/src/code-snippets/android/signatures/Adjust/adid.mdx b/src/code-snippets/android/signatures/Adjust/adid.mdx deleted file mode 100644 index ae7b84a91..000000000 --- a/src/code-snippets/android/signatures/Adjust/adid.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static String getAdid() -``` diff --git a/src/code-snippets/android/signatures/Adjust/appWillOpenUrl.mdx b/src/code-snippets/android/signatures/Adjust/appWillOpenUrl.mdx deleted file mode 100644 index edab3bd92..000000000 --- a/src/code-snippets/android/signatures/Adjust/appWillOpenUrl.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static void appWillOpenUrl(Uri url, Context context) -``` diff --git a/src/code-snippets/android/signatures/Adjust/attribution.mdx b/src/code-snippets/android/signatures/Adjust/attribution.mdx deleted file mode 100644 index d03ad8583..000000000 --- a/src/code-snippets/android/signatures/Adjust/attribution.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static AdjustAttribution getAttribution() -``` diff --git a/src/code-snippets/android/signatures/Adjust/disableThirdPartySharing.mdx b/src/code-snippets/android/signatures/Adjust/disableThirdPartySharing.mdx deleted file mode 100644 index f84e05c9b..000000000 --- a/src/code-snippets/android/signatures/Adjust/disableThirdPartySharing.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static void disableThirdPartySharing(final Context context) -``` diff --git a/src/code-snippets/android/signatures/Adjust/gdprForgetMe.mdx b/src/code-snippets/android/signatures/Adjust/gdprForgetMe.mdx deleted file mode 100644 index d3cf0ff06..000000000 --- a/src/code-snippets/android/signatures/Adjust/gdprForgetMe.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static void gdprForgetMe(final Context context) -``` diff --git a/src/code-snippets/android/signatures/Adjust/getAmazonAdId.mdx b/src/code-snippets/android/signatures/Adjust/getAmazonAdId.mdx deleted file mode 100644 index 5c3995a5e..000000000 --- a/src/code-snippets/android/signatures/Adjust/getAmazonAdId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static String getAmazonAdId(final Context context) -``` diff --git a/src/code-snippets/android/signatures/Adjust/getGoogleAdId.mdx b/src/code-snippets/android/signatures/Adjust/getGoogleAdId.mdx deleted file mode 100644 index bfb316019..000000000 --- a/src/code-snippets/android/signatures/Adjust/getGoogleAdId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static void getGoogleAdId(Context context, OnDeviceIdsRead onDeviceIdRead) -``` diff --git a/src/code-snippets/android/signatures/Adjust/isEnabled.mdx b/src/code-snippets/android/signatures/Adjust/isEnabled.mdx deleted file mode 100644 index 280285a13..000000000 --- a/src/code-snippets/android/signatures/Adjust/isEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static boolean isEnabled() -``` diff --git a/src/code-snippets/android/signatures/Adjust/removeSessionCallbackParameter.mdx b/src/code-snippets/android/signatures/Adjust/removeSessionCallbackParameter.mdx deleted file mode 100644 index c5d4eda7d..000000000 --- a/src/code-snippets/android/signatures/Adjust/removeSessionCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static void removeSessionCallbackParameter(String key) -``` diff --git a/src/code-snippets/android/signatures/Adjust/removeSessionPartnerParameter.mdx b/src/code-snippets/android/signatures/Adjust/removeSessionPartnerParameter.mdx deleted file mode 100644 index 98232cdc3..000000000 --- a/src/code-snippets/android/signatures/Adjust/removeSessionPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static void removeSessionPartnerParameter(String key) -``` diff --git a/src/code-snippets/android/signatures/Adjust/resetSessionCallbackParameters.mdx b/src/code-snippets/android/signatures/Adjust/resetSessionCallbackParameters.mdx deleted file mode 100644 index c6de7891e..000000000 --- a/src/code-snippets/android/signatures/Adjust/resetSessionCallbackParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static void resetSessionCallbackParameters() -``` diff --git a/src/code-snippets/android/signatures/Adjust/resetSessionPartnerParameters.mdx b/src/code-snippets/android/signatures/Adjust/resetSessionPartnerParameters.mdx deleted file mode 100644 index b25251c6d..000000000 --- a/src/code-snippets/android/signatures/Adjust/resetSessionPartnerParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static void resetSessionPartnerParameters() -``` diff --git a/src/code-snippets/android/signatures/Adjust/sendFirstPackages.mdx b/src/code-snippets/android/signatures/Adjust/sendFirstPackages.mdx deleted file mode 100644 index 59f642569..000000000 --- a/src/code-snippets/android/signatures/Adjust/sendFirstPackages.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static void sendFirstPackages() -``` diff --git a/src/code-snippets/android/signatures/Adjust/setEnabled.mdx b/src/code-snippets/android/signatures/Adjust/setEnabled.mdx deleted file mode 100644 index 08014411f..000000000 --- a/src/code-snippets/android/signatures/Adjust/setEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static void setEnabled(boolean enabled) -``` diff --git a/src/code-snippets/android/signatures/Adjust/setOfflineMode.mdx b/src/code-snippets/android/signatures/Adjust/setOfflineMode.mdx deleted file mode 100644 index 86e76d39c..000000000 --- a/src/code-snippets/android/signatures/Adjust/setOfflineMode.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static void setOfflineMode(boolean enabled) -``` diff --git a/src/code-snippets/android/signatures/Adjust/setPushToken.mdx b/src/code-snippets/android/signatures/Adjust/setPushToken.mdx deleted file mode 100644 index fdb5d4548..000000000 --- a/src/code-snippets/android/signatures/Adjust/setPushToken.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static void setPushToken(final String token, final Context context) -``` diff --git a/src/code-snippets/android/signatures/Adjust/trackAdRevenue.mdx b/src/code-snippets/android/signatures/Adjust/trackAdRevenue.mdx deleted file mode 100644 index 5ceeab070..000000000 --- a/src/code-snippets/android/signatures/Adjust/trackAdRevenue.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static void trackAdRevenue(AdjustAdRevenue adRevenue) -``` diff --git a/src/code-snippets/android/signatures/Adjust/trackEvent.mdx b/src/code-snippets/android/signatures/Adjust/trackEvent.mdx deleted file mode 100644 index 16f336fba..000000000 --- a/src/code-snippets/android/signatures/Adjust/trackEvent.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static void trackEvent(AdjustEvent event) -``` diff --git a/src/code-snippets/android/signatures/Adjust/trackMeasurementConsent.mdx b/src/code-snippets/android/signatures/Adjust/trackMeasurementConsent.mdx deleted file mode 100644 index a0682d8ab..000000000 --- a/src/code-snippets/android/signatures/Adjust/trackMeasurementConsent.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static void trackMeasurementConsent(final boolean consentMeasurement) -``` diff --git a/src/code-snippets/android/signatures/Adjust/trackPlayStoreSubscription.mdx b/src/code-snippets/android/signatures/Adjust/trackPlayStoreSubscription.mdx deleted file mode 100644 index 7609cb1d6..000000000 --- a/src/code-snippets/android/signatures/Adjust/trackPlayStoreSubscription.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java -public static void trackPlayStoreSubscription(final AdjustPlayStoreSubscription subscription) -``` diff --git a/src/code-snippets/android/signatures/Adjust/trackThirdPartySharing.mdx b/src/code-snippets/android/signatures/Adjust/trackThirdPartySharing.mdx deleted file mode 100644 index 86778c6e5..000000000 --- a/src/code-snippets/android/signatures/Adjust/trackThirdPartySharing.mdx +++ /dev/null @@ -1,4 +0,0 @@ -```java -public static void trackThirdPartySharing( - final AdjustThirdPartySharing adjustThirdPartySharing) -``` diff --git a/src/content/docs/sdk/android/configuration.mdx b/src/content/docs/sdk/android/configuration.mdx new file mode 100644 index 000000000..3940af8ed --- /dev/null +++ b/src/content/docs/sdk/android/configuration.mdx @@ -0,0 +1,580 @@ +--- +title: Configuration +description: Follow the guides in this section to configure the Adjust SDK. +slug: en/sdk/android/configuration +sidebar-position: 1 +--- + +Use the methods in this document to configure the behavior of the Adjust SDK. + +## Instantiate your config object + +```java title="Method signature" +public AdjustConfig(Context context, String appToken, String environment, boolean allowSuppressLogLevel) { + init(context, appToken, environment, allowSuppressLogLevel); +} +``` + +To configure the Adjust SDK, you need to instantiate an `AdjustConfig` 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 `AdjustConfig` instance and pass the following parameters: + +- `context` (Context): The [Android Context](https://developer.android.com/reference/android/content/Context) in which your app is running. Pass `this` to get the current app context. +- `appToken` (String): Your [Adjust app token](https://help.adjust.com/en/article/app-token-and-reporting-currency#view-your-app-details). +- `environment` (String): The environment you want to run the SDK in. Pass `AdjustConfig.ENVIRONMENT_SANDBOX` to run the SDK in sandbox mode for testing. Pass `AdjustConfig.ENVIRONMENT_PRODUCTION` to run the SDK in production mode for release. +- `allowSuppressLogLevel` (Boolean): Whether to suppress all logging. Set to `true` to suppress logging or `false` to enable logging. + + + + +```kotlin {3} +val appToken = "{YourAppToken}" +val environment = AdjustConfig.ENVIRONMENT_SANDBOX +val config = AdjustConfig(this, appToken, environment, false) +``` + + + + +```java {3} +String appToken = "{YourAppToken}"; +String environment = AdjustConfig.ENVIRONMENT_SANDBOX; +AdjustConfig config = new AdjustConfig(this, appToken, environment, false); +``` + + + + +```js {3} +var yourAppToken = yourAppToken; +var environment = AdjustConfig.EnvironmentSandbox; +var adjustConfig = new AdjustConfig(yourAppToken, environment, false); +``` + + + + +## Read-only configuration + +**Read-only** configuration options are set in your `AdjustConfig` 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.onCreate()`. + +### Set your logging level + +```java title="Method signature" +public void setLogLevel(LogLevel logLevel) +``` + +The Adjust SDK provides configurable log levels to return different amounts of information. The following log levels are available: + + + +| Log level | Description | +| ------------------- | --------------------------------------------- | +| `LogLevel.VERBOSE` | Enable all logging | +| `LogLevel.DEBUG` | Enable debug logging | +| `LogLevel.INFO` | Only show info level logging (default option) | +| `LogLevel.WARN` | Disable informational warnings | +| `LogLevel.ERROR` | Disable warning level logging and below | +| `LogLevel.ASSERT` | Disable error level logging and below | +| `LogLevel.SUPPRESS` | Suppress all logging | + +
+ +You can set your log level by calling the `setLogLevel` method on your `AdjustConfig` instance with the following parameter: + +- `logLevel` (LogLevel): The log level you want to use. + + + + +```kotlin {4} +val appToken = "{YourAppToken}" +val environment = AdjustConfig.ENVIRONMENT_SANDBOX +val config = AdjustConfig(this, appToken, environment) +config.setLogLevel(LogLevel.VERBOSE) +//... +Adjust.onCreate(config) +``` + + + + +```java {4} +String appToken = "{YourAppToken}"; +String environment = AdjustConfig.ENVIRONMENT_SANDBOX; +AdjustConfig config = new AdjustConfig(this, appToken, environment); +config.setLogLevel(LogLevel.VERBOSE); +//... +Adjust.onCreate(config); +``` + + + + +```js {4} +var yourAppToken = yourAppToken; +var environment = AdjustConfig.EnvironmentSandbox; +var adjustConfig = new AdjustConfig(yourAppToken, environment); +adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose); +``` + + + + +### Set external device identifier + +```java title="Method signature" +public void setExternalDeviceId(String 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. You can set property calling the `setExternalDeviceId` method with the following parameter: + +- `externalDeviceId` (String): 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. + + + + + + +```kotlin {4} +val appToken = "{YourAppToken}" +val environment = AdjustConfig.ENVIRONMENT_SANDBOX +val config = AdjustConfig(this, appToken, environment) +config.externalDeviceId("{YourExternalDeviceId}") +//... +Adjust.onCreate(config) +``` + + + + + +```java {4} +String appToken = "{YourAppToken}"; +String environment = AdjustConfig.ENVIRONMENT_SANDBOX; +AdjustConfig config = new AdjustConfig(this, appToken, environment); +config.externalDeviceId("{YourExternalDeviceId}"); +//... +Adjust.onCreate(config); +``` + + + + +```js {4} +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/android/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 + +```java title="Method signature" +public void setDefaultTracker(String 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. To set your default link token, call the `setDefaultTracker` method with the following argument: + +- `defaultTracker` (String): The [Adjust link token](https://help.adjust.com/en/article/links#adjust-link-token) you want to record preinstalled installs against. + + + + +```kotlin {4} +val appToken = "{YourAppToken}" +val environment = AdjustConfig.ENVIRONMENT_SANDBOX +val config = AdjustConfig(this, appToken, environment) +config.setDefaultTracker("{Token}") +//... +Adjust.onCreate(config) +``` + + + + +```java {4} +String appToken = "{YourAppToken}"; +String environment = AdjustConfig.ENVIRONMENT_SANDBOX; +AdjustConfig config = new AdjustConfig(this, appToken, environment); +config.setDefaultTracker("{Token}"); +//... +Adjust.onCreate(config); +``` + + + + +```js {4} +var yourAppToken = yourAppToken; +var environment = AdjustConfig.EnvironmentSandbox; +var adjustConfig = new AdjustConfig(yourAppToken, environment); +adjustConfig.setDefaultTracker("{Token}"); +``` + + + + +### Enable cost data sending + +```java title="Method signature" +public void setNeedsCost(boolean 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, call the `setNeedsCost` method on your config instance with the following parameter: + +- `needsCost` (**Boolean**): 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/android/features/attribution). + + + + +```kotlin {2} +val config = AdjustConfig(this, appToken, environment) +config.setNeedsCost(true) +Adjust.onCreate(config) +``` + + + + +```java {2} +AdjustConfig config = new AdjustConfig(this, appToken, environment); +config.setNeedsCost(true); +Adjust.onCreate(config); +``` + + + + +```js {2} +var adjustConfig = new AdjustConfig(yourAppToken, environment); +adjustConfig.setNeedsCost(true); +Adjust.onCreate(adjustConfig); +``` + + + + +### Enable background recording + +```java title="Method signature" +public void setSendInBackground(boolean 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, call the `setSendInBackground` method on your config instance with the following parameter: + +- `sendInBackground` (Boolean): Set to `true` to enable background sending or `false` to disable background sending. + + + + +```kotlin {4} +val appToken = "{YourAppToken}" +val environment = AdjustConfig.ENVIRONMENT_SANDBOX +val config = AdjustConfig(this, appToken, environment) +config.setSendInBackground(true) +//... +Adjust.onCreate(config) +``` + + + + +```java {4} +String appToken = "{YourAppToken}"; +String environment = AdjustConfig.ENVIRONMENT_SANDBOX; +AdjustConfig config = new AdjustConfig(this, appToken, environment); +config.setSendInBackground(true); +//... +Adjust.onCreate(config); +``` + + + + +```js {4} +var yourAppToken = yourAppToken; +var environment = AdjustConfig.EnvironmentSandbox; +var adjustConfig = new AdjustConfig(yourAppToken, environment); +adjustConfig.setSendInBackground(true); +``` + + + + +### Enable event buffering + +```java title="Method signature" +public void setEventBufferingEnabled(Boolean 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. You can set this property by calling the `setEventBufferingEnabled` method on your config object with the following parameter: + +- `eventBufferingEnabled` (Boolean): Set to `true` to enable event buffering or `false` to disable event buffering. + + + + +```kotlin {4} +val appToken = "{YourAppToken}" +val environment = AdjustConfig.ENVIRONMENT_SANDBOX +val config = AdjustConfig(this, appToken, environment) +config.setEventBufferingEnabled(true) +//... +Adjust.onCreate(config) +``` + + + + +```java {4} +String appToken = "{YourAppToken}"; +String environment = AdjustConfig.ENVIRONMENT_SANDBOX; +AdjustConfig config = new AdjustConfig(this, appToken, environment); +config.setEventBufferingEnabled(true); +//... +Adjust.onCreate(config); +``` + + + + +```js {4} +var yourAppToken = yourAppToken; +var environment = AdjustConfig.EnvironmentSandbox; +var adjustConfig = new AdjustConfig(yourAppToken, environment); +adjustConfig.setEventBufferingEnabled(true); +``` + + + + +### Delay the start of the SDK + +```java title="Method signature" +public void setDelayStart(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/android/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, call the `setDelayStart` method with the following argument: + +- `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**. + + + + +```kotlin {2} +val config = AdjustConfig(this, appToken, environment) +config.setDelayStart(5.5) +Adjust.onCreate(config) +``` + + + + +```java {2} +AdjustConfig config = new AdjustConfig(this, appToken, environment); +config.setDelayStart(5.5); +Adjust.onCreate(config); +``` + + + + +```js {2} +var adjustConfig = new AdjustConfig(yourAppToken, environment); +adjustConfig.setDelayStart(5.5); +Adjust.onCreate(adjustConfig); +``` + + + + +## 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 + +```java title="Method signature" +public static void setOfflineMode(boolean 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` (Boolean): Set to `true` to enable offline mode or `false` to disable offline mode. + + + + +```kotlin +Adjust.setOfflineMode(true) +``` + + + + + +```java +Adjust.setOfflineMode(true); +``` + + + + + +```js +Adjust.setOfflineMode(true); +``` + + + + +### Set push tokens + +```java title="Method signature" +public static void setPushToken(final String token, final Context context) +``` + +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 `setPushToken` method and passing the following arguments: + +- `token` (String): Your push token. +- `context` (Context): The [Android Context](https://developer.android.com/reference/android/content/Context) in which your app is running. Pass `getApplicationContext()` to get the current app context. + + + +If you have access to the push token from the web view, you can call the `setPushToken` method in Javascript. + + + + + + +```kotlin +Adjust.setPushToken("{YourPushToken}", getApplicationContext()) +``` + + + + + +```java +Adjust.setPushToken("{YourPushToken}", getApplicationContext()); +``` + + + + + +```js +Adjust.setPushToken("{YourPushToken}"); +``` + + + + +### Disable or enable the SDK + + + +You can only call this method after the first session. This setting persists between sessions. + + + +```java title="Method signature" +public static void setEnabled(boolean 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` (Boolean): Set to `true` to enable the SDK or `false` to disable the SDK. + + + + +```kotlin +Adjust.setEnabled(false) +``` + + + + + +```java +Adjust.setEnabled(false); +``` + + + + + +```js +Adjust.setEnabled(false); +``` + + + + +#### Check enabled status + +```java title="Method signature" +public static boolean 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`). + + + + +```kotlin +Adjust.isEnabled() +``` + + + + + +```java +Adjust.isEnabled(); +``` + + + + + +```js +Adjust.isEnabled(); +``` + + + diff --git a/src/content/docs/sdk/android/configuration/background.mdx b/src/content/docs/sdk/android/configuration/background.mdx deleted file mode 100644 index 5f835d5ba..000000000 --- a/src/content/docs/sdk/android/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/android/configuration/background ---- - -import SetSendInBackgroundSig from "@android-signatures/ADJConfig/setSendInBackground.mdx" -import SetSendInBackground from "@android-examples/ADJConfig/setSendInBackground.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/android/configuration/delay.mdx b/src/content/docs/sdk/android/configuration/delay.mdx deleted file mode 100644 index 8f0839e9f..000000000 --- a/src/content/docs/sdk/android/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/android/configuration/delay ---- - -import SetOfflineMode from "@android-examples/Adjust/setOfflineMode.mdx" -import SetOfflineModeSig from "@android-signatures/Adjust/setOfflineMode.mdx" -import SetEventBufferingEnabled from "@android-examples/ADJConfig/setEventBufferingEnabled.mdx" -import SetEventBufferingEnabledSig from "@android-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/android/configuration/disable.mdx b/src/content/docs/sdk/android/configuration/disable.mdx deleted file mode 100644 index 0d212edb0..000000000 --- a/src/content/docs/sdk/android/configuration/disable.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Disable the Adjust SDK -description: Disable the Adjust SDK to pause recording. -slug: en/sdk/android/configuration/disable ---- - -import SetEnabled from "@android-examples/Adjust/setEnabled.mdx" -import SetEnabledSig from "@android-signatures/Adjust/setEnabled.mdx" -import IsEnabled from "@android-examples/Adjust/isEnabled.mdx" -import IsEnabledSig from "@android-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. - - diff --git a/src/content/docs/sdk/android/configuration/external-device-id.mdx b/src/content/docs/sdk/android/configuration/external-device-id.mdx deleted file mode 100644 index e29724d96..000000000 --- a/src/content/docs/sdk/android/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/android/configuration/external-device-id ---- - -import SetExternalDeviceId from "@android-examples/ADJConfig/setExternalDeviceId.mdx" -import SetExternalDeviceIdSig from "@android-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/android/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/android/configuration/index.mdx b/src/content/docs/sdk/android/configuration/index.mdx deleted file mode 100644 index e3ac36af2..000000000 --- a/src/content/docs/sdk/android/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/android/configuration -type: category ---- - -Follow the guides in this section to configure the Adjust SDK. diff --git a/src/content/docs/sdk/android/configuration/log-level.mdx b/src/content/docs/sdk/android/configuration/log-level.mdx deleted file mode 100644 index b5d18f3cc..000000000 --- a/src/content/docs/sdk/android/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/android/configuration/log-level ---- - -import SetLogLevel from "@android-examples/ADJConfig/setLogLevel.mdx" -import SetLogLevelSig from "@android-signatures/ADJConfig/setLogLevel.mdx" - -The Adjust SDK provides configurable log levels to return different amounts of information. The following log levels are available: - - - -| Log level | Description | -| --------------------- | --------------------------------------------- | -| `LogLevel.VERBOSE` | Enable all logging | -| `LogLevel.DEBUG` | Enable debug logging | -| `LogLevel.INFO` | Only show info level logging (default option) | -| `LogLevel.WARN` | Disable informational warnings | -| `LogLevel.ERROR` | Disable warning level logging and below | -| `LogLevel.ASSERT` | Disable error level logging and below | -| `LogLevel.SUPPRESS` | Suppress all logging | - -
- -You can set your log level by calling the `setLogLevel` method on your `AdjustConfig` instance. - - diff --git a/src/content/docs/sdk/android/configuration/preinstalled.mdx b/src/content/docs/sdk/android/configuration/preinstalled.mdx deleted file mode 100644 index 9c3e99383..000000000 --- a/src/content/docs/sdk/android/configuration/preinstalled.mdx +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: Send preinstalled app activity -description: Configure a campaign to send information from preinstalled apps. -slug: en/sdk/android/configuration/preinstalled ---- - -import SetPreinstallTrackingEnabledSig from "@android-signatures/ADJConfig/setPreinstallTrackingEnabled.mdx" -import SetPreinstallTrackingEnabled from "@android-examples/ADJConfig/setPreinstallTrackingEnabled.mdx" -import SetDefaultTracker from "@android-examples/ADJConfig/setDefaultTracker.mdx" -import SetDefaultTrackerSig from "@android-signatures/ADJConfig/setDefaultTracker.mdx" -import SetPreinstallFilePathSig from "@android-signatures/ADJConfig/setPreinstallFilePath.mdx" -import SetPreinstallFilePath from "@android-examples/ADJConfig/setPreinstallFilePath.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. - -Your config object contains a **boolean** `preinstallTrackingEnabled` property that controls this feature. To enable preinstall measurement, call the `setPreinstallTrackingEnabled` with a `true` argument. - - - -The Adjust SDK provides 5 methods for measuring preinstalled apps: -- [System properties](#system-properties) -- [Content provider](#content-provider) -- [System installer receiver](#system-installer-receiver) -- [World-readable directory](#world-readable-directory) -- [Default campaign token](#default-campaign-token) - -## System properties - -OEM (Original Equipment Manufacturer) partners can leverage Android system properties to attribute preinstalled apps. The OEM writes attribution information to a file and adds its path to the system properties. The Adjust SDK reads this file on initialization to attribute the install. - -## Content provider - -The content provider method makes use of a read-only content provider. The SDK uses a content resolver to gather preinstall information from the request. - - -To set the permissions, add the following to your `AndroidManifest.xml` file. - -```xml - -``` - -To access a list of preinstalled apps on the device, add the following to your `AndroidManifest.xml` file. - -```xml - - - - - -``` - -## System installer receiver - -The system installer method uses a broadcast receiver. The system installer broadcasts preinstall information. The Adjust SDK reads this information using the system preinstall referrer receiver. - -To set up the receiver, add the following to your `AndroidManifest.xml` file. - -```xml -:caption: AndroidManifest.xml - - - - - - -``` - -## World-readable directory - -Save attribution information for your preinstalled app in a world-readable directory. The SDK reads the information from this file at install to attribute the user. The system encryption protocol protects app data. - -Pass the file path at which your preinstall information can be found to the setPreinstallFilePath method to give the Adjust SDK access to the information. - - - -## Default campaign token - -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 campaign link in Datascape. - - ``` - https://app.adjust.com/{token} - ``` - -2. Copy this token and pass it to the `setDefaultTracker` method. - - - -3. Build and run your app. If you have logging enabled, you should see a message in your log - - ``` - Default tracker: 'abc123'. - ``` diff --git a/src/content/docs/sdk/android/configuration/privacy.mdx b/src/content/docs/sdk/android/configuration/privacy.mdx deleted file mode 100644 index 609fa8011..000000000 --- a/src/content/docs/sdk/android/configuration/privacy.mdx +++ /dev/null @@ -1,210 +0,0 @@ ---- -title: Set up privacy features -description: Configure features that you can use to handle user privacy in your app. -slug: en/sdk/android/configuration/privacy ---- - -import GdprForgetMe from "@android-examples/Adjust/gdprForgetMe.mdx"; -import GdprForgetMeSig from "@android-signatures/Adjust/gdprForgetMe.mdx"; -import AdjustThirdPartySharingIsEnabledFalse from "@android-examples/ADJThirdPartySharing/adjustThirdPartySharingIsEnabledFalse.mdx"; -import AdjustThirdPartySharingIsEnabledTrue from "@android-examples/ADJThirdPartySharing/adjustThirdPartySharingIsEnabledTrue.mdx"; -import ConstructorSig from "@android-signatures/ADJThirdPartySharing/constructor.mdx"; -import AddGranularOption from "@android-examples/ADJThirdPartySharing/addGranularOption.mdx"; -import AddGranularOptionSig from "@android-signatures/ADJThirdPartySharing/addGranularOption.mdx"; -import AddPartnerSharingSetting from "@android-examples/ADJThirdPartySharing/addPartnerSharingSetting.mdx"; -import AddPartnerSharingSettingSig from "@android-signatures/ADJThirdPartySharing/addPartnerSharingSetting.mdx"; -import AddGranularOptionFacebook from "@android-examples/ADJThirdPartySharing/addGranularOptionFacebook.mdx"; -import DisableThirdPartySharing from "@android-examples/Adjust/disableThirdPartySharing.mdx"; -import DisableThirdPartySharingSig from "@android-signatures/Adjust/disableThirdPartySharing.mdx"; -import SetUrlStrategy from "@android-examples/ADJConfig/setUrlStrategy.mdx"; -import SetUrlStrategySig from "@android-signatures/ADJConfig/setUrlStrategy.mdx"; -import TrackMeasurementConsent from "@android-examples/Adjust/trackMeasurementConsent.mdx"; -import TrackMeasurementConsentSig from "@android-signatures/Adjust/trackMeasurementConsent.mdx"; -import SetCoppaCompliantEnabledSig from "@android-signatures/ADJConfig/setCoppaCompliantEnabled.mdx"; -import SetCoppaCompliantEnabled from "@android-examples/ADJConfig/setCoppaCompliantEnabled.mdx"; -import SetPlayStoreKidsAppEnabledSig from "@android-signatures/ADJConfig/setPlayStoreKidsAppEnabled.mdx"; -import SetPlayStoreKidsAppEnabled from "@android-examples/ADJConfig/setPlayStoreKidsAppEnabled.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 [`AdjustThirdPartySharing` object](/en/sdk/android/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 - -If a user opts into sharing with third-parties, call the `trackThirdPartySharing` method method with an [`AdjustThirdPartySharing` object](/en/sdk/android/reference/adjthirdpartysharing) initialized with a `true` value. This updates the user's preferences. - - - -### 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. - - - - - -| Partner name | String value | -| ----------------------- | --------------------------- | -| AppleAds | `apple_ads` | -| Facebook | `facebool` | -| GoogleAds | `adwords` | -| GoogleMarketingPlatform | `google_marketing_platform` | -| Snapchat | `snapchat` | -| Tencent | `tencent` | -| TikTokSan | `tiktok_san` | -| Twitter | `twitter` | -| YahooGemini | `yahoo_gemini` | -| YahooJapanSearch | `yahoo_japan_search` | - -
- -#### 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. | - -
- - - - -```kotlin -val adjustThirdPartySharing = AdjustThirdPartySharing(true) -adjustThirdPartySharing.addGranularOption("google_dma", "eea", "1"); -adjustThirdPartySharing.addGranularOption("google_dma", "ad_personalization", "1"); -adjustThirdPartySharing.addGranularOption("google_dma", "ad_user_data", "1"); -Adjust.trackThirdPartySharing(adjustThirdPartySharing) -``` - - - - -```java -AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(null); -adjustThirdPartySharing.addGranularOption("google_dma", "eea", "1"); -adjustThirdPartySharing.addGranularOption("google_dma", "ad_personalization", "1"); -adjustThirdPartySharing.addGranularOption("google_dma", "ad_user_data", "1"); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` - - - - -```js -let adjustThirdPartySharing = new AdjustThirdPartySharing(true); -adjustThirdPartySharing.addGranularOption("google_dma", "eea", "1"); -adjustThirdPartySharing.addGranularOption( - "google_dma", - "ad_personalization", - "1", -); -adjustThirdPartySharing.addGranularOption("google_dma", "ad_user_data", "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 `AdjustConfig` 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. - - - -## COPPA compliance - -If you need your app to be COPPA compliant, call the `setCoppaCompliantEnabled` method. This method performs the following actions: - -1. Disables third-party sharing **before** the user launches their first `session`. -2. Prevents the SDK from reading device and advertising IDs (for example: `gps_adid` and `android_id`). - - - -You can disable COPPA compliance by calling this method with a `false` argument. - - - -Disabling the `setCoppaCompliantEnabled` method doesn't re-enable third-party sharing. You need to [re-enable third-party sharing](#enable-third-party-sharing) for the user. - - - -## Play Store Kids Apps - -If your app targets users under the age of 13, and the install region **isn't** the USA, you need to mark it as a Kids App. This prevents the SDK from reading device and advertising IDs (for example: `gps_adid` and `android_id`). To do this, call the `setPlayStoreKidsAppEnabled` method with a `true` argument. - - diff --git a/src/content/docs/sdk/android/configuration/push-tokens.mdx b/src/content/docs/sdk/android/configuration/push-tokens.mdx deleted file mode 100644 index f1e1bb063..000000000 --- a/src/content/docs/sdk/android/configuration/push-tokens.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Set up push tokens -description: Configure push tokens for your app. -slug: en/sdk/android/configuration/push-tokens ---- - -import SetPushToken from "@android-examples/Adjust/setPushToken.mdx" -import SetPushTokenSig from "@android-signatures/Adjust/setPushToken.mdx" -import SetPushTokenExample from "@android-examples/Adjust/setPushTokenExample.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 `setPushToken` method and passing your token as an argument. - - - -If you have access to the push token from the web view, you can call the `setPushToken` method in Javascript. - - - - - -## Example - -This example shows how to set a new push token with the value *`HrFmrcq96tj723aWFfrw`* to track your app's retention rates. You can update this value at any time by passing a new token to the `setPushToken` method as an argument: - - - diff --git a/src/content/docs/sdk/android/features/ad-revenue.mdx b/src/content/docs/sdk/android/features/ad-revenue.mdx index 54d8b81f7..69ebe5834 100644 --- a/src/content/docs/sdk/android/features/ad-revenue.mdx +++ b/src/content/docs/sdk/android/features/ad-revenue.mdx @@ -1,26 +1,9 @@ --- -title: Record ad revenue information -description: Record ad revenue information for supported network partners using the Adjust SDK. +title: Send ad revenue information +description: Send ad revenue information for supported network partners using the Adjust SDK. slug: en/sdk/android/features/ad-revenue --- -import TrackAdRevenue from "@android-examples/Adjust/trackAdRevenue.mdx"; -import TrackAdRevenueSig from "@android-signatures/Adjust/trackAdRevenue.mdx"; -import SetRevenue from "@android-examples/ADJAdRevenue/setRevenue.mdx"; -import SetRevenueSig from "@android-signatures/ADJAdRevenue/setRevenue.mdx"; -import SetAdImpressionsCount from "@android-examples/ADJAdRevenue/setAdImpressionsCount.mdx"; -import SetAdImpressionsCountSig from "@android-signatures/ADJAdRevenue/setAdImpressionsCount.mdx"; -import SetAdRevenueNetwork from "@android-examples/ADJAdRevenue/setAdRevenueNetwork.mdx"; -import SetAdRevenueNetworkSig from "@android-signatures/ADJAdRevenue/setAdRevenueNetwork.mdx"; -import SetAdRevenueUnit from "@android-examples/ADJAdRevenue/setAdRevenueUnit.mdx"; -import SetAdRevenueUnitSig from "@android-signatures/ADJAdRevenue/setAdRevenueUnit.mdx"; -import SetAdRevenuePlacement from "@android-examples/ADJAdRevenue/setAdRevenuePlacement.mdx"; -import SetAdRevenuePlacementSig from "@android-signatures/ADJAdRevenue/setAdRevenuePlacement.mdx"; -import AddCallbackParameter from "@android-examples/ADJAdRevenue/addCallbackParameter.mdx"; -import AddCallbackParameterSig from "@android-signatures/ADJAdRevenue/addCallbackParameter.mdx"; -import AddPartnerParameter from "@android-examples/ADJAdRevenue/addPartnerParameter.mdx"; -import AddPartnerParameterSig from "@android-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 AdjustAdRevenue object + +```java title="Method signature" +public AdjustAdRevenue(final String 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 `AdjustAdRevenue` 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 `AdjustAdRevenue` instance and pass the following parameters: -## Sources +- `source` (**String**): The source of the ad revenue. See the table below for available sources @@ -50,19 +36,85 @@ To send ad revenue to Adjust: | `AdjustConfig.AD_REVENUE_UNITY` | Unity | | `AdjustConfig.AD_REVENUE_HELIUM_CHARTBOOST` | Helium Chartboost | | `AdjustConfig.AD_REVENUE_SOURCE_PUBLISHER` | Generic source | -| `AdjustConfig.AD_REVENUE_ADX` | Ad(X) |
-## Record ad revenue amount + + + +```kotlin {1} +val adjustAdRevenue = AdjustAdRevenue("source") +Adjust.trackAdRevenue(adjustAdRevenue) +``` + + -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: +```java {1} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +Adjust.trackAdRevenue(adjustAdRevenue); +``` -`revenue` **number**: The amount of revenue + -`currency` **string**: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of your reporting currency + + +```js {1} +let adjustAdRevenue = new AdjustAdRevenue("source"); +Adjust.trackAdRevenue(adjustAdRevenue); +``` + + + + +## Send ad revenue + +```java title="Method signature" +public static void trackAdRevenue(AdjustAdRevenue adRevenue) +``` + +To send ad revenue to Adjust, call the `trackAdRevenue` method with your ad revenue instance as an argument. + + + + +```kotlin {2} +val adjustAdRevenue = AdjustAdRevenue(AdjustConfig.AD_REVENUE_APPLOVIN_MAX) +Adjust.trackAdRevenue(adjustAdRevenue) +``` + + + + + +```java {2} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue(AdjustConfig.AD_REVENUE_APPLOVIN_MAX); +Adjust.trackAdRevenue(adjustAdRevenue) +``` + + + + + +```js {2} +let adjustAdRevenue = new AdjustAdRevenue(AdjustConfig.AD_REVENUE_APPLOVIN_MAX); +Adjust.trackAdRevenue(adjustAdRevenue); +``` + + + + +## Record ad revenue amount + +```java title="Method signature" +public void setRevenue(final Double revenue, final String currency) +``` + +To send the ad revenue amount, call the `setRevenue` method and pass the following arguments: + +- `revenue` (**Double**): The amount of revenue +- `currency` (**String**): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of your reporting currency @@ -70,38 +122,217 @@ Check the [guide to tracking purchases in different currencies](https://help.adj - + + + +```kotlin {2} +val adjustAdRevenue = AdjustAdRevenue("source") +adjustAdRevenue.setRevenue(1.00, "EUR") +Adjust.trackAdRevenue(adjustAdRevenue) +``` + + + + + +```java {2} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +adjustAdRevenue.setRevenue(1.00, "EUR"); +Adjust.trackAdRevenue(adjustAdRevenue); +``` + + + + + +```js {2} +let adjustAdRevenue = new AdjustAdRevenue("source"); +adjustAdRevenue.setRevenue(1.0, "EUR"); +Adjust.trackAdRevenue(adjustAdRevenue); +``` + + + ## Record ad campaign details -The ad revenue object contains properties you can use to report on your ad campaigns. +The `AdjustAdRevenue` 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. +```java title="Method signature" +public void setAdImpressionsCount(final Integer adImpressionsCount) +``` + +To send the number of recorded ad impressions, call the `setAdImpressionsCount` method and pass the following arguments: + +- `adImpressionsCount` (**Integer**): The number of ad impressions. + + + + +```kotlin {2} +val adjustAdRevenue = AdjustAdRevenue("source") +adjustAdRevenue.setAdImpressionsCount(10) +Adjust.trackAdRevenue(adjustAdRevenue) +``` + + + + + +```java {2} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +adjustAdRevenue.setAdImpressionsCount(10); +Adjust.trackAdRevenue(adjustAdRevenue); +``` + + + + + +```js {2} +let adjustAdRevenue = new AdjustAdRevenue("source"); +adjustAdRevenue.setAdImpressionsCount(10); +Adjust.trackAdRevenue(adjustAdRevenue); +``` - + + ### Ad revenue network -Record which network generated the revenue by passing a **string** value to the `setAdRevenueNetwork` method. +```java title="Method signature" +public void setAdRevenueNetwork(final String adRevenueNetwork) +``` + +To send the ad revenue network, call the `setAdRevenueNetwork` method and pass the following arguments: + +- `adRevenueNetwork` (**String**): The network name. - + + + +```kotlin {2} +val adjustAdRevenue = AdjustAdRevenue("source") +adjustAdRevenue.setAdRevenueNetwork("network1") +Adjust.trackAdRevenue(adjustAdRevenue) +``` + + + + + +```java {2} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +adjustAdRevenue.setAdRevenueNetwork("network1"); +Adjust.trackAdRevenue(adjustAdRevenue); +``` + + + + + +```js {2} +let adjustAdRevenue = new AdjustAdRevenue("source"); +adjustAdRevenue.setAdRevenueNetwork("network1"); +Adjust.trackAdRevenue(adjustAdRevenue); +``` + + + ### Ad revenue unit -Record which ad revenue unit generated the revenue by passing a **string** value to the `setAdRevenueUnit` method. +```java title="Method signature" +public void setAdRevenueUnit(final String adRevenueUnit) +``` + +To send the ad revenue unit, call the `setAdRevenueUnit` method and pass the following arguments: + +- `adRevenueUnit` (**String**): The ad unit. + + + + +```kotlin {2} +val adjustAdRevenue = AdjustAdRevenue("source") +adjustAdRevenue.setAdRevenueUnit("unit1") +Adjust.trackAdRevenue(adjustAdRevenue) +``` + + + + + +```java {2} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +adjustAdRevenue.setAdRevenueUnit("unit1"); +Adjust.trackAdRevenue(adjustAdRevenue); +``` + + - + + +```js {2} +let adjustAdRevenue = new AdjustAdRevenue("source"); +adjustAdRevenue.setAdRevenueUnit("unit1"); +Adjust.trackAdRevenue(adjustAdRevenue); +``` + + + ### Ad revenue placement -Record the placement of your ad by passing a **string** value to the `setAdRevenuePlacement` method. +```java title="Method signature" +public void setAdRevenuePlacement(final String adRevenuePlacement) +``` + +To send the ad revenue placement, call the `setAdRevenuePlacement` method and pass the following arguments: + +- `adRevenuePlacement` (**String**): The ad placement. + + + + +```kotlin {2} +val adjustAdRevenue = AdjustAdRevenue("source") +adjustAdRevenue.setAdRevenuePlacement("banner") +Adjust.trackAdRevenue(adjustAdRevenue) +``` + + + + + +```java {2} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +adjustAdRevenue.setAdRevenuePlacement("banner"); +Adjust.trackAdRevenue(adjustAdRevenue); +``` + + + + + +```js {2} +let adjustAdRevenue = new AdjustAdRevenue('source') +adjustAdRevenue.setAdRevenuePlacement('banner'); +Adjust.trackAdRevenue(adjustAdRevenue); +``` + + + - ## Add callback parameters +```java title="Method signature" +public void addCallbackParameter(final String key, final String 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. @@ -130,10 +361,44 @@ You can read more about using URL callbacks, including a full list of available - + + + +```kotlin {2} +val adjustAdRevenue = AdjustAdRevenue("source") +adjustAdRevenue.addCallbackParameter("key", "value") +Adjust.trackAdRevenue(adjustAdRevenue) +``` + + + + + +```java {2} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +adjustAdRevenue.addCallbackParameter("key", "value"); +Adjust.trackAdRevenue(adjustAdRevenue); +``` + + + + + +```js {2} +let adjustAdRevenue = new AdjustAdRevenue('source') +adjustAdRevenue.addCallbackParameter('key', 'value'); +Adjust.trackAdRevenue(adjustAdRevenue); +``` + + + ## Add partner parameters +```java title="Method signature" +public void addPartnerParameter(String key, String 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 +411,37 @@ 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. - + + + +```kotlin {2} +val adjustAdRevenue = AdjustAdRevenue("source") +adjustAdRevenue.addPartnerParameter("key", "value") +Adjust.trackAdRevenue(adjustAdRevenue) +``` + + + + + +```java {2} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +adjustAdRevenue.addPartnerParameter("key", "value"); +Adjust.trackAdRevenue(adjustAdRevenue); +``` + + + + + +```js {2} +let adjustAdRevenue = new AdjustAdRevenue('source') +adjustAdRevenue.addPartnerParameter('key', 'value'); +Adjust.trackAdRevenue(adjustAdRevenue); +``` + + + ## Example diff --git a/src/content/docs/sdk/android/features/attribution.mdx b/src/content/docs/sdk/android/features/attribution.mdx index 562f58e36..f6bfeffee 100644 --- a/src/content/docs/sdk/android/features/attribution.mdx +++ b/src/content/docs/sdk/android/features/attribution.mdx @@ -4,34 +4,181 @@ description: Listen for attribution changes using the Adjust SDK slug: en/sdk/android/features/attribution --- -import SetOnAttributionChangedListenerSig from "@android-signatures/ADJConfig/setOnAttributionChangedListener.mdx"; -import SetOnAttributionChangedListener from "@android-examples/ADJConfig/setOnAttributionChangedListener.mdx"; -import Attribution from "@android-examples/Adjust/attribution.mdx"; -import AttributionSig from "@android-signatures/Adjust/attribution.mdx"; -import SetOnAttributionChangedListenerFacebook from "@android-examples/ADJConfig/setOnAttributionChangedListenerFacebook.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. +## AdjustAttribution class properties -To configure your callback function, call the `setOnAttributionChangedListener` method with your function name as an argument. +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 `AdjustConfig` instance](/en/sdk/android/configuration#enable-cost-data-sending) 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. | +| `fbInstallReferrer` | String | The [Facebook install referrer](https://developers.facebook.com/docs/app-ads/install-referrer/). | + +
+ +## Trigger a function when attribution changes + +```java title="Method signature" +public void setOnAttributionChangedListener(OnAttributionChangedListener onAttributionChangedListener) +``` + +The SDK can listen for attribution changes and call a function when it detects an update. To configure your callback function, call the `setOnAttributionChangedListener` method with your function name as an argument. -You must call the `setOnAttributionChangedListener` method before initializing the Adjust SDK in your app. +You must call the `setOnAttributionChangedListener` method **before** initializing the Adjust SDK in your app. - + + + +```kotlin {3-5} +val config = AdjustConfig(this, appToken, environment) +//... +config.setOnAttributionChangedListener { + override fun onAttributionChanged(attribution: AdjustAttribution) {} + } +//... +Adjust.onCreate(config) +``` + + + + +```java {3-6} +AdjustConfig config = new AdjustConfig(this, appToken, environment); +//... +config.setOnAttributionChangedListener(new OnAttributionChangedListener() { + @Override + public void onAttributionChanged(AdjustAttribution attribution) {} +}); +//... +Adjust.onCreate(config); +``` + + + + +```js +function attributionCallback(attribution) {} +//... +let adjustConfig = new AdjustConfig(yourAppToken, environment); +adjustConfig.setAttributionCallback(attributionCallback); +Adjust.onCreate(adjustConfig); +``` -## Facebook install referrer + + -The Adjust SDK receives Facebook install referrer information as a **string** property in the [`AdjustAttribution` object](/en/sdk/android/reference/adjattribution). You can access this information by serializing the content as a JSON object. +### Facebook install referrer - +The Adjust SDK receives Facebook install referrer information as a **string** property in the [`AdjustAttribution` object](#adjustattribution-class-properties). You can access this information by serializing the content as a JSON object. + + + + +```kotlin {3-14} +val config = AdjustConfig(this, appToken, environment) +//... +config.setOnAttributionChangedListener { + val fbInstallReferrerJSONObject = extractFBInstallReferrerJSON(it) +} + +fun extractFBInstallReferrerJSON(adjustAttribution: AdjustAttribution): JSONObject? { + try { + return JSONObject(adjustAttribution.fbInstallReferrer) + } catch (e: JSONException) { + Log.d("example", e.message!!) + } + return null +} +//... +Adjust.onCreate(config) +``` + + + + +```java {3-18} +AdjustConfig config = new AdjustConfig(this, appToken, environment); +//... +config.setOnAttributionChangedListener(new OnAttributionChangedListener() { + @Override + public void onAttributionChanged(AdjustAttribution adjustAttribution) { + JSONObject fbInstallReferrerJSONObject = extractFBInstallReferrerJSON(adjustAttribution); + } +}); + +@Nullable +JSONObject extractFBInstallReferrerJSON(AdjustAttribution adjustAttribution) { + try { + return new JSONObject(adjustAttribution.fbInstallReferrer); + } catch (JSONException e) { + Log.d("example", e.getMessage()); + } + return null; +} +//... +Adjust.onCreate(config); +``` + + + ## 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. +```java title="Method signature" +public static AdjustAttribution getAttribution() +``` + +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 `getAttribution` method to return the attribution information as an `AdjustAttribution` object. + + + + +```kotlin +val attribution = Adjust.getAttribution() +``` + + + + + +```java +AdjustAttribution attribution = Adjust.getAttribution(); +``` + + + + -This method returns an Attribution object. See the [`AdjustAttribution` class reference](/en/sdk/android/reference/adjattribution) for a list of available properties. +```js +let attribution = Adjust.getAttribution(); +``` - + + diff --git a/src/content/docs/sdk/android/features/callbacks.mdx b/src/content/docs/sdk/android/features/callbacks.mdx index eb94ec05f..1741d800d 100644 --- a/src/content/docs/sdk/android/features/callbacks.mdx +++ b/src/content/docs/sdk/android/features/callbacks.mdx @@ -4,20 +4,11 @@ description: Use these methods to send callback information to Adjust. slug: en/sdk/android/features/callbacks --- -import SetOnSessionTrackingSucceededListener from "@android-examples/ADJConfig/setOnSessionTrackingSucceededListener.mdx" -import SetOnSessionTrackingSucceededListenerExample from "@android-examples/ADJConfig/setOnSessionTrackingSucceededListenerExample.mdx" -import SetOnSessionTrackingFailedListener from "@android-examples/ADJConfig/setOnSessionTrackingFailedListener.mdx" -import SetOnSessionTrackingFailedListenerExample from "@android-examples/ADJConfig/setOnSessionTrackingFailedListenerExample.mdx" -import SetOnEventTrackingSucceededListener from "@android-examples/ADJConfig/setOnEventTrackingSucceededListener.mdx" -import SetOnEventTrackingSucceededListenerExample from "@android-examples/ADJConfig/setOnEventTrackingSucceededListenerExample.mdx" -import SetOnEventTrackingFailedListener from "@android-examples/ADJConfig/setOnEventTrackingFailedListener.mdx" -import SetOnEventTrackingFailedListenerExample from "@android-examples/ADJConfig/setOnEventTrackingFailedListenerExample.mdx" - Set up callbacks to trigger functions when the SDK sends information to Adjust. You can set up callbacks for **sessions** and **events**. -You must register your callbacks before initializing the SDK. +You must register your callbacks **before** initializing the SDK. @@ -29,39 +20,230 @@ Session callbacks have access to a response data object. You can use its propert -| Property | Data type | Description | -| --------------- | --------------------------- | --------------------- | -| `Message` | String | The message from the server or the error logged by the SDK. | -| `Timestamp` | String | The timestamp from Adjust's servers. | -| `Adid` | String | A unique device identifier provided by Adjust. | -| `JsonResponse` | Dictionary `` | The JSON object with the response from the server. | -| `WillRetry` | Boolean | Indicates whether there will be an attempt to resend a failed package. | +| Property | Data type | Description | +| -------------- | ----------------------------- | ---------------------------------------------------------------------- | +| `Message` | String | The message from the server or the error logged by the SDK. | +| `Timestamp` | String | The timestamp from Adjust's servers. | +| `Adid` | String | A unique device identifier provided by Adjust. | +| `JsonResponse` | Dictionary `` | The JSON object with the response from the server. | +| `WillRetry` | Boolean | Indicates whether there will be an attempt to resend a failed package. |
### Success callbacks -Set up success callbacks to trigger functions when the SDK records a session. +```java title="Method signature" +public void setOnSessionTrackingSucceededListener(OnSessionTrackingSucceededListener onSessionTrackingSucceededListener) +``` - +Set up success callbacks to trigger functions when the SDK records a session. -### Example + + + +```kotlin {3-7} +val config = AdjustConfig(this, appToken, environment) +//... +config.setOnSessionTrackingSucceededListener(new OnSessionTrackingSucceededListener() { + override fun onFinishedSessionTrackingSucceeded(sessionSuccessResponseData: AdjustSessionSuccess) { + //... + } +}) +//... +Adjust.onCreate(config) +``` + + + + +```java {3-8} +AdjustConfig config = new AdjustConfig(this, appToken, environment); +//... +config.setOnSessionTrackingSucceededListener(new OnSessionTrackingSucceededListener() { + @Override + public void onFinishedSessionTrackingSucceeded(AdjustSessionSuccess sessionSuccessResponseData) { + //... + } +}); +//... +Adjust.onCreate(config) +``` + + + + +```js +function sessionSuccessCallback(sessionSuccessResponseData) {} +//... +let adjustConfig = new AdjustConfig(appToken, environment); +adjustConfig.setSessionSuccessCallback(sessionSuccessCallback); +//... +Adjust.onCreate(adjustConfig); +``` + + + + +#### Example This example shows how to created a callback function `sessionSuccess` and register it as a **success** callback. The function logs the timestamp at which the SDK recorded the session. - + + + +```kotlin +val config = AdjustConfig(this, appToken, environment) + +config.setOnSessionTrackingSucceededListener(new OnSessionTrackingSucceededListener() { + override fun sessionSuccess(sessionSuccessResponseData: AdjustSessionSuccess) { + Log.v("Session recorded at " + sessionSuccessResponseData.Timestamp) + } +}) + +Adjust.onCreate(config) +``` + + + + +```java +AdjustConfig config = new AdjustConfig(this, appToken, environment); + +config.setOnSessionTrackingSucceededListener(new OnSessionTrackingSucceededListener() { + @Override + public void sessionSuccess(AdjustSessionSuccess sessionSuccessResponseData) { + Log.v("Session recorded at " + sessionSuccessResponseData.Timestamp) + } +}); + +Adjust.onCreate(config) +``` + + + + +```js +function sessionSuccess(sessionSuccessResponseData) { + console.log("Session recorded at " + sessionSuccessResponseData.Timestamp); +} + +let adjustConfig = new AdjustConfig(appToken, environment); +adjustConfig.setSessionSuccessCallback(sessionSuccess); + +Adjust.onCreate(adjustConfig); +``` + + + ### Failure callbacks -Set up failure callbacks to trigger functions when the SDK fails to record a session. +```java title="Method signature" +public void setOnSessionTrackingFailedListener(OnSessionTrackingFailedListener onSessionTrackingFailedListener) +``` - +Set up failure callbacks to trigger functions when the SDK fails to record a session. -### Example + + + +```kotlin {3-7} +val config = AdjustConfig(this, appToken, environment) +//... +config.setOnSessionTrackingFailedListener(new OnSessionTrackingFailedListener() { + override fun onFinishedSessionTrackingFailed(sessionFailureResponseData: AdjustSessionFailure) { + //... + } +}) +//... +Adjust.onCreate(config) +``` + + + + +```java {3-8} +AdjustConfig config = new AdjustConfig(this, appToken, environment); +//... +config.setOnSessionTrackingFailedListener(new OnSessionTrackingFailedListener() { + @Override + public void onFinishedSessionTrackingFailed(AdjustSessionFailure sessionFailureResponseData) { + //... + } +}); +//... +Adjust.onCreate(config) +``` + + + + +```js +function sessionFailureCallback(sessionFailureResponseData) {} +//... +let adjustConfig = new AdjustConfig(appToken, environment); +adjustConfig.setSessionFailureCallback(sessionFailureCallback); +//... +Adjust.onCreate(adjustConfig); +``` + + + + +#### Example This example shows how to created a callback function `sessionFailure` and register it as a **failure** callback. The function logs the session failure message. - + + + +```kotlin +val config = AdjustConfig(this, appToken, environment) + +config.setOnSessionTrackingFailedListener(new OnSessionTrackingFailedListener() { + override fun sessionFailure(sessionFailureResponseData: AdjustSessionFailure) { + Log.v("Session recording failed. Response: " + sessionFailureResponseData.Message) + } +}) + +Adjust.onCreate(config) +``` + + + + +```java +AdjustConfig config = new AdjustConfig(this, appToken, environment); + +config.setOnSessionTrackingFailedListener(new OnSessionTrackingFailedListener() { + @Override + public void sessionFailure(AdjustSessionFailure sessionFailureResponseData) { + Log.v("Session recording failed. Response: " + sessionFailureResponseData.Message) + } +}); + +Adjust.onCreate(config) +``` + + + + +```js +function sessionFailure(sessionFailureResponseData) { + console.log( + "Session recording failed. Response: " + + sessionFailureResponseData.Message + ); +} + +let adjustConfig = new AdjustConfig(appToken, environment); +adjustConfig.setSessionFailureCallback(sessionFailure); + +Adjust.onCreate(adjustConfig); +``` + + + ## Event callbacks @@ -71,38 +253,228 @@ Event callbacks have access to a response data object. You can use its propertie -| Property | Data type | Description | -| --------------- | --------------------------- | --------------------- | -| `Message` | String | The message from the server or the error logged by the SDK. | -| `Timestamp` | String | The timestamp from Adjust's servers. | -| `Adid` | String | A unique device identifier provided by Adjust. | -| `EventToken` | String | The event token | -| `CallbackId` | String | The custom callback ID set on the event object | -| `JsonResponse` | Dictionary `` | The JSON object with the response from the server. | -| `WillRetry` | Boolean | Indicates whether there will be an attempt to resend a failed package. | +| Property | Data type | Description | +| -------------- | ----------------------------- | ---------------------------------------------------------------------- | +| `Message` | String | The message from the server or the error logged by the SDK. | +| `Timestamp` | String | The timestamp from Adjust's servers. | +| `Adid` | String | A unique device identifier provided by Adjust. | +| `EventToken` | String | The event token | +| `CallbackId` | String | The custom callback ID set on the event object | +| `JsonResponse` | Dictionary `` | The JSON object with the response from the server. | +| `WillRetry` | Boolean | Indicates whether there will be an attempt to resend a failed package. |
### Success callbacks -Set up success callbacks to trigger functions when the SDK records an event. +```java title="Method signature" +public void setOnEventTrackingSucceededListener(OnEventTrackingSucceededListener onEventTrackingSucceededListener) +``` - +Set up success callbacks to trigger functions when the SDK records an event. -### Example + + + +```kotlin {3-7} +val config = AdjustConfig(this, appToken, environment) +//... +config.setOnEventTrackingSucceededListener(new OnEventTrackingSucceededListener() { + override fun onFinishedEventTrackingSucceeded(eventSuccessResponseData: AdjustEventSuccess) { + //... + } +}) +//... +Adjust.onCreate(config) +``` + + + + +```java {3-8} +AdjustConfig config = new AdjustConfig(this, appToken, environment); +//... +config.setOnEventTrackingSucceededListener(new OnEventTrackingSucceededListener() { + @Override + public void onFinishedEventTrackingSucceeded(AdjustEventSuccess eventSuccessResponseData) { + //... + } +}); +//... +Adjust.onCreate(config) +``` + + + + +```js +function eventSuccessCallback(eventSuccessResponseData) {} +//... +let adjustConfig = new AdjustConfig(appToken, environment); +adjustConfig.setEventSuccessCallback(eventSuccessCallback); +//... +Adjust.onCreate(adjustConfig); +``` + + + + +#### Example This example shows how to created a callback function `eventSuccess` and register it as a **success** callback. The function logs the timestamp at which the SDK recorded the event. - + + + +```kotlin +val config = AdjustConfig(this, appToken, environment) + +config.setOnEventTrackingSucceededListener(new OnEventTrackingSucceededListener() { + override fun eventSuccess(eventSuccessResponseData: AdjustEventSuccess) { + Log.v("Event recorded at " + eventSuccessResponseData.Timestamp) + } +}) + +Adjust.onCreate(config) +``` + + + + +```java +AdjustConfig config = new AdjustConfig(this, appToken, environment); + +config.setOnEventTrackingSucceededListener(new OnEventTrackingSucceededListener() { + @Override + public void eventSuccess(AdjustEventSuccess eventSuccessResponseData) { + Log.v("Event recorded at " + eventSuccessResponseData.Timestamp) + } +}); + +Adjust.onCreate(config) +``` + + + + +```js +function eventSuccess(eventSuccessResponseData) { + console.log("Event recorded at " + eventSuccessResponseData.Timestamp); +} + +let adjustConfig = new AdjustConfig(appToken, environment); +adjustConfig.setEventSuccessCallback(eventSuccess); + +Adjust.onCreate(adjustConfig); +``` + + + ### Failure callbacks -Set up failure callbacks to trigger functions when the SDK fails to record an event. +```java title="Method signature" +public void setOnEventTrackingFailedListener(OnEventTrackingFailedListener onEventTrackingFailedListener) +``` - +Set up failure callbacks to trigger functions when the SDK fails to record an event. -### Example + + + +```kotlin {3-7} +val config = AdjustConfig(this, appToken, environment) +//... +config.setOnEventTrackingFailedListener (OnEventTrackingFailedListener() { + override fun onFinishedEventTrackingFailed(eventFailureResponseData: AdjustEventFailure) { + //... + } +}) +//... +Adjust.onCreate(config) +``` + + + + +```java {3-8} +AdjustConfig config = new AdjustConfig(this, appToken, environment); +//... +config.setOnEventTrackingFailedListener(new OnEventTrackingFailedListener() { + @Override + public void onFinishedEventTrackingFailed(AdjustEventFailure eventFailureResponseData) { + //... + } +}); +//... +Adjust.onCreate(config) +``` + + + + +```js +function eventFailureCallback(eventFailureResponseData) {} +//... +let adjustConfig = new AdjustConfig(appToken, environment); +adjustConfig.setEventFailureCallback(eventFailureCallback); +//... +Adjust.onCreate(adjustConfig); +``` + + + + +#### Example This example shows how to created a callback function `eventFailure` and register it as a **failure** callback. The function logs the event failure message. - + + + +```kotlin +val config = AdjustConfig(this, appToken, environment) + +config.setOnEventTrackingFailedListener(new OnEventTrackingFailedListener() { + override fun eventFailure(eventFailureResponseData: AdjustEventFailure) { + Log.v("Event recording failed. Response: " + eventFailureResponseData.Message) + } +}) + +Adjust.onCreate(config) +``` + + + + +```java +AdjustConfig config = new AdjustConfig(this, appToken, environment); + +config.setOnEventTrackingFailedListener(new OnEventTrackingFailedListener() { + @Override + public void eventFailure(AdjustEventFailure eventFailureResponseData) { + Log.v("Event recording failed. Response: " + eventFailureResponseData.Message) + } +}); + +Adjust.onCreate(config) +``` + + + + +```js +function eventFailure(eventFailureResponseData) { + console.log( + "Event recording failed. Response: " + eventFailureResponseData.Message + ); +} + +let adjustConfig = new AdjustConfig(appToken, environment); +adjustConfig.setEventFailureCallback(sessionFailure); + +Adjust.onCreate(adjustConfig); +``` + + + diff --git a/src/content/docs/sdk/android/configuration/deep-linking.mdx b/src/content/docs/sdk/android/features/deep-linking.mdx similarity index 64% rename from src/content/docs/sdk/android/configuration/deep-linking.mdx rename to src/content/docs/sdk/android/features/deep-linking.mdx index c146d233c..9c28d9754 100644 --- a/src/content/docs/sdk/android/configuration/deep-linking.mdx +++ b/src/content/docs/sdk/android/features/deep-linking.mdx @@ -1,19 +1,13 @@ --- title: Set up deep linking description: Configure the SDK to use deep links. -slug: en/sdk/android/configuration/deep-links +slug: en/sdk/android/features/deep-links --- -import SetOnDeeplinkResponseListenerSig from "@android-signatures/ADJConfig/setOnDeeplinkResponseListener.mdx" -import SetOnDeeplinkResponseListener from "@android-examples/ADJConfig/setOnDeeplinkResponseListener.mdx" -import AppWillOpenUrlSig from "@android-signatures/Adjust/appWillOpenUrl.mdx" -import AppWillOpenUrl from "@android-examples/Adjust/appWillOpenUrl.mdx" - 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. +- 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. @@ -31,7 +25,7 @@ You can launch a specific activity when a user interacts with a deep link. To do This example shows how to set up an activity called `MainActivity` to open with the **scheme name** `adjustExample`. -```xml '".MainActivity"' '"adjustExample"' +```xml title="AndroidManifest.xml" '".MainActivity"' '"adjustExample"' + + + +```kotlin {3-7} +val config = AdjustConfig(this, appToken, environment) +//... +config.setOnDeeplinkResponseListener { deeplink -> + Log.d("example", "Deferred deep link callback called!") + Log.d("example", "Deep link URL: $deeplink") + true +} +//... +Adjust.onCreate(config) +``` + + + + +```java {3-12} +AdjustConfig config = new AdjustConfig(this, appToken, environment); +//... +// Evaluate the deeplink to be launched. +config.setOnDeeplinkResponseListener(new OnDeeplinkResponseListener() { + @Override + public boolean launchReceivedDeeplink(Uri deeplink) { + Log.d("example", "Deferred deep link callback called!"); + Log.d("example", "Deep link URL: " + deeplink); + + return true; + } +}); +//... +Adjust.onCreate(config); +``` + + + + +```js {1-4} +function deferredDeeplinkCallback(deeplink) { + console.log("Deferred deep link callback called!"); + console.log(`Deep link URL: ${deeplink}`); +} +//... +let adjustConfig = new AdjustConfig(yourAppToken, environment); +adjustConfig.setOpenDeferredDeeplink(true); +adjustConfig.setDeferredDeeplinkCallback(deferredDeeplinkCallback); +//... +Adjust.start(adjustConfig); +``` + + + ### Example @@ -173,21 +223,68 @@ config.setOnDeeplinkResponseListener(new OnDeeplinkResponseListener() { ## Reattribution via deep links +```java title="Method signature" +public static void appWillOpenUrl(Uri url, Context context) +``` + Adjust enables you to run re-engagement campaigns with usage of deep links. For more information, see the [guide to appending attribution data to a deep link](https://help.adjust.com/en/article/deeplink-generator#manage-your-deeplinks). -To reattribute your user, you need to call the `appWillOpenUrl` method when the app receives deep link content. The Adjust SDK then looks for new attribution data within the deep link. If the SDK finds new information, it forwards the information to Adjust's servers for reattribution. +To reattribute your user, you need to call the `appWillOpenUrl` method when the app receives deep link content. The Adjust SDK then looks for new attribution data within the deep link. If the SDK finds new information, it forwards the information to Adjust's servers for reattribution. + + + + +```kotlin +override fun onCreate(savedInstanceState: Bundle?) { + super.onCreate(savedInstanceState) + setContentView(R.layout.activity_main) + + val intent = intent + val data = intent.data + Adjust.appWillOpenUrl(data, getApplicationContext()) +} +``` - + + + +```java +@Override +protected void onCreate(Bundle savedInstanceState) { + super.onCreate(savedInstanceState); + setContentView(R.layout.activity_main); + + Intent intent = getIntent(); + Uri data = intent.getData(); + Adjust.appWillOpenUrl(data, getApplicationContext()); +} +``` + + + + +```js +Adjust.appWillOpenUrl(deeplinkUrl); +``` + + + ## Link resolution -Some ESPs (Email Service Providers) use their own custom tracking domains for marketing campaigns. If you need to track clicks through a custom domain, you need to set the SDK up to resolve the link. To do this, call the `resolveLink` method of the `AdjustLinkResolution` class. The Adjust SDK will then follow the custom link and resolve it when opening the deep link. This ensures that you record the interaction with your email tracking campaign. +```java title="Method signature" +public static void resolveLink(final String url, + final String[] resolveUrlSuffixArray, + final AdjustLinkResolutionCallback adjustLinkResolutionCallback) +``` + +Some Email Service Providers (ESPs) use their own custom tracking domains for marketing campaigns. If you need to track clicks through a custom domain, you need to set the SDK up to resolve the link. To do this, call the `resolveLink` method of the `AdjustLinkResolution` class. The Adjust SDK will then follow the custom link and resolve it when opening the deep link. This ensures that you record the interaction with your email tracking campaign. -The `resolveLinkWithUrl` method takes the following parameters: +The `resolveLinkWithUrl` method takes the following arguments: -- `url`: the deep link that opened the application. -- `resolveUrlSuffixArray`: the custom domains of the configured campaigns that need to be resolved. -- `adjustLinkResolutionCallback`: the callback that contains the final URL. +- `url` (**String**): the deep link that opened the application. +- `resolveUrlSuffixArray` (**String array**): the custom domains of the configured campaigns that need to be resolved. +- `adjustLinkResolutionCallback` (`AdjustLinkResolutionCallback`): the callback that returns the final URL. The method checks the deep link against the domains in the `resolveUrlSuffixArray`. If it doesn't find any matches, it forwards the deep link URL as is. If it does find a match, it attempts to resolve the link and return the resulting deep link. It then stores this in the callback parameter. @@ -205,9 +302,9 @@ You can use the returned deep link to reattribute your user. To do this, pass th ```kotlin AdjustLinkResolution.resolveLink(url, arrayOf("example.com"), object : AdjustLinkResolution.AdjustLinkResolutionCallback { override fun resolvedLinkCallback(resolvedLink: Uri) { - Adjust.appWillOpenUrl(resolvedLink, applicationContext) - } - }) + Adjust.appWillOpenUrl(resolvedLink, applicationContext) + } +}) ``` diff --git a/src/content/docs/sdk/android/features/device-info.mdx b/src/content/docs/sdk/android/features/device-info.mdx index a7bc46da5..479a63589 100644 --- a/src/content/docs/sdk/android/features/device-info.mdx +++ b/src/content/docs/sdk/android/features/device-info.mdx @@ -4,34 +4,117 @@ description: Use these methods to add details to your callbacks and improve your slug: en/sdk/android/features/device-info --- -import Adid from "@android-examples/Adjust/adid.mdx" -import AdidSig from "@android-signatures/Adjust/adid.mdx" -import GetGoogleAdIdSig from "@android-signatures/Adjust/getGoogleAdId.mdx" -import GetGoogleAdId from "@android-examples/Adjust/getGoogleAdId.mdx" -import GetAmazonAdIdSig from "@android-signatures/Adjust/getAmazonAdId.mdx" -import GetAmazonAdId from "@android-examples/Adjust/getAmazonAdId.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 -Adjust generates a unique ADID (Adjust Device ID) for each device. Call the `adid` method to return this ID as a **string**. +```java title="Method signature" +public static String getAdid() +``` + +Adjust generates a unique Adjust Device ID (ADID) for each device. Call the `getAdid` method to return this ID as a **string**. + + + + +```kotlin +val adid = Adjust.getAdid() +``` + + + + + +```java +String adid = Adjust.getAdid(); +``` - + + + + +```js +let adid = Adjust.getAdid(); +``` + + + ## Google Play Services Advertising ID -The GPS ADID (Google Play Services Advertising ID) is a device-specific identifier for Android devices. +```java title="Method signature" +public static void getGoogleAdId(Context context, OnDeviceIdsRead onDeviceIdRead) +``` + +The Google Play Services Advertising ID (GPS ADID) is a device-specific identifier for Android devices. Users can opt out of sharing their GPS ADID by toggling the "Opt out of Ads Personalization" setting on their device. When a user enables this setting, the Adjust SDK returns a string of zeros when trying to read the GPS ADID. You can access this value by calling the `getGoogleAdId` method in a background thread. Assign a delegate function to access the GPS ADID value. - + + + +```kotlin +Adjust.getGoogleAdId(this, object : OnDeviceIdsRead { + override fun onGoogleAdIdRead(googleAdId: String) {} +}) +``` + + + + + +```java +Adjust.getGoogleAdId(this, new OnDeviceIdsRead() { + @Override + public void onGoogleAdIdRead(String googleAdId) {} +}); +``` + + + + + +```js +Adjust.getGoogleAdId(function(googleAdId) { + // ... +}); +``` + + + ## Amazon Advertiser ID -The Amazon Ad ID (Amazon Advertising ID) is a device-specific identifier for Android devices. Call the `getAmazonAdId` method to return this ID as a **string**. +```java title="Method signature" +public static String getAmazonAdId(final Context context) +``` + +The Amazon Advertising ID (Amazon Ad ID) is a device-specific identifier for Android devices. Call the `getAmazonAdId` method to return this ID as a **string**. + + + + +```kotlin +val amazonAdId = Adjust.getAmazonAdId(getApplicationContext()) +``` + + + + + +```java +String amazonAdId = Adjust.getAmazonAdId(getApplicationContext()); +``` + + + + + +```js +let amazonAdId = Adjust.getAmazonAdId(); +``` - + + diff --git a/src/content/docs/sdk/android/features/events.mdx b/src/content/docs/sdk/android/features/events.mdx index 0dabe4550..8b826522c 100644 --- a/src/content/docs/sdk/android/features/events.mdx +++ b/src/content/docs/sdk/android/features/events.mdx @@ -4,35 +4,124 @@ description: Use these methods to send event information to Adjust. slug: en/sdk/android/features/events --- -import TrackEvent from "@android-examples/Adjust/trackEvent.mdx"; -import TrackEventSig from "@android-signatures/Adjust/trackEvent.mdx"; -import TrackEventExample from "@android-examples/Adjust/trackEventExample.mdx"; -import SetRevenue from "@android-examples/ADJEvent/setRevenue.mdx"; -import SetRevenueSig from "@android-signatures/ADJEvent/setRevenue.mdx"; -import SetRevenueExample from "@android-examples/ADJEvent/setRevenueExample.mdx"; -import SetOrderId from "@android-examples/ADJEvent/setOrderId.mdx"; -import SetOrderIdSig from "@android-signatures/ADJEvent/setOrderId.mdx"; -import SetOrderIdExample from "@android-examples/ADJEvent/setOrderIdExample.mdx"; -import SetCallbackId from "@android-examples/ADJEvent/setCallbackId.mdx"; -import SetCallbackIdSig from "@android-signatures/ADJEvent/setCallbackId.mdx"; -import SetCallbackIdExample from "@android-examples/ADJEvent/setCallbackIdExample.mdx"; -import AddCallbackParameter from "@android-examples/ADJEvent/addCallbackParameter.mdx"; -import AddCallbackParameterSig from "@android-signatures/ADJEvent/addCallbackParameter.mdx"; -import AddCallbackParameterExample from "@android-examples/ADJEvent/addCallbackParameterExample.mdx"; -import AddPartnerParameter from "@android-examples/ADJEvent/addPartnerParameter.mdx"; -import AddPartnerParameterSig from "@android-signatures/ADJEvent/addPartnerParameter.mdx"; -import AddPartnerParameterExample from "@android-examples/ADJEvent/addPartnerParameterExample.mdx"; +The Adjust SDK provides an `AdjustEvent` object which can be used to structure and send event information from your app to Adjust's servers. + +## Instantiate an AdjustEvent object + +```java title="Method signature" +public AdjustEvent(String eventToken) +``` + +To send event information with the Adjust SDK, you need to instantiate an `AdjustEvent` 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 `AdjustEvent` instance and pass the following parameters: + +- `eventToken` (**String**): Your Adjust [event token](https://help.adjust.com/en/article/add-events#manage-your-events). + + + + +```kotlin {1} +val adjustEvent = AdjustEvent("abc123") +Adjust.trackEvent(adjustEvent) +``` + + + + +```java {1} +AdjustEvent adjustEvent = new AdjustEvent("abc123"); +Adjust.trackEvent(adjustEvent); +``` + + + +```js {1} +let adjustEvent = new AdjustEvent('abc123'); +Adjust.trackEvent(adjustEvent); +``` + + + + +## Send an event + +```java title="Method signature" +public static void trackEvent(AdjustEvent 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. - + + + +```kotlin {2} +val adjustEvent = AdjustEvent("abc123") +Adjust.trackEvent(adjustEvent) +``` + + + + +```java {2} +AdjustEvent adjustEvent = new AdjustEvent("abc123"); +Adjust.trackEvent(adjustEvent); +``` + + + + +```js {2} +let 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. - + + + +```kotlin +fun onTrackSimpleEventClick(v: View) { + val event = AdjustEvent("g3mfiw") + Adjust.trackEvent(event) +} +``` + + + + +```java +public void onTrackSimpleEventClick(View v) { + AdjustEvent event = new AdjustEvent("g3mfiw"); + Adjust.trackEvent(event); +} +``` + + + + +```js +window.onload = function () { + var btnTrackSimpleEvent = document.getElementById("btnTrackSimpleEvent"); + btnTrackSimpleEvent.onclick = function (e) { + e.preventDefault(); + var adjustEvent = new AdjustEvent("g3mfiw"); + Adjust.trackEvent(adjustEvent); + }; +}; +``` + + + ```txt collapse={6-46} title="Event log" Path: /event @@ -85,13 +174,16 @@ Parameters: ## Record event revenue +```java title="Method signature" +public void setRevenue(double revenue, String 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. @@ -99,13 +191,78 @@ Check the guide to [tracking purchases in different currencies](https://help.adj - + + + +```kotlin {2} +val adjustEvent = AdjustEvent("abc123") +adjustEvent.setRevenue(0.01, "EUR") +Adjust.trackEvent(adjustEvent) +``` + + + + +```java {2} +AdjustEvent adjustEvent = new AdjustEvent("abc123"); +adjustEvent.setRevenue(0.01, "EUR"); +Adjust.trackEvent(adjustEvent); +``` + + + + +```js {2} +let adjustEvent = new AdjustEvent("abc123"); +adjustEvent.setRevenue(0.01, "EUR"); +Adjust.trackEvent(adjustEvent); +``` + + + ### Example This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. The function sets the `revenue` property of this event to _`0.25`_ and the `currency` property to _`EUR`_. - + + + +```kotlin +fun onTrackRevenueEventClick(v: View) { + val event = AdjustEvent("g3mfiw") + event.setRevenue(0.25, "EUR") + Adjust.trackEvent(event) +} +``` + + + + +```java +public void onTrackRevenueEventClick(View v) { + AdjustEvent event = new AdjustEvent("g3mfiw"); + event.setRevenue(0.25, "EUR") + Adjust.trackEvent(event); +} +``` + + + +```js +window.onload = function() { + var btnTrackRevenueEvent = document.getElementById('btnTrackRevenueEvent') + btnTrackRevenueEvent.onclick = function(e) { + e.preventDefault(); + var adjustEvent = new AdjustEvent('g3mfiw'); + adjustEvent.setRevenue(0.25, 'EUR'); + Adjust.trackEvent(adjustEvent); + } +} +``` + + + ```txt title="Event log" {7,8} Path: /event @@ -120,15 +277,20 @@ Parameters: ### Purchase verification + + +Purchase verification is an **optional** feature. These settings have no effect unless purchase verification is enabled. + + + If you've enabled [purchase verification](https://help.adjust.com/en/article/purchase-verification), you must send additional information with your purchase events to verify them. When Adjust's servers receive this information in an event object, they forward it to Apple to verify the purchase. -`productId` (String): The product identifier of the item that was successfully purchased - -`purchaseToken` (String): The purchase token generated for your successfully completed in-app purchase +- `productId` (**String**): The product identifier of the item that was successfully purchased +- `purchaseToken` (**String**): The purchase token generated for your successfully completed in-app purchase @@ -155,19 +317,90 @@ Adjust.trackEvent(adjustEvent); -## Unique events +## Set a unique order ID + +```java title="Method signature" +public void setOrderId(String orderId) +``` You can pass an optional identifier to avoid recording duplicate events. The SDK stores the last ten identifiers and skips revenue events with duplicate transaction IDs. To set the identifier, call the `setOrderId` method and pass your transaction ID as a **string** argument. - + + + +```kotlin {3} +val adjustEvent = AdjustEvent("abc123") +adjustEvent.setRevenue(0.01, "EUR") +adjustEvent.setOrderId("{OrderId}") +Adjust.trackEvent(adjustEvent) +``` + + + + +```java {3} +AdjustEvent adjustEvent = new AdjustEvent("abc123"); +adjustEvent.setRevenue(0.01, "EUR"); +adjustEvent.setOrderId("{OrderId}"); +Adjust.trackEvent(adjustEvent); +``` + + + +```js {3} +let adjustEvent = new AdjustEvent('abc123'); +adjustEvent.setRevenue(0.01, 'EUR'); +adjustEvent.setOrderId('{OrderId}'); +Adjust.trackEvent(event); +``` + + + ### Example This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. The function sets the `orderId` to `5e85484b-1ebc-4141-aab7-25b869e54c49` using the `setOrderId` method. - + + + +```kotlin +fun onTrackUniqueEventClick(v: View) { + val event = AdjustEvent("g3mfiw") + event.setOrderId("5e85484b-1ebc-4141-aab7-25b869e54c49") + Adjust.trackEvent(event) +} +``` + + + + +```java +public void onTrackUniqueEventClick(View v) { + AdjustEvent event = new AdjustEvent("g3mfiw"); + event.setOrderId("5e85484b-1ebc-4141-aab7-25b869e54c49") + Adjust.trackEvent(event); +} +``` + + + +```js +window.onload = function() { + var btnTrackUniqueEvent = document.getElementById('btnTrackUniqueEvent') + btnTrackUniqueEvent.onclick = function(e) { + e.preventDefault(); + var adjustEvent = new AdjustEvent('g3mfiw'); + adjustEvent.setOrderId('5e85484b-1ebc-4141-aab7-25b869e54c49'); + Adjust.trackEvent(adjustEvent); + } +} +``` + + + ```txt title="Event log" {7} Path: /event @@ -181,13 +414,47 @@ Parameters: ## Add callback parameters +```java title="Method signature" +public void addCallbackParameter(String key, String 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. - + + + +```kotlin {2-3} +val adjustEvent = AdjustEvent("abc123") +adjustEvent.addCallbackParameter("key", "value") +adjustEvent.addCallbackParameter("foo", "bar") +Adjust.trackEvent(adjustEvent) +``` + + + + +```java {2-3} +AdjustEvent adjustEvent = new AdjustEvent("abc123"); +adjustEvent.addCallbackParameter("key", "value"); +adjustEvent.addCallbackParameter("foo", "bar"); +Adjust.trackEvent(adjustEvent); +``` + + + +```js {2-3} +let adjustEvent = new AdjustEvent('abc123'); +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: @@ -224,7 +491,47 @@ The resulting callback URL looks like this: http://www.mydomain.com/callback?event_token=g3mfiw&revenue_amount=0.05 ``` - + + + +```kotlin +fun onTrackUniqueEventClick(v: View) { + val event = AdjustEvent("g3mfiw") + event.addCallbackParameter("event_token", "g3mfiw") + event.addCallbackParameter("revenue_amount", "0.05") + Adjust.trackEvent(event) +} +``` + + + + +```java +public void onTrackUniqueEventClick(View v) { + AdjustEvent event = new AdjustEvent("g3mfiw"); + event.addCallbackParameter("event_token", "g3mfiw"); + event.addCallbackParameter("revenue_amount", "0.05"); + Adjust.trackEvent(event); +} +``` + + + +```js +window.onload = function() { + var btnTrackUniqueEvent = document.getElementById('btnTrackUniqueEvent') + btnTrackUniqueEvent.onclick = function(e) { + e.preventDefault(); + var adjustEvent = new AdjustEvent('g3mfiw'); + adjustEvent.addCallbackParameter('event_token', 'g3mfiw'); + adjustEvent.addCallbackParameter('revenue_amount', '0.05'); + Adjust.trackEvent(adjustEvent); + } +} +``` + + + You can check the parameters were sent to Adjust by checking for `callback_params` in your logs. @@ -240,6 +547,10 @@ Parameters: ## Add partner parameters +```java title="Method signature" +public void addPartnerParameter(String key, String 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. @@ -252,7 +563,37 @@ 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. - + + + +```kotlin {2-3} +val adjustEvent = AdjustEvent("abc123") +adjustEvent.addPartnerParameter("key", "value") +adjustEvent.addPartnerParameter("foo", "bar") +Adjust.trackEvent(adjustEvent) +``` + + + + +```java {2-3} +AdjustEvent adjustEvent = new AdjustEvent("abc123"); +adjustEvent.addPartnerParameter("key", "value"); +adjustEvent.addPartnerParameter("foo", "bar"); +Adjust.trackEvent(adjustEvent); +``` + + + +```js {2-3} +let adjustEvent = new AdjustEvent('abc123'); +adjustEvent.addPartnerParameter('key', 'value'); +adjustEvent.addPartnerParameter('foo', 'bar'); +Adjust.trackEvent(adjustEvent); +``` + + + ### Example @@ -261,7 +602,47 @@ This example shows how to record an event with the token `g3mfiw` whenever a use - The `product_id` of the associated product - The `user_id` of the user who triggered the event - + + + +```kotlin +fun onTrackUniqueEventClick(v: View) { + val event = AdjustEvent("g3mfiw") + event.addPartnerParameter("product_id", "29") + event.addPartnerParameter("user_id", "835") + Adjust.trackEvent(event) +} +``` + + + + +```java +public void onTrackUniqueEventClick(View v) { + AdjustEvent event = new AdjustEvent("g3mfiw"); + event.addPartnerParameter("product_id", "29"); + event.addPartnerParameter("user_id", "835"); + Adjust.trackEvent(event); +} +``` + + + +```js +window.onload = function() { + var btnTrackUniqueEvent = document.getElementById('btnTrackUniqueEvent') + btnTrackUniqueEvent.onclick = function(e) { + e.preventDefault(); + var adjustEvent = new AdjustEvent('g3mfiw'); + adjustEvent.addPartnerParameter('product_id', '29'); + adjustEvent.addPartnerParameter('user_id', '835'); + Adjust.trackEvent(adjustEvent); + } +} +``` + + + You can check the parameters were sent to Adjust by checking for `partner_params` in your logs. @@ -277,17 +658,85 @@ Parameters: ## Add a callback identifier +```java title="Method signature" +public void setCallbackId(String 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. - + + + +```kotlin {2} +val adjustEvent = AdjustEvent("abc123") +adjustEvent.setCallbackId("{Your-Custom-Id}") +Adjust.trackEvent(adjustEvent) +``` + + + + +```java {2} +AdjustEvent adjustEvent = new AdjustEvent("abc123"); +adjustEvent.setCallbackId("{Your-Custom-Id}"); +Adjust.trackEvent(adjustEvent); +``` + + + +```js {2} +let 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`. - + + + +```kotlin +fun onTrackUniqueEventClick(v: View) { + val event = AdjustEvent("g3mfiw") + event.setCallbackId("f2e728d8-271b-49ab-80ea-27830a215147") + Adjust.trackEvent(event) +} +``` + + + + +```java +public void onTrackUniqueEventClick(View v) { + AdjustEvent event = new AdjustEvent("g3mfiw"); + event.setCallbackId("f2e728d8-271b-49ab-80ea-27830a215147") + Adjust.trackEvent(event); +} +``` + + + +```js +window.onload = function() { + var btnTrackUniqueEvent = document.getElementById('btnTrackUniqueEvent') + btnTrackUniqueEvent.onclick = function(e) { + e.preventDefault(); + var adjustEvent = new AdjustEvent('g3mfiw'); + adjustEvent.setCallbackId('f2e728d8-271b-49ab-80ea-27830a215147') + Adjust.trackEvent(adjustEvent); + } +} +``` + + + ```txt title="Event log" {7} Path: /event diff --git a/src/content/docs/sdk/android/features/index.mdx b/src/content/docs/sdk/android/features/index.mdx index efaa2747d..3101ead63 100644 --- a/src/content/docs/sdk/android/features/index.mdx +++ b/src/content/docs/sdk/android/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/android/features type: category +sidebar-position: 3 --- Use the Adjust SDK to send in-app information to Adjust's servers. diff --git a/src/content/docs/sdk/android/features/privacy.mdx b/src/content/docs/sdk/android/features/privacy.mdx new file mode 100644 index 000000000..f7ba4e5ea --- /dev/null +++ b/src/content/docs/sdk/android/features/privacy.mdx @@ -0,0 +1,591 @@ +--- +title: Privacy features +description: Configure features that you can use to handle user privacy in your app. +slug: en/sdk/android/features/privacy +--- + +The Adjust SDK contains features that you can use to handle user privacy in your app. + +## Send right to be forgotten request + +```java title="Method signature" +public static void gdprForgetMe(final Context context) +``` + +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. + + + + +```kotlin +Adjust.gdprForgetMe() +``` + + + + + +```java +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 + +```java title="Method signature" +public AdjustThirdPartySharing(final Boolean isEnabled) +``` + +To enable or disable third party sharing with the Adjust SDK, you need to instantiate an `AdjustEvent` object. This object contains variables that control how third party sharing is handled by Adjust. + +To instantiate a third party sharing object, create a new `AdjustThirdPartySharing` instance and pass the following parameters: + +- `isEnabled` (**Boolean**): Whether third party sharing is enabled. Pass `true` to enable third party sharing or `false` to disable third party sharing + + + +If you set the `isEnabled` property to `false`, 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. + + + + +```kotlin +val adjustThirdPartySharing = AdjustThirdPartySharing(true) +Adjust.trackThirdPartySharing(adjustThirdPartySharing) +``` + + + + + +```java +AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true); +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + + + + + +```js +let adjustThirdPartySharing = new AdjustThirdPartySharing(true); +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + + + + +### Send granular information + +```java title="Method signature" +public void addGranularOption(final String partnerName, + final String key, + final String value) +``` + +You can attach granular information when a user updates their third-party sharing preferences. Use this information to communicate more detail about a user's decision. To do this, call the `addGranularOption` method with the following parameters: + +- `partnerName` (**String**): The name of the partner for whom the granular option applies. +- `key` (**String**): The option key. +- `value` (**String**): The option value. + +The following partners are available: + + + +| Partner name | String value | +| ----------------------- | --------------------------- | +| AppleAds | `apple_ads` | +| Facebook | `facebook` | +| GoogleAds | `adwords` | +| GoogleMarketingPlatform | `google_marketing_platform` | +| Snapchat | `snapchat` | +| Tencent | `tencent` | +| TikTokSan | `tiktok_san` | +| Twitter | `twitter` | +| YahooGemini | `yahoo_gemini` | +| YahooJapanSearch | `yahoo_japan_search` | + +
+ + + + +```kotlin {2} +val adjustThirdPartySharing = AdjustThirdPartySharing(true) +adjustThirdPartySharing.addGranularOption("PartnerA", "foo", "bar") +Adjust.trackThirdPartySharing(adjustThirdPartySharing) +``` + + + + + +```java {2} +AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true); +adjustThirdPartySharing.addGranularOption("PartnerA", "foo", "bar"); +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + + + + + +```js {2} +let adjustThirdPartySharing = new AdjustThirdPartySharing(true); +adjustThirdPartySharing.addGranularOption("PartnerA", "foo", "bar"); +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 + + + +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`. + + + + + + +```kotlin {2-3} +val adjustThirdPartySharing = AdjustThirdPartySharing(true) +adjustThirdPartySharing.addGranularOption("facebook", "data_processing_options_country", "1") +adjustThirdPartySharing.addGranularOption("facebook", "data_processing_options_state", "1000") +Adjust.trackThirdPartySharing(adjustThirdPartySharing) +``` + + + + + +```java {2-3} +AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true); +adjustThirdPartySharing.addGranularOption("facebook", "data_processing_options_country", "1"); +adjustThirdPartySharing.addGranularOption("facebook", "data_processing_options_state", "1000"); +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + + + + + +```js {2-3} +let adjustThirdPartySharing = new AdjustThirdPartySharing(true); +adjustThirdPartySharing.addGranularOption( + "facebook", + "data_processing_options_country", + "1" +); +adjustThirdPartySharing.addGranularOption( + "facebook", + "data_processing_options_state", + "1000" +); +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + + + + +#### 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. | + +
+ + + + +```kotlin +val adjustThirdPartySharing = AdjustThirdPartySharing(true) +adjustThirdPartySharing.addGranularOption("google_dma", "eea", "1"); +adjustThirdPartySharing.addGranularOption("google_dma", "ad_personalization", "1"); +adjustThirdPartySharing.addGranularOption("google_dma", "ad_user_data", "1"); +Adjust.trackThirdPartySharing(adjustThirdPartySharing) +``` + + + + +```java +AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(null); +adjustThirdPartySharing.addGranularOption("google_dma", "eea", "1"); +adjustThirdPartySharing.addGranularOption("google_dma", "ad_personalization", "1"); +adjustThirdPartySharing.addGranularOption("google_dma", "ad_user_data", "1"); +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + + + + +```js +let adjustThirdPartySharing = new AdjustThirdPartySharing(true); +adjustThirdPartySharing.addGranularOption("google_dma", "eea", "1"); +adjustThirdPartySharing.addGranularOption( + "google_dma", + "ad_personalization", + "1" +); +adjustThirdPartySharing.addGranularOption("google_dma", "ad_user_data", "1"); +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + + + + +## Disable third-party sharing + +```java title="Method signature" +public static void disableThirdPartySharing(final Context context) +``` + +To disable third-party sharing for all users, call the `disableThirdPartySharing` method. When Adjust's servers receive this information, Adjust stops sharing the user's data with third parties. The Adjust SDK continues to work as expected. + + + + +```kotlin +Adjust.disableThirdPartySharing() +``` + + + + + +```java +Adjust.disableThirdPartySharing(); +``` + + + + + +```js +Adjust.disableThirdPartySharing(); +``` + + + + +## Set URL strategy + +```java title="Method signature" +public void setUrlStrategy(String urlStrategy) +``` + +The URL strategy feature allows you to set either: + +- The country in which Adjust stores your data (data residency). +- The endpoint to which the Adjust SDK sends traffic (URL strategy). + +This is useful if you're operating in a country with strict privacy requirements. When you set your URL strategy, Adjust stores data in the selected data residency region or sends traffic to the chosen domain. + +To set your country of data residency, call the `setUrlStrategy` method on your `AdjustConfig` instance with the following parameter: + +- `urlStrategy` (**String**): The country of data residence or endpoint to which you want to send SDK traffic. + + + +| Value | Description | +| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| `AdjustConfig.DATA_RESIDENCY_EU` | Sets the area of data residency to the EU | +| `AdjustConfig.DATA_RESIDENCY_TR` | Sets the area of data residency to Turkey | +| `AdjustConfig.DATA_RESIDENCY_US` | Sets the area of data residency to the USA | +| `URL_STRATEGY_CHINA` | Points the URL strategy to the `app.adjust.world` domain | +| `URL_STRATEGY_CN` | Points the URL strategy to the `app.adjust.cn` domain | +| `URL_STRATEGY_CN_ONLY` | Points the URL strategy to the `app.adjust.cn` domain but **doesn't** fall back to another domain if the request fails. | +| `URL_STRATEGY_INDIA` | Points the URL strategy to the `app.adjust.net.in` domain | + +
+ + + + +```kotlin {4} +val appToken = "{YourAppToken}" +val environment = AdjustConfig.ENVIRONMENT_SANDBOX +val config = AdjustConfig(this, appToken, environment) +config.setUrlStrategy(AdjustConfig.DATA_RESIDENCY_EU) +//... +Adjust.onCreate(config) +``` + + + + +```java {4} +String appToken = "{YourAppToken}"; +String environment = AdjustConfig.ENVIRONMENT_SANDBOX; +AdjustConfig config = new AdjustConfig(this, appToken, environment); +config.setUrlStrategy(AdjustConfig.DATA_RESIDENCY_EU); +//... +Adjust.onCreate(config); +``` + + + + +```js {4} +var yourAppToken = yourAppToken; +var environment = AdjustConfig.EnvironmentSandbox; +var adjustConfig = new AdjustConfig(yourAppToken, environment); +adjustConfig.setUrlStrategy(AdjustConfig.DATA_RESIDENCY_EU); +``` + + + + +## Consent measurement for specific users + +```java title="Method signature" +public static void trackMeasurementConsent(final boolean consentMeasurement) +``` + +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: + +- `consentMeasurement` (**Boolean**): Whether consent measurement is enabled (`true`) or not (`false`). + +When enabled, the SDK communicates the data privacy settings to Adjust's servers. Adjust's servers then applies your data privacy rules to the user. The Adjust SDK continues to work as expected. + + + + +```kotlin +Adjust.trackMeasurementConsent(true) +``` + + + + + +```java +Adjust.trackMeasurementConsent(true); +``` + + + + + +```js +Adjust.trackMeasurementConsent(true); +``` + + + + +## COPPA compliance + +```java title="Method signature" +public void setCoppaCompliantEnabled(boolean coppaCompliantEnabled) +``` + +If you need your app to be compliant with the Children's Online Privacy Protection Act (COPPA), call the `setCoppaCompliantEnabled` method. This method performs the following actions: + +1. Disables third-party sharing **before** the user launches their first `session`. +2. Prevents the SDK from reading device and advertising IDs (for example: `gps_adid` and `android_id`). + + + + +```kotlin {4} +val appToken = "{YourAppToken}" +val environment = AdjustConfig.ENVIRONMENT_SANDBOX +val config = AdjustConfig(this, appToken, environment) +config.setCoppaCompliantEnabled(true) +//... +Adjust.onCreate(config) +``` + + + + +```java {4} +String appToken = "{YourAppToken}"; +String environment = AdjustConfig.ENVIRONMENT_SANDBOX; +AdjustConfig config = new AdjustConfig(this, appToken, environment); +config.setCoppaCompliantEnabled(true); +//... +Adjust.onCreate(config); +``` + + + + +```js {4} +var yourAppToken = yourAppToken; +var environment = AdjustConfig.EnvironmentSandbox; +var adjustConfig = new AdjustConfig(yourAppToken, environment); +adjustConfig.setCoppaCompliantEnabled(true); +``` + + + + +You can disable COPPA compliance by calling this method with a `false` argument. + + + +Disabling the `setCoppaCompliantEnabled` method **doesn't** re-enable third-party sharing. You need to [re-enable third-party sharing](#enable-third-party-sharing) for the user. + + + +## Play Store Kids Apps + +```java title="Method signature" +public void setPlayStoreKidsAppEnabled(boolean playStoreKidsAppEnabled) +``` + +If your app targets users under the age of 13, and the install region **isn't** the USA, you need to mark it as a Kids App. This prevents the SDK from reading device and advertising IDs (for example: `gps_adid` and `android_id`). + +To mark your app as a Kids App, call the `setPlayStoreKidsAppEnabled` method with the following argument: + +- `playStoreKidsAppEnabled` (**Boolean**): set to `true` to mark the app as a Kids App, or `false` to mark the app as a non-Kids App. + + + + +```kotlin {4} +val appToken = "{YourAppToken}" +val environment = AdjustConfig.ENVIRONMENT_SANDBOX +val config = AdjustConfig(this, appToken, environment) +config.setPlayStoreKidsAppEnabled(true) +//... +Adjust.onCreate(config) +``` + + + + +```java {4} +String appToken = "{YourAppToken}"; +String environment = AdjustConfig.ENVIRONMENT_SANDBOX; +AdjustConfig config = new AdjustConfig(this, appToken, environment); +config.setPlayStoreKidsAppEnabled(true); +//... +Adjust.onCreate(config); +``` + + + + +```js {4} +var yourAppToken = yourAppToken; +var environment = AdjustConfig.EnvironmentSandbox; +var adjustConfig = new AdjustConfig(yourAppToken, environment); +adjustConfig.setPlayStoreKidsAppEnabled(true); +``` + + + diff --git a/src/content/docs/sdk/android/features/session-parameters.mdx b/src/content/docs/sdk/android/features/session-parameters.mdx index 45c8f528b..ebc4859b5 100644 --- a/src/content/docs/sdk/android/features/session-parameters.mdx +++ b/src/content/docs/sdk/android/features/session-parameters.mdx @@ -4,26 +4,9 @@ description: Send information to your callback URL with each session. slug: en/sdk/android/features/session-parameters --- -import AddSessionCallbackParameter from "@android-examples/Adjust/addSessionCallbackParameter.mdx" -import AddSessionCallbackParameterSig from "@android-signatures/Adjust/addSessionCallbackParameter.mdx" -import RemoveSessionCallbackParameter from "@android-examples/Adjust/removeSessionCallbackParameter.mdx" -import RemoveSessionCallbackParameterSig from "@android-signatures/Adjust/removeSessionCallbackParameter.mdx" -import ResetSessionCallbackParameters from "@android-examples/Adjust/resetSessionCallbackParameters.mdx" -import ResetSessionCallbackParametersSig from "@android-signatures/Adjust/resetSessionCallbackParameters.mdx" -import AddSessionPartnerParameter from "@android-examples/Adjust/addSessionPartnerParameter.mdx" -import AddSessionPartnerParameterSig from "@android-signatures/Adjust/addSessionPartnerParameter.mdx" -import RemoveSessionPartnerParameter from "@android-examples/Adjust/removeSessionPartnerParameter.mdx" -import RemoveSessionPartnerParameterSig from "@android-signatures/Adjust/removeSessionPartnerParameter.mdx" -import ResetSessionPartnerParameters from "@android-examples/Adjust/resetSessionPartnerParameters.mdx" -import ResetSessionPartnerParametersSig from "@android-signatures/Adjust/resetSessionPartnerParameters.mdx" -import SetDelayStart from "@android-examples/ADJConfig/setDelayStart.mdx" -import SetDelayStartSig from "@android-signatures/ADJConfig/setDelayStart.mdx" -import SendFirstPackages from "@android-examples/Adjust/sendFirstPackages.mdx" -import SendFirstPackagesSig from "@android-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,109 @@ 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 + +```java title="Method signature" +public static void addSessionCallbackParameter(String key, String 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. - + + + +```kotlin +Adjust.addSessionCallbackParameter("foo", "bar") +``` + + + + + +```java +Adjust.addSessionCallbackParameter("foo", "bar"); +``` + + + + + +```js +Adjust.addSessionCallbackParameter("foo", "bar"); +``` + + + + +### Remove session callback parameters + +```java title="Method signature" +public static void removeSessionCallbackParameter(String 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. + + + + +```kotlin '"foo"' +Adjust.removeSessionCallbackParameter("foo") +``` + + -You can remove specific session callback parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionCallbackParameter` method. + - +```java '"foo"' +Adjust.removeSessionCallbackParameter("foo"); +``` + + + + + +```js '"foo"' +Adjust.removeSessionCallbackParameter("foo"); +``` + + + + +### Reset session callback parameters + +```java title="Method signature" +public static void resetSessionCallbackParameters() +``` You can remove all session parameters if they're no longer required. To do this, call the `resetSessionCallbackParameters` method. - + + + +```kotlin +Adjust.resetSessionCallbackParameters() +``` + + + + + +```java +Adjust.resetSessionCallbackParameters(); +``` + + + + + +```js +Adjust.resetSessionCallbackParameters(); +``` + + + ## Session partner parameters @@ -55,17 +130,103 @@ 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 + +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. + + + + +```kotlin +Adjust.addSessionPartnerParameter("foo", "bar") +``` + + + + - +```java +Adjust.addSessionPartnerParameter("foo", "bar"); +``` + + + + + +```js +Adjust.addSessionPartnerParameter("foo", "bar"); +``` + + + + +### Remove session partner parameters + +```java title="Method signature" +public static void removeSessionPartnerParameter(String 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. - + + + +```kotlin +Adjust.removeSessionPartnerParameter("foo"); +``` + + + + + +```java +Adjust.removeSessionPartnerParameter("foo"); +``` + + + + + +```js +Adjust.removeSessionPartnerParameter("foo"); +``` + + + + +### Reset session partner parameters + +```java title="Method signature" +public static void resetSessionPartnerParameters() +``` You can remove all session partner parameters if they're no longer required. To do this, call the `resetSessionPartnerParameters` method. - + + + +```kotlin +Adjust.resetSessionPartnerParameters() +``` + + + + + +```java +Adjust.resetSessionPartnerParameters(); +``` + + + + + +```js +Adjust.resetSessionPartnerParameters(); +``` + + + ## Delay start @@ -75,10 +236,63 @@ 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, pass the delay time in seconds to the [`setDelayStart` method](/en/sdk/android/configuration#delay-the-start-of-the-sdk) on your config object. + + + + +```kotlin {2} +val config = AdjustConfig(this, appToken, environment) +config.setDelayStart(5.5) +Adjust.onCreate(config) +``` + + + + +```java {2} +AdjustConfig config = new AdjustConfig(this, appToken, environment); +config.setDelayStart(5.5); +Adjust.onCreate(config); +``` + + + + +```js {2} +var adjustConfig = new AdjustConfig(yourAppToken, environment); +adjustConfig.setDelayStart(5.5); +Adjust.onCreate(adjustConfig); +``` - + + 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. - + + + +```kotlin +Adjust.sendFirstPackages() +``` + + + + + +```java +Adjust.sendFirstPackages(); +``` + + + + + +```js +Adjust.sendFirstPackages(); +``` + + + + diff --git a/src/content/docs/sdk/android/features/subscriptions.mdx b/src/content/docs/sdk/android/features/subscriptions.mdx index 820cfc153..06fce477c 100644 --- a/src/content/docs/sdk/android/features/subscriptions.mdx +++ b/src/content/docs/sdk/android/features/subscriptions.mdx @@ -4,66 +4,214 @@ description: Use these methods send subscription information to Adjust. slug: en/sdk/android/features/subscriptions --- -import AdjustPlayStoreSubscription from "@android-examples/ADJPlayStoreSubscription/constructor.mdx" -import AdjustPlayStoreSubscriptionSig from "@android-signatures/ADJPlayStoreSubscription/constructor.mdx" -import SetPurchaseTime from "@android-examples/ADJPlayStoreSubscription/setPurchaseTime.mdx" -import SetPurchaseTimeSig from "@android-signatures/ADJPlayStoreSubscription/setPurchaseTime.mdx" -import AddCallbackParameter from "@android-examples/ADJPlayStoreSubscription/addCallbackParameter.mdx" -import AddCallbackParameterSig from "@android-signatures/ADJPlayStoreSubscription/addCallbackParameter.mdx" -import AddPartnerParameter from "@android-examples/ADJPlayStoreSubscription/addPartnerParameter.mdx" -import AddPartnerParameterSig from "@android-signatures/ADJPlayStoreSubscription/addPartnerParameter.mdx" -import TrackPlayStoreSubscription from "@android-examples/Adjust/trackPlayStoreSubscription.mdx" -import TrackPlayStoreSubscriptionSig from "@android-signatures/Adjust/trackPlayStoreSubscription.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. -You can record Play Store subscriptions and verify their validity with the Adjust SDK. After the user purchases a subscription, create an [`AdjustPlayStoreSubscription` instance](/en/sdk/android/reference/adjplaystoresubscription) containing the details. +You can record Play Store subscriptions and verify their validity with the Adjust SDK. After the user purchases a subscription, instantiate an `AdjustPlayStoreSubscription` object containing the details. -## 1. Set up your subscription object +## 1. Instantiate a subscription object -To get started, you need to create a subscription object containing details of the subscription purchase. +```java title="Method signature" +public AdjustPlayStoreSubscription(final long price, + final String currency, + final String sku, + final String orderId, + final String signature, + final String purchaseToken) +``` -Create an `AdjustPlayStoreSubscription` object with the following properties: +To get started, you need to instantiate a subscription object containing details of the subscription purchase. To do this, create a new `AdjustPlayStoreSubscription` object and pass the following arguments: -| Parameter | Data type | Description | -| --------------- | ------------ | --------------------------------------- | -| `price` | Number | The price of the subscription | -| `currency` | String | The currency of the subscription | -| `sku` | String | The ID of the product | -| `orderId` | String | Your ID for the transaction | -| `signature` | String | The signature of the purchase data | -| `purchaseToken` | String | The unique token of the transaction. See [Google's documentation](https://developer.android.com/reference/com/android/billingclient/api/Purchase#getPurchaseToken()) for more information | +| Parameter | Data type | Description | +| --------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `price` | Number | The price of the subscription | +| `currency` | String | The currency of the subscription | +| `sku` | String | The ID of the product | +| `orderId` | String | Your ID for the transaction | +| `signature` | String | The signature of the purchase data | +| `purchaseToken` | String | The unique token of the transaction. See [Google's documentation]() for more information |
- + + + +```kotlin +val subscription = AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken); + +Adjust.trackPlayStoreSubscription(subscription) +``` + + + + + +```java +AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken); + +Adjust.trackPlayStoreSubscription(subscription); +``` + + + ### Record the purchase date +```java title="Method signature" +public void setPurchaseTime(final long purchaseTime) +``` + You can record the date on which the user purchased a subscription. The SDK returns this data for you to report on. Call the `setPurchaseTime` method with a timestamp to record this information. - + + + +```kotlin {8} +val subscription = AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken); +subscription.setPurchaseTime(purchaseTime) + +Adjust.trackPlayStoreSubscription(subscription) +``` + + + + + +```java {8} +AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken); +subscription.setPurchaseTime(purchaseTime); + +Adjust.trackPlayStoreSubscription(subscription); +``` + + + ### Add callback parameters +```java title="Method signature" +public void addCallbackParameter(String key, String 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. - + + + +```kotlin +subscription.addCallbackParameter("key", "value") +subscription.addCallbackParameter("foo", "bar") +``` + + + + + +```java +subscription.addCallbackParameter("key", "value"); +subscription.addCallbackParameter("foo", "bar"); +``` + + + ### Add partner parameters +```java title="Method signature" +public void addPartnerParameter(String key, String 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. - + + + +```kotlin +subscription.addPartnerParameter("key", "value") +subscription.addPartnerParameter("foo", "bar") +``` + + + + + +```java +subscription.addPartnerParameter("key", "value"); +subscription.addPartnerParameter("foo", "bar"); +``` + + + ## 2. Send subscription information +```java title="Method signature" +public static void trackPlayStoreSubscription(final AdjustPlayStoreSubscription 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 `trackPlayStoreSubscription` method to record the user's subscription purchase. - + + + +```kotlin {10} +val subscription = AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken) +subscription.setPurchaseTime(purchaseTime) + +Adjust.trackPlayStoreSubscription(subscription) +``` + + + + + +```java {10} +AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken); +subscription.setPurchaseTime(purchaseTime); + +Adjust.trackPlayStoreSubscription(subscription); +``` + + + diff --git a/src/content/docs/sdk/android/index.mdx b/src/content/docs/sdk/android/index.mdx index 561b1616d..6ee1cd351 100644 --- a/src/content/docs/sdk/android/index.mdx +++ b/src/content/docs/sdk/android/index.mdx @@ -28,7 +28,7 @@ The minimum supported Android API level for the web view extension is 17 (Jelly If you're using [Maven](https://maven.apache.org/), add the following to your `build.gradle` file: -```groovy +```groovy title="build.gradle" dependencies { implementation 'com.adjust.sdk:adjust-android:4.33.3' implementation 'com.android.installreferrer:installreferrer:2.2' @@ -43,7 +43,7 @@ Apps that target the Google Play Store must use the gps_adid (Google Advertising If you're using Maven, add the following to your `build.gradle` file: -```groovy +```groovy title="build.gradle" dependencies { implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1' } @@ -53,7 +53,7 @@ dependencies { The [App Set Identifier](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetId) is a unique identifier that enables you to measure information from any of your apps that a user has installed on their device. All apps by the same developer share the same App Set ID, meaning you can gather meaningful insights from users across all your apps. To record a device's App Set ID, you need to add the following permission to your `build.gradle` file: -```groovy +```groovy title="build.gradle" dependencies { implementation 'com.google.android.gms:play-services-appset:16.0.2' } @@ -67,20 +67,20 @@ To give the Adjust SDK access to device information, you need to declare which p Add the following permissions to get access to online features: -```xml +```xml title="AndroidManifest.xml" ``` If your app doesn't target the Google Play Store, add the following permission to access the device's network state: -```xml +```xml title="AndroidManifest.xml" ``` The Adjust SDK includes the `com.google.android.gms.AD_ID` permission by default. If you need to make your app COPPA (Children's Online Privacy Protection Act) compliant or if your app doesn't target the Google Play Store, you must remove this permission using a `remove` directive. -```xml "tools:node="remove"" +```xml title="AndroidManifest.xml" "tools:node="remove"" ``` @@ -88,7 +88,7 @@ The Adjust SDK includes the `com.google.android.gms.AD_ID` permission by default If you're using Proguard to optimize your app, you must add rules to prevent Proguard from removing classes. -```java +```java title="Proguard.pro" -keep class com.adjust.sdk.** { *; } -keep class com.google.android.gms.common.ConnectionResult { int SUCCESS; @@ -105,7 +105,7 @@ If you're using Proguard to optimize your app, you must add rules to prevent Pro If you're not publishing your app in the Google Play Store, add the following rule: -```java +```java title="Proguard.pro" -keep public class com.adjust.sdk.** { *; } ``` @@ -119,7 +119,7 @@ The Google Play Referrer API is available to apps that target the Google Play St To support the Google Play Referrer API, add the following to your `build.gradle` file: -```groovy +```groovy title="build.gradle" dependencies { implementation 'com.android.installreferrer:installreferrer:2.2' } @@ -127,7 +127,7 @@ dependencies { If you're using Proguard, remember to add a rule to prevent the dependency from being removed. -```java +```java title="Proguard.pro" -keep public class com.android.installreferrer.** { *; } ``` @@ -157,7 +157,7 @@ The recommended way to initialize the Adjust SDK is inside a global Android [App 2. Open the `AndroidManifest.xml` file and locate the `` element. 3. Add the `android:name` attribute to the `` element and set it to the name of your application class. For example, if your `Application` class is named `GlobalApplication`, you would set the following: -```xml +```xml title="AndroidManifest.xml" diff --git a/src/content/docs/sdk/android/integrations/admob.mdx b/src/content/docs/sdk/android/integrations/admob.mdx index 6569dd85e..16429e4e9 100644 --- a/src/content/docs/sdk/android/integrations/admob.mdx +++ b/src/content/docs/sdk/android/integrations/admob.mdx @@ -23,9 +23,7 @@ To use this feature, you need to first reach out to your Google representative a ## Examples - - -### Java + ```java AdRequest adRequest = new AdRequest.Builder().build(); diff --git a/src/content/docs/sdk/android/integrations/applovin.mdx b/src/content/docs/sdk/android/integrations/applovin.mdx index d49ac91a4..2683f76ae 100644 --- a/src/content/docs/sdk/android/integrations/applovin.mdx +++ b/src/content/docs/sdk/android/integrations/applovin.mdx @@ -19,9 +19,7 @@ If you have any questions about ad revenue tracking with AppLovin MAX, please co ## Examples - - -### Java + ```java @Override diff --git a/src/content/docs/sdk/android/integrations/batch.mdx b/src/content/docs/sdk/android/integrations/batch.mdx index c3c605406..414b0c2e8 100644 --- a/src/content/docs/sdk/android/integrations/batch.mdx +++ b/src/content/docs/sdk/android/integrations/batch.mdx @@ -17,9 +17,7 @@ To integrate Adjust with the Batch.com SDK, you need to send attribution to the You can set the callback method like this: - - -### Java + ```java AdjustConfig config = new AdjustConfig(this, appToken, environment); diff --git a/src/content/docs/sdk/android/integrations/helium.mdx b/src/content/docs/sdk/android/integrations/helium.mdx index 1faa8c7a3..fdb7ead89 100644 --- a/src/content/docs/sdk/android/integrations/helium.mdx +++ b/src/content/docs/sdk/android/integrations/helium.mdx @@ -19,9 +19,7 @@ If you want to measure ad revenue with the Helium by Chartboost SDK, you can use ## Example - - -### Java + ```java public void ilrdObserver (final HeliumImpressionData impData) { diff --git a/src/content/docs/sdk/android/integrations/index.mdx b/src/content/docs/sdk/android/integrations/index.mdx index ba385d277..e782349cd 100644 --- a/src/content/docs/sdk/android/integrations/index.mdx +++ b/src/content/docs/sdk/android/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/android/integrations type: category +sidebar-position: 4 --- Use SDK to SDK integrations to pass information from third-party SDKs to Adjust. diff --git a/src/content/docs/sdk/android/integrations/ironsource.mdx b/src/content/docs/sdk/android/integrations/ironsource.mdx index be3be75e1..da9f9f22b 100644 --- a/src/content/docs/sdk/android/integrations/ironsource.mdx +++ b/src/content/docs/sdk/android/integrations/ironsource.mdx @@ -19,9 +19,7 @@ If you have any questions about ad revenue measurement with ironSource, please c ## Example - - -### Java + ```java public void onImpressionSuccess (ImpressionData impressionData) { diff --git a/src/content/docs/sdk/android/integrations/mixpanel.mdx b/src/content/docs/sdk/android/integrations/mixpanel.mdx index ca3326004..4d50d5e18 100644 --- a/src/content/docs/sdk/android/integrations/mixpanel.mdx +++ b/src/content/docs/sdk/android/integrations/mixpanel.mdx @@ -27,9 +27,7 @@ You should send this information after receiving a response from Adjust's server Modify your callback method to use the Mixpanel API like this: - - -### Java + ```java public class YourApplicationClass extends Application { diff --git a/src/content/docs/sdk/android/integrations/unity.mdx b/src/content/docs/sdk/android/integrations/unity.mdx index a0fb55988..dfa5fbb78 100644 --- a/src/content/docs/sdk/android/integrations/unity.mdx +++ b/src/content/docs/sdk/android/integrations/unity.mdx @@ -25,9 +25,7 @@ For more information, see the Unity [Mediation API](https://docs.unity.com/media ## Examples - - -### Java + ```java // implement an impression listener diff --git a/src/content/docs/sdk/android/plugins/criteo.mdx b/src/content/docs/sdk/android/plugins/criteo.mdx index a467aa55d..747339997 100644 --- a/src/content/docs/sdk/android/plugins/criteo.mdx +++ b/src/content/docs/sdk/android/plugins/criteo.mdx @@ -12,7 +12,7 @@ You can integrate the Adjust Android SDK with Criteo events by using the Adjust If you are using Maven, add the following dependency to your `build.gradle` file: -``` +```groovy title="build.gradle" dependencies { implementation 'com.adjust.sdk:adjust-android:4.28.2' implementation 'com.adjust.sdk:adjust-android-criteo:4.28.2' @@ -29,11 +29,6 @@ Once you have set up your environment, you can start recording Criteo events wit ### View listing - - - -### Java - ```java import com.adjust.sdk.plugin.AdjustCriteo; @@ -43,16 +38,8 @@ AdjustCriteo.injectViewListingIntoEvent(event, productIds); Adjust.trackEvent(event); ``` - - - ### View product - - - -### Java - ```java import com.adjust.sdk.plugin.AdjustCriteo; @@ -61,16 +48,8 @@ AdjustCriteo.injectViewProductIntoEvent(event, "productId1"); Adjust.trackEvent(event); ``` - - - ### Cart - - - -### Java - ```java import com.adjust.sdk.plugin.AdjustCriteo; @@ -84,16 +63,8 @@ AdjustCriteo.injectCartIntoEvent(event, products); Adjust.trackEvent(event); ``` - - - ### Transaction confirmed - - - -### Java - ```java import com.adjust.sdk.plugin.AdjustCriteo; @@ -107,16 +78,8 @@ AdjustCriteo.injectTransactionConfirmedIntoEvent(event, products, "transactionId Adjust.trackEvent(event); ``` - - - ### User level - - - -### Java - ```java import com.adjust.sdk.plugin.AdjustCriteo; @@ -125,16 +88,8 @@ AdjustCriteo.injectUserLevelIntoEvent(event, 1); Adjust.trackEvent(event); ``` - - - ### User status - - - -### Java - ```java import com.adjust.sdk.plugin.AdjustCriteo; @@ -143,35 +98,18 @@ AdjustCriteo.injectUserStatusIntoEvent(event, "uiStatusValue"); Adjust.trackEvent(event); ``` - - - ### Achievement unlocked - - - -### Java - ```java import com.adjust.sdk.plugin.AdjustCriteo; AdjustEvent event = new AdjustEvent("{achievementUnlockedEventToken}"); AdjustCriteo.injectAchievementUnlockedIntoEvent(event, "AchievementUnlocked"); Adjust.trackEvent(event); -```t.trackEvent(event); ``` - - - ### Custom event - - - -### Java - ```java import com.adjust.sdk.plugin.AdjustCriteo; @@ -180,16 +118,8 @@ AdjustCriteo.injectCustomEventIntoEvent(event, "uiDataValue"); Adjust.trackEvent(event); ``` - - - ### Custom event 2 - - - -### Java - ```java import com.adjust.sdk.plugin.AdjustCriteo; @@ -198,76 +128,44 @@ AdjustCriteo.injectCustomEvent2IntoEvent(event, "uiData2Value", 3); Adjust.trackEvent(event); ``` - - - ### Hashed email You can attach a hashed email to every Criteo event. To do this, call the `injectHashedEmailIntoCriteoEvents` method. The SDK will send a hashed email with every Criteo event throughout the app lifecycle. This means it will need to be set again when the app is re-launched. You can remove the hashed email by setting the `injectHashedEmailIntoCriteoEvents` value to `nil`. - - - -### Java - ```java import com.adjust.sdk.plugin.AdjustCriteo; AdjustCriteo.injectHashedEmailIntoCriteoEvents("8455938a1db5c475a87d76edacb6284e"); ``` - - - ### Search dates You can attach a check-in and check-out date to every Criteo event. To do this, call the `injectViewSearchDatesIntoCriteoEvent` method. The SDK will send the dates with every Criteo event throughout the app lifecycle. This means you will need to set them again when the app is re-launched. You can remove the search dates by setting the `injectViewSearchDatesIntoCriteoEvent` values to `nil`. - - - -### Java - ```java import com.adjust.sdk.plugin.AdjustCriteo; AdjustCriteo.injectViewSearchDatesIntoCriteoEvents("2015-01-01", "2015-01-07"); ``` - - - ### Partner ID You can attach a partner ID to every Criteo event. To do this, call the `injectPartnerIdIntoCriteoEvents` method. The SDK will send the partner ID with every Criteo throughout the app lifecycle. This means you will need to set it again when the app is re-launched. You can remove the partner ID by setting the `injectPartnerIdIntoCriteoEvents` value to null. - - - -### Java - ```java import com.adjust.sdk.plugin.AdjustCriteo; AdjustCriteo.injectPartnerIdIntoCriteoEvents("{CriteoPartnerId}"); ``` - - - ### Send deep link You can add deep link information to Criteo events. To do this, call the `injectDeeplinkIntoEvent` method with the event and URL. - - - -### Java - ```java import com.adjust.sdk.plugin.AdjustCriteo; @@ -283,46 +181,26 @@ protected void onCreate(Bundle savedInstanceState) { } ``` - - - ### Customer ID You can attach a customer ID to every Criteo event. To do this, call the `injectCustomerIdIntoCriteoEvents` method. The SDK will send the customer ID with every Criteo event throughout the app lifecycle. This means you will need to set them again when the app is re-launched. You can remove the customer ID by setting the `injectCustomerIdIntoCriteoEvents` value to nil. - - - -### Java - ```java import com.adjust.sdk.plugin.AdjustCriteo; AdjustCriteo.injectCustomerIdIntoCriteoEvents("{CriteoCustomerId}"); ``` - - - -### User segment +### User segment You can attach the user segment to every Criteo event. To do this, call the `injectUserSegmentIntoCriteoEvents` method. The SDK will send the user segment with every Criteo event throughout the app lifecycle. This means you will need to set it again when the app is re-launched. You can remove the user segment by setting the `injectUserSegmentIntoCriteoEvents` value to nil. - - - -### Java - ```java import com.adjust.sdk.plugin.AdjustCriteo; AdjustCriteo.injectUserSegmentIntoCriteoEvents("{CriteoUserSegment}"); ``` - - - - diff --git a/src/content/docs/sdk/android/plugins/facebook-pixel.mdx b/src/content/docs/sdk/android/plugins/facebook-pixel.mdx index 8da155067..49c606364 100644 --- a/src/content/docs/sdk/android/plugins/facebook-pixel.mdx +++ b/src/content/docs/sdk/android/plugins/facebook-pixel.mdx @@ -20,22 +20,24 @@ To start working with Facebook pixels, follow the steps below: As described in [Facebook's Android SDK guide](https://developers.facebook.com/docs/android/) you will need to add your Facebook App ID to the app by doing the following: -2. Add a new string with the name `facebook_app_id`. Add your Facebook App ID as the value. -1. Open your `strings.xml` file. Example path: `/app/src/main/res/values/strings.xml`. +1. Add a new string with the name `facebook_app_id`. Add your Facebook App ID as the value. +2. Open your `strings.xml` file. Example path: `/app/src/main/res/values/strings.xml`. 3. Open `AndroidManifest.xml`. 4. Add a uses-permission element to the manifest: -```xml - -``` + + ```xml title="AndroidManifest.xml" + + ``` + 5. Add a meta-data element to the application element: -```xml - - ... - - ... - -``` + ```xml title="AndroidManifest.xml" + + ... + + ... + + ``` ### Facebook pixel configuration @@ -44,10 +46,10 @@ Follow Facebook's guide on how to integrate the Facebook pixel. The Javascript c ```html ... @@ -55,14 +57,18 @@ Follow Facebook's guide on how to integrate the Facebook pixel. The Javascript c Next, update your Facebook pixel code. You can find the instructions in the [Hybrid Mobile App Events guide](https://developers.facebook.com/docs/app-events/hybrid-app-events) under **Update Your Pixel**. -```js -fbq('init', ); -fbq('set', 'mobileBridge', , ); +```html + ``` -You need to call `init` and then set immediately afterward. The snippet provided by Facebook contains a `track` method. You can use this method to track a page view event right after you call the `init` method. To track the view event, you need to call `set` between `init` and `track`. +You need to call `init` and then `set` immediately afterward. The snippet provided by Facebook contains a `track` method. You can use this method to track a page view event right after you call the `init` method. To track the view event, you need to call `set` between `init` and `track`. @@ -91,8 +97,11 @@ To use this feature, you need to map Facebook pixels to specific Adjust events. To map events, call the `addFbPixelMapping` method on your config instance. Use the Facebook event name and Adjust event token as parameters. You need to call this before you initialize the Adjust SDK. ```js -adjustConfig.addFbPixelMapping('fb_mobile_search', adjustEventTokenForSearch); -adjustConfig.addFbPixelMapping('fb_mobile_purchase', adjustEventTokenForPurchase); +adjustConfig.addFbPixelMapping("fb_mobile_search", adjustEventTokenForSearch); +adjustConfig.addFbPixelMapping( + "fb_mobile_purchase", + adjustEventTokenForPurchase +); ``` diff --git a/src/content/docs/sdk/android/plugins/imei-plugin.mdx b/src/content/docs/sdk/android/plugins/imei-plugin.mdx index 865f17314..969c7b143 100644 --- a/src/content/docs/sdk/android/plugins/imei-plugin.mdx +++ b/src/content/docs/sdk/android/plugins/imei-plugin.mdx @@ -8,10 +8,9 @@ slug: en/sdk/android/plugins/imei-plugin This plugin is only meant for apps that aren't targeting the Google Play Store. - -Mobile devices come with an IMEI (International Mobile Equipment Identity) and a MEID (Mobile Equipment Identifier). You can use an Android device's IMEI and MEID for attribution in certain markets. To use this feature, you first need to complete the required steps in your Adjust dashboard. Once you have completed the steps, you can use this plugin. +Mobile devices come with an International Mobile Equipment Identity (IMEI) and a Mobile Equipment Identifier (MEID). You can use an Android device's IMEI and MEID for attribution in certain markets. To use this feature, you first need to complete the required steps in your Adjust dashboard. Once you have completed the steps, you can use this plugin. The IMEI plugin provides the IMEI and MEID values of a device. The SDK will continue to use other identifiers as well as the IMEI and MEID. @@ -23,7 +22,7 @@ Before you use this plugin, make sure to follow the get started guide and integr If you are using Maven, add the following dependency to your `build.gradle` file: -```java +```groovy title="build.gradle" dependencies { implementation 'com.adjust.sdk:adjust-android:4.28.2' implementation 'com.adjust.sdk:adjust-android-imei:4.28.2' @@ -38,7 +37,7 @@ You can also add the plugin as a JAR file from the [releases page](https://githu Ensure the following permission is present in your `AndroidManifest.xml` file. If it isn't, add it. -```xml +```xml title="AndroidManifest.xml" ``` @@ -48,7 +47,7 @@ As of Android 6.0 you may need to [request app permission](https://developer.and If your app isn't targeting the Google Play Store, you don't need to add all the rules set out in the get started guide. You can remove rules related to Google Play Services and install referrer libraries. You only need to keep the rules that apply to the Adjust SDK. -``` +```java title="Proguard.pro" -keep public class com.adjust.sdk.** { *; } ``` @@ -63,9 +62,7 @@ The IMEI and MEID are persistent identifiers. You are responsible for ensuring t Once you have set up the plugin, you can gather the device's IMEI and MEID. To do this, call the `AdjustImei.readImeie` method before starting the Adjust SDK. - - -### Java + ```java AdjustImei.readImei(); @@ -79,9 +76,7 @@ Adjust.onCreate(config); If you want to prevent the SDK from reading the IMEI and MEID, call the `AdjustImei.doNotReadImei` method. - - -### Java + ```java AdjustImei.doNotReadImei(); diff --git a/src/content/docs/sdk/android/plugins/index.mdx b/src/content/docs/sdk/android/plugins/index.mdx index dcb835543..4526477ac 100644 --- a/src/content/docs/sdk/android/plugins/index.mdx +++ b/src/content/docs/sdk/android/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/android/plugins type: category +sidebar-position: 5 --- Use plugins to pass information to third-party plugins. diff --git a/src/content/docs/sdk/android/plugins/oaid-plugin.mdx b/src/content/docs/sdk/android/plugins/oaid-plugin.mdx index 2bf022657..46215efcf 100644 --- a/src/content/docs/sdk/android/plugins/oaid-plugin.mdx +++ b/src/content/docs/sdk/android/plugins/oaid-plugin.mdx @@ -4,17 +4,17 @@ description: Use the OAID plugin to pass OAID information to Adjust. slug: en/sdk/android/plugins/oaid-plugin --- -The OAID (Open Anonymous Device Identifier) is a unique identifier for Android devices. The MSA (Mobile Security Alliance) recommends all Chinese-manufactured devices provide an OAID. You can use the OAID to attribute and track devices where Google Play Services isn't available. +The Open Anonymous Device Identifier (OAID) is a unique identifier for Android devices. The Mobile Security Alliance (MSA) recommends all Chinese-manufactured devices provide an OAID. You can use the OAID to attribute and track devices where Google Play Services isn't available. -The OAID plugin provides the OAID of a device. The SDK will continue to use other identifiers as well as the OAID. The OAID is readable on all devices using the MSA SDK or HMS (Huawei Mobile Service) Core SDK on Huawei devices. +The OAID plugin provides the OAID of a device. The SDK will continue to use other identifiers as well as the OAID. The OAID is readable on all devices using the MSA SDK or Huawei Mobile Service (HMS) Core SDK on Huawei devices. -## Add the OAID plugin to your app +## Add the plugin to your app -### Maven +### Maven If you are using Maven, add the following dependency to your `build.gradle` file: -```java +```java title="build.gradle" dependencies { implementation 'com.adjust.sdk:adjust-android:4.33.4' implementation 'com.adjust.sdk:adjust-android-oaid:4.33.4' @@ -31,7 +31,7 @@ Minimum SDK Version 4.28.2 and OAID plugin 4.33.0 are required for Huawei device 1. Add the following to your project's `build.gradle` file: -```groovy +```groovy title="build.gradle" allprojects { repositories { maven { @@ -43,7 +43,7 @@ allprojects { 2. Add the following to your app-level `build.gradle` file: -```groovy +```groovy title="build.gradle" dependencies { implementation 'com.adjust.sdk:adjust-android:4.33.4' implementation 'com.adjust.sdk:adjust-android-oaid:4.33.4' @@ -65,16 +65,16 @@ You don't need to add the MSA SDK to read the OAID value on Huawei devices. The ### Requirements -| MSA SDK version | Adjust OAID plugin version | -|------------------|----------------------------| -| v1.0.10+ | v4.19.0+ | -| v1.0.12+ | v4.22.0+ | -| v1.0.13+ | v4.23.0+ | -| v1.0.23+ | v4.24.1+ | -| v1.0.25+ | v4.27.0+ | -| v1.0.26+ | v4.28.4+ | -| v1.1.0+ | v4.28.9+ | -| v2.0.0+ | v4.33.0+ | +| MSA SDK version | Adjust OAID plugin version | +| --------------- | -------------------------- | +| v1.0.10+ | v4.19.0+ | +| v1.0.12+ | v4.22.0+ | +| v1.0.13+ | v4.23.0+ | +| v1.0.23+ | v4.24.1+ | +| v1.0.25+ | v4.27.0+ | +| v1.0.26+ | v4.28.4+ | +| v1.1.0+ | v4.28.9+ | +| v2.0.0+ | v4.33.0+ | To enable the OAID plugin to read OAID values from the MSA SDK, you need to add it to your project. To do this: @@ -88,7 +88,7 @@ You can use the HMS Core SDK to access the OAID of Huawei devices. To enable the 1. Add the Huawei maven repository. -```groovy +```groovy title="build.gradle" repositories { maven { url "https://developer.huawei.com/repo/" @@ -98,7 +98,7 @@ repositories { 2. Add the HMS Core SDK. -```groovy +```groovy title="build.gradle" dependencies { implementation 'com.huawei.hms:ads-identifier:3.4.56.300' } @@ -108,13 +108,13 @@ dependencies { If your app isn't targeting the Google Play Store, you don't need to add all the rules set out in the Android get started guide. You can remove rules related to Google Play Services and install referrer libraries. You only need to keep the rules that apply to the Adjust SDK. -``` +```java title="Proguard.pro" -keep public class com.adjust.sdk.** { *; } ``` If you are adding the MSA SDK AAR as a dependency, add the following rules: -``` +```java title="Proguard.pro" -keep class com.bun.miitmdid.core.** { *; } ``` @@ -123,9 +123,7 @@ If you are adding the MSA SDK AAR as a dependency, add the following rules: Once you have set up the plugin, you can gather the device's OAID. To do this, call the `AdjustOaid.readOaid(applicationContext)` method before starting the Adjust SDK. - - -### Java + ```java AdjustOaid.readOaid(applicationContext); @@ -141,9 +139,7 @@ Adjust.onCreate(config); If you want to prevent the SDK from reading the OAID, call the `AdjustOaid.doNotReadOaid()` method. - - -### Java + ```java AdjustOaid.doNotReadOaid(); diff --git a/src/content/docs/sdk/android/plugins/samsung-referrer-plugin.mdx b/src/content/docs/sdk/android/plugins/samsung-referrer-plugin.mdx index 67b2876f6..b5157d427 100644 --- a/src/content/docs/sdk/android/plugins/samsung-referrer-plugin.mdx +++ b/src/content/docs/sdk/android/plugins/samsung-referrer-plugin.mdx @@ -10,7 +10,7 @@ The Samsung install referrer is available on all devices that support the Samsun ## Before you begin -Follow the get started guide to integrate the Adjust SDK in your app. +Follow the [get started guide](/en/sdk/android) to integrate the Adjust SDK in your app. ## Install the Samsung referrer plugin @@ -20,7 +20,7 @@ There are two ways to install the Samsung referrer plugin: Add the following dependency to your `build.gradle` file under your Adjust SDK declaration. -```groovy +```groovy title="build.gradle" implementation 'com.adjust.sdk:adjust-android:4.33.4' implementation 'com.adjust.sdk:adjust-android-samsung-referrer:4.33.4' @@ -44,13 +44,14 @@ Adding the Samsung install referrer library via Maven is available only in Adjus To install the Samsung install referrer library, you must add the following dependency to your `build.gradle` file under your Adjust SDK declaration: -```groovy -implem +```groovy title="build.gradle" +implementation 'store.galaxy.samsung.installreferrer:samsung_galaxystore_install_referrer:3.0.1' ``` + For instructions on how to install the Samsung referrer library with Adjust SDK v4.33.3 and below, reach out to your Samsung representative or contact support@samsungdevelopers.com. @@ -61,21 +62,21 @@ If you use Proguard, you must add rules to ensure that important classes aren't Add the following rule to keep all Adjust classes. -```java +```java title="Proguard.pro" -keep public class com.adjust.sdk.** { *; } ``` Add the following rule to keep the Samsung install referrer library. -```java +```java title="Proguard.pro" -keep class com.sec.android.app.samsungapps.installreferrer.** { *; } ``` ## Use the plugin -The Samsung referrer plugin is __enabled__ by default. You can toggle reading Samsung install referrer information on and off using the `AdjustSamsungReferrer` class methods. +The Samsung referrer plugin is **enabled** by default. You can toggle reading Samsung install referrer information on and off using the `AdjustSamsungReferrer` class methods. -To __disable__ reading the install referrer, call `AdjustSamsungReferrer.doNotReadSamsungReferrer()` __before__ you initialize the SDK. +To **disable** reading the install referrer, call `AdjustSamsungReferrer.doNotReadSamsungReferrer()` **before** you initialize the SDK. @@ -98,7 +99,7 @@ Adjust.onCreate(config) -To __reenable__ reading the install referrer, call `AdjustSamsungReferrer.readSamsungReferrer(applicationContext)` __before__ you initialize the SDK. +To **reenable** reading the install referrer, call `AdjustSamsungReferrer.readSamsungReferrer(applicationContext)` **before** you initialize the SDK. diff --git a/src/content/docs/sdk/android/plugins/sociomatic.mdx b/src/content/docs/sdk/android/plugins/sociomatic.mdx index 4728cce52..fe7197de9 100644 --- a/src/content/docs/sdk/android/plugins/sociomatic.mdx +++ b/src/content/docs/sdk/android/plugins/sociomatic.mdx @@ -12,7 +12,7 @@ You can integrate the Adjust SDK with Sociomantic events. If you are using Maven, add the following dependency to your `build.gradle` file: -```groovy +```groovy title="build.gradle" dependencies { implementation 'com.adjust.sdk:adjust-android:4.28.2' implementation 'com.adjust.sdk:adjust-android-criteo:4.28.2' @@ -27,36 +27,34 @@ You can also add the plugin as a JAR file from the [releases page](https://githu Once you have installed the Sociomantic plugin, you will have access to the Sociomantic events methods as well as the following constants. You should use these as the property names of your dictionaries. -* `final static String SCMCategory;` -* `final static String SCMProductName;` -* `final static String SCMSalePrice;` -* `final static String SCMAmount;` -* `final static String SCMCurrency;` -* `final static String SCMProductURL;` -* `final static String SCMProductImageURL;` -* `final static String SCMBrand;` -* `final static String SCMDescription;` -* `final static String SCMTimestamp;` -* `final static String SCMValidityTimestamp;` -* `final static String SCMQuantity;` -* `final static String SCMScore;` -* `final static String SCMProductID;` -* `final static String SCMActionConfirmed;` -* `final static String SCMCustomerAgeGroup;` -* `final static String SCMCustomerEducation;` -* `final static String SCMCustomerGender;` -* `final static String SCMCustomerID;` -* `final static String SCMCustomerMHash;` -* `final static String SCMCustomerSegment;` -* `final static String SCMCustomerTargeting;` -* `final static String SCMTransaction;` +- `final static String SCMCategory;` +- `final static String SCMProductName;` +- `final static String SCMSalePrice;` +- `final static String SCMAmount;` +- `final static String SCMCurrency;` +- `final static String SCMProductURL;` +- `final static String SCMProductImageURL;` +- `final static String SCMBrand;` +- `final static String SCMDescription;` +- `final static String SCMTimestamp;` +- `final static String SCMValidityTimestamp;` +- `final static String SCMQuantity;` +- `final static String SCMScore;` +- `final static String SCMProductID;` +- `final static String SCMActionConfirmed;` +- `final static String SCMCustomerAgeGroup;` +- `final static String SCMCustomerEducation;` +- `final static String SCMCustomerGender;` +- `final static String SCMCustomerID;` +- `final static String SCMCustomerMHash;` +- `final static String SCMCustomerSegment;` +- `final static String SCMCustomerTargeting;` +- `final static String SCMTransaction;` Before sending any Sociomantic events, you should set a partner ID as shown below: - - -### Java + ```java import com.adjust.sdk.plugin.AdjustSociomantic; @@ -74,9 +72,7 @@ Once you have set your partner ID, you can integrate the different Sociomantic e ### Customer event - - -### Java + ```java import com.adjust.sdk.plugin.AdjustSociomantic; @@ -95,9 +91,7 @@ Adjust.trackEvent(event); ### View home page - - -### Java + ```java import com.adjust.sdk.plugin.AdjustSociomantic; @@ -112,9 +106,7 @@ Adjust.trackEvent(event); ### View listing - - -### Java + ```java import com.adjust.sdk.plugin.AdjustSociomantic; @@ -143,9 +135,7 @@ If you're not sure what setup you should use, please contact your technical acco - - -### Java + ```java import com.adjust.sdk.plugin.AdjustSociomantic; @@ -191,9 +181,7 @@ Adjust.trackEvent(event); ### Cart - - -### Java + ```java import com.adjust.sdk.plugin.AdjustSociomantic; @@ -234,9 +222,7 @@ Adjust.trackEvent(event); ### Unconfirmed transaction - - -### Java + ```java import com.adjust.sdk.plugin.AdjustSociomantic; @@ -263,9 +249,7 @@ Adjust.trackEvent(event); Or with parameters: - - -### Java + ```java import com.adjust.sdk.plugin.AdjustSociomantic; @@ -297,9 +281,7 @@ Adjust.trackEvent(event); ### Confirmed transactions - - -### Java + ```java import com.adjust.sdk.plugin.AdjustSociomantic; @@ -326,9 +308,7 @@ Adjust.trackEvent(event); Or with parameters: - - -### Java + ```java import com.adjust.sdk.plugin.AdjustSociomantic; @@ -364,16 +344,14 @@ Adjust.trackEvent(event); | -------------- | ----------- | --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `SCMAmount` | Optional | Product price as decimal value (For example: 2.99) | Please use a dot as a decimal separator and don't use any thousand separators. Please only provide price per product, even if quantity has a value larger than 1. | | `SCMCurrency` | Optional | Currency code in ISO 4217 format (For example: EUR) | Fixed currency code. Should have been provided to you in the tracking code examples. | -| `SCMQuantity` | Optional | Quantity of the product selected | Please use an integer value. | +| `SCMQuantity` | Optional | Quantity of the product selected | Please use an integer value. | ### Lead event - - -### Java + ```java import com.adjust.sdk.plugin.AdjustSociomantic; @@ -389,9 +367,7 @@ Adjust.trackEvent(event); Or confirmed lead: - - -### Java + ```java import com.adjust.sdk.plugin.AdjustSociomantic; diff --git a/src/content/docs/sdk/android/plugins/trademob.mdx b/src/content/docs/sdk/android/plugins/trademob.mdx index 10fd9b34b..d2fc2a04c 100644 --- a/src/content/docs/sdk/android/plugins/trademob.mdx +++ b/src/content/docs/sdk/android/plugins/trademob.mdx @@ -18,7 +18,7 @@ To use this feature, you first need to download and set up the Adjust SDK for yo If you are using Maven, add the following dependency to your `build.gradle` file: -``` +```groovy title="build.gradle" dependencies { implementation 'com.adjust.sdk:adjust-android:4.28.2' implementation 'com.adjust.sdk:adjust-android-trademob:4.28.2' @@ -34,9 +34,7 @@ You can also add the plugin as a JAR file from the [releases page](https://githu ### View listing - - -### Java + ```java import com.adjust.sdk.plugin.AdjustTrademob; @@ -57,9 +55,7 @@ Adjust.trackEvent(event); ### View item - - -### Java + ```java import com.adjust.sdk.plugin.AdjustTrademob; @@ -79,9 +75,7 @@ Adjust.trackEvent(event); ### Add to basket - - -### Java + ```java import com.adjust.sdk.plugin.AdjustTrademob; @@ -103,9 +97,7 @@ Adjust.trackEvent(event); ### Checkout - - -### Java + ```java import com.adjust.sdk.plugin.AdjustTrademob; diff --git a/src/content/docs/sdk/android/plugins/vivo-referrer-plugin.mdx b/src/content/docs/sdk/android/plugins/vivo-referrer-plugin.mdx index a879224a3..544d130e0 100644 --- a/src/content/docs/sdk/android/plugins/vivo-referrer-plugin.mdx +++ b/src/content/docs/sdk/android/plugins/vivo-referrer-plugin.mdx @@ -18,7 +18,7 @@ There are two ways to install the Vivo referrer plugin: Add the following dependency to your `build.gradle` file under your Adjust SDK declaration. -```groovy +```groovy title="build.gradle" implementation 'com.adjust.sdk:adjust-android:4.33.1' implementation 'com.adjust.sdk:adjust-android-vivo-referrer:4.33.1' @@ -30,9 +30,9 @@ The Vivo referrer plugin is available on the GitHub [releases page](https://gith ## Use the plugin -The Vivo referrer plugin is __enabled__ by default. You can toggle reading Vivo install referrer information on and off using the `AdjustVivoReferrer` class methods. +The Vivo referrer plugin is **enabled** by default. You can toggle reading Vivo install referrer information on and off using the `AdjustVivoReferrer` class methods. -To __disable__ reading the install referrer, call `AdjustVivoReferrer.doNotReadVivoReferrer()` __before__ you initialize the SDK. +To **disable** reading the install referrer, call `AdjustVivoReferrer.doNotReadVivoReferrer()` **before** you initialize the SDK. @@ -55,7 +55,7 @@ Adjust.onCreate(config) -To __reenable__ reading the install referrer, call `AdjustVivoReferrer.readVivoReferrer(applicationContext)` __before__ you initialize the SDK. +To **reenable** reading the install referrer, call `AdjustVivoReferrer.readVivoReferrer(applicationContext)` **before** you initialize the SDK. diff --git a/src/content/docs/sdk/android/plugins/xiaomi-referrer-plugin.mdx b/src/content/docs/sdk/android/plugins/xiaomi-referrer-plugin.mdx index 4ae5dde06..207c76812 100644 --- a/src/content/docs/sdk/android/plugins/xiaomi-referrer-plugin.mdx +++ b/src/content/docs/sdk/android/plugins/xiaomi-referrer-plugin.mdx @@ -18,7 +18,7 @@ There are two ways to install the Xiaomi referrer plugin: Add the following dependency to your `build.gradle` file under your Adjust SDK declaration. -```groovy +```groovy title="build.gradle" implementation 'com.adjust.sdk:adjust-android:4.33.4' implementation 'com.adjust.sdk:adjust-android-xiaomi-referrer:4.33.4' @@ -34,9 +34,9 @@ You must add the Xiaomi install referrer to your app to read the referrer value. ### Maven -Add the following dependency to your build.gradle file after the Adjust SDK. +Add the following dependency to your `build.gradle` file after the Adjust SDK. -``` +```groovy title="build.gradle" implementation 'com.miui.referrer:homereferrer:1.0.0.6' ``` @@ -48,13 +48,13 @@ If you use Proguard, you must add rules to ensure that important classes aren't Add the following rule to keep all Adjust classes. -``` +```java title="Proguard.pro" -keep public class com.adjust.sdk.** { *; } ``` Add the following rule to keep the Xiaomi install referrer library. -``` +```java title="Proguard.pro" -keep class com.miui.referrer:homereferrer.** { *; } ``` @@ -62,7 +62,7 @@ Add the following rule to keep the Xiaomi install referrer library. The Xiaomi referrer plugin is active by default. You can enable or disable the reading of Xiaomi install referrer information using the `AdjustXiaomiReferrer` class methods. -To __disable__ reading the install referrer, call `AdjustXiaomiReferrer.doNotReadXiaomiReferrer()` __before__ you initialize the SDK. +To **disable** reading the install referrer, call `AdjustXiaomiReferrer.doNotReadXiaomiReferrer()` **before** you initialize the SDK. @@ -85,7 +85,7 @@ Adjust.onCreate(config); -To __enable__ reading this information, call `AdjustXiaomiReferrer.readXiaomiReferrer(applicationContext)` __before__ you initialize the SDK. +To **enable** reading this information, call `AdjustXiaomiReferrer.readXiaomiReferrer(applicationContext)` **before** you initialize the SDK. diff --git a/src/content/docs/sdk/android/reference/adjadrevenue.mdx b/src/content/docs/sdk/android/reference/adjadrevenue.mdx deleted file mode 100644 index eead262c5..000000000 --- a/src/content/docs/sdk/android/reference/adjadrevenue.mdx +++ /dev/null @@ -1,269 +0,0 @@ ---- -title: AdjustAdRevenue class -description: Use this class to store ad revenue information. -category-title: AdjustAdRevenue class -slug: en/sdk/android/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 "@android-signatures/ADJAdRevenue/constructor.mdx"; - - - - - - - -import Constructor from "@android-examples/ADJAdRevenue/constructor.mdx"; - - - - - - - -`source` (String): The source of the ad revenue. - - - -| Parameter | Source | -| --------------------------------------------- | ----------------- | -| `AdjustConfig.AD_REVENUE_APPLOVIN_MAX` | AppLovin MAX | -| `AdjustConfig.AD_REVENUE_MOPUB` | Mopub | -| `AdjustConfig.AD_REVENUE_ADMOB` | AdMob | -| `AdjustConfig.AD_REVENUE_IRONSOURCE` | ironSource | -| `AdjustConfig.AD_REVENUE_ADMOST` | AdMost | -| `AdjustConfig.AD_REVENUE_UNITY` | Unity | -| `AdjustConfig.AD_REVENUE_HELIUM_CHARTBOOST` | Helium Chartboost | -| `AdjustConfig.AD_REVENUE_SOURCE_PUBLISHER` | Generic source | - -
- - - - - - - -## setRevenue - -Set the revenue amount associated with the ad revenue object. - - - -import SetRevenueSig from "@android-signatures/ADJAdRevenue/setRevenue.mdx" - - - - - - - -import SetRevenue from "@android-examples/ADJAdRevenue/setRevenue.mdx" - - - - - - - -`revenue` (Double): The amount of currency units associated with the ad - -`currency` (String): 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 "@android-signatures/ADJAdRevenue/setAdImpressionsCount.mdx" - - - - - - - -import SetAdImpressionsCount from "@android-examples/ADJAdRevenue/setAdImpressionsCount.mdx" - - - - - - - -`adImpressionsCount` (Integer): The number of impressions associated with the ad - - - - - - - -## setAdRevenueNetwork - -Sets the network associated with the ad revenue. - - - -import SetAdRevenueNetworkSig from "@android-signatures/ADJAdRevenue/setAdRevenueNetwork.mdx" - - - - - - - -import SetAdRevenueNetwork from "@android-examples/ADJAdRevenue/setAdRevenueNetwork.mdx" - - - - - - - -`adRevenueNetwork` (String): The network associated with the ad revenue. - - - - - - - -## setAdRevenueUnit - -Sets the ad unit ID associated with the ad revenue. - - - -import SetAdRevenueUnitSig from "@android-signatures/ADJAdRevenue/setAdRevenueUnit.mdx" - - - - - - - -import SetAdRevenueUnit from "@android-examples/ADJAdRevenue/setAdRevenueUnit.mdx" - - - - - - - -`adRevenueUnit` (String): The ad unit ID associated with the ad revenue - - - - - - - -## setAdRevenuePlacement - -Sets the placement of the ad associated with the ad revenue. - - - -import SetAdRevenuePlacementSig from "@android-signatures/ADJAdRevenue/setAdRevenuePlacement.mdx" - - - - - - - -import SetAdRevenuePlacement from "@android-examples/ADJAdRevenue/setAdRevenuePlacement.mdx" - - - - - - - -`adRevenuePlacement` (String): The placement of the ad associated with the revenue - - - - - - - -## addCallbackParameter - -Adds key-value callback parameters to the ad revenue object. You can add multiple parameters by calling this method multiple times. - - - -import AddCallbackParameterSig from "@android-signatures/ADJAdRevenue/addCallbackParameter.mdx" - - - - - - - -import AddCallbackParameter from "@android-examples/ADJAdRevenue/addCallbackParameter.mdx" - - - - - - - -`key` (String): The data key - -`value` (String): The data value - - - - - - - -## addPartnerParameter - -Adds key-value partner parameters to the ad revenue object. You can add multiple parameters by calling this method multiple times. - - - -import AddPartnerParameterSig from "@android-signatures/ADJAdRevenue/addPartnerParameter.mdx" - - - - - - - -import AddPartnerParameter from "@android-examples/ADJAdRevenue/addPartnerParameter.mdx" - - - - - - - -`key` (String): The data key - -`value` (String): The data value - - - - diff --git a/src/content/docs/sdk/android/reference/adjattribution.mdx b/src/content/docs/sdk/android/reference/adjattribution.mdx deleted file mode 100644 index e0baa7a1b..000000000 --- a/src/content/docs/sdk/android/reference/adjattribution.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AdjustAttribution class -description: Use this class to see attribution information. -category-title: AdjustAttribution class -slug: en/sdk/android/reference/adjattribution ---- - -import Attribution from "@android-signatures/Adjust/attribution.mdx"; -import SetNeedsCost from "@android-signatures/ADJConfig/setNeedsCost.mdx"; - -The `AdjustAttribution` 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 `AdjustConfig` 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. | -| `fbInstallReferrer` | String | The [Facebook install referrer](https://developers.facebook.com/docs/app-ads/install-referrer/). | - -
diff --git a/src/content/docs/sdk/android/reference/adjconfig/index.mdx b/src/content/docs/sdk/android/reference/adjconfig/index.mdx deleted file mode 100644 index d0dad1a11..000000000 --- a/src/content/docs/sdk/android/reference/adjconfig/index.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: AdjustConfig class -description: Use the methods in this class to set up the Adjust SDK. -category-title: AdjustConfig class -slug: en/sdk/android/reference/adjconfig ---- - -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 "@android-signatures/ADJConfig/constructor.mdx" - - - - - - - -import Constructor from "@android-examples/ADJConfig/constructor.mdx" - - - - - - - -`appToken` (String): Your Adjust app token. - -`environment` (String): The environment your app is running in. - -`allowSuppressLogLevel` (Boolean): Whether to allow all logging to be suppressed. - - - - - -`config` (AdjustConfig): A config object initialized with the provided params. - - - - diff --git a/src/content/docs/sdk/android/reference/adjconfig/privacy.mdx b/src/content/docs/sdk/android/reference/adjconfig/privacy.mdx deleted file mode 100644 index 791d4f35a..000000000 --- a/src/content/docs/sdk/android/reference/adjconfig/privacy.mdx +++ /dev/null @@ -1,112 +0,0 @@ ---- -title: Privacy methods -description: Use the methods in this class to set up privacy in the Adjust SDK. -slug: en/sdk/android/reference/adjconfig/privacy -sidebar-position: 1 ---- - -Use the methods in this class to set up privacy in the Adjust SDK. - - - -## 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 "@android-signatures/ADJConfig/setUrlStrategy.mdx"; - - - - - - - -import SetUrlStrategy from "@android-examples/ADJConfig/setUrlStrategy.mdx"; - - - - - - - -`urlStrategy` (String): The data residency target - - - -| Value | Description | -| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `AdjustConfig.DATA_RESIDENCY_EU` | Sets the area of data residency to the EU | -| `AdjustConfig.DATA_RESIDENCY_TR` | Sets the area of data residency to Turkey | -| `AdjustConfig.DATA_RESIDENCY_US` | Sets the area of data residency to the USA | -| `URL_STRATEGY_CHINA` | Points the URL strategy to the `app.adjust.world` domain | -| `URL_STRATEGY_CN` | Points the URL strategy to the `app.adjust.cn` domain | -| `URL_STRATEGY_CN_ONLY` | Points the URL strategy to the `app.adjust.cn` domain but **doesn't** fall back to another domain if the request fails. | -| `URL_STRATEGY_INDIA` | Points the URL strategy to the `app.adjust.net.in` domain | - -
- - - - - - - -## setCoppaCompliantEnabled - -Enable COPPA (Children's Online Privacy Protection Act) compliance in your app. - - - -import SetCoppaCompliantEnabledSig from "@android-signatures/ADJConfig/setCoppaCompliantEnabled.mdx"; - - - - - - - -import SetCoppaCompliantEnabled from "@android-examples/ADJConfig/setCoppaCompliantEnabled.mdx"; - - - - - - - -`coppaCompliantEnabled` (boolean): Whether the app should be COPPA compliant - - - - - - - -## setPlayStoreKidsAppEnabled - -Marks your app as a Kids App and disables reading device information. - - - -import SetPlayStoreKidsAppEnabledSig from "@android-signatures/ADJConfig/setPlayStoreKidsAppEnabled.mdx"; - - - - - - - -import SetPlayStoreKidsAppEnabled from "@android-examples/ADJConfig/setPlayStoreKidsAppEnabled.mdx"; - - - - - - - -`playStoreKidsAppEnabled` (boolean): Whether the app is a Kids app - - - - diff --git a/src/content/docs/sdk/android/reference/adjconfig/setup.mdx b/src/content/docs/sdk/android/reference/adjconfig/setup.mdx deleted file mode 100644 index 2389344d2..000000000 --- a/src/content/docs/sdk/android/reference/adjconfig/setup.mdx +++ /dev/null @@ -1,484 +0,0 @@ ---- -title: Setup methods -description: Configure these properties to set up the Adjust SDK. -slug: en/sdk/android/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 "@android-signatures/ADJConfig/setLogLevel.mdx"; - - - - - - - -import SetLogLevel from "@android-examples/ADJConfig/setLogLevel.mdx"; - - - - - - - -`logLevel` (LogLevel): The level of logging output by the SDK. - - - -| Log level | Description | -| --------------------- | --------------------------------------------- | -| `LogLevel.VERBOSE` | Enable all logging | -| `LogLevel.DEBUG` | Enable debug logging | -| `LogLevel.INFO` | Only show info level logging (default option) | -| `LogLevel.WARN` | Disable informational warnings | -| `LogLevel.ERROR` | Disable warning level logging and below | -| `LogLevel.ASSERT` | Disable error level logging and below | -| `LogLevel.SUPPRESS` | Suppress all logging | - -
- - - - - - - -## setDefaultTracker - -Sets a default token to record installs against. - - - -import SetDefaultTrackerSig from "@android-signatures/ADJConfig/setDefaultTracker.mdx" - - - - - - - -import SetDefaultTracker from "@android-examples/ADJConfig/setDefaultTracker.mdx" - - - - - - - -`defaultTracker` (String): The token to which all preinstalled sessions are attributed. - - - - - - - -## 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 "@android-signatures/ADJConfig/setDelayStart.mdx" - - - - - - - -import SetDelayStart from "@android-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 "@android-signatures/ADJConfig/setExternalDeviceId.mdx" - - - - - - - -import SetExternalDeviceId from "@android-examples/ADJConfig/setExternalDeviceId.mdx" - - - - - - - -`externalDeviceId` (String): 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 "@android-signatures/ADJConfig/setEventBufferingEnabled.mdx" - - - - - - - -import SetEventBufferingEnabled from "@android-examples/ADJConfig/setEventBufferingEnabled.mdx" - - - - - - - -`eventBufferingEnabled` (Boolean): Whether event buffering is enabled. - - - - - - - -## setSendInBackground - -Sets whether the SDK should send data while the app is running in the background. - - - -import SetSendInBackgroundSig from "@android-signatures/ADJConfig/setSendInBackground.mdx" - - - - - - - -import SetSendInBackground from "@android-examples/ADJConfig/setSendInBackground.mdx" - - - - - - - -`sendInBackground` (boolean): Whether the SDK should send information to Adjust when the app is running in the background. - - - - - - - -## setPreinstallTrackingEnabled - -Enables or disables preinstall tracking. - - - -import SetPreinstallTrackingEnabledSig from "@android-signatures/ADJConfig/setPreinstallTrackingEnabled.mdx" - - - - - - - -import SetPreinstallTrackingEnabled from "@android-examples/ADJConfig/setPreinstallTrackingEnabled.mdx" - - - - - - - -`preinstallTrackingEnabled` (boolean): Whether preinstall tracking is enabled. - - - - - - - -## setPreinstallFilePath - -Defines a relative path where preinstall information is available. This directory must be world-readable. - - - -import SetPreinstallFilePathSig from "@android-signatures/ADJConfig/setPreinstallFilePath.mdx" - - - - - - - -import SetPreinstallFilePath from "@android-examples/ADJConfig/setPreinstallFilePath.mdx" - - - - - - - -`preinstallFilePath` (String): The path where the preinstall information is written. - - - - - - - -## setOnAttributionChangedListener - -Sets a delegate function that fires when a user's attribution information updates - - - -import SetOnAttributionChangedListenerSig from "@android-signatures/ADJConfig/setOnAttributionChangedListener.mdx" - - - - - - - -import SetOnAttributionChangedListener from "@android-examples/ADJConfig/setOnAttributionChangedListener.mdx" - - - - - - - -`onAttributionChangedListener` (OnAttributionChangedListener): The delegate function that the SDK calls when a the user's attribution information changes. - - - - - -### setOnAttributionChangedListener for Facebook example - -import SetOnAttributionChangedListenerFacebook from "@android-examples/ADJConfig/setOnAttributionChangedListenerFacebook.mdx" - - - - - -## setNeedsCost - -Sets whether the SDK should gather cost data. This is accessible in the user's attribution information. - - - -import SetNeedsCostSig from "@android-signatures/ADJConfig/setNeedsCost.mdx" - - - - - - - -import SetNeedsCost from "@android-examples/ADJConfig/setNeedsCost.mdx" - - - - - - - -`needsCost` (boolean): Whether the SDK should gather cost data - - - - - - - -## setOnSessionTrackingSucceededListener - -Sets up a success callback to trigger a function when the SDK records a session. - - - -import SetOnSessionTrackingSucceededListenerSig from "@android-signatures/ADJConfig/setOnSessionTrackingSucceededListener.mdx" - - - - - - - -import SetOnSessionTrackingSucceededListener from "@android-examples/ADJConfig/setOnSessionTrackingSucceededListener.mdx" - - - - - - - -`onSessionTrackingSucceededListener` (OnSessionTrackingSucceededListener): The function to launch when the SDK successfully records a session - - - - - - - -## setOnSessionTrackingFailedListener - -Sets up a callback to trigger a function when the SDK fails to record a session. - - - -import SetOnSessionTrackingFailedListenerSig from "@android-signatures/ADJConfig/setOnSessionTrackingFailedListener.mdx" - - - - - - - -import SetOnSessionTrackingFailedListener from "@android-examples/ADJConfig/setOnSessionTrackingFailedListener.mdx" - - - - - - - -`onSessionTrackingFailedListener` (OnSessionTrackingFailedListener): The function to launch when the SDK fails to record a session - - - - - - - -## setOnEventTrackingSucceededListener - -Sets up a success callback to trigger a function when the SDK records an event. - - - -import SetOnEventTrackingSucceededListenerSig from "@android-signatures/ADJConfig/setOnEventTrackingSucceededListener.mdx" - - - - - - - -import SetOnEventTrackingSucceededListener from "@android-examples/ADJConfig/setOnEventTrackingSucceededListener.mdx" - - - - - - - -`onEventTrackingSucceededListener` (OnEventTrackingSucceededListener): The function to launch when the SDK successfully records an event - - - - - - - -## setOnEventTrackingFailedListener - -Sets up a callback to trigger a function when the SDK fails to record an event. - - - -import SetOnEventTrackingFailedListenerSig from "@android-signatures/ADJConfig/setOnEventTrackingFailedListener.mdx" - - - - - - - -import SetOnEventTrackingFailedListener from "@android-examples/ADJConfig/setOnEventTrackingFailedListener.mdx" - - - - - - - -`onEventTrackingFailedListener` (OnEventTrackingFailedListener): The function to launch when the SDK fails to record an event - - - - - - - -## setOnDeeplinkResponseListener - -Sets up a callback to trigger a function when the SDK receives a deferred deep link. - - - -import SetOnDeeplinkResponseListenerSig from "@android-signatures/ADJConfig/setOnDeeplinkResponseListener.mdx" - - - - - - - -import SetOnDeeplinkResponseListener from "@android-examples/ADJConfig/setOnDeeplinkResponseListener.mdx" - - - - - - - -`onDeeplinkResponseListener` (OnDeeplinkResponseListener): The function to launch when the SDK receives a deferred deep link - - - - diff --git a/src/content/docs/sdk/android/reference/adjevent.mdx b/src/content/docs/sdk/android/reference/adjevent.mdx deleted file mode 100644 index d7e85cb04..000000000 --- a/src/content/docs/sdk/android/reference/adjevent.mdx +++ /dev/null @@ -1,198 +0,0 @@ ---- -title: AdjustEvent class -description: Record information about events to send to Adjust. -category-title: AdjustEvent class -slug: en/sdk/android/reference/adjevent ---- - -import TrackEvent from "@android-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 `AdjustEvent` object to the `trackEvent` method. - - - -## Constructor - -Instantiates an event object with an Adjust event token. - - - -import ConstructorSig from "@android-signatures/ADJEvent/constructor.mdx" - - - - - - - -import Constructor from "@android-examples/ADJEvent/constructor.mdx" - - - - - - - -`eventToken` (String): A six-character Adjust event token. - - - - - - - -## setRevenue - -Sets the revenue and currency associated with an event. - - - -import SetRevenueSig from "@android-signatures/ADJEvent/setRevenue.mdx" - - - - - - - -import SetRevenue from "@android-examples/ADJEvent/setRevenue.mdx" - - - - - - - -`amount` (double): The amount of currency units associated with the event. - -`currency` (String): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit. - - - - - - - -## setCallbackId - -Sets a custom identifier for your event object. Adjust's servers can report on this identifier in event callbacks. - - - -import SetCallbackIdSig from "@android-signatures/ADJEvent/setCallbackId.mdx" - - - - - - - -import SetCallbackId from "@android-examples/ADJEvent/setCallbackId.mdx" - - - - - - - -`callbackId` (String): A custom identifier for your event object - - - - - - - -## addCallbackParameter - -Adds key-value information to send to your callback URL. You can add multiple parameters by calling this method multiple times. - -Event callback parameters override session callback parameters that have the same key. - - - -import AddCallbackParameterSig from "@android-signatures/ADJEvent/addCallbackParameter.mdx" - - - - - - - -import AddCallbackParameter from "@android-examples/ADJEvent/addCallbackParameter.mdx" - - - - - - - -`key` (String): The data key - -`value` (String): The data value - - - - - - - -## addPartnerParameter - -Adds key-value information to share with partners. You can add multiple parameters by calling this method multiple times. - - - -import AddPartnerParameterSig from "@android-signatures/ADJEvent/addPartnerParameter.mdx" - - - - - - - -import AddPartnerParameter from "@android-examples/ADJEvent/addPartnerParameter.mdx" - - - - - - - -`key` (String): The data key - -`value` (String): The data value - - - - - - - -## setOrderId - -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 SetOrderIdSig from "@android-signatures/ADJEvent/setOrderId.mdx" - - - - - - - -import SetOrderId from "@android-examples/ADJEvent/setOrderId.mdx" - - - - - - - -`orderId` (String): A unique identifier used to deduplicate events - - - - diff --git a/src/content/docs/sdk/android/reference/adjplaystoresubscription.mdx b/src/content/docs/sdk/android/reference/adjplaystoresubscription.mdx deleted file mode 100644 index d902bd93c..000000000 --- a/src/content/docs/sdk/android/reference/adjplaystoresubscription.mdx +++ /dev/null @@ -1,145 +0,0 @@ ---- -title: AdjustPlayStoreSubscription class -description: Use this class to store Play Store subscription information to Adjust. -category-title: AdjustPlayStoreSubscription class -slug: en/sdk/android/reference/adjplaystoresubscription ---- - -import TrackPlayStoreSubscription from "@android-signatures/Adjust/trackPlayStoreSubscription.mdx" - -Use this class to store Play Store subscription information. You can pass this to Adjust's servers using the `trackPlayStoreSubscription` method. - - - -## Constructor - -Instantiates a Play Store subscription object with key information. - - - -import ConstructorSig from "@android-signatures/ADJPlayStoreSubscription/constructor.mdx" - - - - - - - -import Constructor from "@android-examples/ADJPlayStoreSubscription/constructor.mdx" - - - - - - - -`price` (long): The price of the subscription - -`currency` (String): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit. - -`sku` (String): The ID of the product - -`orderId` (String): The ID of the transaction - -`signature` (String): The signature of the purchase data - -`purchaseToken` (String): The unique token of the transaction. See [Google's documentation](https://developer.android.com/reference/com/android/billingclient/api/Purchase#getPurchaseToken()) for more information -:type purchaseToken: String - - - - - - - -## setPurchaseTime - -Sets the date of the transaction in the subscription object. - - - -import SetPurchaseTimeSig from "@android-signatures/ADJPlayStoreSubscription/setPurchaseTime.mdx" - - - - - - - -import SetPurchaseTime from "@android-examples/ADJPlayStoreSubscription/setPurchaseTime.mdx" - - - - - - - -`purchaseTime` (long): The date on which the subscription was purchased. - - - - - - - -## addCallbackParameter - -Adds key-value information to send to your callback URL. You can add multiple parameters by calling this method multiple times. - - - -import AddCallbackParameterSig from "@android-signatures/ADJPlayStoreSubscription/addCallbackParameter.mdx" - - - - - - - -import AddCallbackParameter from "@android-examples/ADJPlayStoreSubscription/addCallbackParameter.mdx" - - - - - - - -`key` (String): The data key - -`value` (String): The data value - - - - - - - -## addPartnerParameter - -Adds key-value information to share with partners. You can add multiple parameters by calling this method multiple times. - - - -import AddPartnerParameterSig from "@android-signatures/ADJPlayStoreSubscription/addPartnerParameter.mdx" - - - - - - - -import AddPartnerParameter from "@android-examples/ADJPlayStoreSubscription/addPartnerParameter.mdx" - - - - - - - -`key` (String): The data key - -`value` (String): The data value - - - - diff --git a/src/content/docs/sdk/android/reference/adjthirdpartysharing.mdx b/src/content/docs/sdk/android/reference/adjthirdpartysharing.mdx deleted file mode 100644 index 58ffc5c9e..000000000 --- a/src/content/docs/sdk/android/reference/adjthirdpartysharing.mdx +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: AdjustThirdPartySharing class -description: Use this class to communicate a user's third party sharing preferences. -category-title: AdjustThirdPartySharing class -slug: en/sdk/android/reference/adjthirdpartysharing ---- - -import TrackThirdPartySharing from "@android-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 **boolean** value. - - - -import ConstructorSig from "@android-signatures/ADJThirdPartySharing/constructor.mdx" - - - - - - - -import AdjustThirdPartySharingTrue from "@android-examples/ADJThirdPartySharing/adjustThirdPartySharingIsEnabledTrue.mdx"; - - - - - - - -import AdjustThirdPartySharingFalse from "@android-examples/ADJThirdPartySharing/adjustThirdPartySharingIsEnabledFalse.mdx"; - - - - - - - -`isEnabled` (Boolean): A nullable 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 "@android-signatures/ADJThirdPartySharing/addGranularOption.mdx" - - - - - - - -import AddGranularOption from "@android-examples/ADJThirdPartySharing/addGranularOption.mdx"; - - - -You can use this method to toggle Facebook data processing options. - -import Facebook from "@android-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` (String): The name of the partner you want to share information with - -`key` (String): The data key - -`value` (String): 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 "@android-signatures/ADJThirdPartySharing/addPartnerSharingSetting.mdx"; - - - - - - - -import AddPartnerSharingSetting from "@android-examples/ADJThirdPartySharing/addPartnerSharingSetting.mdx"; - - - - - - - -`partnerName` (String): The name of the partner whose settings you want to update. See the table of available partners below -`key` (String): The setting you want to update -`value` (boolean): 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/android/reference/adjust/config.mdx b/src/content/docs/sdk/android/reference/adjust/config.mdx deleted file mode 100644 index e8dfb47e3..000000000 --- a/src/content/docs/sdk/android/reference/adjust/config.mdx +++ /dev/null @@ -1,193 +0,0 @@ ---- -title: Configuration methods -description: Use these methods to update the Adjust SDK's configuration. -slug: en/sdk/android/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 "@android-signatures/Adjust/setEnabled.mdx" - - - - - - - -import SetEnabled from "@android-examples/Adjust/setEnabled.mdx" - - - - - - - -`enabled` (boolean): Whether the SDK is enabled - - - - - - - -## isEnabled - -Call this method to check whether the Adjust SDK is enabled. - - - -import IsEnabledSig from "@android-signatures/Adjust/isEnabled.mdx" - - - - - - - -import IsEnabled from "@android-examples/Adjust/isEnabled.mdx" - - - - - - - -`enabled` (boolean): Whether the SDK is enabled - - - - - - - -## 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 "@android-signatures/Adjust/setOfflineMode.mdx" - - - - - - - -import SetOfflineMode from "@android-examples/Adjust/setOfflineMode.mdx" - - - - - - - -`enabled` (boolean): Whether the SDK is in offline mode - - - - - - - -## setPushToken - -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 SetPushTokenSig from "@android-signatures/Adjust/setPushToken.mdx" - - - - - - - -import SetPushToken from "@android-examples/Adjust/setPushToken.mdx" - - - - - - - -`pushToken` (String): Your push token - -`context` (Context): The [context](https://developer.android.com/reference/android/content/Context) the method is being called in - - - - - - - - -## 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 "@android-signatures/Adjust/sendFirstPackages.mdx" - - - - - - - -import SendFirstPackages from "@android-examples/Adjust/sendFirstPackages.mdx" - - - - - - - - - -## appWillOpenUrl - -Processes URLs to extract deep link information. - - - -import AppWillOpenUrlSig from "@android-signatures/Adjust/appWillOpenUrl.mdx" - - - - - - - -import AppWillOpenUrl from "@android-examples/Adjust/appWillOpenUrl.mdx" - - - - - - - -`url` (Uri): The URL to extract deep link information - -`context` (Context): The [context](https://developer.android.com/reference/android/content/Context) the method is being called in - - - - diff --git a/src/content/docs/sdk/android/reference/adjust/device-info.mdx b/src/content/docs/sdk/android/reference/adjust/device-info.mdx deleted file mode 100644 index a7d0b6d9d..000000000 --- a/src/content/docs/sdk/android/reference/adjust/device-info.mdx +++ /dev/null @@ -1,112 +0,0 @@ ---- -title: Device information methods -description: Use these methods to retrieve device information. -slug: en/sdk/android/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 "@android-signatures/Adjust/adid.mdx" - - - - - - - -import Adid from "@android-examples/Adjust/adid.mdx" - - - - - - - -`adid` (String): The Adjust identifier associated with the device - - - - - - - -## getAmazonAdId - -Returns the Amazon Ad ID (Amazon Advertising ID) associated with the device. - - - -import GetAmazonAdIdSig from "@android-signatures/Adjust/getAmazonAdId.mdx" - - - - - - - -import GetAmazonAdId from "@android-examples/Adjust/getAmazonAdId.mdx" - - - - - - - -`context` (Context): The [context](https://developer.android.com/reference/android/content/Context) the method is being called in. - - - - - -`amazonAdId` (String): The device Amazon Ad ID - - - - - - - -## getGoogleAdId - -Returns the GPS ADID (Google Play Services Advertising ID) associated with the device. Must be called in a background thread. - - - -import GetGoogleAdIdSig from "@android-signatures/Adjust/getGoogleAdId.mdx" - - - - - - - -import GetGoogleAdId from "@android-examples/Adjust/getGoogleAdId.mdx" - - - - - - - -`context` (Context): The [context](https://developer.android.com/reference/android/content/Context) the method is being called in. - -`onDeviceIdsRead` (OnDeviceIdsRead): The function called when the SDK receives the ID from the device - - - - diff --git a/src/content/docs/sdk/android/reference/adjust/index.mdx b/src/content/docs/sdk/android/reference/adjust/index.mdx deleted file mode 100644 index 3f62d5e31..000000000 --- a/src/content/docs/sdk/android/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/android/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/android/reference/adjust/privacy.mdx b/src/content/docs/sdk/android/reference/adjust/privacy.mdx deleted file mode 100644 index fe92f37fe..000000000 --- a/src/content/docs/sdk/android/reference/adjust/privacy.mdx +++ /dev/null @@ -1,128 +0,0 @@ ---- -title: Privacy methods -description: Use these methods to handle user privacy in your app. -slug: en/sdk/android/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 "@android-signatures/Adjust/disableThirdPartySharing.mdx" - - - - - - - -import DisableThirdPartySharing from "@android-examples/Adjust/disableThirdPartySharing.mdx" - - - - - - - -`context` (Context): An optional parameter to pass the app context. Defaults to the extracted app context. - - - - - - - -## 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 "@android-signatures/Adjust/trackThirdPartySharing.mdx" - - - - - - - -import TrackThirdPartySharing from "@android-examples/Adjust/trackThirdPartySharing.mdx" - - - - - - - -`adjustThirdPartySharing` (AdjustThirdPartySharing): 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 "@android-signatures/Adjust/trackMeasurementConsent.mdx" - - - - - - - -import TrackMeasurementConsent from "@android-examples/Adjust/trackMeasurementConsent.mdx" - - - - - - - -`consentMeasurement` (boolean): 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 "@android-signatures/Adjust/gdprForgetMe.mdx" - - - - - - - -import GdprForgetMe from "@android-examples/Adjust/gdprForgetMe.mdx" - - - - - - - -`context` (Context): An optional parameter to pass the app context. Defaults to the extracted app context. - - - - diff --git a/src/content/docs/sdk/android/reference/adjust/recording.mdx b/src/content/docs/sdk/android/reference/adjust/recording.mdx deleted file mode 100644 index 435ec63f2..000000000 --- a/src/content/docs/sdk/android/reference/adjust/recording.mdx +++ /dev/null @@ -1,300 +0,0 @@ ---- -title: Recording methods -description: Use these methods to send information about your app to Adjust. -slug: en/sdk/android/reference/adjust/recording -sidebar-position: 4 ---- - -Use these methods to send information about your app to Adjust. - - - -## trackEvent - -Record event information using an `AdjustEvent` object and an [Adjust event token](https://help.adjust.com/en/article/add-events#add-event). - - - -import TrackEventSig from "@android-signatures/Adjust/trackEvent.mdx" - - - - - - - -import TrackEvent from "@android-examples/Adjust/trackEvent.mdx" - - - - - - - -`event` (AdjustEvent): 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 "@android-signatures/Adjust/addSessionCallbackParameter.mdx" - - - - - - - -import AddSessionCallbackParameter from "@android-examples/Adjust/addSessionCallbackParameter.mdx" - - - - - - - -`key` (String): The data key - -`value` (String): The data value - - - - - - - -## removeSessionCallbackParameter - -Remove a session callback parameter. - - - -import RemoveSessionCallbackParameterSig from "@android-signatures/Adjust/removeSessionCallbackParameter.mdx" - - - - - - - -import RemoveSessionCallbackParameter from "@android-examples/Adjust/removeSessionCallbackParameter.mdx" - - - - - - - -`key` (String): The data key of the parameter you want to remove - - - - - - - -## resetSessionCallbackParameters - -Removes all session callback parameters. - - - -import ResetSessionCallbackParametersSig from "@android-signatures/Adjust/resetSessionCallbackParameters.mdx" - - - - - - - -import ResetSessionCallbackParameters from "@android-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 "@android-signatures/Adjust/addSessionPartnerParameter.mdx" - - - - - - - -import AddSessionPartnerParameter from "@android-examples/Adjust/addSessionPartnerParameter.mdx" - - - - - - - -`key` (String): The data key - -`value` (String): The data value - - - - - - - -## removeSessionPartnerParameter - -Remove a session partner parameter. - - - -import RemoveSessionPartnerParameterSig from "@android-signatures/Adjust/removeSessionPartnerParameter.mdx" - - - - - - - -import RemoveSessionPartnerParameter from "@android-examples/Adjust/removeSessionPartnerParameter.mdx" - - - - - - - -`key` (String): The data key of the parameter you want to remove - - - - - - - -## resetSessionPartnerParameters - -Removes all session partner parameters. - - - -import ResetSessionPartnerParametersSig from "@android-signatures/Adjust/resetSessionPartnerParameters.mdx" - - - - - - - -import ResetSessionPartnerParameters from "@android-examples/Adjust/resetSessionPartnerParameters.mdx" - - - - - - - - - -## trackAdRevenue - -Send ad revenue information to Adjust in an AdjustAdRevenue object. - - - -import TrackAdRevenueSig from "@android-signatures/Adjust/trackAdRevenue.mdx" - - - - - - - -import TrackAdRevenue from "@android-examples/Adjust/trackAdRevenue.mdx" - - - - - - - -`adRevenue` (AdjustAdRevenue): The ad revenue object containing the revenue details - - - - - - - -## trackPlayStoreSubscription - -Send subscription details to Adjust in an AdjustPlayStoreSubscription object. - - - -import TrackPlayStoreSubscriptionSig from "@android-signatures/Adjust/trackPlayStoreSubscription.mdx" - - - - - - - -import TrackPlayStoreSubscription from "@android-examples/Adjust/trackPlayStoreSubscription.mdx" - - - - - - - -`subscription` (AdjustPlayStoreSubscription): The subscription object containing the purchase details - - - - - - - -## getAttribution - -Fetches attribution data about the device. - - - -import AttributionSig from "@android-signatures/Adjust/attribution.mdx" - - - - - - - -import Attribution from "@android-examples/Adjust/attribution.mdx" - - - - - - - -`attribution` (AdjustAttribution): An attribution object containing attribution data associated with the device - - - - diff --git a/src/content/docs/sdk/android/reference/index.mdx b/src/content/docs/sdk/android/reference/index.mdx deleted file mode 100644 index ec4bff265..000000000 --- a/src/content/docs/sdk/android/reference/index.mdx +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: SDK reference -description: SDK reference information for the Android SDK -category-title: Reference -slug: en/sdk/android/reference -type: category ---- diff --git a/src/content/docs/sdk/android/setup/index.mdx b/src/content/docs/sdk/android/setup/index.mdx index 22b3ab28d..88fc6037f 100644 --- a/src/content/docs/sdk/android/setup/index.mdx +++ b/src/content/docs/sdk/android/setup/index.mdx @@ -4,6 +4,7 @@ description: Follow the guides in this section to complete additional setup step category-title: Optional setup slug: en/sdk/android/setup type: category +sidebar-position: 2 --- Follow the guides in this section to complete additional setup steps for the Adjust Android SDK. diff --git a/src/content/docs/sdk/android/setup/multi-processes.mdx b/src/content/docs/sdk/android/setup/multi-processes.mdx index e0ee992d4..213c91fc2 100644 --- a/src/content/docs/sdk/android/setup/multi-processes.mdx +++ b/src/content/docs/sdk/android/setup/multi-processes.mdx @@ -12,14 +12,14 @@ Calling the SDK in multiple processes without setting the process name initializ Android apps can consist of one or more processes. To run services or activities in a process other than the main one, you need to add a process name to your activity or service. To do this, add an `android:process` property to your `activity` or `service` node in your `AndroidManifest.xml` file. -```xml +```xml title="AndroidManifest.xml" ``` -```xml +```xml title="AndroidManifest.xml" @@ -30,7 +30,7 @@ Defining a process name forces the activity or service to run in a process other By default, your main process name is the same as your app package name. For example, if your app package name is `com.example.myapp`, your main process is also named `com.example.myapp`. The above examples run in a process underneath this main process called `com.example.myapp:YourProcessName`. -The Adjust SDK doesn't currently support tracking for more than one process in an app. If your app uses multiple processes, set the main process name in your [`AdjustConfig` object](/en/sdk/android/reference/adjconfig). +The Adjust SDK doesn't currently support tracking for more than one process in an app. If your app uses multiple processes, set the main process name in your [`AdjustConfig` object](/en/sdk/android/configuration). @@ -67,7 +67,7 @@ let environment = AdjustConfig.EnvironmentSandbox; let adjustConfig = new AdjustConfig(appToken, environment); adjustConfig.setProcessName("com.example.myapp"); -Adjust.onCreate(adjustConfig) +Adjust.onCreate(adjustConfig); ``` @@ -75,7 +75,7 @@ Adjust.onCreate(adjustConfig) To change the name of your main process, modify the `android:process` property of the `application` node in your `AndroidManifest.xml` file. -```xml +```xml title="AndroidManifest.xml" diff --git a/src/content/docs/sdk/android/setup/preinstall-tool.mdx b/src/content/docs/sdk/android/setup/preinstall-tool.mdx index 3a764e1be..f8802ca85 100644 --- a/src/content/docs/sdk/android/setup/preinstall-tool.mdx +++ b/src/content/docs/sdk/android/setup/preinstall-tool.mdx @@ -125,7 +125,7 @@ Once you have your keystore file and your campaign token, you can create a confi Here's an example `adjust-config.yaml` file including settings for three stores named `store_1`, `store_2`, and `store_3`. -```yaml +```yaml title="adjust-config.yaml" apk_path: /Users/username/Desktop/apk/example-release.apk keystore_path: /Users/username/Desktop/apk/mykeystore.jks keystore_pass: mykeystorepass @@ -141,7 +141,7 @@ stores: You can define global parameters in the root of the file if you want to use the same settings for each store. Parameters set on a store will override the global parameters for that store. For example: -```yaml +```yaml title="adjust-config.yaml" apk_path: /Users/username/Desktop/apk/example-release.apk keystore_path: /Users/username/Desktop/apk/mykeystore.jks keystore_pass: mykeystorepass diff --git a/src/content/docs/sdk/android/setup/preinstalled.mdx b/src/content/docs/sdk/android/setup/preinstalled.mdx new file mode 100644 index 000000000..67bfa7342 --- /dev/null +++ b/src/content/docs/sdk/android/setup/preinstalled.mdx @@ -0,0 +1,189 @@ +--- +title: Send preinstalled app activity +description: Configure a campaign to send information from preinstalled apps. +slug: en/sdk/android/setup/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. + +Your config object contains a **boolean** `preinstallTrackingEnabled` property that controls this feature. To enable preinstall measurement, call the `setPreinstallTrackingEnabled` with a `true` argument. + + + + +```kotlin {4} +val appToken = "{YourAppToken}" +val environment = AdjustConfig.ENVIRONMENT_SANDBOX +val config = AdjustConfig(this, appToken, environment) +config.setPreinstallTrackingEnabled(true) +//... +Adjust.onCreate(config) +``` + + + + +```java {4} +String appToken = "{YourAppToken}"; +String environment = AdjustConfig.ENVIRONMENT_SANDBOX; +AdjustConfig config = new AdjustConfig(this, appToken, environment); +config.setPreinstallTrackingEnabled(true); +//... +Adjust.onCreate(config); +``` + + + + +```js {4} +var yourAppToken = yourAppToken; +var environment = AdjustConfig.EnvironmentSandbox; +var adjustConfig = new AdjustConfig(yourAppToken, environment); +adjustConfig.setPreinstallTrackingEnabled(true); +``` + + + + +The Adjust SDK provides 5 methods for measuring preinstalled apps: +- [System properties](#system-properties) +- [Content provider](#content-provider) +- [System installer receiver](#system-installer-receiver) +- [World-readable directory](#world-readable-directory) +- [Default campaign token](#default-campaign-token) + +## System properties + +Original Equipment Manufacturer (OEM) partners can leverage Android system properties to attribute preinstalled apps. The OEM (Original Equipment Manufacturer) writes attribution information to a file and adds its path to the system properties. The Adjust SDK reads this file on initialization to attribute the install. + +## Content provider + +The content provider method makes use of a read-only content provider. The SDK uses a content resolver to gather preinstall information from the request. + +To set the permissions, add the following to your `AndroidManifest.xml` file. + +```xml title="AndroidManifest.xml" + +``` + +To access a list of preinstalled apps on the device, add the following to your `AndroidManifest.xml` file. + +```xml title="AndroidManifest.xml" + + + + + +``` + +## System installer receiver + +The system installer method uses a broadcast receiver. The system installer broadcasts preinstall information. The Adjust SDK reads this information using the system preinstall referrer receiver. + +To set up the receiver, add the following to your `AndroidManifest.xml` file. + +```xml title="AndroidManifest.xml" + + + + + +``` + +## World-readable directory + +Save attribution information for your preinstalled app in a world-readable directory. The SDK reads the information from this file at install to attribute the user. The system encryption protocol protects app data. + +Pass the file path at which your preinstall information can be found to the `setPreinstallFilePath` method to give the Adjust SDK access to the information. + + + + +```kotlin {4} +val appToken = "{YourAppToken}" +val environment = AdjustConfig.ENVIRONMENT_SANDBOX +val config = AdjustConfig(this, appToken, environment) +config.setPreinstallFilePath("../EngagementFile.xml") +//... +Adjust.onCreate(config) +``` + + + + +```java {4} +String appToken = "{YourAppToken}"; +String environment = AdjustConfig.ENVIRONMENT_SANDBOX; +AdjustConfig config = new AdjustConfig(this, appToken, environment); +config.setPreinstallFilePath("../EngagementFile.xml"); +//... +Adjust.onCreate(config); +``` + + + + +```js {4} +var yourAppToken = yourAppToken; +var environment = AdjustConfig.EnvironmentSandbox; +var adjustConfig = new AdjustConfig(yourAppToken, environment); +adjustConfig.setPreinstallFilePath("../EngagementFile.xml"); +``` + + + + +## Default link token + +Configuring a default link token enables you to attribute all preinstalls to a predefined Adjust link. Adjust records all information against this token until the attribution source changes. To set this up: + +1. [Create a new campaign link in Campaign Lab](https://help.adjust.com/en/article/links). + + ```text + https://app.adjust.com/{token} + ``` + +2. Copy this token and pass it to the [`setDefaultTracker` method](/en/sdk/android/configuration#set-default-link-token). + + + + +```kotlin {4} +val appToken = "{YourAppToken}" +val environment = AdjustConfig.ENVIRONMENT_SANDBOX +val config = AdjustConfig(this, appToken, environment) +config.setDefaultTracker("{Token}") +//... +Adjust.onCreate(config) +``` + + + + +```java {4} +String appToken = "{YourAppToken}"; +String environment = AdjustConfig.ENVIRONMENT_SANDBOX; +AdjustConfig config = new AdjustConfig(this, appToken, environment); +config.setDefaultTracker("{Token}"); +//... +Adjust.onCreate(config); +``` + + + + +```js {4} +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 will see a message in your log. + + ```text + Default tracker: 'abc123'. + ``` diff --git a/src/content/docs/sdk/flutter/configuration/deep-links.mdx b/src/content/docs/sdk/flutter/configuration/deep-links.mdx index 8b9e7eddb..d8f18128c 100644 --- a/src/content/docs/sdk/flutter/configuration/deep-links.mdx +++ b/src/content/docs/sdk/flutter/configuration/deep-links.mdx @@ -22,7 +22,7 @@ If a user has your app installed, it opens when they interact with a link contai You need to set up deep linking on an app level. Follow the instructions linked below to set up deep linking on your target platform: - [iOS](/en/sdk/ios/configuration/deep-links) -- [Android](/en/sdk/android/configuration/deep-links) +- [Android](/en/sdk/android/features/deep-links) ## Reattribution using deep links diff --git a/src/content/docs/sdk/flutter/index.mdx b/src/content/docs/sdk/flutter/index.mdx index 312d50af7..65625d177 100644 --- a/src/content/docs/sdk/flutter/index.mdx +++ b/src/content/docs/sdk/flutter/index.mdx @@ -111,9 +111,7 @@ The install referrer is a unique identifier which you can use to attribute an ap - - -### Google Play Referrer API + To support the Google Play Referrer API, add the following in your `build.gradle` file: @@ -128,9 +126,7 @@ If you are using Proguard, make sure you have added the following setting in you ``` - - -### Huawei Referrer API + As of v4.22.0, the Adjust SDK supports install tracking on Huawei devices using Huawei App Gallery v10.4 and later. You don't need to make any changes to start using the Huawei Referrer API. diff --git a/src/content/docs/sdk/ios/integrations/admob.mdx b/src/content/docs/sdk/ios/integrations/admob.mdx index 7b299ed4e..5860973b8 100644 --- a/src/content/docs/sdk/ios/integrations/admob.mdx +++ b/src/content/docs/sdk/ios/integrations/admob.mdx @@ -23,9 +23,7 @@ To use this feature, you need to first reach out to your Google representative a ## Examples - - -### Objective-C + ```objc - (void)requestRewardedAd { diff --git a/src/content/docs/sdk/ios/integrations/batch.mdx b/src/content/docs/sdk/ios/integrations/batch.mdx index 278fc61b5..afaa4c9b1 100644 --- a/src/content/docs/sdk/ios/integrations/batch.mdx +++ b/src/content/docs/sdk/ios/integrations/batch.mdx @@ -17,9 +17,7 @@ To integrate Adjust with the Batch.com SDK, you need to send attribution to the You can set the callback method like this: - - -### Objective-C + ```objc - (void)adjustAttributionChanged:(ADJAttribution *)attribution { diff --git a/src/content/docs/sdk/ios/integrations/helium.mdx b/src/content/docs/sdk/ios/integrations/helium.mdx index 6de6155e3..8f5a005e3 100644 --- a/src/content/docs/sdk/ios/integrations/helium.mdx +++ b/src/content/docs/sdk/ios/integrations/helium.mdx @@ -19,9 +19,7 @@ If you want to measure ad revenue with the Helium by Chartboost SDK, you can use ## Example - - -### Objective-C + ```objc [NSNotificationCenter.defaultCenter addObserverForName:kHeliumDidReceiveILRDNotification diff --git a/src/content/docs/sdk/ios/integrations/ironsource.mdx b/src/content/docs/sdk/ios/integrations/ironsource.mdx index 43ebf32c6..da4e670a0 100644 --- a/src/content/docs/sdk/ios/integrations/ironsource.mdx +++ b/src/content/docs/sdk/ios/integrations/ironsource.mdx @@ -19,9 +19,7 @@ If you have any questions about ad revenue measurement with ironSource, please c ## Example - - -### Objective-C + ```objc - (void)impressionDataDidSucceed:(ISImpressionData *)impressionData { diff --git a/src/content/docs/sdk/ios/integrations/mixpanel.mdx b/src/content/docs/sdk/ios/integrations/mixpanel.mdx index a6a27fe27..8b1d069b6 100644 --- a/src/content/docs/sdk/ios/integrations/mixpanel.mdx +++ b/src/content/docs/sdk/ios/integrations/mixpanel.mdx @@ -27,9 +27,7 @@ You should send this information after receiving a response from Adjust's server Modify your callback method to use the Mixpanel API like this: - - -### Objective-C + ```objc - (void)adjustAttributionChanged:(ADJAttribution *)attribution { diff --git a/src/content/docs/sdk/ios/integrations/unity.mdx b/src/content/docs/sdk/ios/integrations/unity.mdx index 1e73f4ffe..7a836058d 100644 --- a/src/content/docs/sdk/ios/integrations/unity.mdx +++ b/src/content/docs/sdk/ios/integrations/unity.mdx @@ -25,9 +25,7 @@ For more information, see the Unity [Mediation API](https://docs.unity.com/media ## Examples - - -### Objective-C + ```objc diff --git a/src/content/docs/sdk/ios/plugins/criteo.mdx b/src/content/docs/sdk/ios/plugins/criteo.mdx index 420584427..ab3715c0b 100644 --- a/src/content/docs/sdk/ios/plugins/criteo.mdx +++ b/src/content/docs/sdk/ios/plugins/criteo.mdx @@ -9,9 +9,7 @@ You can integrate the Adjust iOS SDK with Criteo events by using the Adjust Crit ## Set up your environment - - -### CocoaPods + Add the following line to your `Podfile`: @@ -20,9 +18,7 @@ pod 'Adjust/Criteo' ``` - - -### Carthage + Add following line to your `Cartfile`: diff --git a/src/content/docs/sdk/ios/plugins/sociomatic.mdx b/src/content/docs/sdk/ios/plugins/sociomatic.mdx index fc7a1c16a..fded64d97 100644 --- a/src/content/docs/sdk/ios/plugins/sociomatic.mdx +++ b/src/content/docs/sdk/ios/plugins/sociomatic.mdx @@ -9,9 +9,7 @@ You can integrate the Adjust SDK with Sociomantic events. ## Set up your environment - - -### CocoaPods + Add the following line to your `Podfile`: @@ -20,9 +18,7 @@ pod 'Adjust/Sociomatic' ``` - - -### Carthage + Add following line to your `Cartfile`: diff --git a/src/content/docs/sdk/ios/plugins/trademob.mdx b/src/content/docs/sdk/ios/plugins/trademob.mdx index 9d356efc9..c49418f15 100644 --- a/src/content/docs/sdk/ios/plugins/trademob.mdx +++ b/src/content/docs/sdk/ios/plugins/trademob.mdx @@ -15,9 +15,7 @@ To use this feature, you first need to download and set up the Adjust SDK for yo ## Set up your environment - - -### CocoaPods + Add the following line to your `Podfile`: @@ -26,9 +24,7 @@ pod 'Adjust/Trademob' ``` - - -### Carthage + Add following line to your `Cartfile`: diff --git a/src/content/docs/sdk/react-native/configuration/deep-links.mdx b/src/content/docs/sdk/react-native/configuration/deep-links.mdx index a1154af84..3cb8c8238 100644 --- a/src/content/docs/sdk/react-native/configuration/deep-links.mdx +++ b/src/content/docs/sdk/react-native/configuration/deep-links.mdx @@ -30,7 +30,7 @@ To set up deep linking on your React Native app: 1. Set up deep linking on an app level. Follow the instructions linked below to set up deep linking on your target platform: - [iOS](/en/sdk/ios/configuration/deep-links) - - [Android](/en/sdk/android/configuration/deep-links) + - [Android](/en/sdk/android/features/deep-links) 2. Refer to the [React Native documentation](https://reactnative.dev/docs/linking.html) and follow the instructions to learn how to support both platforms. 3. Use your obtained deep link URL in your JavaScript code. diff --git a/src/content/docs/sdk/react-native/index.mdx b/src/content/docs/sdk/react-native/index.mdx index 16d0bf276..c46b42794 100644 --- a/src/content/docs/sdk/react-native/index.mdx +++ b/src/content/docs/sdk/react-native/index.mdx @@ -21,16 +21,12 @@ To use the Adjust SDK in your React Native app, you need to add it to your proje 1. Download the React Native library using one of the following options. - - -### GitHub + You can download the latest version of the SDK from Adjust's React Native SDK [GitHub releases page](https://github.com/adjust/react_native_sdk/releases). - - -### npm + Run the following command on your terminal: @@ -164,9 +160,7 @@ Although install referrer isn't required, it's highly recommended to improve att - - -### Google Play Referrer API + @@ -206,9 +200,7 @@ allprojects { ``` - - -### Huawei Referrer API + As of v4.22.0, the Adjust SDK supports install tracking on Huawei devices using Huawei App Gallery v10.4 and later. You don't need to make any changes to start using the Huawei Referrer API. diff --git a/src/content/docs/sdk/unity/configuration/deep-links.mdx b/src/content/docs/sdk/unity/configuration/deep-links.mdx index 4b1c98314..5ca6c8618 100644 --- a/src/content/docs/sdk/unity/configuration/deep-links.mdx +++ b/src/content/docs/sdk/unity/configuration/deep-links.mdx @@ -31,7 +31,7 @@ The SDK injects the required settings into Android and iOS projects in v4.30 and For Adjust SDK below v4.30 or Unity Editor below v2019.2 (Android only), you need to set up deep linking on an app level. Follow the instructions linked below to set up deep linking on your target platform: - [iOS](/en/sdk/ios/configuration/deep-links) -- [Android](/en/sdk/android/configuration/deep-links) +- [Android](/en/sdk/android/features/deep-links) ## Deep linking on iOS diff --git a/src/content/docs/sdk/unity/index.mdx b/src/content/docs/sdk/unity/index.mdx index f08e9af93..1dfe51839 100644 --- a/src/content/docs/sdk/unity/index.mdx +++ b/src/content/docs/sdk/unity/index.mdx @@ -125,9 +125,7 @@ The install referrer is a unique identifier which you can use to attribute an ap - Use the Huawei Referrer API. - - -### Google Play Referrer API + There are 2 ways to add support for the Google Play Referrer API: @@ -142,9 +140,7 @@ dependencies { 2. Download the install referrer library from [Maven](https://maven.google.com/web/index.html?q=install#com.android.installreferrer:installreferrer) and put the ARR (Android Archive) file in your `Plugins/Android` folder. - - -### Huawei Referrer API + As of v4.21.1, the Adjust SDK supports install tracking on Huawei devices using Huawei App Gallery v10.4 and later. You don't need to make any changes to start using the Huawei Referrer API. From fb40a9634c0a9738f3ca908a6c0709b11e0e639d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Fri, 23 Feb 2024 15:20:54 +0100 Subject: [PATCH 2/8] Update Flutter docs --- .../Adjust/addSessionCallbackParameter.mdx | 3 - .../Adjust/addSessionPartnerParameter.mdx | 3 - .../examples/Adjust/checkForNewAttStatus.mdx | 3 - .../Adjust/disableThirdPartySharing.mdx | 3 - .../flutter/examples/Adjust/gdprForgetMe.mdx | 3 - .../flutter/examples/Adjust/getAdid.mdx | 5 - .../flutter/examples/Adjust/getAmazonAdId.mdx | 5 - .../getAppTrackingAuthorizationStatus.mdx | 3 - .../examples/Adjust/getAttribution.mdx | 3 - .../flutter/examples/Adjust/getGoogleAdId.mdx | 5 - .../flutter/examples/Adjust/getIdfa.mdx | 5 - .../flutter/examples/Adjust/isEnabled.mdx | 3 - .../Adjust/removeSessionCallbackParameter.mdx | 3 - .../Adjust/removeSessionPartnerParameter.mdx | 3 - ...kingAuthorizationWithCompletionHandler.mdx | 20 - .../Adjust/resetSessionCallbackParameters.mdx | 3 - .../Adjust/resetSessionPartnerParameters.mdx | 3 - .../examples/Adjust/sendFirstPackages.mdx | 3 - .../flutter/examples/Adjust/setEnabled.mdx | 3 - .../examples/Adjust/setOfflineMode.mdx | 3 - .../flutter/examples/Adjust/setPushToken.mdx | 3 - .../examples/Adjust/trackAdRevenue.mdx | 5 - .../Adjust/trackAppStoreSubscription.mdx | 15 - .../flutter/examples/Adjust/trackEvent.mdx | 5 - .../Adjust/trackMeasurementConsent.mdx | 3 - .../Adjust/trackPlayStoreSubscription.mdx | 16 - .../Adjust/trackThirdPartySharing.mdx | 5 - .../examples/Adjust/updateConversionValue.mdx | 3 - .../AdjustAdRevenue/adImpressionsCount.mdx | 7 - .../AdjustAdRevenue/adRevenueNetwork.mdx | 7 - .../AdjustAdRevenue/adRevenuePlacement.mdx | 7 - .../AdjustAdRevenue/adRevenueUnit.mdx | 7 - .../AdjustAdRevenue/addCallbackParameter.mdx | 7 - .../AdjustAdRevenue/addPartnerParameter.mdx | 7 - .../examples/AdjustAdRevenue/constructor.mdx | 5 - .../examples/AdjustAdRevenue/setRevenue.mdx | 7 - .../addCallbackParameter.mdx | 10 - .../addPartnerParameter.mdx | 10 - .../constructor.mdx | 7 - .../setSalesRegion.mdx | 9 - .../setTransactionDate.mdx | 9 - .../AdjustConfig/attributionCallback.mdx | 32 -- .../examples/AdjustConfig/constructor.mdx | 5 - .../conversionValueUpdatedCallback.mdx | 7 - .../AdjustConfig/coppaCompliantEnabled.mdx | 7 - .../deactivateSKAdNetworkHandling.mdx | 7 - .../examples/AdjustConfig/defaultTracker.mdx | 7 - .../AdjustConfig/deferredDeeplinkCallback.mdx | 7 - .../examples/AdjustConfig/delayStart.mdx | 7 - .../AdjustConfig/eventBufferingEnabled.mdx | 7 - .../AdjustConfig/eventFailureCallback.mdx | 31 - .../AdjustConfig/eventSuccessCallback.mdx | 28 - .../AdjustConfig/externalDeviceId.mdx | 7 - .../AdjustConfig/launchDeferredDeeplink.mdx | 7 - .../examples/AdjustConfig/linkMeEnabled.mdx | 7 - .../examples/AdjustConfig/logLevel.mdx | 7 - .../examples/AdjustConfig/needsCost.mdx | 7 - .../AdjustConfig/playStoreKidsAppEnabled.mdx | 7 - .../preinstallTrackingEnabled.mdx | 7 - .../AdjustConfig/sendInBackground.mdx | 7 - .../AdjustConfig/sessionFailureCallback.mdx | 25 - .../AdjustConfig/sessionSuccessCallback.mdx | 22 - .../examples/AdjustConfig/urlStrategy.mdx | 7 - .../AdjustEvent/addCallbackParameter.mdx | 7 - .../AdjustEvent/addPartnerParameter.mdx | 7 - .../examples/AdjustEvent/callbackId.mdx | 7 - .../examples/AdjustEvent/constructor.mdx | 5 - .../examples/AdjustEvent/setRevenue.mdx | 7 - .../examples/AdjustEvent/transactionId.mdx | 7 - .../addCallbackParameter.mdx | 12 - .../addPartnerParameter.mdx | 12 - .../constructor.mdx | 9 - .../setPurchaseTime.mdx | 10 - .../addGranularOption.mdx | 7 - .../addGranularOptionFacebook.mdx | 8 - .../addPartnerSharingSetting.mdx | 7 - .../constructor_false.mdx | 5 - .../constructor_true.mdx | 5 - .../Adjust/addSessionCallbackParameter.mdx | 3 - .../Adjust/addSessionPartnerParameter.mdx | 3 - .../Adjust/checkForNewAttStatus.mdx | 3 - .../Adjust/disableThirdPartySharing.mdx | 3 - .../signatures/Adjust/gdprForgetMe.mdx | 3 - .../flutter/signatures/Adjust/getAdid.mdx | 3 - .../signatures/Adjust/getAmazonAdId.mdx | 3 - .../getAppTrackingAuthorizationStatus.mdx | 3 - .../signatures/Adjust/getAttribution.mdx | 3 - .../signatures/Adjust/getGoogleAdId.mdx | 3 - .../flutter/signatures/Adjust/getIdfa.mdx | 3 - .../flutter/signatures/Adjust/isEnabled.mdx | 3 - .../Adjust/removeSessionCallbackParameter.mdx | 3 - .../Adjust/removeSessionPartnerParameter.mdx | 3 - ...kingAuthorizationWithCompletionHandler.mdx | 3 - .../Adjust/resetSessionCallbackParameters.mdx | 3 - .../Adjust/resetSessionPartnerParameters.mdx | 3 - .../signatures/Adjust/sendFirstPackages.mdx | 3 - .../flutter/signatures/Adjust/setEnabled.mdx | 3 - .../signatures/Adjust/setOfflineMode.mdx | 3 - .../signatures/Adjust/setPushToken.mdx | 3 - .../signatures/Adjust/trackAdRevenue.mdx | 6 - .../Adjust/trackAppStoreSubscription.mdx | 3 - .../flutter/signatures/Adjust/trackEvent.mdx | 3 - .../Adjust/trackMeasurementConsent.mdx | 3 - .../Adjust/trackPlayStoreSubscription.mdx | 3 - .../Adjust/trackThirdPartySharing.mdx | 3 - .../Adjust/updateConversionValue.mdx | 3 - .../AdjustAdRevenue/adImpressionsCount.mdx | 3 - .../AdjustAdRevenue/adRevenueNetwork.mdx | 3 - .../AdjustAdRevenue/adRevenuePlacement.mdx | 3 - .../AdjustAdRevenue/adRevenueUnit.mdx | 3 - .../AdjustAdRevenue/addCallbackParameter.mdx | 5 - .../AdjustAdRevenue/addPartnerParameter.mdx | 5 - .../AdjustAdRevenue/constructor.mdx | 6 - .../signatures/AdjustAdRevenue/setRevenue.mdx | 6 - .../addCallbackParameter.mdx | 3 - .../addPartnerParameter.mdx | 3 - .../constructor.mdx | 3 - .../setSalesRegion.mdx | 3 - .../setTransactionDate.mdx | 3 - .../AdjustConfig/attributionCallback.mdx | 4 - .../signatures/AdjustConfig/constructor.mdx | 6 - .../conversionValueUpdatedCallback.mdx | 3 - .../AdjustConfig/coppaCompliantEnabled.mdx | 3 - .../deactivateSKAdNetworkHandling.mdx | 3 - .../AdjustConfig/defaultTracker.mdx | 3 - .../AdjustConfig/deferredDeeplinkCallback.mdx | 4 - .../signatures/AdjustConfig/delayStart.mdx | 3 - .../AdjustConfig/eventBufferingEnabled.mdx | 3 - .../AdjustConfig/eventFailureCallback.mdx | 4 - .../AdjustConfig/eventSuccessCallback.mdx | 4 - .../AdjustConfig/externalDeviceId.mdx | 3 - .../AdjustConfig/launchDeferredDeeplink.mdx | 3 - .../signatures/AdjustConfig/linkMeEnabled.mdx | 3 - .../signatures/AdjustConfig/logLevel.mdx | 3 - .../signatures/AdjustConfig/needsCost.mdx | 3 - .../AdjustConfig/playStoreKidsAppEnabled.mdx | 3 - .../preinstallTrackingEnabled.mdx | 3 - .../AdjustConfig/sendInBackground.mdx | 3 - .../AdjustConfig/sessionFailureCallback.mdx | 4 - .../AdjustConfig/sessionSuccessCallback.mdx | 4 - .../signatures/AdjustConfig/urlStrategy.mdx | 3 - .../AdjustEvent/addCallbackParameter.mdx | 3 - .../AdjustEvent/addPartnerParameter.mdx | 3 - .../signatures/AdjustEvent/callbackId.mdx | 3 - .../signatures/AdjustEvent/constructor.mdx | 3 - .../signatures/AdjustEvent/setRevenue.mdx | 3 - .../signatures/AdjustEvent/transactionId.mdx | 3 - .../addCallbackParameter.mdx | 3 - .../addPartnerParameter.mdx | 3 - .../constructor.mdx | 3 - .../setPurchaseTime.mdx | 3 - .../addGranularOption.mdx | 3 - .../addPartnerSharingSetting.mdx | 3 - .../AdjustThirdPartySharing/constructor.mdx | 3 - .../sdk/android/features/deep-linking.mdx | 2 +- .../docs/sdk/android/features/privacy.mdx | 37 +- .../android/features/session-parameters.mdx | 4 + .../docs/sdk/flutter/configuration.mdx | 276 +++++++++ .../sdk/flutter/configuration/background.mdx | 21 - .../docs/sdk/flutter/configuration/delay.mdx | 33 -- .../sdk/flutter/configuration/disable.mdx | 108 ---- .../configuration/external-device-id.mdx | 41 -- .../docs/sdk/flutter/configuration/index.mdx | 9 - .../flutter/configuration/preinstalled.mdx | 38 -- .../sdk/flutter/configuration/push-tokens.mdx | 22 - .../docs/sdk/flutter/features/ad-revenue.mdx | 166 ++++-- .../{configuration => features}/att.mdx | 53 +- .../docs/sdk/flutter/features/attribution.mdx | 93 ++- .../docs/sdk/flutter/features/callbacks.mdx | 138 ++++- .../deep-links.mdx | 74 ++- .../docs/sdk/flutter/features/device-info.mdx | 52 +- .../docs/sdk/flutter/features/events.mdx | 118 +++- .../docs/sdk/flutter/features/index.mdx | 1 + .../sdk/flutter/features/preinstalled.mdx | 43 ++ .../{configuration => features}/privacy.mdx | 220 ++++--- .../flutter/features/session-parameters.mdx | 99 +++- .../{configuration => features}/skad.mdx | 50 +- .../sdk/flutter/features/subscriptions.mdx | 197 ++++++- src/content/docs/sdk/flutter/index.mdx | 2 - .../sdk/flutter/reference/adjust/config.mdx | 157 ----- .../flutter/reference/adjust/device-info.mdx | 134 ----- .../sdk/flutter/reference/adjust/index.mdx | 9 - .../sdk/flutter/reference/adjust/privacy.mdx | 116 ---- .../flutter/reference/adjust/recording.mdx | 330 ----------- .../sdk/flutter/reference/adjust/skan-att.mdx | 122 ---- .../sdk/flutter/reference/adjustadrevenue.mdx | 269 --------- .../reference/adjustappstoresubscription.mdx | 170 ------ .../flutter/reference/adjustattribution.mdx | 44 -- .../flutter/reference/adjustconfig/index.mdx | 53 -- .../reference/adjustconfig/privacy.mdx | 79 --- .../flutter/reference/adjustconfig/setup.mdx | 538 ------------------ .../sdk/flutter/reference/adjustevent.mdx | 196 ------- .../reference/adjustplaystoresubscription.mdx | 145 ----- .../reference/adjustthirdpartysharing.mdx | 141 ----- .../docs/sdk/flutter/reference/index.mdx | 7 - 195 files changed, 1320 insertions(+), 3946 deletions(-) delete mode 100644 src/code-snippets/flutter/examples/Adjust/addSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/addSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/checkForNewAttStatus.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/disableThirdPartySharing.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/gdprForgetMe.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/getAdid.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/getAmazonAdId.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/getAppTrackingAuthorizationStatus.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/getAttribution.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/getGoogleAdId.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/getIdfa.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/isEnabled.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/removeSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/removeSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/requestTrackingAuthorizationWithCompletionHandler.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/resetSessionCallbackParameters.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/resetSessionPartnerParameters.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/sendFirstPackages.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/setEnabled.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/setOfflineMode.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/setPushToken.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/trackAdRevenue.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/trackAppStoreSubscription.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/trackEvent.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/trackMeasurementConsent.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/trackPlayStoreSubscription.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/trackThirdPartySharing.mdx delete mode 100644 src/code-snippets/flutter/examples/Adjust/updateConversionValue.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustAdRevenue/adImpressionsCount.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustAdRevenue/adRevenueNetwork.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustAdRevenue/adRevenuePlacement.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustAdRevenue/adRevenueUnit.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustAdRevenue/addCallbackParameter.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustAdRevenue/addPartnerParameter.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustAdRevenue/constructor.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustAdRevenue/setRevenue.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustAppStoreSubscription/addCallbackParameter.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustAppStoreSubscription/addPartnerParameter.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustAppStoreSubscription/constructor.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustAppStoreSubscription/setSalesRegion.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustAppStoreSubscription/setTransactionDate.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/attributionCallback.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/constructor.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/conversionValueUpdatedCallback.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/coppaCompliantEnabled.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/deactivateSKAdNetworkHandling.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/defaultTracker.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/deferredDeeplinkCallback.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/delayStart.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/eventBufferingEnabled.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/eventFailureCallback.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/eventSuccessCallback.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/externalDeviceId.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/launchDeferredDeeplink.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/linkMeEnabled.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/logLevel.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/needsCost.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/playStoreKidsAppEnabled.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/preinstallTrackingEnabled.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/sendInBackground.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/sessionFailureCallback.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/sessionSuccessCallback.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustConfig/urlStrategy.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustEvent/addCallbackParameter.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustEvent/addPartnerParameter.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustEvent/callbackId.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustEvent/constructor.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustEvent/setRevenue.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustEvent/transactionId.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustPlayStoreSubscription/addCallbackParameter.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustPlayStoreSubscription/addPartnerParameter.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustPlayStoreSubscription/constructor.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustPlayStoreSubscription/setPurchaseTime.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustThirdPartySharing/addGranularOption.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustThirdPartySharing/addGranularOptionFacebook.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustThirdPartySharing/addPartnerSharingSetting.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustThirdPartySharing/constructor_false.mdx delete mode 100644 src/code-snippets/flutter/examples/AdjustThirdPartySharing/constructor_true.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/addSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/addSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/checkForNewAttStatus.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/disableThirdPartySharing.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/gdprForgetMe.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/getAdid.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/getAmazonAdId.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/getAppTrackingAuthorizationStatus.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/getAttribution.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/getGoogleAdId.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/getIdfa.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/isEnabled.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/removeSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/removeSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/requestTrackingAuthorizationWithCompletionHandler.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/resetSessionCallbackParameters.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/resetSessionPartnerParameters.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/sendFirstPackages.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/setEnabled.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/setOfflineMode.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/setPushToken.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/trackAdRevenue.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/trackAppStoreSubscription.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/trackEvent.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/trackMeasurementConsent.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/trackPlayStoreSubscription.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/trackThirdPartySharing.mdx delete mode 100644 src/code-snippets/flutter/signatures/Adjust/updateConversionValue.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustAdRevenue/adImpressionsCount.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustAdRevenue/adRevenueNetwork.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustAdRevenue/adRevenuePlacement.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustAdRevenue/adRevenueUnit.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustAdRevenue/addCallbackParameter.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustAdRevenue/addPartnerParameter.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustAdRevenue/constructor.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustAdRevenue/setRevenue.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustAppStoreSubscription/addCallbackParameter.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustAppStoreSubscription/addPartnerParameter.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustAppStoreSubscription/constructor.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustAppStoreSubscription/setSalesRegion.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustAppStoreSubscription/setTransactionDate.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/attributionCallback.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/constructor.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/conversionValueUpdatedCallback.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/coppaCompliantEnabled.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/deactivateSKAdNetworkHandling.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/defaultTracker.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/deferredDeeplinkCallback.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/delayStart.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/eventBufferingEnabled.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/eventFailureCallback.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/eventSuccessCallback.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/externalDeviceId.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/launchDeferredDeeplink.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/linkMeEnabled.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/logLevel.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/needsCost.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/playStoreKidsAppEnabled.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/preinstallTrackingEnabled.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/sendInBackground.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/sessionFailureCallback.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/sessionSuccessCallback.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustConfig/urlStrategy.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustEvent/addCallbackParameter.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustEvent/addPartnerParameter.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustEvent/callbackId.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustEvent/constructor.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustEvent/setRevenue.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustEvent/transactionId.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustPlayStoreSubscription/addCallbackParameter.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustPlayStoreSubscription/addPartnerParameter.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustPlayStoreSubscription/constructor.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustPlayStoreSubscription/setPurchaseTime.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustThirdPartySharing/addGranularOption.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustThirdPartySharing/addPartnerSharingSetting.mdx delete mode 100644 src/code-snippets/flutter/signatures/AdjustThirdPartySharing/constructor.mdx create mode 100644 src/content/docs/sdk/flutter/configuration.mdx delete mode 100644 src/content/docs/sdk/flutter/configuration/background.mdx delete mode 100644 src/content/docs/sdk/flutter/configuration/delay.mdx delete mode 100644 src/content/docs/sdk/flutter/configuration/disable.mdx delete mode 100644 src/content/docs/sdk/flutter/configuration/external-device-id.mdx delete mode 100644 src/content/docs/sdk/flutter/configuration/index.mdx delete mode 100644 src/content/docs/sdk/flutter/configuration/preinstalled.mdx delete mode 100644 src/content/docs/sdk/flutter/configuration/push-tokens.mdx rename src/content/docs/sdk/flutter/{configuration => features}/att.mdx (79%) rename src/content/docs/sdk/flutter/{configuration => features}/deep-links.mdx (73%) create mode 100644 src/content/docs/sdk/flutter/features/preinstalled.mdx rename src/content/docs/sdk/flutter/{configuration => features}/privacy.mdx (51%) rename src/content/docs/sdk/flutter/{configuration => features}/skad.mdx (75%) delete mode 100644 src/content/docs/sdk/flutter/reference/adjust/config.mdx delete mode 100644 src/content/docs/sdk/flutter/reference/adjust/device-info.mdx delete mode 100644 src/content/docs/sdk/flutter/reference/adjust/index.mdx delete mode 100644 src/content/docs/sdk/flutter/reference/adjust/privacy.mdx delete mode 100644 src/content/docs/sdk/flutter/reference/adjust/recording.mdx delete mode 100644 src/content/docs/sdk/flutter/reference/adjust/skan-att.mdx delete mode 100644 src/content/docs/sdk/flutter/reference/adjustadrevenue.mdx delete mode 100644 src/content/docs/sdk/flutter/reference/adjustappstoresubscription.mdx delete mode 100644 src/content/docs/sdk/flutter/reference/adjustattribution.mdx delete mode 100644 src/content/docs/sdk/flutter/reference/adjustconfig/index.mdx delete mode 100644 src/content/docs/sdk/flutter/reference/adjustconfig/privacy.mdx delete mode 100644 src/content/docs/sdk/flutter/reference/adjustconfig/setup.mdx delete mode 100644 src/content/docs/sdk/flutter/reference/adjustevent.mdx delete mode 100644 src/content/docs/sdk/flutter/reference/adjustplaystoresubscription.mdx delete mode 100644 src/content/docs/sdk/flutter/reference/adjustthirdpartysharing.mdx delete mode 100644 src/content/docs/sdk/flutter/reference/index.mdx diff --git a/src/code-snippets/flutter/examples/Adjust/addSessionCallbackParameter.mdx b/src/code-snippets/flutter/examples/Adjust/addSessionCallbackParameter.mdx deleted file mode 100644 index 626713216..000000000 --- a/src/code-snippets/flutter/examples/Adjust/addSessionCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -Adjust.addSessionCallbackParameter('key', 'value'); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/addSessionPartnerParameter.mdx b/src/code-snippets/flutter/examples/Adjust/addSessionPartnerParameter.mdx deleted file mode 100644 index adcae5da8..000000000 --- a/src/code-snippets/flutter/examples/Adjust/addSessionPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -Adjust.addSessionPartnerParameter('key', 'value'); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/checkForNewAttStatus.mdx b/src/code-snippets/flutter/examples/Adjust/checkForNewAttStatus.mdx deleted file mode 100644 index f38c85d9e..000000000 --- a/src/code-snippets/flutter/examples/Adjust/checkForNewAttStatus.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -Adjust.checkForNewAttStatus(); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/disableThirdPartySharing.mdx b/src/code-snippets/flutter/examples/Adjust/disableThirdPartySharing.mdx deleted file mode 100644 index 2179c6bc3..000000000 --- a/src/code-snippets/flutter/examples/Adjust/disableThirdPartySharing.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -Adjust.disableThirdPartySharing(); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/gdprForgetMe.mdx b/src/code-snippets/flutter/examples/Adjust/gdprForgetMe.mdx deleted file mode 100644 index e2bfa8089..000000000 --- a/src/code-snippets/flutter/examples/Adjust/gdprForgetMe.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -Adjust.gdprForgetMe(); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/getAdid.mdx b/src/code-snippets/flutter/examples/Adjust/getAdid.mdx deleted file mode 100644 index 5336e4803..000000000 --- a/src/code-snippets/flutter/examples/Adjust/getAdid.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```dart -Adjust.getAdid().then((adid) { - // Use adid string value. -}); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/getAmazonAdId.mdx b/src/code-snippets/flutter/examples/Adjust/getAmazonAdId.mdx deleted file mode 100644 index 078819bfa..000000000 --- a/src/code-snippets/flutter/examples/Adjust/getAmazonAdId.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```dart -Adjust.getAmazonAdId().then((amazonAdId) { - // Use amazonAdId string value. -}); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/getAppTrackingAuthorizationStatus.mdx b/src/code-snippets/flutter/examples/Adjust/getAppTrackingAuthorizationStatus.mdx deleted file mode 100644 index 88318061d..000000000 --- a/src/code-snippets/flutter/examples/Adjust/getAppTrackingAuthorizationStatus.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -Adjust.getAppTrackingAuthorizationStatus(); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/getAttribution.mdx b/src/code-snippets/flutter/examples/Adjust/getAttribution.mdx deleted file mode 100644 index 88ac6c1e1..000000000 --- a/src/code-snippets/flutter/examples/Adjust/getAttribution.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -AdjustAttribution attribution = Adjust.getAttribution(); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/getGoogleAdId.mdx b/src/code-snippets/flutter/examples/Adjust/getGoogleAdId.mdx deleted file mode 100644 index 906dbc5e1..000000000 --- a/src/code-snippets/flutter/examples/Adjust/getGoogleAdId.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```dart -Adjust.getGoogleAdId().then((googleAdId) { - // Use googleAdId string value. -}); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/getIdfa.mdx b/src/code-snippets/flutter/examples/Adjust/getIdfa.mdx deleted file mode 100644 index 7eb65f7a8..000000000 --- a/src/code-snippets/flutter/examples/Adjust/getIdfa.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```dart -Adjust.getIdfa().then((idfa) { - // Use idfa string value. -}); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/isEnabled.mdx b/src/code-snippets/flutter/examples/Adjust/isEnabled.mdx deleted file mode 100644 index aa7649fdd..000000000 --- a/src/code-snippets/flutter/examples/Adjust/isEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -Adjust.isEnabled(); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/removeSessionCallbackParameter.mdx b/src/code-snippets/flutter/examples/Adjust/removeSessionCallbackParameter.mdx deleted file mode 100644 index 750ab38e4..000000000 --- a/src/code-snippets/flutter/examples/Adjust/removeSessionCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -Adjust.removeSessionCallbackParameter('key'); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/removeSessionPartnerParameter.mdx b/src/code-snippets/flutter/examples/Adjust/removeSessionPartnerParameter.mdx deleted file mode 100644 index 33f941095..000000000 --- a/src/code-snippets/flutter/examples/Adjust/removeSessionPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -Adjust.removeSessionPartnerParameter('key'); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/requestTrackingAuthorizationWithCompletionHandler.mdx b/src/code-snippets/flutter/examples/Adjust/requestTrackingAuthorizationWithCompletionHandler.mdx deleted file mode 100644 index dba29614d..000000000 --- a/src/code-snippets/flutter/examples/Adjust/requestTrackingAuthorizationWithCompletionHandler.mdx +++ /dev/null @@ -1,20 +0,0 @@ -```dart -if (Platform.isIOS) { - Adjust.requestTrackingAuthorizationWithCompletionHandler().then((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/flutter/examples/Adjust/resetSessionCallbackParameters.mdx b/src/code-snippets/flutter/examples/Adjust/resetSessionCallbackParameters.mdx deleted file mode 100644 index 4889dd99e..000000000 --- a/src/code-snippets/flutter/examples/Adjust/resetSessionCallbackParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -Adjust.resetSessionCallbackParameters(); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/resetSessionPartnerParameters.mdx b/src/code-snippets/flutter/examples/Adjust/resetSessionPartnerParameters.mdx deleted file mode 100644 index aa0d44ae7..000000000 --- a/src/code-snippets/flutter/examples/Adjust/resetSessionPartnerParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -Adjust.resetSessionPartnerParameters(); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/sendFirstPackages.mdx b/src/code-snippets/flutter/examples/Adjust/sendFirstPackages.mdx deleted file mode 100644 index fb593cccc..000000000 --- a/src/code-snippets/flutter/examples/Adjust/sendFirstPackages.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -Adjust.sendFirstPackages(); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/setEnabled.mdx b/src/code-snippets/flutter/examples/Adjust/setEnabled.mdx deleted file mode 100644 index 858e6b5f3..000000000 --- a/src/code-snippets/flutter/examples/Adjust/setEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -Adjust.setEnabled(false); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/setOfflineMode.mdx b/src/code-snippets/flutter/examples/Adjust/setOfflineMode.mdx deleted file mode 100644 index 320e15ebe..000000000 --- a/src/code-snippets/flutter/examples/Adjust/setOfflineMode.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -Adjust.setOfflineMode(true); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/setPushToken.mdx b/src/code-snippets/flutter/examples/Adjust/setPushToken.mdx deleted file mode 100644 index 064909373..000000000 --- a/src/code-snippets/flutter/examples/Adjust/setPushToken.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -Adjust.setPushToken('{PushNotificationsToken}'); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/trackAdRevenue.mdx b/src/code-snippets/flutter/examples/Adjust/trackAdRevenue.mdx deleted file mode 100644 index 04b9dee0f..000000000 --- a/src/code-snippets/flutter/examples/Adjust/trackAdRevenue.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```dart {3} -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/trackAppStoreSubscription.mdx b/src/code-snippets/flutter/examples/Adjust/trackAppStoreSubscription.mdx deleted file mode 100644 index 619947bd3..000000000 --- a/src/code-snippets/flutter/examples/Adjust/trackAppStoreSubscription.mdx +++ /dev/null @@ -1,15 +0,0 @@ -```dart {13} -AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( - price, - currency, - transactionId, - receipt); -subscription.setTransactionDate(transactionDate); -subscription.setSalesRegion(salesRegion); -subscription.addCallbackParameter('key1', 'value1'); -subscription.addCallbackParameter('key2', 'value2'); -subscription.addPartnerParameter('key1', 'value1'); -subscription.addPartnerParameter('key2', 'value2'); - -Adjust.trackAppStoreSubscription(subscription); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/trackEvent.mdx b/src/code-snippets/flutter/examples/Adjust/trackEvent.mdx deleted file mode 100644 index d16250c06..000000000 --- a/src/code-snippets/flutter/examples/Adjust/trackEvent.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```dart -AdjustEvent myAdjustEvent = new AdjustEvent('abc123'); -//... -Adjust.trackEvent(myAdjustEvent); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/trackMeasurementConsent.mdx b/src/code-snippets/flutter/examples/Adjust/trackMeasurementConsent.mdx deleted file mode 100644 index cbf77963a..000000000 --- a/src/code-snippets/flutter/examples/Adjust/trackMeasurementConsent.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -Adjust.trackMeasurementConsent(true); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/trackPlayStoreSubscription.mdx b/src/code-snippets/flutter/examples/Adjust/trackPlayStoreSubscription.mdx deleted file mode 100644 index ca8bca328..000000000 --- a/src/code-snippets/flutter/examples/Adjust/trackPlayStoreSubscription.mdx +++ /dev/null @@ -1,16 +0,0 @@ -```dart {14} -AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken); -subscription.setPurchaseTime(purchaseTime); -subscription.addCallbackParameter('key1', 'value1'); -subscription.addCallbackParameter('key2', 'value2'); -subscription.addPartnerParameter('key1', 'value1'); -subscription.addPartnerParameter('key2', 'value2'); - -Adjust.trackPlayStoreSubscription(subscription); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/trackThirdPartySharing.mdx b/src/code-snippets/flutter/examples/Adjust/trackThirdPartySharing.mdx deleted file mode 100644 index fcd06b8ba..000000000 --- a/src/code-snippets/flutter/examples/Adjust/trackThirdPartySharing.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```dart {3} -AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(false); -//... -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` diff --git a/src/code-snippets/flutter/examples/Adjust/updateConversionValue.mdx b/src/code-snippets/flutter/examples/Adjust/updateConversionValue.mdx deleted file mode 100644 index 3482a49c4..000000000 --- a/src/code-snippets/flutter/examples/Adjust/updateConversionValue.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -Adjust.updateConversionValue(6); -``` diff --git a/src/code-snippets/flutter/examples/AdjustAdRevenue/adImpressionsCount.mdx b/src/code-snippets/flutter/examples/AdjustAdRevenue/adImpressionsCount.mdx deleted file mode 100644 index b53fa5ad1..000000000 --- a/src/code-snippets/flutter/examples/AdjustAdRevenue/adImpressionsCount.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -//... -adjustAdRevenue.adImpressionsCount = 10; -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/flutter/examples/AdjustAdRevenue/adRevenueNetwork.mdx b/src/code-snippets/flutter/examples/AdjustAdRevenue/adRevenueNetwork.mdx deleted file mode 100644 index e1e4e035f..000000000 --- a/src/code-snippets/flutter/examples/AdjustAdRevenue/adRevenueNetwork.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -//... -adjustAdRevenue.adRevenueNetwork = "network1"; -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/flutter/examples/AdjustAdRevenue/adRevenuePlacement.mdx b/src/code-snippets/flutter/examples/AdjustAdRevenue/adRevenuePlacement.mdx deleted file mode 100644 index fe59eeb82..000000000 --- a/src/code-snippets/flutter/examples/AdjustAdRevenue/adRevenuePlacement.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -//... -adjustAdRevenue.adRevenuePlacement = "banner"; -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/flutter/examples/AdjustAdRevenue/adRevenueUnit.mdx b/src/code-snippets/flutter/examples/AdjustAdRevenue/adRevenueUnit.mdx deleted file mode 100644 index 9e14f6987..000000000 --- a/src/code-snippets/flutter/examples/AdjustAdRevenue/adRevenueUnit.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -//... -adjustAdRevenue.adRevenueUnit = "unit1"; -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/flutter/examples/AdjustAdRevenue/addCallbackParameter.mdx b/src/code-snippets/flutter/examples/AdjustAdRevenue/addCallbackParameter.mdx deleted file mode 100644 index 01749a046..000000000 --- a/src/code-snippets/flutter/examples/AdjustAdRevenue/addCallbackParameter.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -//... -adjustAdRevenue.addCallbackParameter("key", "value") -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/flutter/examples/AdjustAdRevenue/addPartnerParameter.mdx b/src/code-snippets/flutter/examples/AdjustAdRevenue/addPartnerParameter.mdx deleted file mode 100644 index d3ee9fea2..000000000 --- a/src/code-snippets/flutter/examples/AdjustAdRevenue/addPartnerParameter.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -//... -adjustAdRevenue.addPartnerParameter("key", "value"); -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/flutter/examples/AdjustAdRevenue/constructor.mdx b/src/code-snippets/flutter/examples/AdjustAdRevenue/constructor.mdx deleted file mode 100644 index 07dd0c4a0..000000000 --- a/src/code-snippets/flutter/examples/AdjustAdRevenue/constructor.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```dart -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/flutter/examples/AdjustAdRevenue/setRevenue.mdx b/src/code-snippets/flutter/examples/AdjustAdRevenue/setRevenue.mdx deleted file mode 100644 index 02af901ae..000000000 --- a/src/code-snippets/flutter/examples/AdjustAdRevenue/setRevenue.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -//... -adjustAdRevenue.setRevenue(1.00, "EUR"); -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/flutter/examples/AdjustAppStoreSubscription/addCallbackParameter.mdx b/src/code-snippets/flutter/examples/AdjustAppStoreSubscription/addCallbackParameter.mdx deleted file mode 100644 index e9d2113f7..000000000 --- a/src/code-snippets/flutter/examples/AdjustAppStoreSubscription/addCallbackParameter.mdx +++ /dev/null @@ -1,10 +0,0 @@ -```dart {7-8} -AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( - price, - currency, - transactionId, - receipt); -//... -subscription.addCallbackParameter('key1', 'value1'); -subscription.addCallbackParameter('key2', 'value2'); -``` diff --git a/src/code-snippets/flutter/examples/AdjustAppStoreSubscription/addPartnerParameter.mdx b/src/code-snippets/flutter/examples/AdjustAppStoreSubscription/addPartnerParameter.mdx deleted file mode 100644 index 2b9ae10ff..000000000 --- a/src/code-snippets/flutter/examples/AdjustAppStoreSubscription/addPartnerParameter.mdx +++ /dev/null @@ -1,10 +0,0 @@ -```dart {7-8} -AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( - price, - currency, - transactionId, - receipt); -//... -subscription.addPartnerParameter('key1', 'value1'); -subscription.addPartnerParameter('key2', 'value2'); -``` diff --git a/src/code-snippets/flutter/examples/AdjustAppStoreSubscription/constructor.mdx b/src/code-snippets/flutter/examples/AdjustAppStoreSubscription/constructor.mdx deleted file mode 100644 index 7e7e5e860..000000000 --- a/src/code-snippets/flutter/examples/AdjustAppStoreSubscription/constructor.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart -AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( - price, - currency, - transactionId, - receipt); -``` diff --git a/src/code-snippets/flutter/examples/AdjustAppStoreSubscription/setSalesRegion.mdx b/src/code-snippets/flutter/examples/AdjustAppStoreSubscription/setSalesRegion.mdx deleted file mode 100644 index 64f8134c3..000000000 --- a/src/code-snippets/flutter/examples/AdjustAppStoreSubscription/setSalesRegion.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```dart {7} -AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( - price, - currency, - transactionId, - receipt); -//... -subscription.setSalesRegion(salesRegion); -``` diff --git a/src/code-snippets/flutter/examples/AdjustAppStoreSubscription/setTransactionDate.mdx b/src/code-snippets/flutter/examples/AdjustAppStoreSubscription/setTransactionDate.mdx deleted file mode 100644 index f641bee14..000000000 --- a/src/code-snippets/flutter/examples/AdjustAppStoreSubscription/setTransactionDate.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```dart {7} -AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( - price, - currency, - transactionId, - receipt); -//... -subscription.setTransactionDate(transactionDate); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/attributionCallback.mdx b/src/code-snippets/flutter/examples/AdjustConfig/attributionCallback.mdx deleted file mode 100644 index 7d82746e8..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/attributionCallback.mdx +++ /dev/null @@ -1,32 +0,0 @@ -```dart {2-29} -AdjustConfig adjustConfig = new AdjustConfig(yourAppToken, environment); -config.attributionCallback = (AdjustAttribution attributionChangedData) { - print('[Adjust]: Attribution changed!'); - - if (attributionChangedData.trackerToken != null) { - print('[Adjust]: Tracker token: ' + attributionChangedData.trackerToken); - } - if (attributionChangedData.trackerName != null) { - print('[Adjust]: Tracker name: ' + attributionChangedData.trackerName); - } - if (attributionChangedData.campaign != null) { - print('[Adjust]: Campaign: ' + attributionChangedData.campaign); - } - if (attributionChangedData.network != null) { - print('[Adjust]: Network: ' + attributionChangedData.network); - } - if (attributionChangedData.creative != null) { - print('[Adjust]: Creative: ' + attributionChangedData.creative); - } - if (attributionChangedData.adgroup != null) { - print('[Adjust]: Adgroup: ' + attributionChangedData.adgroup); - } - if (attributionChangedData.clickLabel != null) { - print('[Adjust]: Click label: ' + attributionChangedData.clickLabel); - } - if (attributionChangedData.adid != null) { - print('[Adjust]: Adid: ' + attributionChangedData.adid); - } -}; -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/constructor.mdx b/src/code-snippets/flutter/examples/AdjustConfig/constructor.mdx deleted file mode 100644 index eb6ae12c5..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/constructor.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```dart {1} -AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/conversionValueUpdatedCallback.mdx b/src/code-snippets/flutter/examples/AdjustConfig/conversionValueUpdatedCallback.mdx deleted file mode 100644 index 0382dc43f..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/conversionValueUpdatedCallback.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {2-4} -AdjustConfig adjustConfig = new AdjustConfig(yourAppToken, environment); -config.conversionValueUpdatedCallback = (num? conversionValue) { - print('[Adjust]: Received conversion value update: ' + conversionValue!.toString()); -}; -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/coppaCompliantEnabled.mdx b/src/code-snippets/flutter/examples/AdjustConfig/coppaCompliantEnabled.mdx deleted file mode 100644 index d2cfe198a..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/coppaCompliantEnabled.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); -//... -adjustConfig.coppaCompliantEnabled = true; -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/deactivateSKAdNetworkHandling.mdx b/src/code-snippets/flutter/examples/AdjustConfig/deactivateSKAdNetworkHandling.mdx deleted file mode 100644 index 1c0a2d2f1..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/deactivateSKAdNetworkHandling.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox, true); -//... -adjustConfig.deactivateSKAdNetworkHandling(); -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/defaultTracker.mdx b/src/code-snippets/flutter/examples/AdjustConfig/defaultTracker.mdx deleted file mode 100644 index d717d2520..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/defaultTracker.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); -//... -adjustConfig.defaultTracker = '{TrackerToken}'; -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/deferredDeeplinkCallback.mdx b/src/code-snippets/flutter/examples/AdjustConfig/deferredDeeplinkCallback.mdx deleted file mode 100644 index f95a963c1..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/deferredDeeplinkCallback.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {2-4} -AdjustConfig adjustConfig = new AdjustConfig(yourAppToken, environment); -adjustConfig.deferredDeeplinkCallback = (String uri) { - print('[Adjust]: Received deferred deeplink: ' + uri); -}; -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/delayStart.mdx b/src/code-snippets/flutter/examples/AdjustConfig/delayStart.mdx deleted file mode 100644 index cadfaf8f0..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/delayStart.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); -//... -adjustConfig.delayStart(5.5); -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/eventBufferingEnabled.mdx b/src/code-snippets/flutter/examples/AdjustConfig/eventBufferingEnabled.mdx deleted file mode 100644 index 5d33ff89d..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/eventBufferingEnabled.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); -//... -adjustConfig.eventBufferingEnabled = true; -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/eventFailureCallback.mdx b/src/code-snippets/flutter/examples/AdjustConfig/eventFailureCallback.mdx deleted file mode 100644 index aec4acff7..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/eventFailureCallback.mdx +++ /dev/null @@ -1,31 +0,0 @@ -```dart -AdjustConfig adjustConfig = new AdjustConfig(yourAppToken, environment); - -config.eventFailureCallback = (AdjustEventFailure eventFailureData) { - print('[Adjust]: Event tracking failure!'); - - if (eventFailureData.eventToken != null) { - print('[Adjust]: Event token: ' + eventFailureData.eventToken); - } - if (eventFailureData.message != null) { - print('[Adjust]: Message: ' + eventFailureData.message); - } - if (eventFailureData.timestamp != null) { - print('[Adjust]: Timestamp: ' + eventFailureData.timestamp); - } - if (eventFailureData.adid != null) { - print('[Adjust]: Adid: ' + eventFailureData.adid); - } - if (eventFailureData.callbackId != null) { - print('[Adjust]: Callback ID: ' + eventFailureData.callbackId); - } - if (eventFailureData.willRetry != null) { - print('[Adjust]: Will retry: ' + eventFailureData.willRetry.toString()); - } - if (eventFailureData.jsonResponse != null) { - print('[Adjust]: JSON response: ' + eventFailureData.jsonResponse); - } -}; - -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/eventSuccessCallback.mdx b/src/code-snippets/flutter/examples/AdjustConfig/eventSuccessCallback.mdx deleted file mode 100644 index 0896e0b52..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/eventSuccessCallback.mdx +++ /dev/null @@ -1,28 +0,0 @@ -```dart -AdjustConfig adjustConfig = new AdjustConfig(yourAppToken, environment); - -config.eventSuccessCallback = (AdjustEventSuccess eventSuccessData) { - print('[Adjust]: Event tracking success!'); - - if (eventSuccessData.eventToken != null) { - print('[Adjust]: Event token: ' + eventSuccessData.eventToken); - } - if (eventSuccessData.message != null) { - print('[Adjust]: Message: ' + eventSuccessData.message); - } - if (eventSuccessData.timestamp != null) { - print('[Adjust]: Timestamp: ' + eventSuccessData.timestamp); - } - if (eventSuccessData.adid != null) { - print('[Adjust]: Adid: ' + eventSuccessData.adid); - } - if (eventSuccessData.callbackId != null) { - print('[Adjust]: Callback ID: ' + eventSuccessData.callbackId); - } - if (eventSuccessData.jsonResponse != null) { - print('[Adjust]: JSON response: ' + eventSuccessData.jsonResponse); - } -}; - -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/externalDeviceId.mdx b/src/code-snippets/flutter/examples/AdjustConfig/externalDeviceId.mdx deleted file mode 100644 index b4d2d6261..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/externalDeviceId.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); -//... -adjustConfig.externalDeviceId = '{Your-External-Device-Id}'; -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/launchDeferredDeeplink.mdx b/src/code-snippets/flutter/examples/AdjustConfig/launchDeferredDeeplink.mdx deleted file mode 100644 index c79c8e0bd..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/launchDeferredDeeplink.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); -//... -adjustConfig.launchDeferredDeeplink = true; -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/linkMeEnabled.mdx b/src/code-snippets/flutter/examples/AdjustConfig/linkMeEnabled.mdx deleted file mode 100644 index 0edc1f94c..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/linkMeEnabled.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); -//... -adjustConfig.linkMeEnabled = true; -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/logLevel.mdx b/src/code-snippets/flutter/examples/AdjustConfig/logLevel.mdx deleted file mode 100644 index 7973d6eda..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/logLevel.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); -//... -adjustConfig.logLevel = AdjustLogLevel.verbose; -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/needsCost.mdx b/src/code-snippets/flutter/examples/AdjustConfig/needsCost.mdx deleted file mode 100644 index cf07ce3bb..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/needsCost.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); -//... -adjustConfig.needsCost = true; -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/playStoreKidsAppEnabled.mdx b/src/code-snippets/flutter/examples/AdjustConfig/playStoreKidsAppEnabled.mdx deleted file mode 100644 index 80c646da3..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/playStoreKidsAppEnabled.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); -//... -adjustConfig.playStoreKidsAppEnabled = true; -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/preinstallTrackingEnabled.mdx b/src/code-snippets/flutter/examples/AdjustConfig/preinstallTrackingEnabled.mdx deleted file mode 100644 index 3de647771..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/preinstallTrackingEnabled.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); -//... -adjustConfig.preinstallTrackingEnabled = true; -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/sendInBackground.mdx b/src/code-snippets/flutter/examples/AdjustConfig/sendInBackground.mdx deleted file mode 100644 index 425f3eafa..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/sendInBackground.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); -//... -adjustConfig.sendInBackground = true; -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/sessionFailureCallback.mdx b/src/code-snippets/flutter/examples/AdjustConfig/sessionFailureCallback.mdx deleted file mode 100644 index 4f89cd759..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/sessionFailureCallback.mdx +++ /dev/null @@ -1,25 +0,0 @@ -```dart -AdjustConfig adjustConfig = new AdjustConfig(yourAppToken, environment); - -config.sessionFailureCallback = (AdjustSessionFailure sessionFailureData) { - print('[Adjust]: Session tracking failure!'); - - if (sessionFailureData.message != null) { - print('[Adjust]: Message: ' + sessionFailureData.message); - } - if (sessionFailureData.timestamp != null) { - print('[Adjust]: Timestamp: ' + sessionFailureData.timestamp); - } - if (sessionFailureData.adid != null) { - print('[Adjust]: Adid: ' + sessionFailureData.adid); - } - if (sessionFailureData.willRetry != null) { - print('[Adjust]: Will retry: ' + sessionFailureData.willRetry.toString()); - } - if (sessionFailureData.jsonResponse != null) { - print('[Adjust]: JSON response: ' + sessionFailureData.jsonResponse); - } -}; - -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/sessionSuccessCallback.mdx b/src/code-snippets/flutter/examples/AdjustConfig/sessionSuccessCallback.mdx deleted file mode 100644 index e1b805cce..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/sessionSuccessCallback.mdx +++ /dev/null @@ -1,22 +0,0 @@ -```dart -AdjustConfig adjustConfig = new AdjustConfig(yourAppToken, environment); - -config.sessionSuccessCallback = (AdjustSessionSuccess sessionSuccessData) { - print('[Adjust]: Session tracking success!'); - - if (sessionSuccessData.message != null) { - print('[Adjust]: Message: ' + sessionSuccessData.message); - } - if (sessionSuccessData.timestamp != null) { - print('[Adjust]: Timestamp: ' + sessionSuccessData.timestamp); - } - if (sessionSuccessData.adid != null) { - print('[Adjust]: Adid: ' + sessionSuccessData.adid); - } - if (sessionSuccessData.jsonResponse != null) { - print('[Adjust]: JSON response: ' + sessionSuccessData.jsonResponse); - } -}; - -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustConfig/urlStrategy.mdx b/src/code-snippets/flutter/examples/AdjustConfig/urlStrategy.mdx deleted file mode 100644 index 65e33fb38..000000000 --- a/src/code-snippets/flutter/examples/AdjustConfig/urlStrategy.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); -//... -adjustConfig.urlStrategy = AdjustConfig.DataResidencyEU; -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/flutter/examples/AdjustEvent/addCallbackParameter.mdx b/src/code-snippets/flutter/examples/AdjustEvent/addCallbackParameter.mdx deleted file mode 100644 index af8b90749..000000000 --- a/src/code-snippets/flutter/examples/AdjustEvent/addCallbackParameter.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustEvent myAdjustEvent = new AdjustEvent('abc123'); -//... -adjustEvent.addCallbackParameter('key', 'value'); -//... -Adjust.trackEvent(myAdjustEvent); -``` diff --git a/src/code-snippets/flutter/examples/AdjustEvent/addPartnerParameter.mdx b/src/code-snippets/flutter/examples/AdjustEvent/addPartnerParameter.mdx deleted file mode 100644 index cf57615b2..000000000 --- a/src/code-snippets/flutter/examples/AdjustEvent/addPartnerParameter.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustEvent myAdjustEvent = new AdjustEvent('abc123'); -//... -adjustEvent.addPartnerParameter('key', 'value'); -//... -Adjust.trackEvent(myAdjustEvent); -``` diff --git a/src/code-snippets/flutter/examples/AdjustEvent/callbackId.mdx b/src/code-snippets/flutter/examples/AdjustEvent/callbackId.mdx deleted file mode 100644 index fba20c860..000000000 --- a/src/code-snippets/flutter/examples/AdjustEvent/callbackId.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustEvent myAdjustEvent = new AdjustEvent('abc123'); -//... -myAdjustEvent.callbackId = '{your_callback_id}'; -//... -Adjust.trackEvent(myAdjustEvent); -``` diff --git a/src/code-snippets/flutter/examples/AdjustEvent/constructor.mdx b/src/code-snippets/flutter/examples/AdjustEvent/constructor.mdx deleted file mode 100644 index 515f2138a..000000000 --- a/src/code-snippets/flutter/examples/AdjustEvent/constructor.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```dart {1} -AdjustEvent myAdjustEvent = new AdjustEvent('abc123'); -//... -Adjust.trackEvent(myAdjustEvent); -``` diff --git a/src/code-snippets/flutter/examples/AdjustEvent/setRevenue.mdx b/src/code-snippets/flutter/examples/AdjustEvent/setRevenue.mdx deleted file mode 100644 index ad6b5dbb4..000000000 --- a/src/code-snippets/flutter/examples/AdjustEvent/setRevenue.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustEvent myAdjustEvent = new AdjustEvent('abc123'); -//... -adjustEvent.setRevenue(0.01, 'EUR'); -//... -Adjust.trackEvent(myAdjustEvent); -``` diff --git a/src/code-snippets/flutter/examples/AdjustEvent/transactionId.mdx b/src/code-snippets/flutter/examples/AdjustEvent/transactionId.mdx deleted file mode 100644 index b247c0ae3..000000000 --- a/src/code-snippets/flutter/examples/AdjustEvent/transactionId.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustEvent myAdjustEvent = new AdjustEvent('abc123'); -//... -myAdjustEvent.transactionId = '{TransactionId}'; -//... -Adjust.trackEvent(myAdjustEvent); -``` diff --git a/src/code-snippets/flutter/examples/AdjustPlayStoreSubscription/addCallbackParameter.mdx b/src/code-snippets/flutter/examples/AdjustPlayStoreSubscription/addCallbackParameter.mdx deleted file mode 100644 index 9bc156f88..000000000 --- a/src/code-snippets/flutter/examples/AdjustPlayStoreSubscription/addCallbackParameter.mdx +++ /dev/null @@ -1,12 +0,0 @@ -```dart {9-10} -AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken); -//... -subscription.addCallbackParameter('key1', 'value1'); -subscription.addCallbackParameter('key2', 'value2'); -``` diff --git a/src/code-snippets/flutter/examples/AdjustPlayStoreSubscription/addPartnerParameter.mdx b/src/code-snippets/flutter/examples/AdjustPlayStoreSubscription/addPartnerParameter.mdx deleted file mode 100644 index 2d6c62fba..000000000 --- a/src/code-snippets/flutter/examples/AdjustPlayStoreSubscription/addPartnerParameter.mdx +++ /dev/null @@ -1,12 +0,0 @@ -```dart {9-10} -AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken); -//... -subscription.addPartnerParameter('key1', 'value1'); -subscription.addPartnerParameter('key2', 'value2'); -``` diff --git a/src/code-snippets/flutter/examples/AdjustPlayStoreSubscription/constructor.mdx b/src/code-snippets/flutter/examples/AdjustPlayStoreSubscription/constructor.mdx deleted file mode 100644 index 183d5a9dc..000000000 --- a/src/code-snippets/flutter/examples/AdjustPlayStoreSubscription/constructor.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```dart -AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken); -``` diff --git a/src/code-snippets/flutter/examples/AdjustPlayStoreSubscription/setPurchaseTime.mdx b/src/code-snippets/flutter/examples/AdjustPlayStoreSubscription/setPurchaseTime.mdx deleted file mode 100644 index 166fbff9e..000000000 --- a/src/code-snippets/flutter/examples/AdjustPlayStoreSubscription/setPurchaseTime.mdx +++ /dev/null @@ -1,10 +0,0 @@ -```dart {8} -AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken); -subscription.setPurchaseTime(purchaseTime); -``` diff --git a/src/code-snippets/flutter/examples/AdjustThirdPartySharing/addGranularOption.mdx b/src/code-snippets/flutter/examples/AdjustThirdPartySharing/addGranularOption.mdx deleted file mode 100644 index ac20dd78d..000000000 --- a/src/code-snippets/flutter/examples/AdjustThirdPartySharing/addGranularOption.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(null); -//... -adjustThirdPartySharing.addGranularOption("PartnerA", "key", "value"); -//... -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` diff --git a/src/code-snippets/flutter/examples/AdjustThirdPartySharing/addGranularOptionFacebook.mdx b/src/code-snippets/flutter/examples/AdjustThirdPartySharing/addGranularOptionFacebook.mdx deleted file mode 100644 index efe14b183..000000000 --- a/src/code-snippets/flutter/examples/AdjustThirdPartySharing/addGranularOptionFacebook.mdx +++ /dev/null @@ -1,8 +0,0 @@ -```dart {3,4} -AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(null); -//... -adjustThirdPartySharing.addGranularOption("facebook", "data_processing_options_country", "1"); -adjustThirdPartySharing.addGranularOption("facebook", "data_processing_options_state", "1000"); -//... -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` diff --git a/src/code-snippets/flutter/examples/AdjustThirdPartySharing/addPartnerSharingSetting.mdx b/src/code-snippets/flutter/examples/AdjustThirdPartySharing/addPartnerSharingSetting.mdx deleted file mode 100644 index 2d08b68df..000000000 --- a/src/code-snippets/flutter/examples/AdjustThirdPartySharing/addPartnerSharingSetting.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```dart {3} -AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(null); -//... -adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "foo", false); -//... -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` diff --git a/src/code-snippets/flutter/examples/AdjustThirdPartySharing/constructor_false.mdx b/src/code-snippets/flutter/examples/AdjustThirdPartySharing/constructor_false.mdx deleted file mode 100644 index 9ad30870a..000000000 --- a/src/code-snippets/flutter/examples/AdjustThirdPartySharing/constructor_false.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```dart "false" -AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(false); -//... -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` diff --git a/src/code-snippets/flutter/examples/AdjustThirdPartySharing/constructor_true.mdx b/src/code-snippets/flutter/examples/AdjustThirdPartySharing/constructor_true.mdx deleted file mode 100644 index 23de291a0..000000000 --- a/src/code-snippets/flutter/examples/AdjustThirdPartySharing/constructor_true.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```dart "true" -AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true); -//... -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/addSessionCallbackParameter.mdx b/src/code-snippets/flutter/signatures/Adjust/addSessionCallbackParameter.mdx deleted file mode 100644 index 922c99400..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/addSessionCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static void addSessionCallbackParameter(String key, String value) -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/addSessionPartnerParameter.mdx b/src/code-snippets/flutter/signatures/Adjust/addSessionPartnerParameter.mdx deleted file mode 100644 index fef9256a1..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/addSessionPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static void addSessionPartnerParameter(String key, String value) -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/checkForNewAttStatus.mdx b/src/code-snippets/flutter/signatures/Adjust/checkForNewAttStatus.mdx deleted file mode 100644 index 6006900f1..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/checkForNewAttStatus.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static void checkForNewAttStatus() -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/disableThirdPartySharing.mdx b/src/code-snippets/flutter/signatures/Adjust/disableThirdPartySharing.mdx deleted file mode 100644 index 91bc605ea..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/disableThirdPartySharing.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static void disableThirdPartySharing() -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/gdprForgetMe.mdx b/src/code-snippets/flutter/signatures/Adjust/gdprForgetMe.mdx deleted file mode 100644 index 8fd5d6d31..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/gdprForgetMe.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static void gdprForgetMe() -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/getAdid.mdx b/src/code-snippets/flutter/signatures/Adjust/getAdid.mdx deleted file mode 100644 index 996a25629..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/getAdid.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static Future getAdid() async -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/getAmazonAdId.mdx b/src/code-snippets/flutter/signatures/Adjust/getAmazonAdId.mdx deleted file mode 100644 index 5a9da3539..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/getAmazonAdId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static Future getAmazonAdId() async -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/getAppTrackingAuthorizationStatus.mdx b/src/code-snippets/flutter/signatures/Adjust/getAppTrackingAuthorizationStatus.mdx deleted file mode 100644 index 91272911e..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/getAppTrackingAuthorizationStatus.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static Future getAppTrackingAuthorizationStatus() async -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/getAttribution.mdx b/src/code-snippets/flutter/signatures/Adjust/getAttribution.mdx deleted file mode 100644 index a001c0148..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/getAttribution.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static Future getAttribution() async -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/getGoogleAdId.mdx b/src/code-snippets/flutter/signatures/Adjust/getGoogleAdId.mdx deleted file mode 100644 index 268b7bd8b..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/getGoogleAdId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static Future getGoogleAdId() async -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/getIdfa.mdx b/src/code-snippets/flutter/signatures/Adjust/getIdfa.mdx deleted file mode 100644 index 9ec63c6ab..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/getIdfa.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static Future getIdfa() async -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/isEnabled.mdx b/src/code-snippets/flutter/signatures/Adjust/isEnabled.mdx deleted file mode 100644 index 1e525e661..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/isEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static Future isEnabled() async -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/removeSessionCallbackParameter.mdx b/src/code-snippets/flutter/signatures/Adjust/removeSessionCallbackParameter.mdx deleted file mode 100644 index 9ad9c8509..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/removeSessionCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static void removeSessionCallbackParameter(String key) -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/removeSessionPartnerParameter.mdx b/src/code-snippets/flutter/signatures/Adjust/removeSessionPartnerParameter.mdx deleted file mode 100644 index 415a4ce1e..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/removeSessionPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static void removeSessionPartnerParameter(String key) -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/requestTrackingAuthorizationWithCompletionHandler.mdx b/src/code-snippets/flutter/signatures/Adjust/requestTrackingAuthorizationWithCompletionHandler.mdx deleted file mode 100644 index cff2b5b1c..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/requestTrackingAuthorizationWithCompletionHandler.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static Future requestTrackingAuthorizationWithCompletionHandler() async -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/resetSessionCallbackParameters.mdx b/src/code-snippets/flutter/signatures/Adjust/resetSessionCallbackParameters.mdx deleted file mode 100644 index 936d9e8c1..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/resetSessionCallbackParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static void resetSessionCallbackParameters() -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/resetSessionPartnerParameters.mdx b/src/code-snippets/flutter/signatures/Adjust/resetSessionPartnerParameters.mdx deleted file mode 100644 index 5a8cfa730..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/resetSessionPartnerParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static void resetSessionPartnerParameters() -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/sendFirstPackages.mdx b/src/code-snippets/flutter/signatures/Adjust/sendFirstPackages.mdx deleted file mode 100644 index 46473a082..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/sendFirstPackages.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static void sendFirstPackages() -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/setEnabled.mdx b/src/code-snippets/flutter/signatures/Adjust/setEnabled.mdx deleted file mode 100644 index e4d556ec9..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/setEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static void setEnabled(bool isEnabled) -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/setOfflineMode.mdx b/src/code-snippets/flutter/signatures/Adjust/setOfflineMode.mdx deleted file mode 100644 index 3ffc7c4a1..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/setOfflineMode.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static void setOfflineMode(bool isOffline) -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/setPushToken.mdx b/src/code-snippets/flutter/signatures/Adjust/setPushToken.mdx deleted file mode 100644 index 6303f7dc6..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/setPushToken.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static void setPushToken(String token) -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/trackAdRevenue.mdx b/src/code-snippets/flutter/signatures/Adjust/trackAdRevenue.mdx deleted file mode 100644 index 5fb804d09..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/trackAdRevenue.mdx +++ /dev/null @@ -1,6 +0,0 @@ -```dart -static void trackAdRevenue(String source, String payload) { - _channel - .invokeMethod('trackAdRevenue', {'source': source, 'payload': payload}); -} -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/trackAppStoreSubscription.mdx b/src/code-snippets/flutter/signatures/Adjust/trackAppStoreSubscription.mdx deleted file mode 100644 index 57a740f53..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/trackAppStoreSubscription.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static void trackAppStoreSubscription(AdjustAppStoreSubscription subscription) -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/trackEvent.mdx b/src/code-snippets/flutter/signatures/Adjust/trackEvent.mdx deleted file mode 100644 index 772ab6efc..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/trackEvent.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static void trackEvent(AdjustEvent event) -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/trackMeasurementConsent.mdx b/src/code-snippets/flutter/signatures/Adjust/trackMeasurementConsent.mdx deleted file mode 100644 index e2fb5dbe7..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/trackMeasurementConsent.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static void trackMeasurementConsent(bool measurementConsent) -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/trackPlayStoreSubscription.mdx b/src/code-snippets/flutter/signatures/Adjust/trackPlayStoreSubscription.mdx deleted file mode 100644 index 7742d69bf..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/trackPlayStoreSubscription.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static void trackPlayStoreSubscription(AdjustPlayStoreSubscription subscription) -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/trackThirdPartySharing.mdx b/src/code-snippets/flutter/signatures/Adjust/trackThirdPartySharing.mdx deleted file mode 100644 index 063cd402c..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/trackThirdPartySharing.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static void trackThirdPartySharing(AdjustThirdPartySharing thirdPartySharing) -``` diff --git a/src/code-snippets/flutter/signatures/Adjust/updateConversionValue.mdx b/src/code-snippets/flutter/signatures/Adjust/updateConversionValue.mdx deleted file mode 100644 index 13aba8846..000000000 --- a/src/code-snippets/flutter/signatures/Adjust/updateConversionValue.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -static void updateConversionValue(int conversionValue) -``` diff --git a/src/code-snippets/flutter/signatures/AdjustAdRevenue/adImpressionsCount.mdx b/src/code-snippets/flutter/signatures/AdjustAdRevenue/adImpressionsCount.mdx deleted file mode 100644 index 09280074d..000000000 --- a/src/code-snippets/flutter/signatures/AdjustAdRevenue/adImpressionsCount.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -num? adImpressionsCount; -``` diff --git a/src/code-snippets/flutter/signatures/AdjustAdRevenue/adRevenueNetwork.mdx b/src/code-snippets/flutter/signatures/AdjustAdRevenue/adRevenueNetwork.mdx deleted file mode 100644 index 66a0df14f..000000000 --- a/src/code-snippets/flutter/signatures/AdjustAdRevenue/adRevenueNetwork.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -String? adRevenueNetwork; -``` diff --git a/src/code-snippets/flutter/signatures/AdjustAdRevenue/adRevenuePlacement.mdx b/src/code-snippets/flutter/signatures/AdjustAdRevenue/adRevenuePlacement.mdx deleted file mode 100644 index 83d603ccf..000000000 --- a/src/code-snippets/flutter/signatures/AdjustAdRevenue/adRevenuePlacement.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -String? adRevenuePlacement; -``` diff --git a/src/code-snippets/flutter/signatures/AdjustAdRevenue/adRevenueUnit.mdx b/src/code-snippets/flutter/signatures/AdjustAdRevenue/adRevenueUnit.mdx deleted file mode 100644 index da8ff99d7..000000000 --- a/src/code-snippets/flutter/signatures/AdjustAdRevenue/adRevenueUnit.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -String? adRevenueUnit; -``` diff --git a/src/code-snippets/flutter/signatures/AdjustAdRevenue/addCallbackParameter.mdx b/src/code-snippets/flutter/signatures/AdjustAdRevenue/addCallbackParameter.mdx deleted file mode 100644 index 689a5a025..000000000 --- a/src/code-snippets/flutter/signatures/AdjustAdRevenue/addCallbackParameter.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```dart -void addCallbackParameter(String key, String value) { - _callbackParameters![key] = value; -} -``` diff --git a/src/code-snippets/flutter/signatures/AdjustAdRevenue/addPartnerParameter.mdx b/src/code-snippets/flutter/signatures/AdjustAdRevenue/addPartnerParameter.mdx deleted file mode 100644 index 4004323c2..000000000 --- a/src/code-snippets/flutter/signatures/AdjustAdRevenue/addPartnerParameter.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```dart -void addPartnerParameter(String key, String value) { - _partnerParameters![key] = value; -} -``` diff --git a/src/code-snippets/flutter/signatures/AdjustAdRevenue/constructor.mdx b/src/code-snippets/flutter/signatures/AdjustAdRevenue/constructor.mdx deleted file mode 100644 index 50a81af9d..000000000 --- a/src/code-snippets/flutter/signatures/AdjustAdRevenue/constructor.mdx +++ /dev/null @@ -1,6 +0,0 @@ -```dart -AdjustAdRevenue(this._source) { - _callbackParameters = new Map(); - _partnerParameters = new Map(); -} -``` diff --git a/src/code-snippets/flutter/signatures/AdjustAdRevenue/setRevenue.mdx b/src/code-snippets/flutter/signatures/AdjustAdRevenue/setRevenue.mdx deleted file mode 100644 index e425a3fda..000000000 --- a/src/code-snippets/flutter/signatures/AdjustAdRevenue/setRevenue.mdx +++ /dev/null @@ -1,6 +0,0 @@ -```dart -void setRevenue(num revenue, String currency) { - _revenue = revenue; - _currency = currency; -} -``` diff --git a/src/code-snippets/flutter/signatures/AdjustAppStoreSubscription/addCallbackParameter.mdx b/src/code-snippets/flutter/signatures/AdjustAppStoreSubscription/addCallbackParameter.mdx deleted file mode 100644 index d77a50331..000000000 --- a/src/code-snippets/flutter/signatures/AdjustAppStoreSubscription/addCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -void addCallbackParameter(String key, String value) -``` diff --git a/src/code-snippets/flutter/signatures/AdjustAppStoreSubscription/addPartnerParameter.mdx b/src/code-snippets/flutter/signatures/AdjustAppStoreSubscription/addPartnerParameter.mdx deleted file mode 100644 index 7c373a5a5..000000000 --- a/src/code-snippets/flutter/signatures/AdjustAppStoreSubscription/addPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -void addPartnerParameter(String key, String value) -``` diff --git a/src/code-snippets/flutter/signatures/AdjustAppStoreSubscription/constructor.mdx b/src/code-snippets/flutter/signatures/AdjustAppStoreSubscription/constructor.mdx deleted file mode 100644 index 1598b70bc..000000000 --- a/src/code-snippets/flutter/signatures/AdjustAppStoreSubscription/constructor.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -AdjustAppStoreSubscription(String _price, String _currency, String _transactionId, String _receipt) -``` diff --git a/src/code-snippets/flutter/signatures/AdjustAppStoreSubscription/setSalesRegion.mdx b/src/code-snippets/flutter/signatures/AdjustAppStoreSubscription/setSalesRegion.mdx deleted file mode 100644 index bd73bcc46..000000000 --- a/src/code-snippets/flutter/signatures/AdjustAppStoreSubscription/setSalesRegion.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -void setSalesRegion(String _salesRegion) -``` diff --git a/src/code-snippets/flutter/signatures/AdjustAppStoreSubscription/setTransactionDate.mdx b/src/code-snippets/flutter/signatures/AdjustAppStoreSubscription/setTransactionDate.mdx deleted file mode 100644 index 46839c081..000000000 --- a/src/code-snippets/flutter/signatures/AdjustAppStoreSubscription/setTransactionDate.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -void setTransactionDate(String _transactionDate) -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/attributionCallback.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/attributionCallback.mdx deleted file mode 100644 index 3640a545d..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/attributionCallback.mdx +++ /dev/null @@ -1,4 +0,0 @@ -```dart -typedef void AttributionCallback(AdjustAttribution attributionData); -AttributionCallback? attributionCallback; -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/constructor.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/constructor.mdx deleted file mode 100644 index 42872d6a5..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/constructor.mdx +++ /dev/null @@ -1,6 +0,0 @@ -```dart -AdjustConfig(this._appToken, this._environment) { - _initCallbackHandlers(); - _skAdNetworkHandling = true; -} -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/conversionValueUpdatedCallback.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/conversionValueUpdatedCallback.mdx deleted file mode 100644 index 66a405664..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/conversionValueUpdatedCallback.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -typedef void ConversionValueUpdatedCallback(num? conversionValue); -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/coppaCompliantEnabled.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/coppaCompliantEnabled.mdx deleted file mode 100644 index 19dfed0f9..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/coppaCompliantEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -bool? coppaCompliantEnabled -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/deactivateSKAdNetworkHandling.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/deactivateSKAdNetworkHandling.mdx deleted file mode 100644 index 533ac0e97..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/deactivateSKAdNetworkHandling.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -void deactivateSKAdNetworkHandling() -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/defaultTracker.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/defaultTracker.mdx deleted file mode 100644 index b0cc892bd..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/defaultTracker.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -String? defaultTracker; -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/deferredDeeplinkCallback.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/deferredDeeplinkCallback.mdx deleted file mode 100644 index c1aa7ad0f..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/deferredDeeplinkCallback.mdx +++ /dev/null @@ -1,4 +0,0 @@ -```dart -typedef void DeferredDeeplinkCallback(String? uri); -DeferredDeeplinkCallback? deferredDeeplinkCallback; -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/delayStart.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/delayStart.mdx deleted file mode 100644 index d163f5d28..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/delayStart.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -double? delayStart; -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/eventBufferingEnabled.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/eventBufferingEnabled.mdx deleted file mode 100644 index 61f3117c2..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/eventBufferingEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -bool? eventBufferingEnabled; -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/eventFailureCallback.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/eventFailureCallback.mdx deleted file mode 100644 index 31c16db17..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/eventFailureCallback.mdx +++ /dev/null @@ -1,4 +0,0 @@ -```dart -typedef void EventFailureCallback(AdjustEventFailure failureData); -EventFailureCallback? eventFailureCallback; -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/eventSuccessCallback.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/eventSuccessCallback.mdx deleted file mode 100644 index 5d9e39192..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/eventSuccessCallback.mdx +++ /dev/null @@ -1,4 +0,0 @@ -```dart -typedef void EventSuccessCallback(AdjustEventSuccess successData); -EventSuccessCallback? eventSuccessCallback; -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/externalDeviceId.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/externalDeviceId.mdx deleted file mode 100644 index ad32bdc0f..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/externalDeviceId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -String? externalDeviceId; -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/launchDeferredDeeplink.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/launchDeferredDeeplink.mdx deleted file mode 100644 index e8a5e3991..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/launchDeferredDeeplink.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -bool? launchDeferredDeeplink; -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/linkMeEnabled.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/linkMeEnabled.mdx deleted file mode 100644 index 752c3d804..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/linkMeEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -bool? linkMeEnabled -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/logLevel.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/logLevel.mdx deleted file mode 100644 index 8b3923ae9..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/logLevel.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -AdjustLogLevel? logLevel; -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/needsCost.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/needsCost.mdx deleted file mode 100644 index da2b31e52..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/needsCost.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -bool? needsCost; -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/playStoreKidsAppEnabled.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/playStoreKidsAppEnabled.mdx deleted file mode 100644 index 5069ddc2c..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/playStoreKidsAppEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -bool? playStoreKidsAppEnabled -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/preinstallTrackingEnabled.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/preinstallTrackingEnabled.mdx deleted file mode 100644 index 1ac0d62cc..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/preinstallTrackingEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -bool? preinstallTrackingEnabled -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/sendInBackground.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/sendInBackground.mdx deleted file mode 100644 index 40fac1737..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/sendInBackground.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -bool? sendInBackground; -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/sessionFailureCallback.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/sessionFailureCallback.mdx deleted file mode 100644 index 4fd9697ba..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/sessionFailureCallback.mdx +++ /dev/null @@ -1,4 +0,0 @@ -```dart -typedef void SessionFailureCallback(AdjustSessionFailure failureData); -SessionFailureCallback? sessionFailureCallback; -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/sessionSuccessCallback.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/sessionSuccessCallback.mdx deleted file mode 100644 index aa98a6c15..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/sessionSuccessCallback.mdx +++ /dev/null @@ -1,4 +0,0 @@ -```dart -typedef void SessionSuccessCallback(AdjustSessionSuccess successData); -SessionSuccessCallback? sessionSuccessCallback; -``` diff --git a/src/code-snippets/flutter/signatures/AdjustConfig/urlStrategy.mdx b/src/code-snippets/flutter/signatures/AdjustConfig/urlStrategy.mdx deleted file mode 100644 index ba48a01ac..000000000 --- a/src/code-snippets/flutter/signatures/AdjustConfig/urlStrategy.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -String? urlStrategy; -``` diff --git a/src/code-snippets/flutter/signatures/AdjustEvent/addCallbackParameter.mdx b/src/code-snippets/flutter/signatures/AdjustEvent/addCallbackParameter.mdx deleted file mode 100644 index d77a50331..000000000 --- a/src/code-snippets/flutter/signatures/AdjustEvent/addCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -void addCallbackParameter(String key, String value) -``` diff --git a/src/code-snippets/flutter/signatures/AdjustEvent/addPartnerParameter.mdx b/src/code-snippets/flutter/signatures/AdjustEvent/addPartnerParameter.mdx deleted file mode 100644 index 9d590e572..000000000 --- a/src/code-snippets/flutter/signatures/AdjustEvent/addPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -void addPartnerParameter(String key, String value) -``` diff --git a/src/code-snippets/flutter/signatures/AdjustEvent/callbackId.mdx b/src/code-snippets/flutter/signatures/AdjustEvent/callbackId.mdx deleted file mode 100644 index e0f10b4d5..000000000 --- a/src/code-snippets/flutter/signatures/AdjustEvent/callbackId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -String? callbackId; -``` diff --git a/src/code-snippets/flutter/signatures/AdjustEvent/constructor.mdx b/src/code-snippets/flutter/signatures/AdjustEvent/constructor.mdx deleted file mode 100644 index 2208955b2..000000000 --- a/src/code-snippets/flutter/signatures/AdjustEvent/constructor.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -AdjustEvent(string eventToken) -``` diff --git a/src/code-snippets/flutter/signatures/AdjustEvent/setRevenue.mdx b/src/code-snippets/flutter/signatures/AdjustEvent/setRevenue.mdx deleted file mode 100644 index dd7dc6b50..000000000 --- a/src/code-snippets/flutter/signatures/AdjustEvent/setRevenue.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -void setRevenue(Num revenue, String currency) -``` diff --git a/src/code-snippets/flutter/signatures/AdjustEvent/transactionId.mdx b/src/code-snippets/flutter/signatures/AdjustEvent/transactionId.mdx deleted file mode 100644 index 6258b618d..000000000 --- a/src/code-snippets/flutter/signatures/AdjustEvent/transactionId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -String? transactionId; -``` diff --git a/src/code-snippets/flutter/signatures/AdjustPlayStoreSubscription/addCallbackParameter.mdx b/src/code-snippets/flutter/signatures/AdjustPlayStoreSubscription/addCallbackParameter.mdx deleted file mode 100644 index d77a50331..000000000 --- a/src/code-snippets/flutter/signatures/AdjustPlayStoreSubscription/addCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -void addCallbackParameter(String key, String value) -``` diff --git a/src/code-snippets/flutter/signatures/AdjustPlayStoreSubscription/addPartnerParameter.mdx b/src/code-snippets/flutter/signatures/AdjustPlayStoreSubscription/addPartnerParameter.mdx deleted file mode 100644 index 7c373a5a5..000000000 --- a/src/code-snippets/flutter/signatures/AdjustPlayStoreSubscription/addPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -void addPartnerParameter(String key, String value) -``` diff --git a/src/code-snippets/flutter/signatures/AdjustPlayStoreSubscription/constructor.mdx b/src/code-snippets/flutter/signatures/AdjustPlayStoreSubscription/constructor.mdx deleted file mode 100644 index 8c62edd8d..000000000 --- a/src/code-snippets/flutter/signatures/AdjustPlayStoreSubscription/constructor.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -AdjustPlayStoreSubscription(String _price, String _currency, String _sku, String _orderId, String _signature, String _purchaseToken) -``` diff --git a/src/code-snippets/flutter/signatures/AdjustPlayStoreSubscription/setPurchaseTime.mdx b/src/code-snippets/flutter/signatures/AdjustPlayStoreSubscription/setPurchaseTime.mdx deleted file mode 100644 index db717d787..000000000 --- a/src/code-snippets/flutter/signatures/AdjustPlayStoreSubscription/setPurchaseTime.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -void setPurchaseTime(String purchaseTime) -``` diff --git a/src/code-snippets/flutter/signatures/AdjustThirdPartySharing/addGranularOption.mdx b/src/code-snippets/flutter/signatures/AdjustThirdPartySharing/addGranularOption.mdx deleted file mode 100644 index a4949e3ee..000000000 --- a/src/code-snippets/flutter/signatures/AdjustThirdPartySharing/addGranularOption.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -void addGranularOption(String partnerName, String key, String value) -``` diff --git a/src/code-snippets/flutter/signatures/AdjustThirdPartySharing/addPartnerSharingSetting.mdx b/src/code-snippets/flutter/signatures/AdjustThirdPartySharing/addPartnerSharingSetting.mdx deleted file mode 100644 index 884e4a095..000000000 --- a/src/code-snippets/flutter/signatures/AdjustThirdPartySharing/addPartnerSharingSetting.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -void addPartnerSharingSetting(String partnerName, String key, bool value) -``` diff --git a/src/code-snippets/flutter/signatures/AdjustThirdPartySharing/constructor.mdx b/src/code-snippets/flutter/signatures/AdjustThirdPartySharing/constructor.mdx deleted file mode 100644 index 705636881..000000000 --- a/src/code-snippets/flutter/signatures/AdjustThirdPartySharing/constructor.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```dart -AdjustThirdPartySharing(bool? _isEnabled) -``` diff --git a/src/content/docs/sdk/android/features/deep-linking.mdx b/src/content/docs/sdk/android/features/deep-linking.mdx index 9c28d9754..ea91086db 100644 --- a/src/content/docs/sdk/android/features/deep-linking.mdx +++ b/src/content/docs/sdk/android/features/deep-linking.mdx @@ -127,7 +127,7 @@ protected void onNewIntent(Intent intent) { ## Deferred deep linking -The Adjust SDK opens deferred deep links by default. No additional setup is required. If you want to disable this behavior, you need to set up a deferred deep link callback using the `setOnDeeplinkResponseListener` method . +The Adjust SDK opens deferred deep links by default. No additional setup is required. If you want to disable this behavior, you need to set up a deferred deep link callback using the `setOnDeeplinkResponseListener` method. ### Set up a deferred deep link callback diff --git a/src/content/docs/sdk/android/features/privacy.mdx b/src/content/docs/sdk/android/features/privacy.mdx index f7ba4e5ea..a0b8b4451 100644 --- a/src/content/docs/sdk/android/features/privacy.mdx +++ b/src/content/docs/sdk/android/features/privacy.mdx @@ -52,12 +52,41 @@ You can use the Adjust SDK to record when a user changes their third-party shari public AdjustThirdPartySharing(final Boolean isEnabled) ``` -To enable or disable third party sharing with the Adjust SDK, you need to instantiate an `AdjustEvent` object. This object contains variables that control how third party sharing is handled by Adjust. +To enable or disable third party sharing with the Adjust SDK, you need to instantiate an `AdjustThirdPartySharing` object. This object contains variables that control how third party sharing is handled by Adjust. To instantiate a third party sharing object, create a new `AdjustThirdPartySharing` instance and pass the following parameters: - `isEnabled` (**Boolean**): Whether third party sharing is enabled. Pass `true` to enable third party sharing or `false` to disable third party sharing + + + +```kotlin {1} +val adjustThirdPartySharing = AdjustThirdPartySharing(true) +Adjust.trackThirdPartySharing(adjustThirdPartySharing) +``` + + + + + +```java {1} +AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true); +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + + + + + +```js {1} +let adjustThirdPartySharing = new AdjustThirdPartySharing(true); +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + + + + If you set the `isEnabled` property to `false`, Adjust stops sharing the user's data with third parties. The Adjust SDK continues to work as expected. @@ -69,7 +98,7 @@ Once you've instantiated your `AdjustThirdPartySharing` object, you can send the -```kotlin +```kotlin {2} val adjustThirdPartySharing = AdjustThirdPartySharing(true) Adjust.trackThirdPartySharing(adjustThirdPartySharing) ``` @@ -78,7 +107,7 @@ Adjust.trackThirdPartySharing(adjustThirdPartySharing) -```java +```java {2} AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true); Adjust.trackThirdPartySharing(adjustThirdPartySharing); ``` @@ -87,7 +116,7 @@ Adjust.trackThirdPartySharing(adjustThirdPartySharing); -```js +```js {2} let adjustThirdPartySharing = new AdjustThirdPartySharing(true); Adjust.trackThirdPartySharing(adjustThirdPartySharing); ``` diff --git a/src/content/docs/sdk/android/features/session-parameters.mdx b/src/content/docs/sdk/android/features/session-parameters.mdx index ebc4859b5..97fb13fe7 100644 --- a/src/content/docs/sdk/android/features/session-parameters.mdx +++ b/src/content/docs/sdk/android/features/session-parameters.mdx @@ -132,6 +132,10 @@ Partner parameters don't appear in raw data by default. You can add the `{partne ### Add session partner parameters +```java title="Method signature" +public static void addSessionPartnerParameter(String key, String 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. diff --git a/src/content/docs/sdk/flutter/configuration.mdx b/src/content/docs/sdk/flutter/configuration.mdx new file mode 100644 index 000000000..8d6ee9549 --- /dev/null +++ b/src/content/docs/sdk/flutter/configuration.mdx @@ -0,0 +1,276 @@ +--- +title: Configuration +description: Follow the guides in this section to configure the Adjust SDK. +slug: en/sdk/flutter/configuration +sidebar-position: 1 +--- + +Use the methods in this document to configure the behavior of the Adjust SDK. + +## Instantiate your config object + +```dart title="Method signature" +AdjustConfig(this._appToken, this._environment) { + _initCallbackHandlers(); + _skAdNetworkHandling = true; +} +``` + +To configure the Adjust SDK, you need to instantiate an `AdjustConfig` 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 `AdjustConfig` instance and pass the following parameters: + +- `appToken` (**String**): Your [Adjust app token](https://help.adjust.com/en/article/app-token-and-reporting-currency#view-your-app-details). +- `environment` (**String**): The environment you want to run the SDK in. Pass `AdjustEnvironment.sandbox` to run the SDK in sandbox mode for testing. Pass `AdjustEnvironment.production` to run the SDK in production mode for release. + +```dart {1} +AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.sandbox); +//... +Adjust.start(adjustConfig); +``` + +## Read-only configuration + +**Read-only** configuration options are set in your `AdjustConfig` 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.start()`. + +### Set your logging level + +```dart title="Property declaration" +AdjustLogLevel? logLevel; +``` + +The Adjust SDK provides configurable log levels to return different amounts of information. The following log levels are available: + + + +| Log level | Description | +| ------------------------- | ------------------------------------------ | +| `AdjustLogLevel.verbose` | Enable all logging | +| `AdjustLogLevel.debug` | Enable debug logging | +| `AdjustLogLevel.info` | Only show info level logs (default option) | +| `AdjustLogLevel.warn` | Disable info logging | +| `AdjustLogLevel.error` | Disable warning level logging and below | +| `AdjustLogLevel.assert` | Disable error level logging and below | +| `AdjustLogLevel.suppress` | Suppress all logging | + +
+ +You can set your log level by assigning an `AdjustLogLevel` value to the `logLevel` property of your config instance. + +- `logLevel` (**AdjustLogLevel**): The log level you want to use. + +```dart {3} +AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); +//... +adjustConfig.logLevel = AdjustLogLevel.verbose; +//... +Adjust.start(adjustConfig); +``` + +### Set external device identifier + +```dart title="Property declaration" +String? 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` (**String**): 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. + + + +```dart {3} +AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); +//... +adjustConfig.externalDeviceId = '{Your-External-Device-Id}'; +//... +Adjust.start(adjustConfig); +``` + +If you want to use the external device ID in your business analytics, you can pass it as a [session callback parameter](/en/sdk/flutter/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 + +```dart title="Property declaration" +String? 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` (**String**): The [Adjust link token](https://help.adjust.com/en/article/links#adjust-link-token) you want to record preinstalled installs against. + +```dart {3} +AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); +//... +adjustConfig.defaultTracker = '{TrackerToken}'; +//... +Adjust.start(adjustConfig); +``` + +### Enable cost data sending + +```dart title="Property declaration" +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` (**Boolean**): 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/flutter/features/attribution). + +```dart {3} +AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); +//... +adjustConfig.needsCost = true; +//... +Adjust.start(adjustConfig); +``` + +### Enable background recording + +```dart title="Property declaration" +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` (**Boolean**): Set to `true` to enable background sending or `false` to disable background sending. + +```dart {3} +AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); +//... +adjustConfig.sendInBackground = true; +//... +Adjust.start(adjustConfig); +``` + +### Enable event buffering + +```dart title="Property declaration" +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` (**Boolean**): Set to `true` to enable event buffering or `false` to disable event buffering. + +```dart {3} +AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); +//... +adjustConfig.eventBufferingEnabled = true; +//... +Adjust.start(adjustConfig); +``` + +### Delay the start of the SDK + +```dart title="Property declaration" +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/flutter/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**. + +```dart {3} +AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); +//... +adjustConfig.delayStart(5.5); +//... +Adjust.start(adjustConfig); +``` + +## 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 + +```dart title="Method signature" +static void setOfflineMode(bool isOffline) +``` + + + +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: + +- `isOffline` (**Boolean**): Set to `true` to enable offline mode or `false` to disable offline mode. + +```dart +Adjust.setOfflineMode(true); +``` + +### Set push tokens + +```dart title="Method signature" +static void setPushToken(String token) +``` + +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 `setPushToken` method and passing the following arguments: + +- `token` (**String**): Your push token. + + + +If you have access to the push token from the web view, you can call the `setPushToken` method in Javascript. + + + +```dart +Adjust.setPushToken('{PushNotificationsToken}'); +``` + +### Disable or enable the SDK + + + +You can only call this method after the first session. This setting persists between sessions. + + + +```dart title="Method signature" +static void setEnabled(bool isEnabled) +``` + +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: + +- `isEnabled` (**Boolean**): Set to `true` to enable the SDK or `false` to disable the SDK. + +```dart +Adjust.setEnabled(false); +``` + +#### Check enabled status + +```dart title="Method signature" +static Future isEnabled() async +``` + +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`). + +```dart +Adjust.isEnabled(); +``` diff --git a/src/content/docs/sdk/flutter/configuration/background.mdx b/src/content/docs/sdk/flutter/configuration/background.mdx deleted file mode 100644 index 3c4a4f0af..000000000 --- a/src/content/docs/sdk/flutter/configuration/background.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Record activity in the background -description: Configure the SDK to send requests in the background. -slug: en/sdk/flutter/configuration/background ---- - -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. - -import SetSendInBackgroundSig from "@flutter-signatures/AdjustConfig/sendInBackground.mdx" - -Your config object contains a boolean `sendInBackground` property that controls this behavior. When set to `true`, the SDK sends data to Adjust while the app is running in the background. - - - -You must set the `sendInBackground` property *before* you initialize the Adjust SDK. - - - -import SetSendInBackground from "@flutter-examples/AdjustConfig/sendInBackground.mdx" - - diff --git a/src/content/docs/sdk/flutter/configuration/delay.mdx b/src/content/docs/sdk/flutter/configuration/delay.mdx deleted file mode 100644 index 4f729604c..000000000 --- a/src/content/docs/sdk/flutter/configuration/delay.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Delay recording -description: Configure the SDK to delay the sending of information to Adjust's servers. -slug: en/sdk/flutter/configuration/delay ---- - - - -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. - -import SetOfflineModeSig from "@flutter-signatures/Adjust/setOfflineMode.mdx" - -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. - -import SetOfflineMode from "@flutter-examples/Adjust/setOfflineMode.mdx" - - - -## 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. - -import EventBufferingEnabledSig from "@flutter-signatures/AdjustConfig/eventBufferingEnabled.mdx" - -Your config object contains a boolean `eventBufferingEnabled` property that controls this behavior. Set this property to `true` to enable event buffering. - -import EventBufferingEnabled from "@flutter-examples/AdjustConfig/eventBufferingEnabled.mdx" - - diff --git a/src/content/docs/sdk/flutter/configuration/disable.mdx b/src/content/docs/sdk/flutter/configuration/disable.mdx deleted file mode 100644 index 277ffed96..000000000 --- a/src/content/docs/sdk/flutter/configuration/disable.mdx +++ /dev/null @@ -1,108 +0,0 @@ ---- -title: Disable the Adjust SDK -description: Disable the Adjust SDK to pause recording. -slug: en/sdk/flutter/configuration/disable ---- - -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. - -import SetEnabledSig from "@flutter-signatures/Adjust/setEnabled.mdx" - -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. - - - -import SetEnabled from "@flutter-examples/Adjust/setEnabled.mdx" - - - -## Check enabled status - -import IsEnabledSig from "@flutter-signatures/Adjust/isEnabled.mdx" - -You can check if the Adjust SDK is enabled at any time by calling the `isEnabled` method. This method returns a boolean value. - -import IsEnabled from "@flutter-examples/Adjust/isEnabled.mdx" - - - -## Example - -This example shows how to generate a button to enable or disable the Adjust SDK. - -```dart title="main.dart" -import 'package:adjust_sdk/adjust.dart'; -import 'package:flutter/cupertino.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter/services.dart'; - -Adjust.start(config); - -@override - Widget build(BuildContext context) { - return new CustomScrollView( - shrinkWrap: true, - slivers: [ - new SliverPadding( - padding: const EdgeInsets.all(20.0), - sliver: new SliverList( - delegate: new SliverChildListDelegate( - [ - const Padding(padding: const EdgeInsets.all(7.0)), - - Util.buildCupertinoButton( - 'Is Enabled ?', () => _showIsSdkEnabled()), - const Padding(padding: const EdgeInsets.all(7.0)), - - // Enable / disable SDK. - new Column( - crossAxisAlignment: CrossAxisAlignment.center, - mainAxisSize: MainAxisSize.max, - mainAxisAlignment: MainAxisAlignment.end, - children: [ - // Is SDK enabled switch. - new Text( - _isSdkEnabled ? 'Enabled' : 'Disabled', - style: _isSdkEnabled - ? new TextStyle(fontSize: 32.0, color: Colors.green) - : new TextStyle(fontSize: 32.0, color: Colors.red), - ), - new CupertinoSwitch( - value: _isSdkEnabled, - onChanged: (bool value) { - setState(() { - Adjust.setEnabled(value); - _isSdkEnabled = value; - print('Switch state = $_isSdkEnabled'); - }); - }, - ), - ], - ), - const Padding(padding: const EdgeInsets.all(7.0)), - - // end - ], - ), - ), - ), - ], - ); - } - - _showIsSdkEnabled() { - try { - Adjust.isEnabled().then((isEnabled) { - _isSdkEnabled = isEnabled; - _showDialogMessage('SDK Enabled?', 'Adjust is enabled = $isEnabled'); - }); - } on PlatformException { - _showDialogMessage( - 'SDK Enabled?', 'No such method found in plugin: isEnabled'); - } - } -``` diff --git a/src/content/docs/sdk/flutter/configuration/external-device-id.mdx b/src/content/docs/sdk/flutter/configuration/external-device-id.mdx deleted file mode 100644 index 723bfb77b..000000000 --- a/src/content/docs/sdk/flutter/configuration/external-device-id.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Set external device identifiers -description: Configure an external device ID as a custom identifier for a device. -slug: en/sdk/flutter/configuration/external-device-id ---- - -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. - - - -import ExternalDeviceIdSig from "@flutter-signatures/AdjustConfig/externalDeviceId.mdx"; - -Your config object contains a **string** `externalDeviceId` property that you can use to store your external device ID. - - - -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. - -import ExternalDeviceId from "@flutter-examples/AdjustConfig/externalDeviceId.mdx"; - - - -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/flutter/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/flutter/configuration/index.mdx b/src/content/docs/sdk/flutter/configuration/index.mdx deleted file mode 100644 index 74f5d89ec..000000000 --- a/src/content/docs/sdk/flutter/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/flutter/configuration -type: category ---- - -Follow the guides in this section to configure the Adjust SDK. diff --git a/src/content/docs/sdk/flutter/configuration/preinstalled.mdx b/src/content/docs/sdk/flutter/configuration/preinstalled.mdx deleted file mode 100644 index ea0ce365e..000000000 --- a/src/content/docs/sdk/flutter/configuration/preinstalled.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Send preinstalled app activity -description: Configure a campaign to send information from preinstalled apps. -slug: en/sdk/flutter/configuration/preinstalled ---- - -import DefaultTracker from "@flutter-examples/AdjustConfig/defaultTracker.mdx" -import DefaultTrackerSig from "@flutter-signatures/AdjustConfig/defaultTracker.mdx" -import PreinstallTrackingEnabled from "@flutter-examples/AdjustConfig/preinstallTrackingEnabled.mdx" -import PreinstallTrackingEnabledSig from "@flutter-signatures/AdjustConfig/preinstallTrackingEnabled.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. - -## Enable preinstall recording - -Your config object contains a **boolean** `preinstallTrackingEnabled` property that controls this feature. Set it to `true` to enable preinstall recording. - - - -## Set a default 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 assign it to the `defaultTracker` property 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/flutter/configuration/push-tokens.mdx b/src/content/docs/sdk/flutter/configuration/push-tokens.mdx deleted file mode 100644 index bc684d3ce..000000000 --- a/src/content/docs/sdk/flutter/configuration/push-tokens.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Set up push tokens -description: Configure push tokens for your app. -slug: en/sdk/flutter/configuration/push-tokens ---- - -import SetPushToken from "@flutter-examples/Adjust/setPushToken.mdx" -import SetPushTokenSig from "@flutter-signatures/Adjust/setPushToken.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 `setPushToken` method and passing your token as an argument. - - - -## Example - -This example shows how to set a new push token with the value _`HrFmrcq96tj723aWFfrw`_ to track your app's retention rates. You can update this value at any time by passing a new token to the `setPushToken` method as an argument: - -```dart -Adjust.setPushToken('HrFmrcq96tj723aWFfrw'); -``` diff --git a/src/content/docs/sdk/flutter/features/ad-revenue.mdx b/src/content/docs/sdk/flutter/features/ad-revenue.mdx index 340169e36..cc15a9986 100644 --- a/src/content/docs/sdk/flutter/features/ad-revenue.mdx +++ b/src/content/docs/sdk/flutter/features/ad-revenue.mdx @@ -4,23 +4,6 @@ description: Record ad revenue information for supported network partners using slug: en/sdk/flutter/features/ad-revenue --- -import TrackAdRevenue from "@flutter-examples/Adjust/trackAdRevenue.mdx"; -import TrackAdRevenueSig from "@flutter-signatures/Adjust/trackAdRevenue.mdx"; -import SetRevenue from "@flutter-examples/AdjustAdRevenue/setRevenue.mdx"; -import SetRevenueSig from "@flutter-signatures/AdjustAdRevenue/setRevenue.mdx"; -import AdImpressionsCount from "@flutter-examples/AdjustAdRevenue/adImpressionsCount.mdx"; -import AdImpressionsCountSig from "@flutter-signatures/AdjustAdRevenue/adImpressionsCount.mdx"; -import AdRevenueNetwork from "@flutter-examples/AdjustAdRevenue/adRevenueNetwork.mdx"; -import AdRevenueNetworkSig from "@flutter-signatures/AdjustAdRevenue/adRevenueNetwork.mdx"; -import AdRevenueUnit from "@flutter-examples/AdjustAdRevenue/adRevenueUnit.mdx"; -import AdRevenueUnitSig from "@flutter-signatures/AdjustAdRevenue/adRevenueUnit.mdx"; -import AdRevenuePlacement from "@flutter-examples/AdjustAdRevenue/adRevenuePlacement.mdx"; -import AdRevenuePlacementSig from "@flutter-signatures/AdjustAdRevenue/adRevenuePlacement.mdx"; -import AddCallbackParameter from "@flutter-examples/AdjustAdRevenue/addCallbackParameter.mdx"; -import AddCallbackParameterSig from "@flutter-signatures/AdjustAdRevenue/addCallbackParameter.mdx"; -import AddPartnerParameter from "@flutter-examples/AdjustAdRevenue/addPartnerParameter.mdx"; -import AddPartnerParameterSig from "@flutter-signatures/AdjustAdRevenue/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,20 @@ You need to perform some extra setup steps in your Adjust dashboard to measure a -To send ad revenue to Adjust: +## Instantiate an AdjustAdRevenue object + +```dart title="Method signature" +AdjustAdRevenue(this._source) { + _callbackParameters = new Map(); + _partnerParameters = new Map(); +} +``` -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 `AdjustAdRevenue` 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 `AdjustAdRevenue` instance and pass the following parameters: -## Sources +- `source` (**String**): The source of the ad revenue. See the table below for available sources @@ -53,15 +42,42 @@ To send ad revenue to Adjust:
-## Record ad revenue amount +```dart +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` + +## Send ad revenue + +```dart title="Method signature" +static void trackAdRevenue(String source, String payload) { + _channel + .invokeMethod('trackAdRevenue', {'source': source, 'payload': payload}); +} +``` + +To send ad revenue to Adjust, call the `trackAdRevenue` method with your ad revenue instance as an argument. + +```dart {3} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` -You can record ad revenue by setting the `revenue` and `currency` properties on your ad revenue instance. +## Record ad revenue amount -To set these properties, call the `setRevenue` method and pass the following arguments: +```dart title="Method signature" +void setRevenue(num revenue, String currency) { + _revenue = revenue; + _currency = 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` (**Number**): The amount of revenue +- `currency` (**String**): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of your reporting currency @@ -69,38 +85,90 @@ Check the [guide to tracking purchases in different currencies](https://help.adj - +```dart {3} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +//... +adjustAdRevenue.setRevenue(1.00, "EUR"); +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` ## Record ad campaign details -The ad revenue object contains properties you can use to report on your ad campaigns. +The `AdjustAdRevenue` 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. +```dart title="Property declaration" +num? adImpressionsCount; +``` + +To send the number of recorded ad impressions, assign a **Number** value to the `adImpressionsCount` property of your ad revenue instance. - +```dart {3} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +//... +adjustAdRevenue.adImpressionsCount = 10; +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` ### Ad revenue network -Record which network generated the revenue by passing a **string** value to the `setAdRevenueNetwork` method. +```dart title="Property declaration" +String? adRevenueNetwork; +``` + +To send the ad revenue network, assign the network name as a **String** value to the `adRevenueNetwork` property of your ad revenue instance. - +```dart {3} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +//... +adjustAdRevenue.adRevenueNetwork = "network1"; +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` ### Ad revenue unit -Record which ad revenue unit generated the revenue by passing a **string** value to the `setAdRevenueUnit` method. +```dart title="Property declaration" +String? adRevenueUnit; +``` + +To send the ad revenue unit, assign the unit as a **String** value to the `adRevenueUnit` property of your ad revenue instance. - +```dart {3} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +//... +adjustAdRevenue.adRevenueUnit = "unit1"; +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` ### Ad revenue placement -Record the placement of your ad by passing a **string** value to the `setAdRevenuePlacement` method. +```dart title="Property declaration" +String? adRevenuePlacement; +``` - +To send the ad revenue placement, assign the placement as a **String** value to the `adRevenuePlacement` property of your ad revenue instance. + +```dart {3} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +//... +adjustAdRevenue.adRevenuePlacement = "banner"; +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` ## Add callback parameters +```dart title="Method signature" +void addCallbackParameter(String key, String value) { + _callbackParameters![key] = 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. @@ -109,7 +177,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 ``` @@ -129,10 +197,22 @@ You can read more about using URL callbacks, including a full list of available - +```dart {3} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +//... +adjustAdRevenue.addCallbackParameter("key", "value") +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` ## Add partner parameters +```dart title="Method signature" +void addPartnerParameter(String key, String value) { + _partnerParameters![key] = 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. @@ -145,7 +225,13 @@ 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. - +```dart {3} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +//... +adjustAdRevenue.addPartnerParameter("key", "value"); +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` ## Example diff --git a/src/content/docs/sdk/flutter/configuration/att.mdx b/src/content/docs/sdk/flutter/features/att.mdx similarity index 79% rename from src/content/docs/sdk/flutter/configuration/att.mdx rename to src/content/docs/sdk/flutter/features/att.mdx index ab73f78a1..abd1e94e2 100644 --- a/src/content/docs/sdk/flutter/configuration/att.mdx +++ b/src/content/docs/sdk/flutter/features/att.mdx @@ -1,10 +1,10 @@ --- title: Set up App Tracking Transparency description: Configure your app to use Apple's App Tracking Transparency framework -slug: en/sdk/flutter/configuration/att +slug: en/sdk/flutter/features/att --- -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 @@ -21,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 +```dart title="Method signature" +static Future requestTrackingAuthorizationWithCompletionHandler() async +``` + 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. @@ -39,9 +43,26 @@ The Adjust SDK also records the consent status if you use a custom prompt. If yo -import RequestTrackingAuthorizationWithCompletionHandler from "@flutter-examples/Adjust/requestTrackingAuthorizationWithCompletionHandler.mdx"; - - +```dart +if (Platform.isIOS) { + Adjust.requestTrackingAuthorizationWithCompletionHandler().then((status) { + switch (status) { + case 0: + // ATTrackingManagerAuthorizationStatusNotDetermined case + break; + case 1: + // ATTrackingManagerAuthorizationStatusRestricted case + break; + case 2: + // ATTrackingManagerAuthorizationStatusDenied case + break; + case 3: + // ATTrackingManagerAuthorizationStatusAuthorized case + break; + } + }); +} +``` ### Example @@ -87,13 +108,15 @@ Adjust.requestTrackingAuthorizationWithCompletionHandler().then((status) { ## Get current authorization status -import GetAppTrackingAuthorizationStatusSig from "@flutter-signatures/Adjust/getAppTrackingAuthorizationStatus.mdx" +```dart title="Method signature" +static Future getAppTrackingAuthorizationStatus() async +``` 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**. -import GetAppTrackingAuthorizationStatus from "@flutter-examples/Adjust/getAppTrackingAuthorizationStatus.mdx" - - +```dart +Adjust.getAppTrackingAuthorizationStatus(); +``` ### Example @@ -106,10 +129,12 @@ Adjust.addSessionPartnerParameter("status", authorizationStatus); ## Check for authorization status changes -import CheckForNewAttStatusSig from "@flutter-signatures/Adjust/checkForNewAttStatus.mdx" +```dart title="Method signature" +static 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. -import CheckForNewAttStatus from "@flutter-examples/Adjust/checkForNewAttStatus.mdx" - - +```dart +Adjust.checkForNewAttStatus(); +``` diff --git a/src/content/docs/sdk/flutter/features/attribution.mdx b/src/content/docs/sdk/flutter/features/attribution.mdx index 7c718964e..844fbbf76 100644 --- a/src/content/docs/sdk/flutter/features/attribution.mdx +++ b/src/content/docs/sdk/flutter/features/attribution.mdx @@ -4,32 +4,97 @@ description: Listen for attribution changes using the Adjust SDK slug: en/sdk/flutter/features/attribution --- -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. +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. -import AttributionCallbackSig from "@flutter-signatures/AdjustConfig/attributionCallback.mdx" +## AdjustAttribution class properties -To configure your callback function, add it to the `attributionCallback` property on your config object. +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 `AdjustConfig` instance](/en/sdk/flutter/configuration#enable-cost-data-sending) is `true`: -You must set your `attributionCallback` **before** initializing the Adjust SDK in your app. +- `costType` +- `costAmount` +- `costCurrency` -import AttributionCallback from "@flutter-examples/AdjustConfig/attributionCallback.mdx" + - +| 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. | +| `fbInstallReferrer` | String | The [Facebook install referrer](https://developers.facebook.com/docs/app-ads/install-referrer/). | -Within your delegate function, you have access to the user's `Attribution` information. See the [`AdjustAttribution` class reference](/en/sdk/flutter/reference/adjustattribution) for a list of available properties. +
-## Get current attribution information +## Trigger a function when attribution changes + +```dart title="Property declaration" +typedef void AttributionCallback(AdjustAttribution attributionData); +AttributionCallback? attributionCallback; +``` + +The SDK can listen for attribution changes and call a function when it detects an update. To configure your callback function, assign your function to the `attributionCallback` property on your config instance. + + + +You must call the `attributionCallback` method **before** initializing the Adjust SDK in your app. + + + +```dart {2-29} +AdjustConfig adjustConfig = new AdjustConfig(yourAppToken, environment); +config.attributionCallback = (AdjustAttribution attributionChangedData) { + print('[Adjust]: Attribution changed!'); -import GetAttributionSig from "@flutter-signatures/Adjust/getAttribution.mdx"; + if (attributionChangedData.trackerToken != null) { + print('[Adjust]: Tracker token: ' + attributionChangedData.trackerToken); + } + if (attributionChangedData.trackerName != null) { + print('[Adjust]: Tracker name: ' + attributionChangedData.trackerName); + } + if (attributionChangedData.campaign != null) { + print('[Adjust]: Campaign: ' + attributionChangedData.campaign); + } + if (attributionChangedData.network != null) { + print('[Adjust]: Network: ' + attributionChangedData.network); + } + if (attributionChangedData.creative != null) { + print('[Adjust]: Creative: ' + attributionChangedData.creative); + } + if (attributionChangedData.adgroup != null) { + print('[Adjust]: Adgroup: ' + attributionChangedData.adgroup); + } + if (attributionChangedData.clickLabel != null) { + print('[Adjust]: Click label: ' + attributionChangedData.clickLabel); + } + if (attributionChangedData.adid != null) { + print('[Adjust]: Adid: ' + attributionChangedData.adid); + } +}; +Adjust.start(adjustConfig); +``` -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 `getAttribution` method. +## Get current attribution information -This method returns an Attribution object. See the [`AdjustAttribution` class reference](/en/sdk/flutter/reference/adjustattribution) for a list of available properties. +```dart title="Method signature" +static Future getAttribution() async +``` -import GetAttribution from "@flutter-examples/Adjust/getAttribution.mdx"; +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 `getAttribution` method to return the attribution information as an `AdjustAttribution` object. - +```dart +AdjustAttribution attribution = Adjust.getAttribution(); +``` diff --git a/src/content/docs/sdk/flutter/features/callbacks.mdx b/src/content/docs/sdk/flutter/features/callbacks.mdx index fbb903918..59b4e24a8 100644 --- a/src/content/docs/sdk/flutter/features/callbacks.mdx +++ b/src/content/docs/sdk/flutter/features/callbacks.mdx @@ -32,11 +32,35 @@ Session callbacks have access to a response data object. You can use its propert ### Success callbacks -Set up success callbacks to trigger functions when the SDK records a session. +```dart title="Property declaration" +typedef void SessionSuccessCallback(AdjustSessionSuccess successData); +SessionSuccessCallback? sessionSuccessCallback; +``` -import SessionSuccessCallback from "@flutter-examples/AdjustConfig/sessionSuccessCallback.mdx"; +Set up success callbacks to trigger functions when the SDK records a session. - +```dart +AdjustConfig adjustConfig = new AdjustConfig(yourAppToken, environment); + +config.sessionSuccessCallback = (AdjustSessionSuccess sessionSuccessData) { + print('[Adjust]: Session tracking success!'); + + if (sessionSuccessData.message != null) { + print('[Adjust]: Message: ' + sessionSuccessData.message); + } + if (sessionSuccessData.timestamp != null) { + print('[Adjust]: Timestamp: ' + sessionSuccessData.timestamp); + } + if (sessionSuccessData.adid != null) { + print('[Adjust]: Adid: ' + sessionSuccessData.adid); + } + if (sessionSuccessData.jsonResponse != null) { + print('[Adjust]: JSON response: ' + sessionSuccessData.jsonResponse); + } +}; + +Adjust.start(adjustConfig); +``` #### Example @@ -54,11 +78,38 @@ Adjust.start(myConfig); ### Failure callbacks -Set up failure callbacks to trigger functions when the SDK fails to record a session. +```dart title="Property declaration" +typedef void SessionFailureCallback(AdjustSessionFailure failureData); +SessionFailureCallback? sessionFailureCallback; +``` -import SessionFailureCallback from "@flutter-examples/AdjustConfig/sessionFailureCallback.mdx"; +Set up failure callbacks to trigger functions when the SDK fails to record a session. - +```dart +AdjustConfig adjustConfig = new AdjustConfig(yourAppToken, environment); + +config.sessionFailureCallback = (AdjustSessionFailure sessionFailureData) { + print('[Adjust]: Session tracking failure!'); + + if (sessionFailureData.message != null) { + print('[Adjust]: Message: ' + sessionFailureData.message); + } + if (sessionFailureData.timestamp != null) { + print('[Adjust]: Timestamp: ' + sessionFailureData.timestamp); + } + if (sessionFailureData.adid != null) { + print('[Adjust]: Adid: ' + sessionFailureData.adid); + } + if (sessionFailureData.willRetry != null) { + print('[Adjust]: Will retry: ' + sessionFailureData.willRetry.toString()); + } + if (sessionFailureData.jsonResponse != null) { + print('[Adjust]: JSON response: ' + sessionFailureData.jsonResponse); + } +}; + +Adjust.start(adjustConfig); +``` #### Example @@ -96,11 +147,41 @@ Event callbacks have access to a response data object. You can use its propertie ### Success callbacks -Set up success callbacks to trigger functions when the SDK records an event. +```dart title="Property declaration" +typedef void EventSuccessCallback(AdjustEventSuccess successData); +EventSuccessCallback? eventSuccessCallback; +``` -import EventSuccessCallback from "@flutter-examples/AdjustConfig/eventSuccessCallback.mdx"; +Set up success callbacks to trigger functions when the SDK records an event. - +```dart +AdjustConfig adjustConfig = new AdjustConfig(yourAppToken, environment); + +config.eventSuccessCallback = (AdjustEventSuccess eventSuccessData) { + print('[Adjust]: Event tracking success!'); + + if (eventSuccessData.eventToken != null) { + print('[Adjust]: Event token: ' + eventSuccessData.eventToken); + } + if (eventSuccessData.message != null) { + print('[Adjust]: Message: ' + eventSuccessData.message); + } + if (eventSuccessData.timestamp != null) { + print('[Adjust]: Timestamp: ' + eventSuccessData.timestamp); + } + if (eventSuccessData.adid != null) { + print('[Adjust]: Adid: ' + eventSuccessData.adid); + } + if (eventSuccessData.callbackId != null) { + print('[Adjust]: Callback ID: ' + eventSuccessData.callbackId); + } + if (eventSuccessData.jsonResponse != null) { + print('[Adjust]: JSON response: ' + eventSuccessData.jsonResponse); + } +}; + +Adjust.start(adjustConfig); +``` #### Example @@ -118,11 +199,44 @@ Adjust.start(myConfig); ### Failure callbacks -Set up failure callbacks to trigger functions when the SDK fails to record an event. +```dart title="Property declaration" +typedef void EventFailureCallback(AdjustEventFailure failureData); +EventFailureCallback? eventFailureCallback; +``` -import EventFailureCallback from "@flutter-examples/AdjustConfig/eventFailureCallback.mdx"; +Set up failure callbacks to trigger functions when the SDK fails to record an event. - +```dart +AdjustConfig adjustConfig = new AdjustConfig(yourAppToken, environment); + +config.eventFailureCallback = (AdjustEventFailure eventFailureData) { + print('[Adjust]: Event tracking failure!'); + + if (eventFailureData.eventToken != null) { + print('[Adjust]: Event token: ' + eventFailureData.eventToken); + } + if (eventFailureData.message != null) { + print('[Adjust]: Message: ' + eventFailureData.message); + } + if (eventFailureData.timestamp != null) { + print('[Adjust]: Timestamp: ' + eventFailureData.timestamp); + } + if (eventFailureData.adid != null) { + print('[Adjust]: Adid: ' + eventFailureData.adid); + } + if (eventFailureData.callbackId != null) { + print('[Adjust]: Callback ID: ' + eventFailureData.callbackId); + } + if (eventFailureData.willRetry != null) { + print('[Adjust]: Will retry: ' + eventFailureData.willRetry.toString()); + } + if (eventFailureData.jsonResponse != null) { + print('[Adjust]: JSON response: ' + eventFailureData.jsonResponse); + } +}; + +Adjust.start(adjustConfig); +``` #### Example diff --git a/src/content/docs/sdk/flutter/configuration/deep-links.mdx b/src/content/docs/sdk/flutter/features/deep-links.mdx similarity index 73% rename from src/content/docs/sdk/flutter/configuration/deep-links.mdx rename to src/content/docs/sdk/flutter/features/deep-links.mdx index d8f18128c..12d2dc9e5 100644 --- a/src/content/docs/sdk/flutter/configuration/deep-links.mdx +++ b/src/content/docs/sdk/flutter/features/deep-links.mdx @@ -2,18 +2,15 @@ title: Deep linking description: Follow the guides in this section to set up deep linking. category-title: Deep linking -slug: en/sdk/flutter/configuration/deep-links +slug: en/sdk/flutter/features/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. +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: -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. -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. +The SDK can read deep link data after a user opens your app from a link. ## Set up deep linking @@ -32,11 +29,17 @@ Adjust enables you to run re-engagement campaigns with usage of deep links. For -To reattribute a user, you need to make an extra call to the Adjust SDK within your app. Add a call to the `appWillOpenUrl(Uri, Context)` method when the app receives deep link content. The Adjust SDK will then look for new attribution data within the deep link. If the SDK finds new information, it will forward it to Adjust's servers for reattribution. +Adjust enables you to run re-engagement campaigns with usage of deep links. For more information, see the [guide to appending attribution data to a deep link](https://help.adjust.com/en/article/deeplink-generator#manage-your-deeplinks). + +To reattribute your user, you need to call the `appWillOpenUrl` method when the app receives deep link content. The Adjust SDK then looks for new attribution data within the deep link. If the SDK finds new information, it forwards the information to Adjust's servers for reattribution. +```objc title="Method signature" ++ (void)appWillOpenUrl:(nonnull NSURL *)url; +``` + To enable deep linking for iOS, call the `appWillOpenUrl` method with a `true` value inside your app delegate. @@ -101,6 +104,10 @@ class AppDelegate { +```java title="Method signature" +public static void appWillOpenUrl(Uri url, Context context) +``` + To enable deep linking for Android, call the `appWillOpenUrl` method with a `true` value inside your main activity. @@ -170,25 +177,36 @@ public class MainActivity extends FlutterActivity { ## Deferred deep linking -### Disable deferred deep linking - -import LaunchDeferredDeeplinkSig from "@flutter-signatures/AdjustConfig/launchDeferredDeeplink.mdx" - -The SDK opens deferred deep links by default. You can configure this by setting the `launchDeferredDeeplink` property on your config instance to **true**. +```dart title="Property declaration" +bool? launchDeferredDeeplink; +``` -import LaunchDeferredDeeplink from "@flutter-examples/AdjustConfig/launchDeferredDeeplink.mdx" +The SDK opens deferred deep links by default. No additional setup is required. You can disable this by setting the `launchDeferredDeeplink` property on your config instance to **false**. - +```dart {3} +AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); +//... +adjustConfig.launchDeferredDeeplink = false; +//... +Adjust.start(adjustConfig); +``` ### Set up a deferred deep link callback -import DeferredDeeplinkCallbackSig from "@flutter-signatures/AdjustConfig/deferredDeeplinkCallback.mdx" +```dart title="Property declaration" +typedef void DeferredDeeplinkCallback(String? uri); +DeferredDeeplinkCallback? deferredDeeplinkCallback; +``` You can configure the Adjust SDK to call a function when it receives a deferred deep link by adding a function to the `deferredDeeplinkCallback` property on your config instance. This function receives the deep link as a **string** argument. -import DeferredDeeplinkCallback from "@flutter-examples/AdjustConfig/deferredDeeplinkCallback.mdx" - - +```dart {2-4} +AdjustConfig adjustConfig = new AdjustConfig(yourAppToken, environment); +adjustConfig.deferredDeeplinkCallback = (String uri) { + print('[Adjust]: Received deferred deeplink: ' + uri); +}; +Adjust.start(adjustConfig); +``` ### Example @@ -213,6 +231,10 @@ initPlatformState() async { ### Enable LinkMe +```dart title="Property declaration" +bool? linkMeEnabled +``` + The Adjust SDK lets you copy deep link information from the device pasteboard. When combined with Adjust’s LinkMe solution, this feature enables deferred deep linking on devices running iOS 15 and above. @@ -223,10 +245,12 @@ The Adjust SDK checks the pasteboard when a user opens the app for the first tim When a user clicks on a LinkMe URL they have the option to copy the link information to their system pasteboard. You can use the Adjust SDK to read the system pasteboard for deep link information. If deep link information is present, the SDK forwards the user to the correct page in your app. -import LinkMeEnabledSig from "@flutter-signatures/AdjustConfig/linkMeEnabled.mdx"; - To enable pasteboard checking in your app, set the `linkMeEnabled` property to `true` on your config object: -import LinkMeEnabled from "@flutter-examples/AdjustConfig/linkMeEnabled.mdx"; - - +```dart {3} +AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); +//... +adjustConfig.linkMeEnabled = true; +//... +Adjust.start(adjustConfig); +``` diff --git a/src/content/docs/sdk/flutter/features/device-info.mdx b/src/content/docs/sdk/flutter/features/device-info.mdx index bab79e6c4..cca5e14d7 100644 --- a/src/content/docs/sdk/flutter/features/device-info.mdx +++ b/src/content/docs/sdk/flutter/features/device-info.mdx @@ -8,40 +8,60 @@ The Adjust SDK contains helper methods that return device information. Use these ## Adjust device identifier -import GetAdid from "@flutter-examples/Adjust/getAdid.mdx" -import GetAdidSig from "@flutter-signatures/Adjust/getAdid.mdx" +```dart title="Method signature" +static Future getAdid() async +``` -Adjust generates a unique ADID (Adjust Device ID) for each device. Call the `getAdid` method to return this ID as a **string**. +Adjust generates a unique Adjust Device ID (ADID) for each device. Call the `getAdid` method to return this ID as a **string**. - +```dart +Adjust.getAdid().then((adid) { + // Use adid string value. +}); +``` ## ID For Advertisers -import GetIdfa from "@flutter-examples/Adjust/getIdfa.mdx" -import GetIdfaSig from "@flutter-signatures/Adjust/getIdfa.mdx" +```dart title="Method signature" +static Future getIdfa() async +``` -The IDFA (ID for Advertisers) is a device-specific identifier for Apple devices. Call the `getIdfa` method to return this ID as a **string**. +The ID for Advertisers (IDFA) is a device-specific identifier for Apple devices. Call the `getIdfa` method to return this ID as a **string**. - +```dart +Adjust.getIdfa().then((idfa) { + // Use idfa string value. +}); +``` ## Google Play Services Advertising ID -import GetGoogleAdId from "@flutter-examples/Adjust/getGoogleAdId.mdx" -import GetGoogleAdIdSig from "@flutter-signatures/Adjust/getGoogleAdId.mdx" +```dart title="Method signature" +static Future getGoogleAdId() async +``` -The GPS ADID (Google Play Services Advertising ID) is a device-specific identifier for Android devices. +The Google Play Services Advertising ID (GPS ADID) is a device-specific identifier for Android devices. Users can opt out of sharing their GPS ADID by toggling the "Opt out of Ads Personalization" setting on their device. When a user enables this setting, the Adjust SDK returns a string of zeros when trying to read the GPS ADID. You can access this value by calling the `getGoogleAdId` method in a background thread. Assign a delegate function to access the GPS ADID value. - +```dart +Adjust.getGoogleAdId().then((googleAdId) { + // Use googleAdId string value. +}); +``` ## Amazon Advertiser ID -import GetAmazonAdId from "@flutter-examples/Adjust/getAmazonAdId.mdx" -import GetAmazonAdIdSig from "@flutter-signatures/Adjust/getAmazonAdId.mdx" +```dart title="Method signature" +static Future getAmazonAdId() async +``` -The Amazon Ad ID (Amazon Advertising ID) is a device-specific identifier for Android devices. Call the `getAmazonAdId` method to return this ID as a **string**. +The Amazon Advertising ID (Amazon Ad ID) is a device-specific identifier for Android devices. Call the `getAmazonAdId` method to return this ID as a **string**. - +```dart +Adjust.getAmazonAdId().then((amazonAdId) { + // Use amazonAdId string value. +}); +``` diff --git a/src/content/docs/sdk/flutter/features/events.mdx b/src/content/docs/sdk/flutter/features/events.mdx index c956820de..2c3ad4258 100644 --- a/src/content/docs/sdk/flutter/features/events.mdx +++ b/src/content/docs/sdk/flutter/features/events.mdx @@ -4,25 +4,42 @@ description: Use these methods send event information to Adjust. slug: en/sdk/flutter/features/events --- -import TrackEvent from "@flutter-examples/Adjust/trackEvent.mdx" -import TrackEventSig from "@flutter-signatures/Adjust/trackEvent.mdx" -import SetRevenue from "@flutter-examples/AdjustEvent/setRevenue.mdx" -import SetRevenueSig from "@flutter-signatures/AdjustEvent/setRevenue.mdx" -import TransactionId from "@flutter-examples/AdjustEvent/transactionId.mdx" -import TransactionIdSig from "@flutter-signatures/AdjustEvent/transactionId.mdx" -import CallbackId from "@flutter-examples/AdjustEvent/callbackId.mdx" -import CallbackIdSig from "@flutter-signatures/AdjustEvent/callbackId.mdx" -import AddCallbackParameter from "@flutter-examples/AdjustEvent/addCallbackParameter.mdx" -import AddCallbackParameterSig from "@flutter-signatures/AdjustEvent/addCallbackParameter.mdx" -import AddPartnerParameter from "@flutter-examples/AdjustEvent/addPartnerParameter.mdx" -import AddPartnerParameterSig from "@flutter-signatures/AdjustEvent/addPartnerParameter.mdx" +The Adjust SDK provides an `AdjustEvent` object which can be used to structure and send event information from your app to Adjust's servers. + +## Instantiate an AdjustEvent object + +```dart title="Method signature" +AdjustEvent(string eventToken) +``` + +To send event information with the Adjust SDK, you need to instantiate an `AdjustEvent` 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 `AdjustEvent` instance and pass the following parameters: + +- `eventToken` (**String**): Your Adjust [event token](https://help.adjust.com/en/article/add-events#manage-your-events). + +```dart {1} +AdjustEvent myAdjustEvent = new AdjustEvent('abc123'); +//... +Adjust.trackEvent(myAdjustEvent); +``` + +## Send an event + +```dart title="Method signature" +static void trackEvent(AdjustEvent 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. - +```dart {3} +AdjustEvent myAdjustEvent = new AdjustEvent('abc123'); +//... +Adjust.trackEvent(myAdjustEvent); +``` ### Example @@ -109,13 +126,16 @@ Parameters: ## Record event revenue +```dart title="Method signature" +void setRevenue(Num revenue, String 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. @@ -123,7 +143,13 @@ Check the guide to [tracking purchases in different currencies](https://help.adj - +```dart {3} +AdjustEvent myAdjustEvent = new AdjustEvent('abc123'); +//... +adjustEvent.setRevenue(0.01, 'EUR'); +//... +Adjust.trackEvent(myAdjustEvent); +``` ### Example @@ -174,13 +200,23 @@ Parameters: currency EUR ``` -## Unique events +## Set a unique transaction ID + +```dart title="Property declaration" +String? transactionId; +``` You can pass an optional identifier to avoid recording duplicate events. The SDK stores the last ten identifiers and skips revenue events with duplicate transaction IDs. -To set the identifier, assign your transaction ID to the `setTransactionId` property. +To set the identifier, assign your transaction ID to the `setTransactionId` property of your event instance. - +```dart {3} +AdjustEvent myAdjustEvent = new AdjustEvent('abc123'); +//... +myAdjustEvent.transactionId = '{TransactionId}'; +//... +Adjust.trackEvent(myAdjustEvent); +``` ### Example @@ -233,13 +269,23 @@ Parameters: ## Add callback parameters +```dart title="Method signature" +void addCallbackParameter(String key, String 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. - +```dart {3} +AdjustEvent myAdjustEvent = new AdjustEvent('abc123'); +//... +adjustEvent.addCallbackParameter('key', 'value'); +//... +Adjust.trackEvent(myAdjustEvent); +``` 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: @@ -323,6 +369,10 @@ Parameters: ## Add partner parameters +```dart title="Method signature" +void addPartnerParameter(String key, String 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. @@ -335,7 +385,13 @@ 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. - +```dart {3} +AdjustEvent myAdjustEvent = new AdjustEvent('abc123'); +//... +adjustEvent.addPartnerParameter('key', 'value'); +//... +Adjust.trackEvent(myAdjustEvent); +``` ### Example @@ -391,11 +447,21 @@ Parameters: ## Add a callback identifier +```dart title="Property declaration" +String? 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 assigning your ID to the `callbackId` property. +Set up this identifier by assigning your ID to the `callbackId` property on your event instance. - +```dart {3} +AdjustEvent myAdjustEvent = new AdjustEvent('abc123'); +//... +myAdjustEvent.callbackId = '{your_callback_id}'; +//... +Adjust.trackEvent(myAdjustEvent); +``` ### Example diff --git a/src/content/docs/sdk/flutter/features/index.mdx b/src/content/docs/sdk/flutter/features/index.mdx index 50fcebda9..fda038e2f 100644 --- a/src/content/docs/sdk/flutter/features/index.mdx +++ b/src/content/docs/sdk/flutter/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/flutter/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/flutter/features/preinstalled.mdx b/src/content/docs/sdk/flutter/features/preinstalled.mdx new file mode 100644 index 000000000..df30ed4cd --- /dev/null +++ b/src/content/docs/sdk/flutter/features/preinstalled.mdx @@ -0,0 +1,43 @@ +--- +title: Send preinstalled app activity +description: Configure a campaign to send information from preinstalled apps. +slug: en/sdk/flutter/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. + +Your config object contains a **boolean** `preinstallTrackingEnabled` property that controls this feature. To enable preinstall measurement, assign a **Boolean** value to the `preinstallTrackingEnabled` property of your config object. + +```dart {3} +AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); +//... +adjustConfig.preinstallTrackingEnabled = true; +//... +Adjust.start(adjustConfig); +``` + +## Default link token + +Configuring a default link token enables you to attribute all preinstalls to a predefined Adjust link. Adjust records all information against this token until the attribution source changes. To set this up: + +1. [Create a new campaign link in Campaign Lab](https://help.adjust.com/en/article/links). + + ```text + https://app.adjust.com/{token} + ``` + +2. Copy this token and assign it to the [`defaultTracker` property](/en/sdk/flutter/configuration#set-default-link-token) of your config object. + + ```dart {3} + AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); + //... + adjustConfig.defaultTracker = '{TrackerToken}'; + //... + Adjust.start(adjustConfig); + ``` + +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/flutter/configuration/privacy.mdx b/src/content/docs/sdk/flutter/features/privacy.mdx similarity index 51% rename from src/content/docs/sdk/flutter/configuration/privacy.mdx rename to src/content/docs/sdk/flutter/features/privacy.mdx index 01ac8b03e..114f22682 100644 --- a/src/content/docs/sdk/flutter/configuration/privacy.mdx +++ b/src/content/docs/sdk/flutter/features/privacy.mdx @@ -1,64 +1,74 @@ --- title: Set up privacy features description: Configure features that you can use to handle user privacy in your app. -slug: en/sdk/flutter/configuration/privacy +slug: en/sdk/flutter/features/privacy --- The Adjust SDK contains features that you can use to handle user privacy in your app. -## GDPR right to be forgotten +## Send right to be forgotten request -import GdprForgetMeSig from "@flutter-signatures/Adjust/gdprForgetMe.mdx"; - -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. +```dart title="Method signature" +static void gdprForgetMe() +``` -import GdprForgetMe from "@flutter-examples/Adjust/gdprForgetMe.mdx"; +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. - +```dart +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. - -### Disable third-party sharing - -import TrackThirdPartySharing from "@flutter-signatures/Adjust/trackThirdPartySharing.mdx"; +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. -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. +### Instantiate an AdjustThirdPartySharing object -import ConstructorTrue from "@flutter-examples/AdjustThirdPartySharing/constructor_true.mdx"; - - +```dart title="Method signature" +AdjustThirdPartySharing(bool? _isEnabled) +``` -### Enable third-party sharing +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. -If a user opts into sharing with third-parties, call the [`trackThirdPartySharing` method](#flutter-trackthirdpartysharing-invocation) with an [`AdjustThirdPartySharing` object](/en/sdk/flutter/reference/adjustthirdpartysharing) initialized with a `true` value. This updates the user's preferences. +To instantiate a third party sharing object, create a new `AdjustThirdPartySharing` instance and pass the following parameters: -import ConstructorFalse from "@flutter-examples/AdjustThirdPartySharing/constructor_false.mdx"; +- `isEnabled` (**Boolean**): Whether third party sharing is enabled. Pass `true` to enable third party sharing or `false` to disable third party sharing - +```dart {1} +AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true); +//... +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` -### Send granular information + -import AddGranularOptionSig from "@flutter-signatures/AdjustThirdPartySharing/addGranularOption.mdx"; +If you set the `isEnabled` property to `false`, Adjust stops sharing the user's data with third parties. The Adjust SDK continues to work as expected. -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. + -import AddGranularOption from "@flutter-examples/AdjustThirdPartySharing/addGranularOption.mdx"; +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. - +```dart {3} +AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(false); +//... +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` -### Update partner settings +### Send granular information -import AddPartnerSharingSettingSig from "@flutter-signatures/AdjustThirdPartySharing/addPartnerSharingSetting.mdx"; +```dart title="Method signature" +void addGranularOption(String partnerName, String key, String 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. +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: -import AddPartnerSharingSetting from "@flutter-examples/AdjustThirdPartySharing/addPartnerSharingSetting.mdx"; +- `partnerName` (**String**): The name of the partner for whom the granular option applies. +- `key` (**String**): The option key. +- `value` (**String**): The option value. - +The following partners are available: @@ -77,6 +87,30 @@ import AddPartnerSharingSetting from "@flutter-examples/AdjustThirdPartySharing/
+```dart {3} +AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(null); +//... +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 @@ -85,21 +119,17 @@ The Adjust SDK sends information to Facebook as soon as the app is installed. Yo -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. +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. -import AddGranularOptionFacebook from "@flutter-examples/AdjustThirdPartySharing/addGranularOptionFacebook.mdx"; - - +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.
| +| 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
|
@@ -109,6 +139,15 @@ If you call this method with a `0` value for **either** `data_processing_options +```dart {3,4} +AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(null); +//... +adjustThirdPartySharing.addGranularOption("facebook", "data_processing_options_country", "1"); +adjustThirdPartySharing.addGranularOption("facebook", "data_processing_options_state", "1000"); +//... +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + #### Provide consent data to Google (Digital Markets Act compliance) @@ -143,25 +182,30 @@ Adjust.trackThirdPartySharing(adjustThirdPartySharing); ## Disable third-party sharing -import DisableThirdPartySharingSig from "@flutter-signatures/Adjust/disableThirdPartySharing.mdx"; +```dart title="Method signature" +static 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. -import DisableThirdPartySharing from "@flutter-examples/Adjust/disableThirdPartySharing.mdx"; - - +```dart +Adjust.disableThirdPartySharing(); +``` -## Data residency +## Set URL strategy -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. +```dart title="Property declaration" +String? urlStrategy; +``` -import UrlStrategySig from "@flutter-signatures/AdjustConfig/urlStrategy.mdx"; +The URL strategy feature allows you to set either: -To set your country of data residency, set the `urlStrategy` property on your `AdjustConfig` instance. +- The country in which Adjust stores your data (data residency). +- The endpoint to which the Adjust SDK sends traffic (URL strategy). -import UrlStrategy from "@flutter-examples/AdjustConfig/urlStrategy.mdx"; +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. @@ -176,20 +220,40 @@ import UrlStrategy from "@flutter-examples/AdjustConfig/urlStrategy.mdx";
+```dart {3} +AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); +//... +adjustConfig.urlStrategy = AdjustConfig.DataResidencyEU; +//... +Adjust.start(adjustConfig); +``` + ## Consent measurement for specific users -import TrackMeasurementConsentSig from "@unity-signatures/Adjust/trackMeasurementConsent.mdx"; +```dart title="Method signature" +static void trackMeasurementConsent(bool measurementConsent) +``` -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. +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. -import TrackMeasurementConsent from "@unity-examples/Adjust/trackMeasurementConsent.mdx"; +To toggle this feature, call the `trackMeasurementConsent` method with the following argument: - +- `measurementConsent` (**Boolean**): Whether consent measurement is enabled (`true`) or not (`false`). + +When enabled, the SDK communicates the data privacy settings to Adjust's servers. Adjust's servers then applies your data privacy rules to the user. The Adjust SDK continues to work as expected. + +```dart +Adjust.trackMeasurementConsent(true); +``` ## Privacy for children + + The Adjust SDK includes the `com.google.android.gms.permission.AD_ID` permission by default in version 4.32.0 and above. You can remove it by adding a remove directive if need to make your app COPPA-compliant or if you don't target the Google Play Store. + + ```xml title="AndroidManifest.xml" 'tools:node="remove"' ``` @@ -198,39 +262,45 @@ See Google's [`AdvertisingIdClient.Info documentation`](https://developers.googl ### COPPA compliance -import CoppaCompliantEnabledSig from "@flutter-signatures/AdjustConfig/coppaCompliantEnabled.mdx"; - -If you need your app to be COPPA compliant, call the `coppaCompliantEnabled` method. This method performs the following actions: +```dart title="Property declaration" +bool? coppaCompliantEnabled +``` -1. Disables third-party sharing **before** the user launches their first session. -2. Prevents the SDK from reading device and advertising IDs (For example: `gps_adid` and `android_id`). +If you need your app to be compliant with the Children's Online Privacy Protection Act (COPPA), assign a **Boolean** value to the `coppaCompliantEnabled` property on your config instance. Setting this property to `true`: -import CoppaCompliantEnabled from "@flutter-examples/AdjustConfig/coppaCompliantEnabled.mdx"; +1. Disables third-party sharing **before** the user launches their first `session`. +2. Prevents the SDK from reading device and advertising IDs (for example: `gps_adid` and `android_id`). - +```dart {3} +AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); +//... +adjustConfig.coppaCompliantEnabled = true; +//... +Adjust.start(adjustConfig); +``` -You can disable this method by calling it with a `false` parameter. +You can disable COPPA compliance by calling this method with a `false` argument. -Disabling the `coppaCompliantEnabled` method _doesn't_ re-enable third-party sharing. You need to re-enable third-party sharing for the user. +Disabling COPPA compliance **doesn't** re-enable third-party sharing. You need to [re-enable third-party sharing](#enable-third-party-sharing) for the user. +### Play Store Kids Apps (Android only) + +```dart title="Property declaration" +bool? playStoreKidsAppEnabled +``` + +If your app targets users under the age of 13, and the install region **isn't** the USA, you need to mark it as a Kids App. This prevents the SDK from reading device and advertising IDs (for example: `gps_adid` and `android_id`). + +To mark your app as a Kids App, assign a **Boolean** value to the `playStoreKidsAppEnabled` property on your config instance. Set to `true` to mark the app as a Kids App, or `false` to mark the app as a non-Kids App. + ```dart {3} AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); //... -adjustConfig.coppaCompliantEnabled = false; +adjustConfig.playStoreKidsAppEnabled = true; //... Adjust.start(adjustConfig); ``` - -### Play Store Kids Apps (Android only) - -import PlayStoreKidsAppEnabledSig from "@flutter-signatures/AdjustConfig/playStoreKidsAppEnabled.mdx"; - -If your app targets users under the age of 13, and the install region **isn't** the USA, you need to mark it as a Kids App. This prevents the SDK from reading device and advertising IDs, that's, `gps_adid` and `android_id`. To do this, set the `playStoreKidsAppEnabled` property on your config instance with a `true` parameter. - -import PlayStoreKidsAppEnabled from "@flutter-examples/AdjustConfig/playStoreKidsAppEnabled.mdx"; - - diff --git a/src/content/docs/sdk/flutter/features/session-parameters.mdx b/src/content/docs/sdk/flutter/features/session-parameters.mdx index 9568ccf34..850ad760e 100644 --- a/src/content/docs/sdk/flutter/features/session-parameters.mdx +++ b/src/content/docs/sdk/flutter/features/session-parameters.mdx @@ -4,26 +4,9 @@ description: Send information to your callback URL with each session. slug: en/sdk/flutter/features/session-parameters --- -import AddSessionCallbackParameter from "@flutter-examples/Adjust/addSessionCallbackParameter.mdx" -import AddSessionCallbackParameterSig from "@flutter-signatures/Adjust/addSessionCallbackParameter.mdx" -import RemoveSessionCallbackParameter from "@flutter-examples/Adjust/removeSessionCallbackParameter.mdx" -import RemoveSessionCallbackParameterSig from "@flutter-signatures/Adjust/removeSessionCallbackParameter.mdx" -import ResetSessionCallbackParameters from "@flutter-examples/Adjust/resetSessionCallbackParameters.mdx" -import ResetSessionCallbackParametersSig from "@flutter-signatures/Adjust/resetSessionCallbackParameters.mdx" -import AddSessionPartnerParameter from "@flutter-examples/Adjust/addSessionPartnerParameter.mdx" -import AddSessionPartnerParameterSig from "@flutter-signatures/Adjust/addSessionPartnerParameter.mdx" -import RemoveSessionPartnerParameter from "@flutter-examples/Adjust/removeSessionPartnerParameter.mdx" -import RemoveSessionPartnerParameterSig from "@flutter-signatures/Adjust/removeSessionPartnerParameter.mdx" -import ResetSessionPartnerParameters from "@flutter-examples/Adjust/resetSessionPartnerParameters.mdx" -import ResetSessionPartnerParametersSig from "@flutter-signatures/Adjust/resetSessionPartnerParameters.mdx" -import SetDelayStart from "@flutter-examples/AdjustConfig/delayStart.mdx" -import SetDelayStartSig from "@flutter-signatures/AdjustConfig/delayStart.mdx" -import SendFirstPackages from "@flutter-examples/Adjust/sendFirstPackages.mdx" -import SendFirstPackagesSig from "@flutter-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,43 @@ 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 + +```dart title="Method signature" +static void addSessionCallbackParameter(String key, String 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. - +```dart +Adjust.addSessionCallbackParameter('key', 'value'); +``` + +### Remove session callback parameters + +```dart title="Method signature" +static void removeSessionCallbackParameter(String 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. - +```dart +Adjust.removeSessionCallbackParameter('key'); +``` + +### Reset session callback parameters + +```dart title="Method signature" +static void resetSessionCallbackParameters() +``` You can remove all session parameters if they're no longer required. To do this, call the `resetSessionCallbackParameters` method. - +```dart +Adjust.resetSessionCallbackParameters(); +``` ## Session partner parameters @@ -55,17 +64,41 @@ 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 + +```dart title="Method signature" +static void addSessionPartnerParameter(String key, String 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. - +```dart +Adjust.addSessionPartnerParameter('key', 'value'); +``` + +### Remove session partner parameters + +```dart title="Method signature" +static void removeSessionPartnerParameter(String 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. - +```dart +Adjust.removeSessionPartnerParameter('key'); +``` + +### Reset session partner parameters + +```dart title="Method signature" +static void resetSessionPartnerParameters() +``` You can remove all session partner parameters if they're no longer required. To do this, call the `resetSessionPartnerParameters` method. - +```dart +Adjust.resetSessionPartnerParameters(); +``` ## Delay start @@ -75,10 +108,18 @@ 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, pass the delay time in seconds to the [`setDelayStart` method](/en/sdk/flutter/configuration#delay-the-start-of-the-sdk) on your config object. - +```dart {3} +AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); +//... +adjustConfig.delayStart(5.5); +//... +Adjust.start(adjustConfig); +``` 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. - +```dart +Adjust.sendFirstPackages(); +``` diff --git a/src/content/docs/sdk/flutter/configuration/skad.mdx b/src/content/docs/sdk/flutter/features/skad.mdx similarity index 75% rename from src/content/docs/sdk/flutter/configuration/skad.mdx rename to src/content/docs/sdk/flutter/features/skad.mdx index 3f4c8756a..2204c09ce 100644 --- a/src/content/docs/sdk/flutter/configuration/skad.mdx +++ b/src/content/docs/sdk/flutter/features/skad.mdx @@ -1,7 +1,7 @@ --- title: Set up SKAdNetwork and conversion values description: Configure SKAdNetwork features for your iOS apps. -slug: en/sdk/flutter/configuration/skad +slug: en/sdk/flutter/features/skan --- @@ -10,7 +10,7 @@ This feature is only available on devices running iOS 14 and above. -SKAdNetwork (StoreKit Ad Network) is Apple's attribution framework for +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. @@ -19,9 +19,15 @@ app install and reinstall attribution. The SKAdNetwork workflow goes like this: ## Disable SKAdNetwork communication +```dart 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. -import DeactivateSKAdNetworkHandlingSig from "@flutter-signatures/AdjustConfig/deactivateSKAdNetworkHandling.mdx"; + 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. @@ -31,29 +37,43 @@ You must call the `deactivateSKAdNetworkHandling` method _before_ initializing t -import DeactivateSKAdNetworkHandling from "@flutter-examples/AdjustConfig/deactivateSKAdNetworkHandling.mdx"; - - +```dart {3} +AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox, true); +//... +adjustConfig.deactivateSKAdNetworkHandling(); +//... +Adjust.start(adjustConfig); +``` ## Update conversion values -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. +```dart title="Method signature" +static void updateConversionValue(int conversionValue) +``` -import UpdateConversionValueSig from "@flutter-signatures/Adjust/updateConversionValue.mdx"; +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. -import UpdateConversionValue from "@flutter-examples/Adjust/updateConversionValue.mdx"; - - +```dart +Adjust.updateConversionValue(6); +``` ## Listen for changes to conversion values -If you use Adjust to manage conversion values, the Adjust's servers send conversion value updates to the SDK. You can set up a delegate function to listen for these changes using the `conversionValueUpdatedCallback` method. Pass your function as an argument. +```dart title="Property declaration" +typedef void ConversionValueUpdatedCallback(num? conversionValue); +``` -import ConversionValueUpdatedCallback from "@flutter-examples/AdjustConfig/conversionValueUpdatedCallback.mdx"; +If you use Adjust to manage conversion values, the Adjust's servers send conversion value updates to the SDK. You can set up a delegate function to listen for these changes using the `conversionValueUpdatedCallback` method. Pass your function as an argument. - +```dart {2-4} +AdjustConfig adjustConfig = new AdjustConfig(yourAppToken, environment); +config.conversionValueUpdatedCallback = (num? conversionValue) { + print('[Adjust]: Received conversion value update: ' + conversionValue!.toString()); +}; +Adjust.start(adjustConfig); +``` ### Example @@ -62,7 +82,6 @@ This example shows how to log the following when the conversion value updates: - A message confirming the conversion value update - The new conversion value - ```dart title="main.dart" import 'package:adjust_sdk/adjust.dart'; import 'package:flutter/cupertino.dart'; @@ -82,5 +101,4 @@ config.conversionValueUpdatedCallback = (num? conversionValue) { Adjust.start(config); } - ``` diff --git a/src/content/docs/sdk/flutter/features/subscriptions.mdx b/src/content/docs/sdk/flutter/features/subscriptions.mdx index 4abf0ef0f..201a1dcd8 100644 --- a/src/content/docs/sdk/flutter/features/subscriptions.mdx +++ b/src/content/docs/sdk/flutter/features/subscriptions.mdx @@ -4,23 +4,6 @@ description: Use these methods send subscription information to Adjust. slug: en/sdk/flutter/features/subscriptions --- -import AdjustAppStoreSubscription from "@flutter-examples/AdjustAppStoreSubscription/constructor.mdx"; -import AdjustPlayStoreSubscription from "@flutter-examples/AdjustPlayStoreSubscription/constructor.mdx"; -import SetTransactionDate from "@flutter-examples/AdjustAppStoreSubscription/setTransactionDate.mdx"; -import SetTransactionDateSig from "@flutter-signatures/AdjustAppStoreSubscription/setTransactionDate.mdx"; -import SetPurchaseTime from "@flutter-examples/AdjustPlayStoreSubscription/setPurchaseTime.mdx"; -import SetPurchaseTimeSig from "@flutter-signatures/AdjustPlayStoreSubscription/setPurchaseTime.mdx"; -import SetSalesRegion from "@flutter-examples/AdjustAppStoreSubscription/setSalesRegion.mdx"; -import SetSalesRegionSig from "@flutter-signatures/AdjustAppStoreSubscription/setSalesRegion.mdx"; -import AddCallbackParameterAppStore from "@flutter-examples/AdjustAppStoreSubscription/addCallbackParameter.mdx"; -import AddCallbackParameterPlayStore from "@flutter-examples/AdjustPlayStoreSubscription/addCallbackParameter.mdx"; -import AddPartnerParameterAppStore from "@flutter-examples/AdjustAppStoreSubscription/addPartnerParameter.mdx"; -import AddPartnerParameterPlayStore from "@flutter-examples/AdjustPlayStoreSubscription/addPartnerParameter.mdx"; -import TrackAppStoreSubscription from "@flutter-examples/Adjust/trackAppStoreSubscription.mdx"; -import TrackAppStoreSubscriptionSig from "@flutter-signatures/Adjust/trackAppStoreSubscription.mdx"; -import TrackPlayStoreSubscription from "@flutter-examples/Adjust/trackPlayStoreSubscription.mdx"; -import TrackPlayStoreSubscriptionSig from "@flutter-signatures/Adjust/trackPlayStoreSubscription.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. @@ -29,14 +12,18 @@ The following steps only set up subscription tracking within the Adjust SDK. To You can record App Store and Play Store subscriptions and verify their validity with the Adjust SDK. After the user purchases a subscription, create an `AdjustAppStoreSubscription` or `AdjustPlayStoreSubscription` instance containing the details. -## 1. Set up your subscription object +## 1. Instantiate a subscription object To get started, you need to create a subscription object containing details of the subscription purchase. -Create an `AdjustAppStoreSubscription` object with the following properties +```dart title="Method signature" +AdjustAppStoreSubscription(String _price, String _currency, String _transactionId, String _receipt) +``` + +Create an `AdjustAppStoreSubscription` object with the following properties: @@ -49,12 +36,22 @@ Create an `AdjustAppStoreSubscription` object with the following properties
- +```dart +AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( + price, + currency, + transactionId, + receipt); +``` -Create an `AdjustPlayStoreSubscription` object with the following properties +```dart title="Method signature" +AdjustPlayStoreSubscription(String _price, String _currency, String _sku, String _orderId, String _signature, String _purchaseToken) +``` + +Create an `AdjustPlayStoreSubscription` object with the following properties: @@ -69,7 +66,15 @@ Create an `AdjustPlayStoreSubscription` object with the following properties
- +```dart +AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken); +``` @@ -81,25 +86,62 @@ You can record the date on which the user purchased a subscription. The SDK retu +```dart title="Method signature" +void setTransactionDate(String _transactionDate) +``` + Call the `setTransactionDate` method on your subscription object to record the timestamp of the subscription. - +```dart {7} +AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( + price, + currency, + transactionId, + receipt); +//... +subscription.setTransactionDate(transactionDate); +``` +```dart title="Method signature" +void setPurchaseTime(String purchaseTime) +``` + Call the `setPurchaseTime` method on your subscription object to record the timestamp of the subscription. - +```dart {8} +AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken); +subscription.setPurchaseTime(purchaseTime); +``` ### Record the purchase region (iOS only) +```dart title="Method signature" +void setSalesRegion(String _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. - +```dart {7} +AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( + price, + currency, + transactionId, + receipt); +//... +subscription.setSalesRegion(salesRegion); +``` ### Add callback parameters @@ -108,12 +150,40 @@ You can add callback parameters to your subscription object. The SDK appends the - +```dart title="Method signature" +void addCallbackParameter(String key, String value) +``` + +```dart {7-8} +AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( + price, + currency, + transactionId, + receipt); +//... +subscription.addCallbackParameter('key1', 'value1'); +subscription.addCallbackParameter('key2', 'value2'); +``` - +```dart title="Method signature" +void addCallbackParameter(String key, String value) +``` + +```dart {9-10} +AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken); +//... +subscription.addCallbackParameter('key1', 'value1'); +subscription.addCallbackParameter('key2', 'value2'); +``` @@ -125,12 +195,40 @@ You can add partner parameters to your subscription object. The SDK sends these - +```dart title="Method signature" +void addPartnerParameter(String key, String value) +``` + +```dart {7-8} +AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( + price, + currency, + transactionId, + receipt); +//... +subscription.addPartnerParameter('key1', 'value1'); +subscription.addPartnerParameter('key2', 'value2'); +``` - +```dart title="Method signature" +void addPartnerParameter(String key, String value) +``` + +```dart {9-10} +AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken); +//... +subscription.addPartnerParameter('key1', 'value1'); +subscription.addPartnerParameter('key2', 'value2'); +``` @@ -142,16 +240,53 @@ Once you have set up your subscription object, you can record it using the Adjus +```dart title="Method signature" +static void trackAppStoreSubscription(AdjustAppStoreSubscription subscription) +``` + Pass your subscription object to the `trackAppStoreSubscription` method to record the user's subscription purchase. - +```dart {13} +AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( + price, + currency, + transactionId, + receipt); +subscription.setTransactionDate(transactionDate); +subscription.setSalesRegion(salesRegion); +subscription.addCallbackParameter('key1', 'value1'); +subscription.addCallbackParameter('key2', 'value2'); +subscription.addPartnerParameter('key1', 'value1'); +subscription.addPartnerParameter('key2', 'value2'); + +Adjust.trackAppStoreSubscription(subscription); +``` +```dart title="Method signature" +static void trackPlayStoreSubscription(AdjustPlayStoreSubscription subscription) +``` + Pass your subscription object to the `trackPlayStoreSubscription` method to record the user's subscription purchase. - +```dart {14} +AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken); +subscription.setPurchaseTime(purchaseTime); +subscription.addCallbackParameter('key1', 'value1'); +subscription.addCallbackParameter('key2', 'value2'); +subscription.addPartnerParameter('key1', 'value1'); +subscription.addPartnerParameter('key2', 'value2'); + +Adjust.trackPlayStoreSubscription(subscription); +``` diff --git a/src/content/docs/sdk/flutter/index.mdx b/src/content/docs/sdk/flutter/index.mdx index 65625d177..56260ffbc 100644 --- a/src/content/docs/sdk/flutter/index.mdx +++ b/src/content/docs/sdk/flutter/index.mdx @@ -6,8 +6,6 @@ slug: en/sdk/flutter sidebar-position: 5 --- -import LogLevelSig from "@flutter-signatures/AdjustConfig/logLevel.mdx" - The Adjust Flutter SDK enables you to measure attribution, events, and much more in your Flutter app. Follow the steps in this guide to set up your app to work with the Adjust SDK. You can also check out the example apps [on GitHub](https://github.com/adjust/flutter_sdk/tree/master/example). diff --git a/src/content/docs/sdk/flutter/reference/adjust/config.mdx b/src/content/docs/sdk/flutter/reference/adjust/config.mdx deleted file mode 100644 index 428f653db..000000000 --- a/src/content/docs/sdk/flutter/reference/adjust/config.mdx +++ /dev/null @@ -1,157 +0,0 @@ ---- -title: Configuration methods -description: Use these methods to update the Adjust SDK's configuration. -slug: en/sdk/flutter/reference/adjust/config ---- - -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 "@flutter-signatures/Adjust/setEnabled.mdx" - - - - - - - -import SetEnabled from "@flutter-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 "@flutter-signatures/Adjust/isEnabled.mdx" - - - - - - - -import IsEnabled from "@flutter-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 "@flutter-signatures/Adjust/sendFirstPackages.mdx" - - - - - - - -import SendFirstPackages from "@flutter-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 "@flutter-signatures/Adjust/setOfflineMode.mdx" - - - - - - - -import SetOfflineMode from "@flutter-examples/Adjust/setOfflineMode.mdx" - - - - - - - -`enabled` (bool): Whether the SDK is in offline mode. - - - - - - - -## setPushToken - -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 SetPushTokenSig from "@flutter-signatures/Adjust/setPushToken.mdx" - - - - - - - -import SetPushToken from "@flutter-examples/Adjust/setPushToken.mdx" - - - - - - - -`pushToken` (String): Your push token. - - - - diff --git a/src/content/docs/sdk/flutter/reference/adjust/device-info.mdx b/src/content/docs/sdk/flutter/reference/adjust/device-info.mdx deleted file mode 100644 index 5341dcb55..000000000 --- a/src/content/docs/sdk/flutter/reference/adjust/device-info.mdx +++ /dev/null @@ -1,134 +0,0 @@ ---- -title: Device information methods -description: Use these methods to retrieve device information. -slug: en/sdk/flutter/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 GetAdidSig from "@flutter-signatures/Adjust/getAdid.mdx" - - - - - - - -import GetAdid from "@flutter-examples/Adjust/getAdid.mdx" - - - - - - - -`adid` (String): The Adjust identifier associated with the device - - - - - - - -## getIdfa - -Returns the IDFA (ID for advertisers) associated with the device. - - - -import GetIdfaSig from "@flutter-signatures/Adjust/getIdfa.mdx" - - - - - - - -import GetIdfa from "@flutter-examples/Adjust/getIdfa.mdx" - - - - - - - -`idfa` (String): The IDFA associated with the device - - - - - - - -## getGoogleAdid - -Returns the Google ADID (Google advertiser ID) associated with the device. - - - -import GetGoogleAdidSig from "@flutter-signatures/Adjust/getGoogleAdId.mdx" - - - - - - - -import GetGoogleAdid from "@flutter-examples/Adjust/getGoogleAdId.mdx" - - - - - - - -`googleAdid` (String): The Google ADID associated with the device - - - - - - - -## getAmazonAdid - -Returns the Amazon ADID (Amazon advertiser ID) associated with the device. - - - -import GetAmazonAdidSig from "@flutter-signatures/Adjust/getAmazonAdId.mdx" - - - - - - - -import GetAmazonAdid from "@flutter-examples/Adjust/getAmazonAdId.mdx" - - - - - - - -`amazonAdId` (String): The Amazon ADID associated with the device - - - - diff --git a/src/content/docs/sdk/flutter/reference/adjust/index.mdx b/src/content/docs/sdk/flutter/reference/adjust/index.mdx deleted file mode 100644 index 7315bbfb6..000000000 --- a/src/content/docs/sdk/flutter/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/flutter/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/flutter/reference/adjust/privacy.mdx b/src/content/docs/sdk/flutter/reference/adjust/privacy.mdx deleted file mode 100644 index 6ed904dd3..000000000 --- a/src/content/docs/sdk/flutter/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/flutter/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 "@flutter-signatures/Adjust/disableThirdPartySharing.mdx" - - - - - - - -import DisableThirdPartySharing from "@flutter-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 "@flutter-signatures/Adjust/trackThirdPartySharing.mdx" - - - - - - - -import TrackThirdPartySharing from "@flutter-examples/Adjust/trackThirdPartySharing.mdx" - - - - - - - -`thirdPartySharing` (AdjustThirdPartySharing): 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 "@flutter-signatures/Adjust/trackMeasurementConsent.mdx" - - - - - - - -import TrackMeasurementConsent from "@flutter-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 "@flutter-signatures/Adjust/gdprForgetMe.mdx" - - - - - - - -import GdprForgetMe from "@flutter-examples/Adjust/gdprForgetMe.mdx" - - - - - - diff --git a/src/content/docs/sdk/flutter/reference/adjust/recording.mdx b/src/content/docs/sdk/flutter/reference/adjust/recording.mdx deleted file mode 100644 index f025d52af..000000000 --- a/src/content/docs/sdk/flutter/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/flutter/reference/adjust/recording -sidebar-position: 4 ---- - -Use these methods to send information about your app to Adjust. - - - -## trackEvent - -Record event information using an `Adjust` object and an [Adjust event token](https://help.adjust.com/en/article/add-events#add-event). - - - -import TrackEventSig from "@flutter-signatures/Adjust/trackEvent.mdx" - - - - - - - -import TrackEvent from "@flutter-examples/Adjust/trackEvent.mdx" - - - - - - - -`event` (AdjustEvent): 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 "@flutter-signatures/Adjust/addSessionCallbackParameter.mdx" - - - - - - - -import AddSessionCallbackParameter from "@flutter-examples/Adjust/addSessionCallbackParameter.mdx" - - - - - - - -`key` (String): The data key - -`value` (String): The data value - - - - - - - -## removeSessionCallbackParameter - -Remove a session callback parameter. - - - -import RemoveSessionCallbackParameterSig from "@flutter-signatures/Adjust/removeSessionCallbackParameter.mdx" - - - - - - - -import RemoveSessionCallbackParameter from "@flutter-examples/Adjust/removeSessionCallbackParameter.mdx" - - - - - - - -`key` (String): The data key of the parameter you want to remove. - - - - - - - -## resetSessionCallbackParameters - -Removes all session callback parameters. - - - -import ResetSessionCallbackParametersSig from "@flutter-signatures/Adjust/resetSessionCallbackParameters.mdx" - - - - - - - -import ResetSessionCallbackParameters from "@flutter-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 "@flutter-signatures/Adjust/addSessionPartnerParameter.mdx" - - - - - - - -import AddSessionPartnerParameter from "@flutter-examples/Adjust/addSessionPartnerParameter.mdx" - - - - - - - -`key` (String): The data key - -`value` (String): The data value - - - - - - - -## removeSessionPartnerParameter - -Remove a session partner parameter. - - - -import RemoveSessionPartnerParameterSig from "@flutter-signatures/Adjust/removeSessionPartnerParameter.mdx" - - - - - - - -import RemoveSessionPartnerParameter from "@flutter-examples/Adjust/removeSessionPartnerParameter.mdx" - - - - - - - -`key` (String): The data key of the parameter you want to remove. - - - - - - - -## resetSessionPartnerParameters - -Removes all session partner parameters. - - - -import ResetSessionPartnerParametersSig from "@flutter-signatures/Adjust/resetSessionPartnerParameters.mdx" - - - - - - - -import ResetSessionPartnerParameters from "@flutter-examples/Adjust/resetSessionPartnerParameters.mdx" - - - - - - - - - -## trackAdRevenue - -Record the details of an AdjustAdRevenue object. - - - -import TrackAdRevenueSig from "@flutter-signatures/Adjust/trackAdRevenue.mdx" - - - - - - - -import TrackAdRevenue from "@flutter-examples/Adjust/trackAdRevenue.mdx" - - - - - - - -`adRevenue` (AdjustAdRevenue): The ad revenue object containing the revenue details. - - - - - - - -## trackPlayStoreSubscription - -Record a Play Store subscription object. - - - -import TrackPlayStoreSubscriptionSig from "@flutter-signatures/Adjust/trackPlayStoreSubscription.mdx" - - - - - - - -import TrackPlayStoreSubscription from "@flutter-examples/Adjust/trackPlayStoreSubscription.mdx" - - - - - - - -`subscription` (AdjustPlayStoreSubscription): The subscription object containing the purchase details. - - - - - - - -## trackAppStoreSubscription - -Record an App Store subscription object. - - - -import TrackAppStoreSubscriptionSig from "@flutter-signatures/Adjust/trackAppStoreSubscription.mdx" - - - - - - - -import TrackAppStoreSubscription from "@flutter-examples/Adjust/trackAppStoreSubscription.mdx" - - - - - - - -`subscription` (AdjustAppStoreSubscription): The subscription object containing the purchase details. - - - - - - - -## getAttribution - -Fetches attribution data about the device. - - - -import GetAttributionSig from "@flutter-signatures/Adjust/getAttribution.mdx" - - - - - - - -import GetAttribution from "@flutter-examples/Adjust/getAttribution.mdx" - - - - - - - -`attribution` (AdjustAttribution): An attribution object containing attribution data associated with the device. - - - - diff --git a/src/content/docs/sdk/flutter/reference/adjust/skan-att.mdx b/src/content/docs/sdk/flutter/reference/adjust/skan-att.mdx deleted file mode 100644 index 7ccbf5884..000000000 --- a/src/content/docs/sdk/flutter/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/flutter/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 "@flutter-signatures/Adjust/requestTrackingAuthorizationWithCompletionHandler.mdx" - - - - - - - -import RequestTrackingAuthorization from "@flutter-examples/Adjust/requestTrackingAuthorizationWithCompletionHandler.mdx" - - - - - - - -`statusCallback` (function): Completion handler to which the status is passed. - - - - - - - -## getAppTrackingAuthorizationStatus - -Retrieves the user's current authorization status. - - - -import GetAppTrackingAuthorizationStatusSig from "@flutter-signatures/Adjust/getAppTrackingAuthorizationStatus.mdx" - - - - - - - -import GetAppTrackingAuthorizationStatus from "@flutter-examples/Adjust/getAppTrackingAuthorizationStatus.mdx" - - - - - - - -`status` (num): The user's authorization status. - - - - - - - -## checkForNewAttStatus - -Prompts the SDK to check the current state of `att_status`. - - - -import CheckForNewAttStatusSig from "@flutter-signatures/Adjust/checkForNewAttStatus.mdx" - - - - - - - -import CheckForNewAttStatus from "@flutter-examples/Adjust/checkForNewAttStatus.mdx" - - - - - - - - - -## updateConversionValue - -Updates the [conversion value](https://help.adjust.com/en/suite/article/conversion-hub). - - - -import UpdateConversionValueSig from "@flutter-signatures/Adjust/updateConversionValue.mdx" - - - - - - - -import UpdateConversionValue from "@flutter-examples/Adjust/updateConversionValue.mdx" - - - - - - - -conversionValue (num): The new conversion value. - - - - diff --git a/src/content/docs/sdk/flutter/reference/adjustadrevenue.mdx b/src/content/docs/sdk/flutter/reference/adjustadrevenue.mdx deleted file mode 100644 index 9d7593f7c..000000000 --- a/src/content/docs/sdk/flutter/reference/adjustadrevenue.mdx +++ /dev/null @@ -1,269 +0,0 @@ ---- -title: AdjustAdRevenue class -description: Use this class to store ad revenue information. -category-title: AdjustAdRevenue class -slug: en/sdk/flutter/reference/adjustadrevenue ---- - -Use this class to store ad revenue information. - - - -## Constructor - -Creates an ad revenue object initialized with an external ad revenue source. - - - -import ConstructorSig from "@flutter-signatures/AdjustAdRevenue/constructor.mdx"; - - - - - - - -import Constructor from "@flutter-examples/AdjustAdRevenue/constructor.mdx"; - - - - - - - -`source` (String): The source of the ad revenue. - - - -| Parameter | Source | -| ---------------------------------------------- | ----------------- | -| `AdjustConfig.AdRevenueSourceAppLovinMAX` | AppLovin MAX | -| `AdjustConfig.AdRevenueSourceMopub` | Mopub | -| `AdjustConfig.AdRevenueSourceAdMob` | AdMob | -| `AdjustConfig.AdRevenueSourceIronSource` | ironSource | -| `AdjustConfig.AdRevenueSourceAdmost` | AdMost | -| `AdjustConfig.AdRevenueSourceUnity` | Unity | -| `AdjustConfig.AdRevenueSourceHeliumChartboost` | Helium Chartboost | -| `AdjustConfig.AdRevenueSourcePublisher` | Generic source | - -
- - - - - - - -## setRevenue - -Set the revenue amount associated with the ad revenue object. - - - -import SetRevenueSig from "@flutter-signatures/AdjustAdRevenue/setRevenue.mdx"; - - - - - - - -import SetRevenue from "@flutter-examples/AdjustAdRevenue/setRevenue.mdx"; - - - - - - - -`amount` (num): The amount of currency units associated with the ad. - -`currency` (String): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit. - - - - - - - -## adImpressionsCount - -Sets the number of impressions received for an ad. - - - -import AdImpressionsCountSig from "@flutter-signatures/AdjustAdRevenue/adImpressionsCount.mdx"; - - - - - - - -import AdImpressionsCount from "@flutter-examples/AdjustAdRevenue/adImpressionsCount.mdx"; - - - - - - - -`adImpressionsCaount` (num): The number of impressions associated with the ad. - - - - - - - -## adRevenueNetwork - -Sets the network associated with the ad revenue. - - - -import AdRevenueNetworkSig from "@flutter-signatures/AdjustAdRevenue/adRevenueNetwork.mdx"; - - - - - - - -import AdRevenueNetwork from "@flutter-examples/AdjustAdRevenue/adRevenueNetwork.mdx"; - - - - - - - -`adRevenueNetwork` (String): The network associated with the ad revenue. - - - - - - - -## adRevenueUnit - -Sets the ad unit ID associated with the ad revenue. - - - -import AdRevenueUnitSig from "@flutter-signatures/AdjustAdRevenue/adRevenueUnit.mdx"; - - - - - - - -import AdRevenueUnit from "@flutter-examples/AdjustAdRevenue/adRevenueUnit.mdx"; - - - - - - - -`unit` (String): The ad unit ID associated with the ad revenue. - - - - - - - -## adRevenuePlacement - -Sets the placement of the ad associated with the ad revenue. - - - -import AdRevenuePlacementSig from "@flutter-signatures/AdjustAdRevenue/adRevenuePlacement.mdx"; - - - - - - - -import AdRevenuePlacement from "@flutter-examples/AdjustAdRevenue/adRevenuePlacement.mdx"; - - - - - - - -`adRevenuePlacement` (String): The placement of the ad associated with the revenue. - - - - - - - -## addCallbackParameter - -Adds key-value information to send to your callback URL. - - - -import AddCallbackParameterSig from "@flutter-signatures/AdjustAdRevenue/addCallbackParameter.mdx"; - - - - - - - -import AddCallbackParameter from "@flutter-examples/AdjustAdRevenue/addCallbackParameter.mdx"; - - - - - - - -`key` (String): The data key. - -`value` (String): The data value. - - - - - - - -## addPartnerParameter - -Adds key-value information to share with partners. - - - -import AddPartnerParameterSig from "@flutter-signatures/AdjustAdRevenue/addPartnerParameter.mdx"; - - - - - - - -import AddPartnerParameter from "@flutter-examples/AdjustAdRevenue/addPartnerParameter.mdx"; - - - - - - - -`key` (String): The data key. - -`value` (String): The data value. - - - - diff --git a/src/content/docs/sdk/flutter/reference/adjustappstoresubscription.mdx b/src/content/docs/sdk/flutter/reference/adjustappstoresubscription.mdx deleted file mode 100644 index b97cad816..000000000 --- a/src/content/docs/sdk/flutter/reference/adjustappstoresubscription.mdx +++ /dev/null @@ -1,170 +0,0 @@ ---- -title: AdjustAppStoreSubscription class -description: Use this class to store App Store subscription information. -category-title: AdjustAppStoreSubscription class -slug: en/sdk/flutter/reference/adjustappstoresubscription ---- - -import TrackAppStoreSubscription from "@flutter-signatures/Adjust/trackAppStoreSubscription.mdx" - -Use this class to store App Store subscription information. You can pass this to Adjust's servers using the `trackAppStoreSubscription` method. - - - -## Constructor - -Instantiates a subscription object. - - - -import ConstructorSig from "@flutter-signatures/AdjustAppStoreSubscription/constructor.mdx" - - - - - - - -import Constructor from "@flutter-examples/AdjustAppStoreSubscription/constructor.mdx" - - - - - - - -`price` (String): 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. - - - - - - - -## setTransactionDate - -Sets the date of the transaction in the subscription object. - - - -import SetTransactionDateSig from "@flutter-signatures/AdjustAppStoreSubscription/setTransactionDate.mdx" - - - - - - - -import SetTransactionDate from "@flutter-examples/AdjustAppStoreSubscription/setTransactionDate.mdx" - - - - - - - -`transactionDate` (String): The date on which the subscription was purchased. - - - - - - - -## setSalesRegion - -You can record the region in which the user purchased a subscription. - - - -import SetSalesRegionSig from "@flutter-signatures/AdjustAppStoreSubscription/setSalesRegion.mdx" - - - - - - - -import SetSalesRegion from "@flutter-examples/AdjustAppStoreSubscription/setSalesRegion.mdx" - - - - - - - -`salesRegion` (String): The region in which the subscription was purchased. - - - - - - - -## addCallbackParameter - -Adds key-value callback parameters to the subscription object. You can add multiple parameters by calling this method multiple times. - - - -import AddCallbackParameterSig from "@flutter-signatures/AdjustAppStoreSubscription/addCallbackParameter.mdx" - - - - - - - -import AddCallbackParameter from "@flutter-examples/AdjustAppStoreSubscription/addCallbackParameter.mdx" - - - - - - - -`key` (String): The data key. - -`value` (String): The data value. - - - - - - - -## addPartnerParameter - -Adds key-value callback parameters to the subscription object. You can add multiple parameters by calling this method multiple times. - - - -import AddPartnerParameterSig from "@flutter-signatures/AdjustAppStoreSubscription/addPartnerParameter.mdx" - - - - - - - -import AddPartnerParameter from "@flutter-examples/AdjustAppStoreSubscription/addPartnerParameter.mdx" - - - - - - - -`key` (String): The data key. - -`value` (String): The data value. - - - - diff --git a/src/content/docs/sdk/flutter/reference/adjustattribution.mdx b/src/content/docs/sdk/flutter/reference/adjustattribution.mdx deleted file mode 100644 index 28c0e1e8f..000000000 --- a/src/content/docs/sdk/flutter/reference/adjustattribution.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AdjustAttribution class -description: Use this class to see attribution information. -category-title: AdjustAttribution class -slug: en/sdk/flutter/reference/adjustattribution ---- - -import AttributionSig from "@flutter-signatures/Adjust/getAttribution.mdx" -import NeedsCostSig from "@flutter-signatures/AdjustConfig/needsCost.mdx" - -The `AdjustAttribution` class contains details about the current attribution status of the device. - -## Properties - -The following properties can be accessed by calling the `getAttribution` 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. | -| `fbInstallReferrer` | String | The [Facebook install referrer](https://developers.facebook.com/docs/app-ads/install-referrer/). _Android only_. | - -
diff --git a/src/content/docs/sdk/flutter/reference/adjustconfig/index.mdx b/src/content/docs/sdk/flutter/reference/adjustconfig/index.mdx deleted file mode 100644 index 967b38710..000000000 --- a/src/content/docs/sdk/flutter/reference/adjustconfig/index.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: AdjustConfig class -description: Use the methods in this class to set up the Adjust SDK. -category-title: AdjustConfig class -slug: en/sdk/flutter/reference/adjustconfig -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. - - - - - -## Constructor - -Initialize the configuration object with your Adjust app token. - - - -import Constructor from "@flutter-signatures/AdjustConfig/constructor.mdx" - - - - - - - -import ConfigWithAppToken from "@flutter-examples/AdjustConfig/constructor.mdx" - - - - - - - -`appToken` (string): Your Adjust app token. - -`environment` (AdjustEnvironment): The environment your app is running in. - - - - - -`config` (AdjustConfig): A config object initialized with the provided params. - - - - diff --git a/src/content/docs/sdk/flutter/reference/adjustconfig/privacy.mdx b/src/content/docs/sdk/flutter/reference/adjustconfig/privacy.mdx deleted file mode 100644 index c54724cf5..000000000 --- a/src/content/docs/sdk/flutter/reference/adjustconfig/privacy.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: Privacy methods -description: Configure these properties to set up privacy features in the Adjust SDK. -slug: en/sdk/flutter/reference/adjustconfig/privacy -sidebar-position: 2 ---- - - - -## urlStrategy - -Sets the country or region of data residency. If called with a `UrlStrategy` parameter, sets the country/region where data will be sent preferentially. - - - -import UrlStrategySig from "@flutter-signatures/AdjustConfig/urlStrategy.mdx"; - - - - - - - -import UrlStrategy from "@flutter-examples/AdjustConfig/urlStrategy.mdx"; - - - - - - - -`urlStrategy` (String): The data residency target (see available values below) - - - -| Value | Description | -| ------------------------------- | --------------------------------------------------------- | -| `AdjustConfig.DataResidencyEU` | Sets the area of data residency to the EU | -| `AdjustConfig.DataResidencyTR` | Sets the area of data residency to Turkey | -| `AdjustConfig.DataResidencyUS` | Sets the area of data residency to the USA | -| `AdjustConfig.UrlStrategyChina` | Points the URL strategy to the `app.adjust.world` domain | -| `AdjustConfig.UrlStrategyCn` | Points the URL strategy to the `app.adjust.cn` domain | -| `AdjustConfig.UrlStrategyIndia` | Points the URL strategy to the `app.adjust.net.in` domain | - -
- - - - - - - -## coppaCompliantEnabled - -Enable COPPA (Children's Online Privacy Protection Act) compliance in your app. - - - -import CoppaCompliantEnabledSig from "@flutter-signatures/AdjustConfig/coppaCompliantEnabled.mdx"; - - - - - - - -import CoppaCompliantEnabled from "@flutter-examples/AdjustConfig/coppaCompliantEnabled.mdx"; - - - - - - - -`coppaCompliantEnabled` (bool): Whether the app should be COPPA compliant. - - - - diff --git a/src/content/docs/sdk/flutter/reference/adjustconfig/setup.mdx b/src/content/docs/sdk/flutter/reference/adjustconfig/setup.mdx deleted file mode 100644 index d0a092107..000000000 --- a/src/content/docs/sdk/flutter/reference/adjustconfig/setup.mdx +++ /dev/null @@ -1,538 +0,0 @@ ---- -title: Setup methods -description: Configure these properties to set up the Adjust SDK. -slug: en/sdk/flutter/reference/adjustconfig/setup -sidebar-position: 1 ---- - -Configure these properties to set up the Adjust SDK. - - - -## logLevel - -Set the verbosity of logs you want to receive from the Adjust SDK. - - - -import LogLevelSig from "@flutter-signatures/AdjustConfig/logLevel.mdx"; - - - - - - - -import LogLevel from "@flutter-examples/AdjustConfig/logLevel.mdx"; - - - - - - - -`logLevel` (AdjustLogLevel): The level of logging output by the SDK. - - - -| Log level | Description | -| ------------------------- | ------------------------------------------ | -| `AdjustLogLevel.verbose` | Enable all logging | -| `AdjustLogLevel.debug` | Enable debug logging | -| `AdjustLogLevel.info` | Only show info level logs (default option) | -| `AdjustLogLevel.warn` | Disable info logging | -| `AdjustLogLevel.error` | Disable warning level logging and below | -| `AdjustLogLevel.assert` | Disable error level logging and below | -| `AdjustLogLevel.suppress` | Suppress all logging | - -
- - - - - - - -## defaultTracker - -Sets a default token to record installs against. - - - -import DefaultTrackerSig from "@flutter-signatures/AdjustConfig/defaultTracker.mdx" - - - - - - - -import DefaultTracker from "@flutter-examples/AdjustConfig/defaultTracker.mdx" - - - - - - - -`defaultTracker` (String): The token to which all preinstalled sessions are attributed. - - - - - - - -## sendInBackground - -Sets whether the SDK should send data while the app is running in the background. - - - -import SendInBackgroundSig from "@flutter-signatures/AdjustConfig/sendInBackground.mdx" - - - - - - - -import SendInBackground from "@flutter-examples/AdjustConfig/sendInBackground.mdx" - - - - - - - -`sendInBackground` (bool): Whether the SDK should send information to Adjust when the app is running in the background. - - - - - - - -## sessionSuccessCallback - -Sets up a success callback to trigger a function when the SDK records a session. - - - -import SessionSuccessCallbackSig from "@flutter-signatures/AdjustConfig/sessionSuccessCallback.mdx" - - - - - - - -import SessionSuccessCallback from "@flutter-examples/AdjustConfig/sessionSuccessCallback.mdx" - - - - - - - -`sessionSuccessCallback` (function): The function to launch when the SDK successfully records a session. - - - - - - - -## sessionFailureCallback - -Sets up a callback to trigger a function when the SDK fails to record a session. - - - -import SessionFailureCallbackSig from "@flutter-signatures/AdjustConfig/sessionFailureCallback.mdx" - - - - - - - -import SessionFailureCallback from "@flutter-examples/AdjustConfig/sessionFailureCallback.mdx" - - - - - - - -`sessionFailureCallback` (function): The function to launch when the SDK fails to record a session. - - - - - - - -## eventSuccessCallback - -Sets up a success callback to trigger a function when the SDK records an event. - - - -import EventSuccessCallbackSig from "@flutter-signatures/AdjustConfig/eventSuccessCallback.mdx" - - - - - - - -import EventSuccessCallback from "@flutter-examples/AdjustConfig/eventSuccessCallback.mdx" - - - - - - - -`eventSuccessCallback` (function): The function to launch when the SDK successfully records an event. - - - - - - - -## eventFailureCallback - -Sets up a callback to trigger a function when the SDK fails to record a session. - - - -import EventFailureCallbackSig from "@flutter-signatures/AdjustConfig/eventFailureCallback.mdx" - - - - - - - -import EventFailureCallback from "@flutter-examples/AdjustConfig/eventFailureCallback.mdx" - - - - - - - -`eventFailureCallback` (function): The function to launch when the SDK fails to record an event. - - - - - - - -## delayStart - -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 DelayStartSig from "@flutter-signatures/AdjustConfig/delayStart.mdx" - - - - - - - -import DelayStart from "@flutter-examples/AdjustConfig/delayStart.mdx" - - - - - - - -`delayStart` (num): The time (in seconds) to delay the start of the SDK by. - - - - - - - -## externalDeviceId - -Sets an external device identifier for reporting purposes. - - - -import ExternalDeviceIdSig from "@flutter-signatures/AdjustConfig/externalDeviceId.mdx" - - - - - - - -import ExternalDeviceId from "@flutter-examples/AdjustConfig/externalDeviceId.mdx" - - - - - - - -`externalDeviceId` (String): The external device ID associated with the device. - - - - - - - -## eventBufferingEnabled - -Sets event buffering. If enabled, the SDK stores events on the device and sends all requests once per minute. - - - -import EventBufferingEnabledSig from "@flutter-signatures/AdjustConfig/eventBufferingEnabled.mdx" - - - - - - - -import EventBufferingEnabled from "@flutter-examples/AdjustConfig/eventBufferingEnabled.mdx" - - - - - - - -`eventBufferingEnabled` (bool): Whether event buffering is enabled. - - - - - - - -## needsCost - -Sets whether the SDK should gather cost data. This is accessible in the user's attribution information. - - - -import NeedsCostSig from "@flutter-signatures/AdjustConfig/needsCost.mdx" - - - - - - - -import NeedsCost from "@flutter-examples/AdjustConfig/needsCost.mdx" - - - - - - - -`needsCost` (bool): Whether the SDK should gather cost data - - - - - - - -## attributionCallback - -Sets a delegate function that fires when a user's attribution information updates. - - - -import AttributionCallbackSig from "@flutter-signatures/AdjustConfig/attributionCallback.mdx" - - - - - - - -import AttributionCallback from "@flutter-examples/AdjustConfig/attributionCallback.mdx" - - - - - - - -`attributionCallback` (function): The delegate function that the SDK calls when the user's attribution information changes. - - - - - - - -## preinstallTrackingEnabled - -Enables or disables preinstall tracking. - - - -import PreinstallTrackingEnabledSig from "@flutter-signatures/AdjustConfig/preinstallTrackingEnabled.mdx" - - - - - - - -import PreinstallTrackingEnabled from "@flutter-examples/AdjustConfig/preinstallTrackingEnabled.mdx" - - - - - - - -`preinstallTrackingEnabled` (bool): Whether preinstall tracking is enabled. - - - - - - - -## deactivateSKAdNetworkHandling - -Turns off communication with SKAdNetwork. - - - -SKAdNetwork communication is enabled by default. - - - - - -import DeactivateSKAdNetworkHandlingSig from "@flutter-signatures/AdjustConfig/deactivateSKAdNetworkHandling.mdx" - - - - - - - -import DeactivateSKAdNetworkHandling from "@flutter-examples/AdjustConfig/deactivateSKAdNetworkHandling.mdx" - - - - - - - - - -## deferredDeeplinkCallback - -Enables or disables launching deferred deep links with the SDK. If enabled, the SDK launches deep links the user interacts with. - - - -import DeferredDeeplinkCallbackSig from "@flutter-signatures/AdjustConfig/deferredDeeplinkCallback.mdx" - - - - - - - -import DeferredDeeplinkCallback from "@flutter-examples/AdjustConfig/deferredDeeplinkCallback.mdx" - - - - - - - -`launchDeferredDeepLink` (bool): Whether to enable launching deferred deep links. - - - - - - - -## linkMeEnabled - -Toggle support for Adjust's [LinkMe solution](https://help.adjust.com/en/article/linkme) for deep linking. - - - -import LinkMeEnabledSig from "@flutter-signatures/AdjustConfig/linkMeEnabled.mdx" - - - - - - - -import LinkMeEnabled from "@flutter-examples/AdjustConfig/linkMeEnabled.mdx" - - - - - - - -`linkMeEnabled` (bool): Whether to enable LinkMe. - - - - - - - -## conversionValueUpdatedCallback - -Sets a delegate function to call when the user's conversion value updates. - - - -import ConversionValueUpdatedCallbackSig from "@flutter-signatures/AdjustConfig/conversionValueUpdatedCallback.mdx" - - - - - - - -import ConversionValueUpdatedCallback from "@flutter-examples/AdjustConfig/conversionValueUpdatedCallback.mdx" - - - - - - - -`conversionValueUpdatedCallback` (function): The delegate function the SDK launches when the conversion value updates - - - - diff --git a/src/content/docs/sdk/flutter/reference/adjustevent.mdx b/src/content/docs/sdk/flutter/reference/adjustevent.mdx deleted file mode 100644 index ed3f0352b..000000000 --- a/src/content/docs/sdk/flutter/reference/adjustevent.mdx +++ /dev/null @@ -1,196 +0,0 @@ ---- -title: AdjustEvent class -description: Record information about events to send to Adjust. -category-title: AdjustEvent class -slug: en/sdk/flutter/reference/adjustevent ---- - -import TrackEvent from "@flutter-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 `AdjustEvent` object to the `trackEvent` method. - - - -## Constructor - -Instantiates an event object with an Adjust event token. - - - -import ConstructorSig from "@flutter-signatures/AdjustEvent/constructor.mdx" - - - - - - - -import Constructor from "@flutter-examples/AdjustEvent/constructor.mdx" - - - - - - - -`eventToken` (String): A 6 character Adjust event token. - - - - - - - -## setRevenue - -Sets the revenue and currency associated with an event. - - - -import SetRevenueSig from "@flutter-signatures/AdjustEvent/setRevenue.mdx" - - - - - - - -import SetRevenue from "@flutter-examples/AdjustEvent/setRevenue.mdx" - - - - - - - -`amount` (double): The amount of currency units associated with the event. - -`currency` (String): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit. - - - - - - - -## transactionId - -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 TransactionIdSig from "@flutter-signatures/AdjustEvent/transactionId.mdx" - - - - - - - -import TransactionId from "@flutter-examples/AdjustEvent/transactionId.mdx" - - - - - - - -`transactionId` (String): A unique identifier used to deduplicate events. - - - - - - - -## callbackId - -Sets a custom identifier for your event object. Adjust's servers can report on this identifier in event callbacks. - - - -import CallbackIdSig from "@flutter-signatures/AdjustEvent/callbackId.mdx" - - - - - - - -import CallbackId from "@flutter-examples/AdjustEvent/callbackId.mdx" - - - - - - - -`callbackId` (String): A custom identifier for your event object. - - - - - - - -## addCallbackParameter - -Adds key-value information to send to your callback URL. - - - -import AddCallbackParameterSig from "@flutter-signatures/AdjustEvent/addCallbackParameter.mdx" - - - - - - - -import AddCallbackParameter from "@flutter-examples/AdjustEvent/addCallbackParameter.mdx" - - - - - - - -`key` (String): The data key. - -`value` (String): The data value. - - - - - - - -## addPartnerParameter - -Adds key-value information to share with partners. - - - -import AddPartnerParameterSig from "@flutter-signatures/AdjustEvent/addPartnerParameter.mdx" - - - - - - - -import AddPartnerParameter from "@flutter-examples/AdjustEvent/addPartnerParameter.mdx" - - - - - - - -`key` (String): The data key. - -`value` (String): The data value. - - - - diff --git a/src/content/docs/sdk/flutter/reference/adjustplaystoresubscription.mdx b/src/content/docs/sdk/flutter/reference/adjustplaystoresubscription.mdx deleted file mode 100644 index c7ebe51fe..000000000 --- a/src/content/docs/sdk/flutter/reference/adjustplaystoresubscription.mdx +++ /dev/null @@ -1,145 +0,0 @@ ---- -title: AdjustPlayStoreSubscription class -description: Use this class to store Play Store subscription information. -category-title: AdjustPlayStoreSubscription class -slug: en/sdk/flutter/reference/adjustplaystoresubscription ---- - -import TrackPlayStoreSubscription from "@flutter-signatures/Adjust/trackPlayStoreSubscription.mdx" - -Use this class to store Play Store subscription information. You can pass this to Adjust's servers using the `trackPlayStoreSubscription` method. - - - -## Constructor - -Instantiates a subscription object. - - - -import ConstructorSig from "@flutter-signatures/AdjustPlayStoreSubscription/constructor.mdx" - - - - - - - -import Constructor from "@flutter-examples/AdjustPlayStoreSubscription/constructor.mdx" - - - - - - - -`price` (String): 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 - -`sku` (String): The ID of the product. - -`orderId` (String): Your ID for the transaction. - -`signature` (String): The signature of the purchase data. - -`purchaseToken` (String): The unique token of the transaction. See [Google's documentation](https://developer.android.com/reference/com/android/billingclient/api/Purchase#getPurchaseToken()) for more information. - - - - - - - -## setPurchaseTime - -Sets the date of the transaction in the subscription object. - - - -import SetPurchaseTimeSig from "@flutter-signatures/AdjustPlayStoreSubscription/setPurchaseTime.mdx" - - - - - - - -import SetPurchaseTime from "@flutter-examples/AdjustPlayStoreSubscription/setPurchaseTime.mdx" - - - - - - - -`purchaseTime` (String): The date on which the subscription was purchased. - - - - - - - -## addCallbackParameter - -Adds key-value callback parameters to the subscription object. You can add multiple parameters by calling this method multiple times. - - - -import AddCallbackParameterSig from "@flutter-signatures/AdjustPlayStoreSubscription/addCallbackParameter.mdx" - - - - - - - - -import AddCallbackParameter from "@flutter-examples/AdjustPlayStoreSubscription/addCallbackParameter.mdx" - - - - - - - -`key` (String): The data key. - -`value` (String): The data value. - - - - - - - -## addPartnerParameter - -Adds key-value callback parameters to the subscription object. You can add multiple parameters by calling this method multiple times. - - - -import AddPartnerParameterSig from "@flutter-signatures/AdjustPlayStoreSubscription/addPartnerParameter.mdx" - - - - - - - -import AddPartnerParameter from "@flutter-examples/AdjustPlayStoreSubscription/addPartnerParameter.mdx" - - - - - - - -`key` (String): The data key. - -`value` (String): The data value. - - - - diff --git a/src/content/docs/sdk/flutter/reference/adjustthirdpartysharing.mdx b/src/content/docs/sdk/flutter/reference/adjustthirdpartysharing.mdx deleted file mode 100644 index 02e0b2c9b..000000000 --- a/src/content/docs/sdk/flutter/reference/adjustthirdpartysharing.mdx +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: AdjustThirdPartySharing class -description: Use this class to communicate a user's third party sharing preferences. -category-title: AdjustThirdPartySharing class -slug: en/sdk/flutter/reference/adjustthirdpartysharing ---- - -import TrackThirdPartySharing from "@flutter-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 - -Instantiates a third party sharing object with a **nullable boolean** value. - - - -import Constructor from "@flutter-signatures/AdjustThirdPartySharing/constructor.mdx"; - - - - - - - -import InitTrue from "@flutter-examples/AdjustThirdPartySharing/constructor_true.mdx"; - - - - - - - -`isEnabled` (bool): Whether third party sharing is enabled. - - - - - - - -## 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 "@flutter-signatures/AdjustThirdPartySharing/addGranularOption.mdx" - - - - - - - -import AddGranularOption from "@flutter-examples/AdjustThirdPartySharing/addGranularOption.mdx"; - - - -You can use this method to toggle Facebook data processing options. - -import Facebook from "@flutter-examples/AdjustThirdPartySharing/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` (String): The name of the partner you want to share information with. - -`key` (String): The data key. - -`value` (String): 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 "@flutter-signatures/AdjustThirdPartySharing/addPartnerSharingSetting.mdx"; - - - - - - - -import AddPartnerSharingSetting from "@flutter-examples/AdjustThirdPartySharing/addPartnerSharingSetting.mdx"; - - - - - - - -`partnerName` (String): The name of the partner whose settings you want to update. See the table of available partners below. - -`key` (String): 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/flutter/reference/index.mdx b/src/content/docs/sdk/flutter/reference/index.mdx deleted file mode 100644 index 00d63ee4f..000000000 --- a/src/content/docs/sdk/flutter/reference/index.mdx +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: SDK reference -description: SDK reference information for the Flutter SDK -category-title: Reference -slug: en/sdk/flutter/reference -type: category ---- From d553c81c29204b80ff7a543a343a3ab0fa84c8ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Fri, 23 Feb 2024 16:48:15 +0100 Subject: [PATCH 3/8] Update Web SDK --- .../Adjust/addGlobalCallbackParameters.mdx | 6 - .../Adjust/addGlobalPartnerParameters.mdx | 6 - .../Adjust/clearGlobalCallbackParameters.mdx | 3 - .../Adjust/clearGlobalPartnerParameters.mdx | 3 - .../Adjust/disableThirdPartySharing.mdx | 3 - .../web/examples/Adjust/gdprForgetMe.mdx | 3 - .../web/examples/Adjust/getAttribution.mdx | 3 - .../web/examples/Adjust/getWebUUID.mdx | 3 - .../web/examples/Adjust/initSdk.mdx | 6 - .../Adjust/removeGlobalCallbackParameter.mdx | 3 - .../Adjust/removeGlobalPartnerParameter.mdx | 3 - .../web/examples/Adjust/restart.mdx | 3 - .../web/examples/Adjust/setReferrer.mdx | 3 - .../web/examples/Adjust/stop.mdx | 3 - .../Adjust/switchBackToOnlineMode.mdx | 3 - .../examples/Adjust/switchToOfflineMode.mdx | 3 - .../web/examples/Adjust/trackEvent.mdx | 5 - .../Adjust/addGlobalCallbackParameters.mdx | 3 - .../Adjust/addGlobalPartnerParameters.mdx | 3 - .../Adjust/clearGlobalCallbackParameters.mdx | 3 - .../Adjust/clearGlobalPartnerParameters.mdx | 3 - .../Adjust/disableThirdPartySharing.mdx | 3 - .../web/signatures/Adjust/gdprForgetMe.mdx | 3 - .../web/signatures/Adjust/getAttribution.mdx | 3 - .../web/signatures/Adjust/getWebUUID.mdx | 3 - .../web/signatures/Adjust/initSdk.mdx | 3 - .../Adjust/removeGlobalCallbackParameter.mdx | 3 - .../Adjust/removeGlobalPartnerParameter.mdx | 3 - .../web/signatures/Adjust/restart.mdx | 3 - .../web/signatures/Adjust/setReferrer.mdx | 3 - .../web/signatures/Adjust/stop.mdx | 3 - .../Adjust/switchBackToOnlineMode.mdx | 3 - .../signatures/Adjust/switchToOfflineMode.mdx | 3 - .../web/signatures/Adjust/trackEvent.mdx | 5 - src/content/docs/sdk/web/configuration.mdx | 228 +++++++++++++ .../web/configuration/default-campaign.mdx | 25 -- .../docs/sdk/web/configuration/delay.mdx | 25 -- .../docs/sdk/web/configuration/disable.mdx | 41 --- .../web/configuration/external-device-id.mdx | 29 -- .../docs/sdk/web/configuration/index.mdx | 9 - .../docs/sdk/web/configuration/log-level.mdx | 43 --- .../docs/sdk/web/configuration/namespace.mdx | 27 -- .../docs/sdk/web/configuration/referrer.mdx | 20 -- .../docs/sdk/web/features/attribution.mdx | 118 +++---- .../docs/sdk/web/features/device-info.mdx | 15 +- src/content/docs/sdk/web/features/events.mdx | 315 ++++++++++-------- .../docs/sdk/web/features/global-params.mdx | 82 +++-- src/content/docs/sdk/web/features/index.mdx | 1 + .../{configuration => features}/privacy.mdx | 70 ++-- src/content/docs/sdk/web/index.mdx | 18 +- .../docs/sdk/web/reference/adjust/config.mdx | 192 ----------- .../sdk/web/reference/adjust/device-info.mdx | 35 -- .../docs/sdk/web/reference/adjust/index.mdx | 9 - .../docs/sdk/web/reference/adjust/privacy.mdx | 55 --- .../sdk/web/reference/adjust/recording.mdx | 297 ----------------- src/content/docs/sdk/web/reference/index.mdx | 7 - 56 files changed, 597 insertions(+), 1179 deletions(-) delete mode 100644 src/code-snippets/web/examples/Adjust/addGlobalCallbackParameters.mdx delete mode 100644 src/code-snippets/web/examples/Adjust/addGlobalPartnerParameters.mdx delete mode 100644 src/code-snippets/web/examples/Adjust/clearGlobalCallbackParameters.mdx delete mode 100644 src/code-snippets/web/examples/Adjust/clearGlobalPartnerParameters.mdx delete mode 100644 src/code-snippets/web/examples/Adjust/disableThirdPartySharing.mdx delete mode 100644 src/code-snippets/web/examples/Adjust/gdprForgetMe.mdx delete mode 100644 src/code-snippets/web/examples/Adjust/getAttribution.mdx delete mode 100644 src/code-snippets/web/examples/Adjust/getWebUUID.mdx delete mode 100644 src/code-snippets/web/examples/Adjust/initSdk.mdx delete mode 100644 src/code-snippets/web/examples/Adjust/removeGlobalCallbackParameter.mdx delete mode 100644 src/code-snippets/web/examples/Adjust/removeGlobalPartnerParameter.mdx delete mode 100644 src/code-snippets/web/examples/Adjust/restart.mdx delete mode 100644 src/code-snippets/web/examples/Adjust/setReferrer.mdx delete mode 100644 src/code-snippets/web/examples/Adjust/stop.mdx delete mode 100644 src/code-snippets/web/examples/Adjust/switchBackToOnlineMode.mdx delete mode 100644 src/code-snippets/web/examples/Adjust/switchToOfflineMode.mdx delete mode 100644 src/code-snippets/web/examples/Adjust/trackEvent.mdx delete mode 100644 src/code-snippets/web/signatures/Adjust/addGlobalCallbackParameters.mdx delete mode 100644 src/code-snippets/web/signatures/Adjust/addGlobalPartnerParameters.mdx delete mode 100644 src/code-snippets/web/signatures/Adjust/clearGlobalCallbackParameters.mdx delete mode 100644 src/code-snippets/web/signatures/Adjust/clearGlobalPartnerParameters.mdx delete mode 100644 src/code-snippets/web/signatures/Adjust/disableThirdPartySharing.mdx delete mode 100644 src/code-snippets/web/signatures/Adjust/gdprForgetMe.mdx delete mode 100644 src/code-snippets/web/signatures/Adjust/getAttribution.mdx delete mode 100644 src/code-snippets/web/signatures/Adjust/getWebUUID.mdx delete mode 100644 src/code-snippets/web/signatures/Adjust/initSdk.mdx delete mode 100644 src/code-snippets/web/signatures/Adjust/removeGlobalCallbackParameter.mdx delete mode 100644 src/code-snippets/web/signatures/Adjust/removeGlobalPartnerParameter.mdx delete mode 100644 src/code-snippets/web/signatures/Adjust/restart.mdx delete mode 100644 src/code-snippets/web/signatures/Adjust/setReferrer.mdx delete mode 100644 src/code-snippets/web/signatures/Adjust/stop.mdx delete mode 100644 src/code-snippets/web/signatures/Adjust/switchBackToOnlineMode.mdx delete mode 100644 src/code-snippets/web/signatures/Adjust/switchToOfflineMode.mdx delete mode 100644 src/code-snippets/web/signatures/Adjust/trackEvent.mdx create mode 100644 src/content/docs/sdk/web/configuration.mdx delete mode 100644 src/content/docs/sdk/web/configuration/default-campaign.mdx delete mode 100644 src/content/docs/sdk/web/configuration/delay.mdx delete mode 100644 src/content/docs/sdk/web/configuration/disable.mdx delete mode 100644 src/content/docs/sdk/web/configuration/external-device-id.mdx delete mode 100644 src/content/docs/sdk/web/configuration/index.mdx delete mode 100644 src/content/docs/sdk/web/configuration/log-level.mdx delete mode 100644 src/content/docs/sdk/web/configuration/namespace.mdx delete mode 100644 src/content/docs/sdk/web/configuration/referrer.mdx rename src/content/docs/sdk/web/{configuration => features}/privacy.mdx (64%) delete mode 100644 src/content/docs/sdk/web/reference/adjust/config.mdx delete mode 100644 src/content/docs/sdk/web/reference/adjust/device-info.mdx delete mode 100644 src/content/docs/sdk/web/reference/adjust/index.mdx delete mode 100644 src/content/docs/sdk/web/reference/adjust/privacy.mdx delete mode 100644 src/content/docs/sdk/web/reference/adjust/recording.mdx delete mode 100644 src/content/docs/sdk/web/reference/index.mdx diff --git a/src/code-snippets/web/examples/Adjust/addGlobalCallbackParameters.mdx b/src/code-snippets/web/examples/Adjust/addGlobalCallbackParameters.mdx deleted file mode 100644 index b198943fa..000000000 --- a/src/code-snippets/web/examples/Adjust/addGlobalCallbackParameters.mdx +++ /dev/null @@ -1,6 +0,0 @@ -```js -Adjust.addGlobalCallbackParameters([ - {key: 'key1', value: 'value1'}, - {key: 'key2', value: 'value2'} -]); -``` diff --git a/src/code-snippets/web/examples/Adjust/addGlobalPartnerParameters.mdx b/src/code-snippets/web/examples/Adjust/addGlobalPartnerParameters.mdx deleted file mode 100644 index 91e37542e..000000000 --- a/src/code-snippets/web/examples/Adjust/addGlobalPartnerParameters.mdx +++ /dev/null @@ -1,6 +0,0 @@ -```js -Adjust.addGlobalPartnerParameters([ - {key: 'key1', value: 'value1'}, - {key: 'key2', value: 'value2'} -]); -``` diff --git a/src/code-snippets/web/examples/Adjust/clearGlobalCallbackParameters.mdx b/src/code-snippets/web/examples/Adjust/clearGlobalCallbackParameters.mdx deleted file mode 100644 index 4d0d8fe62..000000000 --- a/src/code-snippets/web/examples/Adjust/clearGlobalCallbackParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```js -Adjust.clearGlobalCallbackParameters(); -``` diff --git a/src/code-snippets/web/examples/Adjust/clearGlobalPartnerParameters.mdx b/src/code-snippets/web/examples/Adjust/clearGlobalPartnerParameters.mdx deleted file mode 100644 index ddc64568b..000000000 --- a/src/code-snippets/web/examples/Adjust/clearGlobalPartnerParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```js -Adjust.clearGlobalPartnerParameters(); -``` diff --git a/src/code-snippets/web/examples/Adjust/disableThirdPartySharing.mdx b/src/code-snippets/web/examples/Adjust/disableThirdPartySharing.mdx deleted file mode 100644 index 8f172367e..000000000 --- a/src/code-snippets/web/examples/Adjust/disableThirdPartySharing.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```js -Adjust.disableThirdPartySharing(); -``` diff --git a/src/code-snippets/web/examples/Adjust/gdprForgetMe.mdx b/src/code-snippets/web/examples/Adjust/gdprForgetMe.mdx deleted file mode 100644 index 5b84b5950..000000000 --- a/src/code-snippets/web/examples/Adjust/gdprForgetMe.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```js -Adjust.gdprForgetMe(); -``` diff --git a/src/code-snippets/web/examples/Adjust/getAttribution.mdx b/src/code-snippets/web/examples/Adjust/getAttribution.mdx deleted file mode 100644 index d6914510a..000000000 --- a/src/code-snippets/web/examples/Adjust/getAttribution.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```js -const attribution = Adjust.getAttribution(); -``` diff --git a/src/code-snippets/web/examples/Adjust/getWebUUID.mdx b/src/code-snippets/web/examples/Adjust/getWebUUID.mdx deleted file mode 100644 index 2e8a0dd2d..000000000 --- a/src/code-snippets/web/examples/Adjust/getWebUUID.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```js -const webUUID = Adjust.getWebUUID(); -``` diff --git a/src/code-snippets/web/examples/Adjust/initSdk.mdx b/src/code-snippets/web/examples/Adjust/initSdk.mdx deleted file mode 100644 index 1dc27a5aa..000000000 --- a/src/code-snippets/web/examples/Adjust/initSdk.mdx +++ /dev/null @@ -1,6 +0,0 @@ -```js -Adjust.initSdk({ - appToken: 'YOUR_APP_TOKEN', - environment: 'sandbox' -}); -``` diff --git a/src/code-snippets/web/examples/Adjust/removeGlobalCallbackParameter.mdx b/src/code-snippets/web/examples/Adjust/removeGlobalCallbackParameter.mdx deleted file mode 100644 index 24e855e66..000000000 --- a/src/code-snippets/web/examples/Adjust/removeGlobalCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```js -Adjust.removeGlobalCallbackParameter('key1'); -``` diff --git a/src/code-snippets/web/examples/Adjust/removeGlobalPartnerParameter.mdx b/src/code-snippets/web/examples/Adjust/removeGlobalPartnerParameter.mdx deleted file mode 100644 index a30e130a0..000000000 --- a/src/code-snippets/web/examples/Adjust/removeGlobalPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```js -Adjust.removeGlobalPartnerParameter('key1'); -``` diff --git a/src/code-snippets/web/examples/Adjust/restart.mdx b/src/code-snippets/web/examples/Adjust/restart.mdx deleted file mode 100644 index b24759b13..000000000 --- a/src/code-snippets/web/examples/Adjust/restart.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```js -Adjust.restart(); -``` diff --git a/src/code-snippets/web/examples/Adjust/setReferrer.mdx b/src/code-snippets/web/examples/Adjust/setReferrer.mdx deleted file mode 100644 index 3ca2e36b5..000000000 --- a/src/code-snippets/web/examples/Adjust/setReferrer.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```js -Adjust.setReferrer("adjust_external_click_id%3DEXTERNAL_CLICK_ID"); -``` diff --git a/src/code-snippets/web/examples/Adjust/stop.mdx b/src/code-snippets/web/examples/Adjust/stop.mdx deleted file mode 100644 index 45b2002f1..000000000 --- a/src/code-snippets/web/examples/Adjust/stop.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```js -Adjust.stop(); -``` diff --git a/src/code-snippets/web/examples/Adjust/switchBackToOnlineMode.mdx b/src/code-snippets/web/examples/Adjust/switchBackToOnlineMode.mdx deleted file mode 100644 index 61a870bdb..000000000 --- a/src/code-snippets/web/examples/Adjust/switchBackToOnlineMode.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```js -Adjust.switchBackToOnlineMode(); -``` diff --git a/src/code-snippets/web/examples/Adjust/switchToOfflineMode.mdx b/src/code-snippets/web/examples/Adjust/switchToOfflineMode.mdx deleted file mode 100644 index 1b771ff44..000000000 --- a/src/code-snippets/web/examples/Adjust/switchToOfflineMode.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```js -Adjust.switchToOfflineMode(); -``` diff --git a/src/code-snippets/web/examples/Adjust/trackEvent.mdx b/src/code-snippets/web/examples/Adjust/trackEvent.mdx deleted file mode 100644 index d14efbc56..000000000 --- a/src/code-snippets/web/examples/Adjust/trackEvent.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```js {2} -Adjust.trackEvent({ - eventToken: '{YourEventToken}' -}) -``` diff --git a/src/code-snippets/web/signatures/Adjust/addGlobalCallbackParameters.mdx b/src/code-snippets/web/signatures/Adjust/addGlobalCallbackParameters.mdx deleted file mode 100644 index 9a0b5d875..000000000 --- a/src/code-snippets/web/signatures/Adjust/addGlobalCallbackParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -function addGlobalCallbackParameters(params: Array): void -``` diff --git a/src/code-snippets/web/signatures/Adjust/addGlobalPartnerParameters.mdx b/src/code-snippets/web/signatures/Adjust/addGlobalPartnerParameters.mdx deleted file mode 100644 index e75ccfecf..000000000 --- a/src/code-snippets/web/signatures/Adjust/addGlobalPartnerParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -function addGlobalPartnerParameters(params: Array): void -``` diff --git a/src/code-snippets/web/signatures/Adjust/clearGlobalCallbackParameters.mdx b/src/code-snippets/web/signatures/Adjust/clearGlobalCallbackParameters.mdx deleted file mode 100644 index 76f4e0de0..000000000 --- a/src/code-snippets/web/signatures/Adjust/clearGlobalCallbackParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -function clearGlobalCallbackParameters(): void -``` diff --git a/src/code-snippets/web/signatures/Adjust/clearGlobalPartnerParameters.mdx b/src/code-snippets/web/signatures/Adjust/clearGlobalPartnerParameters.mdx deleted file mode 100644 index 27fc01b42..000000000 --- a/src/code-snippets/web/signatures/Adjust/clearGlobalPartnerParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -function clearGlobalPartnerParameters(): void -``` diff --git a/src/code-snippets/web/signatures/Adjust/disableThirdPartySharing.mdx b/src/code-snippets/web/signatures/Adjust/disableThirdPartySharing.mdx deleted file mode 100644 index 49b7d9975..000000000 --- a/src/code-snippets/web/signatures/Adjust/disableThirdPartySharing.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -function disableThirdPartySharing(): void -``` diff --git a/src/code-snippets/web/signatures/Adjust/gdprForgetMe.mdx b/src/code-snippets/web/signatures/Adjust/gdprForgetMe.mdx deleted file mode 100644 index 1128d3833..000000000 --- a/src/code-snippets/web/signatures/Adjust/gdprForgetMe.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -function gdprForgetMe(): void -``` diff --git a/src/code-snippets/web/signatures/Adjust/getAttribution.mdx b/src/code-snippets/web/signatures/Adjust/getAttribution.mdx deleted file mode 100644 index c8b411319..000000000 --- a/src/code-snippets/web/signatures/Adjust/getAttribution.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -function getAttribution(): Attribution | undefined -``` diff --git a/src/code-snippets/web/signatures/Adjust/getWebUUID.mdx b/src/code-snippets/web/signatures/Adjust/getWebUUID.mdx deleted file mode 100644 index 9b2b8f66e..000000000 --- a/src/code-snippets/web/signatures/Adjust/getWebUUID.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -function getWebUUID(): string | undefined -``` diff --git a/src/code-snippets/web/signatures/Adjust/initSdk.mdx b/src/code-snippets/web/signatures/Adjust/initSdk.mdx deleted file mode 100644 index 61f1dcc35..000000000 --- a/src/code-snippets/web/signatures/Adjust/initSdk.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -function initSdk({ logLevel, logOutput, ...options }: InitOptions): void -``` diff --git a/src/code-snippets/web/signatures/Adjust/removeGlobalCallbackParameter.mdx b/src/code-snippets/web/signatures/Adjust/removeGlobalCallbackParameter.mdx deleted file mode 100644 index c1e4d53a7..000000000 --- a/src/code-snippets/web/signatures/Adjust/removeGlobalCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```js -function removeGlobalCallbackParameter(key: string): void -``` diff --git a/src/code-snippets/web/signatures/Adjust/removeGlobalPartnerParameter.mdx b/src/code-snippets/web/signatures/Adjust/removeGlobalPartnerParameter.mdx deleted file mode 100644 index 80b4fce64..000000000 --- a/src/code-snippets/web/signatures/Adjust/removeGlobalPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -function removeGlobalPartnerParameter(key: string): void -``` diff --git a/src/code-snippets/web/signatures/Adjust/restart.mdx b/src/code-snippets/web/signatures/Adjust/restart.mdx deleted file mode 100644 index 84a4a5377..000000000 --- a/src/code-snippets/web/signatures/Adjust/restart.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -function restart(): void -``` diff --git a/src/code-snippets/web/signatures/Adjust/setReferrer.mdx b/src/code-snippets/web/signatures/Adjust/setReferrer.mdx deleted file mode 100644 index 0f2be3e99..000000000 --- a/src/code-snippets/web/signatures/Adjust/setReferrer.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -function setReferrer(referrer: string): void -``` diff --git a/src/code-snippets/web/signatures/Adjust/stop.mdx b/src/code-snippets/web/signatures/Adjust/stop.mdx deleted file mode 100644 index d0c00fdba..000000000 --- a/src/code-snippets/web/signatures/Adjust/stop.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -function stop(): void -``` diff --git a/src/code-snippets/web/signatures/Adjust/switchBackToOnlineMode.mdx b/src/code-snippets/web/signatures/Adjust/switchBackToOnlineMode.mdx deleted file mode 100644 index 4d1287638..000000000 --- a/src/code-snippets/web/signatures/Adjust/switchBackToOnlineMode.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -function switchBackToOnlineMode(): void -``` diff --git a/src/code-snippets/web/signatures/Adjust/switchToOfflineMode.mdx b/src/code-snippets/web/signatures/Adjust/switchToOfflineMode.mdx deleted file mode 100644 index 079ae5e4c..000000000 --- a/src/code-snippets/web/signatures/Adjust/switchToOfflineMode.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -function switchToOfflineMode(): void -``` diff --git a/src/code-snippets/web/signatures/Adjust/trackEvent.mdx b/src/code-snippets/web/signatures/Adjust/trackEvent.mdx deleted file mode 100644 index 066605223..000000000 --- a/src/code-snippets/web/signatures/Adjust/trackEvent.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```ts -function trackEvent (params: EventParamsT): Promise { - return _internalTrackEvent(params) -} -``` diff --git a/src/content/docs/sdk/web/configuration.mdx b/src/content/docs/sdk/web/configuration.mdx new file mode 100644 index 000000000..406598d79 --- /dev/null +++ b/src/content/docs/sdk/web/configuration.mdx @@ -0,0 +1,228 @@ +--- +title: Configuration +description: Follow the guides in this section to configure the Adjust SDK. +category-title: Configuration +slug: en/sdk/web/configuration +sidebar-position: 1 +--- + +You can configure the behavior of the Adjust SDK by assigning properties in the `Adjust.initSdk` method. + +## Required configuration + +```ts title="Method signature" +function initSdk({ logLevel, logOutput, ...options }: InitOptions): void; +``` + +To configure the Adjust SDK, you need to call the `Adjust.initSdk` method with the following arguments: + +- `appToken` (**String**): Your [Adjust app token](https://help.adjust.com/en/article/app-token-and-reporting-currency#view-your-app-details). +- `environment` (**String**): The environment you want to run the SDK in. Pass `sandbox` to run the SDK in sandbox mode for testing. Pass `production` to run the SDK in production mode for release. + +```js +Adjust.initSdk({ + appToken: "YOUR_APP_TOKEN", + environment: "sandbox", +}); +``` + +### Logging options + +```js title="Interface declaration" +export type LogOptionsT = $ReadOnly< + $Shape<{| + logLevel: "none" | "error" | "warning" | "info" | "verbose", + logOutput: string, + |}> +>; +``` + +The Adjust SDK provides configurable log levels to return different amounts of information. The following log levels are available: + + + +| Value | Description | +| --------- | -------------------------------------------- | +| `verbose` | Enable full logging | +| `info` | Return information, warnings, and error logs | +| `warning` | Return warnings and error logs | +| `error` | Return only error logs | +| `none` | Disable all logging | + +
+ +You can set the log level by specifying an `logLevel` argument in the `initSdk` method. The SDK defaults to `error` if no value is passed. + +```js {4} +Adjust.initSdk({ + appToken: "YOUR_APP_TOKEN", + environment: "sandbox", + logLevel: "verbose", +}); +``` + +#### Set log output + +You can delegate a log output location in your web app to show logs directly on the screen. To do this, specify an HTML selector in the `logOutput` argument in the `initSdk` method. The SDK logs will print to this container. + +```js {4} +Adjust.initSdk({ + appToken: "YOUR_APP_TOKEN", + environment: "sandbox", + logOutput: "#logDiv", +}); +``` + +## Initialization options + +```js title="Interface declaration" +export type InitOptionsT = $ReadOnly< + $Shape<{| + appToken: $PropertyType, + environment: $PropertyType, + defaultTracker: $PropertyType, + externalDeviceId: $PropertyType, + customUrl: $PropertyType, + dataResidency: $PropertyType, + urlStrategy: $PropertyType, + eventDeduplicationListLimit: $PropertyType< + CustomConfigT, + "eventDeduplicationListLimit" + >, + namespace: $PropertyType, + attributionCallback: (string, Object) => mixed, + |}> +>; +``` + +### Set external device identifier + +```js title="Property declaration" +externalDeviceId: string; +``` + +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. Pass your external device ID as the `externalDeviceId` argument in your `Adjust.initSdk` call. + + + +See the [External device identifiers article](https://help.adjust.com/en/article/external-device-identifiers) in the Adjust help center for more information. + + + +```js {4} +Adjust.initSdk({ + appToken: "YOUR_APP_TOKEN", + environment: "sandbox", + externalDeviceId: "YOUR_EXTERNAL_DEVICE_ID", +}); +``` + +If you want to use the external device ID in your business analytics, you can pass it as a [session callback parameter](/en/sdk/web/features/global-params). + +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 + +```js title="Property declaration" +defaultTracker: string; +``` + +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. Pass your token in the `defaultTracker` argument of your `Adjust.initSdk` call. + +```js {4} +Adjust.initSdk({ + appToken: "YOUR_APP_TOKEN", + environment: "sandbox", + defaultTracker: "YOUR_LINK_TOKEN", +}); +``` + +### Set storage namespace + +```js title="Property declaration" +namespace: string; +``` + +The Adjust SDK creates a storage namespace to store data in by default. You can override this an specify a custom namespace if you want to control where the data ends up. + +Any data that the SDK has stored in the default namespace will be moved the custom namespace when it's set. + + + +Don't change your custom namespace after you set it. Information stored in the custom namespace **won't** be moved to the new namespace. + + + +You can set an custom namespace by specifying a `namespace` property in the `initSdk` method. + +```js {4} +Adjust.initSdk({ + appToken: "YOUR_APP_TOKEN", + environment: "sandbox", + namespace: "myCustomNamespace", +}); +``` + +## 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 + +```js title="Method signature" +function switchToOfflineMode(): void; +``` + + + +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 the browser's IndexedDB, or in localStorage if IndexedDB isn't supported. + +You can toggle offline mode at any time by calling the `switchToOfflineMode` method with the following argument: + +```js +Adjust.switchToOfflineMode(); +``` + +#### Event buffering + +```js title="Method signature" +function switchBackToOnlineMode(): void; +``` + +The SDK sends all saved information to Adjust's servers when you disable offline mode. To do this, call the `switchBackToOnlineMode` method. + +```js +Adjust.switchBackToOnlineMode(); +``` + +### Disable the SDK + +```js +function stop(): void; +``` + +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 disable the SDK at any time by calling the `stop` method. + +```js +Adjust.stop(); +``` + +### Reenable the SDK + +```js +function restart(): void; +``` + +You can restart the SDK at any time by calling the `restart` method. + +```js +Adjust.restart(); +``` diff --git a/src/content/docs/sdk/web/configuration/default-campaign.mdx b/src/content/docs/sdk/web/configuration/default-campaign.mdx deleted file mode 100644 index dca0b1ef2..000000000 --- a/src/content/docs/sdk/web/configuration/default-campaign.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Set a default campaign -description: Configuring a default campaign enables you to attribute all preinstalls to a predefined campaign token. -slug: en/sdk/web/configuration/default-campaign ---- - -import InitSdk from "@web-signatures/Adjust/initSdk.mdx" - -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 campaign link in the Adjust Suite. - -```text "{token}" -https://app.adjust.com/{token} -``` - -2. Pass your campaign token to the `initSdk` method in the `defaultTracker` argument. - -```js -Adjust.initSdk({ - appToken: 'YOUR_APP_TOKEN', - environment: 'sandbox', - defaultTracker: '{token}' -}); -``` diff --git a/src/content/docs/sdk/web/configuration/delay.mdx b/src/content/docs/sdk/web/configuration/delay.mdx deleted file mode 100644 index 11159e296..000000000 --- a/src/content/docs/sdk/web/configuration/delay.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Delay recording -description: Configure the SDK to delay the sending of information to Adjust's servers. -slug: en/sdk/web/configuration/delay ---- - -import SwitchToOfflineMode from "@web-examples/Adjust/switchToOfflineMode.mdx" -import SwitchBackToOnlineMode from "@web-examples/Adjust/switchBackToOnlineMode.mdx" -import SwitchBackToOnlineModeSig from "@web-signatures/Adjust/switchBackToOnlineMode.mdx" - - - -The first session always sends data to Adjust's servers even if offline mode is enabled. - - - -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 the browser's IndexedDB, or in localStorage if IndexedDB isn't supported. - - - -## Event buffering - -The SDK sends all saved information to Adjust's servers when you disable offline mode. To do this, call the `switchBackToOnlineMode` method. - - diff --git a/src/content/docs/sdk/web/configuration/disable.mdx b/src/content/docs/sdk/web/configuration/disable.mdx deleted file mode 100644 index c387a8d74..000000000 --- a/src/content/docs/sdk/web/configuration/disable.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Disable the Adjust SDK -description: Disable the Adjust SDK to pause recording. -slug: en/sdk/web/configuration/disable ---- - -import Stop from "@web-examples/Adjust/stop.mdx" -import StopSig from "@web-signatures/Adjust/stop.mdx" -import Restart from "@web-examples/Adjust/restart.mdx" -import RestartSig from "@web-signatures/Adjust/restart.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 disable the SDK at any time by calling the `stop` method. - - - -You can restart the SDK at any time by calling the `restart` method. - - - -## Example - -This example shows how to stop and restart the Adjust SDK using buttons in the UI. - -```html - - - - - -
-
- -
-
- -
-
- -``` diff --git a/src/content/docs/sdk/web/configuration/external-device-id.mdx b/src/content/docs/sdk/web/configuration/external-device-id.mdx deleted file mode 100644 index 92fad4722..000000000 --- a/src/content/docs/sdk/web/configuration/external-device-id.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Set external device identifiers -description: Configure an external device ID as a custom identifier for a device. -slug: en/sdk/web/configuration/external-device-id ---- - -import InitSdk from "@web-signatures/Adjust/initSdk.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. - - - -You can set an external device ID by specifying an `externalDeviceId` argument in the `initSdk` method. The external device ID is case-sensitive. If you have imported external device IDs, make sure the value you pass matches the imported value. - -```js -Adjust.initSdk({ - appToken: 'YOUR_APP_TOKEN', - environment: 'sandbox', - externalDeviceId: 'YOUR_EXTERNAL_DEVICE_ID' -}); -``` - -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/web/configuration/index.mdx b/src/content/docs/sdk/web/configuration/index.mdx deleted file mode 100644 index 617477d3c..000000000 --- a/src/content/docs/sdk/web/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/web/configuration -type: category ---- - -Follow the guides in this section to configure the Adjust SDK. diff --git a/src/content/docs/sdk/web/configuration/log-level.mdx b/src/content/docs/sdk/web/configuration/log-level.mdx deleted file mode 100644 index cb1b60fb9..000000000 --- a/src/content/docs/sdk/web/configuration/log-level.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Set log level -description: Configure the Adjust SDK's logging verbosity. -slug: en/sdk/web/configuration/log-level ---- - -import InitSdk from "@web-signatures/Adjust/initSdk.mdx" - -The Adjust SDK provides configurable log levels to return different amounts of information. The following log levels are available: - - - -| Value | Description | -| --------- | -------------------------------------------- | -| `verbose` | Enable full logging | -| `info` | Return information, warnings, and error logs | -| `warning` | Return warnings and error logs | -| `error` | Return only error logs | -| `none` | Disable all logging | - -
- -You can set the log level by specifying an `logLevel` argument in the `initSdk` method. The SDK defaults to `error` if no value is passed. - -```js {4} -Adjust.initSdk({ - appToken: "YOUR_APP_TOKEN", - environment: "sandbox", - logLevel: "verbose", -}); -``` - -## Set log output - -You can delegate a log output location in your web app to show logs directly on the screen. To do this, specify an HTML selector in the `logOutput` argument in the `initSdk` method. The SDK logs will print to this container. - -```js {4} -Adjust.initSdk({ - appToken: "YOUR_APP_TOKEN", - environment: "sandbox", - logOutput: "#logDiv", -}); -``` diff --git a/src/content/docs/sdk/web/configuration/namespace.mdx b/src/content/docs/sdk/web/configuration/namespace.mdx deleted file mode 100644 index e9800fe8f..000000000 --- a/src/content/docs/sdk/web/configuration/namespace.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Set a custom storage namespace -description: Override the default storage namespace. -slug: en/sdk/web/configuration/namespace ---- - -import InitSdk from "@web-signatures/Adjust/initSdk.mdx" - -The Adjust SDK creates a storage namespace to store data in by default. You can override this an specify a custom namespace if you want to control where the data ends up. - -Any data that the SDK has stored in the default namespace will be moved the custom namespace when it's set. - - - -If you set a custom namespace this value shouldn't be changed. If you change to another custom namespace, the data won't be moved. - - - -You can set an custom namespace by specifying a `namespace` property in the `initSdk` method. - -```js {4} -Adjust.initSdk({ - appToken: 'YOUR_APP_TOKEN', - environment: 'sandbox', - namespace: 'myCustomNamespace' -}); -``` diff --git a/src/content/docs/sdk/web/configuration/referrer.mdx b/src/content/docs/sdk/web/configuration/referrer.mdx deleted file mode 100644 index bd7a41eea..000000000 --- a/src/content/docs/sdk/web/configuration/referrer.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Set a referrer -description: You can set a referrer to trigger an SDK click with a custom click ID when the SDK starts. -slug: en/sdk/web/configuration/referrer ---- - -import SetReferrer from "@web-examples/Adjust/setReferrer.mdx" -import SetReferrerSig from "@web-signatures/Adjust/setReferrer.mdx" - -You can set a referrer to trigger an SDK click with a custom click ID when the SDK starts. The SDK sends your custom click ID to Adjust's servers for attribution purposes. - - - -Call this method as close to initializing the SDK as possible to ensure your referrer is used for attribution. - - - -To set your referrer, call the `setReferrer` method and pass your referrer as a URL-encoded **string** argument. - - diff --git a/src/content/docs/sdk/web/features/attribution.mdx b/src/content/docs/sdk/web/features/attribution.mdx index 8ca94a78a..1b4a7789c 100644 --- a/src/content/docs/sdk/web/features/attribution.mdx +++ b/src/content/docs/sdk/web/features/attribution.mdx @@ -4,38 +4,11 @@ description: Listen for attribution changes using the Adjust SDK slug: en/sdk/web/features/attribution --- -import InitSdk from "@web-signatures/Adjust/initSdk.mdx" -import GetAttribution from "@web-signatures/Adjust/getAttribution.mdx" - -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. - -You can set an attribution callback method by specifying an `attributionCallback` function in the `initSdk` method. - -```js -Adjust.initSdk({ - appToken: 'YOUR_APP_TOKEN', - environment: 'sandbox', - attributionCallback: function (e, attribution){ - console.log('Adid: ' + attribution.adid); - console.log('Tracker Token: ' + attribution.tracker_token); - console.log('Tracker Name: ' + attribution.tracker_name); - console.log('Network: ' + attribution.network); - console.log('Campaign: ' + attribution.campaign); - console.log('Adgroup: ' + attribution.adgroup); - console.log('Creative: ' + attribution.creative); - console.log('Click Label: ' + attribution.click_label); - console.log('Attribution State: ' + attribution.state); - } -}); -``` - -Within your function, you have access to the user's attribution information. - - +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 an Attribution object. The Attribution object contains the following information: -```js +```js title="Interface declaration" export type AttributionMapT = $ReadOnly<{| adid: string, tracker_token: string, @@ -49,45 +22,76 @@ export type AttributionMapT = $ReadOnly<{| |}>; ``` -`adid` (string): The device's unique Adjust identifier. + -`tracker_token` (string): The campaign token associated with the attribution. +| Values | Data type | Description | +| --------------- | --------- | --------------------------------------------------------------------------------------------------- | +| `adid` | String | The device's unique Adjust identifier. | +| `tracker_token` | String | The campaign token associated with the attribution. | +| `tracker_name` | String | The name of the campaign link. | +| `network` | String | The network associate with the campaign. | +| `campaign` | String | The name of the campaign associated with the attribution. | +| `adgroup` | String | The adgroup associated with the attribution. | +| `creative` | String | The creative associated with the attribution. | +| `click_label` | String | The [click label](https://help.adjust.com/en/article/user-rewards) associated with the attribution. | +| `state` | String | The current state of the attribution. Either `installed` or `reattributed` | -`tracker_name` (string): The name of the campaign link. +
-`network` (string): The network associate with the campaign. +## Trigger a callback when attribution changes -`campaign` (string): The name of the campaign associated with the attribution. +```js title="Property declaration" +attributionCallback: (string, Object) => mixed; +``` -`adgroup` (string): The adgroup associated with the attribution. +The SDK can listen for attribution changes and call a function when it detects an update. You can set an attribution callback method by specifying an `attributionCallback` function in the `initSdk` method. Within your function, you have access to the user's attribution information. -`creative` (string): The creative associated with the attribution. +```js +Adjust.initSdk({ + appToken: "YOUR_APP_TOKEN", + environment: "sandbox", + attributionCallback: function (e, attribution) { + console.log("Adid: " + attribution.adid); + console.log("Tracker Token: " + attribution.tracker_token); + console.log("Tracker Name: " + attribution.tracker_name); + console.log("Network: " + attribution.network); + console.log("Campaign: " + attribution.campaign); + console.log("Adgroup: " + attribution.adgroup); + console.log("Creative: " + attribution.creative); + console.log("Click Label: " + attribution.click_label); + console.log("Attribution State: " + attribution.state); + }, +}); +``` -`click_label` (string): The [click label](https://help.adjust.com/en/article/user-rewards) associated with the attribution. +## Get current attribution information -`state` (string): The current state of the attribution. Either `installed` or `reattributed` +```js title="Method signature" +function getAttribution(): Attribution | undefined; +``` +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 `getAttribution` method. - +```js +const attribution = Adjust.getAttribution(); +``` -## Get current attribution information +## Set a referrer -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 `getAttribution` method. +```js title="Method signature" +function setReferrer(referrer: string): void; +``` -```js -Adjust.initSdk({ - appToken: 'YOUR_APP_TOKEN', - environment: 'sandbox', - attributionCallback: function (e, attribution){ - console.log('Adid: ' + attribution.adid); - console.log('Tracker Token: ' + attribution.tracker_token); - console.log('Tracker Name: ' + attribution.tracker_name); - console.log('Network: ' + attribution.network); - console.log('Campaign: ' + attribution.campaign); - console.log('Adgroup: ' + attribution.adgroup); - console.log('Creative: ' + attribution.creative); - console.log('Click Label: ' + attribution.click_label); - console.log('Atribution State: ' + attribution.state); - } -}); +You can set a referrer to trigger an SDK click with a custom click ID when the SDK starts. The SDK sends your custom click ID to Adjust's servers for attribution purposes. + + + +Call this method as close to initializing the SDK as possible to ensure your referrer is used for attribution. + + + +To set your referrer, call the `setReferrer` method and pass your referrer as a URL-encoded **string** argument. + +```js '"adjust_external_click_id%3DEXTERNAL_CLICK_ID"' +Adjust.setReferrer("adjust_external_click_id%3DEXTERNAL_CLICK_ID"); ``` diff --git a/src/content/docs/sdk/web/features/device-info.mdx b/src/content/docs/sdk/web/features/device-info.mdx index ff9b443ce..b7a499af8 100644 --- a/src/content/docs/sdk/web/features/device-info.mdx +++ b/src/content/docs/sdk/web/features/device-info.mdx @@ -4,15 +4,18 @@ description: Use these methods to add details to your callbacks and improve your slug: en/sdk/web/features/device-info --- -import GetWebUUID from "@web-examples/Adjust/getWebUUID.mdx" -import GetWebUUIDSig from "@web-signatures/Adjust/getWebUUID.mdx" - The Adjust SDK contains helper methods that return device information. Use these methods to add details to your callbacks and improve your reporting. -## Web ID +## Web UUID + +```js title="Method signature" +function getWebUUID(): string | undefined; +``` -To identify web users in Adjust, Web SDK generates a unique `web_uuid` when it tracks the first session. The ID is created per subdomain and per browser. The identifier follows the UUID (Universally Unique Identifier) format. +To identify web users in Adjust, Web SDK generates a unique `web_uuid` when it tracks the first session. The ID is created per subdomain and per browser. The identifier follows the Universally Unique Identifier (UUID) format. Call the `getWebUUID` method to return this information as a **string**. - +```js +const webUUID = Adjust.getWebUUID(); +``` diff --git a/src/content/docs/sdk/web/features/events.mdx b/src/content/docs/sdk/web/features/events.mdx index deb34b5a3..e2b40fc7c 100644 --- a/src/content/docs/sdk/web/features/events.mdx +++ b/src/content/docs/sdk/web/features/events.mdx @@ -4,58 +4,69 @@ description: Use these methods send event information to Adjust. slug: en/sdk/web/features/events --- -import InitSdk from "@web-signatures/Adjust/initSdk.mdx" -import TrackEvent from "@web-examples/Adjust/trackEvent.mdx" -import TrackEventSig from "@web-signatures/Adjust/trackEvent.mdx" +The Adjust SDK provides an event interface which can be used to structure and send event information from your app to Adjust's servers. + +```js title="Interface declaration" +export type EventParamsT = {| + eventToken: string, + revenue?: number, + currency?: string, + deduplicationId?: string, + callbackParams?: Array, + partnerParams?: Array, +|}; +``` -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: +## Send an event -1. Create a new Adjust event instance and pass your event token as a **string** argument. -2. Call the `trackEvent` method method with your event instance as an argument. +To send an event, call the `Adjust.trackEvent` method and pass your Adjust [event token](https://help.adjust.com/en/article/add-events#manage-your-events) as an argument. - +```js {2} +Adjust.trackEvent({ + eventToken: "{YourEventToken}", +}); +``` ### Example This example shows how to record an event with the token _`g3mfiw`_ whenever a user interacts with a button. ```js -function init (defaultEventConfig = {}) { -_ui.trackEventButton.addEventListener('click', _handleTrackEvent, false) +function init(defaultEventConfig = {}) { + _ui.trackEventButton.addEventListener("click", _handleTrackEvent, false); } // ... -function _handleTrackEvent () { -const eventConfig = getItem('eventConfig') || {..._defaultEventConfig} - -if (_disabled) { - return -} - -_disabled = true -_ui.trackEventButton.classList.add('loading') -_ui.trackEventButton.disabled = true - -clearTimeout(_timeoutId) -_timeoutId = setTimeout(() => { - _disabled = false - _ui.trackEventButton.classList.remove('loading') - _ui.trackEventButton.disabled = false - Adjust.trackEvent({ - eventToken: 'g3mfiw' - }) +function _handleTrackEvent() { + const eventConfig = getItem("eventConfig") || { ..._defaultEventConfig }; + + if (_disabled) { + return; + } + + _disabled = true; + _ui.trackEventButton.classList.add("loading"); + _ui.trackEventButton.disabled = true; + + clearTimeout(_timeoutId); + _timeoutId = setTimeout(() => { + _disabled = false; + _ui.trackEventButton.classList.remove("loading"); + _ui.trackEventButton.disabled = false; + Adjust.trackEvent({ + eventToken: "g3mfiw", + }); + }); } - ``` ## Record event revenue 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 `trackEvent` method and pass the following arguments: - -`revenue` (**number**): The amount of revenue generated by the event +To set these properties, call the `Adjust.trackEvent` method and pass the following arguments: -`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. You must format the currency code as a 3 character string that follows the [ISO 4217 standard](https://www.iban.com/currency-codes). Adjust's servers convert the reported revenue to your chosen reporting currency. @@ -77,32 +88,37 @@ Adjust.trackEvent({ This example shows how to record an event with the token _`g3mfiw`_ whenever a user interacts with a button. The function sets the `revenue` property of this event to _`0.25`_ and the `currency` property to _`EUR`_. -```js -function init (defaultEventConfig = {}) { -_ui.trackRevenueEventButton.addEventListener('click', _handleTrackEvent, false) +```js {26-28} +function init(defaultEventConfig = {}) { + _ui.trackRevenueEventButton.addEventListener( + "click", + _handleTrackEvent, + false + ); } //... -function _handleTrackEvent () { -const eventConfig = getItem('eventConfig') || {..._defaultEventConfig} - -if (_disabled) { - return -} - -_disabled = true -_ui.trackRevenueEventButton.classList.add('loading') -_ui.trackRevenueEventButton.disabled = true - -clearTimeout(_timeoutId) -_timeoutId = setTimeout(() => { - _disabled = false - _ui.trackRevenueEventButton.classList.remove('loading') - _ui.trackRevenueEventButton.disabled = false - Adjust.trackEvent({ - eventToken: 'g3mfiw', - revenue: 0.25, - currency: 'EUR' - }) +function _handleTrackEvent() { + const eventConfig = getItem("eventConfig") || { ..._defaultEventConfig }; + + if (_disabled) { + return; + } + + _disabled = true; + _ui.trackRevenueEventButton.classList.add("loading"); + _ui.trackRevenueEventButton.disabled = true; + + clearTimeout(_timeoutId); + _timeoutId = setTimeout(() => { + _disabled = false; + _ui.trackRevenueEventButton.classList.remove("loading"); + _ui.trackRevenueEventButton.disabled = false; + Adjust.trackEvent({ + eventToken: "g3mfiw", + revenue: 0.25, + currency: "EUR", + }); + }); } ``` @@ -123,33 +139,37 @@ Adjust.trackEvent({ This example shows how to record an event with the token _`g3mfiw`_ whenever a user interacts with a button. The function sets the `deduplicationId` to _`5e85484b-1ebc-4141-aab7-25b869e54c49`_. -```js -function init (defaultEventConfig = {}) { -_ui.trackUniqueEventButton.addEventListener('click', _handleTrackEvent, false) +```js {26-27} +function init(defaultEventConfig = {}) { + _ui.trackUniqueEventButton.addEventListener( + "click", + _handleTrackEvent, + false + ); } //... -function _handleTrackEvent () { -const eventConfig = getItem('eventConfig') || {..._defaultEventConfig} - -if (_disabled) { - return -} - -_disabled = true -_ui.trackUniqueEventButton.classList.add('loading') -_ui.trackUniqueEventButton.disabled = true - -clearTimeout(_timeoutId) -_timeoutId = setTimeout(() => { - _disabled = false - _ui.trackUniqueEventButton.classList.remove('loading') - _ui.trackUniqueEventButton.disabled = false - Adjust.trackEvent({ - eventToken: 'g3mfiw', - deduplicationId: '5e85484b-1ebc-4141-aab7-25b869e54c49' - }) +function _handleTrackEvent() { + const eventConfig = getItem("eventConfig") || { ..._defaultEventConfig }; + + if (_disabled) { + return; + } + + _disabled = true; + _ui.trackUniqueEventButton.classList.add("loading"); + _ui.trackUniqueEventButton.disabled = true; + + clearTimeout(_timeoutId); + _timeoutId = setTimeout(() => { + _disabled = false; + _ui.trackUniqueEventButton.classList.remove("loading"); + _ui.trackUniqueEventButton.disabled = false; + Adjust.trackEvent({ + eventToken: "g3mfiw", + deduplicationId: "5e85484b-1ebc-4141-aab7-25b869e54c49", + }); + }); } - ``` You can override the deduplication limit to change the number of identifiers the Adjust SDK stores. To do this, specify the new limit in the `eventDeduplicationListLimit` argument of the `initSdk` method. @@ -164,6 +184,13 @@ Adjust.initSdk({ ## Add callback parameters +```js title="Interface declaration" +export type GlobalParamsT = {| + key: string, + value: string, +|}; +``` + 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. @@ -215,39 +242,51 @@ The resulting callback URL looks like this: http://www.mydomain.com/callback?event_token=g3mfiw&revenue_amount=0.05 ``` -```js -function init (defaultEventConfig = {}) { -_ui.trackCallbackEventButton.addEventListener('click', _handleTrackEvent, false) +```js {26-29} +function init(defaultEventConfig = {}) { + _ui.trackCallbackEventButton.addEventListener( + "click", + _handleTrackEvent, + false + ); } //... -function _handleTrackEvent () { -const eventConfig = getItem('eventConfig') || {..._defaultEventConfig} - -if (_disabled) { - return -} - -_disabled = true -_ui.trackCallbackEventButton.classList.add('loading') -_ui.trackCallbackEventButton.disabled = true - -clearTimeout(_timeoutId) -_timeoutId = setTimeout(() => { - _disabled = false - _ui.trackCallbackEventButton.classList.remove('loading') - _ui.trackCallbackEventButton.disabled = false - Adjust.trackEvent({ - eventToken: 'g3mfiw', - callbackParams: [ - {key: 'eventToken', value: 'g3mfiw'}, - {key: 'revenue_amount', value: '0.05'} - ] - }) +function _handleTrackEvent() { + const eventConfig = getItem("eventConfig") || { ..._defaultEventConfig }; + + if (_disabled) { + return; + } + + _disabled = true; + _ui.trackCallbackEventButton.classList.add("loading"); + _ui.trackCallbackEventButton.disabled = true; + + clearTimeout(_timeoutId); + _timeoutId = setTimeout(() => { + _disabled = false; + _ui.trackCallbackEventButton.classList.remove("loading"); + _ui.trackCallbackEventButton.disabled = false; + Adjust.trackEvent({ + eventToken: "g3mfiw", + callbackParams: [ + { key: "eventToken", value: "g3mfiw" }, + { key: "revenue_amount", value: "0.05" }, + ], + }); + }); } ``` ## Add partner parameters +```js title="Interface declaration" +export type GlobalParamsT = {| + key: string, + value: string, +|}; +``` + 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. @@ -277,40 +316,50 @@ This example shows how to record an event with the token _`g3mfiw`_ whenever a u - The `product_id` of the associated product - The `user_id` of the user who triggered the event -```javascript -function init (defaultEventConfig = {}) { -_ui.trackPartnerEventButton.addEventListener('click', _handleTrackEvent, false) +```javascript {26-29} +function init(defaultEventConfig = {}) { + _ui.trackPartnerEventButton.addEventListener( + "click", + _handleTrackEvent, + false + ); } //... -function _handleTrackEvent () { -const eventConfig = getItem('eventConfig') || {..._defaultEventConfig} - -if (_disabled) { - return +function _handleTrackEvent() { + const eventConfig = getItem("eventConfig") || { ..._defaultEventConfig }; + + if (_disabled) { + return; + } + + _disabled = true; + _ui.trackPartnerEventButton.classList.add("loading"); + _ui.trackPartnerEventButton.disabled = true; + + clearTimeout(_timeoutId); + _timeoutId = setTimeout(() => { + _disabled = false; + _ui.trackPartnerEventButton.classList.remove("loading"); + _ui.trackPartnerEventButton.disabled = false; + Adjust.trackEvent({ + eventToken: "g3mfiw", + partnerParams: [ + { key: "product_id", value: "29" }, + { key: "user_id", value: "835" }, + ], + }); + }); } +``` -_disabled = true -_ui.trackPartnerEventButton.classList.add('loading') -_ui.trackPartnerEventButton.disabled = true +## Record event and redirect to an external page -clearTimeout(_timeoutId) -_timeoutId = setTimeout(() => { - _disabled = false - _ui.trackPartnerEventButton.classList.remove('loading') - _ui.trackPartnerEventButton.disabled = false - Adjust.trackEvent({ - eventToken: 'g3mfiw', - partnerParams: [ - {key: 'product_id', value: '29'}, - {key: 'user_id', value: '835'} - ] - }) +```js title="Method signature" +function trackEvent(params: EventParamsT): Promise { + return _internalTrackEvent(params); } - ``` -## Record event and redirect to an external page - You can record redirects to external pages as events with the Adjust SDK. To ensure the SDK records the event before the redirect happens, the `trackEvent` method returns a [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise). This `Promise` is fulfilled after the SDK receives a response from Adjust's servers. If an internal error response is returned, the `Promise` is rejected. diff --git a/src/content/docs/sdk/web/features/global-params.mdx b/src/content/docs/sdk/web/features/global-params.mdx index 8afd8aec3..201e5d99a 100644 --- a/src/content/docs/sdk/web/features/global-params.mdx +++ b/src/content/docs/sdk/web/features/global-params.mdx @@ -4,31 +4,28 @@ description: You can send additional information from the SDK with each session slug: en/sdk/web/features/global-params --- -import AddGlobalCallbackParameters from "@web-examples/Adjust/addGlobalCallbackParameters.mdx" -import AddGlobalCallbackParametersSig from "@web-signatures/Adjust/addGlobalCallbackParameters.mdx" -import RemoveGlobalCallbackParameter from "@web-examples/Adjust/removeGlobalCallbackParameter.mdx" -import RemoveGlobalCallbackParameterSig from "@web-signatures/Adjust/removeGlobalCallbackParameter.mdx" -import ClearGlobalCallbackParameters from "@web-examples/Adjust/clearGlobalCallbackParameters.mdx" -import ClearGlobalCallbackParametersSig from "@web-signatures/Adjust/clearGlobalCallbackParameters.mdx" -import AddGlobalPartnerParameters from "@web-examples/Adjust/addGlobalPartnerParameters.mdx" -import AddGlobalPartnerParametersSig from "@web-signatures/Adjust/addGlobalPartnerParameters.mdx" -import RemoveGlobalPartnerParameter from "@web-examples/Adjust/removeGlobalPartnerParameter.mdx" -import RemoveGlobalPartnerParameterSig from "@web-signatures/Adjust/removeGlobalPartnerParameter.mdx" -import ClearGlobalPartnerParameters from "@web-examples/Adjust/clearGlobalPartnerParameters.mdx" -import ClearGlobalPartnerParametersSig from "@web-signatures/Adjust/clearGlobalPartnerParameters.mdx" - You can send additional information from the SDK with each session and event by registering global callback and partner parameters. ## Global callback parameters -If you [register a callback URL](https://help.adjust.com/en/article/set-up-callbacks -) in the Adjust dashboard, Adjust sends a GET request to your callback URL when the SDK records a session or event. +If you [register a callback URL](https://help.adjust.com/en/article/set-up-callbacks) in the Adjust dashboard, Adjust sends a GET request to your callback URL when the SDK records a session or event. You can configure global callback parameters to your servers. Once you configure parameters, 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 callback parameters + +```js title="Method signature" +function addGlobalCallbackParameters(params: Array): void; +``` + Add callback parameters to your sessions and events by calling the `addGlobalCallbackParameters` method with an array of **string** key-value pair objects. You can add as many objects to this array as you require. - +```js +Adjust.addGlobalCallbackParameters([ + { key: "key1", value: "value1" }, + { key: "key2", value: "value2" }, +]); +``` For the above example, the callback URL looks like this: @@ -36,13 +33,29 @@ For the above example, the callback URL looks like this: https://www.mydomain.com/callback?key1=value1&key2=value2 ``` +### Remove callback parameters + +```js title="Method signature" +function removeGlobalCallbackParameter(key: string): void; +``` + You can remove global callback parameters if they're no longer required. To do this, pass the parameter key to the `removeGlobalCallbackParameter` method. - +```js +Adjust.removeGlobalCallbackParameter("key1"); +``` + +### Clear all callback parameters + +```js +function clearGlobalCallbackParameters(): void; +``` You can remove all global callback parameters if they're no longer required. To do this, call the `clearGlobalCallbackParameters` method. - +```js +Adjust.clearGlobalCallbackParameters(); +``` ## Global partner parameters @@ -56,14 +69,41 @@ Partner parameters don't appear in raw data by default. You can add the `{partne +### Add partner parameters + +```js title="Method signature" +function addGlobalPartnerParameters(params: Array): void; +``` + Add partner parameters to your sessions and events by calling the `addGlobalPartnerParameters` method with an array of **string** key-value pair objects. You can add as many objects to this array as you require. - +```js +Adjust.addGlobalPartnerParameters([ + { key: "key1", value: "value1" }, + { key: "key2", value: "value2" }, +]); +``` + +### Remove partner parameters + +```js title="Method signature" +function removeGlobalPartnerParameter(key: string): void; +``` You can remove global partner parameters if they're no longer required. To do this, pass the parameter key to the `removeGlobalPartnerParameter` method. - +```js +Adjust.removeGlobalPartnerParameter("key1"); +``` + +### Clear all partner parameters + +```js title="Method signature" +function clearGlobalPartnerParameters(): void; +``` You can remove all global partner parameters if they're no longer required. To do this, call the `clearGlobalPartnerParameters` method. - +```js +Adjust.clearGlobalPartnerParameters(); +``` diff --git a/src/content/docs/sdk/web/features/index.mdx b/src/content/docs/sdk/web/features/index.mdx index ee519ae4d..5be6c1634 100644 --- a/src/content/docs/sdk/web/features/index.mdx +++ b/src/content/docs/sdk/web/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/web/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/web/configuration/privacy.mdx b/src/content/docs/sdk/web/features/privacy.mdx similarity index 64% rename from src/content/docs/sdk/web/configuration/privacy.mdx rename to src/content/docs/sdk/web/features/privacy.mdx index 0ddafbce4..1dd6e7a0b 100644 --- a/src/content/docs/sdk/web/configuration/privacy.mdx +++ b/src/content/docs/sdk/web/features/privacy.mdx @@ -1,46 +1,47 @@ --- title: Set up privacy features description: Configure features that you can use to handle user privacy in your app. -slug: en/sdk/web/configuration/privacy +slug: en/sdk/web/features/privacy --- -import GdprForgetMe from "@web-examples/Adjust/gdprForgetMe.mdx"; -import GdprForgetMeSig from "@web-signatures/Adjust/gdprForgetMe.mdx"; -import DisableThirdPartySharing from "@web-examples/Adjust/disableThirdPartySharing.mdx"; -import DisableThirdPartySharingSig from "@web-signatures/Adjust/disableThirdPartySharing.mdx"; -import InitSdk from "@web-signatures/Adjust/initSdk.mdx" - The Adjust SDK contains features that you can use to handle user privacy in your app. -## GDPR right to be forgotten +## Send right to be forgotten request + +```js title="Method signature" +function gdprForgetMe(): void; +``` -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. +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. - +```js +Adjust.gdprForgetMe(); +``` ## 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 `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. +```js title="Method signature" +function disableThirdPartySharing(): void; +``` - +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. + +```js +Adjust.disableThirdPartySharing(); +``` ## Data residency +```js title="Property declaration" +dataResidency: "EU" | "TR" | "US"; +``` + 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, pass the region code of your preferred country code in the `dataResidency` property of the `initSdk` method. -```js {5} -Adjust.initSdk({ - appToken: "YOUR_APP_TOKEN", - environment: "production", - logLevel: "verbose", - dataResidency: "EU", -}); -``` - | Region | Code | @@ -51,19 +52,23 @@ Adjust.initSdk({
-## URL strategy - -You can set a URL strategy to prioritize regional endpoints for sending data from the Adjust SDK. To do this, pass the region of your preferred country code in the `urlStrategy` property of the `initSdk` method. - ```js {5} Adjust.initSdk({ appToken: "YOUR_APP_TOKEN", environment: "production", logLevel: "verbose", - urlStrategy: "china", + dataResidency: "EU", }); ``` +## URL strategy + +```js title="Property declaration" +urlStrategy: "india" | "china"; +``` + +You can set a URL strategy to prioritize regional endpoints for sending data from the Adjust SDK. To do this, pass the region of your preferred country code in the `urlStrategy` property of the `initSdk` method. + | Region | Code | @@ -73,8 +78,21 @@ Adjust.initSdk({
+```js {5} +Adjust.initSdk({ + appToken: "YOUR_APP_TOKEN", + environment: "production", + logLevel: "verbose", + urlStrategy: "china", +}); +``` + ## Set custom endpoint +```js title="Property declaration" +customUrl: string; +``` + By default, the Adjust SDK sends all data to Adjust's endpoints. If you want to specify a custom endpoint, pass your endpoint in the `customUrl` property of the `initSdk` method. ```js {4} diff --git a/src/content/docs/sdk/web/index.mdx b/src/content/docs/sdk/web/index.mdx index c7a2a710c..f9f661537 100644 --- a/src/content/docs/sdk/web/index.mdx +++ b/src/content/docs/sdk/web/index.mdx @@ -171,18 +171,22 @@ $ pnpm add @adjustcom/adjust-web-sdk ## 2. Initialize the SDK -import InitSdkSig from "@web-signatures/Adjust/initSdk.mdx" - Once you've installed the SDK, you need to initialize it. To do this, call the `initSdk` method. This method takes a number of arguments that customize how the SDK works in your app. You must add the following arguments to your `initSdk` call to initialize the SDK: -`appToken`: Your [Adjust app token](https://help.adjust.com/en/suite/article/app-token-and-reporting-currency). +- `appToken` (**String**): Your [Adjust app token](https://help.adjust.com/en/article/app-token-and-reporting-currency#view-your-app-details). +- `environment` (**String**): The environment you want to run the SDK in. Pass `sandbox` to run the SDK in sandbox mode for testing. Pass `production` to run the SDK in production mode for release. -`environment`: The environment your app is running in. Set this to `sandbox` to test your app locally. +```js +Adjust.initSdk({ + appToken: "YOUR_APP_TOKEN", + environment: "sandbox", +}); +``` -import InitSdk from "@web-examples/Adjust/initSdk.mdx" + - +To customize your Adjust SDK setup, check out the [configuration guide](/en/sdk/web/configuration). -To further customize your Adjust SDK setup, check out the guides in the [configuration features section](/en/sdk/web/configuration). + diff --git a/src/content/docs/sdk/web/reference/adjust/config.mdx b/src/content/docs/sdk/web/reference/adjust/config.mdx deleted file mode 100644 index 25acc0e66..000000000 --- a/src/content/docs/sdk/web/reference/adjust/config.mdx +++ /dev/null @@ -1,192 +0,0 @@ ---- -title: Configuration methods -description: Use these methods to update the Adjust SDK's configuration. -slug: en/sdk/web/reference/adjust/config ---- - -Use these methods to update the Adjust SDK's configuration. - - - -## initSdk - -Initializes the Adjust SDK with a set of customizable options. - - - -import InitSdkSig from "@web-signatures/Adjust/initSdk.mdx" - - - - - - - -import InitSdk from "@web-examples/Adjust/initSdk.mdx" - - - - - - - -`InitOptions` (InitOptions): A set of initialization options that configure the SDK's behavior. - - - -`appToken` (string): Your Adjust app token. - -`environment` (string): The environment your app is running in. `sandbox` or `production`. - -`defaultTracker` (string): An optional campaign token to track installs against by default. - -`externalDeviceId` (string): A custom device identifier. - -`eventDeduplicationListLimit` (int): The number of custom event IDs to store. - -`customUrl` (string): An optional custom endpoint to send requests to. - -`dataResidency` (string): The region you want to store data in. - -`urlStrategy` (string): The region whose endpoints you want to prioritize sending data to. - -`namespace` (string): An optional custom namespace for data storage. - -`attributionCallback` (function): An optional callback method called when the user's attribution information changes. - -`logLevel` (string): The verbosity of logging. - -`logOutput` (string): An optional custom HTML selector to send log output to. - - - - - - - - - - -## stop - -Disables the Adjust SDK. The SDK doesn't send any information to Adjust while it's disabled. - - - -import StopSig from "@web-signatures/Adjust/stop.mdx" - - - - - - - -import Stop from "@web-examples/Adjust/stop.mdx" - - - - - - - - - -## restart - -Restarts the Adjust SDK. - - - -import RestartSig from "@web-signatures/Adjust/restart.mdx" - - - - - - - -import Restart from "@web-examples/Adjust/restart.mdx" - - - - - - - - - -## switchToOfflineMode - -Enables offline mode. - - - -import SwitchToOfflineModeSig from "@web-signatures/Adjust/switchToOfflineMode.mdx" - - - - - - - -import SwitchToOfflineMode from "@web-examples/Adjust/switchToOfflineMode.mdx" - - - - - - - - - -## switchBackToOnlineMode - -Disables offline mode. - - - -import SwitchBackToOnlineModeSig from "@web-signatures/Adjust/switchBackToOnlineMode.mdx" - - - - - - - -import SwitchBackToOnlineMode from "@web-examples/Adjust/switchBackToOnlineMode.mdx" - - - - - - - - - -## setReferrer - -Sets a default referrer to simulate a click. - - - -import SetReferrerSig from "@web-signatures/Adjust/setReferrer.mdx" - - - - - - - -import SetReferrer from "@web-examples/Adjust/setReferrer.mdx" - - - - - - - -`referrer` (string): Your URL-encoded referrer. - - - - diff --git a/src/content/docs/sdk/web/reference/adjust/device-info.mdx b/src/content/docs/sdk/web/reference/adjust/device-info.mdx deleted file mode 100644 index 757bfe21d..000000000 --- a/src/content/docs/sdk/web/reference/adjust/device-info.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Device information methods -description: Use these methods to retrieve device information. -slug: en/sdk/web/reference/adjust/device-info ---- - - - -## getWebUUID - -Return the user's `web_uuid` as a string. - - - -import GetWebUUIDSig from "@web-signatures/Adjust/getWebUUID.mdx" - - - - - - - -import GetWebUUID from "@web-examples/Adjust/getWebUUID.mdx" - - - - - - - -`web_uuid` (string): The user's `web_uuid`. - - - - diff --git a/src/content/docs/sdk/web/reference/adjust/index.mdx b/src/content/docs/sdk/web/reference/adjust/index.mdx deleted file mode 100644 index 26110d2b2..000000000 --- a/src/content/docs/sdk/web/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/web/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/web/reference/adjust/privacy.mdx b/src/content/docs/sdk/web/reference/adjust/privacy.mdx deleted file mode 100644 index 1e2c76766..000000000 --- a/src/content/docs/sdk/web/reference/adjust/privacy.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: Privacy methods -description: Use these methods to handle user privacy in your app. -slug: en/sdk/web/reference/adjust/privacy ---- - -Use these methods to handle user privacy in your app. - - - -## gdprForgetMe - -Disables the SDK and sends an RTBF (Right to Forgotten) request to Adjust's servers. - - - -import GdprForgetMeSig from "@web-signatures/Adjust/gdprForgetMe.mdx" - - - - - - - -import GdprForgetMe from "@web-examples/Adjust/gdprForgetMe.mdx" - - - - - - - - - -## disableThirdPartySharing - -Disables sharing of information with third parties for all users. - - - -import DisableThirdPartySharingSig from "@web-signatures/Adjust/disableThirdPartySharing.mdx" - - - - - - - -import DisableThirdPartySharing from "@web-examples/Adjust/disableThirdPartySharing.mdx" - - - - - - diff --git a/src/content/docs/sdk/web/reference/adjust/recording.mdx b/src/content/docs/sdk/web/reference/adjust/recording.mdx deleted file mode 100644 index 8dfbde7f9..000000000 --- a/src/content/docs/sdk/web/reference/adjust/recording.mdx +++ /dev/null @@ -1,297 +0,0 @@ ---- -title: Recording methods -description: Use these methods to send information about your app to Adjust. -slug: en/sdk/web/reference/adjust/recording ---- - -Use these methods to send information about your app to Adjust. - - - -## trackEvent - -Record an event object with an [Adjust event token](https://help.adjust.com/en/article/add-events#add-event) and additional parameters. - - - -import TrackEventSig from "@web-signatures/Adjust/trackEvent.mdx" - - - - - - - -import TrackEvent from "@web-examples/Adjust/trackEvent.mdx" - - - - - - - -`params` (EventParams): Your Adjust event parameters. - - - -`eventToken` (string): Your Adjust event token. - -`revenue` (number): The amount of money associated with the event. - -`currency` (string): The [ISO 4217 code](https://www.iban.com/currency-codes) of the currency used for the transaction. - -`deduplicationId` (string): An optional identifier to avoid measuring duplicate events. - -`callbackParams` (Array\): A list of key-value pairs to append to your callback URL. - -`partnerParams` (Array\): A list of key-value pairs to send to your external partners. - - - - - -`key` (string): A unique key for the parameter. - -`value` (string): The parameter value. - - - - - - - - - -## addGlobalCallbackParameters - -Adds callback parameters to send with each session and event recorded by the Adjust SDK. - - - -import AddGlobalCallbackParametersSig from "@web-signatures/Adjust/addGlobalCallbackParameters.mdx" - - - - - - - -import AddGlobalCallbackParameters from "@web-examples/Adjust/addGlobalCallbackParameters.mdx" - - - - - - - -`params` (Array\): An array of key-value pair objects. - - - -`key` (string): A unique key for the parameter. - -`value` (string): The parameter value. - - - - - - - - - -## removeGlobalCallbackParameter - -Removes a global callback parameter. - - - -import RemoveGlobalCallbackParameterSig from "@web-signatures/Adjust/removeGlobalCallbackParameter.mdx" - - - - - - - -import RemoveGlobalCallbackParameter from "@web-examples/Adjust/removeGlobalCallbackParameter.mdx" - - - - - - - -`key` (string): The key of the parameter you want to remove. - - - - - - - -## clearGlobalCallbackParameters - -Removes all global callback parameters. - - - -import ClearGlobalCallbackParametersSig from "@web-signatures/Adjust/clearGlobalCallbackParameters.mdx" - - - - - - - -import ClearGlobalCallbackParameters from "@web-examples/Adjust/clearGlobalCallbackParameters.mdx" - - - - - - - - - -## addGlobalPartnerParameters - -Adds partner parameters to send with each session and event recorded by the Adjust SDK. - - - -import AddGlobalPartnerParametersSig from "@web-signatures/Adjust/addGlobalPartnerParameters.mdx" - - - - - - - -import AddGlobalPartnerParameters from "@web-examples/Adjust/addGlobalPartnerParameters.mdx" - - - - - - - -`params` (Array\): An array of key-value pair objects. - - - -`key` (string): A unique key for the parameter. - -`value` (string): The parameter value. - - - - - - - - - -## removeGlobalPartnerParameter - -Removes a global partner parameter. - - - -import RemoveGlobalPartnerParameterSig from "@web-signatures/Adjust/removeGlobalPartnerParameter.mdx" - - - - - - - -import RemoveGlobalPartnerParameter from "@web-examples/Adjust/removeGlobalPartnerParameter.mdx" - - - - - - - -`key` (string): The key of the parameter you want to remove. - - - - - - - -## clearGlobalPartnerParameters - -Removes all global partner parameters. - - - -import ClearGlobalPartnerParametersSig from "@web-signatures/Adjust/clearGlobalPartnerParameters.mdx" - - - - - - - -import ClearGlobalPartnerParameters from "@web-examples/Adjust/clearGlobalPartnerParameters.mdx" - - - - - - - - - -## getAttribution - -Returns the user's attribution information. - - - -import GetAttributionSig from "@web-signatures/Adjust/getAttribution.mdx" - - - - - - - -import GetAttribution from "@web-examples/Adjust/getAttribution.mdx" - - - - - - - -`attribution` (Attribution): The user's attribution information - - - -`adid` (string): The device's unique Adjust identifier. - -`tracker_token` (string): The campaign token associated with the attribution. - -`tracker_name` (string): The name of the campaign link. - -`network` (string): The network associate with the campaign. - -`campaign` (string): The name of the campaign associated with the attribution. - -`adgroup` (string): The adgroup associated with the attribution. - -`creative` (string): The creative associated with the attribution. - -`click_label` (string): The [click label](https://help.adjust.com/en/article/user-rewards) associated with the attribution. - -`state` (string): The current state of the attribution. Either `installed` or `reattributed`. - - - - - - diff --git a/src/content/docs/sdk/web/reference/index.mdx b/src/content/docs/sdk/web/reference/index.mdx deleted file mode 100644 index 6c4e1f4fc..000000000 --- a/src/content/docs/sdk/web/reference/index.mdx +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: SDK reference -description: SDK reference information for the Unity SDK -category-title: Reference -slug: en/sdk/web/reference -type: category ---- From ecdffafd9ffe3fc5ff20ab5f75c8a1db900a9fe2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Fri, 23 Feb 2024 18:42:50 +0100 Subject: [PATCH 4/8] Update React Native documentation --- .../Adjust/addSessionCallbackParameter.mdx | 3 - .../Adjust/addSessionPartnerParameter.mdx | 3 - .../Adjust/appTrackingAuthorizationStatus.mdx | 3 - .../examples/Adjust/checkForNewAttStatus.mdx | 3 - .../Adjust/disableThirdPartySharing.mdx | 3 - .../examples/Adjust/gdprForgetMe.mdx | 3 - .../react-native/examples/Adjust/getAdid.mdx | 5 - .../examples/Adjust/getAmazonAdId.mdx | 5 - .../examples/Adjust/getAttribution.mdx | 12 - .../examples/Adjust/getGoogleAdId.mdx | 5 - .../react-native/examples/Adjust/getIdfa.mdx | 5 - .../examples/Adjust/isEnabled.mdx | 3 - .../Adjust/removeSessionCallbackParameter.mdx | 3 - .../Adjust/removeSessionPartnerParameter.mdx | 3 - .../Adjust/requestTrackingAuthorization.mdx | 18 - .../Adjust/resetSessionCallbackParameters.mdx | 3 - .../Adjust/resetSessionPartnerParameters.mdx | 3 - .../examples/Adjust/sendFirstPackages.mdx | 3 - .../examples/Adjust/setEnabled.mdx | 3 - .../examples/Adjust/setOfflineMode.mdx | 3 - .../examples/Adjust/setPushToken.mdx | 3 - .../examples/Adjust/trackAdRevenue.mdx | 5 - .../Adjust/trackAppStoreSubscription.mdx | 12 - .../examples/Adjust/trackEvent.mdx | 4 - .../Adjust/trackMeasurementConsent.mdx | 3 - .../Adjust/trackPlayStoreSubscription.mdx | 13 - .../Adjust/trackThirdPartySharing.mdx | 4 - .../examples/Adjust/updateConversionValue.mdx | 3 - .../AdjustAdRevenue/addCallbackParameter.mdx | 7 - .../AdjustAdRevenue/addPartnerParameter.mdx | 7 - .../examples/AdjustAdRevenue/constructor.mdx | 4 - .../AdjustAdRevenue/setAdImpressionsCount.mdx | 7 - .../AdjustAdRevenue/setAdRevenueNetwork.mdx | 7 - .../AdjustAdRevenue/setAdRevenuePlacement.mdx | 7 - .../AdjustAdRevenue/setAdRevenueUnit.mdx | 7 - .../examples/AdjustAdRevenue/setRevenue.mdx | 7 - .../addCallbackParameter.mdx | 15 - .../addPartnerParameter.mdx | 15 - .../adjustAppStoreSubscription.mdx | 11 - .../setSalesRegion.mdx | 13 - .../setTransactionDate.mdx | 13 - .../examples/AdjustConfig/constructor.mdx | 8 - .../deactivateSKAdNetworkHandling.mdx | 10 - .../AdjustConfig/sendInBackground.mdx | 7 - .../setAttributionCallbackListener.mdx | 22 - ...ConversionValueUpdatedCallbackListener.mdx | 12 - .../AdjustConfig/setCoppaCompliantEnabled.mdx | 9 - .../AdjustConfig/setDefaultTracker.mdx | 10 - .../setDeferredDeeplinkCallbackListener.mdx | 12 - .../examples/AdjustConfig/setDelayStart.mdx | 10 - .../AdjustConfig/setEventBufferingEnabled.mdx | 10 - ...setEventTrackingFailedCallbackListener.mdx | 20 - ...EventTrackingSucceededCallbackListener.mdx | 19 - .../AdjustConfig/setExternalDeviceId.mdx | 10 - .../setLaunchDeferredDeeplink.mdx | 10 - .../AdjustConfig/setLinkMeEnabled.mdx | 10 - .../examples/AdjustConfig/setLogLevel.mdx | 10 - .../examples/AdjustConfig/setNeedsCost.mdx | 8 - .../setPlayStoreKidsAppEnabled.mdx | 10 - .../AdjustConfig/setPreinstallFilePath.mdx | 10 - .../setPreinstallTrackingEnabled.mdx | 10 - ...tSessionTrackingFailedCallbackListener.mdx | 20 - ...ssionTrackingSucceededCallbackListener.mdx | 19 - .../AdjustConfig/setShouldLaunchDeeplink.mdx | 10 - .../examples/AdjustConfig/setUrlStrategy.mdx | 8 - .../AdjustEvent/addCallbackParameter.mdx | 7 - .../AdjustEvent/addPartnerParameter.mdx | 7 - .../examples/AdjustEvent/constructor.mdx | 5 - .../examples/AdjustEvent/setCallbackId.mdx | 7 - .../examples/AdjustEvent/setRevenue.mdx | 7 - .../examples/AdjustEvent/setTransactionId.mdx | 7 - .../addCallbackParameter.mdx | 13 - .../addPartnerParameter.mdx | 13 - .../adjustPlayStoreSubscription.mdx | 10 - .../setPurchaseTime.mdx | 11 - .../addGranularOption.mdx | 7 - .../addGranularOptionFacebook.mdx | 16 - .../addPartnerSharingSetting.mdx | 6 - .../AdjustThirdPartySharing/initFalse.mdx | 5 - .../AdjustThirdPartySharing/initTrue.mdx | 5 - .../Adjust/addSessionCallbackParameter.mdx | 3 - .../Adjust/addSessionPartnerParameter.mdx | 3 - .../Adjust/appTrackingAuthorizationStatus.mdx | 3 - .../Adjust/checkForNewAttStatus.mdx | 3 - .../Adjust/disableThirdPartySharing.mdx | 3 - .../signatures/Adjust/gdprForgetMe.mdx | 3 - .../signatures/Adjust/getAdid.mdx | 3 - .../signatures/Adjust/getAmazonAdId.mdx | 3 - .../signatures/Adjust/getAttribution.mdx | 3 - .../signatures/Adjust/getGoogleAdId.mdx | 3 - .../signatures/Adjust/getIdfa.mdx | 3 - .../signatures/Adjust/isEnabled.mdx | 3 - .../Adjust/removeSessionCallbackParameter.mdx | 3 - .../Adjust/removeSessionPartnerParameter.mdx | 3 - .../Adjust/requestTrackingAuthorization.mdx | 3 - .../Adjust/resetSessionCallbackParameters.mdx | 3 - .../Adjust/resetSessionPartnerParameters.mdx | 3 - .../signatures/Adjust/sendFirstPackages.mdx | 3 - .../signatures/Adjust/setEnabled.mdx | 3 - .../signatures/Adjust/setOfflineMode.mdx | 3 - .../signatures/Adjust/setPushToken.mdx | 3 - .../signatures/Adjust/trackAdRevenue.mdx | 3 - .../Adjust/trackAppStoreSubscription.mdx | 3 - .../signatures/Adjust/trackEvent.mdx | 3 - .../Adjust/trackMeasurementConsent.mdx | 3 - .../Adjust/trackPlayStoreSubscription.mdx | 3 - .../Adjust/trackThirdPartySharing.mdx | 3 - .../Adjust/updateConversionValue.mdx | 3 - .../AdjustAdRevenue/addCallbackParameter.mdx | 3 - .../AdjustAdRevenue/addPartnerParameter.mdx | 3 - .../AdjustAdRevenue/constructor.mdx | 3 - .../AdjustAdRevenue/setAdImpressionsCount.mdx | 3 - .../AdjustAdRevenue/setAdRevenueNetwork.mdx | 3 - .../AdjustAdRevenue/setAdRevenuePlacement.mdx | 3 - .../AdjustAdRevenue/setAdRevenueUnit.mdx | 3 - .../signatures/AdjustAdRevenue/setRevenue.mdx | 3 - .../addCallbackParameter.mdx | 3 - .../addPartnerParameter.mdx | 3 - .../constructor.mdx | 3 - .../setSalesRegion.mdx | 3 - .../setTransactionDate.mdx | 3 - .../signatures/AdjustConfig/constructor.mdx | 3 - .../deactivateSKAdNetworkHandling.mdx | 3 - .../AdjustConfig/sendInBackground.mdx | 3 - .../setAttributionCallbackListener.mdx | 5 - ...ConversionValueUpdatedCallbackListener.mdx | 5 - .../AdjustConfig/setCoppaCompliantEnabled.mdx | 3 - .../AdjustConfig/setDefaultTracker.mdx | 3 - .../setDeferredDeeplinkCallbackListener.mdx | 5 - .../signatures/AdjustConfig/setDelayStart.mdx | 3 - .../AdjustConfig/setEventBufferingEnabled.mdx | 3 - ...setEventTrackingFailedCallbackListener.mdx | 5 - ...EventTrackingSucceededCallbackListener.mdx | 5 - .../AdjustConfig/setExternalDeviceId.mdx | 3 - .../AdjustConfig/setLinkMeEnabled.mdx | 3 - .../signatures/AdjustConfig/setLogLevel.mdx | 3 - .../signatures/AdjustConfig/setNeedsCost.mdx | 3 - .../setPlayStoreKidsAppEnabled.mdx | 3 - .../AdjustConfig/setPreinstallFilePath.mdx | 3 - .../setPreinstallTrackingEnabled.mdx | 3 - ...tSessionTrackingFailedCallbackListener.mdx | 5 - ...ssionTrackingSucceededCallbackListener.mdx | 5 - .../AdjustConfig/setShouldLaunchDeeplink.mdx | 3 - .../AdjustConfig/setUrlStrategy.mdx | 3 - .../AdjustEvent/addCallbackParameter.mdx | 3 - .../AdjustEvent/addPartnerParameter.mdx | 3 - .../signatures/AdjustEvent/constructor.mdx | 3 - .../signatures/AdjustEvent/setCallbackId.mdx | 3 - .../signatures/AdjustEvent/setProductId.mdx | 3 - .../AdjustEvent/setPurchaseToken.mdx | 3 - .../signatures/AdjustEvent/setReceipt.mdx | 3 - .../signatures/AdjustEvent/setRevenue.mdx | 3 - .../AdjustEvent/setTransactionId.mdx | 3 - .../addCallbackParameter.mdx | 3 - .../addPartnerParameter.mdx | 3 - .../constructor.mdx | 9 - .../setPurchaseTime.mdx | 3 - .../addGranularOption.mdx | 3 - .../addPartnerSharingSetting.mdx | 3 - .../AdjustThirdPartySharing/constructor.mdx | 3 - .../docs/sdk/android/setup/preinstalled.mdx | 2 +- .../sdk/flutter/features/preinstalled.mdx | 2 +- .../docs/sdk/react-native/configuration.mdx | 292 +++++++++ .../react-native/configuration/background.mdx | 20 - .../react-native/configuration/deep-links.mdx | 83 --- .../sdk/react-native/configuration/delay.mdx | 30 - .../react-native/configuration/disable.mdx | 57 -- .../configuration/external-device-id.mdx | 40 -- .../sdk/react-native/configuration/index.mdx | 9 - .../react-native/configuration/log-level.mdx | 43 -- .../configuration/preinstalled.mdx | 30 - .../react-native/configuration/privacy.mdx | 205 ------- .../configuration/push-tokens.mdx | 22 - .../sdk/react-native/features/ad-revenue.mdx | 159 +++-- .../{configuration => features}/att.mdx | 56 +- .../sdk/react-native/features/attribution.mdx | 89 ++- .../sdk/react-native/features/callbacks.mdx | 117 +++- .../sdk/react-native/features/device-info.mdx | 57 +- .../docs/sdk/react-native/features/events.mdx | 165 ++++- .../docs/sdk/react-native/features/index.mdx | 1 + .../react-native/features/preinstalled.mdx | 49 ++ .../sdk/react-native/features/privacy.mdx | 314 ++++++++++ .../features/session-parameters.mdx | 102 +++- .../{configuration => features}/skad.mdx | 57 +- .../react-native/features/subscriptions.mdx | 217 ++++++- .../docs/sdk/react-native/plugins/index.mdx | 1 + .../docs/sdk/react-native/plugins/oaid.mdx | 9 +- .../react-native/reference/adjust/config.mdx | 157 ----- .../reference/adjust/device-info.mdx | 134 ---- .../react-native/reference/adjust/index.mdx | 9 - .../react-native/reference/adjust/privacy.mdx | 116 ---- .../reference/adjust/recording.mdx | 330 ---------- .../reference/adjust/skan-att.mdx | 122 ---- .../reference/adjustadrevenue.mdx | 269 -------- .../reference/adjustappstoresubscription.mdx | 170 ------ .../reference/adjustattribution.mdx | 44 -- .../reference/adjustconfig/index.mdx | 54 -- .../reference/adjustconfig/privacy.mdx | 79 --- .../reference/adjustconfig/setup.mdx | 574 ------------------ .../react-native/reference/adjustevent.mdx | 196 ------ .../reference/adjustplaystoresubscription.mdx | 145 ----- .../reference/adjustthirdpartysharing.mdx | 139 ----- .../docs/sdk/react-native/reference/index.mdx | 7 - 203 files changed, 1490 insertions(+), 4212 deletions(-) delete mode 100644 src/code-snippets/react-native/examples/Adjust/addSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/addSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/appTrackingAuthorizationStatus.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/checkForNewAttStatus.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/disableThirdPartySharing.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/gdprForgetMe.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/getAdid.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/getAmazonAdId.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/getAttribution.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/getGoogleAdId.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/getIdfa.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/isEnabled.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/removeSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/removeSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/requestTrackingAuthorization.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/resetSessionCallbackParameters.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/resetSessionPartnerParameters.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/sendFirstPackages.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/setEnabled.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/setOfflineMode.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/setPushToken.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/trackAdRevenue.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/trackAppStoreSubscription.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/trackEvent.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/trackMeasurementConsent.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/trackPlayStoreSubscription.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/trackThirdPartySharing.mdx delete mode 100644 src/code-snippets/react-native/examples/Adjust/updateConversionValue.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustAdRevenue/addCallbackParameter.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustAdRevenue/addPartnerParameter.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustAdRevenue/constructor.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustAdRevenue/setAdImpressionsCount.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustAdRevenue/setAdRevenueNetwork.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustAdRevenue/setAdRevenuePlacement.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustAdRevenue/setAdRevenueUnit.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustAdRevenue/setRevenue.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustAppStoreSubscription/addCallbackParameter.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustAppStoreSubscription/addPartnerParameter.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustAppStoreSubscription/adjustAppStoreSubscription.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustAppStoreSubscription/setSalesRegion.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustAppStoreSubscription/setTransactionDate.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/constructor.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/deactivateSKAdNetworkHandling.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/sendInBackground.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/setAttributionCallbackListener.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/setConversionValueUpdatedCallbackListener.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/setCoppaCompliantEnabled.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/setDefaultTracker.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/setDeferredDeeplinkCallbackListener.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/setDelayStart.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/setEventBufferingEnabled.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/setEventTrackingFailedCallbackListener.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/setEventTrackingSucceededCallbackListener.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/setExternalDeviceId.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/setLaunchDeferredDeeplink.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/setLinkMeEnabled.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/setLogLevel.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/setNeedsCost.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/setPlayStoreKidsAppEnabled.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/setPreinstallFilePath.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/setPreinstallTrackingEnabled.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/setSessionTrackingFailedCallbackListener.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/setSessionTrackingSucceededCallbackListener.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/setShouldLaunchDeeplink.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustConfig/setUrlStrategy.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustEvent/addCallbackParameter.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustEvent/addPartnerParameter.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustEvent/constructor.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustEvent/setCallbackId.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustEvent/setRevenue.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustEvent/setTransactionId.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustPlayStoreSubscription/addCallbackParameter.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustPlayStoreSubscription/addPartnerParameter.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustPlayStoreSubscription/adjustPlayStoreSubscription.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustPlayStoreSubscription/setPurchaseTime.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustThirdPartySharing/addGranularOption.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustThirdPartySharing/addGranularOptionFacebook.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustThirdPartySharing/addPartnerSharingSetting.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustThirdPartySharing/initFalse.mdx delete mode 100644 src/code-snippets/react-native/examples/AdjustThirdPartySharing/initTrue.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/addSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/addSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/appTrackingAuthorizationStatus.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/checkForNewAttStatus.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/disableThirdPartySharing.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/gdprForgetMe.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/getAdid.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/getAmazonAdId.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/getAttribution.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/getGoogleAdId.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/getIdfa.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/isEnabled.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/removeSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/removeSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/requestTrackingAuthorization.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/resetSessionCallbackParameters.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/resetSessionPartnerParameters.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/sendFirstPackages.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/setEnabled.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/setOfflineMode.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/setPushToken.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/trackAdRevenue.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/trackAppStoreSubscription.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/trackEvent.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/trackMeasurementConsent.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/trackPlayStoreSubscription.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/trackThirdPartySharing.mdx delete mode 100644 src/code-snippets/react-native/signatures/Adjust/updateConversionValue.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustAdRevenue/addCallbackParameter.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustAdRevenue/addPartnerParameter.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustAdRevenue/constructor.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustAdRevenue/setAdImpressionsCount.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustAdRevenue/setAdRevenueNetwork.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustAdRevenue/setAdRevenuePlacement.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustAdRevenue/setAdRevenueUnit.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustAdRevenue/setRevenue.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustAppStoreSubscription/addCallbackParameter.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustAppStoreSubscription/addPartnerParameter.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustAppStoreSubscription/constructor.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustAppStoreSubscription/setSalesRegion.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustAppStoreSubscription/setTransactionDate.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/constructor.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/deactivateSKAdNetworkHandling.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/sendInBackground.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/setAttributionCallbackListener.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/setConversionValueUpdatedCallbackListener.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/setCoppaCompliantEnabled.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/setDefaultTracker.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/setDeferredDeeplinkCallbackListener.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/setDelayStart.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/setEventBufferingEnabled.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/setEventTrackingFailedCallbackListener.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/setEventTrackingSucceededCallbackListener.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/setExternalDeviceId.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/setLinkMeEnabled.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/setLogLevel.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/setNeedsCost.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/setPlayStoreKidsAppEnabled.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/setPreinstallFilePath.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/setPreinstallTrackingEnabled.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/setSessionTrackingFailedCallbackListener.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/setSessionTrackingSucceededCallbackListener.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/setShouldLaunchDeeplink.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustConfig/setUrlStrategy.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustEvent/addCallbackParameter.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustEvent/addPartnerParameter.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustEvent/constructor.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustEvent/setCallbackId.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustEvent/setProductId.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustEvent/setPurchaseToken.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustEvent/setReceipt.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustEvent/setRevenue.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustEvent/setTransactionId.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustPlayStoreSubscription/addCallbackParameter.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustPlayStoreSubscription/addPartnerParameter.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustPlayStoreSubscription/constructor.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustPlayStoreSubscription/setPurchaseTime.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustThirdPartySharing/addGranularOption.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustThirdPartySharing/addPartnerSharingSetting.mdx delete mode 100644 src/code-snippets/react-native/signatures/AdjustThirdPartySharing/constructor.mdx create mode 100644 src/content/docs/sdk/react-native/configuration.mdx delete mode 100644 src/content/docs/sdk/react-native/configuration/background.mdx delete mode 100644 src/content/docs/sdk/react-native/configuration/deep-links.mdx delete mode 100644 src/content/docs/sdk/react-native/configuration/delay.mdx delete mode 100644 src/content/docs/sdk/react-native/configuration/disable.mdx delete mode 100644 src/content/docs/sdk/react-native/configuration/external-device-id.mdx delete mode 100644 src/content/docs/sdk/react-native/configuration/index.mdx delete mode 100644 src/content/docs/sdk/react-native/configuration/log-level.mdx delete mode 100644 src/content/docs/sdk/react-native/configuration/preinstalled.mdx delete mode 100644 src/content/docs/sdk/react-native/configuration/privacy.mdx delete mode 100644 src/content/docs/sdk/react-native/configuration/push-tokens.mdx rename src/content/docs/sdk/react-native/{configuration => features}/att.mdx (73%) create mode 100644 src/content/docs/sdk/react-native/features/preinstalled.mdx create mode 100644 src/content/docs/sdk/react-native/features/privacy.mdx rename src/content/docs/sdk/react-native/{configuration => features}/skad.mdx (75%) delete mode 100644 src/content/docs/sdk/react-native/reference/adjust/config.mdx delete mode 100644 src/content/docs/sdk/react-native/reference/adjust/device-info.mdx delete mode 100644 src/content/docs/sdk/react-native/reference/adjust/index.mdx delete mode 100644 src/content/docs/sdk/react-native/reference/adjust/privacy.mdx delete mode 100644 src/content/docs/sdk/react-native/reference/adjust/recording.mdx delete mode 100644 src/content/docs/sdk/react-native/reference/adjust/skan-att.mdx delete mode 100644 src/content/docs/sdk/react-native/reference/adjustadrevenue.mdx delete mode 100644 src/content/docs/sdk/react-native/reference/adjustappstoresubscription.mdx delete mode 100644 src/content/docs/sdk/react-native/reference/adjustattribution.mdx delete mode 100644 src/content/docs/sdk/react-native/reference/adjustconfig/index.mdx delete mode 100644 src/content/docs/sdk/react-native/reference/adjustconfig/privacy.mdx delete mode 100644 src/content/docs/sdk/react-native/reference/adjustconfig/setup.mdx delete mode 100644 src/content/docs/sdk/react-native/reference/adjustevent.mdx delete mode 100644 src/content/docs/sdk/react-native/reference/adjustplaystoresubscription.mdx delete mode 100644 src/content/docs/sdk/react-native/reference/adjustthirdpartysharing.mdx delete mode 100644 src/content/docs/sdk/react-native/reference/index.mdx diff --git a/src/code-snippets/react-native/examples/Adjust/addSessionCallbackParameter.mdx b/src/code-snippets/react-native/examples/Adjust/addSessionCallbackParameter.mdx deleted file mode 100644 index a278e7d1e..000000000 --- a/src/code-snippets/react-native/examples/Adjust/addSessionCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```jsx -Adjust.addSessionCallbackParameter("key", "value"); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/addSessionPartnerParameter.mdx b/src/code-snippets/react-native/examples/Adjust/addSessionPartnerParameter.mdx deleted file mode 100644 index 592b9f518..000000000 --- a/src/code-snippets/react-native/examples/Adjust/addSessionPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```jsx -Adjust.addSessionPartnerParameter("key", "value"); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/appTrackingAuthorizationStatus.mdx b/src/code-snippets/react-native/examples/Adjust/appTrackingAuthorizationStatus.mdx deleted file mode 100644 index 068c2c449..000000000 --- a/src/code-snippets/react-native/examples/Adjust/appTrackingAuthorizationStatus.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```jsx -Adjust.getAppTrackingAuthorizationStatus(); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/checkForNewAttStatus.mdx b/src/code-snippets/react-native/examples/Adjust/checkForNewAttStatus.mdx deleted file mode 100644 index 1e53e5834..000000000 --- a/src/code-snippets/react-native/examples/Adjust/checkForNewAttStatus.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```jsx -Adjust.checkForNewAttStatus(); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/disableThirdPartySharing.mdx b/src/code-snippets/react-native/examples/Adjust/disableThirdPartySharing.mdx deleted file mode 100644 index 85511d864..000000000 --- a/src/code-snippets/react-native/examples/Adjust/disableThirdPartySharing.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```jsx -Adjust.disableThirdPartySharing(); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/gdprForgetMe.mdx b/src/code-snippets/react-native/examples/Adjust/gdprForgetMe.mdx deleted file mode 100644 index 21322cc3f..000000000 --- a/src/code-snippets/react-native/examples/Adjust/gdprForgetMe.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```jsx -Adjust.gdprForgetMe(); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/getAdid.mdx b/src/code-snippets/react-native/examples/Adjust/getAdid.mdx deleted file mode 100644 index 0779b3f76..000000000 --- a/src/code-snippets/react-native/examples/Adjust/getAdid.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```jsx -Adjust.getAdid((adid) => { - console.log("Adid = " + adid); -}); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/getAmazonAdId.mdx b/src/code-snippets/react-native/examples/Adjust/getAmazonAdId.mdx deleted file mode 100644 index 99d3d07e3..000000000 --- a/src/code-snippets/react-native/examples/Adjust/getAmazonAdId.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```jsx -Adjust.getAmazonAdId((amazonAdId) => { - console.log("Amazon Ad Id = " + amazonAdId); -}); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/getAttribution.mdx b/src/code-snippets/react-native/examples/Adjust/getAttribution.mdx deleted file mode 100644 index 31c53dcca..000000000 --- a/src/code-snippets/react-native/examples/Adjust/getAttribution.mdx +++ /dev/null @@ -1,12 +0,0 @@ -```jsx -Adjust.getAttribution((attribution) => { - console.log("Tracker token = " + attribution.trackerToken); - console.log("Tracker name = " + attribution.trackerName); - console.log("Network = " + attribution.network); - console.log("Campaign = " + attribution.campaign); - console.log("Adgroup = " + attribution.adgroup); - console.log("Creative = " + attribution.creative); - console.log("Click label = " + attribution.clickLabel); - console.log("Adid = " + attribution.adid); -}); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/getGoogleAdId.mdx b/src/code-snippets/react-native/examples/Adjust/getGoogleAdId.mdx deleted file mode 100644 index cd98df9c7..000000000 --- a/src/code-snippets/react-native/examples/Adjust/getGoogleAdId.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```jsx -Adjust.getGoogleAdId((googleAdId) => { - console.log("Google Ad Id = " + googleAdId); -}); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/getIdfa.mdx b/src/code-snippets/react-native/examples/Adjust/getIdfa.mdx deleted file mode 100644 index a91867710..000000000 --- a/src/code-snippets/react-native/examples/Adjust/getIdfa.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```jsx -Adjust.getIdfa((idfa) => { - console.log("IDFA = " + idfa); -}); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/isEnabled.mdx b/src/code-snippets/react-native/examples/Adjust/isEnabled.mdx deleted file mode 100644 index ce480e66a..000000000 --- a/src/code-snippets/react-native/examples/Adjust/isEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```jsx -Adjust.isEnabled(); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/removeSessionCallbackParameter.mdx b/src/code-snippets/react-native/examples/Adjust/removeSessionCallbackParameter.mdx deleted file mode 100644 index 3b836c125..000000000 --- a/src/code-snippets/react-native/examples/Adjust/removeSessionCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```jsx -Adjust.removeSessionCallbackParameter("key"); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/removeSessionPartnerParameter.mdx b/src/code-snippets/react-native/examples/Adjust/removeSessionPartnerParameter.mdx deleted file mode 100644 index 9489d5978..000000000 --- a/src/code-snippets/react-native/examples/Adjust/removeSessionPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```jsx -Adjust.removeSessionPartnerParameter("key"); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/requestTrackingAuthorization.mdx b/src/code-snippets/react-native/examples/Adjust/requestTrackingAuthorization.mdx deleted file mode 100644 index c2dbc71a4..000000000 --- a/src/code-snippets/react-native/examples/Adjust/requestTrackingAuthorization.mdx +++ /dev/null @@ -1,18 +0,0 @@ -```jsx -Adjust.requestTrackingAuthorizationWithCompletionHandler(function (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/react-native/examples/Adjust/resetSessionCallbackParameters.mdx b/src/code-snippets/react-native/examples/Adjust/resetSessionCallbackParameters.mdx deleted file mode 100644 index 1aa90c62f..000000000 --- a/src/code-snippets/react-native/examples/Adjust/resetSessionCallbackParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```jsx -Adjust.resetSessionCallbackParameters(); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/resetSessionPartnerParameters.mdx b/src/code-snippets/react-native/examples/Adjust/resetSessionPartnerParameters.mdx deleted file mode 100644 index 3d0bf74ba..000000000 --- a/src/code-snippets/react-native/examples/Adjust/resetSessionPartnerParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```jsx -Adjust.resetSessionPartnerParameters(); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/sendFirstPackages.mdx b/src/code-snippets/react-native/examples/Adjust/sendFirstPackages.mdx deleted file mode 100644 index b12fcb791..000000000 --- a/src/code-snippets/react-native/examples/Adjust/sendFirstPackages.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```jsx -Adjust.sendFirstPackages(); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/setEnabled.mdx b/src/code-snippets/react-native/examples/Adjust/setEnabled.mdx deleted file mode 100644 index 7e07ff9ce..000000000 --- a/src/code-snippets/react-native/examples/Adjust/setEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```jsx -Adjust.setEnabled(false); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/setOfflineMode.mdx b/src/code-snippets/react-native/examples/Adjust/setOfflineMode.mdx deleted file mode 100644 index 30aa583a9..000000000 --- a/src/code-snippets/react-native/examples/Adjust/setOfflineMode.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```jsx -Adjust.setOfflineMode(true); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/setPushToken.mdx b/src/code-snippets/react-native/examples/Adjust/setPushToken.mdx deleted file mode 100644 index 286eef485..000000000 --- a/src/code-snippets/react-native/examples/Adjust/setPushToken.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```jsx -Adjust.setPushToken("YourPushNotificationToken"); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/trackAdRevenue.mdx b/src/code-snippets/react-native/examples/Adjust/trackAdRevenue.mdx deleted file mode 100644 index 2b2cd16c9..000000000 --- a/src/code-snippets/react-native/examples/Adjust/trackAdRevenue.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```jsx -var adjustAdRevenue = new AdjustAdRevenue("source"); -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/trackAppStoreSubscription.mdx b/src/code-snippets/react-native/examples/Adjust/trackAppStoreSubscription.mdx deleted file mode 100644 index be9e3428a..000000000 --- a/src/code-snippets/react-native/examples/Adjust/trackAppStoreSubscription.mdx +++ /dev/null @@ -1,12 +0,0 @@ -```jsx {10} -var subscription = new AdjustAppStoreSubscription( - price, - currency, - transactionId, - receipt -); -subscription.setTransactionDate(transactionDate); -subscription.setSalesRegion(salesRegion); - -Adjust.trackAppStoreSubscription(subscription); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/trackEvent.mdx b/src/code-snippets/react-native/examples/Adjust/trackEvent.mdx deleted file mode 100644 index 65e46fa05..000000000 --- a/src/code-snippets/react-native/examples/Adjust/trackEvent.mdx +++ /dev/null @@ -1,4 +0,0 @@ -```jsx -var adjustEvent = new AdjustEvent("abc123"); -Adjust.trackEvent(adjustEvent); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/trackMeasurementConsent.mdx b/src/code-snippets/react-native/examples/Adjust/trackMeasurementConsent.mdx deleted file mode 100644 index 9dbca57ae..000000000 --- a/src/code-snippets/react-native/examples/Adjust/trackMeasurementConsent.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```jsx -Adjust.trackMeasurementConsent(true); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/trackPlayStoreSubscription.mdx b/src/code-snippets/react-native/examples/Adjust/trackPlayStoreSubscription.mdx deleted file mode 100644 index 3efffc9a9..000000000 --- a/src/code-snippets/react-native/examples/Adjust/trackPlayStoreSubscription.mdx +++ /dev/null @@ -1,13 +0,0 @@ -```jsx {11} -var subscription = new AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken -); -subscription.setPurchaseTime(purchaseTime); - -Adjust.trackPlayStoreSubscription(subscription); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/trackThirdPartySharing.mdx b/src/code-snippets/react-native/examples/Adjust/trackThirdPartySharing.mdx deleted file mode 100644 index 06b920d79..000000000 --- a/src/code-snippets/react-native/examples/Adjust/trackThirdPartySharing.mdx +++ /dev/null @@ -1,4 +0,0 @@ -```jsx -var adjustThirdPartySharing = new AdjustThirdPartySharing(true); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` diff --git a/src/code-snippets/react-native/examples/Adjust/updateConversionValue.mdx b/src/code-snippets/react-native/examples/Adjust/updateConversionValue.mdx deleted file mode 100644 index 3d242c5aa..000000000 --- a/src/code-snippets/react-native/examples/Adjust/updateConversionValue.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```jsx -Adjust.updateConversionValue(6); -``` diff --git a/src/code-snippets/react-native/examples/AdjustAdRevenue/addCallbackParameter.mdx b/src/code-snippets/react-native/examples/AdjustAdRevenue/addCallbackParameter.mdx deleted file mode 100644 index 379cc14f7..000000000 --- a/src/code-snippets/react-native/examples/AdjustAdRevenue/addCallbackParameter.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```jsx {3} -var adjustAdRevenue = new AdjustAdRevenue("source"); -//... -adjustAdRevenue.addCallbackParameter("key", "value"); -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/react-native/examples/AdjustAdRevenue/addPartnerParameter.mdx b/src/code-snippets/react-native/examples/AdjustAdRevenue/addPartnerParameter.mdx deleted file mode 100644 index 659f8d565..000000000 --- a/src/code-snippets/react-native/examples/AdjustAdRevenue/addPartnerParameter.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```jsx {3} -var adjustAdRevenue = new AdjustAdRevenue("source"); -//... -adjustAdRevenue.addPartnerParameter("key", "value"); -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/react-native/examples/AdjustAdRevenue/constructor.mdx b/src/code-snippets/react-native/examples/AdjustAdRevenue/constructor.mdx deleted file mode 100644 index 453576c0a..000000000 --- a/src/code-snippets/react-native/examples/AdjustAdRevenue/constructor.mdx +++ /dev/null @@ -1,4 +0,0 @@ -```jsx {1} -var adjustAdRevenue = new AdjustAdRevenue("source"); -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/react-native/examples/AdjustAdRevenue/setAdImpressionsCount.mdx b/src/code-snippets/react-native/examples/AdjustAdRevenue/setAdImpressionsCount.mdx deleted file mode 100644 index 7e1b9a2a6..000000000 --- a/src/code-snippets/react-native/examples/AdjustAdRevenue/setAdImpressionsCount.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```jsx {3} -var adjustAdRevenue = new AdjustAdRevenue("source"); -//... -adjustAdRevenue.setAdImpressionsCount(10); -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/react-native/examples/AdjustAdRevenue/setAdRevenueNetwork.mdx b/src/code-snippets/react-native/examples/AdjustAdRevenue/setAdRevenueNetwork.mdx deleted file mode 100644 index 0c8ab5858..000000000 --- a/src/code-snippets/react-native/examples/AdjustAdRevenue/setAdRevenueNetwork.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```jsx {3} -var adjustAdRevenue = new AdjustAdRevenue("source"); -//... -adjustAdRevenue.setAdRevenueNetwork("network1"); -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/react-native/examples/AdjustAdRevenue/setAdRevenuePlacement.mdx b/src/code-snippets/react-native/examples/AdjustAdRevenue/setAdRevenuePlacement.mdx deleted file mode 100644 index 46836145b..000000000 --- a/src/code-snippets/react-native/examples/AdjustAdRevenue/setAdRevenuePlacement.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```jsx {3} -var adjustAdRevenue = new AdjustAdRevenue("source"); -//... -adjustAdRevenue.setAdRevenuePlacement("banner"); -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/react-native/examples/AdjustAdRevenue/setAdRevenueUnit.mdx b/src/code-snippets/react-native/examples/AdjustAdRevenue/setAdRevenueUnit.mdx deleted file mode 100644 index 48fda6dba..000000000 --- a/src/code-snippets/react-native/examples/AdjustAdRevenue/setAdRevenueUnit.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```jsx {3} -var adjustAdRevenue = new AdjustAdRevenue("source"); -//... -adjustAdRevenue.setAdRevenueUnit("unit1"); -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/react-native/examples/AdjustAdRevenue/setRevenue.mdx b/src/code-snippets/react-native/examples/AdjustAdRevenue/setRevenue.mdx deleted file mode 100644 index f111ffbd9..000000000 --- a/src/code-snippets/react-native/examples/AdjustAdRevenue/setRevenue.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```jsx {3} -var adjustAdRevenue = new AdjustAdRevenue("source"); -//... -adjustAdRevenue.setRevenue(1.00, "EUR"); -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/react-native/examples/AdjustAppStoreSubscription/addCallbackParameter.mdx b/src/code-snippets/react-native/examples/AdjustAppStoreSubscription/addCallbackParameter.mdx deleted file mode 100644 index 6cb2502e9..000000000 --- a/src/code-snippets/react-native/examples/AdjustAppStoreSubscription/addCallbackParameter.mdx +++ /dev/null @@ -1,15 +0,0 @@ -```jsx {10-11} -var subscription = new AdjustAppStoreSubscription( - price, - currency, - transactionId, - receipt -); -subscription.setTransactionDate(transactionDate); -subscription.setSalesRegion(salesRegion); -//... -subscription.addCallbackParameter("key1", "value1"); -subscription.addCallbackParameter("key2", "value2"); - -Adjust.trackAppStoreSubscription(subscription); -``` diff --git a/src/code-snippets/react-native/examples/AdjustAppStoreSubscription/addPartnerParameter.mdx b/src/code-snippets/react-native/examples/AdjustAppStoreSubscription/addPartnerParameter.mdx deleted file mode 100644 index ad219f884..000000000 --- a/src/code-snippets/react-native/examples/AdjustAppStoreSubscription/addPartnerParameter.mdx +++ /dev/null @@ -1,15 +0,0 @@ -```jsx {10-11} -var subscription = new AdjustAppStoreSubscription( - price, - currency, - transactionId, - receipt -); -subscription.setTransactionDate(transactionDate); -subscription.setSalesRegion(salesRegion); -//... -subscription.addPartnerParameter("key1", "value1"); -subscription.addPartnerParameter("key2", "value2"); - -Adjust.trackAppStoreSubscription(subscription); -``` diff --git a/src/code-snippets/react-native/examples/AdjustAppStoreSubscription/adjustAppStoreSubscription.mdx b/src/code-snippets/react-native/examples/AdjustAppStoreSubscription/adjustAppStoreSubscription.mdx deleted file mode 100644 index fa0b6168b..000000000 --- a/src/code-snippets/react-native/examples/AdjustAppStoreSubscription/adjustAppStoreSubscription.mdx +++ /dev/null @@ -1,11 +0,0 @@ -```jsx {9} -var subscription = new AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken -); -Adjust.trackPlayStoreSubscription(subscription); -``` diff --git a/src/code-snippets/react-native/examples/AdjustAppStoreSubscription/setSalesRegion.mdx b/src/code-snippets/react-native/examples/AdjustAppStoreSubscription/setSalesRegion.mdx deleted file mode 100644 index 5649c3ff0..000000000 --- a/src/code-snippets/react-native/examples/AdjustAppStoreSubscription/setSalesRegion.mdx +++ /dev/null @@ -1,13 +0,0 @@ -```jsx {10} -var subscription = new AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken -); -//... -subscription.setSalesRegion(salesRegion); -Adjust.trackPlayStoreSubscription(subscription); -``` diff --git a/src/code-snippets/react-native/examples/AdjustAppStoreSubscription/setTransactionDate.mdx b/src/code-snippets/react-native/examples/AdjustAppStoreSubscription/setTransactionDate.mdx deleted file mode 100644 index c965a842c..000000000 --- a/src/code-snippets/react-native/examples/AdjustAppStoreSubscription/setTransactionDate.mdx +++ /dev/null @@ -1,13 +0,0 @@ -```jsx {10} -var subscription = new AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken -); -//... -subscription.setTransactionDate(transactionDate); -Adjust.trackPlayStoreSubscription(subscription); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/constructor.mdx b/src/code-snippets/react-native/examples/AdjustConfig/constructor.mdx deleted file mode 100644 index 4d5bbaf0d..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/constructor.mdx +++ /dev/null @@ -1,8 +0,0 @@ -```jsx -const adjustConfig = new AdjustConfig( - "{YourAppToken}", - AdjustConfig.EnvironmentSandbox -); -//... -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/deactivateSKAdNetworkHandling.mdx b/src/code-snippets/react-native/examples/AdjustConfig/deactivateSKAdNetworkHandling.mdx deleted file mode 100644 index 947eb7df2..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/deactivateSKAdNetworkHandling.mdx +++ /dev/null @@ -1,10 +0,0 @@ -```jsx {6} -const adjustConfig = new AdjustConfig( - "{YourAppToken}", - AdjustConfig.EnvironmentSandbox -); -//... -adjustConfig.deactivateSKAdNetworkHandling(); -//... -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/sendInBackground.mdx b/src/code-snippets/react-native/examples/AdjustConfig/sendInBackground.mdx deleted file mode 100644 index 7ac7d6ce9..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/sendInBackground.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```jsx {3} -const adjustConfig = new AdjustConfig(appToken, environment); -//... -adjustConfig.setSendInBackground(true); -//... -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/setAttributionCallbackListener.mdx b/src/code-snippets/react-native/examples/AdjustConfig/setAttributionCallbackListener.mdx deleted file mode 100644 index 6452124a4..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/setAttributionCallbackListener.mdx +++ /dev/null @@ -1,22 +0,0 @@ -```jsx {3-18} -const adjustConfig = new AdjustConfig(appToken, environment); - -adjustConfig.setAttributionCallbackListener(function (attribution) { - // Printing all attribution properties. - console.log("Attribution changed!"); - console.log(attribution.trackerToken); - console.log(attribution.trackerName); - console.log(attribution.network); - console.log(attribution.campaign); - console.log(attribution.adgroup); - console.log(attribution.creative); - console.log(attribution.clickLabel); - console.log(attribution.adid); - console.log(attribution.costType); - console.log(attribution.costAmount); - console.log(attribution.costCurrency); - console.log(attribution.fbInstallReferrer); -}); - -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/setConversionValueUpdatedCallbackListener.mdx b/src/code-snippets/react-native/examples/AdjustConfig/setConversionValueUpdatedCallbackListener.mdx deleted file mode 100644 index b0ba46f20..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/setConversionValueUpdatedCallbackListener.mdx +++ /dev/null @@ -1,12 +0,0 @@ -```jsx {3-8} -const adjustConfig = new AdjustConfig(appToken, environment); - -adjustConfig.setConversionValueUpdatedCallbackListener(function ( - conversionValue -) { - console.log("Conversion value updated callback recveived"); - console.log("Conversion value: " + conversionValue.conversionValue); -}); - -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/setCoppaCompliantEnabled.mdx b/src/code-snippets/react-native/examples/AdjustConfig/setCoppaCompliantEnabled.mdx deleted file mode 100644 index ce329c10e..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/setCoppaCompliantEnabled.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```jsx {6} -const adjustConfig = new AdjustConfig( - "{YourAppToken}", - AdjustConfig.EnvironmentSandbox -); -//... -adjustConfig.setCoppaCompliantEnabled(true); -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/setDefaultTracker.mdx b/src/code-snippets/react-native/examples/AdjustConfig/setDefaultTracker.mdx deleted file mode 100644 index 7f0de47e8..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/setDefaultTracker.mdx +++ /dev/null @@ -1,10 +0,0 @@ -```jsx {6} -const adjustConfig = new AdjustConfig( - "{YourAppToken}", - AdjustConfig.EnvironmentSandbox -); -//... -adjustConfig.setDefaultTracker("{TrackerToken}"); -//... -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/setDeferredDeeplinkCallbackListener.mdx b/src/code-snippets/react-native/examples/AdjustConfig/setDeferredDeeplinkCallbackListener.mdx deleted file mode 100644 index 6b6c01a05..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/setDeferredDeeplinkCallbackListener.mdx +++ /dev/null @@ -1,12 +0,0 @@ -```jsx {6-8} -const adjustConfig = new AdjustConfig( - "{YourAppToken}", - AdjustConfig.EnvironmentSandbox -); -//.. -adjustConfig.setDeferredDeeplinkCallbackListener(function (deeplink) { - console.log("Deferred deep link URL content: " + deeplink); -}); -//... -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/setDelayStart.mdx b/src/code-snippets/react-native/examples/AdjustConfig/setDelayStart.mdx deleted file mode 100644 index 0a7e42edb..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/setDelayStart.mdx +++ /dev/null @@ -1,10 +0,0 @@ -```jsx {6} -const adjustConfig = new AdjustConfig( - "{YourAppToken}", - AdjustConfig.EnvironmentSandbox -); -//... -adjustConfig.setDelayStart(5.5); -//... -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/setEventBufferingEnabled.mdx b/src/code-snippets/react-native/examples/AdjustConfig/setEventBufferingEnabled.mdx deleted file mode 100644 index 0f18692a3..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/setEventBufferingEnabled.mdx +++ /dev/null @@ -1,10 +0,0 @@ -```jsx {6} -const adjustConfig = new AdjustConfig( - "{YourAppToken}", - AdjustConfig.EnvironmentSandbox -); -//... -adjustConfig.setEventBufferingEnabled(true); -//... -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/setEventTrackingFailedCallbackListener.mdx b/src/code-snippets/react-native/examples/AdjustConfig/setEventTrackingFailedCallbackListener.mdx deleted file mode 100644 index fb7bad659..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/setEventTrackingFailedCallbackListener.mdx +++ /dev/null @@ -1,20 +0,0 @@ -```jsx {6-16} -const adjustConfig = new AdjustConfig( - "{Your App Token}", - AdjustConfig.EnvironmentSandbox -); -adjustConfig.setLogLevel(AdjustLogLevel.Verbose); -adjustConfig.setEventTrackingFailedCallbackListener(function (eventFailure) { - // Printing all event failure properties. - console.log("Event tracking failed!"); - console.log(eventFailure.message); - console.log(eventFailure.timestamp); - console.log(eventFailure.eventToken); - console.log(eventFailure.callbackId); - console.log(eventFailure.adid); - console.log(eventFailure.willRetry); - console.log(eventFailure.jsonResponse); -}); -//... -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/setEventTrackingSucceededCallbackListener.mdx b/src/code-snippets/react-native/examples/AdjustConfig/setEventTrackingSucceededCallbackListener.mdx deleted file mode 100644 index e111212aa..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/setEventTrackingSucceededCallbackListener.mdx +++ /dev/null @@ -1,19 +0,0 @@ -```jsx {6-15} -const adjustConfig = new AdjustConfig( - "{YourAppToken}", - AdjustConfig.EnvironmentSandbox -); -//... -adjustConfig.setEventTrackingSucceededCallbackListener(function (eventSuccess) { - // Printing all event success properties. - console.log("Event tracking succeeded!"); - console.log(eventSuccess.message); - console.log(eventSuccess.timestamp); - console.log(eventSuccess.eventToken); - console.log(eventSuccess.callbackId); - console.log(eventSuccess.adid); - console.log(eventSuccess.jsonResponse); -}); -//... -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/setExternalDeviceId.mdx b/src/code-snippets/react-native/examples/AdjustConfig/setExternalDeviceId.mdx deleted file mode 100644 index dac5167b6..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/setExternalDeviceId.mdx +++ /dev/null @@ -1,10 +0,0 @@ -```jsx {6} -const adjustConfig = new AdjustConfig( - "{YourAppToken}", - AdjustConfig.EnvironmentSandbox -); -//... -adjustConfig.setExternalDeviceId("{Your-External-Device-Id}"); -//... -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/setLaunchDeferredDeeplink.mdx b/src/code-snippets/react-native/examples/AdjustConfig/setLaunchDeferredDeeplink.mdx deleted file mode 100644 index 3bdae320a..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/setLaunchDeferredDeeplink.mdx +++ /dev/null @@ -1,10 +0,0 @@ -```jsx {6} -const adjustConfig = new AdjustConfig( - "{YourAppToken}", - AdjustConfig.EnvironmentSandbox -); -//... -adjustConfig.setLaunchDeferredDeeplink(true); -//... -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/setLinkMeEnabled.mdx b/src/code-snippets/react-native/examples/AdjustConfig/setLinkMeEnabled.mdx deleted file mode 100644 index 11eda68ef..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/setLinkMeEnabled.mdx +++ /dev/null @@ -1,10 +0,0 @@ -```jsx {6} -const adjustConfig = new AdjustConfig( - "{YourAppToken}", - AdjustConfig.EnvironmentSandbox -); -//... -adjustConfig.setLinkMeEnabled(true); -//... -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/setLogLevel.mdx b/src/code-snippets/react-native/examples/AdjustConfig/setLogLevel.mdx deleted file mode 100644 index 8250b2221..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/setLogLevel.mdx +++ /dev/null @@ -1,10 +0,0 @@ -```jsx {6} -const adjustConfig = new AdjustConfig( - "{YourAppToken}", - AdjustConfig.EnvironmentSandbox -); -//... -adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose); -//... -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/setNeedsCost.mdx b/src/code-snippets/react-native/examples/AdjustConfig/setNeedsCost.mdx deleted file mode 100644 index b52370628..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/setNeedsCost.mdx +++ /dev/null @@ -1,8 +0,0 @@ -```jsx {6} -const adjustConfig = new AdjustConfig( - "{Your App Token}", - AdjustConfig.EnvironmentSandbox -); -adjustConfig.setLogLevel(AdjustLogLevel.Verbose); -adjustConfig.setNeedsCost(true); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/setPlayStoreKidsAppEnabled.mdx b/src/code-snippets/react-native/examples/AdjustConfig/setPlayStoreKidsAppEnabled.mdx deleted file mode 100644 index bde401336..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/setPlayStoreKidsAppEnabled.mdx +++ /dev/null @@ -1,10 +0,0 @@ -```jsx {6} -const adjustConfig = new AdjustConfig( - "{YourAppToken}", - AdjustConfig.EnvironmentSandbox -); -//... -adjustConfig.setPlayStoreKidsAppEnabled(true); -//... -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/setPreinstallFilePath.mdx b/src/code-snippets/react-native/examples/AdjustConfig/setPreinstallFilePath.mdx deleted file mode 100644 index b473cd5a5..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/setPreinstallFilePath.mdx +++ /dev/null @@ -1,10 +0,0 @@ -```jsx {6} -const adjustConfig = new AdjustConfig( - "{YourAppToken}", - AdjustConfig.EnvironmentSandbox, -); -//... -adjustConfig.setPreinstallFilePath("../EngagementFile.xml"); -//... -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/setPreinstallTrackingEnabled.mdx b/src/code-snippets/react-native/examples/AdjustConfig/setPreinstallTrackingEnabled.mdx deleted file mode 100644 index 0846573ab..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/setPreinstallTrackingEnabled.mdx +++ /dev/null @@ -1,10 +0,0 @@ -```jsx {6} -const adjustConfig = new AdjustConfig( - "{YourAppToken}", - AdjustConfig.EnvironmentSandbox, -); -//... -adjustConfig.setPreinstallTrackingEnabled(true); -//... -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/setSessionTrackingFailedCallbackListener.mdx b/src/code-snippets/react-native/examples/AdjustConfig/setSessionTrackingFailedCallbackListener.mdx deleted file mode 100644 index a3659de1f..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/setSessionTrackingFailedCallbackListener.mdx +++ /dev/null @@ -1,20 +0,0 @@ -```jsx {6-16} -const adjustConfig = new AdjustConfig( - "{YourAppToken}", - AdjustConfig.EnvironmentSandbox -); -//... -adjustConfig.setSessionTrackingFailedCallbackListener(function ( - sessionFailure -) { - // Printing all session failure properties. - console.log("Session tracking failed!"); - console.log(sessionFailure.message); - console.log(sessionFailure.timestamp); - console.log(sessionFailure.adid); - console.log(sessionFailure.willRetry); - console.log(sessionFailure.jsonResponse); -}); -//... -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/setSessionTrackingSucceededCallbackListener.mdx b/src/code-snippets/react-native/examples/AdjustConfig/setSessionTrackingSucceededCallbackListener.mdx deleted file mode 100644 index c3a178dd8..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/setSessionTrackingSucceededCallbackListener.mdx +++ /dev/null @@ -1,19 +0,0 @@ -```jsx {6-15} -const adjustConfig = new AdjustConfig( - "{YourAppToken}", - AdjustConfig.EnvironmentSandbox -); -//... -adjustConfig.setSessionTrackingSucceededCallbackListener(function ( - sessionSuccess -) { - // Printing all session success properties. - console.log("Session tracking succeeded!"); - console.log(sessionSuccess.message); - console.log(sessionSuccess.timestamp); - console.log(sessionSuccess.adid); - console.log(sessionSuccess.jsonResponse); -}); -//... -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/setShouldLaunchDeeplink.mdx b/src/code-snippets/react-native/examples/AdjustConfig/setShouldLaunchDeeplink.mdx deleted file mode 100644 index 9e11388e8..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/setShouldLaunchDeeplink.mdx +++ /dev/null @@ -1,10 +0,0 @@ -```jsx {6} -const adjustConfig = new AdjustConfig( - "{YourAppToken}", - AdjustConfig.EnvironmentSandbox -); -//... -adjustConfig.setShouldLaunchDeeplink(true); -//... -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustConfig/setUrlStrategy.mdx b/src/code-snippets/react-native/examples/AdjustConfig/setUrlStrategy.mdx deleted file mode 100644 index 441918201..000000000 --- a/src/code-snippets/react-native/examples/AdjustConfig/setUrlStrategy.mdx +++ /dev/null @@ -1,8 +0,0 @@ -```jsx "AdjustConfig.AdjustDataResidencyEU" {5} -const adjustConfig = new AdjustConfig( - "{YourAppToken}", - AdjustConfig.EnvironmentSandbox -); -adjustConfig.setUrlStrategy(AdjustConfig.DataResidencyEU); -Adjust.create(adjustConfig); -``` diff --git a/src/code-snippets/react-native/examples/AdjustEvent/addCallbackParameter.mdx b/src/code-snippets/react-native/examples/AdjustEvent/addCallbackParameter.mdx deleted file mode 100644 index 7de2e8e94..000000000 --- a/src/code-snippets/react-native/examples/AdjustEvent/addCallbackParameter.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```jsx {3} -var adjustEvent = new AdjustEvent("abc123"); -//... -adjustEvent.addCallbackParameter("key", "value"); -//... -Adjust.trackEvent(adjustEvent); -``` diff --git a/src/code-snippets/react-native/examples/AdjustEvent/addPartnerParameter.mdx b/src/code-snippets/react-native/examples/AdjustEvent/addPartnerParameter.mdx deleted file mode 100644 index ffb137a6d..000000000 --- a/src/code-snippets/react-native/examples/AdjustEvent/addPartnerParameter.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```jsx {3} -var adjustEvent = new AdjustEvent("abc123"); -//... -adjustEvent.addPartnerParameter("key", "value"); -//... -Adjust.trackEvent(adjustEvent); -``` diff --git a/src/code-snippets/react-native/examples/AdjustEvent/constructor.mdx b/src/code-snippets/react-native/examples/AdjustEvent/constructor.mdx deleted file mode 100644 index 09d32a084..000000000 --- a/src/code-snippets/react-native/examples/AdjustEvent/constructor.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```jsx -var adjustEvent = new AdjustEvent("abc123"); -//... -Adjust.trackEvent(adjustEvent); -``` diff --git a/src/code-snippets/react-native/examples/AdjustEvent/setCallbackId.mdx b/src/code-snippets/react-native/examples/AdjustEvent/setCallbackId.mdx deleted file mode 100644 index 21a2dbbe7..000000000 --- a/src/code-snippets/react-native/examples/AdjustEvent/setCallbackId.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```jsx {3} -var adjustEvent = new AdjustEvent("abc123"); -//... -adjustEvent.setCallbackId("your_callback_id"); -//... -Adjust.trackEvent(adjustEvent); -``` diff --git a/src/code-snippets/react-native/examples/AdjustEvent/setRevenue.mdx b/src/code-snippets/react-native/examples/AdjustEvent/setRevenue.mdx deleted file mode 100644 index 1504568fa..000000000 --- a/src/code-snippets/react-native/examples/AdjustEvent/setRevenue.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```jsx {3} -var adjustEvent = new AdjustEvent("abc123"); -//... -adjustEvent.setRevenue(0.01, "EUR"); -//... -Adjust.trackEvent(adjustEvent); -``` diff --git a/src/code-snippets/react-native/examples/AdjustEvent/setTransactionId.mdx b/src/code-snippets/react-native/examples/AdjustEvent/setTransactionId.mdx deleted file mode 100644 index 362a94bcb..000000000 --- a/src/code-snippets/react-native/examples/AdjustEvent/setTransactionId.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```jsx {3} -var adjustEvent = new AdjustEvent("abc123"); -//... -adjustEvent.setTransactionId("{transactionId}"); -//... -Adjust.trackEvent(adjustEvent); -``` diff --git a/src/code-snippets/react-native/examples/AdjustPlayStoreSubscription/addCallbackParameter.mdx b/src/code-snippets/react-native/examples/AdjustPlayStoreSubscription/addCallbackParameter.mdx deleted file mode 100644 index bc4f1de71..000000000 --- a/src/code-snippets/react-native/examples/AdjustPlayStoreSubscription/addCallbackParameter.mdx +++ /dev/null @@ -1,13 +0,0 @@ -```jsx {10,11} -var subscription = new AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken -); -//... -subscription.addCallbackParameter("key1", "value1"); -subscription.addCallbackParameter("key2", "value2"); -``` diff --git a/src/code-snippets/react-native/examples/AdjustPlayStoreSubscription/addPartnerParameter.mdx b/src/code-snippets/react-native/examples/AdjustPlayStoreSubscription/addPartnerParameter.mdx deleted file mode 100644 index 9504a349a..000000000 --- a/src/code-snippets/react-native/examples/AdjustPlayStoreSubscription/addPartnerParameter.mdx +++ /dev/null @@ -1,13 +0,0 @@ -```jsx {10,11} -var subscription = new AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken -); -//... -subscription.addPartnerParameter("key1", "value1"); -subscription.addPartnerParameter("key2", "value2"); -``` diff --git a/src/code-snippets/react-native/examples/AdjustPlayStoreSubscription/adjustPlayStoreSubscription.mdx b/src/code-snippets/react-native/examples/AdjustPlayStoreSubscription/adjustPlayStoreSubscription.mdx deleted file mode 100644 index b748e57b5..000000000 --- a/src/code-snippets/react-native/examples/AdjustPlayStoreSubscription/adjustPlayStoreSubscription.mdx +++ /dev/null @@ -1,10 +0,0 @@ -```jsx -var subscription = new AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken -); -``` diff --git a/src/code-snippets/react-native/examples/AdjustPlayStoreSubscription/setPurchaseTime.mdx b/src/code-snippets/react-native/examples/AdjustPlayStoreSubscription/setPurchaseTime.mdx deleted file mode 100644 index 8f0cef395..000000000 --- a/src/code-snippets/react-native/examples/AdjustPlayStoreSubscription/setPurchaseTime.mdx +++ /dev/null @@ -1,11 +0,0 @@ -```jsx {9} -var subscription = new AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken -); -subscription.setPurchaseTime(purchaseTime); -``` diff --git a/src/code-snippets/react-native/examples/AdjustThirdPartySharing/addGranularOption.mdx b/src/code-snippets/react-native/examples/AdjustThirdPartySharing/addGranularOption.mdx deleted file mode 100644 index 881761082..000000000 --- a/src/code-snippets/react-native/examples/AdjustThirdPartySharing/addGranularOption.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```jsx {3} -var adjustThirdPartySharing = new AdjustThirdPartySharing(null); -//... -adjustThirdPartySharing.addGranularOption("PartnerA", "key", "value"); -//... -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` diff --git a/src/code-snippets/react-native/examples/AdjustThirdPartySharing/addGranularOptionFacebook.mdx b/src/code-snippets/react-native/examples/AdjustThirdPartySharing/addGranularOptionFacebook.mdx deleted file mode 100644 index 0cd442157..000000000 --- a/src/code-snippets/react-native/examples/AdjustThirdPartySharing/addGranularOptionFacebook.mdx +++ /dev/null @@ -1,16 +0,0 @@ -```jsx {3-12} -var adjustThirdPartySharing = new AdjustThirdPartySharing(null); -//... -adjustThirdPartySharing.addGranularOption( - "facebook", - "data_processing_options_country", - "1" -); -adjustThirdPartySharing.addGranularOption( - "facebook", - "data_processing_options_state", - "1000" -); -//... -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` diff --git a/src/code-snippets/react-native/examples/AdjustThirdPartySharing/addPartnerSharingSetting.mdx b/src/code-snippets/react-native/examples/AdjustThirdPartySharing/addPartnerSharingSetting.mdx deleted file mode 100644 index a61940bb6..000000000 --- a/src/code-snippets/react-native/examples/AdjustThirdPartySharing/addPartnerSharingSetting.mdx +++ /dev/null @@ -1,6 +0,0 @@ -```jsx {3} -var adjustThirdPartySharing = new AdjustThirdPartySharing(null); -//... -adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "foo", false); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` diff --git a/src/code-snippets/react-native/examples/AdjustThirdPartySharing/initFalse.mdx b/src/code-snippets/react-native/examples/AdjustThirdPartySharing/initFalse.mdx deleted file mode 100644 index 406755c62..000000000 --- a/src/code-snippets/react-native/examples/AdjustThirdPartySharing/initFalse.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```jsx "false" -var adjustThirdPartySharing = new AdjustThirdPartySharing(false); -//... -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` diff --git a/src/code-snippets/react-native/examples/AdjustThirdPartySharing/initTrue.mdx b/src/code-snippets/react-native/examples/AdjustThirdPartySharing/initTrue.mdx deleted file mode 100644 index 670e757ca..000000000 --- a/src/code-snippets/react-native/examples/AdjustThirdPartySharing/initTrue.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```jsx "true" -var adjustThirdPartySharing = new AdjustThirdPartySharing(true); -//... -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/addSessionCallbackParameter.mdx b/src/code-snippets/react-native/signatures/Adjust/addSessionCallbackParameter.mdx deleted file mode 100644 index 28ab23ab3..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/addSessionCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -addSessionCallbackParameter: (key: string, value: string) => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/addSessionPartnerParameter.mdx b/src/code-snippets/react-native/signatures/Adjust/addSessionPartnerParameter.mdx deleted file mode 100644 index 8ace442b2..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/addSessionPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -addSessionPartnerParameter: (key: string, value: string) => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/appTrackingAuthorizationStatus.mdx b/src/code-snippets/react-native/signatures/Adjust/appTrackingAuthorizationStatus.mdx deleted file mode 100644 index 0432f563c..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/appTrackingAuthorizationStatus.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -getAppTrackingAuthorizationStatus: (callback: (authorizationStatus: number) => void) => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/checkForNewAttStatus.mdx b/src/code-snippets/react-native/signatures/Adjust/checkForNewAttStatus.mdx deleted file mode 100644 index 4cbb63437..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/checkForNewAttStatus.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -checkForNewAttStatus: () => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/disableThirdPartySharing.mdx b/src/code-snippets/react-native/signatures/Adjust/disableThirdPartySharing.mdx deleted file mode 100644 index f1e5ec247..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/disableThirdPartySharing.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -disableThirdPartySharing: () => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/gdprForgetMe.mdx b/src/code-snippets/react-native/signatures/Adjust/gdprForgetMe.mdx deleted file mode 100644 index 0fdbf1b54..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/gdprForgetMe.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -gdprForgetMe: () => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/getAdid.mdx b/src/code-snippets/react-native/signatures/Adjust/getAdid.mdx deleted file mode 100644 index 90e13e6e2..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/getAdid.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -getAdid: (callback: (adid: string) => void) => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/getAmazonAdId.mdx b/src/code-snippets/react-native/signatures/Adjust/getAmazonAdId.mdx deleted file mode 100644 index 117c28538..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/getAmazonAdId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -getAmazonAdId: (callback: (adid: string) => void) => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/getAttribution.mdx b/src/code-snippets/react-native/signatures/Adjust/getAttribution.mdx deleted file mode 100644 index b27806856..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/getAttribution.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -getAttribution: (callback: (attribution: AdjustAttribution) => void) => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/getGoogleAdId.mdx b/src/code-snippets/react-native/signatures/Adjust/getGoogleAdId.mdx deleted file mode 100644 index 5c2af5d99..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/getGoogleAdId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -getGoogleAdId: (callback: (adid: string) => void) => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/getIdfa.mdx b/src/code-snippets/react-native/signatures/Adjust/getIdfa.mdx deleted file mode 100644 index 89f601cf1..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/getIdfa.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -getIdfa: (callback: (idfa: string) => void) => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/isEnabled.mdx b/src/code-snippets/react-native/signatures/Adjust/isEnabled.mdx deleted file mode 100644 index 091777164..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/isEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -isEnabled: (callback: (enabled: boolean) => void) => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/removeSessionCallbackParameter.mdx b/src/code-snippets/react-native/signatures/Adjust/removeSessionCallbackParameter.mdx deleted file mode 100644 index f45f14c2e..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/removeSessionCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -removeSessionCallbackParameter: (key: string) => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/removeSessionPartnerParameter.mdx b/src/code-snippets/react-native/signatures/Adjust/removeSessionPartnerParameter.mdx deleted file mode 100644 index 5802b2504..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/removeSessionPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -removeSessionPartnerParameter: (key: string) => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/requestTrackingAuthorization.mdx b/src/code-snippets/react-native/signatures/Adjust/requestTrackingAuthorization.mdx deleted file mode 100644 index dd7998120..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/requestTrackingAuthorization.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -requestTrackingAuthorizationWithCompletionHandler: (handler: (status: number) => void) => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/resetSessionCallbackParameters.mdx b/src/code-snippets/react-native/signatures/Adjust/resetSessionCallbackParameters.mdx deleted file mode 100644 index 51421c2eb..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/resetSessionCallbackParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -resetSessionCallbackParameters: () => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/resetSessionPartnerParameters.mdx b/src/code-snippets/react-native/signatures/Adjust/resetSessionPartnerParameters.mdx deleted file mode 100644 index c5f4e1b18..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/resetSessionPartnerParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -resetSessionPartnerParameters: () => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/sendFirstPackages.mdx b/src/code-snippets/react-native/signatures/Adjust/sendFirstPackages.mdx deleted file mode 100644 index 304cac99a..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/sendFirstPackages.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -sendFirstPackages: () => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/setEnabled.mdx b/src/code-snippets/react-native/signatures/Adjust/setEnabled.mdx deleted file mode 100644 index fd4a104c3..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/setEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -setEnabled: (enabled: boolean) => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/setOfflineMode.mdx b/src/code-snippets/react-native/signatures/Adjust/setOfflineMode.mdx deleted file mode 100644 index b0bf5d73d..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/setOfflineMode.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -setOfflineMode: (enabled: boolean) => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/setPushToken.mdx b/src/code-snippets/react-native/signatures/Adjust/setPushToken.mdx deleted file mode 100644 index c019a09ee..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/setPushToken.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -setPushToken: (token: string) => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/trackAdRevenue.mdx b/src/code-snippets/react-native/signatures/Adjust/trackAdRevenue.mdx deleted file mode 100644 index 212b01a68..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/trackAdRevenue.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -trackAdRevenue: ((source: string, payload: string) => void) & ((source: AdjustAdRevenue) => void) -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/trackAppStoreSubscription.mdx b/src/code-snippets/react-native/signatures/Adjust/trackAppStoreSubscription.mdx deleted file mode 100644 index e4b768fff..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/trackAppStoreSubscription.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -trackAppStoreSubscription: (subscription: AdjustAppStoreSubscription) => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/trackEvent.mdx b/src/code-snippets/react-native/signatures/Adjust/trackEvent.mdx deleted file mode 100644 index da2b4ee46..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/trackEvent.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -trackEvent: (adjustEvent: AdjustEvent) => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/trackMeasurementConsent.mdx b/src/code-snippets/react-native/signatures/Adjust/trackMeasurementConsent.mdx deleted file mode 100644 index d9e503741..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/trackMeasurementConsent.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -trackMeasurementConsent: (measurementConsent: boolean) => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/trackPlayStoreSubscription.mdx b/src/code-snippets/react-native/signatures/Adjust/trackPlayStoreSubscription.mdx deleted file mode 100644 index e3236d5ff..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/trackPlayStoreSubscription.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -trackPlayStoreSubscription: (subscription: AdjustPlayStoreSubscription) => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/trackThirdPartySharing.mdx b/src/code-snippets/react-native/signatures/Adjust/trackThirdPartySharing.mdx deleted file mode 100644 index 90cf78abc..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/trackThirdPartySharing.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -trackThirdPartySharing: (adjustThirdPartySharing: AdjustThirdPartySharing) => void -``` diff --git a/src/code-snippets/react-native/signatures/Adjust/updateConversionValue.mdx b/src/code-snippets/react-native/signatures/Adjust/updateConversionValue.mdx deleted file mode 100644 index bb5e7d5d1..000000000 --- a/src/code-snippets/react-native/signatures/Adjust/updateConversionValue.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -updateConversionValue: (conversionValue: number) => void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustAdRevenue/addCallbackParameter.mdx b/src/code-snippets/react-native/signatures/AdjustAdRevenue/addCallbackParameter.mdx deleted file mode 100644 index fad4f2746..000000000 --- a/src/code-snippets/react-native/signatures/AdjustAdRevenue/addCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public addCallbackParameter(key: string, value: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustAdRevenue/addPartnerParameter.mdx b/src/code-snippets/react-native/signatures/AdjustAdRevenue/addPartnerParameter.mdx deleted file mode 100644 index ef58b5c15..000000000 --- a/src/code-snippets/react-native/signatures/AdjustAdRevenue/addPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public addPartnerParameter(key: string, value: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustAdRevenue/constructor.mdx b/src/code-snippets/react-native/signatures/AdjustAdRevenue/constructor.mdx deleted file mode 100644 index 512b94389..000000000 --- a/src/code-snippets/react-native/signatures/AdjustAdRevenue/constructor.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -constructor(source: string) -``` diff --git a/src/code-snippets/react-native/signatures/AdjustAdRevenue/setAdImpressionsCount.mdx b/src/code-snippets/react-native/signatures/AdjustAdRevenue/setAdImpressionsCount.mdx deleted file mode 100644 index a5536f29a..000000000 --- a/src/code-snippets/react-native/signatures/AdjustAdRevenue/setAdImpressionsCount.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setAdImpressionsCount(adImpressionsCount: number): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustAdRevenue/setAdRevenueNetwork.mdx b/src/code-snippets/react-native/signatures/AdjustAdRevenue/setAdRevenueNetwork.mdx deleted file mode 100644 index bcc895543..000000000 --- a/src/code-snippets/react-native/signatures/AdjustAdRevenue/setAdRevenueNetwork.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setAdRevenueNetwork(adRevenueNetwork: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustAdRevenue/setAdRevenuePlacement.mdx b/src/code-snippets/react-native/signatures/AdjustAdRevenue/setAdRevenuePlacement.mdx deleted file mode 100644 index dba6c93a9..000000000 --- a/src/code-snippets/react-native/signatures/AdjustAdRevenue/setAdRevenuePlacement.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setAdRevenuePlacement(adRevenuePlacement: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustAdRevenue/setAdRevenueUnit.mdx b/src/code-snippets/react-native/signatures/AdjustAdRevenue/setAdRevenueUnit.mdx deleted file mode 100644 index db645f2b4..000000000 --- a/src/code-snippets/react-native/signatures/AdjustAdRevenue/setAdRevenueUnit.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setAdRevenueUnit(adRevenueUnit: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustAdRevenue/setRevenue.mdx b/src/code-snippets/react-native/signatures/AdjustAdRevenue/setRevenue.mdx deleted file mode 100644 index 4c477a103..000000000 --- a/src/code-snippets/react-native/signatures/AdjustAdRevenue/setRevenue.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setRevenue(revenue: number, currency: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustAppStoreSubscription/addCallbackParameter.mdx b/src/code-snippets/react-native/signatures/AdjustAppStoreSubscription/addCallbackParameter.mdx deleted file mode 100644 index fad4f2746..000000000 --- a/src/code-snippets/react-native/signatures/AdjustAppStoreSubscription/addCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public addCallbackParameter(key: string, value: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustAppStoreSubscription/addPartnerParameter.mdx b/src/code-snippets/react-native/signatures/AdjustAppStoreSubscription/addPartnerParameter.mdx deleted file mode 100644 index ef58b5c15..000000000 --- a/src/code-snippets/react-native/signatures/AdjustAppStoreSubscription/addPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public addPartnerParameter(key: string, value: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustAppStoreSubscription/constructor.mdx b/src/code-snippets/react-native/signatures/AdjustAppStoreSubscription/constructor.mdx deleted file mode 100644 index f8088f648..000000000 --- a/src/code-snippets/react-native/signatures/AdjustAppStoreSubscription/constructor.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -constructor(price: string, currency: string, transactionId: string, receipt: string) -``` diff --git a/src/code-snippets/react-native/signatures/AdjustAppStoreSubscription/setSalesRegion.mdx b/src/code-snippets/react-native/signatures/AdjustAppStoreSubscription/setSalesRegion.mdx deleted file mode 100644 index c5899e9ac..000000000 --- a/src/code-snippets/react-native/signatures/AdjustAppStoreSubscription/setSalesRegion.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setSalesRegion(salesRegion: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustAppStoreSubscription/setTransactionDate.mdx b/src/code-snippets/react-native/signatures/AdjustAppStoreSubscription/setTransactionDate.mdx deleted file mode 100644 index 6b4a50412..000000000 --- a/src/code-snippets/react-native/signatures/AdjustAppStoreSubscription/setTransactionDate.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setTransactionDate(transactionDate: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/constructor.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/constructor.mdx deleted file mode 100644 index 1aeed4f8f..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/constructor.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -constructor(appToken: string, environment: Environment) -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/deactivateSKAdNetworkHandling.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/deactivateSKAdNetworkHandling.mdx deleted file mode 100644 index a9500de39..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/deactivateSKAdNetworkHandling.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public deactivateSKAdNetworkHandling(): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/sendInBackground.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/sendInBackground.mdx deleted file mode 100644 index a775e97b8..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/sendInBackground.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setSendInBackground(sendInBackground: boolean): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/setAttributionCallbackListener.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/setAttributionCallbackListener.mdx deleted file mode 100644 index aa4e09a74..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/setAttributionCallbackListener.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```ts -public setAttributionCallbackListener( - callback: (attribution: AdjustAttribution) => void -): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/setConversionValueUpdatedCallbackListener.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/setConversionValueUpdatedCallbackListener.mdx deleted file mode 100644 index aa34715dc..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/setConversionValueUpdatedCallbackListener.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```ts -public setConversionValueUpdatedCallbackListener( - callback: (conversionValue: AdjustConversionValue) => void -): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/setCoppaCompliantEnabled.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/setCoppaCompliantEnabled.mdx deleted file mode 100644 index 85978a84b..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/setCoppaCompliantEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setCoppaCompliantEnabled(coppaCompliantEnabled: boolean): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/setDefaultTracker.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/setDefaultTracker.mdx deleted file mode 100644 index 79d0ffe7a..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/setDefaultTracker.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setDefaultTracker(defaultTracked: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/setDeferredDeeplinkCallbackListener.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/setDeferredDeeplinkCallbackListener.mdx deleted file mode 100644 index debe8dfc2..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/setDeferredDeeplinkCallbackListener.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```ts -public setDeferredDeeplinkCallbackListener( - callback: (uri: AdjustUri) => void -): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/setDelayStart.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/setDelayStart.mdx deleted file mode 100644 index f67941090..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/setDelayStart.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setDelayStart(delayStart: number): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/setEventBufferingEnabled.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/setEventBufferingEnabled.mdx deleted file mode 100644 index ea8e255aa..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/setEventBufferingEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setEventBufferingEnabled(eventBufferingEnabled: boolean): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/setEventTrackingFailedCallbackListener.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/setEventTrackingFailedCallbackListener.mdx deleted file mode 100644 index 50ec39ad8..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/setEventTrackingFailedCallbackListener.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```ts -public setEventTrackingFailedCallbackListener( - callback: (eventFailed: AdjustEventTrackingFailure) => void -): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/setEventTrackingSucceededCallbackListener.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/setEventTrackingSucceededCallbackListener.mdx deleted file mode 100644 index 92df998e1..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/setEventTrackingSucceededCallbackListener.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```jsx -public setEventTrackingSucceededCallbackListener( - callback: (eventSuccess: AdjustEventTrackingSuccess) => void -): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/setExternalDeviceId.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/setExternalDeviceId.mdx deleted file mode 100644 index 400b6547b..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/setExternalDeviceId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setExternalDeviceId(externalDeviceId: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/setLinkMeEnabled.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/setLinkMeEnabled.mdx deleted file mode 100644 index 805aec7a3..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/setLinkMeEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setLinkMeEnabled(linkMeEnabled: boolean): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/setLogLevel.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/setLogLevel.mdx deleted file mode 100644 index 5e0de63a9..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/setLogLevel.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setLogLevel(level: LogLevel): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/setNeedsCost.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/setNeedsCost.mdx deleted file mode 100644 index 80a05be33..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/setNeedsCost.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setNeedsCost(needsCost: boolean): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/setPlayStoreKidsAppEnabled.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/setPlayStoreKidsAppEnabled.mdx deleted file mode 100644 index a9901a911..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/setPlayStoreKidsAppEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setPlayStoreKidsAppEnabled(playStoreKidsAppEnabled: boolean): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/setPreinstallFilePath.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/setPreinstallFilePath.mdx deleted file mode 100644 index e2c40850f..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/setPreinstallFilePath.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setPreinstallFilePath(preinstallFilePath: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/setPreinstallTrackingEnabled.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/setPreinstallTrackingEnabled.mdx deleted file mode 100644 index a5ae28c9d..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/setPreinstallTrackingEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setPreinstallTrackingEnabled(preinstallTrackingEnabled: boolean): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/setSessionTrackingFailedCallbackListener.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/setSessionTrackingFailedCallbackListener.mdx deleted file mode 100644 index 2273bbf4f..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/setSessionTrackingFailedCallbackListener.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```ts -public setSessionTrackingFailedCallbackListener( - callback: (sessionFailed: AdjustSessionTrackingFailure) => void -): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/setSessionTrackingSucceededCallbackListener.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/setSessionTrackingSucceededCallbackListener.mdx deleted file mode 100644 index b1fd7fe89..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/setSessionTrackingSucceededCallbackListener.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```ts -public setSessionTrackingSucceededCallbackListener( - callback: (sessionSuccess: AdjustSessionTrackingSuccess) => void -): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/setShouldLaunchDeeplink.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/setShouldLaunchDeeplink.mdx deleted file mode 100644 index d4803e906..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/setShouldLaunchDeeplink.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setShouldLaunchDeeplink(shouldLaunchDeeplink: boolean): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustConfig/setUrlStrategy.mdx b/src/code-snippets/react-native/signatures/AdjustConfig/setUrlStrategy.mdx deleted file mode 100644 index ed6b3576e..000000000 --- a/src/code-snippets/react-native/signatures/AdjustConfig/setUrlStrategy.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setUrlStrategy(urlStrategy: UrlStrategy): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustEvent/addCallbackParameter.mdx b/src/code-snippets/react-native/signatures/AdjustEvent/addCallbackParameter.mdx deleted file mode 100644 index fad4f2746..000000000 --- a/src/code-snippets/react-native/signatures/AdjustEvent/addCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public addCallbackParameter(key: string, value: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustEvent/addPartnerParameter.mdx b/src/code-snippets/react-native/signatures/AdjustEvent/addPartnerParameter.mdx deleted file mode 100644 index ef58b5c15..000000000 --- a/src/code-snippets/react-native/signatures/AdjustEvent/addPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public addPartnerParameter(key: string, value: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustEvent/constructor.mdx b/src/code-snippets/react-native/signatures/AdjustEvent/constructor.mdx deleted file mode 100644 index fdf5844d4..000000000 --- a/src/code-snippets/react-native/signatures/AdjustEvent/constructor.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -constructor(eventToken: string) -``` diff --git a/src/code-snippets/react-native/signatures/AdjustEvent/setCallbackId.mdx b/src/code-snippets/react-native/signatures/AdjustEvent/setCallbackId.mdx deleted file mode 100644 index 66484f9c1..000000000 --- a/src/code-snippets/react-native/signatures/AdjustEvent/setCallbackId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setCallbackId(callbackId: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustEvent/setProductId.mdx b/src/code-snippets/react-native/signatures/AdjustEvent/setProductId.mdx deleted file mode 100644 index a8358d96c..000000000 --- a/src/code-snippets/react-native/signatures/AdjustEvent/setProductId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setProductId(productId: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustEvent/setPurchaseToken.mdx b/src/code-snippets/react-native/signatures/AdjustEvent/setPurchaseToken.mdx deleted file mode 100644 index cd72349dd..000000000 --- a/src/code-snippets/react-native/signatures/AdjustEvent/setPurchaseToken.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setPurchaseToken(purchaseToken: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustEvent/setReceipt.mdx b/src/code-snippets/react-native/signatures/AdjustEvent/setReceipt.mdx deleted file mode 100644 index 080c78839..000000000 --- a/src/code-snippets/react-native/signatures/AdjustEvent/setReceipt.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setReceipt(receipt: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustEvent/setRevenue.mdx b/src/code-snippets/react-native/signatures/AdjustEvent/setRevenue.mdx deleted file mode 100644 index 4c477a103..000000000 --- a/src/code-snippets/react-native/signatures/AdjustEvent/setRevenue.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setRevenue(revenue: number, currency: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustEvent/setTransactionId.mdx b/src/code-snippets/react-native/signatures/AdjustEvent/setTransactionId.mdx deleted file mode 100644 index a80bf5115..000000000 --- a/src/code-snippets/react-native/signatures/AdjustEvent/setTransactionId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setTransactionId(transactionId: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustPlayStoreSubscription/addCallbackParameter.mdx b/src/code-snippets/react-native/signatures/AdjustPlayStoreSubscription/addCallbackParameter.mdx deleted file mode 100644 index fad4f2746..000000000 --- a/src/code-snippets/react-native/signatures/AdjustPlayStoreSubscription/addCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public addCallbackParameter(key: string, value: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustPlayStoreSubscription/addPartnerParameter.mdx b/src/code-snippets/react-native/signatures/AdjustPlayStoreSubscription/addPartnerParameter.mdx deleted file mode 100644 index ef58b5c15..000000000 --- a/src/code-snippets/react-native/signatures/AdjustPlayStoreSubscription/addPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public addPartnerParameter(key: string, value: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustPlayStoreSubscription/constructor.mdx b/src/code-snippets/react-native/signatures/AdjustPlayStoreSubscription/constructor.mdx deleted file mode 100644 index 9ffdf54e1..000000000 --- a/src/code-snippets/react-native/signatures/AdjustPlayStoreSubscription/constructor.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```ts -constructor( - price: string, - currency: string, - sku: string, - orderId: string, - signature: string, - purchaseToken: string) -``` diff --git a/src/code-snippets/react-native/signatures/AdjustPlayStoreSubscription/setPurchaseTime.mdx b/src/code-snippets/react-native/signatures/AdjustPlayStoreSubscription/setPurchaseTime.mdx deleted file mode 100644 index 823956826..000000000 --- a/src/code-snippets/react-native/signatures/AdjustPlayStoreSubscription/setPurchaseTime.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public setPurchaseTime(purchaseTime: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustThirdPartySharing/addGranularOption.mdx b/src/code-snippets/react-native/signatures/AdjustThirdPartySharing/addGranularOption.mdx deleted file mode 100644 index ec27e5da6..000000000 --- a/src/code-snippets/react-native/signatures/AdjustThirdPartySharing/addGranularOption.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public addGranularOption(partnerName: string, key: string, value: string): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustThirdPartySharing/addPartnerSharingSetting.mdx b/src/code-snippets/react-native/signatures/AdjustThirdPartySharing/addPartnerSharingSetting.mdx deleted file mode 100644 index f33bce208..000000000 --- a/src/code-snippets/react-native/signatures/AdjustThirdPartySharing/addPartnerSharingSetting.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -public addPartnerSharingSetting(partnerName: string, key: string, value: boolean): void -``` diff --git a/src/code-snippets/react-native/signatures/AdjustThirdPartySharing/constructor.mdx b/src/code-snippets/react-native/signatures/AdjustThirdPartySharing/constructor.mdx deleted file mode 100644 index 398ec20e0..000000000 --- a/src/code-snippets/react-native/signatures/AdjustThirdPartySharing/constructor.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```ts -constructor(isEnabled: boolean) -``` diff --git a/src/content/docs/sdk/android/setup/preinstalled.mdx b/src/content/docs/sdk/android/setup/preinstalled.mdx index 67bfa7342..afae9e5b2 100644 --- a/src/content/docs/sdk/android/setup/preinstalled.mdx +++ b/src/content/docs/sdk/android/setup/preinstalled.mdx @@ -139,7 +139,7 @@ Configuring a default link token enables you to attribute all preinstalls to a p 1. [Create a new campaign link in Campaign Lab](https://help.adjust.com/en/article/links). - ```text + ```text "{token}" https://app.adjust.com/{token} ``` diff --git a/src/content/docs/sdk/flutter/features/preinstalled.mdx b/src/content/docs/sdk/flutter/features/preinstalled.mdx index df30ed4cd..ae2d7372a 100644 --- a/src/content/docs/sdk/flutter/features/preinstalled.mdx +++ b/src/content/docs/sdk/flutter/features/preinstalled.mdx @@ -22,7 +22,7 @@ Configuring a default link token enables you to attribute all preinstalls to a p 1. [Create a new campaign link in Campaign Lab](https://help.adjust.com/en/article/links). - ```text + ```text "{token}" https://app.adjust.com/{token} ``` diff --git a/src/content/docs/sdk/react-native/configuration.mdx b/src/content/docs/sdk/react-native/configuration.mdx new file mode 100644 index 000000000..62fd2358f --- /dev/null +++ b/src/content/docs/sdk/react-native/configuration.mdx @@ -0,0 +1,292 @@ +--- +title: Configuration +description: Follow the guides in this section to configure the Adjust SDK. +slug: en/sdk/react-native/configuration +sidebar-position: 1 +--- + +Use the methods in this document to configure the behavior of the Adjust SDK. + +## Instantiate your config object + +```ts title="Method signature" +constructor(appToken: string, environment: Environment) +``` + +To configure the Adjust SDK, you need to instantiate an `AdjustConfig` 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 `AdjustConfig` instance and pass the following parameters: + +- `appToken` (**String**): Your [Adjust app token](https://help.adjust.com/en/article/app-token-and-reporting-currency#view-your-app-details). +- `environment` (**Environment**): The environment you want to run the SDK in. Pass `AdjustConfig.EnvironmentSandbox` to run the SDK in sandbox mode for testing. Pass `AdjustConfig.EnvironmentProduction` to run the SDK in production mode for release. + +```jsx +const adjustConfig = new AdjustConfig( + "{YourAppToken}", + AdjustConfig.EnvironmentSandbox +); +//... +Adjust.create(adjustConfig); +``` + +## Read-only configuration + +**Read-only** configuration options are set in your `AdjustConfig` 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.start()`. + +### Set your logging level + +```ts title="Method signature" +public setLogLevel(level: LogLevel): void +``` + +The Adjust SDK provides configurable log levels to return different amounts of information. The following log levels are available: + + + +| Log level | Description | +| ------------------------------- | ------------------------------------------ | +| `AdjustConfig.LogLevelVerbose` | Enable all logging | +| `AdjustConfig.LogLevelDebug` | Enable debug logging | +| `AdjustConfig.LogLevelInfo` | Only show info level logs (default option) | +| `AdjustConfig.LogLevelWarn` | Disable info logging | +| `AdjustConfig.LogLevelError` | Disable warning level logging and below | +| `AdjustConfig.LogLevelAssert` | Disable error level logging and below | +| `AdjustConfig.LogLevelSuppress` | Suppress all logging | + +
+ +You can set your log level by calling the `setLogLevel` method on your `AdjustConfig` instance with the following parameter: + +- `logLevel` (**LogLevel**): The log level you want to use. + +```jsx {6} +const adjustConfig = new AdjustConfig( + "{YourAppToken}", + AdjustConfig.EnvironmentSandbox +); +//... +adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose); +//... +Adjust.create(adjustConfig); +``` + +### Set external device identifier + +```ts title="Method signature" +public setExternalDeviceId(externalDeviceId: string): void +``` + +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. You can set property calling the `setExternalDeviceId` method with the following parameter: + +- `externalDeviceId` (**String**): 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. + + + +```jsx {6} +const adjustConfig = new AdjustConfig( + "{YourAppToken}", + AdjustConfig.EnvironmentSandbox +); +//... +adjustConfig.setExternalDeviceId("{Your-External-Device-Id}"); +//... +Adjust.create(adjustConfig); +``` + +If you want to use the external device ID in your business analytics, you can pass it as a [session callback parameter](/en/sdk/flutter/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 + +```ts title="Method signature" +public setDefaultTracker(defaultTracker: string): void +``` + +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. To set your default link token, call the `setDefaultTracker` method with the following argument: + +- `defaultTracker` (String): The [Adjust link token](https://help.adjust.com/en/article/links#adjust-link-token) you want to record preinstalled installs against. + +```jsx {6} +const adjustConfig = new AdjustConfig( + "{YourAppToken}", + AdjustConfig.EnvironmentSandbox +); +//... +adjustConfig.setDefaultTracker("{TrackerToken}"); +//... +Adjust.create(adjustConfig); +``` + +### Enable cost data sending + +```ts title="Method signature" +public setNeedsCost(needsCost: boolean): void +``` + +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, call the `setNeedsCost` method on your config instance with the following parameter: + +- `needsCost` (**Boolean**): 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/react-native/features/attribution). + +```jsx {6} +const adjustConfig = new AdjustConfig( + "{Your App Token}", + AdjustConfig.EnvironmentSandbox +); +adjustConfig.setLogLevel(AdjustLogLevel.Verbose); +adjustConfig.setNeedsCost(true); +``` + +### Enable background recording + +```ts title="Method signature" +public setSendInBackground(sendInBackground: boolean): void +``` + +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, call the `setSendInBackground` method on your config instance with the following parameter: + +- `sendInBackground` (Boolean): Set to `true` to enable background sending or `false` to disable background sending. + +```jsx {3} +const adjustConfig = new AdjustConfig(appToken, environment); +//... +adjustConfig.setSendInBackground(true); +//... +Adjust.create(adjustConfig); +``` + +### Enable event buffering + +```ts title="Method signature" +public setEventBufferingEnabled(eventBufferingEnabled: boolean): void +``` + +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 the following parameter: + +- `eventBufferingEnabled` (**Boolean**): Set to `true` to enable event buffering or `false` to disable event buffering. + +```jsx {6} +const adjustConfig = new AdjustConfig( + "{YourAppToken}", + AdjustConfig.EnvironmentSandbox +); +//... +adjustConfig.setEventBufferingEnabled(true); +//... +Adjust.create(adjustConfig); +``` + +### Delay the start of the SDK + +```ts title="Method signature" +public setDelayStart(delayStart: number): void +``` + +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/android/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, call the `setDelayStart` method with the following argument: + +- `delayStart` (**Number**): 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**. + +```jsx {6} +const adjustConfig = new AdjustConfig( + "{YourAppToken}", + AdjustConfig.EnvironmentSandbox +); +//... +adjustConfig.setDelayStart(5.5); +//... +Adjust.create(adjustConfig); +``` + +## 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 + +```ts title="Method signature" +setOfflineMode: (enabled: boolean) => void +``` + + + +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` (**Boolean**): Set to `true` to enable offline mode or `false` to disable offline mode. + +```jsx +Adjust.setOfflineMode(true); +``` + +### Set push tokens + +```ts title="Method signature" +setPushToken: (token: string) => void +``` + +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 `setPushToken` method and passing the following arguments: + +- `token` (**String**): Your push token. + + + +If you have access to the push token from the web view, you can call the `setPushToken` method in Javascript. + + + +```jsx +Adjust.setPushToken("YourPushNotificationToken"); +``` + +### Disable or enable the SDK + + + +You can only call this method after the first session. This setting persists between sessions. + + + +```ts title="Method siganture" +setEnabled: (enabled: boolean) => void +``` + +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` (**Boolean**): Set to `true` to enable the SDK or `false` to disable the SDK. + +```jsx +Adjust.setEnabled(false); +``` + +#### Check enabled status + +```ts title="Method signature" +isEnabled: (callback: (enabled: boolean) => void) => void +``` + +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`). + +```jsx +Adjust.isEnabled(); +``` diff --git a/src/content/docs/sdk/react-native/configuration/background.mdx b/src/content/docs/sdk/react-native/configuration/background.mdx deleted file mode 100644 index 02cf7a076..000000000 --- a/src/content/docs/sdk/react-native/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/react-native/configuration/background ---- - -import SetSendInBackground from "@react-native-examples/AdjustConfig/sendInBackground.mdx" -import SetSendInBackgroundSig from "@react-native-signatures/AdjustConfig/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/react-native/configuration/deep-links.mdx b/src/content/docs/sdk/react-native/configuration/deep-links.mdx deleted file mode 100644 index 3cb8c8238..000000000 --- a/src/content/docs/sdk/react-native/configuration/deep-links.mdx +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: Deep linking -description: Follow the guides in this section to set up deep linking. -category-title: Deep linking -slug: en/sdk/react-native/configuration/deep-links ---- - -import SetLinkMeEnabled from "@react-native-examples/AdjustConfig/setLinkMeEnabled.mdx" -import SetLinkMeEnabledSig from "@react-native-signatures/AdjustConfig/setLinkMeEnabled.mdx" -import SetShouldLaunchDeeplink from "@react-native-examples/AdjustConfig/setShouldLaunchDeeplink.mdx" -import SetShouldLaunchDeeplinkSig from "@react-native-signatures/AdjustConfig/setShouldLaunchDeeplink.mdx" -import SetDeferredDeeplinkCallbackListener from "@react-native-examples/AdjustConfig/setDeferredDeeplinkCallbackListener.mdx" -import SetDeferredDeeplinkCallbackListenerSig from "@react-native-signatures/AdjustConfig/setDeferredDeeplinkCallbackListener.mdx" - -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. - -## Set up deep linking - -If a user has your app installed, it opens when they interact with a link containing deep link information. The Adjust SDK contains tools to parse deep link information for use throughout your app. - -To set up deep linking on your React Native app: - -1. Set up deep linking on an app level. Follow the instructions linked below to set up deep linking on your target platform: - - [iOS](/en/sdk/ios/configuration/deep-links) - - [Android](/en/sdk/android/features/deep-links) -2. Refer to the [React Native documentation](https://reactnative.dev/docs/linking.html) and follow the instructions to learn how to support both platforms. -3. Use your obtained deep link URL in your JavaScript code. - -## Deferred deep linking - -### Disable deferred deep linking - -The SDK opens deferred deep links by default. You can configure this by passing a **boolean** argument to the `setDeferredDeeplinkCallbackListener` method. - - - -### Set up a deferred deep link delegate - -You can configure the Adjust SDK to call a delegate function when it receives a deferred deep link by calling the `SetDeferredDeeplinkCallbackListener` method. This delegate function receives the deep link as a **string** argument. - - - -### Example - -This example shows how to log a deep link address when the user opens a deferred deep link. - -```jsx {1-3, 9} -const LogDeepLink = function (deeplinkURL) { - console.log("Deeplink URL: " + deeplinkURL); -}; -//... -const adjustConfig = new AdjustConfig( - "{YourAppToken}", - AdjustConfig.EnvironmentSandbox -); -adjustConfig.setDeferredDeeplinkCallbackListener(LogDeepLink); -//... -Adjust.create(adjustConfig); -``` - -### Enable LinkMe - -The Adjust SDK lets you copy deep link information from the device pasteboard. When combined with Adjust’s LinkMe solution, this feature enables deferred deep linking on devices running iOS 15 and above. - - - -The Adjust SDK checks the pasteboard when a user opens the app for the first time. The device displays a dialog asking if the user wants to allow the app to read the pasteboard. - - - -When a user clicks on a LinkMe URL they have the option to copy the link information to their system pasteboard. You can use the Adjust SDK to read the system pasteboard for deep link information. If deep link information is present, the SDK forwards the user to the correct page in your app. - -To enable pasteboard checking in your app, pass a true value to the `setLinkMeEnabled` method on your config object: - - diff --git a/src/content/docs/sdk/react-native/configuration/delay.mdx b/src/content/docs/sdk/react-native/configuration/delay.mdx deleted file mode 100644 index e81dcc596..000000000 --- a/src/content/docs/sdk/react-native/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/react-native/configuration/delay ---- - -import SetOfflineMode from "@react-native-examples/Adjust/setOfflineMode.mdx" -import SetOfflineModeSig from "@react-native-signatures/Adjust/setOfflineMode.mdx" -import SetEventBufferingEnabled from "@react-native-examples/AdjustConfig/setEventBufferingEnabled.mdx" -import SetEventBufferingEnabledSig from "@react-native-signatures/AdjustConfig/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/react-native/configuration/disable.mdx b/src/content/docs/sdk/react-native/configuration/disable.mdx deleted file mode 100644 index 5b2aa75a6..000000000 --- a/src/content/docs/sdk/react-native/configuration/disable.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Disable the Adjust SDK -description: Disable the Adjust SDK to pause recording. -slug: en/sdk/react-native/configuration/disable ---- - -import SetEnabled from "@react-native-examples/Adjust/setEnabled.mdx"; -import SetEnabledSig from "@react-native-signatures/Adjust/setEnabled.mdx"; -import IsEnabled from "@react-native-examples/Adjust/isEnabled.mdx"; -import IsEnabledSig from "@react-native-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 generate a button to enable or disable the Adjust SDK. The button displays the correct action based on the value of the `txtSetEnabled` variable. - -- When `txtSetEnabled` = `"Disable SDK"`, the button disables the SDK and sets `txtSetEnabled` to `"Enable SDK"`. -- When `txtSetEnabled` = `"Enable SDK"`, the button enables the SDK and sets `txtSetEnabled` to `"Disable SDK"`. - -```jsx {6,10,15} -const App: () => React$Node = () => { - Adjust.getSdkVersion(function (sdkVersion) { - console.log("Adjust SDK version: " + sdkVersion); - }); - - var txtSetEnabled = "Disable SDK"; - - function _onPress_enableSdk() { - Adjust.setEnabled(true); - txtSetEnabled = "Disable SDK"; - } - - function _onPress_disableSdk() { - Adjust.setEnabled(false); - txtSetEnabled = "Enable SDK"; - } -}; - -export default App; -``` diff --git a/src/content/docs/sdk/react-native/configuration/external-device-id.mdx b/src/content/docs/sdk/react-native/configuration/external-device-id.mdx deleted file mode 100644 index af555ab25..000000000 --- a/src/content/docs/sdk/react-native/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/react-native/configuration/external-device-id ---- - -import SetExternalDeviceId from "@react-native-examples/AdjustConfig/setExternalDeviceId.mdx" -import SetExternalDeviceIdSig from "@react-native-signatures/AdjustConfig/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/react-native/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/react-native/configuration/index.mdx b/src/content/docs/sdk/react-native/configuration/index.mdx deleted file mode 100644 index 8658a3dd2..000000000 --- a/src/content/docs/sdk/react-native/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/react-native/configuration -type: category ---- - -Follow the guides in this section to configure the Adjust SDK. diff --git a/src/content/docs/sdk/react-native/configuration/log-level.mdx b/src/content/docs/sdk/react-native/configuration/log-level.mdx deleted file mode 100644 index 9b270208c..000000000 --- a/src/content/docs/sdk/react-native/configuration/log-level.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Set log level -description: Configure the Adjust SDK's logging verbosity. -slug: en/sdk/react-native/configuration/log-level ---- - -import SetLogLevel from "@react-native-examples/AdjustConfig/setLogLevel.mdx"; -import SetLogLevelSig from "@react-native-signatures/AdjustConfig/setLogLevel.mdx"; - -The Adjust SDK provides configurable log levels to return different amounts of information. The following log levels are available: - - - -| Log level | Description | -| ------------------------------- | ------------------------------------------ | -| `AdjustConfig.LogLevelVerbose` | Enable all logging | -| `AdjustConfig.LogLevelDebug` | Enable debug logging | -| `AdjustConfig.LogLevelInfo` | Only show info level logs (default option) | -| `AdjustConfig.LogLevelWarn` | Disable info logging | -| `AdjustConfig.LogLevelError` | Disable warning level logging and below | -| `AdjustConfig.LogLevelAssert` | Disable error level logging and below | -| `AdjustConfig.LogLevelSuppress` | Suppress all logging | - -
- -You can set your log level by calling the `setLogLevel` method on your `AdjustConfig` instance. - - - -## Disable all logging - -To disable all log output when initializing the SDK manually, call `setLogLevel(AdjustConfig.LogLevelSuppress)` on your config instance. - -```jsx {6} -const adjustConfig = new AdjustConfig( - "{YourAppToken}", - AdjustConfig.EnvironmentSandbox -); -//... -adjustConfig.setLogLevel(AdjustConfig.LogLevelSuppress); -//... -Adjust.create(adjustConfig); -``` diff --git a/src/content/docs/sdk/react-native/configuration/preinstalled.mdx b/src/content/docs/sdk/react-native/configuration/preinstalled.mdx deleted file mode 100644 index 61023e835..000000000 --- a/src/content/docs/sdk/react-native/configuration/preinstalled.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Send preinstalled app activity -description: Configure a campaign to send information from preinstalled apps. -slug: en/sdk/react-native/configuration/preinstalled ---- - -import SetDefaultTracker from "@react-native-examples/AdjustConfig/setDefaultTracker.mdx" -import SetDefaultTrackerSig from "@react-native-signatures/AdjustConfig/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. - -## Default 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/react-native/configuration/privacy.mdx b/src/content/docs/sdk/react-native/configuration/privacy.mdx deleted file mode 100644 index 9fddc4899..000000000 --- a/src/content/docs/sdk/react-native/configuration/privacy.mdx +++ /dev/null @@ -1,205 +0,0 @@ ---- -title: Set up privacy features -description: Configure features that you can use to handle user privacy in your app. -slug: en/sdk/react-native/configuration/privacy ---- - -import GdprForgetMe from "@react-native-examples/Adjust/gdprForgetMe.mdx"; -import GdprForgetMeSig from "@react-native-signatures/Adjust/gdprForgetMe.mdx"; -import InitWithIsEnabledNumberBoolFalse from "@react-native-examples/AdjustThirdPartySharing/initFalse.mdx"; -import InitWithIsEnabledNumberBoolTrue from "@react-native-examples/AdjustThirdPartySharing/initTrue.mdx"; -import TrackThirdPartySharing from "@react-native-signatures/Adjust/trackThirdPartySharing.mdx"; -import AddGranularOption from "@react-native-examples/AdjustThirdPartySharing/addGranularOption.mdx"; -import AddGranularOptionSig from "@react-native-signatures/AdjustThirdPartySharing/addGranularOption.mdx"; -import AddPartnerSharingSetting from "@react-native-examples/AdjustThirdPartySharing/addPartnerSharingSetting.mdx"; -import AddPartnerSharingSettingSig from "@react-native-signatures/AdjustThirdPartySharing/addPartnerSharingSetting.mdx"; -import AddGranularOptionFacebook from "@react-native-examples/AdjustThirdPartySharing/addGranularOptionFacebook.mdx"; -import DisableThirdPartySharing from "@react-native-examples/Adjust/disableThirdPartySharing.mdx"; -import DisableThirdPartySharingSig from "@react-native-signatures/Adjust/disableThirdPartySharing.mdx"; -import SetUrlStrategy from "@react-native-examples/AdjustConfig/setUrlStrategy.mdx"; -import SetUrlStrategySig from "@react-native-signatures/AdjustConfig/setUrlStrategy.mdx"; -import TrackMeasurementConsent from "@react-native-examples/Adjust/trackMeasurementConsent.mdx"; -import TrackMeasurementConsentSig from "@react-native-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. - - - - - -| 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` | - -
- -#### 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. - - - - - -| 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.
| - -
- - - -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. | - -
- -```jsx -var adjustThirdPartySharing = new AdjustThirdPartySharing(null); -adjustThirdPartySharing.addGranularOption("google_dma", "eea", "1"); -adjustThirdPartySharing.addGranularOption( - "google_dma", - "ad_personalization", - "1", -); -adjustThirdPartySharing.addGranularOption("google_dma", "ad_user_data", "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 `AdjustConfig` instance. - - - - - -| Value | Description | -| ------------------------ | --------------------------------------------------------- | -| `AdjustDataResidencyEU` | Sets the area of data residency to the EU | -| `AdjustDataResidencyTR` | Sets the area of data residency to Turkey | -| `AdjustDataResidencyUS` | Sets the area of data residency to the USA | -| `AdjustUrlStrategyChina` | Points the URL strategy to the `app.adjust.world` domain | -| `AdjustUrlStrategyCn` | Points the URL strategy to the `app.adjust.cn` domain | -| `AdjustUrlStrategyIndia` | Points the URL strategy to the `app.adjust.net.in` domain | - -
- -## 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. - - - -## COPPA compliance - -import SetCoppaCompliantEnabledSig from "@react-native-signatures/AdjustConfig/setCoppaCompliantEnabled.mdx"; - -If you need your app to be COPPA compliant, call the `setCoppaCompliantEnabled` method. This method performs the following actions: - -1. Disables third-party sharing **before** the user launches their first session. -2. Prevents the SDK from reading device and advertising IDs (For example: `gps_adid` and `android_id`). - -import SetCoppaCompliantEnabled from "@react-native-examples/AdjustConfig/setCoppaCompliantEnabled.mdx"; - - - -You can disable this method by calling it with a `false` parameter. - - - -Disabling the `setCoppaCompliantEnabled` method _doesn't_ re-enable third-party sharing. You need to re-enable third-party sharing for the user. - - - -## Play Store Kids Apps (Android only) - -import SetPlayStoreKidsAppEnabledSig from "@react-native-signatures/AdjustConfig/setPlayStoreKidsAppEnabled.mdx"; - -If your app targets users under the age of 13, and the install region **isn't** the USA, you need to mark it as a Kids App. This prevents the SDK from reading device and advertising IDs, that's, `gps_adid` and `android_id`. To do this, call the `setPlayStoreKidsAppEnabled` method with a `true` parameter. - -import SetPlayStoreKidsAppEnabled from "@react-native-examples/AdjustConfig/setPlayStoreKidsAppEnabled.mdx"; - - diff --git a/src/content/docs/sdk/react-native/configuration/push-tokens.mdx b/src/content/docs/sdk/react-native/configuration/push-tokens.mdx deleted file mode 100644 index 6c366f77c..000000000 --- a/src/content/docs/sdk/react-native/configuration/push-tokens.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Set up push tokens -description: Configure push tokens for your app. -slug: en/sdk/react-native/configuration/push-tokens ---- - -import SetPushToken from "@react-native-examples/Adjust/setPushToken.mdx" -import SetPushTokenSig from "@react-native-signatures/Adjust/setPushToken.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 `setPushToken` method and passing your token as an argument. - - - -## Example - -This example shows how to set a new push token with the value _`HrFmrcq96tj723aWFfrw`_ to track your app's retention rates. You can update this value at any time by passing a new token to the `setPushToken` method as an argument: - -```jsx '"HrFmrcq96tj723aWFfrw"' -Adjust.setPushToken("HrFmrcq96tj723aWFfrw"); -``` diff --git a/src/content/docs/sdk/react-native/features/ad-revenue.mdx b/src/content/docs/sdk/react-native/features/ad-revenue.mdx index fd9cd78ca..8792e0f52 100644 --- a/src/content/docs/sdk/react-native/features/ad-revenue.mdx +++ b/src/content/docs/sdk/react-native/features/ad-revenue.mdx @@ -4,23 +4,6 @@ description: Record ad revenue information for supported network partners using slug: en/sdk/react-native/features/ad-revenue --- -import TrackAdRevenue from "@react-native-examples/Adjust/trackAdRevenue.mdx"; -import TrackAdRevenueSig from "@react-native-signatures/Adjust/trackAdRevenue.mdx"; -import SetRevenue from "@react-native-examples/AdjustAdRevenue/setRevenue.mdx"; -import SetRevenueSig from "@react-native-signatures/AdjustAdRevenue/setRevenue.mdx"; -import SetAdImpressionsCount from "@react-native-examples/AdjustAdRevenue/setAdImpressionsCount.mdx"; -import SetAdImpressionsCountSig from "@react-native-signatures/AdjustAdRevenue/setAdImpressionsCount.mdx"; -import SetAdRevenueNetwork from "@react-native-examples/AdjustAdRevenue/setAdRevenueNetwork.mdx"; -import SetAdRevenueNetworkSig from "@react-native-signatures/AdjustAdRevenue/setAdRevenueNetwork.mdx"; -import SetAdRevenueUnit from "@react-native-examples/AdjustAdRevenue/setAdRevenueUnit.mdx"; -import SetAdRevenueUnitSig from "@react-native-signatures/AdjustAdRevenue/setAdRevenueUnit.mdx"; -import SetAdRevenuePlacement from "@react-native-examples/AdjustAdRevenue/setAdRevenuePlacement.mdx"; -import SetAdRevenuePlacementSig from "@react-native-signatures/AdjustAdRevenue/setAdRevenuePlacement.mdx"; -import AddCallbackParameter from "@react-native-examples/AdjustAdRevenue/addCallbackParameter.mdx"; -import AddCallbackParameterSig from "@react-native-signatures/AdjustAdRevenue/addCallbackParameter.mdx"; -import AddPartnerParameter from "@react-native-examples/AdjustAdRevenue/addPartnerParameter.mdx"; -import AddPartnerParameterSig from "@react-native-signatures/AdjustAdRevenue/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 AdjustAdRevenue object + +```ts title="Method signature" +constructor(source: string) +``` -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 `AdjustAdRevenue` 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 `AdjustAdRevenue` instance and pass the following parameters: -## Sources +- `source` (**String**): The source of the ad revenue. See the table below for available sources @@ -53,15 +39,36 @@ To send ad revenue to Adjust:
-## Record ad revenue amount +```jsx {1} +var adjustAdRevenue = new AdjustAdRevenue("source"); +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` -You can record ad revenue by setting the `revenue` and `currency` properties on your ad revenue instance. +## Send ad revenue -To set these properties, call the `setRevenue` method and pass the following arguments: +```ts title="Method signature" +trackAdRevenue: ((source: string, payload: string) => void) & ((source: AdjustAdRevenue) => void) +``` -`revenue` **number**: The amount of revenue +To send ad revenue to Adjust, call the `trackAdRevenue` method with your ad revenue instance as an argument. -`currency` **string**: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of your reporting currency +```jsx {3} +var adjustAdRevenue = new AdjustAdRevenue("source"); +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` + +## Record ad revenue amount + +```ts title="Method signature" +public setRevenue(revenue: number, currency: string): void +``` + +To send the ad revenue amount, call the `setRevenue` method and pass the following arguments: + +- `revenue` (**Double**): The amount of revenue +- `currency` (**String**): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of your reporting currency @@ -69,38 +76,94 @@ Check the [guide to tracking purchases in different currencies](https://help.adj - +```jsx {3} +var adjustAdRevenue = new AdjustAdRevenue("source"); +//... +adjustAdRevenue.setRevenue(1.0, "EUR"); +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` ## Record ad campaign details -The ad revenue object contains properties you can use to report on your ad campaigns. +The `AdjustAdRevenue` 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. +```ts title="Method signature" +public setAdImpressionsCount(adImpressionsCount: number): void +``` + +To send the number of recorded ad impressions, call the `setAdImpressionsCount` method and pass the following arguments: - +- `adImpressionsCount` (**Integer**): The number of ad impressions. + +```jsx {3} +var adjustAdRevenue = new AdjustAdRevenue("source"); +//... +adjustAdRevenue.setAdImpressionsCount(10); +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` ### Ad revenue network -Record which network generated the revenue by passing a **string** value to the `setAdRevenueNetwork` method. +```ts title="Method signature" +public setAdRevenueNetwork(adRevenueNetwork: string): void +``` + +To send the ad revenue network, call the `setAdRevenueNetwork` method and pass the following arguments: - +- `adRevenueNetwork` (**String**): The network name. + +```jsx {3} +var adjustAdRevenue = new AdjustAdRevenue("source"); +//... +adjustAdRevenue.setAdRevenueNetwork("network1"); +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` ### Ad revenue unit -Record which ad revenue unit generated the revenue by passing a **string** value to the `setAdRevenueUnit` method. +```ts title="Method signature" +public setAdRevenueUnit(adRevenueUnit: string): void +``` + +To send the ad revenue unit, call the `setAdRevenueUnit` method and pass the following arguments: - +- `adRevenueUnit` (**String**): The ad unit. + +```jsx {3} +var adjustAdRevenue = new AdjustAdRevenue("source"); +//... +adjustAdRevenue.setAdRevenueUnit("unit1"); +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` ### Ad revenue placement +```ts title="Method signature" +public setAdRevenuePlacement(adRevenuePlacement: string): void +``` + Record the placement of your ad by passing a **string** value to the `setAdRevenuePlacement` method. - +```jsx {3} +var adjustAdRevenue = new AdjustAdRevenue("source"); +//... +adjustAdRevenue.setAdRevenuePlacement("banner"); +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` ## Add callback parameters +```ts title="Method signature" +public addCallbackParameter(key: string, value: string): void +``` + 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. @@ -129,10 +192,20 @@ You can read more about using URL callbacks, including a full list of available - +```jsx {3} +var adjustAdRevenue = new AdjustAdRevenue("source"); +//... +adjustAdRevenue.addCallbackParameter("key", "value"); +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` ## Add partner parameters +```ts title="Method signature" +public addPartnerParameter(key: string, value: string): void +``` + 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. @@ -145,7 +218,13 @@ 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. - +```jsx {3} +var adjustAdRevenue = new AdjustAdRevenue("source"); +//... +adjustAdRevenue.addPartnerParameter("key", "value"); +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` ## Example @@ -161,8 +240,8 @@ This example shows how to set up and record an ad revenue object with the follow - A partner parameter: `"key2" = "value2"` ```jsx -var adjustAdRevenue = new AdjustAdRevenue("source"); -adjustAdRevenue.setRevenue(1.00, "EUR"); +var adjustAdRevenue = new AdjustAdRevenue(AdjustConfig.AdRevenueSourceAppLovinMAX); +adjustAdRevenue.setRevenue(1.0, "EUR"); adjustAdRevenue.setAdImpressionsCount(10); adjustAdRevenue.setAdRevenueNetwork("network1"); adjustAdRevenue.setAdRevenueUnit("unit1"); diff --git a/src/content/docs/sdk/react-native/configuration/att.mdx b/src/content/docs/sdk/react-native/features/att.mdx similarity index 73% rename from src/content/docs/sdk/react-native/configuration/att.mdx rename to src/content/docs/sdk/react-native/features/att.mdx index f5ae89757..7349eaf09 100644 --- a/src/content/docs/sdk/react-native/configuration/att.mdx +++ b/src/content/docs/sdk/react-native/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/react-native/configuration/att +slug: en/sdk/react-native/features/att --- -import RequestTrackingAuthorization from "@react-native-examples/Adjust/requestTrackingAuthorization.mdx" -import AppTrackingAuthorizationStatus from "@react-native-examples/Adjust/appTrackingAuthorizationStatus.mdx" -import AppTrackingAuthorizationStatusSig from "@react-native-signatures/Adjust/appTrackingAuthorizationStatus.mdx" -import CheckForNewAttStatus from "@react-native-examples/Adjust/checkForNewAttStatus.mdx" -import CheckForNewAttStatusSig from "@react-native-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 @@ -33,14 +27,15 @@ You might receive a status code of `-1` if the SDK is unable to retrieve the ATT ## App-tracking authorization wrapper +```ts title="Method signature" +requestTrackingAuthorizationWithCompletionHandler: (handler: (status: number) => void) => void +``` + 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. -You must specify text content for the tracking request dialog. You can add this to your project in two ways: - -1. Add your text to the **User Tracking Description** field in the Adjust prefab. -2. Add your text to the `NSUserTrackingUsageDescription` key in your `Info.plist` file. +You must specify text content for the tracking request dialog. To do this, add your text to the `NSUserTrackingUsageDescription` key in your `Info.plist` file. @@ -48,7 +43,24 @@ The Adjust SDK also records the consent status if you use a custom prompt. If yo - +```jsx +Adjust.requestTrackingAuthorizationWithCompletionHandler(function (status) { + switch (status) { + case 0: + // ATTrackingManagerAuthorizationStatusNotDetermined case + break; + case 1: + // ATTrackingManagerAuthorizationStatusRestricted case + break; + case 2: + // ATTrackingManagerAuthorizationStatusDenied case + break; + case 3: + // ATTrackingManagerAuthorizationStatusAuthorized case + break; + } +}); +``` ### Example @@ -81,9 +93,15 @@ Adjust.requestTrackingAuthorizationWithCompletionHandler(function (status) { ## 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**. +```ts title="Method signature" +getAppTrackingAuthorizationStatus: (callback: (authorizationStatus: number) => void) => void +``` - +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**. + +```jsx +Adjust.getAppTrackingAuthorizationStatus(); +``` ### Example @@ -96,6 +114,12 @@ Adjust.addSessionPartnerParameter("status", authorizationStatus); ## Check for authorization status changes +```ts title="Method signature" +checkForNewAttStatus: () => void +``` + 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. - +```jsx +Adjust.checkForNewAttStatus(); +``` diff --git a/src/content/docs/sdk/react-native/features/attribution.mdx b/src/content/docs/sdk/react-native/features/attribution.mdx index c668e90ee..862fedb37 100644 --- a/src/content/docs/sdk/react-native/features/attribution.mdx +++ b/src/content/docs/sdk/react-native/features/attribution.mdx @@ -4,14 +4,49 @@ description: Listen for attribution changes using the Adjust SDK slug: en/sdk/react-native/features/attribution --- -import SetAttributionCallbackListener from "@react-native-examples/AdjustConfig/setAttributionCallbackListener.mdx"; -import SetAttributionCallbackListenerSig from "@react-native-signatures/AdjustConfig/setAttributionCallbackListener.mdx"; -import Attribution from "@react-native-examples/Adjust/getAttribution.mdx"; -import AttributionSig from "@react-native-signatures/Adjust/getAttribution.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. +## AdjustAttribution class properties -To configure your callback function, call the `setAttributionCallbackListener` method with your function name as an argument. +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 `AdjustConfig` instance](/en/sdk/react-native/configuration#enable-cost-data-sending) 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. | +| `fbInstallReferrer` | String | The [Facebook install referrer](https://developers.facebook.com/docs/app-ads/install-referrer/). | + +
+ +## Trigger a function when attribution changes + +```dart title="Property declaration" +typedef void AttributionCallback(AdjustAttribution attributionData); +AttributionCallback? attributionCallback; +``` + +The SDK can listen for attribution changes and call a function when it detects an update. To configure your callback function, call the `setAttributionCallbackListener` method with your function as an argument. @@ -19,14 +54,46 @@ You must call the `setAttributionCallbackListener` method **before** initializin - +```jsx {3-18} +const adjustConfig = new AdjustConfig(appToken, environment); + +adjustConfig.setAttributionCallbackListener(function (attribution) { + // Printing all attribution properties. + console.log("Attribution changed!"); + console.log(attribution.trackerToken); + console.log(attribution.trackerName); + console.log(attribution.network); + console.log(attribution.campaign); + console.log(attribution.adgroup); + console.log(attribution.creative); + console.log(attribution.clickLabel); + console.log(attribution.adid); + console.log(attribution.costType); + console.log(attribution.costAmount); + console.log(attribution.costCurrency); + console.log(attribution.fbInstallReferrer); +}); -Within your delegate function, you have access to the user's `Attribution` information. See the [`AdjustAttribution` class reference](/en/sdk/react-native/reference/adjustattribution) for a list of available properties. +Adjust.create(adjustConfig); +``` ## 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 `getAttribution` method. +```ts title="Method signature" +getAttribution: (callback: (attribution: AdjustAttribution) => void) => void +``` -This method returns an Attribution object. See the [`AdjustAttribution` class reference](/en/sdk/react-native/reference/adjustattribution) for a list of available properties. +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 `getAttribution` method to return the attribution information as an `AdjustAttribution` object. - +```jsx +Adjust.getAttribution((attribution) => { + console.log("Tracker token = " + attribution.trackerToken); + console.log("Tracker name = " + attribution.trackerName); + console.log("Network = " + attribution.network); + console.log("Campaign = " + attribution.campaign); + console.log("Adgroup = " + attribution.adgroup); + console.log("Creative = " + attribution.creative); + console.log("Click label = " + attribution.clickLabel); + console.log("Adid = " + attribution.adid); +}); +``` diff --git a/src/content/docs/sdk/react-native/features/callbacks.mdx b/src/content/docs/sdk/react-native/features/callbacks.mdx index 8a1146afb..e8eafb0ad 100644 --- a/src/content/docs/sdk/react-native/features/callbacks.mdx +++ b/src/content/docs/sdk/react-native/features/callbacks.mdx @@ -4,12 +4,7 @@ description: Set up callbacks to trigger functions when the SDK sends informatio slug: en/sdk/react-native/features/callbacks --- -import SetSessionTrackingSucceededCallbackListener from "@react-native-examples/AdjustConfig/setSessionTrackingSucceededCallbackListener.mdx"; -import SetEventTrackingSucceededCallbackListener from "@react-native-examples/AdjustConfig/setEventTrackingSucceededCallbackListener.mdx"; -import SetSessionTrackingFailedCallbackListener from "@react-native-examples/AdjustConfig/setSessionTrackingFailedCallbackListener.mdx"; -import SetEventTrackingFailedCallbackListener from "@react-native-examples/AdjustConfig/setEventTrackingFailedCallbackListener.mdx"; - -Set up callbacks to trigger functions when the SDK sends information to Adjust. You can set up callbacks for sessions and events. +Set up callbacks to trigger functions when the SDK sends information to Adjust. You can set up callbacks for **sessions** and **events**. @@ -30,16 +25,40 @@ Session callbacks have access to a response data object. You can use its propert | `Message` | String | The message from the server or the error logged by the SDK. | | `Timestamp` | String | The timestamp from Adjust's servers. | | `Adid` | String | A unique device identifier provided by Adjust. | -| `JsonResponse` | Dictionary \ | The JSOaN object with the response from the server. | +| `JsonResponse` | Dictionary `` | The JSON object with the response from the server. | | `WillRetry` | Boolean | Indicates whether there will be an attempt to resend a failed package. | ### Success callbacks +```ts title="Method signature" +public setSessionTrackingSucceededCallbackListener( + callback: (sessionSuccess: AdjustSessionTrackingSuccess) => void +): void +``` + Set up success callbacks to trigger functions when the SDK records a session. - +```jsx {6-15} +const adjustConfig = new AdjustConfig( + "{YourAppToken}", + AdjustConfig.EnvironmentSandbox +); +//... +adjustConfig.setSessionTrackingSucceededCallbackListener(function ( + sessionSuccess +) { + // Printing all session success properties. + console.log("Session tracking succeeded!"); + console.log(sessionSuccess.message); + console.log(sessionSuccess.timestamp); + console.log(sessionSuccess.adid); + console.log(sessionSuccess.jsonResponse); +}); +//... +Adjust.create(adjustConfig); +``` #### Example @@ -62,9 +81,34 @@ Adjust.create(adjustConfig); ### Failure callbacks +```ts title="Method signature" +public setSessionTrackingFailedCallbackListener( + callback: (sessionFailed: AdjustSessionTrackingFailure) => void +): void +``` + Set up failure callbacks to trigger functions when the SDK fails to record a session. - +```jsx {6-16} +const adjustConfig = new AdjustConfig( + "{YourAppToken}", + AdjustConfig.EnvironmentSandbox +); +//... +adjustConfig.setSessionTrackingFailedCallbackListener(function ( + sessionFailure +) { + // Printing all session failure properties. + console.log("Session tracking failed!"); + console.log(sessionFailure.message); + console.log(sessionFailure.timestamp); + console.log(sessionFailure.adid); + console.log(sessionFailure.willRetry); + console.log(sessionFailure.jsonResponse); +}); +//... +Adjust.create(adjustConfig); +``` #### Example @@ -98,18 +142,42 @@ Event callbacks have access to a response data object. You can use its propertie | `Message` | String | The message from the server or the error logged by the SDK. | | `Timestamp` | String | The timestamp from Adjust's servers. | | `Adid` | String | A unique device identifier provided by Adjust. | -| `JsonResponse` | Dictionary \ | The JSON object with the response from the server. | | `EventToken` | String | The event token | | `CallbackId` | String | The custom callback ID set on the event object | +| `JsonResponse` | Dictionary `` | The JSON object with the response from the server. | | `WillRetry` | Boolean | Indicates whether there will be an attempt to resend a failed package. | ### Success callbacks +```jsx title="Method signature" +public setEventTrackingSucceededCallbackListener( + callback: (eventSuccess: AdjustEventTrackingSuccess) => void +): void +``` + Set up success callbacks to trigger functions when the SDK records an event. - +```jsx {6-15} +const adjustConfig = new AdjustConfig( + "{YourAppToken}", + AdjustConfig.EnvironmentSandbox +); +//... +adjustConfig.setEventTrackingSucceededCallbackListener(function (eventSuccess) { + // Printing all event success properties. + console.log("Event tracking succeeded!"); + console.log(eventSuccess.message); + console.log(eventSuccess.timestamp); + console.log(eventSuccess.eventToken); + console.log(eventSuccess.callbackId); + console.log(eventSuccess.adid); + console.log(eventSuccess.jsonResponse); +}); +//... +Adjust.create(adjustConfig); +``` #### Example @@ -130,9 +198,34 @@ Adjust.create(adjustConfig); ### Failure callbacks +```ts title="Method signature" +public setEventTrackingFailedCallbackListener( + callback: (eventFailed: AdjustEventTrackingFailure) => void +): void +``` + Set up failure callbacks to trigger functions when the SDK fails to record an event. - +```jsx {6-16} +const adjustConfig = new AdjustConfig( + "{Your App Token}", + AdjustConfig.EnvironmentSandbox +); +adjustConfig.setLogLevel(AdjustLogLevel.Verbose); +adjustConfig.setEventTrackingFailedCallbackListener(function (eventFailure) { + // Printing all event failure properties. + console.log("Event tracking failed!"); + console.log(eventFailure.message); + console.log(eventFailure.timestamp); + console.log(eventFailure.eventToken); + console.log(eventFailure.callbackId); + console.log(eventFailure.adid); + console.log(eventFailure.willRetry); + console.log(eventFailure.jsonResponse); +}); +//... +Adjust.create(adjustConfig); +``` #### Example diff --git a/src/content/docs/sdk/react-native/features/device-info.mdx b/src/content/docs/sdk/react-native/features/device-info.mdx index 340278354..8bb46df63 100644 --- a/src/content/docs/sdk/react-native/features/device-info.mdx +++ b/src/content/docs/sdk/react-native/features/device-info.mdx @@ -4,41 +4,64 @@ description: Use these methods to add details to your callbacks and improve your slug: en/sdk/react-native/features/device-info --- -import GetIdfa from "@react-native-examples/Adjust/getIdfa.mdx" -import GetIdfaSig from "@react-native-signatures/Adjust/getIdfa.mdx" -import GetAdid from "@react-native-examples/Adjust/getAdid.mdx" -import GetAdidSig from "@react-native-signatures/Adjust/getAdid.mdx" -import GetAmazonAdId from "@react-native-examples/Adjust/getAmazonAdId.mdx" -import GetAmazonAdIdSig from "@react-native-signatures/Adjust/getAmazonAdId.mdx" -import GetGoogleAdId from "@react-native-examples/Adjust/getGoogleAdId.mdx" -import GetGoogleAdIdSig from "@react-native-signatures/Adjust/getGoogleAdId.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 -Adjust generates a unique ADID (Adjust Device ID) for each device. Call the `getAdid` method to return this ID as a **string**. +```ts title="Method signature" +getAdid: (callback: (adid: string) => void) => void +``` + +Adjust generates a unique Adjust Device ID (ADID) for each device. Call the `getAdid` method to return this ID as a **string**. - +```jsx +Adjust.getAdid((adid) => { + console.log("ADID = " + adid); +}); +``` ## ID For Advertisers -The IDFA (ID for Advertisers) is a device-specific identifier for Apple devices. Call the `getIdfa` method to return this ID as a **string**. +```ts title="Method signature" +getIdfa: (callback: (idfa: string) => void) => void +``` + +The ID for Advertisers (IDFA) is a device-specific identifier for Apple devices. Call the `getIdfa` method to return this ID as a **string**. - +```jsx +Adjust.getIdfa((idfa) => { + console.log("IDFA = " + idfa); +}); +``` ## Google Play Services Advertising ID -The GPS ADID (Google Play Services Advertising ID) is a device-specific identifier for Android devices. +```ts title="Method signature" +getGoogleAdId: (callback: (adid: string) => void) => void +``` + +The Google Play Services Advertising ID (GPS ADID) is a device-specific identifier for Android devices. Users can opt out of sharing their GPS ADID by toggling the "Opt out of Ads Personalization" setting on their device. When a user enables this setting, the Adjust SDK returns a string of zeros when trying to read the GPS ADID. You can access this value by calling the `getGoogleAdId` method in a background thread. Assign a delegate function to access the GPS ADID value. - +```jsx +Adjust.getGoogleAdId((googleAdId) => { + console.log("Google Ad ID = " + googleAdId); +}); +``` ## Amazon Advertiser ID -The Amazon Ad ID (Amazon Advertising ID) is a device-specific identifier for Android devices. Call the `getAmazonAdId` method to return this ID as a **string**. +```ts title="Method signature" +getAmazonAdId: (callback: (adid: string) => void) => void +``` + +The Amazon Advertising ID (Amazon Ad ID) is a device-specific identifier for Android devices. Call the `getAmazonAdId` method to return this ID as a **string**. - +```jsx +Adjust.getAmazonAdId((amazonAdId) => { + console.log("Amazon Ad ID = " + amazonAdId); +}); +``` diff --git a/src/content/docs/sdk/react-native/features/events.mdx b/src/content/docs/sdk/react-native/features/events.mdx index fa98b3e9e..a68e4b914 100644 --- a/src/content/docs/sdk/react-native/features/events.mdx +++ b/src/content/docs/sdk/react-native/features/events.mdx @@ -4,25 +4,41 @@ description: Use these methods send event information to Adjust. slug: en/sdk/react-native/features/events --- -import TrackEvent from "@react-native-examples/Adjust/trackEvent.mdx"; -import TrackEventSig from "@react-native-signatures/Adjust/trackEvent.mdx"; -import SetRevenue from "@react-native-examples/AdjustEvent/setRevenue.mdx"; -import SetRevenueSig from "@react-native-signatures/AdjustEvent/setRevenue.mdx"; -import SetTransactionId from "@react-native-examples/AdjustEvent/setTransactionId.mdx"; -import SetTransactionIdSig from "@react-native-signatures/AdjustEvent/setTransactionId.mdx"; -import SetCallbackId from "@react-native-examples/AdjustEvent/setCallbackId.mdx"; -import SetCallbackIdSig from "@react-native-signatures/AdjustEvent/setCallbackId.mdx"; -import AddCallbackParameter from "@react-native-examples/AdjustEvent/addCallbackParameter.mdx"; -import AddCallbackParameterSig from "@react-native-signatures/AdjustEvent/addCallbackParameter.mdx"; -import AddPartnerParameter from "@react-native-examples/AdjustEvent/addPartnerParameter.mdx"; -import AddPartnerParameterSig from "@react-native-signatures/AdjustEvent/addPartnerParameter.mdx"; +The Adjust SDK provides an `AdjustEvent` object which can be used to structure and send event information from your app to Adjust's servers. + +## Instantiate an AdjustEvent object + +```ts title="Method signature" +constructor(eventToken: string) +``` + +To send event information with the Adjust SDK, you need to instantiate an `AdjustEvent` 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 `AdjustEvent` instance and pass the following parameters: + +- `eventToken` (**String**): Your Adjust [event token](https://help.adjust.com/en/article/add-events#manage-your-events). + +```jsx +var adjustEvent = new AdjustEvent("abc123"); +//... +Adjust.trackEvent(adjustEvent); +``` + +## Send an event + +```ts title="Method signature" +trackEvent: (adjustEvent: AdjustEvent) => void +``` 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. - +```jsx +var adjustEvent = new AdjustEvent("abc123"); +Adjust.trackEvent(adjustEvent); +``` ### Example @@ -38,21 +54,75 @@ function _onPress_trackSimpleEvent() { + onPress={_onPress_trackSimpleEvent} + > Track Simple Event + - +; +``` + +```txt collapse={6-46} title="Event log" +Path: /event +ClientSdk: reactnative4.38.0 +Parameters: + android_uuid 781f17d5-5048-4fae-a4e5-77b58bab62b9 + api_level 34 + app_token 2fm9gkqubvpc + app_version 1.0 + attribution_deeplink 1 + callback_params {"key":"value","foo":"bar"} + connectivity_type 1 + country US + cpu_type arm64-v8a + created_at 2024-01-25T14:13:16.151Z+0100 + currency EUR + device_manufacturer Google + device_name sdk_gphone64_arm64 + device_type phone + display_height 2205 + display_width 1080 + environment sandbox + event_buffering_enabled 0 + event_count 3 + event_token g3mfiw + gps_adid 5962dfc1-3a53-4692-850b-22c4bf4311a5 + gps_adid_attempt 2 + gps_adid_src service + hardware_name UE1A.230829.036 + language en + mcc 310 + mnc 260 + needs_response_details 1 + os_build UE1A.230829.036 + os_name android + os_version 14 + package_name com.adjust.examples + partner_params {"key":"value","foo":"bar"} + revenue 0.25 + screen_density high + screen_format long + screen_size normal + session_count 2 + session_length 23 + subsession_count 1 + time_spent 23 + tracking_enabled 1 + ui_mode 1 ``` ## Record event revenue +```ts title="Method signature" +public setRevenue(revenue: number, currency: string): void +``` + 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. @@ -60,7 +130,13 @@ Check the guide to [tracking purchases in different currencies](https://help.adj - +```jsx {3} +var adjustEvent = new AdjustEvent("abc123"); +//... +adjustEvent.setRevenue(0.01, "EUR"); +//... +Adjust.trackEvent(adjustEvent); +``` ### Example @@ -136,11 +212,21 @@ Parameters: ## Unique events +```ts title="Method signature" +public setTransactionId(transactionId: string): void +``` + You can pass an optional identifier to avoid recording duplicate events. The SDK stores the last ten identifiers and skips revenue events with duplicate transaction IDs. To set the identifier, call the `setTransactionId` method and pass your transaction ID as a **string** argument. - +```jsx {3} +var adjustEvent = new AdjustEvent("abc123"); +//... +adjustEvent.setTransactionId("{transactionId}"); +//... +Adjust.trackEvent(adjustEvent); +``` ### Example @@ -178,17 +264,27 @@ Parameters: ## Add callback parameters +```ts title="Method signature" +public addCallbackParameter(key: string, value: string): void +``` + 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. - +```jsx {3} +var adjustEvent = new AdjustEvent("abc123"); +//... +adjustEvent.addCallbackParameter("key", "value"); +//... +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: -```http "key=value" "foo=bar" +```http https://www.mydomain.com/callback?key=value&foo=bar ``` @@ -253,6 +349,10 @@ Parameters: ## Add partner parameters +```ts title="Method signature" +public addPartnerParameter(key: string, value: string): void +``` + 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. @@ -265,7 +365,13 @@ 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. - +```jsx {3} +var adjustEvent = new AdjustEvent("abc123"); +//... +adjustEvent.addPartnerParameter("key", "value"); +//... +Adjust.trackEvent(adjustEvent); +``` ### Example @@ -306,11 +412,21 @@ Parameters: ## Add a callback identifier +```ts title="Method signature" +public setCallbackId(callbackId: string): void +``` + 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. - +```jsx {3} +var adjustEvent = new AdjustEvent("abc123"); +//... +adjustEvent.setCallbackId("your_callback_id"); +//... +Adjust.trackEvent(adjustEvent); +``` ### Example @@ -325,6 +441,7 @@ function _onPress_trackUniqueCallbackEvent() { //... Adjust.trackEvent(adjustEvent); } +//... <> void +``` + +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. + +```jsx +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 + +```ts title="Method signature" +constructor(isEnabled: boolean) +``` + +To enable or disable third party sharing with the Adjust SDK, you need to instantiate an `AdjustThirdPartySharing` object. This object contains variables that control how third party sharing is handled by Adjust. + +To instantiate a third party sharing object, create a new `AdjustThirdPartySharing` instance and pass the following parameters: + +- `isEnabled` (**Boolean**): Whether third party sharing is enabled. Pass `true` to enable third party sharing or `false` to disable third party sharing + +```jsx +var adjustThirdPartySharing = new AdjustThirdPartySharing(true); +//... +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + + + +If you set the `isEnabled` property to `false`, 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. + +```jsx +var adjustThirdPartySharing = new AdjustThirdPartySharing(false); +//... +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + +### Send granular information + +```ts title="Method signature" +public addGranularOption(partnerName: string, key: string, value: string): void +``` + +You can attach granular information when a user updates their third-party sharing preferences. Use this information to communicate more detail about a user's decision. To do this, call the `addGranularOption` method with the following parameters: + +- `partnerName` (**String**): The name of the partner for whom the granular option applies. +- `key` (**String**): The option key. +- `value` (**String**): The option value. + +The following partners are available: + + + +| Partner name | String value | +| ----------------------- | --------------------------- | +| AppleAds | `apple_ads` | +| Facebook | `facebook` | +| GoogleAds | `adwords` | +| GoogleMarketingPlatform | `google_marketing_platform` | +| Snapchat | `snapchat` | +| Tencent | `tencent` | +| TikTokSan | `tiktok_san` | +| Twitter | `twitter` | +| YahooGemini | `yahoo_gemini` | +| YahooJapanSearch | `yahoo_japan_search` | + +
+ +```jsx {3} +var adjustThirdPartySharing = new AdjustThirdPartySharing(null); +//... +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 + + + +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`. + + + +```jsx {3-12} +var adjustThirdPartySharing = new AdjustThirdPartySharing(null); +//... +adjustThirdPartySharing.addGranularOption( + "facebook", + "data_processing_options_country", + "1" +); +adjustThirdPartySharing.addGranularOption( + "facebook", + "data_processing_options_state", + "1000" +); +//... +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + +#### 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. | + +
+ +```jsx +var adjustThirdPartySharing = new AdjustThirdPartySharing(null); +adjustThirdPartySharing.addGranularOption("google_dma", "eea", "1"); +adjustThirdPartySharing.addGranularOption( + "google_dma", + "ad_personalization", + "1" +); +adjustThirdPartySharing.addGranularOption("google_dma", "ad_user_data", "1"); +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + +## Disable third-party sharing + +```ts title="Method signature" +disableThirdPartySharing: () => void +``` + +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. + +```jsx +Adjust.disableThirdPartySharing(); +``` + +## Data residency + +```ts title="Method signature" +public setUrlStrategy(urlStrategy: UrlStrategy): void +``` + +The URL strategy feature allows you to set either: + +- The country in which Adjust stores your data (data residency). +- The endpoint to which the Adjust SDK sends traffic (URL strategy). + +This is useful if you're operating in a country with strict privacy requirements. When you set your URL strategy, Adjust stores data in the selected data residency region or sends traffic to the chosen domain. + +To set your country of data residency, call the `setUrlStrategy` method on your `AdjustConfig` instance with the following parameter: + +- `urlStrategy` (**String**): The country of data residence or endpoint to which you want to send SDK traffic. + + + +| Value | Description | +| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| `AdjustConfig.DataResidencyEU` | Sets the area of data residency to the EU | +| `AdjustConfig.DataResidencyTR` | Sets the area of data residency to Turkey | +| `AdjustConfig.DataResidencyUS` | Sets the area of data residency to the USA | +| `AdjustConfig.UrlStrategyChina` | Points the URL strategy to the `app.adjust.world` domain | +| `AdjustConfig.UrlStrategyCn` | Points the URL strategy to the `app.adjust.cn` domain | +| `AdjustConfig.UrlStrategyCnOnly` | Points the URL strategy to the `app.adjust.cn` domain but **doesn't** fall back to another domain if the request fails. | +| `AdjustConfig.UrlStrategyIndia` | Points the URL strategy to the `app.adjust.net.in` domain | + +
+ +```jsx "AdjustConfig.DataResidencyEU" {5} +const adjustConfig = new AdjustConfig( + "{YourAppToken}", + AdjustConfig.EnvironmentSandbox +); +adjustConfig.setUrlStrategy(AdjustConfig.DataResidencyEU); +Adjust.create(adjustConfig); +``` + +## Consent measurement for specific users + +```ts title="Method signature" +trackMeasurementConsent: (measurementConsent: boolean) => void +``` + +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: + +- `consentMeasurement` (**Boolean**): Whether consent measurement is enabled (`true`) or not (`false`). + +When enabled, the SDK communicates the data privacy settings to Adjust's servers. Adjust's servers then applies your data privacy rules to the user. The Adjust SDK continues to work as expected. + +```jsx +Adjust.trackMeasurementConsent(true); +``` + +## COPPA compliance + +```ts title="Method signature" +public setCoppaCompliantEnabled(coppaCompliantEnabled: boolean): void +``` + +If you need your app to be compliant with the Children's Online Privacy Protection Act (COPPA), call the `setCoppaCompliantEnabled` method. This method performs the following actions: + +1. Disables third-party sharing **before** the user launches their first `session`. +2. Prevents the SDK from reading device and advertising IDs (for example: `gps_adid` and `android_id`). + +```jsx {6} +const adjustConfig = new AdjustConfig( + "{YourAppToken}", + AdjustConfig.EnvironmentSandbox +); +//... +adjustConfig.setCoppaCompliantEnabled(true); +Adjust.create(adjustConfig); +``` + +You can disable this method by calling it with a `false` parameter. + + + +Disabling the `setCoppaCompliantEnabled` method _doesn't_ re-enable third-party sharing. You need to [re-enable third-party sharing](#enable-third-party-sharing) for the user. + + + +## Play Store Kids Apps (Android only) + +```ts title="Method signature" +public setPlayStoreKidsAppEnabled(playStoreKidsAppEnabled: boolean): void +``` + +If your app targets users under the age of 13, and the install region **isn't** the USA, you need to mark it as a Kids App. This prevents the SDK from reading device and advertising IDs (for example: `gps_adid` and `android_id`). + +To mark your app as a Kids App, call the `setPlayStoreKidsAppEnabled` method with the following argument: + +- `playStoreKidsAppEnabled` (**Boolean**): set to `true` to mark the app as a Kids App, or `false` to mark the app as a non-Kids App. + +```jsx {6} +const adjustConfig = new AdjustConfig( + "{YourAppToken}", + AdjustConfig.EnvironmentSandbox +); +//... +adjustConfig.setPlayStoreKidsAppEnabled(true); +//... +Adjust.create(adjustConfig); +``` diff --git a/src/content/docs/sdk/react-native/features/session-parameters.mdx b/src/content/docs/sdk/react-native/features/session-parameters.mdx index d8b5096e5..154b29e21 100644 --- a/src/content/docs/sdk/react-native/features/session-parameters.mdx +++ b/src/content/docs/sdk/react-native/features/session-parameters.mdx @@ -4,26 +4,9 @@ description: Send information to your callback URL with each session. slug: en/sdk/react-native/features/session-parameters --- -import AddSessionCallbackParameter from "@react-native-examples/Adjust/addSessionCallbackParameter.mdx" -import AddSessionCallbackParameterSig from "@react-native-signatures/Adjust/addSessionCallbackParameter.mdx" -import RemoveSessionCallbackParameter from "@react-native-examples/Adjust/removeSessionCallbackParameter.mdx" -import RemoveSessionCallbackParameterSig from "@react-native-signatures/Adjust/removeSessionCallbackParameter.mdx" -import ResetSessionCallbackParameters from "@react-native-examples/Adjust/resetSessionCallbackParameters.mdx" -import ResetSessionCallbackParametersSig from "@react-native-signatures/Adjust/resetSessionCallbackParameters.mdx" -import AddSessionPartnerParameter from "@react-native-examples/Adjust/addSessionPartnerParameter.mdx" -import AddSessionPartnerParameterSig from "@react-native-signatures/Adjust/addSessionPartnerParameter.mdx" -import RemoveSessionPartnerParameter from "@react-native-examples/Adjust/removeSessionPartnerParameter.mdx" -import RemoveSessionPartnerParameterSig from "@react-native-signatures/Adjust/removeSessionPartnerParameter.mdx" -import ResetSessionPartnerParameters from "@react-native-examples/Adjust/resetSessionPartnerParameters.mdx" -import ResetSessionPartnerParametersSig from "@react-native-signatures/Adjust/resetSessionPartnerParameters.mdx" -import SetDelayStart from "@react-native-examples/AdjustConfig/setDelayStart.mdx" -import SetDelayStartSig from "@react-native-signatures/AdjustConfig/setDelayStart.mdx" -import SendFirstPackages from "@react-native-examples/Adjust/sendFirstPackages.mdx" -import SendFirstPackagesSig from "@react-native-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,43 @@ 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 + +```ts title="Method signature" +addSessionCallbackParameter: (key: string, value: string) => void +``` + 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. - +```jsx +Adjust.addSessionCallbackParameter("key", "value"); +``` + +### Remove session callback parameters + +```ts title="Method signature" +removeSessionCallbackParameter: (key: string) => void +``` -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. - +```jsx +Adjust.removeSessionCallbackParameter("key"); +``` + +### Reset session callback parameters + +```ts title="Method signature" +resetSessionCallbackParameters: () => void +``` You can remove all session parameters if they're no longer required. To do this, call the `resetSessionCallbackParameters` method. - +```jsx +Adjust.resetSessionCallbackParameters(); +``` ## Session partner parameters @@ -55,17 +64,41 @@ 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 + +```ts title="Method signature" +addSessionPartnerParameter: (key: string, value: string) => void +``` + +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. - +```jsx +Adjust.addSessionPartnerParameter("key", "value"); +``` + +### Remove session partner parameters + +```ts title="Method signature" +removeSessionPartnerParameter: (key: string) => void +``` You can remove specific session partner parameters if they're no longer required. To do this, pass the parameter key to the `removeSessionPartnerParameter` method. - +```jsx +Adjust.removeSessionPartnerParameter("key"); +``` + +### Reset session partner parameters + +```ts title="Method signature" +resetSessionPartnerParameters: () => void +``` You can remove all session partner parameters if they're no longer required. To do this, call the `resetSessionPartnerParameters` method. - +```jsx +Adjust.resetSessionPartnerParameters(); +``` ## Delay start @@ -75,10 +108,21 @@ 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, pass the delay time in seconds to the [`setDelayStart` method](/en/sdk/react-native/configuration#delay-the-start-of-the-sdk) on your config object. - +```jsx {6} +const adjustConfig = new AdjustConfig( + "{YourAppToken}", + AdjustConfig.EnvironmentSandbox +); +//... +adjustConfig.setDelayStart(5.5); +//... +Adjust.create(adjustConfig); +``` 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. - +```jsx +Adjust.sendFirstPackages(); +``` diff --git a/src/content/docs/sdk/react-native/configuration/skad.mdx b/src/content/docs/sdk/react-native/features/skad.mdx similarity index 75% rename from src/content/docs/sdk/react-native/configuration/skad.mdx rename to src/content/docs/sdk/react-native/features/skad.mdx index 16f615dc9..7c88e69b7 100644 --- a/src/content/docs/sdk/react-native/configuration/skad.mdx +++ b/src/content/docs/sdk/react-native/features/skad.mdx @@ -1,23 +1,16 @@ --- title: Set up SKAdNetwork and conversion values description: Configure SKAdNetwork features for your iOS apps. -slug: en/sdk/react-native/configuration/skad +slug: en/sdk/react-native/features/skad --- -import DeactivateSKAdNetworkHandling from "@react-native-examples/AdjustConfig/deactivateSKAdNetworkHandling.mdx"; -import DeactivateSKAdNetworkHandlingSig from "@react-native-signatures/AdjustConfig/deactivateSKAdNetworkHandling.mdx"; -import UpdateConversionValue from "@react-native-examples/Adjust/updateConversionValue.mdx"; -import UpdateConversionValueSig from "@react-native-signatures/Adjust/updateConversionValue.mdx"; -import SetConversionValueUpdatedCallbackListener from "@react-native-examples/AdjustConfig/setConversionValueUpdatedCallbackListener.mdx"; -import SetConversionValueUpdatedCallbackListenerSig from "@react-native-signatures/AdjustConfig/setConversionValueUpdatedCallbackListener.mdx"; - This feature is only available on devices running iOS 14 and above. -SKAdNetwork (StoreKit Ad Network) is Apple's attribution framework for +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. @@ -26,8 +19,16 @@ app install and reinstall attribution. The SKAdNetwork workflow goes like this: ## Disable SKAdNetwork communication +```ts title="Method signature" +public deactivateSKAdNetworkHandling(): void +``` + + + 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. @@ -36,15 +37,30 @@ You must call the `deactivateSKAdNetworkHandling` method _before_ initializing t - +```jsx {6} +const adjustConfig = new AdjustConfig( + "{YourAppToken}", + AdjustConfig.EnvironmentSandbox +); +//... +adjustConfig.deactivateSKAdNetworkHandling(); +//... +Adjust.create(adjustConfig); +``` ## Update conversion values +```ts title="Method signature" +updateConversionValue: (conversionValue: number) => void +``` + 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. - +```jsx +Adjust.updateConversionValue(6); +``` ### Example @@ -58,9 +74,26 @@ function _onPress_trackSimpleEvent() { ## Listen for changes to conversion values +```ts title="Method signature" +public setConversionValueUpdatedCallbackListener( + callback: (conversionValue: AdjustConversionValue) => void +): void +``` + If you use Adjust to manage conversion values, the Adjust's servers send conversion value updates to the SDK. You can set up a delegate function to listen for these changes using the `setConversionValueUpdatedCallbackListener` method. Pass your function as an argument. - +```jsx {3-8} +const adjustConfig = new AdjustConfig(appToken, environment); + +adjustConfig.setConversionValueUpdatedCallbackListener(function ( + conversionValue +) { + console.log("Conversion value updated callback recveived"); + console.log("Conversion value: " + conversionValue.conversionValue); +}); + +Adjust.create(adjustConfig); +``` ### Example diff --git a/src/content/docs/sdk/react-native/features/subscriptions.mdx b/src/content/docs/sdk/react-native/features/subscriptions.mdx index 7e3a11c45..618b12c45 100644 --- a/src/content/docs/sdk/react-native/features/subscriptions.mdx +++ b/src/content/docs/sdk/react-native/features/subscriptions.mdx @@ -4,27 +4,6 @@ description: Use these methods send subscription information to Adjust. slug: en/sdk/react-native/features/subscriptions --- -import AdjustAppStoreSubscription from "@react-native-examples/AdjustAppStoreSubscription/adjustAppStoreSubscription.mdx"; -import AdjustPlayStoreSubscription from "@react-native-examples/AdjustPlayStoreSubscription/adjustPlayStoreSubscription.mdx"; -import SetTransactionDate from "@react-native-examples/AdjustAppStoreSubscription/setTransactionDate.mdx"; -import SetTransactionDateSig from "@react-native-signatures/AdjustAppStoreSubscription/setTransactionDate.mdx"; -import SetPurchaseTime from "@react-native-examples/AdjustPlayStoreSubscription/setPurchaseTime.mdx"; -import SetPurchaseTimeSig from "@react-native-signatures/AdjustPlayStoreSubscription/setPurchaseTime.mdx"; -import SetSalesRegion from "@react-native-examples/AdjustAppStoreSubscription/setSalesRegion.mdx"; -import SetSalesRegionSig from "@react-native-signatures/AdjustAppStoreSubscription/setSalesRegion.mdx"; -import AddCallbackParameterAppStore from "@react-native-examples/AdjustAppStoreSubscription/addCallbackParameter.mdx"; -import AddCallbackParameterAppStoreSig from "@react-native-signatures/AdjustAppStoreSubscription/addCallbackParameter.mdx"; -import AddCallbackParameterPlayStore from "@react-native-examples/AdjustPlayStoreSubscription/addCallbackParameter.mdx"; -import AddCallbackParameterPlayStoreSig from "@react-native-signatures/AdjustPlayStoreSubscription/addCallbackParameter.mdx"; -import AddPartnerParameterAppStore from "@react-native-examples/AdjustAppStoreSubscription/addPartnerParameter.mdx"; -import AddPartnerParameterAppStoreSig from "@react-native-signatures/AdjustAppStoreSubscription/addPartnerParameter.mdx"; -import AddPartnerParameterPlayStore from "@react-native-examples/AdjustPlayStoreSubscription/addPartnerParameter.mdx"; -import AddPartnerParameterPlayStoreSig from "@react-native-signatures/AdjustPlayStoreSubscription/addPartnerParameter.mdx"; -import TrackAppStoreSubscription from "@react-native-examples/Adjust/trackAppStoreSubscription.mdx"; -import TrackAppStoreSubscriptionSig from "@react-native-signatures/Adjust/trackAppStoreSubscription.mdx"; -import TrackPlayStoreSubscription from "@react-native-examples/Adjust/trackPlayStoreSubscription.mdx"; -import TrackPlayStoreSubscriptionSig from "@react-native-signatures/Adjust/trackPlayStoreSubscription.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. @@ -33,13 +12,17 @@ The following steps only set up subscription tracking within the Adjust SDK. To You can record App Store and Play Store subscriptions and verify their validity with the Adjust SDK. After the user purchases a subscription, create an `AdjustAppStoreSubscription` or `AdjustPlayStoreSubscription` instance containing the details. -## 1. Set up your subscription object +## 1. Instantiate a subscription object To get started, you need to create a subscription object containing details of the subscription purchase. +```ts title="Method signature" +constructor(price: string, currency: string, transactionId: string, receipt: string) +``` + Create an `AdjustAppStoreSubscription` object with the following properties @@ -53,11 +36,25 @@ Create an `AdjustAppStoreSubscription` object with the following properties
- +```jsx {9} +var subscription = new AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken +); +Adjust.trackPlayStoreSubscription(subscription); +``` +```ts title="Method signature" +constructor(price: string, currency: string, sku: string, orderId: string, signature: string, purchaseToken: string) +``` + Create an `AdjustPlayStoreSubscription` object with the following properties @@ -73,7 +70,16 @@ Create an `AdjustPlayStoreSubscription` object with the following properties
- +```jsx +var subscription = new AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken +); +``` @@ -85,25 +91,71 @@ You can record the date on which the user purchased a subscription. The SDK retu +```ts title="Method signature" +public setTransactionDate(transactionDate: string): void +``` + Call the `setTransactionDate` method method on your subscription object to record the timestamp of the subscription. - +```jsx {10} +var subscription = new AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken +); +//... +subscription.setTransactionDate(transactionDate); +Adjust.trackPlayStoreSubscription(subscription); +``` +```ts title="Method signature" +public setPurchaseTime(purchaseTime: string): void +``` + Call the `setPurchaseTime` method on your subscription object to record the timestamp of the subscription. - +```jsx {9} +var subscription = new AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken +); +subscription.setPurchaseTime(purchaseTime); +``` ### Record the purchase region (iOS only) +```ts title="Method signature" +public setSalesRegion(salesRegion: string): void +``` + 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. - +```jsx {10} +var subscription = new AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken +); +//... +subscription.setSalesRegion(salesRegion); +Adjust.trackPlayStoreSubscription(subscription); +``` ### Add callback parameters @@ -112,12 +164,46 @@ You can add callback parameters to your subscription object. The SDK appends the - +```ts title="Method signature" +public addCallbackParameter(key: string, value: string): void +``` + +```jsx {10-11} +var subscription = new AdjustAppStoreSubscription( + price, + currency, + transactionId, + receipt +); +subscription.setTransactionDate(transactionDate); +subscription.setSalesRegion(salesRegion); +//... +subscription.addCallbackParameter("key1", "value1"); +subscription.addCallbackParameter("key2", "value2"); + +Adjust.trackAppStoreSubscription(subscription); +``` - +```ts title="Method signature" +public addCallbackParameter(key: string, value: string): void +``` + +```jsx {10,11} +var subscription = new AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken +); +//... +subscription.addCallbackParameter("key1", "value1"); +subscription.addCallbackParameter("key2", "value2"); +``` @@ -129,12 +215,46 @@ You can add partner parameters to your subscription object. The SDK sends these - +```ts title="Method signature" +public addPartnerParameter(key: string, value: string): void +``` + +```jsx {10-11} +var subscription = new AdjustAppStoreSubscription( + price, + currency, + transactionId, + receipt +); +subscription.setTransactionDate(transactionDate); +subscription.setSalesRegion(salesRegion); +//... +subscription.addPartnerParameter("key1", "value1"); +subscription.addPartnerParameter("key2", "value2"); + +Adjust.trackAppStoreSubscription(subscription); +``` - +```ts title="Method signature" +public addPartnerParameter(key: string, value: string): void +``` + +```jsx {10,11} +var subscription = new AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken +); +//... +subscription.addPartnerParameter("key1", "value1"); +subscription.addPartnerParameter("key2", "value2"); +``` @@ -146,16 +266,47 @@ Once you have set up your subscription object, you can record it using the Adjus +```ts title="Method signature" +trackAppStoreSubscription: (subscription: AdjustAppStoreSubscription) => void +``` + Pass your subscription object to the `trackAppStoreSubscription` method method to record the user's subscription purchase. - +```jsx {10} +var subscription = new AdjustAppStoreSubscription( + price, + currency, + transactionId, + receipt +); +subscription.setTransactionDate(transactionDate); +subscription.setSalesRegion(salesRegion); + +Adjust.trackAppStoreSubscription(subscription); +``` +```ts title="Method signature" +trackPlayStoreSubscription: (subscription: AdjustPlayStoreSubscription) => void +``` + Pass your subscription object to the `trackPlayStoreSubscription` method method to record the user's subscription purchase. - +```jsx {11} +var subscription = new AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken +); +subscription.setPurchaseTime(purchaseTime); + +Adjust.trackPlayStoreSubscription(subscription); +``` diff --git a/src/content/docs/sdk/react-native/plugins/index.mdx b/src/content/docs/sdk/react-native/plugins/index.mdx index d6e361b38..1f358e043 100644 --- a/src/content/docs/sdk/react-native/plugins/index.mdx +++ b/src/content/docs/sdk/react-native/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/react-native/plugins type: category +sidebar-position: 3 --- Use plugins to pass information to third-party plugins. diff --git a/src/content/docs/sdk/react-native/plugins/oaid.mdx b/src/content/docs/sdk/react-native/plugins/oaid.mdx index 419131dff..577b6d540 100644 --- a/src/content/docs/sdk/react-native/plugins/oaid.mdx +++ b/src/content/docs/sdk/react-native/plugins/oaid.mdx @@ -4,7 +4,7 @@ description: Use the OAID plugin to read a device's OAID. slug: en/sdk/react-native/plugins/oaid --- -The OAID (Open Anonymous Device Identifier) is a unique identifier for Android devices. The MSA (Mobile Security Alliance) recommends all Chinese-manufactured devices provide an OAID. You can use the OAID to attribute and track devices where Google Play Services isn't available. +The Open Anonymous Device Identifier (OAID) is a unique identifier for Android devices. The Mobile Security Alliance (MSA) recommends all Chinese-manufactured devices provide an OAID. You can use the OAID to attribute and track devices where Google Play Services isn't available. The OAID plugin provides the OAID of a device. The SDK will continue to use other identifiers as well as the OAID. @@ -35,6 +35,9 @@ Adjust.create(adjustConfig); To stop the SDK from reading OAID values, call the `AdjustOaid.doNotReadOaid()` method. -```jsx -AdjustOaid.readOaid(); +```jsx {2} +import { AdjustOaid } from 'react-native-adjust-oaid'; +AdjustOaid.doNotReadOaid(); +// ... +Adjust.create(adjustConfig); ``` diff --git a/src/content/docs/sdk/react-native/reference/adjust/config.mdx b/src/content/docs/sdk/react-native/reference/adjust/config.mdx deleted file mode 100644 index 3d78d2701..000000000 --- a/src/content/docs/sdk/react-native/reference/adjust/config.mdx +++ /dev/null @@ -1,157 +0,0 @@ ---- -title: Configuration methods -description: Use these methods to update the Adjust SDK's configuration. -slug: en/sdk/react-native/reference/adjust/config ---- - -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 "@react-native-signatures/Adjust/setEnabled.mdx" - - - - - - - -import SetEnabled from "@react-native-examples/Adjust/setEnabled.mdx" - - - - - - - -`enabled` (boolean): Whether the SDK is enabled. - - - - - - - -## isEnabled - -Call this method to check whether the Adjust SDK is enabled. - - - -import IsEnabledSig from "@react-native-signatures/Adjust/isEnabled.mdx" - - - - - - - -import IsEnabled from "@react-native-examples/Adjust/isEnabled.mdx" - - - - - - - -`enabled` (boolean): 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 "@react-native-signatures/Adjust/sendFirstPackages.mdx" - - - - - - - -import SendFirstPackages from "@react-native-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 "@react-native-signatures/Adjust/setOfflineMode.mdx" - - - - - - - -import SetOfflineMode from "@react-native-examples/Adjust/setOfflineMode.mdx" - - - - - - - -`enabled` (boolean): Whether the SDK is in offline mode. - - - - - - - -## setPushToken - -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 SetPushTokenSig from "@react-native-signatures/Adjust/setPushToken.mdx" - - - - - - - -import SetPushToken from "@react-native-examples/Adjust/setPushToken.mdx" - - - - - - - -`token` (string): Your push token. - - - - diff --git a/src/content/docs/sdk/react-native/reference/adjust/device-info.mdx b/src/content/docs/sdk/react-native/reference/adjust/device-info.mdx deleted file mode 100644 index 5ea3dc274..000000000 --- a/src/content/docs/sdk/react-native/reference/adjust/device-info.mdx +++ /dev/null @@ -1,134 +0,0 @@ ---- -title: Device information methods -description: Use these methods to retrieve device information. -slug: en/sdk/react-native/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 GetAdidSig from "@react-native-signatures/Adjust/getAdid.mdx" - - - - - - - -import GetAdid from "@react-native-examples/Adjust/getAdid.mdx" - - - - - - - -`adid` (string): The Adjust identifier associated with the device - - - - - - - -## getIdfa - -Returns the IDFA (ID for advertisers) associated with the device. - - - -import GetIdfaSig from "@react-native-signatures/Adjust/getIdfa.mdx" - - - - - - - -import GetIdfa from "@react-native-examples/Adjust/getIdfa.mdx" - - - - - - - -`idfa` (string): The IDFA associated with the device - - - - - - - -## getGoogleAdid - -Returns the Google ADID (Google advertiser ID) associated with the device. - - - -import GetGoogleAdidSig from "@react-native-signatures/Adjust/getGoogleAdId.mdx" - - - - - - - -import GetGoogleAdid from "@react-native-examples/Adjust/getGoogleAdId.mdx" - - - - - - - -`googleAdid` (string): The Google ADID associated with the device - - - - - - - -## getAmazonAdid - -Returns the Amazon ADID (Amazon advertiser ID) associated with the device. - - - -import GetAmazonAdidSig from "@react-native-signatures/Adjust/getAmazonAdId.mdx" - - - - - - - -import GetAmazonAdid from "@react-native-examples/Adjust/getAmazonAdId.mdx" - - - - - - - -`amazonAdId` (string): The Amazon ADID associated with the device - - - - diff --git a/src/content/docs/sdk/react-native/reference/adjust/index.mdx b/src/content/docs/sdk/react-native/reference/adjust/index.mdx deleted file mode 100644 index 4ac01bad0..000000000 --- a/src/content/docs/sdk/react-native/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/react-native/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/react-native/reference/adjust/privacy.mdx b/src/content/docs/sdk/react-native/reference/adjust/privacy.mdx deleted file mode 100644 index e6f843cda..000000000 --- a/src/content/docs/sdk/react-native/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/react-native/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 "@react-native-signatures/Adjust/disableThirdPartySharing.mdx" - - - - - - - -import DisableThirdPartySharing from "@react-native-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 "@react-native-signatures/Adjust/trackThirdPartySharing.mdx" - - - - - - - -import TrackThirdPartySharing from "@react-native-examples/Adjust/trackThirdPartySharing.mdx" - - - - - - - -`thirdPartySharing` (AdjustThirdPartySharing): 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 "@react-native-signatures/Adjust/trackMeasurementConsent.mdx" - - - - - - - -import TrackMeasurementConsent from "@react-native-examples/Adjust/trackMeasurementConsent.mdx" - - - - - - - -`enabled` (boolean): 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 "@react-native-signatures/Adjust/gdprForgetMe.mdx" - - - - - - - -import GdprForgetMe from "@react-native-examples/Adjust/gdprForgetMe.mdx" - - - - - - diff --git a/src/content/docs/sdk/react-native/reference/adjust/recording.mdx b/src/content/docs/sdk/react-native/reference/adjust/recording.mdx deleted file mode 100644 index 311463264..000000000 --- a/src/content/docs/sdk/react-native/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/react-native/reference/adjust/recording -sidebar-position: 4 ---- - -Use these methods to send information about your app to Adjust. - - - -## trackEvent - -Record event information using an `Adjust` object and an [Adjust event token](https://help.adjust.com/en/article/add-events#add-event). - - - -import TrackEventSig from "@react-native-signatures/Adjust/trackEvent.mdx" - - - - - - - -import TrackEvent from "@react-native-examples/Adjust/trackEvent.mdx" - - - - - - - -`event` (AdjustEvent): 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 "@react-native-signatures/Adjust/addSessionCallbackParameter.mdx" - - - - - - - -import AddSessionCallbackParameter from "@react-native-examples/Adjust/addSessionCallbackParameter.mdx" - - - - - - - -`key` (string): The data key - -`value` (string): The data value - - - - - - - -## removeSessionCallbackParameter - -Remove a session callback parameter. - - - -import RemoveSessionCallbackParameterSig from "@react-native-signatures/Adjust/removeSessionCallbackParameter.mdx" - - - - - - - -import RemoveSessionCallbackParameter from "@react-native-examples/Adjust/removeSessionCallbackParameter.mdx" - - - - - - - -`key` (string): The data key of the parameter you want to remove. - - - - - - - -## resetSessionCallbackParameters - -Removes all session callback parameters. - - - -import ResetSessionCallbackParametersSig from "@react-native-signatures/Adjust/resetSessionCallbackParameters.mdx" - - - - - - - -import ResetSessionCallbackParameters from "@react-native-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 "@react-native-signatures/Adjust/addSessionPartnerParameter.mdx" - - - - - - - -import AddSessionPartnerParameter from "@react-native-examples/Adjust/addSessionPartnerParameter.mdx" - - - - - - - -`key` (string): The data key - -`value` (string): The data value - - - - - - - -## removeSessionPartnerParameter - -Remove a session partner parameter. - - - -import RemoveSessionPartnerParameterSig from "@react-native-signatures/Adjust/removeSessionPartnerParameter.mdx" - - - - - - - -import RemoveSessionPartnerParameter from "@react-native-examples/Adjust/removeSessionPartnerParameter.mdx" - - - - - - - -`key` (string): The data key of the parameter you want to remove. - - - - - - - -## resetSessionPartnerParameters - -Removes all session partner parameters. - - - -import ResetSessionPartnerParametersSig from "@react-native-signatures/Adjust/resetSessionPartnerParameters.mdx" - - - - - - - -import ResetSessionPartnerParameters from "@react-native-examples/Adjust/resetSessionPartnerParameters.mdx" - - - - - - - - - -## trackAdRevenue - -Record the details of an AdjustAdRevenue object. - - - -import TrackAdRevenueSig from "@react-native-signatures/Adjust/trackAdRevenue.mdx" - - - - - - - -import TrackAdRevenue from "@react-native-examples/Adjust/trackAdRevenue.mdx" - - - - - - - -`adRevenue` (AdjustAdRevenue): The ad revenue object containing the revenue details. - - - - - - - -## trackPlayStoreSubscription - -Record a Play Store subscription object. - - - -import TrackPlayStoreSubscriptionSig from "@react-native-signatures/Adjust/trackPlayStoreSubscription.mdx" - - - - - - - -import TrackPlayStoreSubscription from "@react-native-examples/Adjust/trackPlayStoreSubscription.mdx" - - - - - - - -`subscription` (AdjustPlayStoreSubscription): The subscription object containing the purchase details. - - - - - - - -## trackAppStoreSubscription - -Record an App Store subscription object. - - - -import TrackAppStoreSubscriptionSig from "@react-native-signatures/Adjust/trackAppStoreSubscription.mdx" - - - - - - - -import TrackAppStoreSubscription from "@react-native-examples/Adjust/trackAppStoreSubscription.mdx" - - - - - - - -`subscription` (AdjustAppStoreSubscription): The subscription object containing the purchase details. - - - - - - - -## getAttribution - -Fetches attribution data about the device. - - - -import GetAttributionSig from "@react-native-signatures/Adjust/getAttribution.mdx" - - - - - - - -import GetAttribution from "@react-native-examples/Adjust/getAttribution.mdx" - - - - - - - -`attribution` (AdjustAttribution): An attribution object containing attribution data associated with the device. - - - - diff --git a/src/content/docs/sdk/react-native/reference/adjust/skan-att.mdx b/src/content/docs/sdk/react-native/reference/adjust/skan-att.mdx deleted file mode 100644 index c308a1121..000000000 --- a/src/content/docs/sdk/react-native/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/react-native/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 "@react-native-signatures/Adjust/requestTrackingAuthorization.mdx" - - - - - - - -import RequestTrackingAuthorization from "@react-native-examples/Adjust/requestTrackingAuthorization.mdx" - - - - - - - -`statusCallback` (Action\): Completion handler to which the status is passed. - - - - - - - -## getAppTrackingAuthorizationStatus - -Retrieves the user's current authorization status. - - - -import GetAppTrackingAuthorizationStatusSig from "@react-native-signatures/Adjust/appTrackingAuthorizationStatus.mdx" - - - - - - - -import GetAppTrackingAuthorizationStatus from "@react-native-examples/Adjust/appTrackingAuthorizationStatus.mdx" - - - - - - - -`status` (number): The user's authorization status. - - - - - - - -## checkForNewAttStatus - -Prompts the SDK to check the current state of `att_status`. - - - -import CheckForNewAttStatusSig from "@react-native-signatures/Adjust/checkForNewAttStatus.mdx" - - - - - - - -import CheckForNewAttStatus from "@react-native-examples/Adjust/checkForNewAttStatus.mdx" - - - - - - - - - -## updateConversionValue - -Updates the [conversion value](https://help.adjust.com/en/suite/article/conversion-hub). - - - -import UpdateConversionValueSig from "@react-native-signatures/Adjust/updateConversionValue.mdx" - - - - - - - -import UpdateConversionValue from "@react-native-examples/Adjust/updateConversionValue.mdx" - - - - - - - -conversionValue (number): The new conversion value. - - - - diff --git a/src/content/docs/sdk/react-native/reference/adjustadrevenue.mdx b/src/content/docs/sdk/react-native/reference/adjustadrevenue.mdx deleted file mode 100644 index 1cf7a81c2..000000000 --- a/src/content/docs/sdk/react-native/reference/adjustadrevenue.mdx +++ /dev/null @@ -1,269 +0,0 @@ ---- -title: AdjustAdRevenue class -description: Use this class to store ad revenue information. -category-title: AdjustAdRevenue class -slug: en/sdk/react-native/reference/adjustadrevenue ---- - -Use this class to store ad revenue information. - - - -## Constructor - -Creates an ad revenue object initialized with an external ad revenue source. - - - -import ConstructorSig from "@react-native-signatures/AdjustAdRevenue/constructor.mdx"; - - - - - - - -import Constructor from "@react-native-examples/AdjustAdRevenue/constructor.mdx"; - - - - - - - -`source` (string): The source of the ad revenue. - - - -| Parameter | Source | -| ---------------------------------------------- | ----------------- | -| `AdjustConfig.AdRevenueSourceAppLovinMAX` | AppLovin MAX | -| `AdjustConfig.AdRevenueSourceMopub` | Mopub | -| `AdjustConfig.AdRevenueSourceAdMob` | AdMob | -| `AdjustConfig.AdRevenueSourceIronSource` | ironSource | -| `AdjustConfig.AdRevenueSourceAdmost` | AdMost | -| `AdjustConfig.AdRevenueSourceUnity` | Unity | -| `AdjustConfig.AdRevenueSourceHeliumChartboost` | Helium Chartboost | -| `AdjustConfig.AdRevenueSourcePublisher` | Generic source | - -
- - - - - - - -## setRevenue - -Set the revenue amount associated with the ad revenue object. - - - -import SetRevenueSig from "@react-native-signatures/AdjustAdRevenue/setRevenue.mdx"; - - - - - - - -import SetRevenue from "@react-native-examples/AdjustAdRevenue/setRevenue.mdx"; - - - - - - - -`amount` (number): The amount of currency units associated with the ad. - -`currency` (string): 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 "@react-native-signatures/AdjustAdRevenue/setAdImpressionsCount.mdx"; - - - - - - - -import SetAdImpressionsCount from "@react-native-examples/AdjustAdRevenue/setAdImpressionsCount.mdx"; - - - - - - - -`adImpressionsCaount` (number): The number of impressions associated with the ad. - - - - - - - -## setAdRevenueNetwork - -Sets the network associated with the ad revenue. - - - -import SetAdRevenueNetworkSig from "@react-native-signatures/AdjustAdRevenue/setAdRevenueNetwork.mdx"; - - - - - - - -import SetAdRevenueNetwork from "@react-native-examples/AdjustAdRevenue/setAdRevenueNetwork.mdx"; - - - - - - - -`adRevenueNetwork` (string): The network associated with the ad revenue. - - - - - - - -## setAdRevenueUnit - -Sets the ad unit ID associated with the ad revenue. - - - -import SetAdRevenueUnitSig from "@react-native-signatures/AdjustAdRevenue/setAdRevenueUnit.mdx"; - - - - - - - -import SetAdRevenueUnit from "@react-native-examples/AdjustAdRevenue/setAdRevenueUnit.mdx"; - - - - - - - -`unit` (string): The ad unit ID associated with the ad revenue. - - - - - - - -## setAdRevenuePlacement - -Sets the placement of the ad associated with the ad revenue. - - - -import SetAdRevenuePlacementSig from "@react-native-signatures/AdjustAdRevenue/setAdRevenuePlacement.mdx"; - - - - - - - -import SetAdRevenuePlacement from "@react-native-examples/AdjustAdRevenue/setAdRevenuePlacement.mdx"; - - - - - - - -`adRevenuePlacement` (string): The placement of the ad associated with the revenue. - - - - - - - -## addCallbackParameter - -Adds key-value information to send to your callback URL. - - - -import AddCallbackParameterSig from "@react-native-signatures/AdjustAdRevenue/addCallbackParameter.mdx"; - - - - - - - -import AddCallbackParameter from "@react-native-examples/AdjustAdRevenue/addCallbackParameter.mdx"; - - - - - - - -`key` (string): The data key. - -`value` (string): The data value. - - - - - - - -## addPartnerParameter - -Adds key-value information to share with partners. - - - -import AddPartnerParameterSig from "@react-native-signatures/AdjustAdRevenue/addPartnerParameter.mdx"; - - - - - - - -import AddPartnerParameter from "@react-native-examples/AdjustAdRevenue/addPartnerParameter.mdx"; - - - - - - - -`key` (string): The data key. - -`value` (string): The data value. - - - - diff --git a/src/content/docs/sdk/react-native/reference/adjustappstoresubscription.mdx b/src/content/docs/sdk/react-native/reference/adjustappstoresubscription.mdx deleted file mode 100644 index a719c9927..000000000 --- a/src/content/docs/sdk/react-native/reference/adjustappstoresubscription.mdx +++ /dev/null @@ -1,170 +0,0 @@ ---- -title: AdjustAppStoreSubscription class -description: Use this class to store App Store subscription information. -category-title: AdjustAppStoreSubscription class -slug: en/sdk/react-native/reference/adjustappstoresubscription ---- - -import TrackAppStoreSubscription from "@react-native-signatures/Adjust/trackAppStoreSubscription.mdx" - -Use this class to store App Store subscription information. You can pass this to Adjust's servers using the `trackAppStoreSubscription` method. - - - -## Constructor - -Instantiates a subscription object. - - - -import ConstructorSig from "@react-native-signatures/AdjustAppStoreSubscription/constructor.mdx" - - - - - - - -import Constructor from "@react-native-examples/AdjustAppStoreSubscription/adjustAppStoreSubscription.mdx" - - - - - - - -`price` (string): 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. - - - - - - - -## setTransactionDate - -Sets the date of the transaction in the subscription object. - - - -import SetTransactionDateSig from "@react-native-signatures/AdjustAppStoreSubscription/setTransactionDate.mdx" - - - - - - - -import SetTransactionDate from "@react-native-examples/AdjustAppStoreSubscription/setTransactionDate.mdx" - - - - - - - -`transactionDate` (string): The date on which the subscription was purchased. - - - - - - - -## setSalesRegion - -You can record the region in which the user purchased a subscription. - - - -import SetSalesRegionSig from "@react-native-signatures/AdjustAppStoreSubscription/setSalesRegion.mdx" - - - - - - - -import SetSalesRegion from "@react-native-examples/AdjustAppStoreSubscription/setSalesRegion.mdx" - - - - - - - -`salesRegion` (string): The region in which the subscription was purchased. - - - - - - - -## addCallbackParameter - -Adds key-value callback parameters to the subscription object. You can add multiple parameters by calling this method multiple times. - - - -import AddCallbackParameterSig from "@react-native-signatures/AdjustAppStoreSubscription/addCallbackParameter.mdx" - - - - - - - -import AddCallbackParameter from "@react-native-examples/AdjustAppStoreSubscription/addCallbackParameter.mdx" - - - - - - - -`key` (string): The data key. - -`value` (string): The data value. - - - - - - - -## addPartnerParameter - -Adds key-value callback parameters to the subscription object. You can add multiple parameters by calling this method multiple times. - - - -import AddPartnerParameterSig from "@react-native-signatures/AdjustAppStoreSubscription/addPartnerParameter.mdx" - - - - - - - -import AddPartnerParameter from "@react-native-examples/AdjustAppStoreSubscription/addPartnerParameter.mdx" - - - - - - - -`key` (string): The data key. - -`value` (string): The data value. - - - - diff --git a/src/content/docs/sdk/react-native/reference/adjustattribution.mdx b/src/content/docs/sdk/react-native/reference/adjustattribution.mdx deleted file mode 100644 index 58f341a57..000000000 --- a/src/content/docs/sdk/react-native/reference/adjustattribution.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AdjustAttribution class -description: Use this class to see attribution information. -category-title: AdjustAttribution class -slug: en/sdk/react-native/reference/adjustattribution ---- - -import AttributionSig from "@react-native-signatures/Adjust/getAttribution.mdx"; -import SetNeedsCostSig from "@react-native-signatures/AdjustConfig/setNeedsCost.mdx"; - -The `AdjustAttribution` class contains details about the current attribution status of the device. - -## Properties - -The following properties can be accessed by calling the `getAttribution` 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. | -| `fbInstallReferrer` | String | The [Facebook install referrer](https://developers.facebook.com/docs/app-ads/install-referrer/). _Android only_. | - -
diff --git a/src/content/docs/sdk/react-native/reference/adjustconfig/index.mdx b/src/content/docs/sdk/react-native/reference/adjustconfig/index.mdx deleted file mode 100644 index a22e1d689..000000000 --- a/src/content/docs/sdk/react-native/reference/adjustconfig/index.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: AdjustConfig class -description: Use the methods in this class to set up the Adjust SDK. -category-title: AdjustConfig class -slug: en/sdk/react-native/reference/adjustconfig -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. - - - - - -## Constructor - -Instantiates the configuration object with your Adjust app token. - - - -import Constructor from "@react-native-signatures/AdjustConfig/constructor.mdx" - - - - - - - -import ConfigWithAppToken from "@react-native-examples/AdjustConfig/constructor.mdx" - - - - - - - -`appToken` (string): Your Adjust app token. - -`environment` (Environment): The environment your app is running in. - - - - - -`config` (AdjustConfig): A config object initialized with the provided params. - - - - diff --git a/src/content/docs/sdk/react-native/reference/adjustconfig/privacy.mdx b/src/content/docs/sdk/react-native/reference/adjustconfig/privacy.mdx deleted file mode 100644 index b5e90c0ca..000000000 --- a/src/content/docs/sdk/react-native/reference/adjustconfig/privacy.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: Privacy methods -description: Configure these properties to set up privacy features in the Adjust SDK. -slug: en/sdk/react-native/reference/adjustconfig/privacy -sidebar-position: 2 ---- - - - -## setUrlStrategy - -Sets the country or region of data residency. If called with a `UrlStrategy` parameter, sets the country/region where data will be sent preferentially. - - - -import SetUrlStrategySig from "@react-native-signatures/AdjustConfig/setUrlStrategy.mdx"; - - - - - - - -import SetUrlStrategy from "@react-native-examples/AdjustConfig/setUrlStrategy.mdx"; - - - - - - - -`urlStrategy` (UrlStrategy): The data residency target (see available values below) - - - -| Value | Description | -| ------------------------------- | --------------------------------------------------------- | -| `AdjustConfig.DataResidencyEU` | Sets the area of data residency to the EU | -| `AdjustConfig.DataResidencyTR` | Sets the area of data residency to Turkey | -| `AdjustConfig.DataResidencyUS` | Sets the area of data residency to the USA | -| `AdjustConfig.UrlStrategyChina` | Points the URL strategy to the `app.adjust.world` domain | -| `AdjustConfig.UrlStrategyCn` | Points the URL strategy to the `app.adjust.cn` domain | -| `AdjustConfig.UrlStrategyIndia` | Points the URL strategy to the `app.adjust.net.in` domain | - -
- - - - - - - -## setCoppaCompliantEnabled - -Enable COPPA (Children's Online Privacy Protection Act) compliance in your app. - - - -import SetCoppaCompliantEnabledSig from "@react-native-signatures/AdjustConfig/setCoppaCompliantEnabled.mdx"; - - - - - - - -import SetCoppaCompliantEnabled from "@react-native-examples/AdjustConfig/setCoppaCompliantEnabled.mdx"; - - - - - - - -`coppaCompliantEnabled` (boolean): Whether the app should be COPPA compliant. - - - - diff --git a/src/content/docs/sdk/react-native/reference/adjustconfig/setup.mdx b/src/content/docs/sdk/react-native/reference/adjustconfig/setup.mdx deleted file mode 100644 index 111d1cbd3..000000000 --- a/src/content/docs/sdk/react-native/reference/adjustconfig/setup.mdx +++ /dev/null @@ -1,574 +0,0 @@ ---- -title: Setup methods -description: Configure these properties to set up the Adjust SDK. -slug: en/sdk/react-native/reference/adjustconfig/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 "@react-native-signatures/AdjustConfig/setLogLevel.mdx"; - - - - - - - -import SetLogLevel from "@react-native-examples/AdjustConfig/setLogLevel.mdx"; - - - - - - - -`logLevel` (LogLevel): The level of logging output by the SDK. - - - -| Log level | Description | -| ------------------------------- | ------------------------------------------ | -| `AdjustConfig.LogLevelVerbose` | Enable all logging | -| `AdjustConfig.LogLevelDebug` | Enable debug logging | -| `AdjustConfig.LogLevelInfo` | Only show info level logs (default option) | -| `AdjustConfig.LogLevelWarn` | Disable info logging | -| `AdjustConfig.LogLevelError` | Disable warning level logging and below | -| `AdjustConfig.LogLevelAssert` | Disable error level logging and below | -| `AdjustConfig.LogLevelSuppress` | Suppress all logging | - -
- - - - - - - -## setDefaultTracker - -Sets a default token to record installs against. - - - -import SetDefaultTrackerSig from "@react-native-signatures/AdjustConfig/setDefaultTracker.mdx"; - - - - - - - -import SetDefaultTracker from "@react-native-examples/AdjustConfig/setDefaultTracker.mdx"; - - - - - - - -`defaultTracker` (string): The token to which all preinstalled sessions are attributed. - - - - - - - -## setSendInBackground - -Sets whether the SDK should send data while the app is running in the background. - - - -import SetSendInBackgroundSig from "@react-native-signatures/AdjustConfig/sendInBackground.mdx"; - - - - - - - -import SetSendInBackground from "@react-native-examples/AdjustConfig/sendInBackground.mdx"; - - - - - - - -`sendInBackground` (boolean): Whether the SDK should send information to Adjust when the app is running in the background. - - - - - - - -## setSessionTrackingSucceededCallbackListener - -Sets up a success callback to trigger a function when the SDK records a session. - - - -import SetSessionTrackingSucceededCallbackListenerSig from "@react-native-signatures/AdjustConfig/setSessionTrackingSucceededCallbackListener.mdx"; - - - - - - - -import SetSessionTrackingSucceededCallbackListener from "@react-native-examples/AdjustConfig/setSessionTrackingSucceededCallbackListener.mdx"; - - - - - - - -`callback` (function): The function to launch when the SDK successfully records a session. - - - - - - - -## setSessionTrackingFailedCallbackListener - -Sets up a callback to trigger a function when the SDK fails to record a session. - - - -import SetSessionTrackingFailedCallbackListenerSig from "@react-native-signatures/AdjustConfig/setSessionTrackingFailedCallbackListener.mdx"; - - - - - - - -import SetSessionTrackingFailedCallbackListener from "@react-native-examples/AdjustConfig/setSessionTrackingFailedCallbackListener.mdx"; - - - - - - - -`callback` (function): The function to launch when the SDK fails to record a session. - - - - - - - -## setEventTrackingSucceededCallbackListener - -Sets up a success callback to trigger a function when the SDK records an event. - - - -import SetEventTrackingSucceededCallbackListenerSig from "@react-native-signatures/AdjustConfig/setEventTrackingSucceededCallbackListener.mdx"; - - - - - - - -import SetEventTrackingSucceededCallbackListener from "@react-native-examples/AdjustConfig/setEventTrackingSucceededCallbackListener.mdx"; - - - - - - - -`callback` (function): The function to launch when the SDK successfully records an event. - - - - - - - -## setEventTrackingFailedCallbackListener - -Sets up a callback to trigger a function when the SDK fails to record a session. - - - -import SetEventTrackingFailedCallbackListenerSig from "@react-native-signatures/AdjustConfig/setEventTrackingFailedCallbackListener.mdx"; - - - - - - - -import SetEventTrackingFailedCallbackListener from "@react-native-examples/AdjustConfig/setEventTrackingFailedCallbackListener.mdx"; - - - - - - - -`callback` (function): The function to launch when the SDK fails to record an event. - - - - - - - -## 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 "@react-native-signatures/AdjustConfig/setDelayStart.mdx"; - - - - - - - -import SetDelayStart from "@react-native-examples/AdjustConfig/setDelayStart.mdx"; - - - - - - - -`delayStart` (number): The time (in seconds) to delay the start of the SDK by. - - - - - - - -## setExternalDeviceId - -Sets an external device identifier for reporting purposes. - - - -import SetExternalDeviceIdSig from "@react-native-signatures/AdjustConfig/setExternalDeviceId.mdx"; - - - - - - - -import SetExternalDeviceId from "@react-native-examples/AdjustConfig/setExternalDeviceId.mdx"; - - - - - - - -`externalDeviceId` (string): 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 "@react-native-signatures/AdjustConfig/setEventBufferingEnabled.mdx"; - - - - - - - -import SetEventBufferingEnabled from "@react-native-examples/AdjustConfig/setEventBufferingEnabled.mdx"; - - - - - - - -`eventBufferingEnabled` (boolean): Whether event buffering is enabled. - - - - - - - -## setNeedsCost - -Sets whether the SDK should gather cost data. This is accessible in the user's attribution information. - - - -import SetNeedsCostSig from "@react-native-signatures/AdjustConfig/setNeedsCost.mdx"; - - - - - - - -import SetNeedsCost from "@react-native-examples/AdjustConfig/setNeedsCost.mdx"; - - - - - - - -`needsCost` (boolean): Whether the SDK should gather cost data - - - - - - - -## setAttributionCallbackListener - -Sets a delegate function that fires when a user's attribution information updates. - - - -import SetAttributionCallbackListenerSig from "@react-native-signatures/AdjustConfig/setAttributionCallbackListener.mdx"; - - - - - - - -import SetAttributionCallbackListener from "@react-native-examples/AdjustConfig/setAttributionCallbackListener.mdx"; - - - - - - - -`callback` (function): The delegate function that the SDK calls when the user's attribution information changes. - - - - - - - -## setPreinstallTrackingEnabled - -Enables or disables preinstall tracking. - - - -import SetPreinstallTrackingEnabledSig from "@react-native-signatures/AdjustConfig/setPreinstallTrackingEnabled.mdx"; - - - - - - - -import SetPreinstallTrackingEnabled from "@react-native-examples/AdjustConfig/setPreinstallTrackingEnabled.mdx"; - - - - - - - -`preinstallTrackingEnabled` (boolean): Whether preinstall tracking is enabled. - - - - - - - -## setPreinstallFilePath - -Defines a relative path where preinstall information is available. - - - -This directory must be world-readable - - - - - -import SetPreinstallFilePathSig from "@react-native-signatures/AdjustConfig/setPreinstallFilePath.mdx"; - - - - - - - -import SetPreinstallFilePath from "@react-native-examples/AdjustConfig/setPreinstallFilePath.mdx"; - - - - - - - -`preinstallFilePath` (string): The path where the preinstall information is written. - - - - - - - -## deactivateSKAdNetworkHandling - -Turns off communication with SKAdNetwork. - - - -SKAdNetwork communication is enabled by default. - - - - - -import DeactivateSKAdNetworkHandlingSig from "@react-native-signatures/AdjustConfig/deactivateSKAdNetworkHandling.mdx"; - - - - - - - -import DeactivateSKAdNetworkHandling from "@react-native-examples/AdjustConfig/deactivateSKAdNetworkHandling.mdx"; - - - - - - - - - -## setDeferredDeeplinkCallbackListener - -Sets a callback listener that triggers when a deep link is opened. - - - -import SetDeferredDeeplinkCallbackListenerSig from "@react-native-signatures/AdjustConfig/setDeferredDeeplinkCallbackListener.mdx"; - - - - - - - -import SetDeferredDeeplinkCallbackListener from "@react-native-examples/AdjustConfig/setDeferredDeeplinkCallbackListener.mdx"; - - - - - - - -`callback` (function): The function to launch when deep link content is received. - - - - - - - -## setLinkMeEnabled - -Toggle support for Adjust's [LinkMe solution](https://help.adjust.com/en/article/linkme) for deep linking. - - - -import SetLinkMeEnabledSig from "@react-native-signatures/AdjustConfig/setLinkMeEnabled.mdx"; - - - - - - - -import SetLinkMeEnabled from "@react-native-examples/AdjustConfig/setLinkMeEnabled.mdx"; - - - - - - - -`linkMeEnabled` (boolean): Whether to enable LinkMe. - - - - - - - -## setConversionValueUpdatedCallbackListener - -Sets a delegate function to call when the user's conversion value updates. - - - -import SetConversionValueUpdatedCallbackListenerSig from "@react-native-signatures/AdjustConfig/setConversionValueUpdatedCallbackListener.mdx"; - - - - - - - -import SetConversionValueUpdatedCallbackListener from "@react-native-examples/AdjustConfig/setConversionValueUpdatedCallbackListener.mdx"; - - - - - - - -`callback` (function): The delegate function the SDK launches when the conversion value updates - - - - diff --git a/src/content/docs/sdk/react-native/reference/adjustevent.mdx b/src/content/docs/sdk/react-native/reference/adjustevent.mdx deleted file mode 100644 index f01e3b8a0..000000000 --- a/src/content/docs/sdk/react-native/reference/adjustevent.mdx +++ /dev/null @@ -1,196 +0,0 @@ ---- -title: AdjustEvent class -description: Record information about events to send to Adjust. -category-title: AdjustEvent class -slug: en/sdk/react-native/reference/adjustevent ---- - -import TrackEvent from "@react-native-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 `AdjustEvent` object to the `trackEvent` method. - - - -## Constructor - -Instantiates an event object with an Adjust event token. - - - -import ConstructorSig from "@react-native-signatures/AdjustEvent/constructor.mdx" - - - - - - - -import Constructor from "@react-native-examples/AdjustEvent/constructor.mdx" - - - - - - - -`eventToken` (string): A 6 character Adjust event token. - - - - - - - -## setRevenue - -Sets the revenue and currency associated with an event. - - - -import SetRevenueSig from "@react-native-signatures/AdjustEvent/setRevenue.mdx" - - - - - - - -import SetRevenue from "@react-native-examples/AdjustEvent/setRevenue.mdx" - - - - - - - -`amount` (number): The amount of currency units associated with the event. - -`currency` (string): 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 "@react-native-signatures/AdjustEvent/setTransactionId.mdx" - - - - - - - -import SetTransactionId from "@react-native-examples/AdjustEvent/setTransactionId.mdx" - - - - - - - -`transactionId` (string): 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 "@react-native-signatures/AdjustEvent/setCallbackId.mdx" - - - - - - - -import SetCallbackId from "@react-native-examples/AdjustEvent/setCallbackId.mdx" - - - - - - - -`callbackId` (string): A custom identifier for your event object. - - - - - - - -## addCallbackParameter - -Adds key-value information to send to your callback URL. - - - -import AddCallbackParameterSig from "@react-native-signatures/AdjustEvent/addCallbackParameter.mdx" - - - - - - - -import AddCallbackParameter from "@react-native-examples/AdjustEvent/addCallbackParameter.mdx" - - - - - - - -`key` (string): The data key. - -`value` (string): The data value. - - - - - - - -## addPartnerParameter - -Adds key-value information to share with partners. - - - -import AddPartnerParameterSig from "@react-native-signatures/AdjustEvent/addPartnerParameter.mdx" - - - - - - - -import AddPartnerParameter from "@react-native-examples/AdjustEvent/addPartnerParameter.mdx" - - - - - - - -`key` (string): The data key. - -`value` (string): The data value. - - - - diff --git a/src/content/docs/sdk/react-native/reference/adjustplaystoresubscription.mdx b/src/content/docs/sdk/react-native/reference/adjustplaystoresubscription.mdx deleted file mode 100644 index 27a6c84f0..000000000 --- a/src/content/docs/sdk/react-native/reference/adjustplaystoresubscription.mdx +++ /dev/null @@ -1,145 +0,0 @@ ---- -title: AdjustPlayStoreSubscription class -description: Use this class to store Play Store subscription information. -category-title: AdjustPlayStoreSubscription class -slug: en/sdk/react-native/reference/adjustplaystoresubscription ---- - -import TrackPlayStoreSubscription from "@react-native-signatures/Adjust/trackPlayStoreSubscription.mdx" - -Use this class to store Play Store subscription information. You can pass this to Adjust's servers using the `trackPlayStoreSubscription` method. - - - -## Constructor - -Instantiates a subscription object. - - - -import ConstructorSig from "@react-native-signatures/AdjustPlayStoreSubscription/constructor.mdx" - - - - - - - -import Constructor from "@react-native-examples/AdjustPlayStoreSubscription/adjustPlayStoreSubscription.mdx" - - - - - - - -`price` (string): 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 - -`sku` (string): The ID of the product. - -`orderId` (string): Your ID for the transaction. - -`signature` (string): The signature of the purchase data. - -`purchaseToken` (string): The unique token of the transaction. See [Google's documentation](https://developer.android.com/reference/com/android/billingclient/api/Purchase#getPurchaseToken()) for more information. - - - - - - - -## setPurchaseTime - -Sets the date of the transaction in the subscription object. - - - -import SetPurchaseTimeSig from "@react-native-signatures/AdjustPlayStoreSubscription/setPurchaseTime.mdx" - - - - - - - -import SetPurchaseTime from "@react-native-examples/AdjustPlayStoreSubscription/setPurchaseTime.mdx" - - - - - - - -`purchaseTime` (string): The date on which the subscription was purchased. - - - - - - - -## addCallbackParameter - -Adds key-value callback parameters to the subscription object. You can add multiple parameters by calling this method multiple times. - - - -import AddCallbackParameterSig from "@react-native-signatures/AdjustPlayStoreSubscription/addCallbackParameter.mdx" - - - - - - - - -import AddCallbackParameter from "@react-native-examples/AdjustPlayStoreSubscription/addCallbackParameter.mdx" - - - - - - - -`key` (string): The data key. - -`value` (string): The data value. - - - - - - - -## addPartnerParameter - -Adds key-value callback parameters to the subscription object. You can add multiple parameters by calling this method multiple times. - - - -import AddPartnerParameterSig from "@react-native-signatures/AdjustPlayStoreSubscription/addPartnerParameter.mdx" - - - - - - - -import AddPartnerParameter from "@react-native-examples/AdjustPlayStoreSubscription/addPartnerParameter.mdx" - - - - - - - -`key` (string): The data key. - -`value` (string): The data value. - - - - diff --git a/src/content/docs/sdk/react-native/reference/adjustthirdpartysharing.mdx b/src/content/docs/sdk/react-native/reference/adjustthirdpartysharing.mdx deleted file mode 100644 index e20d973b2..000000000 --- a/src/content/docs/sdk/react-native/reference/adjustthirdpartysharing.mdx +++ /dev/null @@ -1,139 +0,0 @@ ---- -title: AdjustThirdPartySharing class -description: Use this class to communicate a user's third party sharing preferences. -category-title: AdjustThirdPartySharing class -slug: en/sdk/react-native/reference/adjustthirdpartysharing ---- - -import TrackThirdPartySharing from "@react-native-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 Constructor from "@react-native-signatures/AdjustThirdPartySharing/constructor.mdx"; - - - - - - - -import InitTrue from "@react-native-examples/AdjustThirdPartySharing/initTrue.mdx"; - - - - - - - -`isEnabled` (boolean): Whether third party sharing is enabled. - - - - - - - -## 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 "@react-native-signatures/AdjustThirdPartySharing/addGranularOption.mdx" - - - - - - - -import AddGranularOption from "@react-native-examples/AdjustThirdPartySharing/addGranularOption.mdx"; - - - -You can use this method to toggle Facebook data processing options. - -import Facebook from "@react-native-examples/AdjustThirdPartySharing/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` (string): The name of the partner you want to share information with. - -`key` (string): The data key. - -`value` (string): 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 "@react-native-signatures/AdjustThirdPartySharing/addPartnerSharingSetting.mdx"; - - - - - - - -import AddPartnerSharingSetting from "@react-native-examples/AdjustThirdPartySharing/addPartnerSharingSetting.mdx"; - - - - - - - -`partnerName` (string): The name of the partner whose settings you want to update. See the table of available partners below. -`key` (string): The setting you want to update. -`value` (boolean): 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/react-native/reference/index.mdx b/src/content/docs/sdk/react-native/reference/index.mdx deleted file mode 100644 index 51a995357..000000000 --- a/src/content/docs/sdk/react-native/reference/index.mdx +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: SDK reference -description: SDK reference information for the React Native SDK -category-title: Reference -slug: en/sdk/react-native/reference -type: category ---- From 045e04583d09ec34c6103c1ec176e61fc27412b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Sat, 24 Feb 2024 17:27:05 +0100 Subject: [PATCH 5/8] Update Windows documentation --- .../Adjust/AddSessionCallbackParameter.mdx | 3 - .../Adjust/AddSessionPartnerParameter.mdx | 3 - .../windows/examples/Adjust/GdprForgetMe.mdx | 3 - .../windows/examples/Adjust/GetAdid.mdx | 3 - .../examples/Adjust/GetAttribution.mdx | 3 - .../examples/Adjust/GetWindowsAdId.mdx | 3 - .../windows/examples/Adjust/IsEnabled.mdx | 3 - .../Adjust/RemoveSessionCallbackParameter.mdx | 3 - .../Adjust/RemoveSessionPartnerParameter.mdx | 3 - .../Adjust/ResetSessionCallbackParameters.mdx | 3 - .../Adjust/ResetSessionPartnerParameters.mdx | 3 - .../examples/Adjust/SendFirstPackages.mdx | 3 - .../windows/examples/Adjust/SetEnabled.mdx | 3 - .../examples/Adjust/SetOfflineMode.mdx | 3 - .../windows/examples/Adjust/SetPushToken.mdx | 3 - .../windows/examples/Adjust/TrackEvent.mdx | 3 - .../AdjustConfig/AttributionChanged.mdx | 19 - .../AdjustConfig/DeeplinkResponse.mdx | 19 - .../examples/AdjustConfig/DefaultTracker.mdx | 6 - .../examples/AdjustConfig/DelayStart.mdx | 3 - .../AdjustConfig/EventBufferingEnabled.mdx | 8 - .../AdjustConfig/EventTrackingFailed.mdx | 9 - .../AdjustConfig/EventTrackingSucceeded.mdx | 9 - .../AdjustConfig/SendInBackground.mdx | 8 - .../AdjustConfig/SessionTrackingFailed.mdx | 9 - .../AdjustConfig/SessionTrackingSucceeded.mdx | 9 - .../examples/AdjustConfig/constructor.mdx | 6 - .../AdjustConfig/setExternalDeviceId.mdx | 7 - .../examples/AdjustConfig/setLogDelegate.mdx | 7 - .../AdjustEvent/AddCallbackParameter.mdx | 8 - .../AdjustEvent/AddPartnerParameter.mdx | 8 - .../examples/AdjustEvent/CallbackId.mdx | 7 - .../examples/AdjustEvent/PurchaseId.mdx | 8 - .../examples/AdjustEvent/SetRevenue.mdx | 5 - .../Adjust/AddSessionCallbackParameter.mdx | 3 - .../Adjust/AddSessionPartnerParameter.mdx | 3 - .../signatures/Adjust/GdprForgetMe.mdx | 3 - .../windows/signatures/Adjust/GetAdid.mdx | 3 - .../signatures/Adjust/GetAttribution.mdx | 3 - .../signatures/Adjust/GetWindowsAdId.mdx | 3 - .../windows/signatures/Adjust/IsEnabled.mdx | 3 - .../Adjust/RemoveSessionCallbackParameter.mdx | 3 - .../Adjust/RemoveSessionPartnerParameter.mdx | 3 - .../Adjust/ResetSessionCallbackParameters.mdx | 3 - .../Adjust/ResetSessionPartnerParameters.mdx | 3 - .../signatures/Adjust/SendFirstPackages.mdx | 3 - .../windows/signatures/Adjust/SetEnabled.mdx | 3 - .../signatures/Adjust/SetOfflineMode.mdx | 3 - .../signatures/Adjust/SetPushToken.mdx | 3 - .../windows/signatures/Adjust/TrackEvent.mdx | 4 - .../AdjustConfig/AttributionChanged.mdx | 3 - .../AdjustConfig/DeeplinkResponse.mdx | 3 - .../AdjustConfig/DefaultTracker.mdx | 3 - .../signatures/AdjustConfig/DelayStart.mdx | 3 - .../AdjustConfig/EventBufferingEnabled.mdx | 3 - .../AdjustConfig/EventTrackingFailed.mdx | 3 - .../AdjustConfig/EventTrackingSucceeded.mdx | 3 - .../AdjustConfig/SendInBackground.mdx | 3 - .../AdjustConfig/SessionTrackingFailed.mdx | 3 - .../AdjustConfig/SessionTrackingSucceeded.mdx | 3 - .../signatures/AdjustConfig/constructor.mdx | 3 - .../AdjustConfig/setExternalDeviceId.mdx | 3 - .../AdjustConfig/setLogDelegate.mdx | 3 - .../AdjustEvent/AddCallbackParameter.mdx | 3 - .../AdjustEvent/AddPartnerParameter.mdx | 3 - .../signatures/AdjustEvent/CallbackId.mdx | 3 - .../signatures/AdjustEvent/Constructor.mdx | 3 - .../signatures/AdjustEvent/PurchaseId.mdx | 3 - .../signatures/AdjustEvent/SetRevenue.mdx | 3 - .../docs/sdk/flutter/features/deep-links.mdx | 2 - .../flutter/features/session-parameters.mdx | 2 +- .../docs/sdk/windows/configuration.mdx | 247 ++++++++++++ .../sdk/windows/configuration/background.mdx | 21 - .../docs/sdk/windows/configuration/delay.mdx | 33 -- .../sdk/windows/configuration/disable.mdx | 31 -- .../docs/sdk/windows/configuration/index.mdx | 9 - .../sdk/windows/configuration/log-level.mdx | 28 -- .../windows/configuration/preinstalled.mdx | 28 -- .../sdk/windows/configuration/privacy.mdx | 18 - .../sdk/windows/configuration/push-tokens.mdx | 20 - .../docs/sdk/windows/features/attribution.mdx | 74 +++- .../docs/sdk/windows/features/callbacks.mdx | 72 +++- .../deep-links.mdx | 43 +- .../docs/sdk/windows/features/device-info.mdx | 22 +- .../docs/sdk/windows/features/events.mdx | 139 +++++-- .../docs/sdk/windows/features/index.mdx | 1 + .../sdk/windows/features/preinstalled.mdx | 32 ++ .../docs/sdk/windows/features/privacy.mdx | 21 + .../windows/features/session-parameters.mdx | 97 +++-- src/content/docs/sdk/windows/index.mdx | 9 +- .../sdk/windows/reference/adjust/config.mdx | 158 -------- .../windows/reference/adjust/device-info.mdx | 68 ---- .../sdk/windows/reference/adjust/index.mdx | 9 - .../sdk/windows/reference/adjust/privacy.mdx | 32 -- .../windows/reference/adjust/recording.mdx | 240 ----------- .../windows/reference/adjustattribution.mdx | 29 -- .../windows/reference/adjustconfig/index.mdx | 55 --- .../windows/reference/adjustconfig/setup.mdx | 376 ------------------ .../sdk/windows/reference/adjustevent.mdx | 198 --------- .../docs/sdk/windows/reference/index.mdx | 7 - 100 files changed, 642 insertions(+), 1788 deletions(-) delete mode 100644 src/code-snippets/windows/examples/Adjust/AddSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/windows/examples/Adjust/AddSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/windows/examples/Adjust/GdprForgetMe.mdx delete mode 100644 src/code-snippets/windows/examples/Adjust/GetAdid.mdx delete mode 100644 src/code-snippets/windows/examples/Adjust/GetAttribution.mdx delete mode 100644 src/code-snippets/windows/examples/Adjust/GetWindowsAdId.mdx delete mode 100644 src/code-snippets/windows/examples/Adjust/IsEnabled.mdx delete mode 100644 src/code-snippets/windows/examples/Adjust/RemoveSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/windows/examples/Adjust/RemoveSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/windows/examples/Adjust/ResetSessionCallbackParameters.mdx delete mode 100644 src/code-snippets/windows/examples/Adjust/ResetSessionPartnerParameters.mdx delete mode 100644 src/code-snippets/windows/examples/Adjust/SendFirstPackages.mdx delete mode 100644 src/code-snippets/windows/examples/Adjust/SetEnabled.mdx delete mode 100644 src/code-snippets/windows/examples/Adjust/SetOfflineMode.mdx delete mode 100644 src/code-snippets/windows/examples/Adjust/SetPushToken.mdx delete mode 100644 src/code-snippets/windows/examples/Adjust/TrackEvent.mdx delete mode 100644 src/code-snippets/windows/examples/AdjustConfig/AttributionChanged.mdx delete mode 100644 src/code-snippets/windows/examples/AdjustConfig/DeeplinkResponse.mdx delete mode 100644 src/code-snippets/windows/examples/AdjustConfig/DefaultTracker.mdx delete mode 100644 src/code-snippets/windows/examples/AdjustConfig/DelayStart.mdx delete mode 100644 src/code-snippets/windows/examples/AdjustConfig/EventBufferingEnabled.mdx delete mode 100644 src/code-snippets/windows/examples/AdjustConfig/EventTrackingFailed.mdx delete mode 100644 src/code-snippets/windows/examples/AdjustConfig/EventTrackingSucceeded.mdx delete mode 100644 src/code-snippets/windows/examples/AdjustConfig/SendInBackground.mdx delete mode 100644 src/code-snippets/windows/examples/AdjustConfig/SessionTrackingFailed.mdx delete mode 100644 src/code-snippets/windows/examples/AdjustConfig/SessionTrackingSucceeded.mdx delete mode 100644 src/code-snippets/windows/examples/AdjustConfig/constructor.mdx delete mode 100644 src/code-snippets/windows/examples/AdjustConfig/setExternalDeviceId.mdx delete mode 100644 src/code-snippets/windows/examples/AdjustConfig/setLogDelegate.mdx delete mode 100644 src/code-snippets/windows/examples/AdjustEvent/AddCallbackParameter.mdx delete mode 100644 src/code-snippets/windows/examples/AdjustEvent/AddPartnerParameter.mdx delete mode 100644 src/code-snippets/windows/examples/AdjustEvent/CallbackId.mdx delete mode 100644 src/code-snippets/windows/examples/AdjustEvent/PurchaseId.mdx delete mode 100644 src/code-snippets/windows/examples/AdjustEvent/SetRevenue.mdx delete mode 100644 src/code-snippets/windows/signatures/Adjust/AddSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/windows/signatures/Adjust/AddSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/windows/signatures/Adjust/GdprForgetMe.mdx delete mode 100644 src/code-snippets/windows/signatures/Adjust/GetAdid.mdx delete mode 100644 src/code-snippets/windows/signatures/Adjust/GetAttribution.mdx delete mode 100644 src/code-snippets/windows/signatures/Adjust/GetWindowsAdId.mdx delete mode 100644 src/code-snippets/windows/signatures/Adjust/IsEnabled.mdx delete mode 100644 src/code-snippets/windows/signatures/Adjust/RemoveSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/windows/signatures/Adjust/RemoveSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/windows/signatures/Adjust/ResetSessionCallbackParameters.mdx delete mode 100644 src/code-snippets/windows/signatures/Adjust/ResetSessionPartnerParameters.mdx delete mode 100644 src/code-snippets/windows/signatures/Adjust/SendFirstPackages.mdx delete mode 100644 src/code-snippets/windows/signatures/Adjust/SetEnabled.mdx delete mode 100644 src/code-snippets/windows/signatures/Adjust/SetOfflineMode.mdx delete mode 100644 src/code-snippets/windows/signatures/Adjust/SetPushToken.mdx delete mode 100644 src/code-snippets/windows/signatures/Adjust/TrackEvent.mdx delete mode 100644 src/code-snippets/windows/signatures/AdjustConfig/AttributionChanged.mdx delete mode 100644 src/code-snippets/windows/signatures/AdjustConfig/DeeplinkResponse.mdx delete mode 100644 src/code-snippets/windows/signatures/AdjustConfig/DefaultTracker.mdx delete mode 100644 src/code-snippets/windows/signatures/AdjustConfig/DelayStart.mdx delete mode 100644 src/code-snippets/windows/signatures/AdjustConfig/EventBufferingEnabled.mdx delete mode 100644 src/code-snippets/windows/signatures/AdjustConfig/EventTrackingFailed.mdx delete mode 100644 src/code-snippets/windows/signatures/AdjustConfig/EventTrackingSucceeded.mdx delete mode 100644 src/code-snippets/windows/signatures/AdjustConfig/SendInBackground.mdx delete mode 100644 src/code-snippets/windows/signatures/AdjustConfig/SessionTrackingFailed.mdx delete mode 100644 src/code-snippets/windows/signatures/AdjustConfig/SessionTrackingSucceeded.mdx delete mode 100644 src/code-snippets/windows/signatures/AdjustConfig/constructor.mdx delete mode 100644 src/code-snippets/windows/signatures/AdjustConfig/setExternalDeviceId.mdx delete mode 100644 src/code-snippets/windows/signatures/AdjustConfig/setLogDelegate.mdx delete mode 100644 src/code-snippets/windows/signatures/AdjustEvent/AddCallbackParameter.mdx delete mode 100644 src/code-snippets/windows/signatures/AdjustEvent/AddPartnerParameter.mdx delete mode 100644 src/code-snippets/windows/signatures/AdjustEvent/CallbackId.mdx delete mode 100644 src/code-snippets/windows/signatures/AdjustEvent/Constructor.mdx delete mode 100644 src/code-snippets/windows/signatures/AdjustEvent/PurchaseId.mdx delete mode 100644 src/code-snippets/windows/signatures/AdjustEvent/SetRevenue.mdx create mode 100644 src/content/docs/sdk/windows/configuration.mdx delete mode 100644 src/content/docs/sdk/windows/configuration/background.mdx delete mode 100644 src/content/docs/sdk/windows/configuration/delay.mdx delete mode 100644 src/content/docs/sdk/windows/configuration/disable.mdx delete mode 100644 src/content/docs/sdk/windows/configuration/index.mdx delete mode 100644 src/content/docs/sdk/windows/configuration/log-level.mdx delete mode 100644 src/content/docs/sdk/windows/configuration/preinstalled.mdx delete mode 100644 src/content/docs/sdk/windows/configuration/privacy.mdx delete mode 100644 src/content/docs/sdk/windows/configuration/push-tokens.mdx rename src/content/docs/sdk/windows/{configuration => features}/deep-links.mdx (76%) create mode 100644 src/content/docs/sdk/windows/features/preinstalled.mdx create mode 100644 src/content/docs/sdk/windows/features/privacy.mdx delete mode 100644 src/content/docs/sdk/windows/reference/adjust/config.mdx delete mode 100644 src/content/docs/sdk/windows/reference/adjust/device-info.mdx delete mode 100644 src/content/docs/sdk/windows/reference/adjust/index.mdx delete mode 100644 src/content/docs/sdk/windows/reference/adjust/privacy.mdx delete mode 100644 src/content/docs/sdk/windows/reference/adjust/recording.mdx delete mode 100644 src/content/docs/sdk/windows/reference/adjustattribution.mdx delete mode 100644 src/content/docs/sdk/windows/reference/adjustconfig/index.mdx delete mode 100644 src/content/docs/sdk/windows/reference/adjustconfig/setup.mdx delete mode 100644 src/content/docs/sdk/windows/reference/adjustevent.mdx delete mode 100644 src/content/docs/sdk/windows/reference/index.mdx diff --git a/src/code-snippets/windows/examples/Adjust/AddSessionCallbackParameter.mdx b/src/code-snippets/windows/examples/Adjust/AddSessionCallbackParameter.mdx deleted file mode 100644 index b6b0809a8..000000000 --- a/src/code-snippets/windows/examples/Adjust/AddSessionCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.AddSessionCallbackParameter("key", "value"); -``` diff --git a/src/code-snippets/windows/examples/Adjust/AddSessionPartnerParameter.mdx b/src/code-snippets/windows/examples/Adjust/AddSessionPartnerParameter.mdx deleted file mode 100644 index c83810a96..000000000 --- a/src/code-snippets/windows/examples/Adjust/AddSessionPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.AddSessionPartnerParameter("key", "value"); -``` diff --git a/src/code-snippets/windows/examples/Adjust/GdprForgetMe.mdx b/src/code-snippets/windows/examples/Adjust/GdprForgetMe.mdx deleted file mode 100644 index c86861cc3..000000000 --- a/src/code-snippets/windows/examples/Adjust/GdprForgetMe.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.GdprForgetMe(); -``` diff --git a/src/code-snippets/windows/examples/Adjust/GetAdid.mdx b/src/code-snippets/windows/examples/Adjust/GetAdid.mdx deleted file mode 100644 index c7c73c035..000000000 --- a/src/code-snippets/windows/examples/Adjust/GetAdid.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -string adid = Adjust.GetAdid(); -``` diff --git a/src/code-snippets/windows/examples/Adjust/GetAttribution.mdx b/src/code-snippets/windows/examples/Adjust/GetAttribution.mdx deleted file mode 100644 index 53b7fc765..000000000 --- a/src/code-snippets/windows/examples/Adjust/GetAttribution.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -AdjustAttribution attribution = Adjust.GetAttribution(); -``` diff --git a/src/code-snippets/windows/examples/Adjust/GetWindowsAdId.mdx b/src/code-snippets/windows/examples/Adjust/GetWindowsAdId.mdx deleted file mode 100644 index 4168481ec..000000000 --- a/src/code-snippets/windows/examples/Adjust/GetWindowsAdId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -var windowsAdid = Adjust.GetWindowsAdId(); -``` diff --git a/src/code-snippets/windows/examples/Adjust/IsEnabled.mdx b/src/code-snippets/windows/examples/Adjust/IsEnabled.mdx deleted file mode 100644 index 47d940e96..000000000 --- a/src/code-snippets/windows/examples/Adjust/IsEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.IsEnabled(); -``` diff --git a/src/code-snippets/windows/examples/Adjust/RemoveSessionCallbackParameter.mdx b/src/code-snippets/windows/examples/Adjust/RemoveSessionCallbackParameter.mdx deleted file mode 100644 index 287c11948..000000000 --- a/src/code-snippets/windows/examples/Adjust/RemoveSessionCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.RemoveSessionCallbackParameter("key"); -``` diff --git a/src/code-snippets/windows/examples/Adjust/RemoveSessionPartnerParameter.mdx b/src/code-snippets/windows/examples/Adjust/RemoveSessionPartnerParameter.mdx deleted file mode 100644 index 7993bc4ea..000000000 --- a/src/code-snippets/windows/examples/Adjust/RemoveSessionPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.RemoveSessionPartnerParameter("key"); -``` diff --git a/src/code-snippets/windows/examples/Adjust/ResetSessionCallbackParameters.mdx b/src/code-snippets/windows/examples/Adjust/ResetSessionCallbackParameters.mdx deleted file mode 100644 index 08911fa94..000000000 --- a/src/code-snippets/windows/examples/Adjust/ResetSessionCallbackParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.ResetSessionCallbackParameters(); -``` diff --git a/src/code-snippets/windows/examples/Adjust/ResetSessionPartnerParameters.mdx b/src/code-snippets/windows/examples/Adjust/ResetSessionPartnerParameters.mdx deleted file mode 100644 index 53ec8e071..000000000 --- a/src/code-snippets/windows/examples/Adjust/ResetSessionPartnerParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.ResetSessionPartnerParameters(); -``` diff --git a/src/code-snippets/windows/examples/Adjust/SendFirstPackages.mdx b/src/code-snippets/windows/examples/Adjust/SendFirstPackages.mdx deleted file mode 100644 index e124cd037..000000000 --- a/src/code-snippets/windows/examples/Adjust/SendFirstPackages.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.SendFirstPackages() -``` diff --git a/src/code-snippets/windows/examples/Adjust/SetEnabled.mdx b/src/code-snippets/windows/examples/Adjust/SetEnabled.mdx deleted file mode 100644 index 298f4a93a..000000000 --- a/src/code-snippets/windows/examples/Adjust/SetEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.SetEnabled(false); -``` diff --git a/src/code-snippets/windows/examples/Adjust/SetOfflineMode.mdx b/src/code-snippets/windows/examples/Adjust/SetOfflineMode.mdx deleted file mode 100644 index 31052062e..000000000 --- a/src/code-snippets/windows/examples/Adjust/SetOfflineMode.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.SetOfflineMode(true); -``` diff --git a/src/code-snippets/windows/examples/Adjust/SetPushToken.mdx b/src/code-snippets/windows/examples/Adjust/SetPushToken.mdx deleted file mode 100644 index 4c5f086f1..000000000 --- a/src/code-snippets/windows/examples/Adjust/SetPushToken.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.SetPushToken("{YourDeviceToken}"); -``` diff --git a/src/code-snippets/windows/examples/Adjust/TrackEvent.mdx b/src/code-snippets/windows/examples/Adjust/TrackEvent.mdx deleted file mode 100644 index 6767b00fc..000000000 --- a/src/code-snippets/windows/examples/Adjust/TrackEvent.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void TrackEvent(AdjustEvent adjustEvent) -``` diff --git a/src/code-snippets/windows/examples/AdjustConfig/AttributionChanged.mdx b/src/code-snippets/windows/examples/AdjustConfig/AttributionChanged.mdx deleted file mode 100644 index 638abf4d3..000000000 --- a/src/code-snippets/windows/examples/AdjustConfig/AttributionChanged.mdx +++ /dev/null @@ -1,19 +0,0 @@ -```c# -var config = new AdjustConfig(appToken, environment); - -config.AttributionChanged = (attribution) => - System.Diagnostics.Debug.WriteLine("attribution: " + attribution); - -Adjust.ApplicationLaunching(config); -``` - -```c# -var config = new AdjustConfig(appToken, environment); -config.AttributionChanged = AdjustAttributionChanged; -Adjust.ApplicationLaunching(config); - -private void AdjustAttributionChanged(AdjustAttribution attribution) -{ - //... -} -``` diff --git a/src/code-snippets/windows/examples/AdjustConfig/DeeplinkResponse.mdx b/src/code-snippets/windows/examples/AdjustConfig/DeeplinkResponse.mdx deleted file mode 100644 index 77df3cbe3..000000000 --- a/src/code-snippets/windows/examples/AdjustConfig/DeeplinkResponse.mdx +++ /dev/null @@ -1,19 +0,0 @@ -```c# -var config = new AdjustConfig(appToken, environment, - msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); - -config.DeeplinkResponse = deepLinkUri => -{ - if (ShouldAdjustSdkLaunchTheDeeplink(deepLinkUri)) - { - return true; - } - else - { - return false; - } -}; - -Adjust.ApplicationLaunching(config); -// ... -``` diff --git a/src/code-snippets/windows/examples/AdjustConfig/DefaultTracker.mdx b/src/code-snippets/windows/examples/AdjustConfig/DefaultTracker.mdx deleted file mode 100644 index 4a2126ead..000000000 --- a/src/code-snippets/windows/examples/AdjustConfig/DefaultTracker.mdx +++ /dev/null @@ -1,6 +0,0 @@ -```c# -var config = new AdjustConfig(appToken, environment, - msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); -config.DefaultTracker = "{TrackerToken}"; -Adjust.ApplicationLaunching(config); -``` diff --git a/src/code-snippets/windows/examples/AdjustConfig/DelayStart.mdx b/src/code-snippets/windows/examples/AdjustConfig/DelayStart.mdx deleted file mode 100644 index 6b82fcc64..000000000 --- a/src/code-snippets/windows/examples/AdjustConfig/DelayStart.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -adjustConfig.DelayStart = TimeSpan.FromSeconds(5.5); -``` diff --git a/src/code-snippets/windows/examples/AdjustConfig/EventBufferingEnabled.mdx b/src/code-snippets/windows/examples/AdjustConfig/EventBufferingEnabled.mdx deleted file mode 100644 index 8dc511b65..000000000 --- a/src/code-snippets/windows/examples/AdjustConfig/EventBufferingEnabled.mdx +++ /dev/null @@ -1,8 +0,0 @@ -```c# -var config = new AdjustConfig(appToken, environment, - msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); - -config.EventBufferingEnabled = true; - -Adjust.ApplicationLaunching(config); -``` diff --git a/src/code-snippets/windows/examples/AdjustConfig/EventTrackingFailed.mdx b/src/code-snippets/windows/examples/AdjustConfig/EventTrackingFailed.mdx deleted file mode 100644 index 7dbaa8076..000000000 --- a/src/code-snippets/windows/examples/AdjustConfig/EventTrackingFailed.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```c# -var config = new AdjustConfig(appToken, environment, - msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); -config.EventTrackingFailed = adjustEventFailure => -{ - //... -}; -Adjust.ApplicationLaunching(config); -``` diff --git a/src/code-snippets/windows/examples/AdjustConfig/EventTrackingSucceeded.mdx b/src/code-snippets/windows/examples/AdjustConfig/EventTrackingSucceeded.mdx deleted file mode 100644 index 43f49283b..000000000 --- a/src/code-snippets/windows/examples/AdjustConfig/EventTrackingSucceeded.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```c# -var config = new AdjustConfig(appToken, environment, - msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); -config.EventTrackingSucceeded = adjustEventSuccess => -{ - //... -}; -Adjust.ApplicationLaunching(config); -``` diff --git a/src/code-snippets/windows/examples/AdjustConfig/SendInBackground.mdx b/src/code-snippets/windows/examples/AdjustConfig/SendInBackground.mdx deleted file mode 100644 index 841e2de68..000000000 --- a/src/code-snippets/windows/examples/AdjustConfig/SendInBackground.mdx +++ /dev/null @@ -1,8 +0,0 @@ -```c# -var config = new AdjustConfig(appToken, environment, - msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); - -config.SendInBackground = true; - -Adjust.ApplicationLaunching(config); -``` diff --git a/src/code-snippets/windows/examples/AdjustConfig/SessionTrackingFailed.mdx b/src/code-snippets/windows/examples/AdjustConfig/SessionTrackingFailed.mdx deleted file mode 100644 index 0be1dffd2..000000000 --- a/src/code-snippets/windows/examples/AdjustConfig/SessionTrackingFailed.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```c# -var config = new AdjustConfig(appToken, environment, - msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); -config.SessionTrackingFailed = adjustSessionFailure => -{ - //... -}; -Adjust.ApplicationLaunching(config); -``` diff --git a/src/code-snippets/windows/examples/AdjustConfig/SessionTrackingSucceeded.mdx b/src/code-snippets/windows/examples/AdjustConfig/SessionTrackingSucceeded.mdx deleted file mode 100644 index 2313ef333..000000000 --- a/src/code-snippets/windows/examples/AdjustConfig/SessionTrackingSucceeded.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```c# -var config = new AdjustConfig(appToken, environment, - msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); -config.SessionTrackingSucceeded = adjustSessionSuccess => -{ - //... -}; -Adjust.ApplicationLaunching(config); -``` diff --git a/src/code-snippets/windows/examples/AdjustConfig/constructor.mdx b/src/code-snippets/windows/examples/AdjustConfig/constructor.mdx deleted file mode 100644 index e54d0bcb7..000000000 --- a/src/code-snippets/windows/examples/AdjustConfig/constructor.mdx +++ /dev/null @@ -1,6 +0,0 @@ -```c# -string appToken = "hmqwpvspxnuo"; -string environment = AdjustConfig.EnvironmentSandbox; -var config = new AdjustConfig(appToken, environment, - msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); -``` diff --git a/src/code-snippets/windows/examples/AdjustConfig/setExternalDeviceId.mdx b/src/code-snippets/windows/examples/AdjustConfig/setExternalDeviceId.mdx deleted file mode 100644 index a80c99128..000000000 --- a/src/code-snippets/windows/examples/AdjustConfig/setExternalDeviceId.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); -//... -adjustConfig.setExternalDeviceId("{Your-External-Device-Id}"); -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/windows/examples/AdjustConfig/setLogDelegate.mdx b/src/code-snippets/windows/examples/AdjustConfig/setLogDelegate.mdx deleted file mode 100644 index e8dfb2c2f..000000000 --- a/src/code-snippets/windows/examples/AdjustConfig/setLogDelegate.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); -//... -adjustConfig.setLogDelegate(msg => Debug.Log(msg)); -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/windows/examples/AdjustEvent/AddCallbackParameter.mdx b/src/code-snippets/windows/examples/AdjustEvent/AddCallbackParameter.mdx deleted file mode 100644 index 8a3f00579..000000000 --- a/src/code-snippets/windows/examples/AdjustEvent/AddCallbackParameter.mdx +++ /dev/null @@ -1,8 +0,0 @@ -```c# -var adjustEvent = new AdjustEvent("abc123"); - -adjustEvent.AddCallbackParameter("key", "value"); -adjustEvent.AddCallbackParameter("foo", "bar"); - -Adjust.TrackEvent(adjustEvent); -``` diff --git a/src/code-snippets/windows/examples/AdjustEvent/AddPartnerParameter.mdx b/src/code-snippets/windows/examples/AdjustEvent/AddPartnerParameter.mdx deleted file mode 100644 index ea63f6ed8..000000000 --- a/src/code-snippets/windows/examples/AdjustEvent/AddPartnerParameter.mdx +++ /dev/null @@ -1,8 +0,0 @@ -```c# -var adjustEvent = new AdjustEvent("abc123"); - -adjustEvent.AddPartnerParameter("key", "value"); -adjustEvent.AddPartnerParameter("foo", "bar"); - -Adjust.TrackEvent(adjustEvent); -``` diff --git a/src/code-snippets/windows/examples/AdjustEvent/CallbackId.mdx b/src/code-snippets/windows/examples/AdjustEvent/CallbackId.mdx deleted file mode 100644 index 4abba7bb8..000000000 --- a/src/code-snippets/windows/examples/AdjustEvent/CallbackId.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -var adjustEvent = new AdjustEvent("abc123"); - -adjustEvent.CallbackId = "Your-Custom-Id"; - -Adjust.TrackEvent(adjustEvent); -``` diff --git a/src/code-snippets/windows/examples/AdjustEvent/PurchaseId.mdx b/src/code-snippets/windows/examples/AdjustEvent/PurchaseId.mdx deleted file mode 100644 index c8e86d06e..000000000 --- a/src/code-snippets/windows/examples/AdjustEvent/PurchaseId.mdx +++ /dev/null @@ -1,8 +0,0 @@ -```c# -AdjustEvent event = new AdjustEvent("abc123"); - -event.SetRevenue(0.01, "EUR"); -event.PurchaseId = "{PurchaseId}"; - -Adjust.trackEvent(event); -``` diff --git a/src/code-snippets/windows/examples/AdjustEvent/SetRevenue.mdx b/src/code-snippets/windows/examples/AdjustEvent/SetRevenue.mdx deleted file mode 100644 index 070ab6d4e..000000000 --- a/src/code-snippets/windows/examples/AdjustEvent/SetRevenue.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```c# -var adjustEvent = new AdjustEvent("abc123"); -adjustEvent.SetRevenue(0.01, "EUR"); -Adjust.TrackEvent(adjustEvent); -``` diff --git a/src/code-snippets/windows/signatures/Adjust/AddSessionCallbackParameter.mdx b/src/code-snippets/windows/signatures/Adjust/AddSessionCallbackParameter.mdx deleted file mode 100644 index 08118900f..000000000 --- a/src/code-snippets/windows/signatures/Adjust/AddSessionCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void AddSessionCallbackParameter(string key, string value) -``` diff --git a/src/code-snippets/windows/signatures/Adjust/AddSessionPartnerParameter.mdx b/src/code-snippets/windows/signatures/Adjust/AddSessionPartnerParameter.mdx deleted file mode 100644 index 3745bfb6d..000000000 --- a/src/code-snippets/windows/signatures/Adjust/AddSessionPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void AddSessionPartnerParameter(string key, string value) -``` diff --git a/src/code-snippets/windows/signatures/Adjust/GdprForgetMe.mdx b/src/code-snippets/windows/signatures/Adjust/GdprForgetMe.mdx deleted file mode 100644 index 006ef3942..000000000 --- a/src/code-snippets/windows/signatures/Adjust/GdprForgetMe.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void GdprForgetMe() -``` diff --git a/src/code-snippets/windows/signatures/Adjust/GetAdid.mdx b/src/code-snippets/windows/signatures/Adjust/GetAdid.mdx deleted file mode 100644 index 485c22000..000000000 --- a/src/code-snippets/windows/signatures/Adjust/GetAdid.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static string GetAdid() -``` diff --git a/src/code-snippets/windows/signatures/Adjust/GetAttribution.mdx b/src/code-snippets/windows/signatures/Adjust/GetAttribution.mdx deleted file mode 100644 index 889e77c9c..000000000 --- a/src/code-snippets/windows/signatures/Adjust/GetAttribution.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static AdjustAttribution GetAttribution() -``` diff --git a/src/code-snippets/windows/signatures/Adjust/GetWindowsAdId.mdx b/src/code-snippets/windows/signatures/Adjust/GetWindowsAdId.mdx deleted file mode 100644 index 0fc82eed1..000000000 --- a/src/code-snippets/windows/signatures/Adjust/GetWindowsAdId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static string GetWindowsAdId() -``` diff --git a/src/code-snippets/windows/signatures/Adjust/IsEnabled.mdx b/src/code-snippets/windows/signatures/Adjust/IsEnabled.mdx deleted file mode 100644 index 85cc9f40b..000000000 --- a/src/code-snippets/windows/signatures/Adjust/IsEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static bool IsEnabled() -``` diff --git a/src/code-snippets/windows/signatures/Adjust/RemoveSessionCallbackParameter.mdx b/src/code-snippets/windows/signatures/Adjust/RemoveSessionCallbackParameter.mdx deleted file mode 100644 index d50930fc0..000000000 --- a/src/code-snippets/windows/signatures/Adjust/RemoveSessionCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void RemoveSessionCallbackParameter(string key) -``` diff --git a/src/code-snippets/windows/signatures/Adjust/RemoveSessionPartnerParameter.mdx b/src/code-snippets/windows/signatures/Adjust/RemoveSessionPartnerParameter.mdx deleted file mode 100644 index 27c5b944f..000000000 --- a/src/code-snippets/windows/signatures/Adjust/RemoveSessionPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void RemoveSessionPartnerParameter(string key) -``` diff --git a/src/code-snippets/windows/signatures/Adjust/ResetSessionCallbackParameters.mdx b/src/code-snippets/windows/signatures/Adjust/ResetSessionCallbackParameters.mdx deleted file mode 100644 index aaf975290..000000000 --- a/src/code-snippets/windows/signatures/Adjust/ResetSessionCallbackParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void ResetSessionCallbackParameters() -``` diff --git a/src/code-snippets/windows/signatures/Adjust/ResetSessionPartnerParameters.mdx b/src/code-snippets/windows/signatures/Adjust/ResetSessionPartnerParameters.mdx deleted file mode 100644 index 9a6ca7dd6..000000000 --- a/src/code-snippets/windows/signatures/Adjust/ResetSessionPartnerParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void ResetSessionPartnerParameters() -``` diff --git a/src/code-snippets/windows/signatures/Adjust/SendFirstPackages.mdx b/src/code-snippets/windows/signatures/Adjust/SendFirstPackages.mdx deleted file mode 100644 index bc88ec45f..000000000 --- a/src/code-snippets/windows/signatures/Adjust/SendFirstPackages.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void SendFirstPackages() -``` diff --git a/src/code-snippets/windows/signatures/Adjust/SetEnabled.mdx b/src/code-snippets/windows/signatures/Adjust/SetEnabled.mdx deleted file mode 100644 index 712efa0c2..000000000 --- a/src/code-snippets/windows/signatures/Adjust/SetEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void SetEnabled(bool enabled) -``` diff --git a/src/code-snippets/windows/signatures/Adjust/SetOfflineMode.mdx b/src/code-snippets/windows/signatures/Adjust/SetOfflineMode.mdx deleted file mode 100644 index e0bd58992..000000000 --- a/src/code-snippets/windows/signatures/Adjust/SetOfflineMode.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void SetOfflineMode(bool offline) -``` diff --git a/src/code-snippets/windows/signatures/Adjust/SetPushToken.mdx b/src/code-snippets/windows/signatures/Adjust/SetPushToken.mdx deleted file mode 100644 index 57aac507d..000000000 --- a/src/code-snippets/windows/signatures/Adjust/SetPushToken.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void SetPushToken(string pushToken) -``` diff --git a/src/code-snippets/windows/signatures/Adjust/TrackEvent.mdx b/src/code-snippets/windows/signatures/Adjust/TrackEvent.mdx deleted file mode 100644 index 04cd3f69e..000000000 --- a/src/code-snippets/windows/signatures/Adjust/TrackEvent.mdx +++ /dev/null @@ -1,4 +0,0 @@ -```c# -var adjustEvent = new AdjustEvent("abc123"); -Adjust.TrackEvent(adjustEvent); -``` diff --git a/src/code-snippets/windows/signatures/AdjustConfig/AttributionChanged.mdx b/src/code-snippets/windows/signatures/AdjustConfig/AttributionChanged.mdx deleted file mode 100644 index d8db5d96d..000000000 --- a/src/code-snippets/windows/signatures/AdjustConfig/AttributionChanged.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public Action AttributionChanged { get; set; } -``` diff --git a/src/code-snippets/windows/signatures/AdjustConfig/DeeplinkResponse.mdx b/src/code-snippets/windows/signatures/AdjustConfig/DeeplinkResponse.mdx deleted file mode 100644 index a9ee1cb52..000000000 --- a/src/code-snippets/windows/signatures/AdjustConfig/DeeplinkResponse.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public Func DeeplinkResponse { get; set; } -``` diff --git a/src/code-snippets/windows/signatures/AdjustConfig/DefaultTracker.mdx b/src/code-snippets/windows/signatures/AdjustConfig/DefaultTracker.mdx deleted file mode 100644 index b644f02d5..000000000 --- a/src/code-snippets/windows/signatures/AdjustConfig/DefaultTracker.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public string DefaultTracker { get; set; } -``` diff --git a/src/code-snippets/windows/signatures/AdjustConfig/DelayStart.mdx b/src/code-snippets/windows/signatures/AdjustConfig/DelayStart.mdx deleted file mode 100644 index 891a1e48d..000000000 --- a/src/code-snippets/windows/signatures/AdjustConfig/DelayStart.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public TimeSpan? DelayStart { get; set; } -``` diff --git a/src/code-snippets/windows/signatures/AdjustConfig/EventBufferingEnabled.mdx b/src/code-snippets/windows/signatures/AdjustConfig/EventBufferingEnabled.mdx deleted file mode 100644 index fb2098d52..000000000 --- a/src/code-snippets/windows/signatures/AdjustConfig/EventBufferingEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public bool EventBufferingEnabled { get; set; } -``` diff --git a/src/code-snippets/windows/signatures/AdjustConfig/EventTrackingFailed.mdx b/src/code-snippets/windows/signatures/AdjustConfig/EventTrackingFailed.mdx deleted file mode 100644 index 0b5ebdf55..000000000 --- a/src/code-snippets/windows/signatures/AdjustConfig/EventTrackingFailed.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public Action EventTrackingFailed { get; set; } -``` diff --git a/src/code-snippets/windows/signatures/AdjustConfig/EventTrackingSucceeded.mdx b/src/code-snippets/windows/signatures/AdjustConfig/EventTrackingSucceeded.mdx deleted file mode 100644 index 7b5e143ae..000000000 --- a/src/code-snippets/windows/signatures/AdjustConfig/EventTrackingSucceeded.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public Action EventTrackingSucceeded { get; set; } -``` diff --git a/src/code-snippets/windows/signatures/AdjustConfig/SendInBackground.mdx b/src/code-snippets/windows/signatures/AdjustConfig/SendInBackground.mdx deleted file mode 100644 index 53e4660be..000000000 --- a/src/code-snippets/windows/signatures/AdjustConfig/SendInBackground.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public bool SendInBackground { get; set; } -``` diff --git a/src/code-snippets/windows/signatures/AdjustConfig/SessionTrackingFailed.mdx b/src/code-snippets/windows/signatures/AdjustConfig/SessionTrackingFailed.mdx deleted file mode 100644 index d8072490c..000000000 --- a/src/code-snippets/windows/signatures/AdjustConfig/SessionTrackingFailed.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public Action SessionTrackingFailed { get; set; } -``` diff --git a/src/code-snippets/windows/signatures/AdjustConfig/SessionTrackingSucceeded.mdx b/src/code-snippets/windows/signatures/AdjustConfig/SessionTrackingSucceeded.mdx deleted file mode 100644 index 5a9b4bd2c..000000000 --- a/src/code-snippets/windows/signatures/AdjustConfig/SessionTrackingSucceeded.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public Action SessionTrackingSucceeded { get; set; } -``` diff --git a/src/code-snippets/windows/signatures/AdjustConfig/constructor.mdx b/src/code-snippets/windows/signatures/AdjustConfig/constructor.mdx deleted file mode 100644 index d831636a2..000000000 --- a/src/code-snippets/windows/signatures/AdjustConfig/constructor.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public AdjustConfig(string appToken, string environment, Action logDelegate = null, LogLevel? logLevel = null) -``` diff --git a/src/code-snippets/windows/signatures/AdjustConfig/setExternalDeviceId.mdx b/src/code-snippets/windows/signatures/AdjustConfig/setExternalDeviceId.mdx deleted file mode 100644 index 41c8f3be5..000000000 --- a/src/code-snippets/windows/signatures/AdjustConfig/setExternalDeviceId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setExternalDeviceId(string externalDeviceId) -``` diff --git a/src/code-snippets/windows/signatures/AdjustConfig/setLogDelegate.mdx b/src/code-snippets/windows/signatures/AdjustConfig/setLogDelegate.mdx deleted file mode 100644 index 658b8febf..000000000 --- a/src/code-snippets/windows/signatures/AdjustConfig/setLogDelegate.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setLogDelegate(Action logDelegate) -``` diff --git a/src/code-snippets/windows/signatures/AdjustEvent/AddCallbackParameter.mdx b/src/code-snippets/windows/signatures/AdjustEvent/AddCallbackParameter.mdx deleted file mode 100644 index 0be52f6a8..000000000 --- a/src/code-snippets/windows/signatures/AdjustEvent/AddCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void AddCallbackParameter(string key, string value) -``` diff --git a/src/code-snippets/windows/signatures/AdjustEvent/AddPartnerParameter.mdx b/src/code-snippets/windows/signatures/AdjustEvent/AddPartnerParameter.mdx deleted file mode 100644 index d5cbe3e0a..000000000 --- a/src/code-snippets/windows/signatures/AdjustEvent/AddPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void AddPartnerParameter(string key, string value) -``` diff --git a/src/code-snippets/windows/signatures/AdjustEvent/CallbackId.mdx b/src/code-snippets/windows/signatures/AdjustEvent/CallbackId.mdx deleted file mode 100644 index 59f827bb5..000000000 --- a/src/code-snippets/windows/signatures/AdjustEvent/CallbackId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public string CallbackId { get; set; } -``` diff --git a/src/code-snippets/windows/signatures/AdjustEvent/Constructor.mdx b/src/code-snippets/windows/signatures/AdjustEvent/Constructor.mdx deleted file mode 100644 index 1cf7b656b..000000000 --- a/src/code-snippets/windows/signatures/AdjustEvent/Constructor.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public AdjustEvent(string eventToken) -``` diff --git a/src/code-snippets/windows/signatures/AdjustEvent/PurchaseId.mdx b/src/code-snippets/windows/signatures/AdjustEvent/PurchaseId.mdx deleted file mode 100644 index 2a3ab167f..000000000 --- a/src/code-snippets/windows/signatures/AdjustEvent/PurchaseId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public string PurchaseId { get; set; } -``` diff --git a/src/code-snippets/windows/signatures/AdjustEvent/SetRevenue.mdx b/src/code-snippets/windows/signatures/AdjustEvent/SetRevenue.mdx deleted file mode 100644 index f184d18f3..000000000 --- a/src/code-snippets/windows/signatures/AdjustEvent/SetRevenue.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void SetRevenue(double revenue, string currency) -``` diff --git a/src/content/docs/sdk/flutter/features/deep-links.mdx b/src/content/docs/sdk/flutter/features/deep-links.mdx index 12d2dc9e5..3b1722b92 100644 --- a/src/content/docs/sdk/flutter/features/deep-links.mdx +++ b/src/content/docs/sdk/flutter/features/deep-links.mdx @@ -29,8 +29,6 @@ Adjust enables you to run re-engagement campaigns with usage of deep links. For -Adjust enables you to run re-engagement campaigns with usage of deep links. For more information, see the [guide to appending attribution data to a deep link](https://help.adjust.com/en/article/deeplink-generator#manage-your-deeplinks). - To reattribute your user, you need to call the `appWillOpenUrl` method when the app receives deep link content. The Adjust SDK then looks for new attribution data within the deep link. If the SDK finds new information, it forwards the information to Adjust's servers for reattribution. diff --git a/src/content/docs/sdk/flutter/features/session-parameters.mdx b/src/content/docs/sdk/flutter/features/session-parameters.mdx index 850ad760e..bcce221eb 100644 --- a/src/content/docs/sdk/flutter/features/session-parameters.mdx +++ b/src/content/docs/sdk/flutter/features/session-parameters.mdx @@ -108,7 +108,7 @@ 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](/en/sdk/flutter/configuration#delay-the-start-of-the-sdk) 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/flutter/configuration#delay-the-start-of-the-sdk) on your config object. ```dart {3} AdjustConfig adjustConfig = new AdjustConfig('{YourAppToken}', AdjustEnvironment.Sandbox); diff --git a/src/content/docs/sdk/windows/configuration.mdx b/src/content/docs/sdk/windows/configuration.mdx new file mode 100644 index 000000000..bb1483cc1 --- /dev/null +++ b/src/content/docs/sdk/windows/configuration.mdx @@ -0,0 +1,247 @@ +--- +title: Configuration +description: Follow the guides in this section to configure the Adjust SDK. +category-title: Configuration +slug: en/sdk/windows/configuration +sidebar-position: 1 +--- + +Use the methods in this document to configure the behavior of the Adjust SDK. + +## Instantiate your config object + +```c# title="Method signature" +public AdjustConfig(string appToken, string environment, Action logDelegate = null, LogLevel? logLevel = null) +``` + +To configure the Adjust SDK, you need to instantiate an `AdjustConfig` 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 `AdjustConfig` instance and pass the following parameters: + +- `appToken` (**String**): Your [Adjust app token](https://help.adjust.com/en/article/app-token-and-reporting-currency#view-your-app-details). +- `environment` (**String**): The environment you want to run the SDK in. Pass `AdjustConfig.EnvironmentSandbox` to run the SDK in sandbox mode for testing. Pass `AdjustConfig.EnvironmentProduction` to run the SDK in production mode for release. +- `logDelegate` (**Action**): A function to which logging is delegated. You can also configure this using the [`setLogDelegate` method](#configure-a-log-delegate). +- `logLevel` (**LogLevel**): The level of logging you want to record. The following log levels are supported: + + + +| Log level | Description | +| ------------------- | --------------------------------------------- | +| `LogLevel.Verbose` | Enable all logging | +| `LogLevel.Debug` | Enable debug logging | +| `LogLevel.Info` | Only show info level logging (default option) | +| `LogLevel.Warn` | Disable informational warnings | +| `LogLevel.Error` | Disable warning level logging and below | +| `LogLevel.Assert` | Disable error level logging and below | +| `LogLevel.Suppress` | Suppress all logging | + +
+ +```c# +string appToken = "hmqwpvspxnuo"; +string environment = AdjustConfig.EnvironmentSandbox; +var adjustConfig = new AdjustConfig(appToken, environment, + msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); +Adjust.ApplicationLaunching(adjustConfig); +``` + +## Read-only configuration + +**Read-only** configuration options are set in your `AdjustConfig` 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.ApplicationLaunching()`. + +### Configure a log delegate + +```c# title="Method signature" +public void setLogDelegate(Action logDelegate); +``` + +A log delegate is a function that the Adjust SDK calls to record logs. To configure a log delegate, pass your log function to the `setLogDelegate`. The Adjust SDK calls this function each time it outputs a log message. + +```c# {3} +AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); +//... +adjustConfig.setLogDelegate(msg => Debug.Log(msg)); +//... +Adjust.ApplicationLaunching(config); +``` + +### Set external device identifier + +```c# title="Method signature" +public void setExternalDeviceId(string 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. You can set property calling the `setExternalDeviceId` method with the following parameter: + +- `externalDeviceId` (String): 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. + + + +```c# {3} +AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); +//... +adjustConfig.setExternalDeviceId("{Your-External-Device-Id}"); +//... +Adjust.ApplicationLaunching(adjustConfig); +``` + +If you want to use the external device ID in your business analytics, you can pass it as a [session callback parameter](/en/sdk/android/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 + +```c# title="Property declaration" +public string DefaultTracker { get; set; } +``` + +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. To set your default link token, assign your [Adjust link token](https://help.adjust.com/en/article/links#adjust-link-token) to the `DefaultTracker` property on your config instance. + +```c# {3} +var adjustConfig = new AdjustConfig(appToken, environment, + msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); +adjustConfig.DefaultTracker = "{TrackerToken}"; +Adjust.ApplicationLaunching(adjustConfig); +``` + +### Enable background recording + +```c# title="Property declaration" +public bool SendInBackground { get; set; } +``` + +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. + +```c# {4} +var adjustConfig = new AdjustConfig(appToken, environment, + msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); +//... +adjustConfig.SendInBackground = true; +//... +Adjust.ApplicationLaunching(adjustConfig); +``` + +### Enable event buffering + +```c# title="Property declaration" +public bool EventBufferingEnabled { get; set; } +``` + +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` (**Boolean**): Set to `true` to enable event buffering or `false` to disable event buffering. + +```c# {4} +var adjustConfig = new AdjustConfig(appToken, environment, + msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); +//... +adjustConfig.EventBufferingEnabled = true; +//... +Adjust.ApplicationLaunching(adjustConfig); +``` + +### Delay the start of the SDK + +```c# title="Property declaration" +public TimeSpan? DelayStart { get; set; } +``` + +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/flutter/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 **TimeSpan** value to the `DelayStart` property of your config instance. + +- `delayStart` (**TimeSpan**): 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**. + +```c# +adjustConfig.DelayStart = TimeSpan.FromSeconds(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 + +```c# title="Method signature" +public void SetOfflineMode(bool offline); +``` + + + +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: + +- `offline` (Boolean): Set to `true` to enable offline mode or `false` to disable offline mode. + +```c# +Adjust.SetOfflineMode(true); +``` + +### Set push tokens + +```c# title="Method signature" +public static void SetPushToken(string pushToken); +``` + +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 `setPushToken` method and passing the following arguments: + +- `pushToken` (String): Your push token. + + + +If you have access to the push token from the web view, you can call the `setPushToken` method in Javascript. + + + +```c# +Adjust.SetPushToken("{YourDeviceToken}"); +``` + +### Disable or enable the SDK + + + +You can only call this method after the first session. This setting persists between sessions. + + + +```c# title="Method signature" +public static 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` (Boolean): Set to `true` to enable the SDK or `false` to disable the SDK. + +```c# +Adjust.SetEnabled(false); +``` + +#### Check enabled status + +```c# title="Method signature" +public static 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`). + +```c# +Adjust.IsEnabled(); +``` diff --git a/src/content/docs/sdk/windows/configuration/background.mdx b/src/content/docs/sdk/windows/configuration/background.mdx deleted file mode 100644 index 4412d55a5..000000000 --- a/src/content/docs/sdk/windows/configuration/background.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Record activity in the background -description: Configure the SDK to send requests in the background. -slug: en/sdk/windows/configuration/background ---- - -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. - -import SendInBackgroundSig from "@windows-signatures/AdjustConfig/SendInBackground.mdx"; - -Your config object contains a boolean `SendInBackground` property that controls this behavior. When set to `true`, the SDK sends data to Adjust while the app is running in the background. - - - -You must set the `SendInBackground` property _before_ you initialize the Adjust SDK. - - - -import SendInBackground from "@windows-examples/AdjustConfig/SendInBackground.mdx"; - - diff --git a/src/content/docs/sdk/windows/configuration/delay.mdx b/src/content/docs/sdk/windows/configuration/delay.mdx deleted file mode 100644 index dd0c26119..000000000 --- a/src/content/docs/sdk/windows/configuration/delay.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Delay recording -description: Configure the SDK to delay the sending of information to Adjust's servers. -slug: en/sdk/windows/configuration/delay ---- - - - -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. - -import SetOfflineModeSig from "@windows-signatures/Adjust/SetOfflineMode.mdx"; - -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. - -import SetOfflineMode from "@windows-examples/Adjust/SetOfflineMode.mdx"; - - - -## 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. - -import EventBufferingEnabledSig from "@windows-signatures/AdjustConfig/EventBufferingEnabled.mdx"; - -Your config object contains a boolean `EventBufferingEnabled` property that controls this behavior. Set this property to `true` to enable event buffering. - -import EventBufferingEnabled from "@windows-examples/AdjustConfig/EventBufferingEnabled.mdx"; - - diff --git a/src/content/docs/sdk/windows/configuration/disable.mdx b/src/content/docs/sdk/windows/configuration/disable.mdx deleted file mode 100644 index 9337ead5e..000000000 --- a/src/content/docs/sdk/windows/configuration/disable.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Disable the Adjust SDK -description: Disable the Adjust SDK to pause recording. -slug: en/sdk/windows/configuration/disable ---- - -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. - -import SetEnabledSig from "@windows-signatures/Adjust/SetEnabled.mdx"; - -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. - - - -import SetEnabled from "@windows-examples/Adjust/SetEnabled.mdx"; - - - -## Check enabled status - -import IsEnabledSig from "@windows-signatures/Adjust/IsEnabled.mdx"; - -You can check if the Adjust SDK is enabled at any time by calling the `IsEnabled` method. This method returns a boolean value. - -import IsEnabled from "@windows-examples/Adjust/IsEnabled.mdx"; - - diff --git a/src/content/docs/sdk/windows/configuration/index.mdx b/src/content/docs/sdk/windows/configuration/index.mdx deleted file mode 100644 index 07201ad08..000000000 --- a/src/content/docs/sdk/windows/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/windows/configuration -type: category ---- - -Follow the guides in this section to configure the Adjust SDK. diff --git a/src/content/docs/sdk/windows/configuration/log-level.mdx b/src/content/docs/sdk/windows/configuration/log-level.mdx deleted file mode 100644 index 72ec2e13d..000000000 --- a/src/content/docs/sdk/windows/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/windows/configuration/log-level ---- - -import SetLogLevel from "@windows-examples/AdjustConfig/constructor.mdx"; -import SetLogLevelSig from "@windows-signatures/AdjustConfig/constructor.mdx"; - -The Adjust SDK provides configurable log levels to return different amounts of information. The following log levels are available: - - - -| ADJLogLevel | Description | -| ------------------- | ------------------------------------------ | -| `LogLevel.Verbose` | Enable all logging | -| `LogLevel.Debug` | Enable debug logging | -| `LogLevel.Info` | Only show info level logs (default option) | -| `LogLevel.Warn` | Disable info logging | -| `LogLevel.Error` | Disable warning level logging and below | -| `LogLevel.Assert` | Disable error level logging and below | -| `LogLevel.Suppress` | Suppress all logging | - -
- -You can set your log level by setting the `logLevel` property as the fourth positional argument of the `AdjustConfig` constructor. - - diff --git a/src/content/docs/sdk/windows/configuration/preinstalled.mdx b/src/content/docs/sdk/windows/configuration/preinstalled.mdx deleted file mode 100644 index 489b5bb94..000000000 --- a/src/content/docs/sdk/windows/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/windows/configuration/preinstalled ---- - -import DefaultTracker from "@windows-examples/AdjustConfig/DefaultTracker.mdx"; -import DefaultTrackerSig from "@windows-signatures/AdjustConfig/DefaultTracker.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 Campaign Lab. - -```http "{token}" -https://app.adjust.com/{token} -``` - -2. Copy this token and pass it to the `DefaultTracker` 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/windows/configuration/privacy.mdx b/src/content/docs/sdk/windows/configuration/privacy.mdx deleted file mode 100644 index b960176d5..000000000 --- a/src/content/docs/sdk/windows/configuration/privacy.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Set up privacy features -description: Configure features that you can use to handle user privacy in your app. -slug: en/sdk/windows/configuration/privacy ---- - -import GdprForgetMe from "@windows-examples/Adjust/GdprForgetMe.mdx"; -import GdprForgetMeSig from "@windows-signatures/Adjust/GdprForgetMe.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. - - diff --git a/src/content/docs/sdk/windows/configuration/push-tokens.mdx b/src/content/docs/sdk/windows/configuration/push-tokens.mdx deleted file mode 100644 index a592cac24..000000000 --- a/src/content/docs/sdk/windows/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/windows/configuration/push-tokens ---- - -import SetPushToken from "@windows-examples/Adjust/SetPushToken.mdx"; -import SetPushTokenSig from "@windows-signatures/Adjust/SetPushToken.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 measurement](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 `SetPushToken` method and passing your token as an argument. - - - -This example shows how to set a new push token with the value `HrFmrcq96tj723aWFfrw` to record your app's retention rates. You can update this value at any time by passing a new token to the `SetPushToken` method as an argument: - -```c# -Adjust.SetPushToken("HrFmrcq96tj723aWFfrw"); -``` diff --git a/src/content/docs/sdk/windows/features/attribution.mdx b/src/content/docs/sdk/windows/features/attribution.mdx index 356893066..929ccf941 100644 --- a/src/content/docs/sdk/windows/features/attribution.mdx +++ b/src/content/docs/sdk/windows/features/attribution.mdx @@ -4,11 +4,34 @@ description: Listen for attribution changes using the Adjust SDK slug: en/sdk/windows/features/attribution --- -import Attribution from "@windows-examples/Adjust/GetAttribution.mdx"; -import AttributionSig from "@windows-signatures/Adjust/GetAttribution.mdx"; -import AttributionChanged from "@windows-examples/AdjustConfig/AttributionChanged.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 or a [deep link](https://help.adjust.com/en/article/deep-links), their attribution information updates. The SDK can listen for attribution changes and call a function when it detects an update. +## AdjustAttribution 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. + + + +| 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 | + +
+ +## Trigger a function when attribution changes + +```c# title="Property declaration" +public Action AttributionChanged { get; set; } +``` + +The SDK can listen for attribution changes and call a function when it detects an update. To configure your callback function, assign your function to the `AttributionChanged` property on your config instance. You can pass the name of a function or write the function inline. @@ -16,14 +39,47 @@ You must call the `AttributionChanged` method **before** initializing the Adjust - + + + +```c# {3,4} +var config = new AdjustConfig(appToken, environment); -Within your delegate function, you have access to the user's Attribution object. See the [`AdjustAttribution` class reference](/en/sdk/windows/reference/adjustattribution) for a list of available parameters. +config.AttributionChanged = (attribution) => + System.Diagnostics.Debug.WriteLine("attribution: " + attribution); + +Adjust.ApplicationLaunching(config); +``` + + + + +```c# "AdjustAttributionChanged" +var config = new AdjustConfig(appToken, environment); +config.AttributionChanged = AdjustAttributionChanged; +Adjust.ApplicationLaunching(config); + +private void AdjustAttributionChanged(AdjustAttribution attribution) +{ + //... +} +``` + + + ## Get current attribution information -(Available from v4.12.0 and later.) 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 `GetAttribution` method. +```c# title="Method signature" +public static AdjustAttribution GetAttribution(); +``` + + + +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 `GetAttribution` method to return the attribution information as an `AdjustAttribution` object. -This method returns an Attribution object. See the [`AdjustAttribution` class reference](/en/sdk/windows/reference/adjustattribution) for a list of available properties. + - +```c# +AdjustAttribution attribution = Adjust.GetAttribution(); +``` diff --git a/src/content/docs/sdk/windows/features/callbacks.mdx b/src/content/docs/sdk/windows/features/callbacks.mdx index b9be05cca..72d9d7543 100644 --- a/src/content/docs/sdk/windows/features/callbacks.mdx +++ b/src/content/docs/sdk/windows/features/callbacks.mdx @@ -32,17 +32,27 @@ Session callbacks have access to a response data object. You can use its propert ### Success callbacks -Set up success callbacks to trigger functions when the SDK records a session. +```c# title="Property declaration" +public Action SessionTrackingSucceeded { get; set; } +``` -import SessionTrackingSucceeded from "@windows-examples/AdjustConfig/SessionTrackingSucceeded.mdx"; +Set up success callbacks to trigger functions when the SDK records a session. - +```c# {3-6} +var config = new AdjustConfig(appToken, environment, + msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); +config.SessionTrackingSucceeded = adjustSessionSuccess => +{ + //... +}; +Adjust.ApplicationLaunching(config); +``` #### Example This example shows how to log the timestamp at which the SDK recorded the session. -```c# +```c# {3-6} var config = new AdjustConfig(appToken, environment, msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); config.SessionTrackingSucceeded = adjustSessionSuccess => @@ -54,17 +64,27 @@ Adjust.ApplicationLaunching(config); ### Failure callbacks -Set up failure callbacks to trigger functions when the SDK fails to record a session. +```c# title="Property declaration" +public Action SessionTrackingFailed { get; set; } +``` -import SessionTrackingFailed from "@windows-examples/AdjustConfig/SessionTrackingFailed.mdx"; +Set up failure callbacks to trigger functions when the SDK fails to record a session. - +```c# {3-6} +var config = new AdjustConfig(appToken, environment, + msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); +config.EventTrackingFailed = adjustEventFailure => +{ + //... +}; +Adjust.ApplicationLaunching(config); +``` #### Example This example shows how to log the session failure message. -```c# +```c# {3-6} var config = new AdjustConfig(appToken, environment, msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); config.SessionTrackingFailed = adjustSessionFailure => @@ -96,17 +116,27 @@ Event callbacks have access to a response data object. You can use its propertie ### Success callbacks -Set up success callbacks to trigger functions when the SDK records an event. +```c# title="Property declaration" +public Action EventTrackingSucceeded { get; set; } +``` -import EventTrackingSucceeded from "@windows-examples/AdjustConfig/EventTrackingSucceeded.mdx"; +Set up success callbacks to trigger functions when the SDK records an event. - +```c# {3-6} +var config = new AdjustConfig(appToken, environment, + msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); +config.EventTrackingSucceeded = adjustEventSuccess => +{ + //... +}; +Adjust.ApplicationLaunching(config); +``` #### Example This example shows how to log the timestamp at which the SDK recorded an event. -```c# +```c# {3-6} var config = new AdjustConfig(appToken, environment, msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); config.EventTrackingSucceeded = adjustEventSuccess => @@ -118,17 +148,27 @@ Adjust.ApplicationLaunching(config); ### Failure callbacks -Set up failure callbacks to trigger functions when the SDK fails to record an event. +```c# title="Property declaration" +public Action EventTrackingFailed { get; set; } +``` -import EventTrackingFailed from "@windows-examples/AdjustConfig/EventTrackingFailed.mdx"; +Set up failure callbacks to trigger functions when the SDK fails to record an event. - +```c# {3-6} +var config = new AdjustConfig(appToken, environment, + msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); +config.EventTrackingFailed = adjustEventFailure => +{ + //... +}; +Adjust.ApplicationLaunching(config); +``` #### Example This example shows how to log an event failure message. -```c# +```c# {3-6} var config = new AdjustConfig(appToken, environment, msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); config.EventTrackingFailed = adjustEventFailure => diff --git a/src/content/docs/sdk/windows/configuration/deep-links.mdx b/src/content/docs/sdk/windows/features/deep-links.mdx similarity index 76% rename from src/content/docs/sdk/windows/configuration/deep-links.mdx rename to src/content/docs/sdk/windows/features/deep-links.mdx index d1b338aec..8955f7ca4 100644 --- a/src/content/docs/sdk/windows/configuration/deep-links.mdx +++ b/src/content/docs/sdk/windows/features/deep-links.mdx @@ -2,16 +2,13 @@ title: Deep linking description: Follow the guides in this section to set up deep linking. category-title: Deep linking -slug: en/sdk/windows/configuration/deep-links +slug: en/sdk/windows/features/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. +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: -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. +- 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. @@ -30,7 +27,7 @@ If a user has your app installed, it opens when they interact with a link contai Next, you need to set up your `OnActivated` event handler. This handles the activated deep link event. To set this up, add the following to your your `App.xaml.cs` file: -```c# +```c# title="App.xaml.cs" // ... protected override void OnActivated(IActivatedEventArgs args) { if (args.Kind == ActivationKind.Protocol) { @@ -56,14 +53,38 @@ Your app opens when a user interacts with a link containing your **unique scheme ## Deferred deep linking +```c# title="Property declaration" +public Func DeeplinkResponse { get; set; } +``` + You can configure the Adjust SDK to call a delegate function when it receives a deferred deep link. This delegate function receives the deep link as a **string** argument. Once the SDK receives the deep link content from Adjust's servers, it delivers it through this delegate function and expects a **boolean** return value. This value represents whether the SDK should launch the **OnActivated** event handler. -import DeeplinkResponse from "@windows-examples/AdjustConfig/DeeplinkResponse.mdx"; +```c# {4-14} +var adjustConfig = new AdjustConfig(appToken, environment, + msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); + +adjustConfig.DeeplinkResponse = deepLinkUri => +{ + if (ShouldAdjustSdkLaunchTheDeeplink(deepLinkUri)) + { + return true; + } + else + { + return false; + } +}; - +Adjust.ApplicationLaunching(adjustConfig); +// ... +``` ## Reattribution using deep links +```cs title="Method signature" +public static void AppWillOpenUrl(Uri uri); +``` + Adjust enables you to run re-engagement campaigns with usage of deep links. For more information, see the [guide to appending attribution data to a deep link](https://help.adjust.com/en/article/manage-reattributions#track-reattributions-via-deeplink-clicks). @@ -76,7 +97,7 @@ If the user needs to be reattributed due to clicking on an Adjust deep link, thi You must call `Adjust.AppWillOpenUrl` in the `OnActivated` method of your app: -```c# +```c# {8-10} using AdjustSdk; public partial class App : Application diff --git a/src/content/docs/sdk/windows/features/device-info.mdx b/src/content/docs/sdk/windows/features/device-info.mdx index 595c028d5..0efdda299 100644 --- a/src/content/docs/sdk/windows/features/device-info.mdx +++ b/src/content/docs/sdk/windows/features/device-info.mdx @@ -8,18 +8,24 @@ The Adjust SDK contains helper methods that return device information. Use these ## Adjust device identifier -import GetAdid from "@windows-examples/Adjust/GetAdid.mdx"; -import GetAdidSig from "@windows-signatures/Adjust/GetAdid.mdx"; +```c# title="Method signature" +public static string GetAdid(); +``` -Adjust generates a unique ADID (Adjust Device ID) for each device. Call the `GetAdid` method to return this ID as a **string**. +Adjust generates a unique Adjust Device ID (ADID) for each device. Call the `GetAdid` method to return this ID as a **string**. - +```c# +string adid = Adjust.GetAdid(); +``` ## Windows advertising identifier -import GetWindowsAdId from "@windows-examples/Adjust/GetWindowsAdId.mdx"; -import GetWindowsAdIdSig from "@windows-signatures/Adjust/GetWindowsAdId.mdx"; +```c# title="Method signature" +public static string GetWindowsAdId(); +``` -The Windows ADID (Advertising ID) is a device-specific identifier for Windows devices. Call the `GetWindowsAdId` method to return this ID as a **string**. +The Windows Advertising ID (Windows ADID) is a device-specific identifier for Windows devices. Call the `GetWindowsAdId` method to return this ID as a **string**. - +```c# +var windowsAdid = Adjust.GetWindowsAdId(); +``` diff --git a/src/content/docs/sdk/windows/features/events.mdx b/src/content/docs/sdk/windows/features/events.mdx index 95cb3d239..80fb55582 100644 --- a/src/content/docs/sdk/windows/features/events.mdx +++ b/src/content/docs/sdk/windows/features/events.mdx @@ -4,31 +4,46 @@ description: Use these methods send event information to Adjust. slug: en/sdk/windows/features/events --- -import TrackEvent from "@windows-examples/Adjust/TrackEvent.mdx"; -import TrackEventSig from "@windows-signatures/Adjust/TrackEvent.mdx"; -import SetRevenue from "@windows-examples/AdjustEvent/SetRevenue.mdx"; -import SetRevenueSig from "@windows-signatures/AdjustEvent/SetRevenue.mdx"; -import PurchaseId from "@windows-examples/AdjustEvent/PurchaseId.mdx"; -import PurchaseIdSig from "@windows-signatures/AdjustEvent/PurchaseId.mdx"; -import CallbackId from "@windows-examples/AdjustEvent/CallbackId.mdx"; -import CallbackIdSig from "@windows-signatures/AdjustEvent/CallbackId.mdx"; -import AddCallbackParameter from "@windows-examples/AdjustEvent/AddCallbackParameter.mdx"; -import AddCallbackParameterSig from "@windows-signatures/AdjustEvent/AddCallbackParameter.mdx"; -import AddPartnerParameter from "@windows-examples/AdjustEvent/AddPartnerParameter.mdx"; -import AddPartnerParameterSig from "@windows-signatures/AdjustEvent/AddPartnerParameter.mdx"; +The Adjust SDK provides an `AdjustEvent` object which can be used to structure and send event information from your app to Adjust's servers. + +## Instantiate an AdjustEvent object + +```c# title="Method signature" +public AdjustEvent(string eventToken); +``` + +To send event information with the Adjust SDK, you need to instantiate an `AdjustEvent` 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 `AdjustEvent` instance and pass the following parameters: + +- `eventToken` (**String**): Your Adjust [event token](https://help.adjust.com/en/article/add-events#manage-your-events). + +```c# {1} +var adjustEvent = new AdjustEvent("abc123"); +Adjust.TrackEvent(adjustEvent); +``` + +## Send an event + +```c# title="Method signature" +public static void TrackEvent(AdjustEvent adjustEvent); +``` 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. - +```c# {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. -```c# +```c# {14-18} using AdjustSdk; using Windows.UI.Xaml; using Windows.UI.Xaml.Controls; @@ -69,13 +84,16 @@ namespace AdjustWSExample ## Record event revenue +```c# title="Method signature" +public void SetRevenue(double revenue, string 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. @@ -83,13 +101,17 @@ Check the guide to [tracking purchases in different currencies](https://help.adj - +```c# {2} +var adjustEvent = new AdjustEvent("abc123"); +adjustEvent.SetRevenue(0.01, "EUR"); +Adjust.TrackEvent(adjustEvent); +``` ### Example This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. The function sets the `revenue` property of this event to _`0.25`_ and the `currency` property to _`EUR`_. -```c# +```c# {14-19} using AdjustSdk; using Windows.UI.Xaml; using Windows.UI.Xaml.Controls; @@ -129,19 +151,30 @@ namespace AdjustWSExample ``` -## Unique events +## Set a unique purchase ID + +```c# title="Property declaration" +public string PurchaseId { get; set; } +``` You can pass an optional identifier to avoid recording duplicate events. The SDK stores the last ten identifiers and skips revenue events with duplicate purchase IDs. -To set the identifier, call the `PurchaseId` method, with the purchase ID as a **string** argument. +To set the identifier, assign your purchase ID to the `PurchaseId` property on your event object. - +```c# {4} +AdjustEvent event = new AdjustEvent("abc123"); + +event.SetRevenue(0.01, "EUR"); +event.PurchaseId = "{PurchaseId}"; + +Adjust.trackEvent(event); +``` ### Example -This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. The function sets the `uniqueId` to `5e85484b-1ebc-4141-aab7-25b869e54c49` using the `PurchaseId` method. +This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. The function sets `PurchaseId` property to `5e85484b-1ebc-4141-aab7-25b869e54c49`. -```c# +```c# {14-20} using AdjustSdk; using Windows.UI.Xaml; using Windows.UI.Xaml.Controls; @@ -184,17 +217,28 @@ namespace AdjustWSExample ## Add callback parameters -If you [register a callback URL](https://help.adjust.com/en/article/set-up-callbacks) in AppView, the SDK sends a GET request to your callback URL when it records an event. +```c# title="Method signature" +public void AddCallbackParameter(string key, string 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 in your BI system. +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. +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. - +```c# {3,4} +var adjustEvent = new AdjustEvent("abc123"); + +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: -```http +```http "key=value" "foo=bar" https://www.mydomain.com/callback?key=value&foo=bar ``` @@ -204,7 +248,7 @@ Adjust doesn't store your custom callback parameters. Custom parameters are only -If you're using cloud storage uploads, make sure to add the parameters to your CSV definition. +If you're using CSV uploads, make sure to add the parameters to your CSV definition. Adjust supports many placeholders which you can use to pass information from the SDK to your URL. For example, the `{idfa}` placeholder for iOS and the `{gps_adid}` placeholder for Android. The `{publisher_parameter}` placeholder presents all callback parameters in a single string. @@ -227,7 +271,7 @@ The resulting callback URL looks like this: http://www.mydomain.com/callback?event_token=g3mfiw&revenue_amount=0.05 ``` -```c# +```c# {14-20} using AdjustSdk; using Windows.UI.Xaml; using Windows.UI.Xaml.Controls; @@ -270,6 +314,10 @@ namespace AdjustWSExample ## Add partner parameters +```c# title="Method signature" +public void AddPartnerParameter(string key, string 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. @@ -280,9 +328,16 @@ 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. +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. + +```c# {3,4} +var adjustEvent = new AdjustEvent("abc123"); - +adjustEvent.AddPartnerParameter("key", "value"); +adjustEvent.AddPartnerParameter("foo", "bar"); + +Adjust.TrackEvent(adjustEvent); +``` ### Example @@ -291,7 +346,7 @@ This example shows how to record an event with the token `g3mfiw` whenever a use - The `product_id` of the associated product - The `user_id` of the user who triggered the event -```c# +```c# {14-20} using AdjustSdk; using Windows.UI.Xaml; using Windows.UI.Xaml.Controls; @@ -334,17 +389,27 @@ namespace AdjustWSExample ## Add a callback identifier +```c# title="Property declaration" +public string CallbackId { get; set; } +``` + 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 `CallbackId` method with the callback ID as a **string** argument. +Set up this identifier by assigning your identifier to the `CallbackId` property on your event object. + +```c# {3} +var adjustEvent = new AdjustEvent("abc123"); - +adjustEvent.CallbackId = "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`. -```c# +```c# {14-19} using AdjustSdk; using Windows.UI.Xaml; using Windows.UI.Xaml.Controls; diff --git a/src/content/docs/sdk/windows/features/index.mdx b/src/content/docs/sdk/windows/features/index.mdx index ce0f21777..336525430 100644 --- a/src/content/docs/sdk/windows/features/index.mdx +++ b/src/content/docs/sdk/windows/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/windows/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/windows/features/preinstalled.mdx b/src/content/docs/sdk/windows/features/preinstalled.mdx new file mode 100644 index 000000000..f9c134ba2 --- /dev/null +++ b/src/content/docs/sdk/windows/features/preinstalled.mdx @@ -0,0 +1,32 @@ +--- +title: Send preinstalled app activity +description: Configure a campaign to send information from preinstalled apps. +slug: en/sdk/windows/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. + +## Default link token + +Configuring a default link token enables you to attribute all preinstalls to a predefined Adjust link. Adjust records all information against this token until the attribution source changes. To set this up: + +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/flutter/configuration#set-default-link-token) of your config object. + + ```c# {3} + var config = new AdjustConfig(appToken, environment, + msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); + config.DefaultTracker = "{TrackerToken}"; + Adjust.ApplicationLaunching(config); + ``` + +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/windows/features/privacy.mdx b/src/content/docs/sdk/windows/features/privacy.mdx new file mode 100644 index 000000000..6064f446b --- /dev/null +++ b/src/content/docs/sdk/windows/features/privacy.mdx @@ -0,0 +1,21 @@ +--- +title: Set up privacy features +description: Configure features that you can use to handle user privacy in your app. +slug: en/sdk/windows/features/privacy +--- + +The Adjust SDK contains features that you can use to handle user privacy in your app. + +## Send right to be forgotten request + +```c# title="Method signature" +public static 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. + +```c# +Adjust.GdprForgetMe(); +``` diff --git a/src/content/docs/sdk/windows/features/session-parameters.mdx b/src/content/docs/sdk/windows/features/session-parameters.mdx index bee9bfb06..86fe8dd05 100644 --- a/src/content/docs/sdk/windows/features/session-parameters.mdx +++ b/src/content/docs/sdk/windows/features/session-parameters.mdx @@ -4,26 +4,9 @@ description: Send information to your callback URL with each session. slug: en/sdk/windows/features/session-parameters --- -import AddSessionCallbackParameter from "@windows-examples/Adjust/AddSessionCallbackParameter.mdx"; -import AddSessionCallbackParameterSig from "@windows-signatures/Adjust/AddSessionCallbackParameter.mdx"; -import RemoveSessionCallbackParameter from "@windows-examples/Adjust/RemoveSessionCallbackParameter.mdx"; -import RemoveSessionCallbackParameterSig from "@windows-signatures/Adjust/RemoveSessionCallbackParameter.mdx"; -import ResetSessionCallbackParameters from "@windows-examples/Adjust/ResetSessionCallbackParameters.mdx"; -import ResetSessionCallbackParametersSig from "@windows-signatures/Adjust/ResetSessionCallbackParameters.mdx"; -import AddSessionPartnerParameter from "@windows-examples/Adjust/AddSessionPartnerParameter.mdx"; -import AddSessionPartnerParameterSig from "@windows-signatures/Adjust/AddSessionPartnerParameter.mdx"; -import RemoveSessionPartnerParameter from "@windows-examples/Adjust/RemoveSessionPartnerParameter.mdx"; -import RemoveSessionPartnerParameterSig from "@windows-signatures/Adjust/RemoveSessionPartnerParameter.mdx"; -import ResetSessionPartnerParameters from "@windows-examples/Adjust/ResetSessionPartnerParameters.mdx"; -import ResetSessionPartnerParametersSig from "@windows-signatures/Adjust/ResetSessionPartnerParameters.mdx"; -import DelayStart from "@windows-examples/AdjustConfig/DelayStart.mdx"; -import DelayStartSig from "@windows-signatures/AdjustConfig/DelayStart.mdx"; -import SendFirstPackages from "@windows-examples/Adjust/SendFirstPackages.mdx"; -import SendFirstPackagesSig from "@windows-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 in your BI system. +## Session callback parameters @@ -31,17 +14,43 @@ 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 + +```c# title="Method signature" +public static void AddSessionCallbackParameter(string key, string 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. - +```c# +Adjust.AddSessionCallbackParameter("key", "value"); +``` + +### Remove session callback parameters + +```c# title="Method signature" +public static void RemoveSessionCallbackParameter(string 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. +```c# +Adjust.RemoveSessionCallbackParameter("key"); +``` - +### Reset session callback parameters -You can remove all session parameters if they're no longer required. To do this, call the `ResetSessionCallbackP parameters` method. +```c# title="Method signature" +public static void ResetSessionCallbackParameters(); +``` - +You can remove all session parameters if they're no longer required. To do this, call the `ResetSessionCallbackParameters` method. + +```c# +Adjust.ResetSessionCallbackParameters(); +``` ## Session partner parameters @@ -55,17 +64,41 @@ 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 + +```c# title="Method signature" +public static void AddSessionPartnerParameter(string key, string 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. + +```c# +Adjust.AddSessionPartnerParameter("key", "value"); +``` - +### Remove session partner parameters + +```c# title="Method signature" +public static void RemoveSessionPartnerParameter(string 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. - +```c# +Adjust.RemoveSessionPartnerParameter("key"); +``` + +### Reset session partner parameters + +```c# title="Method signature" +public static void ResetSessionPartnerParameters(); +``` You can remove all session partner parameters if they're no longer required. To do this, call the `ResetSessionPartnerParameters` method. - +```c# +Adjust.ResetSessionPartnerParameters(); +``` ## Delay start @@ -75,10 +108,14 @@ 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 `DelayStart` 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/flutter/configuration#delay-the-start-of-the-sdk) on your config object. - +```c# +adjustConfig.DelayStart = TimeSpan.FromSeconds(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. - +```c# +Adjust.SendFirstPackages() +``` diff --git a/src/content/docs/sdk/windows/index.mdx b/src/content/docs/sdk/windows/index.mdx index 665e2b572..a455e43b4 100644 --- a/src/content/docs/sdk/windows/index.mdx +++ b/src/content/docs/sdk/windows/index.mdx @@ -31,7 +31,7 @@ To install the Adjust SDK using the Package Manager Console: 1. Select **TOOLS --> NuGet Package Manager --> Package Manager Console** to open the Package Manager Console view. 2. Enter the following install command in the prompt and hit **Return** to run it. -```c# +```console PM> Install-Package Adjust ``` @@ -43,7 +43,7 @@ Once you've added the Adjust SDK to your Visual Studio project, you need to inte 2. Open the `App.xaml.cs` file. 3. Add the following directive to the top of the file: -```c# +```c# title="App.xaml.cs" using AdjustSdk; ``` @@ -51,9 +51,8 @@ using AdjustSdk; 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. - -`environment`: The environment you want to run the SDK in. Set this to `AdjustConfig.EnvironmentSandbox`. +- `appToken`: Your app's token. +- `environment`: The environment you want to run the SDK in. Set this to `AdjustConfig.EnvironmentSandbox`. To initialize the Adjust SDK with this config object: diff --git a/src/content/docs/sdk/windows/reference/adjust/config.mdx b/src/content/docs/sdk/windows/reference/adjust/config.mdx deleted file mode 100644 index 3b84e43c2..000000000 --- a/src/content/docs/sdk/windows/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/windows/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 "@windows-signatures/Adjust/SetEnabled.mdx"; - - - - - - - -import SetEnabled from "@windows-examples/Adjust/SetEnabled.mdx"; - - - - - - - -`enabled` (boolean): Whether the SDK should be enabled - - - - - - - -## IsEnabled - -Call this method to check whether the Adjust SDK is enabled. - - - -import IsEnabledSig from "@windows-signatures/Adjust/IsEnabled.mdx"; - - - - - - - -import IsEnabled from "@windows-examples/Adjust/IsEnabled.mdx"; - - - - - - - -`enabled` (boolean): Whether the SDK is enabled - - - - - - - -## 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 "@windows-signatures/Adjust/SetOfflineMode.mdx"; - - - - - - - -import SetOfflineMode from "@windows-examples/Adjust/SetOfflineMode.mdx"; - - - - - - - -`enabled` (boolean): Whether the SDK should be in offline mode - - - - - - - -## SetPushToken - -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 SetPushTokenSig from "@windows-signatures/Adjust/SetPushToken.mdx"; - - - - - - - -import SetPushToken from "@windows-examples/Adjust/SetPushToken.mdx"; - - - - - - - -`pushToken` (String): Your push token - - - - - - - -## 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 "@windows-signatures/Adjust/SendFirstPackages.mdx"; - - - - - - - -import SendFirstPackages from "@windows-examples/Adjust/SendFirstPackages.mdx"; - - - - - - diff --git a/src/content/docs/sdk/windows/reference/adjust/device-info.mdx b/src/content/docs/sdk/windows/reference/adjust/device-info.mdx deleted file mode 100644 index 9c7201313..000000000 --- a/src/content/docs/sdk/windows/reference/adjust/device-info.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: Device information methods -description: Use these methods to retrieve device information. -slug: en/sdk/windows/reference/adjust/device-info -sidebar-position: 2 ---- - -Use these methods to retrieve device information. - - - -## GetAdid - -Returns the ADID (Adjust Device ID) associated with the device. - - - -import AdidSig from "@windows-signatures/Adjust/GetAdid.mdx"; - - - - - - - -import Adid from "@windows-examples/Adjust/GetAdid.mdx"; - - - - - - - -`adid` (String): The Adjust identifier associated with the device - - - - - - - -## GetWindowsAdId - -Returns the Windows ADID (Advertising ID) associated with the device. - - - -import GetWindowsAdId from "@windows-signatures/Adjust/GetWindowsAdId.mdx"; - - - - - - - -import WindowsAdId from "@windows-examples/Adjust/GetWindowsAdId.mdx"; - - - - - - - -`Windows ADID` (String): The device Windows ADID - - - - diff --git a/src/content/docs/sdk/windows/reference/adjust/index.mdx b/src/content/docs/sdk/windows/reference/adjust/index.mdx deleted file mode 100644 index 686e172ad..000000000 --- a/src/content/docs/sdk/windows/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/windows/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/windows/reference/adjust/privacy.mdx b/src/content/docs/sdk/windows/reference/adjust/privacy.mdx deleted file mode 100644 index 78ad84c03..000000000 --- a/src/content/docs/sdk/windows/reference/adjust/privacy.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Privacy methods -description: Use these methods to handle user privacy in your app. -slug: en/sdk/windows/reference/adjust/privacy -sidebar-position: 3 ---- - -Use these methods to handle user privacy in your app. - - - -## 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 "@windows-signatures/Adjust/GdprForgetMe.mdx"; - - - - - - - -import GdprForgetMe from "@windows-examples/Adjust/GdprForgetMe.mdx"; - - - - - - diff --git a/src/content/docs/sdk/windows/reference/adjust/recording.mdx b/src/content/docs/sdk/windows/reference/adjust/recording.mdx deleted file mode 100644 index 78d60b1e6..000000000 --- a/src/content/docs/sdk/windows/reference/adjust/recording.mdx +++ /dev/null @@ -1,240 +0,0 @@ ---- -title: Recording methods -description: Use these methods to send information about your app to Adjust. -slug: en/sdk/windows/reference/adjust/recording -sidebar-position: 4 ---- - -Use these methods to send information about your app to Adjust. - - - -## TrackEvent - -Record event information using an `AdjustEvent` object and an [Adjust event token](https://help.adjust.com/en/article/add-events#add-event). - - - -import TrackEventSig from "@windows-signatures/Adjust/TrackEvent.mdx"; - - - - - - - -import TrackEvent from "@windows-examples/Adjust/TrackEvent.mdx"; - - - - - - - -`event` (AdjustEvent): An event object containing the information you want to record. - - - - - - - -## 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 "@windows-signatures/Adjust/AddSessionCallbackParameter.mdx"; - - - - - - - -import AddSessionCallbackParameter from "@windows-examples/Adjust/AddSessionCallbackParameter.mdx"; - - - - - - - -`key` (String): The data key - -`value` (String): The data value - - - - - - - -## RemoveSessionCallbackParameter - -Remove a session callback parameter. - - - -import RemoveSessionCallbackParameterSig from "@windows-signatures/Adjust/RemoveSessionCallbackParameter.mdx"; - - - - - - - -import RemoveSessionCallbackParameter from "@windows-examples/Adjust/RemoveSessionCallbackParameter.mdx"; - - - - - - - -`key` (String): The data key of the parameter you want to remove. - - - - - - - -## ResetSessionCallbackParameters - -Removes all session callback parameters. - - - -import ResetSessionCallbackParametersSig from "@windows-signatures/Adjust/ResetSessionCallbackParameters.mdx"; - - - - - - - -import ResetSessionCallbackParameters from "@windows-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 "@windows-signatures/Adjust/AddSessionPartnerParameter.mdx"; - - - - - - - -import AddSessionPartnerParameter from "@windows-examples/Adjust/AddSessionPartnerParameter.mdx"; - - - - - - - -`key` (String): The data key - -`value` (String): The data value - - - - - - - -## RemoveSessionPartnerParameter - -Remove a session partner parameter. - - - -import RemoveSessionPartnerParameterSig from "@windows-signatures/Adjust/RemoveSessionPartnerParameter.mdx"; - - - - - - - -import RemoveSessionPartnerParameter from "@windows-examples/Adjust/RemoveSessionPartnerParameter.mdx"; - - - - - - - -`key` (String): The data key of the parameter you want to remove. - - - - - - - -## resetSessionPartnerParameters - -Removes all session partner parameters. - - - -import ResetSessionPartnerParametersSig from "@windows-signatures/Adjust/ResetSessionPartnerParameters.mdx"; - - - - - - - -import ResetSessionPartnerParameters from "@windows-examples/Adjust/ResetSessionPartnerParameters.mdx"; - - - - - - - - - -## getAttribution - -Fetches attribution data about the device. - - - -import AttributionSig from "@windows-signatures/Adjust/GetAttribution.mdx"; - - - - - - - -import Attribution from "@windows-examples/Adjust/GetAttribution.mdx"; - - - - - - - -`attribution` (ADJAttribution): An attribution object containing attribution data associated with the device. - - - - diff --git a/src/content/docs/sdk/windows/reference/adjustattribution.mdx b/src/content/docs/sdk/windows/reference/adjustattribution.mdx deleted file mode 100644 index 1e22855ad..000000000 --- a/src/content/docs/sdk/windows/reference/adjustattribution.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: AdjustAttribution class -description: Use this class to see attribution information. -category-title: AdjustAttribution class -slug: en/sdk/windows/reference/adjustattribution ---- - -import GetAttribution from "@windows-signatures/Adjust/GetAttribution.mdx"; - -The `AdjustAttribution` class contains details about the current attribution status of the device. - -## Properties - -The following properties can be accessed by calling the `GetAttribution` method. Any values that aren't populated for the user are returned as a null value. - - - -| 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 | - -
diff --git a/src/content/docs/sdk/windows/reference/adjustconfig/index.mdx b/src/content/docs/sdk/windows/reference/adjustconfig/index.mdx deleted file mode 100644 index 8a9221e7b..000000000 --- a/src/content/docs/sdk/windows/reference/adjustconfig/index.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: AdjustConfig class -description: Use the methods in this class to set up the Adjust SDK. -category-title: AdjustConfig class -slug: en/sdk/windows/reference/adjustconfig -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 "@windows-signatures/AdjustConfig/constructor.mdx"; - - - - - - - -import Constructor from "@windows-examples/AdjustConfig/constructor.mdx"; - - - - - - - -`appToken` (String): Your Adjust app token. - -`environment` (String): The environment your app is running in. - -`logDelegate` (String): A function to which logging is delegated. - -`logLevel` (LogLevel): The verbosity of logging - - - - - -`config` (AdjustConfig): A config object initialized with the provided params. - - - - diff --git a/src/content/docs/sdk/windows/reference/adjustconfig/setup.mdx b/src/content/docs/sdk/windows/reference/adjustconfig/setup.mdx deleted file mode 100644 index 4b2b30ead..000000000 --- a/src/content/docs/sdk/windows/reference/adjustconfig/setup.mdx +++ /dev/null @@ -1,376 +0,0 @@ ---- -title: Setup methods -description: Configure these properties to set up the Adjust SDK. -slug: en/sdk/windows/reference/AdjustConfig/setup -sidebar-position: 1 ---- - -Configure these properties to set up the Adjust SDK. - - - -## setLogDelegate - -Set the verbosity of logs you want to receive from the Adjust SDK. - - - -import SetLogDelegateSig from "@windows-signatures/AdjustConfig/setLogDelegate.mdx"; - - - - - - - -`logDelegate` (Action): The delegate function or program that handles log output. - -`logLevel` (LogLevel): The level of logging output by the SDK. - - - - - -import SetLogDelegate from "@windows-examples/AdjustConfig/setLogDelegate.mdx"; - - - - - - - - - -## DefaultTracker - -Sets a default token to record installs against. - - - -import DefaultTrackerSig from "@windows-signatures/AdjustConfig/DefaultTracker.mdx"; - - - - - - - -import SetDefaultTracker from "@windows-examples/AdjustConfig/DefaultTracker.mdx"; - - - - - - - -`defaultTracker` (String): The token to which all preinstalled sessions are attributed. - - - - - - - -## SendInBackground - -Sets whether the SDK should send data while the app is running in the background. - - - -import SendInBackgroundSig from "@windows-signatures/AdjustConfig/SendInBackground.mdx"; - - - - - - - -import SendInBackground from "@windows-examples/AdjustConfig/SendInBackground.mdx"; - - - - - - - -`SendInBackground` (BOOL): Whether the SDK should send information to Adjust when the app is running in the background. - - - - - - - -## SessionTrackingSucceeded - -Sets up a success callback to trigger a function when the SDK records a session. - - - -import SessionTrackingSucceededSig from "@windows-signatures/AdjustConfig/SessionTrackingSucceeded.mdx"; - - - - - - - -import SessionTrackingSucceeded from "@windows-examples/AdjustConfig/SessionTrackingSucceeded.mdx"; - - - - - - - -`AdjustSessionSuccess` (Action): The function to launch when the SDK successfully records a session. - - - - - - - -## SessionTrackingFailed - -Sets up a callback to trigger a function when the SDK fails to record a session. - - - -import SessionTrackingFailedSig from "@windows-signatures/AdjustConfig/SessionTrackingFailed.mdx"; - - - - - - - -import SessionTrackingFailed from "@windows-examples/AdjustConfig/SessionTrackingFailed.mdx"; - - - - - - - -`AdjustSessionFailed` (Action): The function to launch when the SDK fails to record a session. - - - - - - - -## EventTrackingSucceeded - -Sets up a success callback to trigger a function when the SDK records an event. - - - -import EventTrackingSucceededSig from "@windows-signatures/AdjustConfig/EventTrackingSucceeded.mdx"; - - - - - - - -import EventTrackingSucceeded from "@windows-examples/AdjustConfig/EventTrackingSucceeded.mdx"; - - - - - - - -`AdjustEventSuccess` (Action): The function to launch when the SDK successfully records an event. - - - - - - - -## EventTrackingFailed - -Sets up a callback to trigger a function when the SDK fails to record an event. - - - -import EventTrackingFailedSig from "@windows-signatures/AdjustConfig/EventTrackingFailed.mdx"; - - - - - - - -import EventTrackingFailed from "@windows-examples/AdjustConfig/EventTrackingFailed.mdx"; - - - - - - - -`AdjustEventFailed` (Action): The function to launch when the SDK fails to record an event. - - - - - - - -## DelayStart - -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 DelayStartSig from "@windows-signatures/AdjustConfig/DelayStart.mdx"; - - - - - - - -import DelayStart from "@windows-examples/AdjustConfig/DelayStart.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 "@windows-signatures/AdjustConfig/setExternalDeviceId.mdx"; - - - - - - - -import SetExternalDeviceId from "@windows-examples/AdjustConfig/setExternalDeviceId.mdx"; - - - - - - - -`externalDeviceId` (String): The external device ID associated with the device. - - - - - - - -## EventBufferingEnabled - -Sets event buffering. If enabled, the SDK stores events on the device and sends all requests once per minute. - - - -import EventBufferingEnabledSig from "@windows-signatures/AdjustConfig/EventBufferingEnabled.mdx"; - - - - - - - -`EventBufferingEnabled` (BOOL): Whether event buffering is enabled. - - - - - -import EventBufferingEnabled from "@windows-examples/AdjustConfig/EventBufferingEnabled.mdx"; - - - - - - - - - -## AttributionChanged - -Sets a delegate function that fires when a user's attribution information updates. - - - -import AttributionChangedSig from "@windows-signatures/AdjustConfig/AttributionChanged.mdx"; - - - - - - - -`AdjustAttribution` (Action): The delegate function that the SDK calls when a the user's attribution information changes. - - - - - -import AttributionChanged from "@windows-examples/AdjustConfig/AttributionChanged.mdx"; - - - - - - - - - -## DeeplinkResponse - -Enables or disables launching deferred deep links with the SDK. If enabled, the SDK launches deep links the user interacts with. - - - -import DeeplinkResponseSig from "@windows-signatures/AdjustConfig/DeeplinkResponse.mdx"; - - - - - - - -`DeeplinkResponse` (Func): The function to call on receipt of a deferred deep link. - - - - - -import DeeplinkResponse from "@windows-examples/AdjustConfig/DeeplinkResponse.mdx"; - - - - - - diff --git a/src/content/docs/sdk/windows/reference/adjustevent.mdx b/src/content/docs/sdk/windows/reference/adjustevent.mdx deleted file mode 100644 index 58adae033..000000000 --- a/src/content/docs/sdk/windows/reference/adjustevent.mdx +++ /dev/null @@ -1,198 +0,0 @@ ---- -title: AdjustEvent class -description: Record information about events to send to Adjust. -category-title: AdjustEvent class -slug: en/sdk/windows/reference/adjustevent ---- - -import TrackEvent from "@windows-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 `AdjustEvent` object to the `TrackEvent` method. - - - -## Constructor - -Instantiates an event object with an Adjust event token. - - - -import ConstructorSig from "@windows-signatures/AdjustEvent/Constructor.mdx"; - - - - - - - -`event` (AdjustEvent): An event object containing information you want to record. - -`eventToken` (String): A 6 character Adjust event token. - - - - - -import Constructor from "@windows-examples/Adjust/TrackEvent.mdx"; - - - - - - - - - -## SetRevenue - -Sets the revenue and currency associated with an event. - - - -import SetRevenueSig from "@windows-signatures/AdjustEvent/SetRevenue.mdx"; - - - - - - - -import SetRevenue from "@windows-examples/AdjustEvent/SetRevenue.mdx"; - - - - - - - -`amount` (double): The amount of currency units associated with the event. - -`currency` (String): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of the currency unit. - - - - - - - -## AddCallbackParameter - -Adds key-value information to send to your callback URL. - - - -import AddCallbackParameterSig from "@windows-signatures/AdjustEvent/AddCallbackParameter.mdx"; - - - - - - - -import AddCallbackParameter from "@windows-examples/AdjustEvent/AddCallbackParameter.mdx"; - - - - - - - -`key` (String): The data key. - -`value` (String): The data value. - - - - - - - -## AddPartnerParameter - -Adds key-value information to share with partners. - - - -import AddPartnerParameterSig from "@windows-signatures/AdjustEvent/AddPartnerParameter.mdx"; - - - - - - - -import AddPartnerParameter from "@windows-examples/AdjustEvent/AddPartnerParameter.mdx"; - - - - - - - -`key` (String): The data key. - -`value` (String): The data value. - - - - - - - -## PurchaseId - -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 PurchaseIdSig from "@windows-signatures/AdjustEvent/PurchaseId.mdx"; - - - - - - - -import PurchaseId from "@windows-examples/AdjustEvent/PurchaseId.mdx"; - - - - - - - -`PurchaseId` (String): A unique identifier used to deduplicate events. - - - - - - - -## CallbackId - -Sets a custom identifier for your event object. Adjust's servers can report on this identifier in event callbacks. - - - -import CallbackIdSig from "@windows-signatures/AdjustEvent/CallbackId.mdx"; - - - - - - - -import CallbackId from "@windows-examples/AdjustEvent/CallbackId.mdx"; - - - - - - - -`CallbackId` (String): A custom identifier for your event object. - - - - diff --git a/src/content/docs/sdk/windows/reference/index.mdx b/src/content/docs/sdk/windows/reference/index.mdx deleted file mode 100644 index d38e23227..000000000 --- a/src/content/docs/sdk/windows/reference/index.mdx +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: SDK reference -description: SDK reference information for the Windows SDK -category-title: Reference -slug: en/sdk/windows/reference -type: category ---- From 1cc8d16936232b623972ade1ed4336cbe4479630 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Sat, 24 Feb 2024 21:38:29 +0100 Subject: [PATCH 6/8] Update iOS documentation --- .../ADJAdRevenue/addCallbackParameter.mdx | 20 - .../ADJAdRevenue/addPartnerParameter.mdx | 20 - .../ios/examples/ADJAdRevenue/constructor.mdx | 20 - .../ADJAdRevenue/setAdImpressionsCount.mdx | 20 - .../ADJAdRevenue/setAdRevenueNetwork.mdx | 20 - .../ADJAdRevenue/setAdRevenuePlacement.mdx | 20 - .../ADJAdRevenue/setAdRevenueUnit.mdx | 20 - .../ios/examples/ADJAdRevenue/setRevenue.mdx | 20 - .../ios/examples/ADJConfig/constructor.mdx | 34 - .../deactivateSKAdNetworkHandling.mdx | 28 - .../examples/ADJConfig/sendInBackground.mdx | 40 -- .../setAllowAdServicesInfoReading.mdx | 27 - .../ADJConfig/setAllowIdfaReading.mdx | 27 - .../examples/ADJConfig/setDefaultTracker.mdx | 37 -- .../ios/examples/ADJConfig/setDelayStart.mdx | 39 -- .../ios/examples/ADJConfig/setDelegate.mdx | 49 -- .../ADJConfig/setEventBufferingEnabled.mdx | 37 -- .../ADJConfig/setExternalDeviceId.mdx | 39 -- .../examples/ADJConfig/setLinkMeEnabled.mdx | 40 -- .../ios/examples/ADJConfig/setLogLevel.mdx | 40 -- .../ios/examples/ADJConfig/setNeedsCost.mdx | 39 -- .../ios/examples/ADJConfig/setUrlStrategy.mdx | 40 -- .../ADJEvent/addCallbackParameter.mdx | 32 - .../examples/ADJEvent/addPartnerParameter.mdx | 32 - .../ios/examples/ADJEvent/constructor.mdx | 26 - .../ios/examples/ADJEvent/setCallbackId.mdx | 29 - .../ios/examples/ADJEvent/setRevenue.mdx | 29 - .../examples/ADJEvent/setTransactionId.mdx | 29 - .../ADJLinkResolution/resolveLinkWithUrl.mdx | 27 - .../ADJSubscription/addCallbackParameter.mdx | 29 - .../ADJSubscription/addPartnerParameter.mdx | 29 - .../examples/ADJSubscription/constructor.mdx | 23 - .../ADJSubscription/setSalesRegion.mdx | 27 - .../ADJSubscription/setTransactionDate.mdx | 27 - .../addGranularOption.mdx | 29 - .../addGranularOptionFacebook.mdx | 32 - .../addPartnerSharingSetting.mdx | 29 - .../initWithIsEnabledNumberBoolFalse.mdx | 26 - .../initWithIsEnabledNumberBoolTrue.mdx | 26 - .../Adjust/addSessionCallbackParameter.mdx | 3 - .../Adjust/addSessionPartnerParameter.mdx | 23 - .../ios/examples/Adjust/adid.mdx | 23 - .../Adjust/appTrackingAuthorizationStatus.mdx | 24 - .../ios/examples/Adjust/appWillOpenUrl.mdx | 16 - .../ios/examples/Adjust/attribution.mdx | 23 - .../examples/Adjust/checkForNewAttStatus.mdx | 16 - .../Adjust/disableThirdPartySharing.mdx | 23 - .../ios/examples/Adjust/gdprForgetMe.mdx | 23 - .../ios/examples/Adjust/idfa.mdx | 25 - .../ios/examples/Adjust/isEnabled.mdx | 23 - .../Adjust/removeSessionCallbackParameter.mdx | 23 - .../Adjust/removeSessionPartnerParameter.mdx | 23 - .../Adjust/requestTrackingAuthorization.mdx | 48 -- .../Adjust/resetSessionCallbackParameters.mdx | 23 - .../Adjust/resetSessionPartnerParameters.mdx | 23 - .../ios/examples/Adjust/sendFirstPackages.mdx | 23 - .../ios/examples/Adjust/setDeviceToken.mdx | 27 - .../ios/examples/Adjust/setEnabled.mdx | 23 - .../ios/examples/Adjust/setOfflineMode.mdx | 24 - .../ios/examples/Adjust/trackAdRevenue.mdx | 19 - .../ios/examples/Adjust/trackEvent.mdx | 26 - .../Adjust/trackMeasurementConsent.mdx | 23 - .../ios/examples/Adjust/trackSubscription.mdx | 50 -- .../Adjust/trackThirdPartySharing.mdx | 26 - .../examples/Adjust/updateConversionValue.mdx | 16 - .../ADJAdRevenue/addCallbackParameter.mdx | 3 - .../ADJAdRevenue/addPartnerParameter.mdx | 3 - .../signatures/ADJAdRevenue/constructor.mdx | 3 - .../ADJAdRevenue/setAdImpressionsCount.mdx | 3 - .../ADJAdRevenue/setAdRevenueNetwork.mdx | 3 - .../ADJAdRevenue/setAdRevenuePlacement.mdx | 3 - .../ADJAdRevenue/setAdRevenueUnit.mdx | 3 - .../signatures/ADJAdRevenue/setRevenue.mdx | 3 - .../ios/signatures/ADJConfig/constructor.mdx | 5 - .../deactivateSKAdNetworkHandling.mdx | 3 - .../setAllowAdServicesInfoReading.mdx | 3 - .../ADJConfig/setAllowIdfaReading.mdx | 3 - .../ADJConfig/setDefaultTracker.mdx | 3 - .../signatures/ADJConfig/setDelayStart.mdx | 3 - .../ios/signatures/ADJConfig/setDelegate.mdx | 3 - .../ADJConfig/setEventBufferingEnabled.mdx | 3 - .../ADJConfig/setExternalDeviceId.mdx | 3 - .../signatures/ADJConfig/setLinkMeEnabled.mdx | 3 - .../ios/signatures/ADJConfig/setLogLevel.mdx | 3 - .../ios/signatures/ADJConfig/setNeedsCost.mdx | 3 - .../ADJConfig/setSendInBackground.mdx | 3 - .../signatures/ADJConfig/setUrlStrategy.mdx | 3 - .../ADJEvent/addCallbackParameter.mdx | 3 - .../ADJEvent/addPartnerParameter.mdx | 3 - .../ios/signatures/ADJEvent/constructor.mdx | 3 - .../ios/signatures/ADJEvent/setCallbackId.mdx | 3 - .../ios/signatures/ADJEvent/setRevenue.mdx | 3 - .../signatures/ADJEvent/setTransactionId.mdx | 3 - .../ADJLinkResolution/resolveLinkWithUrl.mdx | 5 - .../ADJSubscription/addCallbackParameter.mdx | 3 - .../ADJSubscription/addPartnerParameter.mdx | 3 - .../ADJSubscription/constructor.mdx | 6 - .../ADJSubscription/setSalesRegion.mdx | 3 - .../ADJSubscription/setTransactionDate.mdx | 3 - .../addGranularOption.mdx | 5 - .../addPartnerSharingSetting.mdx | 5 - .../ADJThirdPartySharing/constructor.mdx | 3 - .../Adjust/addSessionCallbackParameter.mdx | 3 - .../Adjust/addSessionPartnerParameter.mdx | 3 - .../ios/signatures/Adjust/adid.mdx | 3 - .../Adjust/appTrackingAuthorizationStatus.mdx | 3 - .../ios/signatures/Adjust/appWillOpenUrl.mdx | 3 - .../ios/signatures/Adjust/attribution.mdx | 3 - .../Adjust/checkForNewAttStatus.mdx | 3 - .../Adjust/disableThirdPartySharing.mdx | 3 - .../ios/signatures/Adjust/gdprForgetMe.mdx | 3 - .../ios/signatures/Adjust/idfa.mdx | 3 - .../ios/signatures/Adjust/isEnabled.mdx | 3 - .../Adjust/removeSessionCallbackParameter.mdx | 3 - .../Adjust/removeSessionPartnerParameter.mdx | 3 - .../Adjust/requestTrackingAuthorization.mdx | 3 - .../Adjust/resetSessionCallbackParameters.mdx | 3 - .../Adjust/resetSessionPartnerParameters.mdx | 3 - .../signatures/Adjust/sendFirstPackages.mdx | 3 - .../ios/signatures/Adjust/setDeviceToken.mdx | 3 - .../ios/signatures/Adjust/setEnabled.mdx | 3 - .../ios/signatures/Adjust/setOfflineMode.mdx | 3 - .../ios/signatures/Adjust/trackAdRevenue.mdx | 3 - .../ios/signatures/Adjust/trackEvent.mdx | 3 - .../Adjust/trackMeasurementConsent.mdx | 3 - .../signatures/Adjust/trackSubscription.mdx | 3 - .../Adjust/trackThirdPartySharing.mdx | 3 - .../Adjust/updateConversionValue.mdx | 3 - src/content/docs/kitchen-sink/typography.mdx | 4 - .../docs/sdk/android/features/privacy.mdx | 96 +-- .../docs/sdk/flutter/features/privacy.mdx | 32 +- .../docs/sdk/flutter/features/skad.mdx | 3 +- src/content/docs/sdk/ios/configuration.mdx | 613 ++++++++++++++++++ .../docs/sdk/ios/configuration/background.mdx | 20 - .../ios/configuration/deep-links/index.mdx | 16 - .../docs/sdk/ios/configuration/delay.mdx | 30 - .../docs/sdk/ios/configuration/disable.mdx | 160 ----- .../ios/configuration/external-device-id.mdx | 40 -- .../docs/sdk/ios/configuration/index.mdx | 9 - .../docs/sdk/ios/configuration/log-level.mdx | 28 - .../sdk/ios/configuration/preinstalled.mdx | 28 - .../docs/sdk/ios/configuration/privacy.mdx | 149 ----- .../sdk/ios/configuration/push-tokens.mdx | 20 - .../docs/sdk/ios/features/ad-revenue.mdx | 285 ++++++-- .../ios/{configuration => features}/att.mdx | 117 +++- .../docs/sdk/ios/features/attribution.mdx | 126 +++- .../deep-links/data-points.mdx | 2 +- .../deep-links/deep-link.mdx | 2 +- .../deep-links/deferred.mdx | 50 +- .../deep-links/direct.mdx | 2 +- .../sdk/ios/features/deep-links/index.mdx | 14 + .../deep-links/resolution.mdx | 5 +- .../deep-links/testing.mdx | 6 +- .../docs/sdk/ios/features/device-info.mdx | 67 +- src/content/docs/sdk/ios/features/events.mdx | 300 +++++++-- src/content/docs/sdk/ios/features/index.mdx | 1 + .../docs/sdk/ios/features/preinstalled.mdx | 61 ++ src/content/docs/sdk/ios/features/privacy.mdx | 478 ++++++++++++++ .../sdk/ios/features/session-parameters.mdx | 273 +++++++- .../ios/{configuration => features}/skad.mdx | 69 +- .../docs/sdk/ios/features/subscriptions.mdx | 246 ++++++- src/content/docs/sdk/ios/index.mdx | 7 +- .../docs/sdk/ios/integrations/index.mdx | 1 + .../docs/sdk/ios/plugins/facebook-pixel.mdx | 2 +- src/content/docs/sdk/ios/plugins/index.mdx | 1 + .../docs/sdk/ios/reference/adjadrevenue.mdx | 269 -------- .../docs/sdk/ios/reference/adjattribution.mdx | 43 -- .../sdk/ios/reference/adjconfig/index.mdx | 54 -- .../sdk/ios/reference/adjconfig/setup.mdx | 438 ------------- .../docs/sdk/ios/reference/adjevent.mdx | 196 ------ .../sdk/ios/reference/adjlinkresolution.mdx | 42 -- .../sdk/ios/reference/adjsubscription.mdx | 168 ----- .../ios/reference/adjthirdpartysharing.mdx | 139 ---- .../docs/sdk/ios/reference/adjust/config.mdx | 158 ----- .../sdk/ios/reference/adjust/device-info.mdx | 74 --- .../docs/sdk/ios/reference/adjust/index.mdx | 9 - .../docs/sdk/ios/reference/adjust/privacy.mdx | 116 ---- .../sdk/ios/reference/adjust/recording.mdx | 330 ---------- .../sdk/ios/reference/adjust/skan-att.mdx | 122 ---- src/content/docs/sdk/ios/reference/index.mdx | 7 - .../sdk/react-native/features/privacy.mdx | 30 +- 181 files changed, 2603 insertions(+), 4931 deletions(-) delete mode 100644 src/code-snippets/ios/examples/ADJAdRevenue/addCallbackParameter.mdx delete mode 100644 src/code-snippets/ios/examples/ADJAdRevenue/addPartnerParameter.mdx delete mode 100644 src/code-snippets/ios/examples/ADJAdRevenue/constructor.mdx delete mode 100644 src/code-snippets/ios/examples/ADJAdRevenue/setAdImpressionsCount.mdx delete mode 100644 src/code-snippets/ios/examples/ADJAdRevenue/setAdRevenueNetwork.mdx delete mode 100644 src/code-snippets/ios/examples/ADJAdRevenue/setAdRevenuePlacement.mdx delete mode 100644 src/code-snippets/ios/examples/ADJAdRevenue/setAdRevenueUnit.mdx delete mode 100644 src/code-snippets/ios/examples/ADJAdRevenue/setRevenue.mdx delete mode 100644 src/code-snippets/ios/examples/ADJConfig/constructor.mdx delete mode 100644 src/code-snippets/ios/examples/ADJConfig/deactivateSKAdNetworkHandling.mdx delete mode 100644 src/code-snippets/ios/examples/ADJConfig/sendInBackground.mdx delete mode 100644 src/code-snippets/ios/examples/ADJConfig/setAllowAdServicesInfoReading.mdx delete mode 100644 src/code-snippets/ios/examples/ADJConfig/setAllowIdfaReading.mdx delete mode 100644 src/code-snippets/ios/examples/ADJConfig/setDefaultTracker.mdx delete mode 100644 src/code-snippets/ios/examples/ADJConfig/setDelayStart.mdx delete mode 100644 src/code-snippets/ios/examples/ADJConfig/setDelegate.mdx delete mode 100644 src/code-snippets/ios/examples/ADJConfig/setEventBufferingEnabled.mdx delete mode 100644 src/code-snippets/ios/examples/ADJConfig/setExternalDeviceId.mdx delete mode 100644 src/code-snippets/ios/examples/ADJConfig/setLinkMeEnabled.mdx delete mode 100644 src/code-snippets/ios/examples/ADJConfig/setLogLevel.mdx delete mode 100644 src/code-snippets/ios/examples/ADJConfig/setNeedsCost.mdx delete mode 100644 src/code-snippets/ios/examples/ADJConfig/setUrlStrategy.mdx delete mode 100644 src/code-snippets/ios/examples/ADJEvent/addCallbackParameter.mdx delete mode 100644 src/code-snippets/ios/examples/ADJEvent/addPartnerParameter.mdx delete mode 100644 src/code-snippets/ios/examples/ADJEvent/constructor.mdx delete mode 100644 src/code-snippets/ios/examples/ADJEvent/setCallbackId.mdx delete mode 100644 src/code-snippets/ios/examples/ADJEvent/setRevenue.mdx delete mode 100644 src/code-snippets/ios/examples/ADJEvent/setTransactionId.mdx delete mode 100644 src/code-snippets/ios/examples/ADJLinkResolution/resolveLinkWithUrl.mdx delete mode 100644 src/code-snippets/ios/examples/ADJSubscription/addCallbackParameter.mdx delete mode 100644 src/code-snippets/ios/examples/ADJSubscription/addPartnerParameter.mdx delete mode 100644 src/code-snippets/ios/examples/ADJSubscription/constructor.mdx delete mode 100644 src/code-snippets/ios/examples/ADJSubscription/setSalesRegion.mdx delete mode 100644 src/code-snippets/ios/examples/ADJSubscription/setTransactionDate.mdx delete mode 100644 src/code-snippets/ios/examples/ADJThirdPartySharing/addGranularOption.mdx delete mode 100644 src/code-snippets/ios/examples/ADJThirdPartySharing/addGranularOptionFacebook.mdx delete mode 100644 src/code-snippets/ios/examples/ADJThirdPartySharing/addPartnerSharingSetting.mdx delete mode 100644 src/code-snippets/ios/examples/ADJThirdPartySharing/initWithIsEnabledNumberBoolFalse.mdx delete mode 100644 src/code-snippets/ios/examples/ADJThirdPartySharing/initWithIsEnabledNumberBoolTrue.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/addSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/addSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/adid.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/appTrackingAuthorizationStatus.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/appWillOpenUrl.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/attribution.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/checkForNewAttStatus.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/disableThirdPartySharing.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/gdprForgetMe.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/idfa.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/isEnabled.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/removeSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/removeSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/requestTrackingAuthorization.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/resetSessionCallbackParameters.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/resetSessionPartnerParameters.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/sendFirstPackages.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/setDeviceToken.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/setEnabled.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/setOfflineMode.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/trackAdRevenue.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/trackEvent.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/trackMeasurementConsent.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/trackSubscription.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/trackThirdPartySharing.mdx delete mode 100644 src/code-snippets/ios/examples/Adjust/updateConversionValue.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJAdRevenue/addCallbackParameter.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJAdRevenue/addPartnerParameter.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJAdRevenue/constructor.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJAdRevenue/setAdImpressionsCount.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJAdRevenue/setAdRevenueNetwork.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJAdRevenue/setAdRevenuePlacement.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJAdRevenue/setAdRevenueUnit.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJAdRevenue/setRevenue.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJConfig/constructor.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJConfig/deactivateSKAdNetworkHandling.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJConfig/setAllowAdServicesInfoReading.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJConfig/setAllowIdfaReading.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJConfig/setDefaultTracker.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJConfig/setDelayStart.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJConfig/setDelegate.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJConfig/setEventBufferingEnabled.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJConfig/setExternalDeviceId.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJConfig/setLinkMeEnabled.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJConfig/setLogLevel.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJConfig/setNeedsCost.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJConfig/setSendInBackground.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJConfig/setUrlStrategy.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJEvent/addCallbackParameter.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJEvent/addPartnerParameter.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJEvent/constructor.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJEvent/setCallbackId.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJEvent/setRevenue.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJEvent/setTransactionId.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJLinkResolution/resolveLinkWithUrl.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJSubscription/addCallbackParameter.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJSubscription/addPartnerParameter.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJSubscription/constructor.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJSubscription/setSalesRegion.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJSubscription/setTransactionDate.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJThirdPartySharing/addGranularOption.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJThirdPartySharing/addPartnerSharingSetting.mdx delete mode 100644 src/code-snippets/ios/signatures/ADJThirdPartySharing/constructor.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/addSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/addSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/adid.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/appTrackingAuthorizationStatus.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/appWillOpenUrl.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/attribution.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/checkForNewAttStatus.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/disableThirdPartySharing.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/gdprForgetMe.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/idfa.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/isEnabled.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/removeSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/removeSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/requestTrackingAuthorization.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/resetSessionCallbackParameters.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/resetSessionPartnerParameters.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/sendFirstPackages.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/setDeviceToken.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/setEnabled.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/setOfflineMode.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/trackAdRevenue.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/trackEvent.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/trackMeasurementConsent.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/trackSubscription.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/trackThirdPartySharing.mdx delete mode 100644 src/code-snippets/ios/signatures/Adjust/updateConversionValue.mdx create mode 100644 src/content/docs/sdk/ios/configuration.mdx delete mode 100644 src/content/docs/sdk/ios/configuration/background.mdx delete mode 100644 src/content/docs/sdk/ios/configuration/deep-links/index.mdx delete mode 100644 src/content/docs/sdk/ios/configuration/delay.mdx delete mode 100644 src/content/docs/sdk/ios/configuration/disable.mdx delete mode 100644 src/content/docs/sdk/ios/configuration/external-device-id.mdx delete mode 100644 src/content/docs/sdk/ios/configuration/index.mdx delete mode 100644 src/content/docs/sdk/ios/configuration/log-level.mdx delete mode 100644 src/content/docs/sdk/ios/configuration/preinstalled.mdx delete mode 100644 src/content/docs/sdk/ios/configuration/privacy.mdx delete mode 100644 src/content/docs/sdk/ios/configuration/push-tokens.mdx rename src/content/docs/sdk/ios/{configuration => features}/att.mdx (54%) rename src/content/docs/sdk/ios/{configuration => features}/deep-links/data-points.mdx (98%) rename src/content/docs/sdk/ios/{configuration => features}/deep-links/deep-link.mdx (98%) rename src/content/docs/sdk/ios/{configuration => features}/deep-links/deferred.mdx (83%) rename src/content/docs/sdk/ios/{configuration => features}/deep-links/direct.mdx (99%) create mode 100644 src/content/docs/sdk/ios/features/deep-links/index.mdx rename src/content/docs/sdk/ios/{configuration => features}/deep-links/resolution.mdx (98%) rename src/content/docs/sdk/ios/{configuration => features}/deep-links/testing.mdx (98%) create mode 100644 src/content/docs/sdk/ios/features/preinstalled.mdx create mode 100644 src/content/docs/sdk/ios/features/privacy.mdx rename src/content/docs/sdk/ios/{configuration => features}/skad.mdx (89%) delete mode 100644 src/content/docs/sdk/ios/reference/adjadrevenue.mdx delete mode 100644 src/content/docs/sdk/ios/reference/adjattribution.mdx delete mode 100644 src/content/docs/sdk/ios/reference/adjconfig/index.mdx delete mode 100644 src/content/docs/sdk/ios/reference/adjconfig/setup.mdx delete mode 100644 src/content/docs/sdk/ios/reference/adjevent.mdx delete mode 100644 src/content/docs/sdk/ios/reference/adjlinkresolution.mdx delete mode 100644 src/content/docs/sdk/ios/reference/adjsubscription.mdx delete mode 100644 src/content/docs/sdk/ios/reference/adjthirdpartysharing.mdx delete mode 100644 src/content/docs/sdk/ios/reference/adjust/config.mdx delete mode 100644 src/content/docs/sdk/ios/reference/adjust/device-info.mdx delete mode 100644 src/content/docs/sdk/ios/reference/adjust/index.mdx delete mode 100644 src/content/docs/sdk/ios/reference/adjust/privacy.mdx delete mode 100644 src/content/docs/sdk/ios/reference/adjust/recording.mdx delete mode 100644 src/content/docs/sdk/ios/reference/adjust/skan-att.mdx delete mode 100644 src/content/docs/sdk/ios/reference/index.mdx 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" From 3a4861d41515d6622fc8b5eb697962e8a854fed5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Sat, 24 Feb 2024 22:05:13 +0100 Subject: [PATCH 7/8] Fix category page ordering --- src/components/Layout/PageContent/PageContent.astro | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/components/Layout/PageContent/PageContent.astro b/src/components/Layout/PageContent/PageContent.astro index 1bb6d5070..5b45ba894 100644 --- a/src/components/Layout/PageContent/PageContent.astro +++ b/src/components/Layout/PageContent/PageContent.astro @@ -18,6 +18,9 @@ type Props = { const { title, headings, childLinks } = Astro.props; const sortedLinks = childLinks.sort((a, b) => { + if (!a.position && !b.position) { + return 0; + } a.position = Number(a.position) || 0; b.position = Number(b.position) || 0; return a?.position > b?.position ? 1 : -1; From 7e06ce601c4e0b6afd31ad9a82a72bb5384017ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Sun, 25 Feb 2024 14:54:23 +0100 Subject: [PATCH 8/8] Update Unity documentation --- .../Adjust/addSessionCallbackParameter.mdx | 3 - .../Adjust/addSessionPartnerParameter.mdx | 3 - .../Adjust/appTrackingAuthorizationStatus.mdx | 3 - .../examples/Adjust/checkForNewAttStatus.mdx | 3 - .../Adjust/disableThirdPartySharing.mdx | 3 - .../unity/examples/Adjust/gdprForgetMe.mdx | 3 - .../unity/examples/Adjust/getAdid.mdx | 3 - .../unity/examples/Adjust/getAmazonAdId.mdx | 3 - .../unity/examples/Adjust/getAttribution.mdx | 3 - .../unity/examples/Adjust/getGoogleAdId.mdx | 5 - .../unity/examples/Adjust/getIdfa.mdx | 3 - .../unity/examples/Adjust/isEnabled.mdx | 3 - .../Adjust/removeSessionCallbackParameter.mdx | 3 - .../Adjust/removeSessionPartnerParameter.mdx | 3 - .../Adjust/requestTrackingAuthorization.mdx | 20 - .../Adjust/resetSessionCallbackParameters.mdx | 3 - .../Adjust/resetSessionPartnerParameters.mdx | 3 - .../examples/Adjust/sendFirstPackages.mdx | 3 - .../unity/examples/Adjust/setDeviceToken.mdx | 3 - .../unity/examples/Adjust/setEnabled.mdx | 3 - .../unity/examples/Adjust/setOfflineMode.mdx | 3 - .../unity/examples/Adjust/trackAdRevenue.mdx | 5 - .../Adjust/trackAppStoreSubscription.mdx | 15 - .../unity/examples/Adjust/trackEvent.mdx | 5 - .../Adjust/trackMeasurementConsent.mdx | 3 - .../Adjust/trackPlayStoreSubscription.mdx | 16 - .../Adjust/trackThirdPartySharing.mdx | 5 - .../examples/Adjust/updateConversionValue.mdx | 3 - .../AdjustAdRevenue/addCallbackParameter.mdx | 7 - .../AdjustAdRevenue/addPartnerParameter.mdx | 7 - .../examples/AdjustAdRevenue/constructor.mdx | 4 - .../AdjustAdRevenue/setAdImpressionsCount.mdx | 7 - .../AdjustAdRevenue/setAdRevenueNetwork.mdx | 7 - .../AdjustAdRevenue/setAdRevenuePlacement.mdx | 7 - .../AdjustAdRevenue/setAdRevenueUnit.mdx | 7 - .../examples/AdjustAdRevenue/setRevenue.mdx | 7 - .../addCallbackParameter.mdx | 10 - .../addPartnerParameter.mdx | 10 - .../adjustAppStoreSubscription.mdx | 7 - .../setSalesRegion.mdx | 9 - .../setTransactionDate.mdx | 9 - .../examples/AdjustConfig/constructor.mdx | 5 - .../deactivateSKAdNetworkHandling.mdx | 7 - .../AdjustConfig/sendInBackground.mdx | 7 - .../setAttributionChangedDelegate.mdx | 19 - .../setConversionValueUpdatedDelegate.mdx | 7 - .../AdjustConfig/setCoppaCompliantEnabled.mdx | 5 - .../AdjustConfig/setDefaultTracker.mdx | 7 - .../examples/AdjustConfig/setDelayStart.mdx | 7 - .../AdjustConfig/setEventBufferingEnabled.mdx | 7 - .../AdjustConfig/setEventFailureDelegate.mdx | 11 - .../AdjustConfig/setEventSuccessDelegate.mdx | 11 - .../AdjustConfig/setExternalDeviceId.mdx | 7 - .../setLaunchDeferredDeeplink.mdx | 7 - .../AdjustConfig/setLinkMeEnabled.mdx | 7 - .../examples/AdjustConfig/setLogDelegate.mdx | 7 - .../examples/AdjustConfig/setLogLevel.mdx | 7 - .../examples/AdjustConfig/setNeedsCost.mdx | 5 - .../AdjustConfig/setPreinstallFilePath.mdx | 7 - .../setPreinstallTrackingEnabled.mdx | 7 - .../setSessionFailureDelegate.mdx | 11 - .../setSessionSuccessDelegate.mdx | 11 - .../examples/AdjustConfig/setUrlStrategy.mdx | 5 - .../AdjustEvent/addCallbackParameter.mdx | 7 - .../AdjustEvent/addPartnerParameter.mdx | 7 - .../examples/AdjustEvent/constructor.mdx | 5 - .../examples/AdjustEvent/setCallbackId.mdx | 7 - .../unity/examples/AdjustEvent/setRevenue.mdx | 7 - .../examples/AdjustEvent/setTransactionId.mdx | 7 - .../addCallbackParameter.mdx | 12 - .../addPartnerParameter.mdx | 12 - .../adjustPlayStoreSubscription.mdx | 9 - .../setPurchaseTime.mdx | 10 - .../addGranularOption.mdx | 7 - .../addGranularOptionFacebook.mdx | 8 - .../addPartnerSharingSetting.mdx | 6 - .../AdjustThirdPartySharing/initFalse.mdx | 5 - .../AdjustThirdPartySharing/initTrue.mdx | 5 - .../Adjust/addSessionCallbackParameter.mdx | 3 - .../Adjust/addSessionPartnerParameter.mdx | 3 - .../Adjust/appTrackingAuthorizationStatus.mdx | 3 - .../Adjust/checkForNewAttStatus.mdx | 3 - .../Adjust/disableThirdPartySharing.mdx | 3 - .../unity/signatures/Adjust/gdprForgetMe.mdx | 3 - .../unity/signatures/Adjust/getAdid.mdx | 3 - .../unity/signatures/Adjust/getAmazonAdId.mdx | 3 - .../signatures/Adjust/getAttribution.mdx | 3 - .../unity/signatures/Adjust/getGoogleAdId.mdx | 3 - .../unity/signatures/Adjust/getIdfa.mdx | 3 - .../unity/signatures/Adjust/isEnabled.mdx | 3 - .../Adjust/removeSessionCallbackParameter.mdx | 3 - .../Adjust/removeSessionPartnerParameter.mdx | 3 - .../Adjust/requestTrackingAuthorization.mdx | 3 - .../Adjust/resetSessionCallbackParameters.mdx | 3 - .../Adjust/resetSessionPartnerParameters.mdx | 3 - .../signatures/Adjust/sendFirstPackages.mdx | 3 - .../signatures/Adjust/setDeviceToken.mdx | 3 - .../unity/signatures/Adjust/setEnabled.mdx | 3 - .../signatures/Adjust/setOfflineMode.mdx | 3 - .../signatures/Adjust/trackAdRevenue.mdx | 3 - .../Adjust/trackAppStoreSubscription.mdx | 3 - .../unity/signatures/Adjust/trackEvent.mdx | 3 - .../Adjust/trackMeasurementConsent.mdx | 3 - .../Adjust/trackPlayStoreSubscription.mdx | 3 - .../Adjust/trackThirdPartySharing.mdx | 3 - .../Adjust/updateConversionValue.mdx | 3 - .../AdjustAdRevenue/addCallbackParameter.mdx | 3 - .../AdjustAdRevenue/addPartnerParameter.mdx | 3 - .../AdjustAdRevenue/constructor.mdx | 3 - .../AdjustAdRevenue/setAdImpressionsCount.mdx | 3 - .../AdjustAdRevenue/setAdRevenueNetwork.mdx | 3 - .../AdjustAdRevenue/setAdRevenuePlacement.mdx | 3 - .../AdjustAdRevenue/setAdRevenueUnit.mdx | 3 - .../signatures/AdjustAdRevenue/setRevenue.mdx | 3 - .../addCallbackParameter.mdx | 3 - .../addPartnerParameter.mdx | 3 - .../constructor.mdx | 3 - .../setSalesRegion.mdx | 3 - .../setTransactionDate.mdx | 3 - .../signatures/AdjustConfig/constructor.mdx | 3 - .../deactivateSKAdNetworkHandling.mdx | 3 - .../AdjustConfig/sendInBackground.mdx | 3 - .../setAttributionChangedDelegate.mdx | 3 - .../setConversionValueUpdatedDelegate.mdx | 3 - .../AdjustConfig/setCoppaCompliantEnabled.mdx | 3 - .../AdjustConfig/setDefaultTracker.mdx | 3 - .../signatures/AdjustConfig/setDelayStart.mdx | 3 - .../AdjustConfig/setEventBufferingEnabled.mdx | 3 - .../AdjustConfig/setEventFailureDelegate.mdx | 3 - .../AdjustConfig/setEventSuccessDelegate.mdx | 3 - .../AdjustConfig/setExternalDeviceId.mdx | 3 - .../setLaunchDeferredDeeplink.mdx | 3 - .../AdjustConfig/setLinkMeEnabled.mdx | 3 - .../AdjustConfig/setLogDelegate.mdx | 3 - .../signatures/AdjustConfig/setLogLevel.mdx | 3 - .../signatures/AdjustConfig/setNeedsCost.mdx | 3 - .../AdjustConfig/setPreinstallFilePath.mdx | 3 - .../setPreinstallTrackingEnabled.mdx | 3 - .../setSessionFailureDelegate.mdx | 3 - .../setSessionSuccessDelegate.mdx | 3 - .../AdjustConfig/setUrlStrategy.mdx | 3 - .../AdjustEvent/addCallbackParameter.mdx | 3 - .../AdjustEvent/addPartnerParameter.mdx | 3 - .../signatures/AdjustEvent/constructor.mdx | 7 - .../signatures/AdjustEvent/setCallbackId.mdx | 3 - .../signatures/AdjustEvent/setRevenue.mdx | 3 - .../AdjustEvent/setTransactionId.mdx | 3 - .../addCallbackParameter.mdx | 3 - .../addPartnerParameter.mdx | 3 - .../constructor.mdx | 3 - .../setPurchaseTime.mdx | 3 - .../addGranularOption.mdx | 3 - .../addPartnerSharingSetting.mdx | 3 - .../AdjustThirdPartySharing/constructor.mdx | 8 - .../docs/sdk/android/setup/preinstalled.mdx | 4 +- src/content/docs/sdk/unity/configuration.mdx | 266 ++++++++ .../sdk/unity/configuration/background.mdx | 20 - .../docs/sdk/unity/configuration/delay.mdx | 30 - .../docs/sdk/unity/configuration/disable.mdx | 50 -- .../configuration/external-device-id.mdx | 40 -- .../docs/sdk/unity/configuration/index.mdx | 9 - .../sdk/unity/configuration/log-level.mdx | 56 -- .../sdk/unity/configuration/push-tokens.mdx | 22 - .../docs/sdk/unity/features/ad-revenue.mdx | 162 +++-- .../unity/{configuration => features}/att.mdx | 57 +- .../docs/sdk/unity/features/attribution.mdx | 76 ++- .../docs/sdk/unity/features/callbacks.mdx | 81 ++- .../deep-links.mdx | 50 +- .../docs/sdk/unity/features/device-info.mdx | 51 +- .../docs/sdk/unity/features/events.mdx | 139 +++- src/content/docs/sdk/unity/features/index.mdx | 1 + .../preinstalled.mdx | 43 +- .../{configuration => features}/privacy.mdx | 175 +++-- .../sdk/unity/features/session-parameters.mdx | 99 ++- .../{configuration => features}/skad.mdx | 51 +- .../docs/sdk/unity/features/subscriptions.mdx | 211 ++++-- src/content/docs/sdk/unity/index.mdx | 2 +- .../docs/sdk/unity/integrations/admob.mdx | 2 +- .../docs/sdk/unity/integrations/applovin.mdx | 2 +- .../docs/sdk/unity/integrations/helium.mdx | 2 +- .../docs/sdk/unity/integrations/index.mdx | 1 + .../sdk/unity/integrations/ironsource.mdx | 2 +- .../docs/sdk/unity/integrations/unity.mdx | 2 +- src/content/docs/sdk/unity/plugins/imei.mdx | 4 +- src/content/docs/sdk/unity/plugins/index.mdx | 1 + src/content/docs/sdk/unity/plugins/oaid.mdx | 4 +- .../sdk/unity/reference/adjust/config.mdx | 157 ----- .../unity/reference/adjust/device-info.mdx | 134 ---- .../docs/sdk/unity/reference/adjust/index.mdx | 9 - .../sdk/unity/reference/adjust/privacy.mdx | 116 ---- .../sdk/unity/reference/adjust/recording.mdx | 330 ---------- .../sdk/unity/reference/adjust/skan-att.mdx | 122 ---- .../sdk/unity/reference/adjustadrevenue.mdx | 269 -------- .../reference/adjustappstoresubscription.mdx | 170 ----- .../sdk/unity/reference/adjustattribution.mdx | 44 -- .../unity/reference/adjustconfig/index.mdx | 55 -- .../unity/reference/adjustconfig/privacy.mdx | 79 --- .../unity/reference/adjustconfig/setup.mdx | 604 ------------------ .../docs/sdk/unity/reference/adjustevent.mdx | 196 ------ .../reference/adjustplaystoresubscription.mdx | 145 ----- .../reference/adjustthirdpartysharing.mdx | 139 ---- .../docs/sdk/unity/reference/index.mdx | 7 - .../docs/sdk/windows/configuration.mdx | 44 +- .../docs/sdk/windows/features/attribution.mdx | 10 +- .../docs/sdk/windows/features/callbacks.mdx | 24 +- .../docs/sdk/windows/features/deep-links.mdx | 8 +- .../docs/sdk/windows/features/device-info.mdx | 8 +- .../docs/sdk/windows/features/events.mdx | 40 +- .../sdk/windows/features/preinstalled.mdx | 2 +- .../docs/sdk/windows/features/privacy.mdx | 4 +- .../windows/features/session-parameters.mdx | 28 +- src/content/docs/sdk/windows/index.mdx | 4 +- 212 files changed, 1265 insertions(+), 3955 deletions(-) delete mode 100644 src/code-snippets/unity/examples/Adjust/addSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/addSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/appTrackingAuthorizationStatus.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/checkForNewAttStatus.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/disableThirdPartySharing.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/gdprForgetMe.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/getAdid.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/getAmazonAdId.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/getAttribution.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/getGoogleAdId.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/getIdfa.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/isEnabled.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/removeSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/removeSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/requestTrackingAuthorization.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/resetSessionCallbackParameters.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/resetSessionPartnerParameters.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/sendFirstPackages.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/setDeviceToken.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/setEnabled.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/setOfflineMode.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/trackAdRevenue.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/trackAppStoreSubscription.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/trackEvent.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/trackMeasurementConsent.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/trackPlayStoreSubscription.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/trackThirdPartySharing.mdx delete mode 100644 src/code-snippets/unity/examples/Adjust/updateConversionValue.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustAdRevenue/addCallbackParameter.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustAdRevenue/addPartnerParameter.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustAdRevenue/constructor.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustAdRevenue/setAdImpressionsCount.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustAdRevenue/setAdRevenueNetwork.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustAdRevenue/setAdRevenuePlacement.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustAdRevenue/setAdRevenueUnit.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustAdRevenue/setRevenue.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustAppStoreSubscription/addCallbackParameter.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustAppStoreSubscription/addPartnerParameter.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustAppStoreSubscription/adjustAppStoreSubscription.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustAppStoreSubscription/setSalesRegion.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustAppStoreSubscription/setTransactionDate.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/constructor.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/deactivateSKAdNetworkHandling.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/sendInBackground.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/setAttributionChangedDelegate.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/setConversionValueUpdatedDelegate.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/setCoppaCompliantEnabled.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/setDefaultTracker.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/setDelayStart.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/setEventBufferingEnabled.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/setEventFailureDelegate.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/setEventSuccessDelegate.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/setExternalDeviceId.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/setLaunchDeferredDeeplink.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/setLinkMeEnabled.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/setLogDelegate.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/setLogLevel.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/setNeedsCost.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/setPreinstallFilePath.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/setPreinstallTrackingEnabled.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/setSessionFailureDelegate.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/setSessionSuccessDelegate.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustConfig/setUrlStrategy.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustEvent/addCallbackParameter.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustEvent/addPartnerParameter.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustEvent/constructor.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustEvent/setCallbackId.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustEvent/setRevenue.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustEvent/setTransactionId.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustPlayStoreSubscription/addCallbackParameter.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustPlayStoreSubscription/addPartnerParameter.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustPlayStoreSubscription/adjustPlayStoreSubscription.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustPlayStoreSubscription/setPurchaseTime.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustThirdPartySharing/addGranularOption.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustThirdPartySharing/addGranularOptionFacebook.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustThirdPartySharing/addPartnerSharingSetting.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustThirdPartySharing/initFalse.mdx delete mode 100644 src/code-snippets/unity/examples/AdjustThirdPartySharing/initTrue.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/addSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/addSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/appTrackingAuthorizationStatus.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/checkForNewAttStatus.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/disableThirdPartySharing.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/gdprForgetMe.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/getAdid.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/getAmazonAdId.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/getAttribution.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/getGoogleAdId.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/getIdfa.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/isEnabled.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/removeSessionCallbackParameter.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/removeSessionPartnerParameter.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/requestTrackingAuthorization.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/resetSessionCallbackParameters.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/resetSessionPartnerParameters.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/sendFirstPackages.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/setDeviceToken.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/setEnabled.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/setOfflineMode.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/trackAdRevenue.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/trackAppStoreSubscription.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/trackEvent.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/trackMeasurementConsent.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/trackPlayStoreSubscription.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/trackThirdPartySharing.mdx delete mode 100644 src/code-snippets/unity/signatures/Adjust/updateConversionValue.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustAdRevenue/addCallbackParameter.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustAdRevenue/addPartnerParameter.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustAdRevenue/constructor.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustAdRevenue/setAdImpressionsCount.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustAdRevenue/setAdRevenueNetwork.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustAdRevenue/setAdRevenuePlacement.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustAdRevenue/setAdRevenueUnit.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustAdRevenue/setRevenue.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustAppStoreSubscription/addCallbackParameter.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustAppStoreSubscription/addPartnerParameter.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustAppStoreSubscription/constructor.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustAppStoreSubscription/setSalesRegion.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustAppStoreSubscription/setTransactionDate.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/constructor.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/deactivateSKAdNetworkHandling.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/sendInBackground.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/setAttributionChangedDelegate.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/setConversionValueUpdatedDelegate.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/setCoppaCompliantEnabled.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/setDefaultTracker.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/setDelayStart.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/setEventBufferingEnabled.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/setEventFailureDelegate.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/setEventSuccessDelegate.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/setExternalDeviceId.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/setLaunchDeferredDeeplink.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/setLinkMeEnabled.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/setLogDelegate.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/setLogLevel.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/setNeedsCost.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/setPreinstallFilePath.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/setPreinstallTrackingEnabled.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/setSessionFailureDelegate.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/setSessionSuccessDelegate.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustConfig/setUrlStrategy.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustEvent/addCallbackParameter.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustEvent/addPartnerParameter.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustEvent/constructor.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustEvent/setCallbackId.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustEvent/setRevenue.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustEvent/setTransactionId.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustPlayStoreSubscription/addCallbackParameter.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustPlayStoreSubscription/addPartnerParameter.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustPlayStoreSubscription/constructor.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustPlayStoreSubscription/setPurchaseTime.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustThirdPartySharing/addGranularOption.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustThirdPartySharing/addPartnerSharingSetting.mdx delete mode 100644 src/code-snippets/unity/signatures/AdjustThirdPartySharing/constructor.mdx create mode 100644 src/content/docs/sdk/unity/configuration.mdx delete mode 100644 src/content/docs/sdk/unity/configuration/background.mdx delete mode 100644 src/content/docs/sdk/unity/configuration/delay.mdx delete mode 100644 src/content/docs/sdk/unity/configuration/disable.mdx delete mode 100644 src/content/docs/sdk/unity/configuration/external-device-id.mdx delete mode 100644 src/content/docs/sdk/unity/configuration/index.mdx delete mode 100644 src/content/docs/sdk/unity/configuration/log-level.mdx delete mode 100644 src/content/docs/sdk/unity/configuration/push-tokens.mdx rename src/content/docs/sdk/unity/{configuration => features}/att.mdx (75%) rename src/content/docs/sdk/unity/{configuration => features}/deep-links.mdx (76%) rename src/content/docs/sdk/unity/{configuration => features}/preinstalled.mdx (67%) rename src/content/docs/sdk/unity/{configuration => features}/privacy.mdx (52%) rename src/content/docs/sdk/unity/{configuration => features}/skad.mdx (74%) delete mode 100644 src/content/docs/sdk/unity/reference/adjust/config.mdx delete mode 100644 src/content/docs/sdk/unity/reference/adjust/device-info.mdx delete mode 100644 src/content/docs/sdk/unity/reference/adjust/index.mdx delete mode 100644 src/content/docs/sdk/unity/reference/adjust/privacy.mdx delete mode 100644 src/content/docs/sdk/unity/reference/adjust/recording.mdx delete mode 100644 src/content/docs/sdk/unity/reference/adjust/skan-att.mdx delete mode 100644 src/content/docs/sdk/unity/reference/adjustadrevenue.mdx delete mode 100644 src/content/docs/sdk/unity/reference/adjustappstoresubscription.mdx delete mode 100644 src/content/docs/sdk/unity/reference/adjustattribution.mdx delete mode 100644 src/content/docs/sdk/unity/reference/adjustconfig/index.mdx delete mode 100644 src/content/docs/sdk/unity/reference/adjustconfig/privacy.mdx delete mode 100644 src/content/docs/sdk/unity/reference/adjustconfig/setup.mdx delete mode 100644 src/content/docs/sdk/unity/reference/adjustevent.mdx delete mode 100644 src/content/docs/sdk/unity/reference/adjustplaystoresubscription.mdx delete mode 100644 src/content/docs/sdk/unity/reference/adjustthirdpartysharing.mdx delete mode 100644 src/content/docs/sdk/unity/reference/index.mdx diff --git a/src/code-snippets/unity/examples/Adjust/addSessionCallbackParameter.mdx b/src/code-snippets/unity/examples/Adjust/addSessionCallbackParameter.mdx deleted file mode 100644 index 4ce7ba47a..000000000 --- a/src/code-snippets/unity/examples/Adjust/addSessionCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.addSessionCallbackParameter("key", "value"); -``` diff --git a/src/code-snippets/unity/examples/Adjust/addSessionPartnerParameter.mdx b/src/code-snippets/unity/examples/Adjust/addSessionPartnerParameter.mdx deleted file mode 100644 index a2429c90f..000000000 --- a/src/code-snippets/unity/examples/Adjust/addSessionPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.addSessionPartnerParameter("key", "value"); -``` diff --git a/src/code-snippets/unity/examples/Adjust/appTrackingAuthorizationStatus.mdx b/src/code-snippets/unity/examples/Adjust/appTrackingAuthorizationStatus.mdx deleted file mode 100644 index 17109d13c..000000000 --- a/src/code-snippets/unity/examples/Adjust/appTrackingAuthorizationStatus.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.getAppTrackingAuthorizationStatus(); -``` diff --git a/src/code-snippets/unity/examples/Adjust/checkForNewAttStatus.mdx b/src/code-snippets/unity/examples/Adjust/checkForNewAttStatus.mdx deleted file mode 100644 index 91e555d44..000000000 --- a/src/code-snippets/unity/examples/Adjust/checkForNewAttStatus.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.checkForNewAttStatus(); -``` diff --git a/src/code-snippets/unity/examples/Adjust/disableThirdPartySharing.mdx b/src/code-snippets/unity/examples/Adjust/disableThirdPartySharing.mdx deleted file mode 100644 index ee96b8406..000000000 --- a/src/code-snippets/unity/examples/Adjust/disableThirdPartySharing.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.disableThirdPartySharing(); -``` diff --git a/src/code-snippets/unity/examples/Adjust/gdprForgetMe.mdx b/src/code-snippets/unity/examples/Adjust/gdprForgetMe.mdx deleted file mode 100644 index 0c723e6bd..000000000 --- a/src/code-snippets/unity/examples/Adjust/gdprForgetMe.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.gdprForgetMe(); -``` diff --git a/src/code-snippets/unity/examples/Adjust/getAdid.mdx b/src/code-snippets/unity/examples/Adjust/getAdid.mdx deleted file mode 100644 index 624125dc1..000000000 --- a/src/code-snippets/unity/examples/Adjust/getAdid.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -string adid = Adjust.getAdid(); -``` diff --git a/src/code-snippets/unity/examples/Adjust/getAmazonAdId.mdx b/src/code-snippets/unity/examples/Adjust/getAmazonAdId.mdx deleted file mode 100644 index b473ec7b9..000000000 --- a/src/code-snippets/unity/examples/Adjust/getAmazonAdId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -string amazonAdId = Adjust.getAmazonAdId(); -``` diff --git a/src/code-snippets/unity/examples/Adjust/getAttribution.mdx b/src/code-snippets/unity/examples/Adjust/getAttribution.mdx deleted file mode 100644 index 14892335c..000000000 --- a/src/code-snippets/unity/examples/Adjust/getAttribution.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -var attribution = Adjust.getAttribution(); -``` diff --git a/src/code-snippets/unity/examples/Adjust/getGoogleAdId.mdx b/src/code-snippets/unity/examples/Adjust/getGoogleAdId.mdx deleted file mode 100644 index b5c5e34a5..000000000 --- a/src/code-snippets/unity/examples/Adjust/getGoogleAdId.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```c# -Adjust.getGoogleAdId((string googleAdId) => { - //... -}}; -``` diff --git a/src/code-snippets/unity/examples/Adjust/getIdfa.mdx b/src/code-snippets/unity/examples/Adjust/getIdfa.mdx deleted file mode 100644 index c52dcb653..000000000 --- a/src/code-snippets/unity/examples/Adjust/getIdfa.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -string idfa = Adjust.getIdfa(); -``` diff --git a/src/code-snippets/unity/examples/Adjust/isEnabled.mdx b/src/code-snippets/unity/examples/Adjust/isEnabled.mdx deleted file mode 100644 index d3ac69d25..000000000 --- a/src/code-snippets/unity/examples/Adjust/isEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.isEnabled(); -``` diff --git a/src/code-snippets/unity/examples/Adjust/removeSessionCallbackParameter.mdx b/src/code-snippets/unity/examples/Adjust/removeSessionCallbackParameter.mdx deleted file mode 100644 index a0792de77..000000000 --- a/src/code-snippets/unity/examples/Adjust/removeSessionCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.removeSessionCallbackParameter("key"); -``` diff --git a/src/code-snippets/unity/examples/Adjust/removeSessionPartnerParameter.mdx b/src/code-snippets/unity/examples/Adjust/removeSessionPartnerParameter.mdx deleted file mode 100644 index bef1bca16..000000000 --- a/src/code-snippets/unity/examples/Adjust/removeSessionPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.removeSessionPartnerParameter("key"); -``` diff --git a/src/code-snippets/unity/examples/Adjust/requestTrackingAuthorization.mdx b/src/code-snippets/unity/examples/Adjust/requestTrackingAuthorization.mdx deleted file mode 100644 index 6a62ecea0..000000000 --- a/src/code-snippets/unity/examples/Adjust/requestTrackingAuthorization.mdx +++ /dev/null @@ -1,20 +0,0 @@ -```c# -Adjust.requestTrackingAuthorizationWithCompletionHandler((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/unity/examples/Adjust/resetSessionCallbackParameters.mdx b/src/code-snippets/unity/examples/Adjust/resetSessionCallbackParameters.mdx deleted file mode 100644 index 4a8d95126..000000000 --- a/src/code-snippets/unity/examples/Adjust/resetSessionCallbackParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.resetSessionCallbackParameters(); -``` diff --git a/src/code-snippets/unity/examples/Adjust/resetSessionPartnerParameters.mdx b/src/code-snippets/unity/examples/Adjust/resetSessionPartnerParameters.mdx deleted file mode 100644 index 4730c5bd4..000000000 --- a/src/code-snippets/unity/examples/Adjust/resetSessionPartnerParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.resetSessionPartnerParameters(); -``` diff --git a/src/code-snippets/unity/examples/Adjust/sendFirstPackages.mdx b/src/code-snippets/unity/examples/Adjust/sendFirstPackages.mdx deleted file mode 100644 index 4ffeefa9e..000000000 --- a/src/code-snippets/unity/examples/Adjust/sendFirstPackages.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.sendFirstPackages(); -``` diff --git a/src/code-snippets/unity/examples/Adjust/setDeviceToken.mdx b/src/code-snippets/unity/examples/Adjust/setDeviceToken.mdx deleted file mode 100644 index ec733f447..000000000 --- a/src/code-snippets/unity/examples/Adjust/setDeviceToken.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.setDeviceToken("{YourDeviceToken}"); -``` diff --git a/src/code-snippets/unity/examples/Adjust/setEnabled.mdx b/src/code-snippets/unity/examples/Adjust/setEnabled.mdx deleted file mode 100644 index ca7d5e0f1..000000000 --- a/src/code-snippets/unity/examples/Adjust/setEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.setEnabled(false); -``` diff --git a/src/code-snippets/unity/examples/Adjust/setOfflineMode.mdx b/src/code-snippets/unity/examples/Adjust/setOfflineMode.mdx deleted file mode 100644 index 4df413eca..000000000 --- a/src/code-snippets/unity/examples/Adjust/setOfflineMode.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.setOfflineMode(true); -``` diff --git a/src/code-snippets/unity/examples/Adjust/trackAdRevenue.mdx b/src/code-snippets/unity/examples/Adjust/trackAdRevenue.mdx deleted file mode 100644 index ae0af9ac8..000000000 --- a/src/code-snippets/unity/examples/Adjust/trackAdRevenue.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```c# -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/unity/examples/Adjust/trackAppStoreSubscription.mdx b/src/code-snippets/unity/examples/Adjust/trackAppStoreSubscription.mdx deleted file mode 100644 index 1175ca54b..000000000 --- a/src/code-snippets/unity/examples/Adjust/trackAppStoreSubscription.mdx +++ /dev/null @@ -1,15 +0,0 @@ -```c# -AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( - price, - currency, - transactionId, - receipt); -subscription.setTransactionDate(transactionDate); -subscription.setSalesRegion(salesRegion); -subscription.addCallbackParameter("key1", "value1"); -subscription.addCallbackParameter("key2", "value2"); -subscription.addPartnerParameter("key1", "value1"); -subscription.addPartnerParameter("key2", "value2"); - -Adjust.trackAppStoreSubscription(subscription); -``` diff --git a/src/code-snippets/unity/examples/Adjust/trackEvent.mdx b/src/code-snippets/unity/examples/Adjust/trackEvent.mdx deleted file mode 100644 index a1536d606..000000000 --- a/src/code-snippets/unity/examples/Adjust/trackEvent.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```c# -AdjustEvent adjustEvent = new AdjustEvent("abc123"); -//... -Adjust.trackEvent(adjustEvent); -``` diff --git a/src/code-snippets/unity/examples/Adjust/trackMeasurementConsent.mdx b/src/code-snippets/unity/examples/Adjust/trackMeasurementConsent.mdx deleted file mode 100644 index f7721986e..000000000 --- a/src/code-snippets/unity/examples/Adjust/trackMeasurementConsent.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.trackMeasurementConsent(true); -``` diff --git a/src/code-snippets/unity/examples/Adjust/trackPlayStoreSubscription.mdx b/src/code-snippets/unity/examples/Adjust/trackPlayStoreSubscription.mdx deleted file mode 100644 index 742759020..000000000 --- a/src/code-snippets/unity/examples/Adjust/trackPlayStoreSubscription.mdx +++ /dev/null @@ -1,16 +0,0 @@ -```c# -AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken); -subscription.setPurchaseTime(purchaseTime); -subscription.addCallbackParameter("key1", "value1"); -subscription.addCallbackParameter("key2", "value2"); -subscription.addPartnerParameter("key1", "value1"); -subscription.addPartnerParameter("key2", "value2"); - -Adjust.trackPlayStoreSubscription(subscription); -``` diff --git a/src/code-snippets/unity/examples/Adjust/trackThirdPartySharing.mdx b/src/code-snippets/unity/examples/Adjust/trackThirdPartySharing.mdx deleted file mode 100644 index 715e4b6bc..000000000 --- a/src/code-snippets/unity/examples/Adjust/trackThirdPartySharing.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```c# -AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true); -//... -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` diff --git a/src/code-snippets/unity/examples/Adjust/updateConversionValue.mdx b/src/code-snippets/unity/examples/Adjust/updateConversionValue.mdx deleted file mode 100644 index f74862d03..000000000 --- a/src/code-snippets/unity/examples/Adjust/updateConversionValue.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -Adjust.updateConversionValue(6); -``` diff --git a/src/code-snippets/unity/examples/AdjustAdRevenue/addCallbackParameter.mdx b/src/code-snippets/unity/examples/AdjustAdRevenue/addCallbackParameter.mdx deleted file mode 100644 index 5c18215ec..000000000 --- a/src/code-snippets/unity/examples/AdjustAdRevenue/addCallbackParameter.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -//... -adjustAdRevenue.addCallbackParameter("key", "value"); -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/unity/examples/AdjustAdRevenue/addPartnerParameter.mdx b/src/code-snippets/unity/examples/AdjustAdRevenue/addPartnerParameter.mdx deleted file mode 100644 index fe7fe1736..000000000 --- a/src/code-snippets/unity/examples/AdjustAdRevenue/addPartnerParameter.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -//... -adjustAdRevenue.addPartnerParameter("key", "value"); -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/unity/examples/AdjustAdRevenue/constructor.mdx b/src/code-snippets/unity/examples/AdjustAdRevenue/constructor.mdx deleted file mode 100644 index 472becf77..000000000 --- a/src/code-snippets/unity/examples/AdjustAdRevenue/constructor.mdx +++ /dev/null @@ -1,4 +0,0 @@ -```c# -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/unity/examples/AdjustAdRevenue/setAdImpressionsCount.mdx b/src/code-snippets/unity/examples/AdjustAdRevenue/setAdImpressionsCount.mdx deleted file mode 100644 index d23154e33..000000000 --- a/src/code-snippets/unity/examples/AdjustAdRevenue/setAdImpressionsCount.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -//... -adjustAdRevenue.setAdImpressionsCount(10); -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/unity/examples/AdjustAdRevenue/setAdRevenueNetwork.mdx b/src/code-snippets/unity/examples/AdjustAdRevenue/setAdRevenueNetwork.mdx deleted file mode 100644 index 8993672a4..000000000 --- a/src/code-snippets/unity/examples/AdjustAdRevenue/setAdRevenueNetwork.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -//... -adjustAdRevenue.setAdRevenueNetwork("network1"); -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/unity/examples/AdjustAdRevenue/setAdRevenuePlacement.mdx b/src/code-snippets/unity/examples/AdjustAdRevenue/setAdRevenuePlacement.mdx deleted file mode 100644 index b6cf49523..000000000 --- a/src/code-snippets/unity/examples/AdjustAdRevenue/setAdRevenuePlacement.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -//... -adjustAdRevenue.setAdRevenuePlacement("banner"); -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/unity/examples/AdjustAdRevenue/setAdRevenueUnit.mdx b/src/code-snippets/unity/examples/AdjustAdRevenue/setAdRevenueUnit.mdx deleted file mode 100644 index 487187f93..000000000 --- a/src/code-snippets/unity/examples/AdjustAdRevenue/setAdRevenueUnit.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -//... -adjustAdRevenue.setAdRevenueUnit("unit1"); -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/unity/examples/AdjustAdRevenue/setRevenue.mdx b/src/code-snippets/unity/examples/AdjustAdRevenue/setRevenue.mdx deleted file mode 100644 index b0a7508f7..000000000 --- a/src/code-snippets/unity/examples/AdjustAdRevenue/setRevenue.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); -//... -adjustAdRevenue.setRevenue(1.00, "EUR"); -//... -Adjust.trackAdRevenue(adjustAdRevenue); -``` diff --git a/src/code-snippets/unity/examples/AdjustAppStoreSubscription/addCallbackParameter.mdx b/src/code-snippets/unity/examples/AdjustAppStoreSubscription/addCallbackParameter.mdx deleted file mode 100644 index 7ae40b07f..000000000 --- a/src/code-snippets/unity/examples/AdjustAppStoreSubscription/addCallbackParameter.mdx +++ /dev/null @@ -1,10 +0,0 @@ -```c# -AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( - price, - currency, - transactionId, - receipt); -//... -subscription.addCallbackParameter("key1", "value1"); -subscription.addCallbackParameter("key2", "value2"); -``` diff --git a/src/code-snippets/unity/examples/AdjustAppStoreSubscription/addPartnerParameter.mdx b/src/code-snippets/unity/examples/AdjustAppStoreSubscription/addPartnerParameter.mdx deleted file mode 100644 index a917120cb..000000000 --- a/src/code-snippets/unity/examples/AdjustAppStoreSubscription/addPartnerParameter.mdx +++ /dev/null @@ -1,10 +0,0 @@ -```c# -AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( - price, - currency, - transactionId, - receipt); -//... -subscription.addPartnerParameter("key1", "value1"); -subscription.addPartnerParameter("key2", "value2"); -``` diff --git a/src/code-snippets/unity/examples/AdjustAppStoreSubscription/adjustAppStoreSubscription.mdx b/src/code-snippets/unity/examples/AdjustAppStoreSubscription/adjustAppStoreSubscription.mdx deleted file mode 100644 index 2d6042969..000000000 --- a/src/code-snippets/unity/examples/AdjustAppStoreSubscription/adjustAppStoreSubscription.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( - price, - currency, - transactionId, - receipt); -``` diff --git a/src/code-snippets/unity/examples/AdjustAppStoreSubscription/setSalesRegion.mdx b/src/code-snippets/unity/examples/AdjustAppStoreSubscription/setSalesRegion.mdx deleted file mode 100644 index 83ec3a28e..000000000 --- a/src/code-snippets/unity/examples/AdjustAppStoreSubscription/setSalesRegion.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```c# -AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( - price, - currency, - transactionId, - receipt); -//... -subscription.setSalesRegion(salesRegion); -``` diff --git a/src/code-snippets/unity/examples/AdjustAppStoreSubscription/setTransactionDate.mdx b/src/code-snippets/unity/examples/AdjustAppStoreSubscription/setTransactionDate.mdx deleted file mode 100644 index 155514f2a..000000000 --- a/src/code-snippets/unity/examples/AdjustAppStoreSubscription/setTransactionDate.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```c# -AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( - price, - currency, - transactionId, - receipt); -//... -subscription.setTransactionDate(transactionDate); -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/constructor.mdx b/src/code-snippets/unity/examples/AdjustConfig/constructor.mdx deleted file mode 100644 index b91a6aa14..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/constructor.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```c# -AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox); -// ... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/deactivateSKAdNetworkHandling.mdx b/src/code-snippets/unity/examples/AdjustConfig/deactivateSKAdNetworkHandling.mdx deleted file mode 100644 index f776f1ba5..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/deactivateSKAdNetworkHandling.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); -//... -adjustConfig.deactivateSKAdNetworkHandling(); -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/sendInBackground.mdx b/src/code-snippets/unity/examples/AdjustConfig/sendInBackground.mdx deleted file mode 100644 index fddcb32bc..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/sendInBackground.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox); -//... -adjustConfig.setSendInBackground(true); -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/setAttributionChangedDelegate.mdx b/src/code-snippets/unity/examples/AdjustConfig/setAttributionChangedDelegate.mdx deleted file mode 100644 index 23d873ec7..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/setAttributionChangedDelegate.mdx +++ /dev/null @@ -1,19 +0,0 @@ -```c# {8, 13-16} -using com.adjust.sdk; - -public class ExampleGUI : MonoBehaviour { - void OnGUI() { - if (GUI.Button(new Rect(0, 0, Screen.width, Screen.height), "callback")) { - AdjustConfig adjustConfig = new AdjustConfig("{Your App Token}", AdjustEnvironmentSandbox); - adjustConfig.setLogLevel(AdjustLogLevel.Verbose); - adjustConfig.setAttributionChangedDelegate(this.attributionChangedDelegate); - Adjust.start(adjustConfig); - } - } - - public void attributionChangedDelegate(AdjustAttribution attribution) { - Debug.Log("Attribution changed"); - // ... - } -} -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/setConversionValueUpdatedDelegate.mdx b/src/code-snippets/unity/examples/AdjustConfig/setConversionValueUpdatedDelegate.mdx deleted file mode 100644 index 162e003bc..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/setConversionValueUpdatedDelegate.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); -//... -adjustConfig.setConversionValueUpdatedDelegate(ConversionValueUpdatedCallback); -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/setCoppaCompliantEnabled.mdx b/src/code-snippets/unity/examples/AdjustConfig/setCoppaCompliantEnabled.mdx deleted file mode 100644 index e80c043a8..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/setCoppaCompliantEnabled.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```c# -AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox); -adjustConfig.setCoppaCompliantEnabled(true); -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/setDefaultTracker.mdx b/src/code-snippets/unity/examples/AdjustConfig/setDefaultTracker.mdx deleted file mode 100644 index 1e1ada7c5..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/setDefaultTracker.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox); -//... -adjustConfig.setDefaultTracker("{TrackerToken}"); -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/setDelayStart.mdx b/src/code-snippets/unity/examples/AdjustConfig/setDelayStart.mdx deleted file mode 100644 index 81f803e01..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/setDelayStart.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox); -//... -adjustConfig.setDelayStart(5.5); -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/setEventBufferingEnabled.mdx b/src/code-snippets/unity/examples/AdjustConfig/setEventBufferingEnabled.mdx deleted file mode 100644 index 099ea87fd..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/setEventBufferingEnabled.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox); -//... -adjustConfig.setEventBufferingEnabled(true); -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/setEventFailureDelegate.mdx b/src/code-snippets/unity/examples/AdjustConfig/setEventFailureDelegate.mdx deleted file mode 100644 index 14a26068f..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/setEventFailureDelegate.mdx +++ /dev/null @@ -1,11 +0,0 @@ -```c# {3, 7-9} -AdjustConfig adjustConfig = new AdjustConfig("{Your App Token}", AdjustEnvironment.Sandbox); -adjustConfig.setLogLevel(AdjustLogLevel.Verbose); -adjustConfig.setEventFailureDelegate(EventFailureCallback); -//... -Adjust.start(adjustConfig); -//... -public void EventFailureCallback(AdjustEventFailure eventFailureData) { - //... -} -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/setEventSuccessDelegate.mdx b/src/code-snippets/unity/examples/AdjustConfig/setEventSuccessDelegate.mdx deleted file mode 100644 index 2a79b334a..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/setEventSuccessDelegate.mdx +++ /dev/null @@ -1,11 +0,0 @@ -```c# {3, 7-9} -AdjustConfig adjustConfig = new AdjustConfig("{Your App Token}", AdjustEnvironment.Sandbox); -adjustConfig.setLogLevel(AdjustLogLevel.Verbose); -adjustConfig.setEventSuccessDelegate(EventSuccessCallback); -//... -Adjust.start(adjustConfig); -//... -public void EventSuccessCallback(AdjustEventSuccess eventSuccessData) { - //... -} -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/setExternalDeviceId.mdx b/src/code-snippets/unity/examples/AdjustConfig/setExternalDeviceId.mdx deleted file mode 100644 index a80c99128..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/setExternalDeviceId.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); -//... -adjustConfig.setExternalDeviceId("{Your-External-Device-Id}"); -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/setLaunchDeferredDeeplink.mdx b/src/code-snippets/unity/examples/AdjustConfig/setLaunchDeferredDeeplink.mdx deleted file mode 100644 index da78d60ef..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/setLaunchDeferredDeeplink.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox); -//... -adjustConfig.setLaunchDeferredDeeplink(true); -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/setLinkMeEnabled.mdx b/src/code-snippets/unity/examples/AdjustConfig/setLinkMeEnabled.mdx deleted file mode 100644 index 2b7f86158..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/setLinkMeEnabled.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); -//... -adjustConfig.setLinkMeEnabled(true); -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/setLogDelegate.mdx b/src/code-snippets/unity/examples/AdjustConfig/setLogDelegate.mdx deleted file mode 100644 index e8dfb2c2f..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/setLogDelegate.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); -//... -adjustConfig.setLogDelegate(msg => Debug.Log(msg)); -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/setLogLevel.mdx b/src/code-snippets/unity/examples/AdjustConfig/setLogLevel.mdx deleted file mode 100644 index 0a4dcdbdb..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/setLogLevel.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustConfig config = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); -//... -config.setLogLevel(AdjustLogLevel.Error); -//... -Adjust.start(config); -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/setNeedsCost.mdx b/src/code-snippets/unity/examples/AdjustConfig/setNeedsCost.mdx deleted file mode 100644 index 153eb03a5..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/setNeedsCost.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```c# -AdjustConfig adjustConfig = new AdjustConfig("{Your App Token}", AdjustEnvironment.Sandbox); -adjustConfig.setLogLevel(AdjustLogLevel.Verbose); -adjustConfig.setNeedsCost(true); -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/setPreinstallFilePath.mdx b/src/code-snippets/unity/examples/AdjustConfig/setPreinstallFilePath.mdx deleted file mode 100644 index 6e95113f4..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/setPreinstallFilePath.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); -//... -adjustConfig.setPreinstallFilePath("../EngagementFile.xml"); -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/setPreinstallTrackingEnabled.mdx b/src/code-snippets/unity/examples/AdjustConfig/setPreinstallTrackingEnabled.mdx deleted file mode 100644 index 2e5010c8f..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/setPreinstallTrackingEnabled.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); -//... -adjustConfig.setPreinstallTrackingEnabled(true); -//... -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/setSessionFailureDelegate.mdx b/src/code-snippets/unity/examples/AdjustConfig/setSessionFailureDelegate.mdx deleted file mode 100644 index 5ae76fbd5..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/setSessionFailureDelegate.mdx +++ /dev/null @@ -1,11 +0,0 @@ -```c# {3, 7-9} -AdjustConfig adjustConfig = new AdjustConfig("{Your App Token}", AdjustEnvironment.Sandbox); -adjustConfig.setLogLevel(AdjustLogLevel.Verbose); -adjustConfig.setSessionFailureDelegate(SessionFailureCallback); -//... -Adjust.start(adjustConfig); -//... -public void SessionFailureCallback (AdjustSessionFailure sessionFailureData) { - //... -} -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/setSessionSuccessDelegate.mdx b/src/code-snippets/unity/examples/AdjustConfig/setSessionSuccessDelegate.mdx deleted file mode 100644 index 1a81f6c30..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/setSessionSuccessDelegate.mdx +++ /dev/null @@ -1,11 +0,0 @@ -```c# {3, 7-9} -AdjustConfig adjustConfig = new AdjustConfig("{Your App Token}", AdjustEnvironment.Sandbox); -adjustConfig.setLogLevel(AdjustLogLevel.Verbose); -adjustConfig.setSessionSuccessDelegate(SessionSuccessCallback); -//... -Adjust.start(adjustConfig); -//... -public void SessionSuccessCallback (AdjustSessionSuccess sessionSuccessData) { - //... -} -``` diff --git a/src/code-snippets/unity/examples/AdjustConfig/setUrlStrategy.mdx b/src/code-snippets/unity/examples/AdjustConfig/setUrlStrategy.mdx deleted file mode 100644 index 790883c64..000000000 --- a/src/code-snippets/unity/examples/AdjustConfig/setUrlStrategy.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```c# "AdjustConfig.AdjustDataResidencyEU" -AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox); -adjustConfig.setUrlStrategy(AdjustConfig.AdjustDataResidencyEU); -Adjust.start(adjustConfig); -``` diff --git a/src/code-snippets/unity/examples/AdjustEvent/addCallbackParameter.mdx b/src/code-snippets/unity/examples/AdjustEvent/addCallbackParameter.mdx deleted file mode 100644 index 7b306dbfa..000000000 --- a/src/code-snippets/unity/examples/AdjustEvent/addCallbackParameter.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustEvent adjustEvent = new AdjustEvent("abc123"); -//... -adjustEvent.addCallbackParameter("key", "value"); -//... -Adjust.trackEvent(adjustEvent); -``` diff --git a/src/code-snippets/unity/examples/AdjustEvent/addPartnerParameter.mdx b/src/code-snippets/unity/examples/AdjustEvent/addPartnerParameter.mdx deleted file mode 100644 index fa2107ca0..000000000 --- a/src/code-snippets/unity/examples/AdjustEvent/addPartnerParameter.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustEvent adjustEvent = new AdjustEvent("abc123"); -//... -adjustEvent.addPartnerParameter("key", "value"); -//... -Adjust.trackEvent(adjustEvent); -``` diff --git a/src/code-snippets/unity/examples/AdjustEvent/constructor.mdx b/src/code-snippets/unity/examples/AdjustEvent/constructor.mdx deleted file mode 100644 index a1536d606..000000000 --- a/src/code-snippets/unity/examples/AdjustEvent/constructor.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```c# -AdjustEvent adjustEvent = new AdjustEvent("abc123"); -//... -Adjust.trackEvent(adjustEvent); -``` diff --git a/src/code-snippets/unity/examples/AdjustEvent/setCallbackId.mdx b/src/code-snippets/unity/examples/AdjustEvent/setCallbackId.mdx deleted file mode 100644 index 106c61192..000000000 --- a/src/code-snippets/unity/examples/AdjustEvent/setCallbackId.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustEvent adjustEvent = new AdjustEvent("abc123"); -//... -adjustEvent.setCallbackId("{your_callback_id}"); -//... -Adjust.trackEvent(adjustEvent); -``` diff --git a/src/code-snippets/unity/examples/AdjustEvent/setRevenue.mdx b/src/code-snippets/unity/examples/AdjustEvent/setRevenue.mdx deleted file mode 100644 index ae8a4fcfa..000000000 --- a/src/code-snippets/unity/examples/AdjustEvent/setRevenue.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustEvent adjustEvent = new AdjustEvent("abc123"); -//... -adjustEvent.setRevenue(0.01, "EUR"); -//... -Adjust.trackEvent(adjustEvent); -``` diff --git a/src/code-snippets/unity/examples/AdjustEvent/setTransactionId.mdx b/src/code-snippets/unity/examples/AdjustEvent/setTransactionId.mdx deleted file mode 100644 index 7e8de00de..000000000 --- a/src/code-snippets/unity/examples/AdjustEvent/setTransactionId.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustEvent adjustEvent = new AdjustEvent("abc123"); -//... -adjustEvent.setTransactionId("transactionId"); -//... -Adjust.trackEvent(adjustEvent); -``` diff --git a/src/code-snippets/unity/examples/AdjustPlayStoreSubscription/addCallbackParameter.mdx b/src/code-snippets/unity/examples/AdjustPlayStoreSubscription/addCallbackParameter.mdx deleted file mode 100644 index 4c8f2a9bd..000000000 --- a/src/code-snippets/unity/examples/AdjustPlayStoreSubscription/addCallbackParameter.mdx +++ /dev/null @@ -1,12 +0,0 @@ -```c# -AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken); -//... -subscription.addCallbackParameter("key1", "value1"); -subscription.addCallbackParameter("key2", "value2"); -``` diff --git a/src/code-snippets/unity/examples/AdjustPlayStoreSubscription/addPartnerParameter.mdx b/src/code-snippets/unity/examples/AdjustPlayStoreSubscription/addPartnerParameter.mdx deleted file mode 100644 index 7259953e5..000000000 --- a/src/code-snippets/unity/examples/AdjustPlayStoreSubscription/addPartnerParameter.mdx +++ /dev/null @@ -1,12 +0,0 @@ -```c# -AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken); -//... -subscription.addPartnerParameter("key1", "value1"); -subscription.addPartnerParameter("key2", "value2"); -``` diff --git a/src/code-snippets/unity/examples/AdjustPlayStoreSubscription/adjustPlayStoreSubscription.mdx b/src/code-snippets/unity/examples/AdjustPlayStoreSubscription/adjustPlayStoreSubscription.mdx deleted file mode 100644 index b16341a43..000000000 --- a/src/code-snippets/unity/examples/AdjustPlayStoreSubscription/adjustPlayStoreSubscription.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```c# -AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken); -``` diff --git a/src/code-snippets/unity/examples/AdjustPlayStoreSubscription/setPurchaseTime.mdx b/src/code-snippets/unity/examples/AdjustPlayStoreSubscription/setPurchaseTime.mdx deleted file mode 100644 index ec54b151b..000000000 --- a/src/code-snippets/unity/examples/AdjustPlayStoreSubscription/setPurchaseTime.mdx +++ /dev/null @@ -1,10 +0,0 @@ -```c# -AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( - price, - currency, - sku, - orderId, - signature, - purchaseToken); -subscription.setPurchaseTime(purchaseTime); -``` diff --git a/src/code-snippets/unity/examples/AdjustThirdPartySharing/addGranularOption.mdx b/src/code-snippets/unity/examples/AdjustThirdPartySharing/addGranularOption.mdx deleted file mode 100644 index 6a9556eab..000000000 --- a/src/code-snippets/unity/examples/AdjustThirdPartySharing/addGranularOption.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(null); -//... -adjustThirdPartySharing.addGranularOption("PartnerA", "key", "value"); -//... -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` diff --git a/src/code-snippets/unity/examples/AdjustThirdPartySharing/addGranularOptionFacebook.mdx b/src/code-snippets/unity/examples/AdjustThirdPartySharing/addGranularOptionFacebook.mdx deleted file mode 100644 index 2d55b7ac0..000000000 --- a/src/code-snippets/unity/examples/AdjustThirdPartySharing/addGranularOptionFacebook.mdx +++ /dev/null @@ -1,8 +0,0 @@ -```c# -AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(null); -//... -adjustThirdPartySharing.addGranularOption("facebook", "data_processing_options_country", "1"); -adjustThirdPartySharing.addGranularOption("facebook", "data_processing_options_state", "1000"); -//... -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` diff --git a/src/code-snippets/unity/examples/AdjustThirdPartySharing/addPartnerSharingSetting.mdx b/src/code-snippets/unity/examples/AdjustThirdPartySharing/addPartnerSharingSetting.mdx deleted file mode 100644 index 339e613aa..000000000 --- a/src/code-snippets/unity/examples/AdjustThirdPartySharing/addPartnerSharingSetting.mdx +++ /dev/null @@ -1,6 +0,0 @@ -```c# -AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(null); -//... -adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "foo", false); -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` diff --git a/src/code-snippets/unity/examples/AdjustThirdPartySharing/initFalse.mdx b/src/code-snippets/unity/examples/AdjustThirdPartySharing/initFalse.mdx deleted file mode 100644 index 600b3b712..000000000 --- a/src/code-snippets/unity/examples/AdjustThirdPartySharing/initFalse.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```c# "false" -AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(false); -//... -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` diff --git a/src/code-snippets/unity/examples/AdjustThirdPartySharing/initTrue.mdx b/src/code-snippets/unity/examples/AdjustThirdPartySharing/initTrue.mdx deleted file mode 100644 index 505d5ac8f..000000000 --- a/src/code-snippets/unity/examples/AdjustThirdPartySharing/initTrue.mdx +++ /dev/null @@ -1,5 +0,0 @@ -```c# "true" -AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true); -//... -Adjust.trackThirdPartySharing(adjustThirdPartySharing); -``` diff --git a/src/code-snippets/unity/signatures/Adjust/addSessionCallbackParameter.mdx b/src/code-snippets/unity/signatures/Adjust/addSessionCallbackParameter.mdx deleted file mode 100644 index 3094a3df1..000000000 --- a/src/code-snippets/unity/signatures/Adjust/addSessionCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void addSessionCallbackParameter(string key, string value) -``` diff --git a/src/code-snippets/unity/signatures/Adjust/addSessionPartnerParameter.mdx b/src/code-snippets/unity/signatures/Adjust/addSessionPartnerParameter.mdx deleted file mode 100644 index 0c3c37b5f..000000000 --- a/src/code-snippets/unity/signatures/Adjust/addSessionPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void addSessionPartnerParameter(string key, string value) -``` diff --git a/src/code-snippets/unity/signatures/Adjust/appTrackingAuthorizationStatus.mdx b/src/code-snippets/unity/signatures/Adjust/appTrackingAuthorizationStatus.mdx deleted file mode 100644 index 784292643..000000000 --- a/src/code-snippets/unity/signatures/Adjust/appTrackingAuthorizationStatus.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static int getAppTrackingAuthorizationStatus() -``` diff --git a/src/code-snippets/unity/signatures/Adjust/checkForNewAttStatus.mdx b/src/code-snippets/unity/signatures/Adjust/checkForNewAttStatus.mdx deleted file mode 100644 index 138cc4745..000000000 --- a/src/code-snippets/unity/signatures/Adjust/checkForNewAttStatus.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void checkForNewAttStatus() -``` diff --git a/src/code-snippets/unity/signatures/Adjust/disableThirdPartySharing.mdx b/src/code-snippets/unity/signatures/Adjust/disableThirdPartySharing.mdx deleted file mode 100644 index c4c9b5444..000000000 --- a/src/code-snippets/unity/signatures/Adjust/disableThirdPartySharing.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void disableThirdPartySharing() -``` diff --git a/src/code-snippets/unity/signatures/Adjust/gdprForgetMe.mdx b/src/code-snippets/unity/signatures/Adjust/gdprForgetMe.mdx deleted file mode 100644 index 314bf1888..000000000 --- a/src/code-snippets/unity/signatures/Adjust/gdprForgetMe.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void gdprForgetMe() -``` diff --git a/src/code-snippets/unity/signatures/Adjust/getAdid.mdx b/src/code-snippets/unity/signatures/Adjust/getAdid.mdx deleted file mode 100644 index d0391c287..000000000 --- a/src/code-snippets/unity/signatures/Adjust/getAdid.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static string getAdid() -``` diff --git a/src/code-snippets/unity/signatures/Adjust/getAmazonAdId.mdx b/src/code-snippets/unity/signatures/Adjust/getAmazonAdId.mdx deleted file mode 100644 index 68a3f041d..000000000 --- a/src/code-snippets/unity/signatures/Adjust/getAmazonAdId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static string getAmazonAdId() -``` diff --git a/src/code-snippets/unity/signatures/Adjust/getAttribution.mdx b/src/code-snippets/unity/signatures/Adjust/getAttribution.mdx deleted file mode 100644 index 27473e5f1..000000000 --- a/src/code-snippets/unity/signatures/Adjust/getAttribution.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static AdjustAttribution getAttribution() -``` diff --git a/src/code-snippets/unity/signatures/Adjust/getGoogleAdId.mdx b/src/code-snippets/unity/signatures/Adjust/getGoogleAdId.mdx deleted file mode 100644 index b5b91625b..000000000 --- a/src/code-snippets/unity/signatures/Adjust/getGoogleAdId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void getGoogleAdId(Action onDeviceIdsRead) -``` diff --git a/src/code-snippets/unity/signatures/Adjust/getIdfa.mdx b/src/code-snippets/unity/signatures/Adjust/getIdfa.mdx deleted file mode 100644 index e67114c78..000000000 --- a/src/code-snippets/unity/signatures/Adjust/getIdfa.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static string getIdfa() -``` diff --git a/src/code-snippets/unity/signatures/Adjust/isEnabled.mdx b/src/code-snippets/unity/signatures/Adjust/isEnabled.mdx deleted file mode 100644 index 868adf4de..000000000 --- a/src/code-snippets/unity/signatures/Adjust/isEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static bool isEnabled() -``` diff --git a/src/code-snippets/unity/signatures/Adjust/removeSessionCallbackParameter.mdx b/src/code-snippets/unity/signatures/Adjust/removeSessionCallbackParameter.mdx deleted file mode 100644 index 3391d7d7e..000000000 --- a/src/code-snippets/unity/signatures/Adjust/removeSessionCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void removeSessionCallbackParameter(string key) -``` diff --git a/src/code-snippets/unity/signatures/Adjust/removeSessionPartnerParameter.mdx b/src/code-snippets/unity/signatures/Adjust/removeSessionPartnerParameter.mdx deleted file mode 100644 index 0d522315c..000000000 --- a/src/code-snippets/unity/signatures/Adjust/removeSessionPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void removeSessionPartnerParameter(string key) -``` diff --git a/src/code-snippets/unity/signatures/Adjust/requestTrackingAuthorization.mdx b/src/code-snippets/unity/signatures/Adjust/requestTrackingAuthorization.mdx deleted file mode 100644 index 678a581a2..000000000 --- a/src/code-snippets/unity/signatures/Adjust/requestTrackingAuthorization.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void requestTrackingAuthorizationWithCompletionHandler(Action statusCallback, string sceneName = "Adjust") -``` diff --git a/src/code-snippets/unity/signatures/Adjust/resetSessionCallbackParameters.mdx b/src/code-snippets/unity/signatures/Adjust/resetSessionCallbackParameters.mdx deleted file mode 100644 index a470b5398..000000000 --- a/src/code-snippets/unity/signatures/Adjust/resetSessionCallbackParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void resetSessionCallbackParameters() -``` diff --git a/src/code-snippets/unity/signatures/Adjust/resetSessionPartnerParameters.mdx b/src/code-snippets/unity/signatures/Adjust/resetSessionPartnerParameters.mdx deleted file mode 100644 index 78d76d7da..000000000 --- a/src/code-snippets/unity/signatures/Adjust/resetSessionPartnerParameters.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void resetSessionPartnerParameters() -``` diff --git a/src/code-snippets/unity/signatures/Adjust/sendFirstPackages.mdx b/src/code-snippets/unity/signatures/Adjust/sendFirstPackages.mdx deleted file mode 100644 index 9b4ddba21..000000000 --- a/src/code-snippets/unity/signatures/Adjust/sendFirstPackages.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void sendFirstPackages() -``` diff --git a/src/code-snippets/unity/signatures/Adjust/setDeviceToken.mdx b/src/code-snippets/unity/signatures/Adjust/setDeviceToken.mdx deleted file mode 100644 index 7f1d207a6..000000000 --- a/src/code-snippets/unity/signatures/Adjust/setDeviceToken.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void setDeviceToken(string deviceToken) -``` diff --git a/src/code-snippets/unity/signatures/Adjust/setEnabled.mdx b/src/code-snippets/unity/signatures/Adjust/setEnabled.mdx deleted file mode 100644 index 16f599188..000000000 --- a/src/code-snippets/unity/signatures/Adjust/setEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void setEnabled(bool enabled) -``` diff --git a/src/code-snippets/unity/signatures/Adjust/setOfflineMode.mdx b/src/code-snippets/unity/signatures/Adjust/setOfflineMode.mdx deleted file mode 100644 index 3f4efc850..000000000 --- a/src/code-snippets/unity/signatures/Adjust/setOfflineMode.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void setOfflineMode(bool enabled) -``` diff --git a/src/code-snippets/unity/signatures/Adjust/trackAdRevenue.mdx b/src/code-snippets/unity/signatures/Adjust/trackAdRevenue.mdx deleted file mode 100644 index cfc0e0fd6..000000000 --- a/src/code-snippets/unity/signatures/Adjust/trackAdRevenue.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void trackAdRevenue(string source, string payload) -``` diff --git a/src/code-snippets/unity/signatures/Adjust/trackAppStoreSubscription.mdx b/src/code-snippets/unity/signatures/Adjust/trackAppStoreSubscription.mdx deleted file mode 100644 index caab47c88..000000000 --- a/src/code-snippets/unity/signatures/Adjust/trackAppStoreSubscription.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void trackAppStoreSubscription(AdjustAppStoreSubscription subscription) -``` diff --git a/src/code-snippets/unity/signatures/Adjust/trackEvent.mdx b/src/code-snippets/unity/signatures/Adjust/trackEvent.mdx deleted file mode 100644 index 266c09eb2..000000000 --- a/src/code-snippets/unity/signatures/Adjust/trackEvent.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void trackEvent(AdjustEvent adjustEvent) -``` diff --git a/src/code-snippets/unity/signatures/Adjust/trackMeasurementConsent.mdx b/src/code-snippets/unity/signatures/Adjust/trackMeasurementConsent.mdx deleted file mode 100644 index 49b92e454..000000000 --- a/src/code-snippets/unity/signatures/Adjust/trackMeasurementConsent.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void trackMeasurementConsent(bool measurementConsent) -``` diff --git a/src/code-snippets/unity/signatures/Adjust/trackPlayStoreSubscription.mdx b/src/code-snippets/unity/signatures/Adjust/trackPlayStoreSubscription.mdx deleted file mode 100644 index 3acdd3a99..000000000 --- a/src/code-snippets/unity/signatures/Adjust/trackPlayStoreSubscription.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void trackPlayStoreSubscription(AdjustPlayStoreSubscription subscription) -``` diff --git a/src/code-snippets/unity/signatures/Adjust/trackThirdPartySharing.mdx b/src/code-snippets/unity/signatures/Adjust/trackThirdPartySharing.mdx deleted file mode 100644 index 4b63a5e0a..000000000 --- a/src/code-snippets/unity/signatures/Adjust/trackThirdPartySharing.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void trackThirdPartySharing(AdjustThirdPartySharing thirdPartySharing) -``` diff --git a/src/code-snippets/unity/signatures/Adjust/updateConversionValue.mdx b/src/code-snippets/unity/signatures/Adjust/updateConversionValue.mdx deleted file mode 100644 index fa61dc8d0..000000000 --- a/src/code-snippets/unity/signatures/Adjust/updateConversionValue.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public static void updateConversionValue(int conversionValue) -``` diff --git a/src/code-snippets/unity/signatures/AdjustAdRevenue/addCallbackParameter.mdx b/src/code-snippets/unity/signatures/AdjustAdRevenue/addCallbackParameter.mdx deleted file mode 100644 index ce33a7eb2..000000000 --- a/src/code-snippets/unity/signatures/AdjustAdRevenue/addCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void addCallbackParameter(string key, string value) -``` diff --git a/src/code-snippets/unity/signatures/AdjustAdRevenue/addPartnerParameter.mdx b/src/code-snippets/unity/signatures/AdjustAdRevenue/addPartnerParameter.mdx deleted file mode 100644 index 73d65a444..000000000 --- a/src/code-snippets/unity/signatures/AdjustAdRevenue/addPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void addPartnerParameter(string key, string value) -``` diff --git a/src/code-snippets/unity/signatures/AdjustAdRevenue/constructor.mdx b/src/code-snippets/unity/signatures/AdjustAdRevenue/constructor.mdx deleted file mode 100644 index f7a319253..000000000 --- a/src/code-snippets/unity/signatures/AdjustAdRevenue/constructor.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public AdjustAdRevenue(string source) -``` diff --git a/src/code-snippets/unity/signatures/AdjustAdRevenue/setAdImpressionsCount.mdx b/src/code-snippets/unity/signatures/AdjustAdRevenue/setAdImpressionsCount.mdx deleted file mode 100644 index f0aa1250d..000000000 --- a/src/code-snippets/unity/signatures/AdjustAdRevenue/setAdImpressionsCount.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setAdImpressionsCount(int adImpressionsCount) -``` diff --git a/src/code-snippets/unity/signatures/AdjustAdRevenue/setAdRevenueNetwork.mdx b/src/code-snippets/unity/signatures/AdjustAdRevenue/setAdRevenueNetwork.mdx deleted file mode 100644 index 576e715e0..000000000 --- a/src/code-snippets/unity/signatures/AdjustAdRevenue/setAdRevenueNetwork.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setAdRevenueNetwork(string adRevenueNetwork) -``` diff --git a/src/code-snippets/unity/signatures/AdjustAdRevenue/setAdRevenuePlacement.mdx b/src/code-snippets/unity/signatures/AdjustAdRevenue/setAdRevenuePlacement.mdx deleted file mode 100644 index f58233079..000000000 --- a/src/code-snippets/unity/signatures/AdjustAdRevenue/setAdRevenuePlacement.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setAdRevenuePlacement(string adRevenuePlacement) -``` diff --git a/src/code-snippets/unity/signatures/AdjustAdRevenue/setAdRevenueUnit.mdx b/src/code-snippets/unity/signatures/AdjustAdRevenue/setAdRevenueUnit.mdx deleted file mode 100644 index c08dc52d2..000000000 --- a/src/code-snippets/unity/signatures/AdjustAdRevenue/setAdRevenueUnit.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setAdRevenueUnit(string adRevenueUnit) -``` diff --git a/src/code-snippets/unity/signatures/AdjustAdRevenue/setRevenue.mdx b/src/code-snippets/unity/signatures/AdjustAdRevenue/setRevenue.mdx deleted file mode 100644 index 7dbb3d754..000000000 --- a/src/code-snippets/unity/signatures/AdjustAdRevenue/setRevenue.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setRevenue(double amount, string currency) -``` diff --git a/src/code-snippets/unity/signatures/AdjustAppStoreSubscription/addCallbackParameter.mdx b/src/code-snippets/unity/signatures/AdjustAppStoreSubscription/addCallbackParameter.mdx deleted file mode 100644 index ce33a7eb2..000000000 --- a/src/code-snippets/unity/signatures/AdjustAppStoreSubscription/addCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void addCallbackParameter(string key, string value) -``` diff --git a/src/code-snippets/unity/signatures/AdjustAppStoreSubscription/addPartnerParameter.mdx b/src/code-snippets/unity/signatures/AdjustAppStoreSubscription/addPartnerParameter.mdx deleted file mode 100644 index 73d65a444..000000000 --- a/src/code-snippets/unity/signatures/AdjustAppStoreSubscription/addPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void addPartnerParameter(string key, string value) -``` diff --git a/src/code-snippets/unity/signatures/AdjustAppStoreSubscription/constructor.mdx b/src/code-snippets/unity/signatures/AdjustAppStoreSubscription/constructor.mdx deleted file mode 100644 index b11097f28..000000000 --- a/src/code-snippets/unity/signatures/AdjustAppStoreSubscription/constructor.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public AdjustAppStoreSubscription(string price, string currency, string transactionId, string receipt) -``` diff --git a/src/code-snippets/unity/signatures/AdjustAppStoreSubscription/setSalesRegion.mdx b/src/code-snippets/unity/signatures/AdjustAppStoreSubscription/setSalesRegion.mdx deleted file mode 100644 index 19be9eda9..000000000 --- a/src/code-snippets/unity/signatures/AdjustAppStoreSubscription/setSalesRegion.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setSalesRegion(string salesRegion) -``` diff --git a/src/code-snippets/unity/signatures/AdjustAppStoreSubscription/setTransactionDate.mdx b/src/code-snippets/unity/signatures/AdjustAppStoreSubscription/setTransactionDate.mdx deleted file mode 100644 index d43fb6bdf..000000000 --- a/src/code-snippets/unity/signatures/AdjustAppStoreSubscription/setTransactionDate.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setTransactionDate(string transactionDate) -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/constructor.mdx b/src/code-snippets/unity/signatures/AdjustConfig/constructor.mdx deleted file mode 100644 index cc397e686..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/constructor.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public AdjustConfig(string appToken, AdjustEnvironment environment, bool allowSuppressLogLevel) -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/deactivateSKAdNetworkHandling.mdx b/src/code-snippets/unity/signatures/AdjustConfig/deactivateSKAdNetworkHandling.mdx deleted file mode 100644 index 5e14858fe..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/deactivateSKAdNetworkHandling.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void deactivateSKAdNetworkHandling() -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/sendInBackground.mdx b/src/code-snippets/unity/signatures/AdjustConfig/sendInBackground.mdx deleted file mode 100644 index 10f2ecb20..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/sendInBackground.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setSendInBackground(bool sendInBackground) -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/setAttributionChangedDelegate.mdx b/src/code-snippets/unity/signatures/AdjustConfig/setAttributionChangedDelegate.mdx deleted file mode 100644 index 2db819a58..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/setAttributionChangedDelegate.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setAttributionChangedDelegate(Action attributionChangedDelegate, string sceneName = "Adjust") -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/setConversionValueUpdatedDelegate.mdx b/src/code-snippets/unity/signatures/AdjustConfig/setConversionValueUpdatedDelegate.mdx deleted file mode 100644 index 0cda53822..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/setConversionValueUpdatedDelegate.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setConversionValueUpdatedDelegate(Action conversionValueUpdatedDelegate, string sceneName = "Adjust") -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/setCoppaCompliantEnabled.mdx b/src/code-snippets/unity/signatures/AdjustConfig/setCoppaCompliantEnabled.mdx deleted file mode 100644 index b106504a9..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/setCoppaCompliantEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setCoppaCompliantEnabled(bool coppaCompliantEnabled) -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/setDefaultTracker.mdx b/src/code-snippets/unity/signatures/AdjustConfig/setDefaultTracker.mdx deleted file mode 100644 index 28422d520..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/setDefaultTracker.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setDefaultTracker(string defaultTracker) -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/setDelayStart.mdx b/src/code-snippets/unity/signatures/AdjustConfig/setDelayStart.mdx deleted file mode 100644 index bffea4a62..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/setDelayStart.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setDelayStart(double delayStart) -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/setEventBufferingEnabled.mdx b/src/code-snippets/unity/signatures/AdjustConfig/setEventBufferingEnabled.mdx deleted file mode 100644 index 4612b66ff..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/setEventBufferingEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setEventBufferingEnabled(bool eventBufferingEnabled) -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/setEventFailureDelegate.mdx b/src/code-snippets/unity/signatures/AdjustConfig/setEventFailureDelegate.mdx deleted file mode 100644 index 782013127..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/setEventFailureDelegate.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setEventFailureDelegate(Action eventFailureDelegate, string sceneName = "Adjust") -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/setEventSuccessDelegate.mdx b/src/code-snippets/unity/signatures/AdjustConfig/setEventSuccessDelegate.mdx deleted file mode 100644 index 503e92307..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/setEventSuccessDelegate.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setEventSuccessDelegate(Action eventSuccessDelegate, string sceneName = "Adjust") -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/setExternalDeviceId.mdx b/src/code-snippets/unity/signatures/AdjustConfig/setExternalDeviceId.mdx deleted file mode 100644 index 41c8f3be5..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/setExternalDeviceId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setExternalDeviceId(string externalDeviceId) -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/setLaunchDeferredDeeplink.mdx b/src/code-snippets/unity/signatures/AdjustConfig/setLaunchDeferredDeeplink.mdx deleted file mode 100644 index cceb7b3b4..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/setLaunchDeferredDeeplink.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setLaunchDeferredDeeplink(bool launchDeferredDeeplink) -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/setLinkMeEnabled.mdx b/src/code-snippets/unity/signatures/AdjustConfig/setLinkMeEnabled.mdx deleted file mode 100644 index 489e1863e..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/setLinkMeEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setLinkMeEnabled(bool linkMeEnabled) -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/setLogDelegate.mdx b/src/code-snippets/unity/signatures/AdjustConfig/setLogDelegate.mdx deleted file mode 100644 index 658b8febf..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/setLogDelegate.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setLogDelegate(Action logDelegate) -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/setLogLevel.mdx b/src/code-snippets/unity/signatures/AdjustConfig/setLogLevel.mdx deleted file mode 100644 index aa3f3266f..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/setLogLevel.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setLogLevel(AdjustLogLevel logLevel) -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/setNeedsCost.mdx b/src/code-snippets/unity/signatures/AdjustConfig/setNeedsCost.mdx deleted file mode 100644 index 51a08d212..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/setNeedsCost.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setNeedsCost(bool needsCost) -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/setPreinstallFilePath.mdx b/src/code-snippets/unity/signatures/AdjustConfig/setPreinstallFilePath.mdx deleted file mode 100644 index d06bb3a6b..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/setPreinstallFilePath.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setPreinstallFilePath(string preinstallFilePath) -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/setPreinstallTrackingEnabled.mdx b/src/code-snippets/unity/signatures/AdjustConfig/setPreinstallTrackingEnabled.mdx deleted file mode 100644 index f2ab7230e..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/setPreinstallTrackingEnabled.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setPreinstallTrackingEnabled(bool preinstallTrackingEnabled) -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/setSessionFailureDelegate.mdx b/src/code-snippets/unity/signatures/AdjustConfig/setSessionFailureDelegate.mdx deleted file mode 100644 index f6f7db8a7..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/setSessionFailureDelegate.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setSessionFailureDelegate(Action sessionFailureDelegate, string sceneName = "Adjust") -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/setSessionSuccessDelegate.mdx b/src/code-snippets/unity/signatures/AdjustConfig/setSessionSuccessDelegate.mdx deleted file mode 100644 index 1a629c140..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/setSessionSuccessDelegate.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setSessionSuccessDelegate(Action sessionSuccessDelegate, string sceneName = "Adjust") -``` diff --git a/src/code-snippets/unity/signatures/AdjustConfig/setUrlStrategy.mdx b/src/code-snippets/unity/signatures/AdjustConfig/setUrlStrategy.mdx deleted file mode 100644 index 98c7552f5..000000000 --- a/src/code-snippets/unity/signatures/AdjustConfig/setUrlStrategy.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setUrlStrategy(String urlStrategy) -``` diff --git a/src/code-snippets/unity/signatures/AdjustEvent/addCallbackParameter.mdx b/src/code-snippets/unity/signatures/AdjustEvent/addCallbackParameter.mdx deleted file mode 100644 index ce33a7eb2..000000000 --- a/src/code-snippets/unity/signatures/AdjustEvent/addCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void addCallbackParameter(string key, string value) -``` diff --git a/src/code-snippets/unity/signatures/AdjustEvent/addPartnerParameter.mdx b/src/code-snippets/unity/signatures/AdjustEvent/addPartnerParameter.mdx deleted file mode 100644 index 73d65a444..000000000 --- a/src/code-snippets/unity/signatures/AdjustEvent/addPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void addPartnerParameter(string key, string value) -``` diff --git a/src/code-snippets/unity/signatures/AdjustEvent/constructor.mdx b/src/code-snippets/unity/signatures/AdjustEvent/constructor.mdx deleted file mode 100644 index 98fce8b2b..000000000 --- a/src/code-snippets/unity/signatures/AdjustEvent/constructor.mdx +++ /dev/null @@ -1,7 +0,0 @@ -```c# -public AdjustEvent(string eventToken) -{ - this.eventToken = eventToken; - this.isReceiptSet = false; -} -``` diff --git a/src/code-snippets/unity/signatures/AdjustEvent/setCallbackId.mdx b/src/code-snippets/unity/signatures/AdjustEvent/setCallbackId.mdx deleted file mode 100644 index 2bef45b39..000000000 --- a/src/code-snippets/unity/signatures/AdjustEvent/setCallbackId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setCallbackId(string callbackId) -``` diff --git a/src/code-snippets/unity/signatures/AdjustEvent/setRevenue.mdx b/src/code-snippets/unity/signatures/AdjustEvent/setRevenue.mdx deleted file mode 100644 index 7dbb3d754..000000000 --- a/src/code-snippets/unity/signatures/AdjustEvent/setRevenue.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setRevenue(double amount, string currency) -``` diff --git a/src/code-snippets/unity/signatures/AdjustEvent/setTransactionId.mdx b/src/code-snippets/unity/signatures/AdjustEvent/setTransactionId.mdx deleted file mode 100644 index 26dbc9ffd..000000000 --- a/src/code-snippets/unity/signatures/AdjustEvent/setTransactionId.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setTransactionId(string transactionId) -``` diff --git a/src/code-snippets/unity/signatures/AdjustPlayStoreSubscription/addCallbackParameter.mdx b/src/code-snippets/unity/signatures/AdjustPlayStoreSubscription/addCallbackParameter.mdx deleted file mode 100644 index ce33a7eb2..000000000 --- a/src/code-snippets/unity/signatures/AdjustPlayStoreSubscription/addCallbackParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void addCallbackParameter(string key, string value) -``` diff --git a/src/code-snippets/unity/signatures/AdjustPlayStoreSubscription/addPartnerParameter.mdx b/src/code-snippets/unity/signatures/AdjustPlayStoreSubscription/addPartnerParameter.mdx deleted file mode 100644 index 73d65a444..000000000 --- a/src/code-snippets/unity/signatures/AdjustPlayStoreSubscription/addPartnerParameter.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void addPartnerParameter(string key, string value) -``` diff --git a/src/code-snippets/unity/signatures/AdjustPlayStoreSubscription/constructor.mdx b/src/code-snippets/unity/signatures/AdjustPlayStoreSubscription/constructor.mdx deleted file mode 100644 index 36e9e148b..000000000 --- a/src/code-snippets/unity/signatures/AdjustPlayStoreSubscription/constructor.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public AdjustPlayStoreSubscription(string price, string currency, string sku, string orderId, string signature, string purchaseToken) -``` diff --git a/src/code-snippets/unity/signatures/AdjustPlayStoreSubscription/setPurchaseTime.mdx b/src/code-snippets/unity/signatures/AdjustPlayStoreSubscription/setPurchaseTime.mdx deleted file mode 100644 index cf6574f65..000000000 --- a/src/code-snippets/unity/signatures/AdjustPlayStoreSubscription/setPurchaseTime.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void setPurchaseTime(string purchaseTime) -``` diff --git a/src/code-snippets/unity/signatures/AdjustThirdPartySharing/addGranularOption.mdx b/src/code-snippets/unity/signatures/AdjustThirdPartySharing/addGranularOption.mdx deleted file mode 100644 index 3c25882d7..000000000 --- a/src/code-snippets/unity/signatures/AdjustThirdPartySharing/addGranularOption.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void addGranularOption(string partnerName, string key, string value) -``` diff --git a/src/code-snippets/unity/signatures/AdjustThirdPartySharing/addPartnerSharingSetting.mdx b/src/code-snippets/unity/signatures/AdjustThirdPartySharing/addPartnerSharingSetting.mdx deleted file mode 100644 index 20125aa3d..000000000 --- a/src/code-snippets/unity/signatures/AdjustThirdPartySharing/addPartnerSharingSetting.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```c# -public void addPartnerSharingSetting(string partnerName, string key, bool value) -``` diff --git a/src/code-snippets/unity/signatures/AdjustThirdPartySharing/constructor.mdx b/src/code-snippets/unity/signatures/AdjustThirdPartySharing/constructor.mdx deleted file mode 100644 index f12bf33bf..000000000 --- a/src/code-snippets/unity/signatures/AdjustThirdPartySharing/constructor.mdx +++ /dev/null @@ -1,8 +0,0 @@ -```c# -public AdjustThirdPartySharing(bool? isEnabled) -{ - this.isEnabled = isEnabled; - this.granularOptions = new Dictionary>(); - this.partnerSharingSettings = new Dictionary>(); -} -``` diff --git a/src/content/docs/sdk/android/setup/preinstalled.mdx b/src/content/docs/sdk/android/setup/preinstalled.mdx index afae9e5b2..77f10195c 100644 --- a/src/content/docs/sdk/android/setup/preinstalled.mdx +++ b/src/content/docs/sdk/android/setup/preinstalled.mdx @@ -50,11 +50,11 @@ The Adjust SDK provides 5 methods for measuring preinstalled apps: - [Content provider](#content-provider) - [System installer receiver](#system-installer-receiver) - [World-readable directory](#world-readable-directory) -- [Default campaign token](#default-campaign-token) +- [Default link token](#default-link-token) ## System properties -Original Equipment Manufacturer (OEM) partners can leverage Android system properties to attribute preinstalled apps. The OEM (Original Equipment Manufacturer) writes attribution information to a file and adds its path to the system properties. The Adjust SDK reads this file on initialization to attribute the install. +Original Equipment Manufacturer (OEM) partners can leverage Android system properties to attribute preinstalled apps. The OEM (Original Equipment Manufacturer) writes attribution information to a file and adds its path to the system properties. The Adjust SDK reads this file on initialization to attribute the install. ## Content provider diff --git a/src/content/docs/sdk/unity/configuration.mdx b/src/content/docs/sdk/unity/configuration.mdx new file mode 100644 index 000000000..537b42f36 --- /dev/null +++ b/src/content/docs/sdk/unity/configuration.mdx @@ -0,0 +1,266 @@ +--- +title: Configuration +description: Follow the guides in this section to configure the Adjust SDK. +slug: en/sdk/unity/configuration +sidebar-position: 1 +--- + +Use the methods in this document to configure the behavior of the Adjust SDK. + +## Instantiate your config object + +```cs title="Method signature" +public AdjustConfig(string appToken, AdjustEnvironment environment, bool allowSuppressLogLevel) +``` + +To configure the Adjust SDK, you need to instantiate an `AdjustConfig` 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 `AdjustConfig` instance and pass the following parameters: + +- `appToken` (**String**): Your [Adjust app token](https://help.adjust.com/en/article/app-token-and-reporting-currency#view-your-app-details). +- `environment` (**AdjustEnvironment**): The environment you want to run the SDK in. Pass `AdjustEnvironment.sandbox` to run the SDK in sandbox mode for testing. Pass `AdjustEnvironment.production` to run the SDK in production mode for release. +- `allowSuppressLogLevel` (Boolean): Whether to suppress all logging. Set to `true` to suppress logging or `false` to enable logging. + +```cs {1} +AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox); +// ... +Adjust.start(adjustConfig); +``` + +## Read-only configuration + +**Read-only** configuration options are set in your `AdjustConfig` 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.start()`. + +### Set your logging level + +```cs title="Method signature" +public void setLogLevel(AdjustLogLevel logLevel); +``` + +The Adjust SDK provides configurable log levels to return different amounts of information. The following log levels are available: + + + +| Log level | Description | +| ------------------------- | ------------------------------------------ | +| `AdjustLogLevel.Verbose` | Enable all logging | +| `AdjustLogLevel.Debug` | Enable debug logging | +| `AdjustLogLevel.Info` | Only show info level logs (default option) | +| `AdjustLogLevel.Warn` | Disable info logging | +| `AdjustLogLevel.Error` | Disable warning level logging and below | +| `AdjustLogLevel.Assert` | Disable error level logging and below | +| `AdjustLogLevel.Suppress` | Suppress all logging | + +
+ +You can set your log level by calling the `setLogLevel` method on your `AdjustConfig` instance with the following parameter: + +- `logLevel` (**LogLevel**): The log level you want to use. + +```cs {3} +AdjustConfig config = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); +//... +config.setLogLevel(AdjustLogLevel.Error); +//... +Adjust.start(config); +``` + +### Set external device identifier + +```cs title="Method signature" +public void setExternalDeviceId(string 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. You can set property calling the `setExternalDeviceId` method with the following parameter: + +- `externalDeviceId` (**String**): 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. + + + +```cs {3} +AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); +//... +adjustConfig.setExternalDeviceId("{Your-External-Device-Id}"); +//... +Adjust.start(adjustConfig); +``` + +If you want to use the external device ID in your business analytics, you can pass it as a [session callback parameter](/en/sdk/flutter/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 + +```cs title="Method signature" +public void setDefaultTracker(string 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. To set your default link token, call the `setDefaultTracker` method with the following argument: + +- `defaultTracker` (**String**): The [Adjust link token](https://help.adjust.com/en/article/links#adjust-link-token) you want to record preinstalled installs against. + +```cs {3} +AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox); +//... +adjustConfig.setDefaultTracker("{TrackerToken}"); +//... +Adjust.start(adjustConfig); +``` + +### Enable cost data sending + +```cs title="Method signature" +public void setNeedsCost(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, call the `setNeedsCost` method on your config instance with the following parameter: + +- `needsCost` (**Boolean**): 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/unity/features/attribution). + +```cs {3} +AdjustConfig adjustConfig = new AdjustConfig("{Your App Token}", AdjustEnvironment.Sandbox); +adjustConfig.setLogLevel(AdjustLogLevel.Verbose); +adjustConfig.setNeedsCost(true); +``` + +### Enable background recording + +```cs title="Method signature" +public void setSendInBackground(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, call the `setSendInBackground` method on your config instance with the following parameter: + +- `sendInBackground` (**Boolean**): Set to `true` to enable background sending or `false` to disable background sending. + +```cs {3} +AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox); +//... +adjustConfig.setSendInBackground(true); +//... +Adjust.start(adjustConfig); +``` + +### Enable event buffering + +```cs title="Method" +public void setEventBufferingEnabled(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. You can set this property by calling the `setEventBufferingEnabled` method on your config object with the following parameter: + +- `eventBufferingEnabled` (**Boolean**): Set to `true` to enable event buffering or `false` to disable event buffering. + +```cs {3} +AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox); +//... +adjustConfig.setEventBufferingEnabled(true); +//... +Adjust.start(adjustConfig); +``` + +### Delay the start of the SDK + +```cs title="Method signature" +public void setDelayStart(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/android/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, call the `setDelayStart` method with the following argument: + +- `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**. + +```cs {3} +AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox); +//... +adjustConfig.setDelayStart(5.5); +//... +Adjust.start(adjustConfig); +``` + +## 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 + +```cs title="Method signature" +public static void setEnabled(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` (Boolean): Set to `true` to enable offline mode or `false` to disable offline mode. + +```cs +Adjust.setEnabled(false); +``` + +### Set push tokens + +```cs title="Method signature" +public static void setDeviceToken(string 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 string `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` (**String**): Your push token. + +```cs +Adjust.setDeviceToken("{YourDeviceToken}"); +``` + +### Disable or enable the SDK + + + +You can only call this method after the first session. This setting persists between sessions. + + + +```cs title="Method signature" +public static 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` (Boolean): Set to `true` to enable the SDK or `false` to disable the SDK. + +```cs +Adjust.setEnabled(false); +``` + +#### Check enabled status + +```cs title="Method signature" +public static 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`). + +```cs +Adjust.isEnabled(); +``` diff --git a/src/content/docs/sdk/unity/configuration/background.mdx b/src/content/docs/sdk/unity/configuration/background.mdx deleted file mode 100644 index 629f95ad4..000000000 --- a/src/content/docs/sdk/unity/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/unity/configuration/background ---- - -import SetSendInBackground from "@unity-examples/AdjustConfig/sendInBackground.mdx" -import SetSendInBackgroundSig from "@unity-signatures/AdjustConfig/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/unity/configuration/delay.mdx b/src/content/docs/sdk/unity/configuration/delay.mdx deleted file mode 100644 index 84d9285cb..000000000 --- a/src/content/docs/sdk/unity/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/unity/configuration/delay ---- - -import SetOfflineMode from "@unity-examples/Adjust/setOfflineMode.mdx" -import SetOfflineModeSig from "@unity-signatures/Adjust/setOfflineMode.mdx" -import SetEventBufferingEnabled from "@unity-examples/AdjustConfig/setEventBufferingEnabled.mdx" -import SetEventBufferingEnabledSig from "@unity-signatures/AdjustConfig/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/unity/configuration/disable.mdx b/src/content/docs/sdk/unity/configuration/disable.mdx deleted file mode 100644 index 38a2d7d73..000000000 --- a/src/content/docs/sdk/unity/configuration/disable.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Disable the Adjust SDK -description: Disable the Adjust SDK to pause recording. -slug: en/sdk/unity/configuration/disable ---- - -import SetEnabled from "@unity-examples/Adjust/setEnabled.mdx" -import SetEnabledSig from "@unity-signatures/Adjust/setEnabled.mdx" -import IsEnabled from "@unity-examples/Adjust/isEnabled.mdx" -import IsEnabledSig from "@unity-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 generate a button to enable or disable the Adjust SDK. The button displays the correct action based on the value of the txtSetEnabled variable. - -* When `txtSetEnabled` = `"Disable SDK"`, the button disables the SDK and sets `txtSetEnabled` to `"Enable SDK"`. -* When `txtSetEnabled` = `"Enable SDK"`, the button enables the SDK and sets `txtSetEnabled` to `"Disable SDK"`. - -```c# -private string txtSetEnabled = "Disable SDK"; - -if (GUI.Button(new Rect(0, Screen.height * 6 / numberOfButtons, Screen.width, Screen.height / numberOfButtons), txtSetEnabled)) { - if (string.Equals(txtSetEnabled, "Disable SDK", StringComparison.OrdinalIgnoreCase)) { - Adjust.setEnabled(false); - txtSetEnabled = "Enable SDK"; - } - else { - Adjust.setEnabled(true); - txtSetEnabled = "Disable SDK"; - } -} -``` diff --git a/src/content/docs/sdk/unity/configuration/external-device-id.mdx b/src/content/docs/sdk/unity/configuration/external-device-id.mdx deleted file mode 100644 index fe2352ffd..000000000 --- a/src/content/docs/sdk/unity/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/unity/configuration/external-device-id ---- - -import SetExternalDeviceId from "@unity-examples/AdjustConfig/setExternalDeviceId.mdx" -import SetExternalDeviceIdSig from "@unity-signatures/AdjustConfig/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/unity/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/unity/configuration/index.mdx b/src/content/docs/sdk/unity/configuration/index.mdx deleted file mode 100644 index ae927950c..000000000 --- a/src/content/docs/sdk/unity/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/unity/configuration -type: category ---- - -Follow the guides in this section to configure the Adjust SDK. diff --git a/src/content/docs/sdk/unity/configuration/log-level.mdx b/src/content/docs/sdk/unity/configuration/log-level.mdx deleted file mode 100644 index e06c43921..000000000 --- a/src/content/docs/sdk/unity/configuration/log-level.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: Set log level -description: Configure the Adjust SDK's logging verbosity. -slug: en/sdk/unity/configuration/log-level ---- - -import SetLogLevel from "@unity-examples/AdjustConfig/setLogLevel.mdx"; -import SetLogLevelSig from "@unity-signatures/AdjustConfig/setLogLevel.mdx"; -import SetLogDelegate from "@unity-examples/AdjustConfig/setLogDelegate.mdx"; -import SetLogDelegateSig from "@unity-signatures/AdjustConfig/setLogDelegate.mdx"; - -The Adjust SDK provides configurable log levels to return different amounts of information. The following log levels are available: - - - -| Log level | Description | -| ------------------------- | ------------------------------------------ | -| `AdjustLogLevel.Verbose` | Enable all logging | -| `AdjustLogLevel.Debug` | Enable debug logging | -| `AdjustLogLevel.Info` | Only show info level logs (default option) | -| `AdjustLogLevel.Warn` | Disable info logging | -| `AdjustLogLevel.Error` | Disable warning level logging and below | -| `AdjustLogLevel.Assert` | Disable error level logging and below | -| `AdjustLogLevel.Suppress` | Suppress all logging | - -
- -You can set your log level by calling the `setLogLevel` method on your `AdjustConfig` instance. - - - -## Disable all logging - -To disable all log output when initializing the SDK manually, call `setLogLevel(AdjustLogLevel.Suppress)` on your config instance. You need to set `allowSuppressLogLevel` by passing a `true` value as the third argument in your `AdjustConfig` declaration. - -```c# {3} -AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); -//... -adjustConfig.setLogLevel(AdjustLogLevel.Suppress); -//... -Adjust.start(adjustConfig); -``` - -## View compiled logs on Windows - -If your target is Windows-based and you want to see the compiled logs from the SDK in **Production** mode, redirect the log output to your app while testing it in **Sandbox** mode. - -To register a log delegate, call the `setLogDelegate` method on your `AdjustConfig` instance. - - - -You must call the `setLogDelegate` method **before** you initialize the Adjust SDK. - - - - diff --git a/src/content/docs/sdk/unity/configuration/push-tokens.mdx b/src/content/docs/sdk/unity/configuration/push-tokens.mdx deleted file mode 100644 index 267167a1b..000000000 --- a/src/content/docs/sdk/unity/configuration/push-tokens.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Set up push tokens -description: Configure push tokens for your app. -slug: en/sdk/unity/configuration/push-tokens ---- - -import SetDeviceToken from "@unity-examples/Adjust/setDeviceToken.mdx" -import SetDeviceTokenSig from "@unity-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 and passing your token as an argument. - - - -## Example - -This example shows how to set a new push token with the value _`HrFmrcq96tj723aWFfrw`_ to track your app's retention rates. You can update this value at any time by passing a new token to the `setDeviceToken` method as an argument: - -```c# '"HrFmrcq96tj723aWFfrw"' -Adjust.setDeviceToken("HrFmrcq96tj723aWFfrw"); -``` diff --git a/src/content/docs/sdk/unity/features/ad-revenue.mdx b/src/content/docs/sdk/unity/features/ad-revenue.mdx index 198339fb6..61088f3c1 100644 --- a/src/content/docs/sdk/unity/features/ad-revenue.mdx +++ b/src/content/docs/sdk/unity/features/ad-revenue.mdx @@ -4,23 +4,6 @@ description: Record ad revenue information for supported network partners using slug: en/sdk/unity/features/ad-revenue --- -import TrackAdRevenue from "@unity-examples/Adjust/trackAdRevenue.mdx"; -import TrackAdRevenueSig from "@unity-signatures/Adjust/trackAdRevenue.mdx"; -import SetRevenue from "@unity-examples/AdjustAdRevenue/setRevenue.mdx"; -import SetRevenueSig from "@unity-signatures/AdjustAdRevenue/setRevenue.mdx"; -import SetAdImpressionsCount from "@unity-examples/AdjustAdRevenue/setAdImpressionsCount.mdx"; -import SetAdImpressionsCountSig from "@unity-signatures/AdjustAdRevenue/setAdImpressionsCount.mdx"; -import SetAdRevenueNetwork from "@unity-examples/AdjustAdRevenue/setAdRevenueNetwork.mdx"; -import SetAdRevenueNetworkSig from "@unity-signatures/AdjustAdRevenue/setAdRevenueNetwork.mdx"; -import SetAdRevenueUnit from "@unity-examples/AdjustAdRevenue/setAdRevenueUnit.mdx"; -import SetAdRevenueUnitSig from "@unity-signatures/AdjustAdRevenue/setAdRevenueUnit.mdx"; -import SetAdRevenuePlacement from "@unity-examples/AdjustAdRevenue/setAdRevenuePlacement.mdx"; -import SetAdRevenuePlacementSig from "@unity-signatures/AdjustAdRevenue/setAdRevenuePlacement.mdx"; -import AddCallbackParameter from "@unity-examples/AdjustAdRevenue/addCallbackParameter.mdx"; -import AddCallbackParameterSig from "@unity-signatures/AdjustAdRevenue/addCallbackParameter.mdx"; -import AddPartnerParameter from "@unity-examples/AdjustAdRevenue/addPartnerParameter.mdx"; -import AddPartnerParameterSig from "@unity-signatures/AdjustAdRevenue/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 AdjustAdRevenue object + +```cs title="Method signature" +public AdjustAdRevenue(string 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 `AdjustAdRevenue` 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 `AdjustAdRevenue` instance and pass the following parameters: -## Sources +- `source` (**String**): The source of the ad revenue. See the table below for available sources @@ -54,15 +40,35 @@ To send ad revenue to Adjust:
-## Record ad revenue amount +```cs {1} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +Adjust.trackAdRevenue(adjustAdRevenue); +``` -You can record ad revenue by setting the `revenue` and `currency` properties on your ad revenue instance. +## Send ad revenue -To set these properties, call the `setRevenue` method and pass the following arguments: +```cs title="Method signature" +public static void trackAdRevenue(AdjustAdRevenue adRevenue); +``` -`revenue` **number**: The amount of revenue +To send ad revenue to Adjust, call the `trackAdRevenue` method with your ad revenue instance as an argument. -`currency` **string**: The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of your reporting currency +```cs {3} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` + +## Record ad revenue amount + +```cs title="Method signature" +public void setRevenue(double amount, string currency); +``` + +To send the ad revenue amount, call the `setRevenue` method and pass the following arguments: + +- `revenue` (**Double**): The amount of revenue +- `currency` (**String**): The 3 character [ISO 4217 code](https://www.iban.com/currency-codes) of your reporting currency @@ -70,38 +76,96 @@ Check the [guide to tracking purchases in different currencies](https://help.adj - +```cs {3} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +//... +adjustAdRevenue.setRevenue(1.00, "EUR"); +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` ## Record ad campaign details -The ad revenue object contains properties you can use to report on your ad campaigns. +The `AdjustAdRevenue` 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. +```cs title="Method signature" +public void setAdImpressionsCount(int adImpressionsCount); +``` + +To send the number of recorded ad impressions, call the `setAdImpressionsCount` method and pass the following arguments: + +- `adImpressionsCount` (**Integer**): The number of ad impressions. - +```cs {3} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +//... +adjustAdRevenue.setAdImpressionsCount(10); +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` ### Ad revenue network -Record which network generated the revenue by passing a **string** value to the `setAdRevenueNetwork` method. +```cs title="Method signature" +public void setAdRevenueNetwork(string adRevenueNetwork); +``` + +To send the ad revenue network, call the `setAdRevenueNetwork` method and pass the following arguments: - +- `adRevenueNetwork` (**String**): The network name. + +```cs {3} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +//... +adjustAdRevenue.setAdRevenueNetwork("network1"); +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` ### Ad revenue unit -Record which ad revenue unit generated the revenue by passing a **string** value to the `setAdRevenueUnit` method. +```cs title="Method signature" +public void setAdRevenueUnit(string adRevenueUnit); +``` + +To send the ad revenue unit, call the `setAdRevenueUnit` method and pass the following arguments: - +- `adRevenueUnit` (**String**): The ad unit. + +```cs {3} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +//... +adjustAdRevenue.setAdRevenueUnit("unit1"); +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` ### Ad revenue placement -Record the placement of your ad by passing a **string** value to the `setAdRevenuePlacement` method. +```cs title="Method signature" +public void setAdRevenuePlacement(string adRevenuePlacement); +``` + +To send the ad revenue placement, call the `setAdRevenuePlacement` method and pass the following arguments: - +- `adRevenuePlacement` (**String**): The ad placement. + +```cs {3} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +//... +adjustAdRevenue.setAdRevenuePlacement("banner"); +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` ## Add callback parameters +```cs +public void addCallbackParameter(string key, string 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 +174,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 +194,20 @@ You can read more about using URL callbacks, including a full list of available - +```cs {3} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +//... +adjustAdRevenue.addCallbackParameter("key", "value"); +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` ## Add partner parameters +```cs +public void addPartnerParameter(string key, string 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 +220,13 @@ 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. - +```cs {3} +AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source"); +//... +adjustAdRevenue.addPartnerParameter("key", "value"); +//... +Adjust.trackAdRevenue(adjustAdRevenue); +``` ## Example @@ -161,7 +241,7 @@ This example shows how to set up and record an ad revenue object with the follow - A callback parameter: `"key1" = "value1"` - A partner parameter: `"key2" = "value2"` -```c# +```cs AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue(AdjustConfig.AdjustAdRevenueSourceAppLovinMAX); adjustAdRevenue.setRevenue(1.00, "EUR"); adjustAdRevenue.setAdImpressionsCount(10); diff --git a/src/content/docs/sdk/unity/configuration/att.mdx b/src/content/docs/sdk/unity/features/att.mdx similarity index 75% rename from src/content/docs/sdk/unity/configuration/att.mdx rename to src/content/docs/sdk/unity/features/att.mdx index 760ac0d0d..b0aca23ff 100644 --- a/src/content/docs/sdk/unity/configuration/att.mdx +++ b/src/content/docs/sdk/unity/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/unity/configuration/att +slug: en/sdk/unity/features/att --- -import RequestTrackingAuthorization from "@unity-examples/Adjust/requestTrackingAuthorization.mdx" -import AppTrackingAuthorizationStatus from "@unity-examples/Adjust/appTrackingAuthorizationStatus.mdx" -import AppTrackingAuthorizationStatusSig from "@unity-signatures/Adjust/appTrackingAuthorizationStatus.mdx" -import CheckForNewAttStatus from "@unity-examples/Adjust/checkForNewAttStatus.mdx" -import CheckForNewAttStatusSig from "@unity-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 @@ -33,6 +27,10 @@ You might receive a status code of `-1` if the SDK is unable to retrieve the ATT ## App-tracking authorization wrapper +```cs title="Method signature" +public static void requestTrackingAuthorizationWithCompletionHandler(Action statusCallback, string sceneName = "Adjust"); +``` + 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,13 +43,32 @@ The Adjust SDK also records the consent status if you use a custom prompt. If yo - +```cs +Adjust.requestTrackingAuthorizationWithCompletionHandler((status) => +{ + switch (status) + { + case 0: + // ATTrackingManagerAuthorizationStatusNotDetermined case + break; + case 1: + // ATTrackingManagerAuthorizationStatusRestricted case + break; + case 2: + // ATTrackingManagerAuthorizationStatusDenied case + break; + case 3: + // ATTrackingManagerAuthorizationStatusAuthorized case + break; + } +}); +``` ### Example This example shows how to log a human-readable description of the user's authorization status when they interact with a prompt. -```c# +```cs Adjust.requestTrackingAuthorizationWithCompletionHandler((status) => { switch (status) @@ -74,21 +91,33 @@ Adjust.requestTrackingAuthorizationWithCompletionHandler((status) => ## 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**. +```cs title="Method signature" +public static int getAppTrackingAuthorizationStatus(); +``` + +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**. - +```cs +Adjust.getAppTrackingAuthorizationStatus(); +``` ### Example This example shows how to collect the user's authorization status and convert it to a `String`. This information is assigned to a variable called `authorizationStatus` and passed as a session partner parameter with the key `"status"`. -```c# +```cs string authorizationStatus = Convert.ToString(Adjust.getAppTrackingAuthorizationStatus()); Adjust.addSessionPartnerParameter("status", authorizationStatus); ``` ## Check for authorization status changes +```cs title="Method signature" +public static 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. - +```cs +Adjust.checkForNewAttStatus(); +``` diff --git a/src/content/docs/sdk/unity/features/attribution.mdx b/src/content/docs/sdk/unity/features/attribution.mdx index 2ff3521f2..8c57894c1 100644 --- a/src/content/docs/sdk/unity/features/attribution.mdx +++ b/src/content/docs/sdk/unity/features/attribution.mdx @@ -4,14 +4,48 @@ description: Listen for attribution changes using the Adjust SDK slug: en/sdk/unity/features/attribution --- -import SetAttributionChangedDelegate from "@unity-examples/AdjustConfig/setAttributionChangedDelegate.mdx"; -import SetAttributionChangedDelegateSig from "@unity-signatures/AdjustConfig/setAttributionChangedDelegate.mdx"; -import Attribution from "@unity-examples/Adjust/getAttribution.mdx"; -import AttributionSig from "@unity-signatures/Adjust/getAttribution.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. +## AdjustAttribution class properties -To configure your callback function, call the `setAttributionChangedDelegate` method with your function name as an argument. +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 `AdjustConfig` instance](/en/sdk/android/configuration#enable-cost-data-sending) 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. | +| `fbInstallReferrer` | String | The [Facebook install referrer](https://developers.facebook.com/docs/app-ads/install-referrer/). _Android only_. | + +
+ +## Trigger a function when attribution changes + +```cs title="Method signature" +public void setAttributionChangedDelegate(Action attributionChangedDelegate, string sceneName = "Adjust"); +``` + +The SDK can listen for attribution changes and call a function when it detects an update. To configure your callback function, call the `setAttributionChangedDelegate` method with your function name as an argument. @@ -19,14 +53,34 @@ You must call the `setAttributionChangedDelegate` method **before** initializing - +```cs {8, 13-16} +using com.adjust.sdk; + +public class ExampleGUI : MonoBehaviour { + void OnGUI() { + if (GUI.Button(new Rect(0, 0, Screen.width, Screen.height), "callback")) { + AdjustConfig adjustConfig = new AdjustConfig("{Your App Token}", AdjustEnvironmentSandbox); + adjustConfig.setLogLevel(AdjustLogLevel.Verbose); + adjustConfig.setAttributionChangedDelegate(this.attributionChangedDelegate); + Adjust.start(adjustConfig); + } + } -Within your delegate function, you have access to the user's `Attribution` information. See the [`AdjustAttribution` class reference](/en/sdk/unity/reference/adjustattribution) for a list of available properties. + public void attributionChangedDelegate(AdjustAttribution attribution) { + Debug.Log("Attribution changed"); + // ... + } +} +``` ## 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 `getAttribution` method. +```cs title="Method signature" +public static AdjustAttribution getAttribution(); +``` -This method returns an Attribution object. See the [`AdjustAttribution` class reference](/en/sdk/unity/reference/adjustattribution) for a list of available properties. +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 `getAttribution` method to return the attribution information as an `AdjustAttribution` object. - +```cs +var attribution = Adjust.getAttribution(); +``` diff --git a/src/content/docs/sdk/unity/features/callbacks.mdx b/src/content/docs/sdk/unity/features/callbacks.mdx index 850903051..7efaec448 100644 --- a/src/content/docs/sdk/unity/features/callbacks.mdx +++ b/src/content/docs/sdk/unity/features/callbacks.mdx @@ -4,12 +4,7 @@ description: Set up callbacks to trigger functions when the SDK sends informatio slug: en/sdk/unity/features/callbacks --- -import SetSessionSuccessDelegate from "@unity-examples/AdjustConfig/setSessionSuccessDelegate.mdx"; -import SetEventSuccessDelegate from "@unity-examples/AdjustConfig/setEventSuccessDelegate.mdx"; -import SetSessionFailureDelegate from "@unity-examples/AdjustConfig/setSessionFailureDelegate.mdx"; -import SetEventFailureDelegate from "@unity-examples/AdjustConfig/setEventFailureDelegate.mdx"; - -Set up callbacks to trigger functions when the SDK sends information to Adjust. You can set up callbacks for sessions and events. +Set up callbacks to trigger functions when the SDK sends information to Adjust. You can set up callbacks for **sessions** and **events**. @@ -30,22 +25,36 @@ Session callbacks have access to a response data object. You can use its propert | `Message` | String | The message from the server or the error logged by the SDK. | | `Timestamp` | String | The timestamp from Adjust's servers. | | `Adid` | String | A unique device identifier provided by Adjust. | -| `JsonResponse` | Dictionary \ | The JSON object with the response from the server. | +| `JsonResponse` | Dictionary `` | The JSON object with the response from the server. | | `WillRetry` | Boolean | Indicates whether there will be an attempt to resend a failed package. | ### Success callbacks +```cs title="Method signature" +public void setSessionSuccessDelegate(Action sessionSuccessDelegate, string sceneName = "Adjust"); +``` + Set up success callbacks to trigger functions when the SDK records a session. - +```cs {3, 7-9} +AdjustConfig adjustConfig = new AdjustConfig("{Your App Token}", AdjustEnvironment.Sandbox); +adjustConfig.setLogLevel(AdjustLogLevel.Verbose); +adjustConfig.setSessionSuccessDelegate(SessionSuccessCallback); +//... +Adjust.start(adjustConfig); +//... +public void SessionSuccessCallback (AdjustSessionSuccess sessionSuccessData) { + //... +} +``` ### Example This example shows how to created a callback function `sessionSuccess` and register it as a **success** callback. The function logs the timestamp at which the SDK recorded the session. -```c# +```cs AdjustConfig adjustConfig = new AdjustConfig("{Your App Token}", AdjustEnvironment.Sandbox); adjustConfig.setLogLevel(AdjustLogLevel.Verbose); adjustConfig.setSessionSuccessDelegate(sessionSuccess); @@ -59,15 +68,29 @@ public void sessionSuccess (AdjustSessionSuccess sessionSuccessData) { ### Failure callbacks +```cs title="Method signature" +public void setSessionFailureDelegate(Action sessionFailureDelegate, string sceneName = "Adjust"); +``` + Set up failure callbacks to trigger functions when the SDK fails to record a session. - +```cs {3, 7-9} +AdjustConfig adjustConfig = new AdjustConfig("{Your App Token}", AdjustEnvironment.Sandbox); +adjustConfig.setLogLevel(AdjustLogLevel.Verbose); +adjustConfig.setSessionFailureDelegate(SessionFailureCallback); +//... +Adjust.start(adjustConfig); +//... +public void SessionFailureCallback (AdjustSessionFailure sessionFailureData) { + //... +} +``` ### Example This example shows how to created a callback function `sessionFailure` and register it as a **failure** callback. The function logs the session failure message. -```c# +```cs AdjustConfig adjustConfig = new AdjustConfig("{Your App Token}", AdjustEnvironment.Sandbox); adjustConfig.setLogLevel(AdjustLogLevel.Verbose); adjustConfig.setSessionFailureDelegate(sessionFailure); @@ -101,15 +124,29 @@ Event callbacks have access to a response data object. You can use its propertie ### Success callbacks +```cs title="Method signature" +public void setEventSuccessDelegate(Action eventSuccessDelegate, string sceneName = "Adjust"); +``` + Set up success callbacks to trigger functions when the SDK records an event. - +```cs {3, 7-9} +AdjustConfig adjustConfig = new AdjustConfig("{Your App Token}", AdjustEnvironment.Sandbox); +adjustConfig.setLogLevel(AdjustLogLevel.Verbose); +adjustConfig.setEventSuccessDelegate(EventSuccessCallback); +//... +Adjust.start(adjustConfig); +//... +public void EventSuccessCallback(AdjustEventSuccess eventSuccessData) { + //... +} +``` ### Example This example shows how to created a callback function `eventSuccess` and register it as a **success** callback. The function logs the timestamp at which the SDK recorded the event. -```c# +```cs AdjustConfig adjustConfig = new AdjustConfig("{Your App Token}", AdjustEnvironment.Sandbox); adjustConfig.setLogLevel(AdjustLogLevel.Verbose); adjustConfig.setEventSuccessDelegate(eventSuccess); @@ -123,15 +160,29 @@ public void eventSuccess (AdjustEventSuccess eventSuccessData) { ### Failure callbacks +```cs title="Method signature" +public void setEventFailureDelegate(Action eventFailureDelegate, string sceneName = "Adjust"); +``` + Set up failure callbacks to trigger functions when the SDK fails to record an event. - +```cs {3, 7-9} +AdjustConfig adjustConfig = new AdjustConfig("{Your App Token}", AdjustEnvironment.Sandbox); +adjustConfig.setLogLevel(AdjustLogLevel.Verbose); +adjustConfig.setEventFailureDelegate(EventFailureCallback); +//... +Adjust.start(adjustConfig); +//... +public void EventFailureCallback(AdjustEventFailure eventFailureData) { + //... +} +``` ### Example This example shows how to created a callback function `eventFailure` and register it as a **failure** callback. The function logs the event failure message. -```c# +```cs AdjustConfig adjustConfig = new AdjustConfig("{Your App Token}", AdjustEnvironment.Sandbox); adjustConfig.setLogLevel(AdjustLogLevel.Verbose); adjustConfig.setEventFailureDelegate(eventFailure); diff --git a/src/content/docs/sdk/unity/configuration/deep-links.mdx b/src/content/docs/sdk/unity/features/deep-links.mdx similarity index 76% rename from src/content/docs/sdk/unity/configuration/deep-links.mdx rename to src/content/docs/sdk/unity/features/deep-links.mdx index 5ca6c8618..deddb9b57 100644 --- a/src/content/docs/sdk/unity/configuration/deep-links.mdx +++ b/src/content/docs/sdk/unity/features/deep-links.mdx @@ -2,23 +2,15 @@ title: Deep linking description: Follow the guides in this section to set up deep linking. category-title: Deep linking -slug: en/sdk/unity/configuration/deep-links +slug: en/sdk/unity/features/deep-links --- -import SetLinkMeEnabled from "@unity-examples/AdjustConfig/setLinkMeEnabled.mdx" -import SetLinkMeEnabledSig from "@unity-signatures/AdjustConfig/setLinkMeEnabled.mdx" -import SetLaunchDeferredDeeplink from "@unity-examples/AdjustConfig/setLaunchDeferredDeeplink.mdx" -import SetLaunchDeferredDeeplinkSig from "@unity-signatures/AdjustConfig/setLaunchDeferredDeeplink.mdx" +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: -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. +- 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 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. +The SDK can read deep link data after a user opens your app from a link. ## Set up deep linking @@ -64,15 +56,29 @@ Android devices use a unique URI scheme to handle deep links. To set up deep lin ### Disable deferred deep linking +```cs title="Method signature" +public void setLaunchDeferredDeeplink(bool launchDeferredDeeplink); +``` + The SDK opens deferred deep links by default. You can configure this by passing a **boolean** argument to the `setLaunchDeferredDeeplink` method. - +```cs {3} +AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox); +//... +adjustConfig.setLaunchDeferredDeeplink(true); +//... +Adjust.start(adjustConfig); +``` ### Set up a deferred deep link delegate +```cs title="Method signature" +public void setDeferredDeeplinkDelegate(Action deferredDeeplinkDelegate, string sceneName = "Adjust"); +``` + You can configure the Adjust SDK to call a delegate function when it receives a deferred deep link. This delegate function receives the deep link as a **string** argument. -```c# {1-3, 6} +```cs {1-3, 6} private void DeferredDeeplinkCallback(string deeplinkURL) { //... } @@ -86,7 +92,7 @@ Adjust.start(adjustConfig); This example shows how to log a deep link address when the user opens a deferred deep link. -```c# +```cs private void LogDeepLink(string deepLinkURL) { Debug.Log("Deeplink URL: " + deeplinkURL); } @@ -99,6 +105,10 @@ Adjust.start(adjustConfig); ### Enable LinkMe +```cs title="Method signature" +public void setLinkMeEnabled(bool linkMeEnabled); +``` + The Adjust SDK lets you copy deep link information from the device pasteboard. When combined with Adjust’s LinkMe solution, this feature enables deferred deep linking on devices running iOS 15 and above. @@ -111,4 +121,10 @@ 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 config object: - +```cs {3} +AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); +//... +adjustConfig.setLinkMeEnabled(true); +//... +Adjust.start(adjustConfig); +``` diff --git a/src/content/docs/sdk/unity/features/device-info.mdx b/src/content/docs/sdk/unity/features/device-info.mdx index 1cbfbbbb8..241d8f734 100644 --- a/src/content/docs/sdk/unity/features/device-info.mdx +++ b/src/content/docs/sdk/unity/features/device-info.mdx @@ -4,41 +4,58 @@ description: Use these methods to add details to your callbacks and improve your slug: en/sdk/unity/features/device-info --- -import GetIdfa from "@unity-examples/Adjust/getIdfa.mdx" -import GetIdfaSig from "@unity-signatures/Adjust/getIdfa.mdx" -import GetAdid from "@unity-examples/Adjust/getAdid.mdx" -import GetAdidSig from "@unity-signatures/Adjust/getAdid.mdx" -import GetAmazonAdId from "@unity-examples/Adjust/getAmazonAdId.mdx" -import GetAmazonAdIdSig from "@unity-signatures/Adjust/getAmazonAdId.mdx" -import GetGoogleAdId from "@unity-examples/Adjust/getGoogleAdId.mdx" -import GetGoogleAdIdSig from "@unity-signatures/Adjust/getGoogleAdId.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 -Adjust generates a unique ADID (Adjust Device ID) for each device. Call the `getAdid` method to return this ID as a **string**. +```cs +public static string getAdid(); +``` + +Adjust generates a unique Adjust Device ID (ADID) for each device. Call the `getAdid` method to return this ID as a **string**. - +```cs +string adid = Adjust.getAdid(); +``` ## ID For Advertisers -The IDFA (ID for Advertisers) is a device-specific identifier for Apple devices. Call the `getIdfa` method to return this ID as a **string**. +```cs title="Method signature" +public static string getIdfa(); +``` + +The ID for Advertisers (IDFA) is a device-specific identifier for Apple devices. Call the `getIdfa` method to return this ID as a **string**. - +```cs +string idfa = Adjust.getIdfa(); +``` ## Google Play Services Advertising ID -The GPS ADID (Google Play Services Advertising ID) is a device-specific identifier for Android devices. +```cs title="Method signature" +public static void getGoogleAdId(Action onDeviceIdsRead); +``` + +The Google Play Services Advertising ID (GPS ADID) is a device-specific identifier for Android devices. Users can opt out of sharing their GPS ADID by toggling the "Opt out of Ads Personalization" setting on their device. When a user enables this setting, the Adjust SDK returns a string of zeros when trying to read the GPS ADID. You can access this value by calling the `getGoogleAdId` method in a background thread. Assign a delegate function to access the GPS ADID value. - +```cs +Adjust.getGoogleAdId((string googleAdId) => { + //... +}); +``` ## Amazon Advertiser ID -The Amazon Ad ID (Amazon Advertising ID) is a device-specific identifier for Android devices. Call the `getAmazonAdId` method to return this ID as a **string**. +```cs title="Method signature" +public static string getAmazonAdId(); +``` + +The Amazon Advertising ID (Amazon Ad ID) is a device-specific identifier for Android devices. Call the `getAmazonAdId` method to return this ID as a **string**. - +```cs +string amazonAdId = Adjust.getAmazonAdId(); +``` diff --git a/src/content/docs/sdk/unity/features/events.mdx b/src/content/docs/sdk/unity/features/events.mdx index 53ac2161d..c08703487 100644 --- a/src/content/docs/sdk/unity/features/events.mdx +++ b/src/content/docs/sdk/unity/features/events.mdx @@ -4,31 +4,52 @@ description: Use these methods send event information to Adjust. slug: en/sdk/unity/features/events --- -import TrackEvent from "@unity-examples/Adjust/trackEvent.mdx" -import TrackEventSig from "@unity-signatures/Adjust/trackEvent.mdx" -import SetRevenue from "@unity-examples/AdjustEvent/setRevenue.mdx" -import SetRevenueSig from "@unity-signatures/AdjustEvent/setRevenue.mdx" -import SetTransactionId from "@unity-examples/AdjustEvent/setTransactionId.mdx" -import SetTransactionIdSig from "@unity-signatures/AdjustEvent/setTransactionId.mdx" -import SetCallbackId from "@unity-examples/AdjustEvent/setCallbackId.mdx" -import SetCallbackIdSig from "@unity-signatures/AdjustEvent/setCallbackId.mdx" -import AddCallbackParameter from "@unity-examples/AdjustEvent/addCallbackParameter.mdx" -import AddCallbackParameterSig from "@unity-signatures/AdjustEvent/addCallbackParameter.mdx" -import AddPartnerParameter from "@unity-examples/AdjustEvent/addPartnerParameter.mdx" -import AddPartnerParameterSig from "@unity-signatures/AdjustEvent/addPartnerParameter.mdx" +The Adjust SDK provides an `AdjustEvent` object which can be used to structure and send event information from your app to Adjust's servers. + +## Instantiate an AdjustEvent object + +```cs title="Method signature" +public AdjustEvent(string eventToken) +{ + this.eventToken = eventToken; + this.isReceiptSet = false; +} +``` + +To send event information with the Adjust SDK, you need to instantiate an `AdjustEvent` 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 `AdjustEvent` instance and pass the following parameters: + +- `eventToken` (**String**): Your Adjust [event token](https://help.adjust.com/en/article/add-events#manage-your-events). + +```cs {1} +AdjustEvent adjustEvent = new AdjustEvent("abc123"); +//... +Adjust.trackEvent(adjustEvent); +``` + +## Send an event + +```cs title="Method signature" +public static void trackEvent(AdjustEvent adjustEvent); +``` 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. - +```cs {3} +AdjustEvent 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. -```c# +```cs if (GUI.Button(new Rect(0, Screen.height * 1 / numberOfButtons, Screen.width, Screen.height / numberOfButtons), "Track Simple Event")) { AdjustEvent adjustEvent = new AdjustEvent("g3mfiw"); Adjust.trackEvent(adjustEvent); @@ -86,13 +107,16 @@ Parameters: ## Record event revenue +```cs title="Method signature" +public void setRevenue(double amount, string 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. @@ -100,13 +124,19 @@ Check the guide to [tracking purchases in different currencies](https://help.adj - +```cs {3} +AdjustEvent adjustEvent = new AdjustEvent("abc123"); +//... +adjustEvent.setRevenue(0.01, "EUR"); +//... +Adjust.trackEvent(adjustEvent); +``` ### Example This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. The function sets the `revenue` property of this event to _`0.25`_ and the `currency` property to _`EUR`_. -```c# +```cs if (GUI.Button(new Rect(0, Screen.height * 2 / numberOfButtons, Screen.width, Screen.height / numberOfButtons), "Track Revenue Event")) { AdjustEvent adjustEvent = new AdjustEvent("g3mfiw"); adjustEvent.setRevenue(0.25, "EUR"); @@ -127,19 +157,20 @@ Parameters: ### Purchase verification - + -If you've enabled [purchase verification](https://help.adjust.com/en/article/purchase-verification), you must send additional information with your purchase events to verify them. When Adjust's servers receive this information in an event object, they forward it to Apple to verify the purchase. +Purchase verification is an **optional** feature. These settings have no effect unless purchase verification is enabled. - + -`productId` (String): The product identifier of the item that was successfully purchased + -`transactionId` (NSString): The [`transactionIdentifier` value](https://developer.apple.com/documentation/storekit/skpaymenttransaction/1411288-transactionidentifier) of the successfully completed purchase. iOS only +If you've enabled [purchase verification](https://help.adjust.com/en/article/purchase-verification), you must send additional information with your purchase events to verify them. When Adjust's servers receive this information in an event object, they forward it to Apple to verify the purchase. -`receipt` (String): The signed receipt containing the information about the successfully completed purchase. iOS only + -`purchaseToken` (String): The purchase token generated for your successfully completed in-app purchase. Android only +- `productId` (**String**): The product identifier of the item that was successfully purchased +- `purchaseToken` (**String**): The purchase token generated for your successfully completed in-app purchase ```cs AdjustEvent adjustEvent = new AdjustEvent("abc123"); @@ -153,17 +184,27 @@ Adjust.trackEvent(adjustEvent); ## Unique events +```cs title="Method signature" +public void setTransactionId(string transactionId); +``` + You can pass an optional identifier to avoid recording duplicate events. The SDK stores the last ten identifiers and skips revenue events with duplicate transaction IDs. To set the identifier, call the `setTransactionId` method and pass your transaction ID as a **string** argument. - +```cs {3} +AdjustEvent adjustEvent = new AdjustEvent("abc123"); +//... +adjustEvent.setTransactionId("transactionId"); +//... +Adjust.trackEvent(adjustEvent); +``` ### Example This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. The function sets the `uniqueId` to `5e85484b-1ebc-4141-aab7-25b869e54c49` using the `setTransactionId` method. -```c# +```cs if (GUI.Button(new Rect(0, Screen.height * 2 / numberOfButtons, Screen.width, Screen.height / numberOfButtons), "Track Unique Event")) { AdjustEvent adjustEvent = new AdjustEvent("g3mfiw"); string uniqueId = "5e85484b-1ebc-4141-aab7-25b869e54c49" @@ -184,13 +225,23 @@ Parameters: ## Add callback parameters +```cs title="Method signature" +public void addCallbackParameter(string key, string 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. - +```cs {3} +AdjustEvent adjustEvent = new AdjustEvent("abc123"); +//... +adjustEvent.addCallbackParameter("key", "value"); +//... +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: @@ -227,7 +278,7 @@ The resulting callback URL looks like this: http://www.mydomain.com/callback?event_token=g3mfiw&revenue_amount=0.05 ``` -```c# +```cs if (GUI.Button(new Rect(0, Screen.height * 2 / numberOfButtons, Screen.width, Screen.height / numberOfButtons), "Track Callback Event")) { AdjustEvent adjustEvent = new AdjustEvent("g3mfiw"); adjustEvent.addCallbackParameter("event_token", "g3mfiw"); @@ -248,6 +299,10 @@ Parameters: ## Add partner parameters +```cs title="Method signature" +public void addPartnerParameter(string key, string 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. @@ -260,7 +315,13 @@ 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. - +```cs {3} +AdjustEvent adjustEvent = new AdjustEvent("abc123"); +//... +adjustEvent.addPartnerParameter("key", "value"); +//... +Adjust.trackEvent(adjustEvent); +``` ### Example @@ -269,7 +330,7 @@ This example shows how to record an event with the token `g3mfiw` whenever a use * The `product_id` of the associated product * The `user_id` of the user who triggered the event -```c# +```cs if (GUI.Button(new Rect(0, Screen.height * 2 / numberOfButtons, Screen.width, Screen.height / numberOfButtons), "Track Partner Event")) { AdjustEvent adjustEvent = new AdjustEvent("g3mfiw"); adjustEvent.addPartnerParameter("product_id", "29"); @@ -290,17 +351,27 @@ Parameters: ## Add a callback identifier +```cs title="Method signature" +public void setCallbackId(string 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. - +```cs +AdjustEvent adjustEvent = new AdjustEvent("abc123"); +//... +adjustEvent.setCallbackId("{your_callback_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`. -```c# +```cs if (GUI.Button(new Rect(0, Screen.height * 2 / numberOfButtons, Screen.width, Screen.height / numberOfButtons), "Track Unique Callback Event")) { AdjustEvent adjustEvent = new AdjustEvent("g3mfiw"); string callbackId = "f2e728d8-271b-49ab-80ea-27830a215147" diff --git a/src/content/docs/sdk/unity/features/index.mdx b/src/content/docs/sdk/unity/features/index.mdx index 838edb706..d2f28d070 100644 --- a/src/content/docs/sdk/unity/features/index.mdx +++ b/src/content/docs/sdk/unity/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/unity/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/unity/configuration/preinstalled.mdx b/src/content/docs/sdk/unity/features/preinstalled.mdx similarity index 67% rename from src/content/docs/sdk/unity/configuration/preinstalled.mdx rename to src/content/docs/sdk/unity/features/preinstalled.mdx index 6456a15bf..d9cb1cd1c 100644 --- a/src/content/docs/sdk/unity/configuration/preinstalled.mdx +++ b/src/content/docs/sdk/unity/features/preinstalled.mdx @@ -1,21 +1,20 @@ --- title: Send preinstalled app activity description: Configure a campaign to send information from preinstalled apps. -slug: en/sdk/unity/configuration/preinstalled +slug: en/sdk/unity/features/preinstalled --- -import SetPreinstallTrackingEnabled from "@unity-examples/AdjustConfig/setPreinstallTrackingEnabled.mdx" -import SetPreinstallTrackingEnabledSig from "@unity-signatures/AdjustConfig/setPreinstallTrackingEnabled.mdx" -import SetPreinstallFilePath from "@unity-examples/AdjustConfig/setPreinstallFilePath.mdx" -import SetPreinstallFilePathSig from "@unity-signatures/AdjustConfig/setPreinstallFilePath.mdx" -import SetDefaultTracker from "@unity-examples/AdjustConfig/setDefaultTracker.mdx" -import SetDefaultTrackerSig from "@unity-signatures/AdjustConfig/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. Your config object contains a **boolean** `preinstallTrackingEnabled` property that controls this feature. To enable preinstall measurement, call the `setPreinstallTrackingEnabled` method with a `true` argument. - +```cs +AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); +//... +adjustConfig.setPreinstallTrackingEnabled(true); +//... +Adjust.start(adjustConfig); +``` The Adjust SDK provides 5 methods for measuring preinstalled apps: @@ -23,11 +22,11 @@ The Adjust SDK provides 5 methods for measuring preinstalled apps: * [Content provider](#content-provider) (Android only). * [System Installer Receiver](#system-installer-receiver) (Android only). * [World Readable Directory](#world-readable-directory) (Android only). -* [Default campaign](#default-campaign) (iOS and Android). +* [Default link token](#default-link-token) (iOS and Android). ## System properties -OEM (Original Equipment Manufacturer) partners can leverage Android system properties to attribute preinstalled apps. The OEM writes attribution information to a file and adds its path to the system properties. The Adjust SDK reads this file on initialization to attribute the install. +Original Equipment Manufacturer (OEM) partners can leverage Android system properties to attribute preinstalled apps. The OEM (Original Equipment Manufacturer) writes attribution information to a file and adds its path to the system properties. The Adjust SDK reads this file on initialization to attribute the install. ## Content provider @@ -69,13 +68,19 @@ Save attribution information for your preinstalled app in a world-readable direc Pass the file path at which your preinstall information can be found to the `setPreinstallFilePath` method to give the Adjust SDK access to the information. - +```cs +AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); +//... +adjustConfig.setPreinstallFilePath("../EngagementFile.xml"); +//... +Adjust.start(adjustConfig); +``` -## Default campaign +## Default link token -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: +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 link in Adjust. +1. [Create a new campaign link in Campaign Lab](https://help.adjust.com/en/article/links). ```http "{token}" https://app.adjust.com/{token} @@ -83,7 +88,13 @@ Configuring a default campaign enables you to attribute all preinstalls to a pre 2. Copy this token and pass it to the `setDefaultTracker` method in your app delegate file. - + ```cs + AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox); + //... + adjustConfig.setDefaultTracker("{TrackerToken}"); + //... + Adjust.start(adjustConfig); + ``` 3. Build and run your app. If you have logging enabled, you should see a message in your log diff --git a/src/content/docs/sdk/unity/configuration/privacy.mdx b/src/content/docs/sdk/unity/features/privacy.mdx similarity index 52% rename from src/content/docs/sdk/unity/configuration/privacy.mdx rename to src/content/docs/sdk/unity/features/privacy.mdx index 74107969e..bd270af0b 100644 --- a/src/content/docs/sdk/unity/configuration/privacy.mdx +++ b/src/content/docs/sdk/unity/features/privacy.mdx @@ -1,61 +1,75 @@ --- title: Set up privacy features description: Configure features that you can use to handle user privacy in your app. -slug: en/sdk/unity/configuration/privacy +slug: en/sdk/unity/features/privacy --- -import GdprForgetMe from "@unity-examples/Adjust/gdprForgetMe.mdx"; -import GdprForgetMeSig from "@unity-signatures/Adjust/gdprForgetMe.mdx"; -import InitWithIsEnabledNumberBoolFalse from "@unity-examples/AdjustThirdPartySharing/initFalse.mdx"; -import InitWithIsEnabledNumberBoolTrue from "@unity-examples/AdjustThirdPartySharing/initTrue.mdx"; -import TrackThirdPartySharing from "@unity-signatures/Adjust/trackThirdPartySharing.mdx"; -import AddGranularOption from "@unity-examples/AdjustThirdPartySharing/addGranularOption.mdx"; -import AddGranularOptionSig from "@unity-signatures/AdjustThirdPartySharing/addGranularOption.mdx"; -import AddPartnerSharingSetting from "@unity-examples/AdjustThirdPartySharing/addPartnerSharingSetting.mdx"; -import AddPartnerSharingSettingSig from "@unity-signatures/AdjustThirdPartySharing/addPartnerSharingSetting.mdx"; -import AddGranularOptionFacebook from "@unity-examples/AdjustThirdPartySharing/addGranularOptionFacebook.mdx"; -import DisableThirdPartySharing from "@unity-examples/Adjust/disableThirdPartySharing.mdx"; -import DisableThirdPartySharingSig from "@unity-signatures/Adjust/disableThirdPartySharing.mdx"; -import SetUrlStrategy from "@unity-examples/AdjustConfig/setUrlStrategy.mdx"; -import SetUrlStrategySig from "@unity-signatures/AdjustConfig/setUrlStrategy.mdx"; -import TrackMeasurementConsent from "@unity-examples/Adjust/trackMeasurementConsent.mdx"; -import TrackMeasurementConsentSig from "@unity-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 +## Send right to be forgotten request + +```cs title="Method signature" +public static void gdprForgetMe(); +``` -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. +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. - +```cs +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. +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. -### Disable third-party sharing +### Instantiate an AdjustThirdPartySharing object -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. +```cs title="Method signature" +public AdjustThirdPartySharing(bool? isEnabled); +``` - +To enable or disable third party sharing with the Adjust SDK, you need to instantiate an `AdjustThirdPartySharing` object. This object contains variables that control how third party sharing is handled by Adjust. -### Enable third-party sharing +To instantiate a third party sharing object, create a new `AdjustThirdPartySharing` instance and pass the following parameters: - +- `isEnabled` (**Boolean**): Whether third party sharing is enabled. Pass `true` to enable third party sharing or `false` to disable third party sharing -### Send granular information +```cs {1} +AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true); +//... +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` -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. + - +If you set the `isEnabled` property to `false`, Adjust stops sharing the user's data with third parties. The Adjust SDK continues to work as expected. -### 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. +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. + +```cs {3} +AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true); +//... +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + +### Send granular information + +```cs title="Method signature" +public void addGranularOption(string partnerName, string key, string value); +``` + +You can attach granular information when a user updates their third-party sharing preferences. Use this information to communicate more detail about a user's decision. To do this, call the `addGranularOption` method with the following parameters: + +- `partnerName` (**String**): The name of the partner for whom the granular option applies. +- `key` (**String**): The option key. +- `value` (**String**): The option value. - +The following partners are available: @@ -74,6 +88,14 @@ You can use the Adjust SDK to update your third party sharing settings on a per-
+```cs {3} +AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(null); +//... +adjustThirdPartySharing.addGranularOption("PartnerA", "key", "value"); +//... +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + #### Manage Facebook Limited Data Use @@ -82,19 +104,17 @@ The Adjust SDK sends information to Facebook as soon as the app is installed. Yo -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. +Facebook provides a feature called Limited Data Use (LDU) to comply with the California Consumer Privacy Act (CCPA). This feature enables you to notify Facebook when a California-based user is opted out of the sale of data. You can also use it if you want to opt all users out by default. You can update the Facebook LDU status by passing arguments 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.
| +| 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
|
@@ -104,6 +124,15 @@ If you call this method with a `0` value for **either** `data_processing_options +```cs {3,4} +AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(null); +//... +adjustThirdPartySharing.addGranularOption("facebook", "data_processing_options_country", "1"); +adjustThirdPartySharing.addGranularOption("facebook", "data_processing_options_state", "1000"); +//... +Adjust.trackThirdPartySharing(adjustThirdPartySharing); +``` + #### Provide consent data to Google (Digital Markets Act compliance) @@ -136,19 +165,49 @@ adjustThirdPartySharing.addGranularOption("google_dma", "ad_user_data", "1"); Adjust.trackThirdPartySharing(adjustThirdPartySharing); ``` +### Update partner settings + +```cs title="Method signature" +public 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. + +```cs {3} +AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(null); +//... +adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "foo", false); +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. +```cs title="Method signature" +public static 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. -## Data residency +```cs +Adjust.disableThirdPartySharing(); +``` -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. +## Set URL strategy -To set your country of data residency, call the `setUrlStrategy` method on your `AdjustConfig` instance. +```cs title="Method signature" +public void setUrlStrategy(String urlStrategy); +``` + +The URL strategy feature allows you to set either: + +- The country in which Adjust stores your data (data residency). +- The endpoint to which the Adjust SDK sends traffic (URL strategy). + +This is useful if you're operating in a country with strict privacy requirements. When you set your URL strategy, Adjust stores data in the selected data residency region or sends traffic to the chosen domain. - +To set your country of data residency, call the `setUrlStrategy` method on your `AdjustConfig` instance with the following parameter: + +- `urlStrategy` (**String**): The country of data residence or endpoint to which you want to send SDK traffic. @@ -163,8 +222,26 @@ To set your country of data residency, call the `setUrlStrategy` method on your
+```cs {2} +AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox); +adjustConfig.setUrlStrategy(AdjustConfig.AdjustDataResidencyEU); +Adjust.start(adjustConfig); +``` + ## 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. +```cs title="Method signature" +public static void trackMeasurementConsent(bool measurementConsent); +``` + +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: + +- `consentMeasurement` (**Boolean**): Whether consent measurement is enabled (`true`) or not (`false`). - +When enabled, the SDK communicates the data privacy settings to Adjust's servers. Adjust's servers then applies your data privacy rules to the user. The Adjust SDK continues to work as expected. + +```cs +Adjust.trackMeasurementConsent(true); +``` diff --git a/src/content/docs/sdk/unity/features/session-parameters.mdx b/src/content/docs/sdk/unity/features/session-parameters.mdx index 4910c053f..0676e0352 100644 --- a/src/content/docs/sdk/unity/features/session-parameters.mdx +++ b/src/content/docs/sdk/unity/features/session-parameters.mdx @@ -4,26 +4,9 @@ description: Send information to your callback URL with each session. slug: en/sdk/unity/features/session-parameters --- -import AddSessionCallbackParameter from "@unity-examples/Adjust/addSessionCallbackParameter.mdx" -import AddSessionCallbackParameterSig from "@unity-signatures/Adjust/addSessionCallbackParameter.mdx" -import RemoveSessionCallbackParameter from "@unity-examples/Adjust/removeSessionCallbackParameter.mdx" -import RemoveSessionCallbackParameterSig from "@unity-signatures/Adjust/removeSessionCallbackParameter.mdx" -import ResetSessionCallbackParameters from "@unity-examples/Adjust/resetSessionCallbackParameters.mdx" -import ResetSessionCallbackParametersSig from "@unity-signatures/Adjust/resetSessionCallbackParameters.mdx" -import AddSessionPartnerParameter from "@unity-examples/Adjust/addSessionPartnerParameter.mdx" -import AddSessionPartnerParameterSig from "@unity-signatures/Adjust/addSessionPartnerParameter.mdx" -import RemoveSessionPartnerParameter from "@unity-examples/Adjust/removeSessionPartnerParameter.mdx" -import RemoveSessionPartnerParameterSig from "@unity-signatures/Adjust/removeSessionPartnerParameter.mdx" -import ResetSessionPartnerParameters from "@unity-examples/Adjust/resetSessionPartnerParameters.mdx" -import ResetSessionPartnerParametersSig from "@unity-signatures/Adjust/resetSessionPartnerParameters.mdx" -import SetDelayStart from "@unity-examples/AdjustConfig/setDelayStart.mdx" -import SetDelayStartSig from "@unity-signatures/AdjustConfig/setDelayStart.mdx" -import SendFirstPackages from "@unity-examples/Adjust/sendFirstPackages.mdx" -import SendFirstPackagesSig from "@unity-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,43 @@ 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 + +```cs title="Method signature" +public static void addSessionCallbackParameter(string key, string 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. - +```cs +Adjust.addSessionCallbackParameter("key", "value"); +``` + +### Remove session callback parameters + +```cs title="Method signature" +public static void removeSessionCallbackParameter(string 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. - +```cs +Adjust.removeSessionCallbackParameter("key"); +``` + +### Reset session callback parameters + +```cs title="Method signature" +public static void resetSessionCallbackParameters(); +``` You can remove all session parameters if they're no longer required. To do this, call the `resetSessionCallbackParameters` method. - +```cs +Adjust.resetSessionCallbackParameters(); +``` ## Session partner parameters @@ -55,17 +64,41 @@ 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 + +```cs title="Method signature" +public static void addSessionPartnerParameter(string key, string 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. - +```cs +Adjust.addSessionPartnerParameter("key", "value"); +``` + +### Remove session partner parameters + +```cs title="Method signature" +public static void removeSessionPartnerParameter(string 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. - +```cs +Adjust.removeSessionPartnerParameter("key"); +``` + +### Reset session partner parameters + +```cs title="Method signature" +public static void resetSessionPartnerParameters(); +``` You can remove all session partner parameters if they're no longer required. To do this, call the `resetSessionPartnerParameters` method. - +```cs +Adjust.resetSessionPartnerParameters(); +``` ## Delay start @@ -75,10 +108,18 @@ 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, pass the delay time in seconds to the [`setDelayStart` method](/en/sdk/unity/configuration#delay-the-start-of-the-sdk) on your config object. - +```cs {3} +AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox); +//... +adjustConfig.setDelayStart(5.5); +//... +Adjust.start(adjustConfig); +``` 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. - +```cs +Adjust.sendFirstPackages(); +``` diff --git a/src/content/docs/sdk/unity/configuration/skad.mdx b/src/content/docs/sdk/unity/features/skad.mdx similarity index 74% rename from src/content/docs/sdk/unity/configuration/skad.mdx rename to src/content/docs/sdk/unity/features/skad.mdx index 009180d14..e89eb7c24 100644 --- a/src/content/docs/sdk/unity/configuration/skad.mdx +++ b/src/content/docs/sdk/unity/features/skad.mdx @@ -1,23 +1,16 @@ --- title: Set up SKAdNetwork and conversion values description: Configure SKAdNetwork features for your iOS apps. -slug: en/sdk/unity/configuration/skad +slug: en/sdk/unity/features/skad --- -import DeactivateSKAdNetworkHandling from "@unity-examples/AdjustConfig/deactivateSKAdNetworkHandling.mdx"; -import DeactivateSKAdNetworkHandlingSig from "@unity-signatures/AdjustConfig/deactivateSKAdNetworkHandling.mdx"; -import UpdateConversionValue from "@unity-examples/Adjust/updateConversionValue.mdx"; -import UpdateConversionValueSig from "@unity-signatures/Adjust/updateConversionValue.mdx"; -import SetConversionValueUpdatedDelegate from "@unity-examples/AdjustConfig/setConversionValueUpdatedDelegate.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. @@ -25,8 +18,16 @@ app install and reinstall attribution. The SKAdNetwork workflow goes like this: ## Disable SKAdNetwork communication +```cs title="Method signature" +public 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. @@ -35,21 +36,33 @@ You must call the `deactivateSKAdNetworkHandling` method _before_ initializing t - +```cs {3} +AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); +//... +adjustConfig.deactivateSKAdNetworkHandling(); +//... +Adjust.start(adjustConfig); +``` ## Update conversion values +```cs title="Method signature" +public static void updateConversionValue(int 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. - +```cs +Adjust.updateConversionValue(6); +``` ### Example This example shows how to update a conversion value to `10` in response to a user triggering an event. -```c# {2} +```cs {2} public void OnButtonClick() { Adjust.updateConversionValue(10); } @@ -57,9 +70,19 @@ public void OnButtonClick() { ## Listen for changes to conversion values +```cs title="Method signature" +public void setConversionValueUpdatedDelegate(Action conversionValueUpdatedDelegate, string sceneName = "Adjust"); +``` + If you use Adjust to manage conversion values, the Adjust's servers send conversion value updates to the SDK. You can set up a delegate function to listen for these changes using the `setConversionValueUpdatedDelegate` method. Pass your function as an argument. - +```cs {3} +AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); +//... +adjustConfig.setConversionValueUpdatedDelegate(ConversionValueUpdatedCallback); +//... +Adjust.start(adjustConfig); +``` ### Example @@ -68,7 +91,7 @@ This example shows how to log the following when the conversion value updates: - A message confirming the conversion value update - The new conversion value -```c# {8, 14-17} +```cs {8, 14-17} using com.adjust.sdk; public class ExampleGUI : MonoBehaviour { diff --git a/src/content/docs/sdk/unity/features/subscriptions.mdx b/src/content/docs/sdk/unity/features/subscriptions.mdx index 454040995..605da9010 100644 --- a/src/content/docs/sdk/unity/features/subscriptions.mdx +++ b/src/content/docs/sdk/unity/features/subscriptions.mdx @@ -4,27 +4,6 @@ description: Use these methods send subscription information to Adjust. slug: en/sdk/unity/features/subscriptions --- -import AdjustAppStoreSubscription from "@unity-examples/AdjustAppStoreSubscription/adjustAppStoreSubscription.mdx"; -import AdjustPlayStoreSubscription from "@unity-examples/AdjustPlayStoreSubscription/adjustPlayStoreSubscription.mdx"; -import SetTransactionDate from "@unity-examples/AdjustAppStoreSubscription/setTransactionDate.mdx"; -import SetTransactionDateSig from "@unity-signatures/AdjustAppStoreSubscription/setTransactionDate.mdx"; -import SetPurchaseTime from "@unity-examples/AdjustPlayStoreSubscription/setPurchaseTime.mdx"; -import SetPurchaseTimeSig from "@unity-signatures/AdjustPlayStoreSubscription/setPurchaseTime.mdx"; -import SetSalesRegion from "@unity-examples/AdjustAppStoreSubscription/setSalesRegion.mdx"; -import SetSalesRegionSig from "@unity-signatures/AdjustAppStoreSubscription/setSalesRegion.mdx"; -import AddCallbackParameterAppStore from "@unity-examples/AdjustAppStoreSubscription/addCallbackParameter.mdx"; -import AddCallbackParameterAppStoreSig from "@unity-signatures/AdjustAppStoreSubscription/addCallbackParameter.mdx"; -import AddCallbackParameterPlayStore from "@unity-examples/AdjustPlayStoreSubscription/addCallbackParameter.mdx"; -import AddCallbackParameterPlayStoreSig from "@unity-signatures/AdjustPlayStoreSubscription/addCallbackParameter.mdx"; -import AddPartnerParameterAppStore from "@unity-examples/AdjustAppStoreSubscription/addPartnerParameter.mdx"; -import AddPartnerParameterAppStoreSig from "@unity-signatures/AdjustAppStoreSubscription/addPartnerParameter.mdx"; -import AddPartnerParameterPlayStore from "@unity-examples/AdjustPlayStoreSubscription/addPartnerParameter.mdx"; -import AddPartnerParameterPlayStoreSig from "@unity-signatures/AdjustPlayStoreSubscription/addPartnerParameter.mdx"; -import TrackAppStoreSubscription from "@unity-examples/Adjust/trackAppStoreSubscription.mdx"; -import TrackAppStoreSubscriptionSig from "@unity-signatures/Adjust/trackAppStoreSubscription.mdx"; -import TrackPlayStoreSubscription from "@unity-examples/Adjust/trackPlayStoreSubscription.mdx"; -import TrackPlayStoreSubscriptionSig from "@unity-signatures/Adjust/trackPlayStoreSubscription.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. @@ -33,32 +12,46 @@ The following steps only set up subscription tracking within the Adjust SDK. To You can record App Store and Play Store subscriptions and verify their validity with the Adjust SDK. After the user purchases a subscription, create an `AdjustAppStoreSubscription` or `AdjustPlayStoreSubscription` instance containing the details. -## 1. Set up your subscription object +## 1. Instantiate a subscription object To get started, you need to create a subscription object containing details of the subscription purchase. -Create an `AdjustAppStoreSubscription` object with the following properties +```cs title="Method signature" +public AdjustAppStoreSubscription(string price, string currency, string transactionId, string receipt) +``` + +Create an `AdjustAppStoreSubscription` object with the following properties: | Parameter | Data type | Description | | --------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `price` | Number | The price of the subscription | +| `price` | String | 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 |
- +```cs +AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( + price, + currency, + transactionId, + receipt); +``` -Create an `AdjustPlayStoreSubscription` object with the following properties +```cs title="Method signature" +public AdjustPlayStoreSubscription(string price, string currency, string sku, string orderId, string signature, string purchaseToken) +``` + +Create an `AdjustPlayStoreSubscription` object with the following properties: @@ -73,7 +66,15 @@ Create an `AdjustPlayStoreSubscription` object with the following properties
- +```cs +AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken); +``` @@ -85,25 +86,62 @@ You can record the date on which the user purchased a subscription. The SDK retu -Call the `setTransactionDate` method method on your subscription object to record the timestamp of the subscription. +```cs title="Method signature" +public void setTransactionDate(string transactionDate); +``` - +Call the `setTransactionDate` method on your subscription object to record the timestamp of the subscription. + +```cs {7} +AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( + price, + currency, + transactionId, + receipt); +//... +subscription.setTransactionDate(transactionDate); +``` +```cs title="Methdo signature" +public void setPurchaseTime(string purchaseTime); +``` + Call the `setPurchaseTime` method on your subscription object to record the timestamp of the subscription. - +```cs {8} +AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken); +subscription.setPurchaseTime(purchaseTime); +``` ### Record the purchase region (iOS only) +```cs title="Method signature" +public void setSalesRegion(string 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. - +```cs {7} +AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( + price, + currency, + transactionId, + receipt); +//... +subscription.setSalesRegion(salesRegion); +``` ### Add callback parameters @@ -112,12 +150,40 @@ You can add callback parameters to your subscription object. The SDK appends the - +```cs title="Method signature" +public void addCallbackParameter(string key, string value); +``` + +```cs {7-8} +AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( + price, + currency, + transactionId, + receipt); +//... +subscription.addCallbackParameter("key1", "value1"); +subscription.addCallbackParameter("key2", "value2"); +``` - +```cs title="Method signature" +public void addCallbackParameter(string key, string value); +``` + +```cs {9-10} +AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken); +//... +subscription.addCallbackParameter("key1", "value1"); +subscription.addCallbackParameter("key2", "value2"); +``` @@ -129,12 +195,40 @@ You can add partner parameters to your subscription object. The SDK sends these - +```cs title="Method signature" +public void addPartnerParameter(string key, string value); +``` + +```cs {7-8} +AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( + price, + currency, + transactionId, + receipt); +//... +subscription.addPartnerParameter("key1", "value1"); +subscription.addPartnerParameter("key2", "value2"); +``` - +```cs title="Method signature" +public void addPartnerParameter(string key, string value); +``` + +```cs {9-10} +AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken); +//... +subscription.addPartnerParameter("key1", "value1"); +subscription.addPartnerParameter("key2", "value2"); +``` @@ -146,16 +240,53 @@ Once you have set up your subscription object, you can record it using the Adjus -Pass your subscription object to the `trackAppStoreSubscription` method method to record the user's subscription purchase. +```cs title="Method signature" +public static void trackAppStoreSubscription(AdjustAppStoreSubscription subscription); +``` + +Pass your subscription object to the `trackAppStoreSubscription` method to record the user's subscription purchase. - +```cs {13} +AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription( + price, + currency, + transactionId, + receipt); +subscription.setTransactionDate(transactionDate); +subscription.setSalesRegion(salesRegion); +subscription.addCallbackParameter("key1", "value1"); +subscription.addCallbackParameter("key2", "value2"); +subscription.addPartnerParameter("key1", "value1"); +subscription.addPartnerParameter("key2", "value2"); + +Adjust.trackAppStoreSubscription(subscription); +``` -Pass your subscription object to the `trackPlayStoreSubscription` method method to record the user's subscription purchase. - - +```cs title="Method signature" +public static void trackPlayStoreSubscription(AdjustPlayStoreSubscription subscription); +``` + +Pass your subscription object to the `trackPlayStoreSubscription` method to record the user's subscription purchase. + +```cs {14} +AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription( + price, + currency, + sku, + orderId, + signature, + purchaseToken); +subscription.setPurchaseTime(purchaseTime); +subscription.addCallbackParameter("key1", "value1"); +subscription.addCallbackParameter("key2", "value2"); +subscription.addPartnerParameter("key1", "value1"); +subscription.addPartnerParameter("key2", "value2"); + +Adjust.trackPlayStoreSubscription(subscription); +``` diff --git a/src/content/docs/sdk/unity/index.mdx b/src/content/docs/sdk/unity/index.mdx index 1dfe51839..662a7816c 100644 --- a/src/content/docs/sdk/unity/index.mdx +++ b/src/content/docs/sdk/unity/index.mdx @@ -44,7 +44,7 @@ To set up the Adjust SDK, enter the following information: The Adjust SDK starts when the app's Awake event triggers by default. To override this behavior, check the **START SDK MANUALLY** option. This enables you to initialize the Adjust SDK by calling `Adjust.start()` with your config instance as an argument. -```c# +```cs AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox); // ... Adjust.start(adjustConfig); diff --git a/src/content/docs/sdk/unity/integrations/admob.mdx b/src/content/docs/sdk/unity/integrations/admob.mdx index 9a78c671c..e60644419 100644 --- a/src/content/docs/sdk/unity/integrations/admob.mdx +++ b/src/content/docs/sdk/unity/integrations/admob.mdx @@ -22,7 +22,7 @@ To use this feature, you need to first reach out to your Google representative a ## Examples -```c# +```cs this.rewardedAd.OnPaidEvent += this.HandleAdPaidEvent; public void HandleAdPaidEvent(object sender, AdValueEventArgs args) { diff --git a/src/content/docs/sdk/unity/integrations/applovin.mdx b/src/content/docs/sdk/unity/integrations/applovin.mdx index ac991974a..5a3ef1588 100644 --- a/src/content/docs/sdk/unity/integrations/applovin.mdx +++ b/src/content/docs/sdk/unity/integrations/applovin.mdx @@ -18,7 +18,7 @@ If you have any questions about ad revenue tracking with AppLovin MAX, please co ## Examples -```c# +```cs private void OnRewardedAdRevenuePaidEvent(string adUnitId, MaxSdkBase.AdInfo adInfo) { var adRevenue = new AdjustAdRevenue(AdjustConfig.AdjustAdRevenueSourceAppLovinMAX); diff --git a/src/content/docs/sdk/unity/integrations/helium.mdx b/src/content/docs/sdk/unity/integrations/helium.mdx index f63beacb1..e167d189d 100644 --- a/src/content/docs/sdk/unity/integrations/helium.mdx +++ b/src/content/docs/sdk/unity/integrations/helium.mdx @@ -18,7 +18,7 @@ If you want to measure ad revenue with the Helium by Chartboost SDK, you can use ## Example -```c# +```cs void DidReceiveImpressionLevelRevenueData(string placement, Hashtable impressionData) { var json = HeliumJSON.Serialize(impressionData); diff --git a/src/content/docs/sdk/unity/integrations/index.mdx b/src/content/docs/sdk/unity/integrations/index.mdx index 3aab408e3..23914f332 100644 --- a/src/content/docs/sdk/unity/integrations/index.mdx +++ b/src/content/docs/sdk/unity/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/unity/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/unity/integrations/ironsource.mdx b/src/content/docs/sdk/unity/integrations/ironsource.mdx index e95aa9f0f..109d7eaaf 100644 --- a/src/content/docs/sdk/unity/integrations/ironsource.mdx +++ b/src/content/docs/sdk/unity/integrations/ironsource.mdx @@ -18,7 +18,7 @@ If you have any questions about ad revenue measurement with ironSource, please c ## Example -```c# +```cs IronSourceEvents.onImpressionDataReadyEvent += ImpressionDataReadyEvent; private void ImpressionDataReadyEvent(IronSourceImpressionData impressionData) { diff --git a/src/content/docs/sdk/unity/integrations/unity.mdx b/src/content/docs/sdk/unity/integrations/unity.mdx index 98a565b8e..62bfb2e01 100644 --- a/src/content/docs/sdk/unity/integrations/unity.mdx +++ b/src/content/docs/sdk/unity/integrations/unity.mdx @@ -24,7 +24,7 @@ For more information, see the Unity [Mediation API](https://docs.unity.com/media ## Example -```c# +```cs static void OnImpression(object sender, ImpressionEventArgs e) { var impressionData = e.ImpressionData != null ? JsonUtility.ToJson(e.ImpressionData, true) : "null"; diff --git a/src/content/docs/sdk/unity/plugins/imei.mdx b/src/content/docs/sdk/unity/plugins/imei.mdx index 6f67994cd..6d50ff903 100644 --- a/src/content/docs/sdk/unity/plugins/imei.mdx +++ b/src/content/docs/sdk/unity/plugins/imei.mdx @@ -62,7 +62,7 @@ The IMEI and MEID are persistent identifiers. You are responsible for ensuring t Once you've set up the plugin, you can gather the device's IMEI and MEID. To do this, call the `AdjustImei.readImei` method before starting the Adjust SDK. -```c# +```cs AdjustImei.ReadImei(); // ... Adjust.start(config); @@ -70,6 +70,6 @@ Adjust.start(config); If you want to prevent the SDK from reading the IMEI and MEID, call the `AdjustImei.doNotReadImei` method. -```c# +```cs AdjustImei.doNotReadImei(); ``` diff --git a/src/content/docs/sdk/unity/plugins/index.mdx b/src/content/docs/sdk/unity/plugins/index.mdx index 3a566f8df..41f11a924 100644 --- a/src/content/docs/sdk/unity/plugins/index.mdx +++ b/src/content/docs/sdk/unity/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/unity/plugins type: category +sidebar-position: 4 --- Use plugins to pass information to third-party plugins. diff --git a/src/content/docs/sdk/unity/plugins/oaid.mdx b/src/content/docs/sdk/unity/plugins/oaid.mdx index 0519c6162..f81b50e1f 100644 --- a/src/content/docs/sdk/unity/plugins/oaid.mdx +++ b/src/content/docs/sdk/unity/plugins/oaid.mdx @@ -101,7 +101,7 @@ If you are adding the MSA SDK AAR as a dependency, add the following rules: Once you have set up the plugin, you can gather the device's OAID. To do this, call the `AdjustOaid.readOaid(applicationContext)` method before starting the Adjust SDK. -```c# +```cs AdjustOaid.ReadOaid(); // ... Adjust.start(config); @@ -109,6 +109,6 @@ Adjust.start(config); If you want to prevent the SDK from reading the OAID, call the `AdjustOaid.doNotReadOaid()` method. -```c# +```cs AdjustOaid.DoNotReadOaid(); ``` diff --git a/src/content/docs/sdk/unity/reference/adjust/config.mdx b/src/content/docs/sdk/unity/reference/adjust/config.mdx deleted file mode 100644 index 548254012..000000000 --- a/src/content/docs/sdk/unity/reference/adjust/config.mdx +++ /dev/null @@ -1,157 +0,0 @@ ---- -title: Configuration methods -description: Use these methods to update the Adjust SDK's configuration. -slug: en/sdk/unity/reference/adjust/config ---- - -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 "@unity-signatures/Adjust/setEnabled.mdx" - - - - - - - -import SetEnabled from "@unity-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 "@unity-signatures/Adjust/isEnabled.mdx" - - - - - - - -import IsEnabled from "@unity-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 "@unity-signatures/Adjust/sendFirstPackages.mdx" - - - - - - - -import SendFirstPackages from "@unity-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 "@unity-signatures/Adjust/setOfflineMode.mdx" - - - - - - - -import SetOfflineMode from "@unity-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 "@unity-signatures/Adjust/setDeviceToken.mdx" - - - - - - - -import SetDeviceToken from "@unity-examples/Adjust/setDeviceToken.mdx" - - - - - - - -`deviceToken` (string): Your push token. - - - - diff --git a/src/content/docs/sdk/unity/reference/adjust/device-info.mdx b/src/content/docs/sdk/unity/reference/adjust/device-info.mdx deleted file mode 100644 index e548d5338..000000000 --- a/src/content/docs/sdk/unity/reference/adjust/device-info.mdx +++ /dev/null @@ -1,134 +0,0 @@ ---- -title: Device information methods -description: Use these methods to retrieve device information. -slug: en/sdk/unity/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 GetAdidSig from "@unity-signatures/Adjust/getAdid.mdx" - - - - - - - -import GetAdid from "@unity-examples/Adjust/getAdid.mdx" - - - - - - - -`adid` (string): The Adjust identifier associated with the device - - - - - - - -## getIdfa - -Returns the IDFA (ID for advertisers) associated with the device. - - - -import GetIdfaSig from "@unity-signatures/Adjust/getIdfa.mdx" - - - - - - - -import GetIdfa from "@unity-examples/Adjust/getIdfa.mdx" - - - - - - - -`idfa` (string): The IDFA associated with the device - - - - - - - -## getGoogleAdid - -Returns the Google ADID (Google advertiser ID) associated with the device. - - - -import GetGoogleAdidSig from "@unity-signatures/Adjust/getGoogleAdId.mdx" - - - - - - - -import GetGoogleAdid from "@unity-examples/Adjust/getGoogleAdId.mdx" - - - - - - - -`googleAdid` (string): The Google ADID associated with the device - - - - - - - -## getAmazonAdid - -Returns the Amazon ADID (Amazon advertiser ID) associated with the device. - - - -import GetAmazonAdidSig from "@unity-signatures/Adjust/getAmazonAdId.mdx" - - - - - - - -import GetAmazonAdid from "@unity-examples/Adjust/getAmazonAdId.mdx" - - - - - - - -`amazonAdId` (string): The Amazon ADID associated with the device - - - - diff --git a/src/content/docs/sdk/unity/reference/adjust/index.mdx b/src/content/docs/sdk/unity/reference/adjust/index.mdx deleted file mode 100644 index ddcc11d4c..000000000 --- a/src/content/docs/sdk/unity/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/unity/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/unity/reference/adjust/privacy.mdx b/src/content/docs/sdk/unity/reference/adjust/privacy.mdx deleted file mode 100644 index f5034265d..000000000 --- a/src/content/docs/sdk/unity/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/unity/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 "@unity-signatures/Adjust/disableThirdPartySharing.mdx" - - - - - - - -import DisableThirdPartySharing from "@unity-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 "@unity-signatures/Adjust/trackThirdPartySharing.mdx" - - - - - - - -import TrackThirdPartySharing from "@unity-examples/Adjust/trackThirdPartySharing.mdx" - - - - - - - -`thirdPartySharing` (AdjustThirdPartySharing): 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 "@unity-signatures/Adjust/trackMeasurementConsent.mdx" - - - - - - - -import TrackMeasurementConsent from "@unity-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 "@unity-signatures/Adjust/gdprForgetMe.mdx" - - - - - - - -import GdprForgetMe from "@unity-examples/Adjust/gdprForgetMe.mdx" - - - - - - diff --git a/src/content/docs/sdk/unity/reference/adjust/recording.mdx b/src/content/docs/sdk/unity/reference/adjust/recording.mdx deleted file mode 100644 index 615741576..000000000 --- a/src/content/docs/sdk/unity/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/unity/reference/adjust/recording -sidebar-position: 4 ---- - -Use these methods to send information about your app to Adjust. - - - -## trackEvent - -Record event information using an `Adjust` object and an [Adjust event token](https://help.adjust.com/en/article/add-events#add-event). - - - -import TrackEventSig from "@unity-signatures/Adjust/trackEvent.mdx" - - - - - - - -import TrackEvent from "@unity-examples/Adjust/trackEvent.mdx" - - - - - - - -`event` (AdjustEvent): 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 "@unity-signatures/Adjust/addSessionCallbackParameter.mdx" - - - - - - - -import AddSessionCallbackParameter from "@unity-examples/Adjust/addSessionCallbackParameter.mdx" - - - - - - - -`key` (string): The data key - -`value` (string): The data value - - - - - - - -## removeSessionCallbackParameter - -Remove a session callback parameter. - - - -import RemoveSessionCallbackParameterSig from "@unity-signatures/Adjust/removeSessionCallbackParameter.mdx" - - - - - - - -import RemoveSessionCallbackParameter from "@unity-examples/Adjust/removeSessionCallbackParameter.mdx" - - - - - - - -`key` (string): The data key of the parameter you want to remove. - - - - - - - -## resetSessionCallbackParameters - -Removes all session callback parameters. - - - -import ResetSessionCallbackParametersSig from "@unity-signatures/Adjust/resetSessionCallbackParameters.mdx" - - - - - - - -import ResetSessionCallbackParameters from "@unity-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 "@unity-signatures/Adjust/addSessionPartnerParameter.mdx" - - - - - - - -import AddSessionPartnerParameter from "@unity-examples/Adjust/addSessionPartnerParameter.mdx" - - - - - - - -`key` (string): The data key - -`value` (string): The data value - - - - - - - -## removeSessionPartnerParameter - -Remove a session partner parameter. - - - -import RemoveSessionPartnerParameterSig from "@unity-signatures/Adjust/removeSessionPartnerParameter.mdx" - - - - - - - -import RemoveSessionPartnerParameter from "@unity-examples/Adjust/removeSessionPartnerParameter.mdx" - - - - - - - -`key` (string): The data key of the parameter you want to remove. - - - - - - - -## resetSessionPartnerParameters - -Removes all session partner parameters. - - - -import ResetSessionPartnerParametersSig from "@unity-signatures/Adjust/resetSessionPartnerParameters.mdx" - - - - - - - -import ResetSessionPartnerParameters from "@unity-examples/Adjust/resetSessionPartnerParameters.mdx" - - - - - - - - - -## trackAdRevenue - -Record the details of an AdjustAdRevenue object. - - - -import TrackAdRevenueSig from "@unity-signatures/Adjust/trackAdRevenue.mdx" - - - - - - - -import TrackAdRevenue from "@unity-examples/Adjust/trackAdRevenue.mdx" - - - - - - - -`adRevenue` (AdjustAdRevenue): The ad revenue object containing the revenue details. - - - - - - - -## trackPlayStoreSubscription - -Record a Play Store subscription object. - - - -import TrackPlayStoreSubscriptionSig from "@unity-signatures/Adjust/trackPlayStoreSubscription.mdx" - - - - - - - -import TrackPlayStoreSubscription from "@unity-examples/Adjust/trackPlayStoreSubscription.mdx" - - - - - - - -`subscription` (AdjustPlayStoreSubscription): The subscription object containing the purchase details. - - - - - - - -## trackAppStoreSubscription - -Record an App Store subscription object. - - - -import TrackAppStoreSubscriptionSig from "@unity-signatures/Adjust/trackAppStoreSubscription.mdx" - - - - - - - -import TrackAppStoreSubscription from "@unity-examples/Adjust/trackAppStoreSubscription.mdx" - - - - - - - -`subscription` (AdjustAppStoreSubscription): The subscription object containing the purchase details. - - - - - - - -## getAttribution - -Fetches attribution data about the device. - - - -import GetAttributionSig from "@unity-signatures/Adjust/getAttribution.mdx" - - - - - - - -import GetAttribution from "@unity-examples/Adjust/getAttribution.mdx" - - - - - - - -`attribution` (AdjustAttribution): An attribution object containing attribution data associated with the device. - - - - diff --git a/src/content/docs/sdk/unity/reference/adjust/skan-att.mdx b/src/content/docs/sdk/unity/reference/adjust/skan-att.mdx deleted file mode 100644 index 4b99c97e7..000000000 --- a/src/content/docs/sdk/unity/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/unity/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 "@unity-signatures/Adjust/requestTrackingAuthorization.mdx" - - - - - - - -import RequestTrackingAuthorization from "@unity-examples/Adjust/requestTrackingAuthorization.mdx" - - - - - - - -`statusCallback` (Action\): Completion handler to which the status is passed. - - - - - - - -## getAppTrackingAuthorizationStatus - -Retrieves the user's current authorization status. - - - -import GetAppTrackingAuthorizationStatusSig from "@unity-signatures/Adjust/appTrackingAuthorizationStatus.mdx" - - - - - - - -import GetAppTrackingAuthorizationStatus from "@unity-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 "@unity-signatures/Adjust/checkForNewAttStatus.mdx" - - - - - - - -import CheckForNewAttStatus from "@unity-examples/Adjust/checkForNewAttStatus.mdx" - - - - - - - - - -## updateConversionValue - -Updates the [conversion value](https://help.adjust.com/en/suite/article/conversion-hub). - - - -import UpdateConversionValueSig from "@unity-signatures/Adjust/updateConversionValue.mdx" - - - - - - - -import UpdateConversionValue from "@unity-examples/Adjust/updateConversionValue.mdx" - - - - - - - -conversionValue (int): The new conversion value. - - - - diff --git a/src/content/docs/sdk/unity/reference/adjustadrevenue.mdx b/src/content/docs/sdk/unity/reference/adjustadrevenue.mdx deleted file mode 100644 index 331370866..000000000 --- a/src/content/docs/sdk/unity/reference/adjustadrevenue.mdx +++ /dev/null @@ -1,269 +0,0 @@ ---- -title: AdjustAdRevenue class -description: Use this class to store ad revenue information. -category-title: AdjustAdRevenue class -slug: en/sdk/unity/reference/adjustadrevenue ---- - -Use this class to store ad revenue information. - - - -## Constructor - -Creates an ad revenue object initialized with an external ad revenue source. - - - -import ConstructorSig from "@unity-signatures/AdjustAdRevenue/constructor.mdx"; - - - - - - - -import Constructor from "@unity-examples/AdjustAdRevenue/constructor.mdx"; - - - - - - - -`source` (NSString): The source of the ad revenue. - - - -| Parameter | Source | -| ---------------------------------------------------- | ----------------- | -| `AdjustConfig.AdjustAdRevenueSourceAppLovinMAX` | AppLovin MAX | -| `AdjustConfig.AdjustAdRevenueSourceMopub` | Mopub | -| `AdjustConfig.AdjustAdRevenueSourceAdMob` | AdMob | -| `AdjustConfig.AdjustAdRevenueSourceIronSource` | ironSource | -| `AdjustConfig.AdjustAdRevenueSourceAdmost` | AdMost | -| `AdjustConfig.AdjustAdRevenueSourceUnity` | Unity | -| `AdjustConfig.AdjustAdRevenueSourceHeliumChartboost` | Helium Chartboost | -| `AdjustConfig.AdjustAdRevenueSourcePublisher` | Generic source | - -
- - - - - - - -## setRevenue - -Set the revenue amount associated with the ad revenue object. - - - -import SetRevenueSig from "@unity-signatures/AdjustAdRevenue/setRevenue.mdx" - - - - - - - -import SetRevenue from "@unity-examples/AdjustAdRevenue/setRevenue.mdx" - - - - - - - -`amount` (double): The amount of currency units associated with the ad. - -`currency` (string): 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 "@unity-signatures/AdjustAdRevenue/setAdImpressionsCount.mdx" - - - - - - - -import SetAdImpressionsCount from "@unity-examples/AdjustAdRevenue/setAdImpressionsCount.mdx" - - - - - - - -`adImpressionsCaount` (int): The number of impressions associated with the ad. - - - - - - - -## setAdRevenueNetwork - -Sets the network associated with the ad revenue. - - - -import SetAdRevenueNetworkSig from "@unity-signatures/AdjustAdRevenue/setAdRevenueNetwork.mdx" - - - - - - - -import SetAdRevenueNetwork from "@unity-examples/AdjustAdRevenue/setAdRevenueNetwork.mdx" - - - - - - - -`adRevenueNetwork` (string): The network associated with the ad revenue. - - - - - - - -## setAdRevenueUnit - -Sets the ad unit ID associated with the ad revenue. - - - -import SetAdRevenueUnitSig from "@unity-signatures/AdjustAdRevenue/setAdRevenueUnit.mdx" - - - - - - - -import SetAdRevenueUnit from "@unity-examples/AdjustAdRevenue/setAdRevenueUnit.mdx" - - - - - - - -`unit` (string): The ad unit ID associated with the ad revenue. - - - - - - - -## setAdRevenuePlacement - -Sets the placement of the ad associated with the ad revenue. - - - -import SetAdRevenuePlacementSig from "@unity-signatures/AdjustAdRevenue/setAdRevenuePlacement.mdx" - - - - - - - -import SetAdRevenuePlacement from "@unity-examples/AdjustAdRevenue/setAdRevenuePlacement.mdx" - - - - - - - -`adRevenuePlacement` (string): The placement of the ad associated with the revenue. - - - - - - - -## addCallbackParameter - -Adds key-value information to send to your callback URL. - - - -import AddCallbackParameterSig from "@unity-signatures/AdjustAdRevenue/addCallbackParameter.mdx" - - - - - - - -import AddCallbackParameter from "@unity-examples/AdjustAdRevenue/addCallbackParameter.mdx" - - - - - - - -`key` (string): The data key. - -`value` (string): The data value. - - - - - - - -## addPartnerParameter - -Adds key-value information to share with partners. - - - -import AddPartnerParameterSig from "@unity-signatures/AdjustAdRevenue/addPartnerParameter.mdx" - - - - - - - -import AddPartnerParameter from "@unity-examples/AdjustAdRevenue/addPartnerParameter.mdx" - - - - - - - -`key` (string): The data key. - -`value` (string): The data value. - - - - diff --git a/src/content/docs/sdk/unity/reference/adjustappstoresubscription.mdx b/src/content/docs/sdk/unity/reference/adjustappstoresubscription.mdx deleted file mode 100644 index 92d77747f..000000000 --- a/src/content/docs/sdk/unity/reference/adjustappstoresubscription.mdx +++ /dev/null @@ -1,170 +0,0 @@ ---- -title: AdjustAppStoreSubscription class -description: Use this class to store App Store subscription information. -category-title: AdjustAppStoreSubscription class -slug: en/sdk/unity/reference/adjustappstoresubscription ---- - -import TrackAppStoreSubscription from "@unity-signatures/Adjust/trackAppStoreSubscription.mdx" - -Use this class to store App Store subscription information. You can pass this to Adjust's servers using the `trackAppStoreSubscription` method. - - - -## Constructor - -Instantiates a subscription object. - - - -import ConstructorSig from "@unity-signatures/AdjustAppStoreSubscription/constructor.mdx" - - - - - - - -import Constructor from "@unity-examples/AdjustAppStoreSubscription/adjustAppStoreSubscription.mdx" - - - - - - - -`price` (string): 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. - - - - - - - -## setTransactionDate - -Sets the date of the transaction in the subscription object. - - - -import SetTransactionDateSig from "@unity-signatures/AdjustAppStoreSubscription/setTransactionDate.mdx" - - - - - - - -import SetTransactionDate from "@unity-examples/AdjustAppStoreSubscription/setTransactionDate.mdx" - - - - - - - -`transactionDate` (string): The date on which the subscription was purchased. - - - - - - - -## setSalesRegion - -You can record the region in which the user purchased a subscription. - - - -import SetSalesRegionSig from "@unity-signatures/AdjustAppStoreSubscription/setSalesRegion.mdx" - - - - - - - -import SetSalesRegion from "@unity-examples/AdjustAppStoreSubscription/setSalesRegion.mdx" - - - - - - - -`salesRegion` (string): The region in which the subscription was purchased. - - - - - - - -## addCallbackParameter - -Adds key-value callback parameters to the subscription object. You can add multiple parameters by calling this method multiple times. - - - -import AddCallbackParameterSig from "@unity-signatures/AdjustAppStoreSubscription/addCallbackParameter.mdx" - - - - - - - -import AddCallbackParameter from "@unity-examples/AdjustAppStoreSubscription/addCallbackParameter.mdx" - - - - - - - -`key` (string): The data key. - -`value` (string): The data value. - - - - - - - -## addPartnerParameter - -Adds key-value callback parameters to the subscription object. You can add multiple parameters by calling this method multiple times. - - - -import AddPartnerParameterSig from "@unity-signatures/AdjustAppStoreSubscription/addPartnerParameter.mdx" - - - - - - - -import AddPartnerParameter from "@unity-examples/AdjustAppStoreSubscription/addPartnerParameter.mdx" - - - - - - - -`key` (string): The data key. - -`value` (string): The data value. - - - - diff --git a/src/content/docs/sdk/unity/reference/adjustattribution.mdx b/src/content/docs/sdk/unity/reference/adjustattribution.mdx deleted file mode 100644 index 864475247..000000000 --- a/src/content/docs/sdk/unity/reference/adjustattribution.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AdjustAttribution class -description: Use this class to see attribution information. -category-title: AdjustAttribution class -slug: en/sdk/unity/reference/adjustattribution ---- - -import AttributionSig from "@unity-signatures/Adjust/getAttribution.mdx" -import SetNeedsCostSig from "@unity-signatures/AdjustConfig/setNeedsCost.mdx" - -The `AdjustAttribution` class contains details about the current attribution status of the device. - -## Properties - -The following properties can be accessed by calling the `getAttribution` 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. | -| `fbInstallReferrer` | String | The [Facebook install referrer](https://developers.facebook.com/docs/app-ads/install-referrer/). _Android only_. | - -
diff --git a/src/content/docs/sdk/unity/reference/adjustconfig/index.mdx b/src/content/docs/sdk/unity/reference/adjustconfig/index.mdx deleted file mode 100644 index 9c869ca0e..000000000 --- a/src/content/docs/sdk/unity/reference/adjustconfig/index.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: AdjustConfig class -description: Use the methods in this class to set up the Adjust SDK. -category-title: AdjustConfig class -slug: en/sdk/unity/reference/adjustconfig -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. - - - - - -## Constructor - -Initialize the configuration object with your Adjust app token. - - - -import Constructor from "@unity-signatures/AdjustConfig/constructor.mdx" - - - - - - - -import ConfigWithAppToken from "@unity-examples/AdjustConfig/constructor.mdx" - - - - - - - -`appToken` (string): Your Adjust app token. - -`environment` (AdjustEnvironment): The environment your app is running in. - -`allowSuppressLogLevel` (bool): Whether to allow all logging to be suppressed. - - - - - -`config` (AdjustConfig): A config object initialized with the provided params. - - - - diff --git a/src/content/docs/sdk/unity/reference/adjustconfig/privacy.mdx b/src/content/docs/sdk/unity/reference/adjustconfig/privacy.mdx deleted file mode 100644 index 1b0197f0b..000000000 --- a/src/content/docs/sdk/unity/reference/adjustconfig/privacy.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: Privacy methods -description: Configure these properties to set up privacy features in the Adjust SDK. -slug: en/sdk/unity/reference/adjustconfig/privacy -sidebar-position: 2 ---- - - - -## setUrlStrategy - -Sets the country or region of data residency. If called with a `UrlStrategy` parameter, sets the country/region where data will be sent preferentially. - - - -import SetUrlStrategySig from "@unity-signatures/AdjustConfig/setUrlStrategy.mdx"; - - - - - - - -import SetUrlStrategy from "@unity-examples/AdjustConfig/setUrlStrategy.mdx"; - - - - - - - -`urlStrategy` (string): The data residency target (see available values below) - - - -| Value | Description | -| ------------------------ | --------------------------------------------------------- | -| `AdjustDataResidencyEU` | Sets the area of data residency to the EU | -| `AdjustDataResidencyTR` | Sets the area of data residency to Turkey | -| `AdjustDataResidencyUS` | Sets the area of data residency to the USA | -| `AdjustUrlStrategyChina` | Points the URL strategy to the `app.adjust.world` domain | -| `AdjustUrlStrategyCn` | Points the URL strategy to the `app.adjust.cn` domain | -| `AdjustUrlStrategyIndia` | Points the URL strategy to the `app.adjust.net.in` domain | - -
- - - - - - - -## setCoppaCompliantEnabled - -Enable COPPA (Children's Online Privacy Protection Act) compliance in your app. - - - -import SetCoppaCompliantEnabledSig from "@unity-signatures/AdjustConfig/setCoppaCompliantEnabled.mdx"; - - - - - - - -import SetCoppaCompliantEnabled from "@unity-examples/AdjustConfig/setCoppaCompliantEnabled.mdx"; - - - - - - - -`coppaCompliantEnabled` (bool): Whether the app should be COPPA compliant. - - - - diff --git a/src/content/docs/sdk/unity/reference/adjustconfig/setup.mdx b/src/content/docs/sdk/unity/reference/adjustconfig/setup.mdx deleted file mode 100644 index c98326791..000000000 --- a/src/content/docs/sdk/unity/reference/adjustconfig/setup.mdx +++ /dev/null @@ -1,604 +0,0 @@ ---- -title: Setup methods -description: Configure these properties to set up the Adjust SDK. -slug: en/sdk/unity/reference/adjustconfig/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 "@unity-signatures/AdjustConfig/setLogLevel.mdx"; - - - - - - - -import SetLogLevel from "@unity-examples/AdjustConfig/setLogLevel.mdx"; - - - - - - - -`logLevel` (AdjustLogLevel): The level of logging output by the SDK. - - - -| Log level | Description | -| ------------------------- | ------------------------------------------ | -| `AdjustLogLevel.Verbose` | Enable all logging | -| `AdjustLogLevel.Debug` | Enable debug logging | -| `AdjustLogLevel.Info` | Only show info level logs (default option) | -| `AdjustLogLevel.Warn` | Disable info logging | -| `AdjustLogLevel.Error` | Disable warning level logging and below | -| `AdjustLogLevel.Assert` | Disable error level logging and below | -| `AdjustLogLevel.Suppress` | Suppress all logging | - -
- - - - - - - -## setLogDelegate - -Add a description of the method or function here - - - -import SetLogDelegateSig from "@unity-signatures/AdjustConfig/setLogDelegate.mdx" - - - - - - - -import SetLogDelegate from "@unity-examples/AdjustConfig/setLogDelegate.mdx" - - - - - - - -`logDelegate` (Action\): The delegate function or program that handles log output. - - - - - - - -## setDefaultTracker - -Sets a default token to record installs against. - - - -import SetDefaultTrackerSig from "@unity-signatures/AdjustConfig/setDefaultTracker.mdx" - - - - - - - -import SetDefaultTracker from "@unity-examples/AdjustConfig/setDefaultTracker.mdx" - - - - - - - -`defaultTracker` (string): The token to which all preinstalled sessions are attributed. - - - - - - - -## setSendInBackground - -Sets whether the SDK should send data while the app is running in the background. - - - -import SetSendInBackgroundSig from "@unity-signatures/AdjustConfig/sendInBackground.mdx" - - - - - - - -import SetSendInBackground from "@unity-examples/AdjustConfig/sendInBackground.mdx" - - - - - - - -`sendInBackground` (bool): Whether the SDK should send information to Adjust when the app is running in the background. - - - - - - - -## setSessionSuccessDelegate - -Sets up a success callback to trigger a function when the SDK records a session. - - - -import SetSessionSuccessDelegateSig from "@unity-signatures/AdjustConfig/setSessionSuccessDelegate.mdx" - - - - - - - -import SetSessionSuccessDelegate from "@unity-examples/AdjustConfig/setSessionSuccessDelegate.mdx" - - - - - - - -`sessionSuccessDelegate` (Action\): The function to launch when the SDK successfully records a session. - - - - - - - -## setSessionFailureDelegate - -Sets up a callback to trigger a function when the SDK fails to record a session. - - - -import SetSessionFailureDelegateSig from "@unity-signatures/AdjustConfig/setSessionFailureDelegate.mdx" - - - - - - - -import SetSessionFailureDelegate from "@unity-examples/AdjustConfig/setSessionFailureDelegate.mdx" - - - - - - - -`sessionFailureDelegate` (Action\): The function to launch when the SDK fails to record a session. - - - - - - - -## setEventSuccessDelegate - -Sets up a success callback to trigger a function when the SDK records an event. - - - -import SetEventSuccessDelegateSig from "@unity-signatures/AdjustConfig/setEventSuccessDelegate.mdx" - - - - - - - -import SetEventSuccessDelegate from "@unity-examples/AdjustConfig/setEventSuccessDelegate.mdx" - - - - - - - -`eventSuccessDelegate` (Action\): The function to launch when the SDK successfully records an event. - - - - - - - -## setEventFailureDelegate - -Sets up a callback to trigger a function when the SDK fails to record a session. - - - -import SetEventFailureDelegateSig from "@unity-signatures/AdjustConfig/setEventFailureDelegate.mdx" - - - - - - - -import SetEventFailureDelegate from "@unity-examples/AdjustConfig/setEventFailureDelegate.mdx" - - - - - - - -`eventFailureDelegate` (Action\): The function to launch when the SDK fails to record an event. - - - - - - - -## 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 "@unity-signatures/AdjustConfig/setDelayStart.mdx" - - - - - - - -import SetDelayStart from "@unity-examples/AdjustConfig/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 "@unity-signatures/AdjustConfig/setExternalDeviceId.mdx" - - - - - - - -import SetExternalDeviceId from "@unity-examples/AdjustConfig/setExternalDeviceId.mdx" - - - - - - - -`externalDeviceId` (string): 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 "@unity-signatures/AdjustConfig/setEventBufferingEnabled.mdx" - - - - - - - -import SetEventBufferingEnabled from "@unity-examples/AdjustConfig/setEventBufferingEnabled.mdx" - - - - - - - -`eventBufferingEnabled` (bool): Whether event buffering is enabled. - - - - - - - -## setNeedsCost - -Sets whether the SDK should gather cost data. This is accessible in the user's attribution information. - - - -import SetNeedsCostSig from "@unity-signatures/AdjustConfig/setNeedsCost.mdx" - - - - - - - -import SetNeedsCost from "@unity-examples/AdjustConfig/setNeedsCost.mdx" - - - - - - - -`needsCost` (bool): Whether the SDK should gather cost data - - - - - - - -## setAttributionChangedDelegate - -Sets a delegate function that fires when a user's attribution information updates. - - - -import SetAttributionChangedDelegateSig from "@unity-signatures/AdjustConfig/setAttributionChangedDelegate.mdx" - - - - - - - -import SetAttributionChangedDelegate from "@unity-examples/AdjustConfig/setAttributionChangedDelegate.mdx" - - - - - - - -`attributionChangedDelegate` (Action\): The delegate function that the SDK calls when the user's attribution information changes. - - - - - - - -## setPreinstallTrackingEnabled - -Enables or disables preinstall tracking. - - - -import SetPreinstallTrackingEnabledSig from "@unity-signatures/AdjustConfig/setPreinstallTrackingEnabled.mdx" - - - - - - - -import SetPreinstallTrackingEnabled from "@unity-examples/AdjustConfig/setPreinstallTrackingEnabled.mdx" - - - - - - - -`preinstallTrackingEnabled` (bool): Whether preinstall tracking is enabled. - - - - - - - -## setPreinstallFilePath - -Defines a relative path where preinstall information is available. - - - -This directory must be world-readable - - - - - -import SetPreinstallFilePathSig from "@unity-signatures/AdjustConfig/setPreinstallFilePath.mdx" - - - - - - - -import SetPreinstallFilePath from "@unity-examples/AdjustConfig/setPreinstallFilePath.mdx" - - - - - - - -`preinstallFilePath` (string): The path where the preinstall information is written. - - - - - - - -## deactivateSKAdNetworkHandling - -Turns off communication with SKAdNetwork. - - - -SKAdNetwork communication is enabled by default. - - - - - -import DeactivateSKAdNetworkHandlingSig from "@unity-signatures/AdjustConfig/deactivateSKAdNetworkHandling.mdx" - - - - - - - -import DeactivateSKAdNetworkHandling from "@unity-examples/AdjustConfig/deactivateSKAdNetworkHandling.mdx" - - - - - - - - - -## setLaunchDeferredDeepLink - -Enables or disables launching deferred deep links with the SDK. If enabled, the SDK launches deep links the user interacts with. - - - -import SetLaunchDeferredDeepLinkSig from "@unity-signatures/AdjustConfig/setLaunchDeferredDeeplink.mdx" - - - - - - - -import SetLaunchDeferredDeepLink from "@unity-examples/AdjustConfig/setLaunchDeferredDeeplink.mdx" - - - - - - - -`launchDeferredDeepLink` (bool): Whether to enable launching deferred deep links. - - - - - - - -## setLinkMeEnabled - -Toggle support for Adjust's [LinkMe solution](https://help.adjust.com/en/article/linkme) for deep linking. - - - -import SetLinkMeEnabledSig from "@unity-signatures/AdjustConfig/setLinkMeEnabled.mdx" - - - - - - - -import SetLinkMeEnabled from "@unity-examples/AdjustConfig/setLinkMeEnabled.mdx" - - - - - - - -`linkMeEnabled` (bool): Whether to enable LinkMe. - - - - - - - -## setConversionValueUpdatedDelegate - -Sets a delegate function to call when the user's conversion value updates. - - - -import SetConversionValueUpdatedDelegateSig from "@unity-signatures/AdjustConfig/setConversionValueUpdatedDelegate.mdx" - - - - - - - -import SetConversionValueUpdatedDelegate from "@unity-examples/AdjustConfig/setConversionValueUpdatedDelegate.mdx" - - - - - - - -`conversionValueUpdatedDelegate` (Action\): The delegate function the SDK launches when the conversion value updates - - - - diff --git a/src/content/docs/sdk/unity/reference/adjustevent.mdx b/src/content/docs/sdk/unity/reference/adjustevent.mdx deleted file mode 100644 index 28eed15d0..000000000 --- a/src/content/docs/sdk/unity/reference/adjustevent.mdx +++ /dev/null @@ -1,196 +0,0 @@ ---- -title: AdjustEvent class -description: Record information about events to send to Adjust. -category-title: AdjustEvent class -slug: en/sdk/unity/reference/adjustevent ---- - -import TrackEvent from "@unity-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 `AdjustEvent` object to the `trackEvent` method. - - - -## Constructor - -Instantiates an event object with an Adjust event token. - - - -import ConstructorSig from "@unity-signatures/AdjustEvent/constructor.mdx" - - - - - - - -import Constructor from "@unity-examples/AdjustEvent/constructor.mdx" - - - - - - - -`eventToken` (string): A 6 character Adjust event token. - - - - - - - -## setRevenue - -Sets the revenue and currency associated with an event. - - - -import SetRevenueSig from "@unity-signatures/AdjustEvent/setRevenue.mdx" - - - - - - - -import SetRevenue from "@unity-examples/AdjustEvent/setRevenue.mdx" - - - - - - - -`amount` (double): The amount of currency units associated with the event. - -`currency` (string): 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 "@unity-signatures/AdjustEvent/setTransactionId.mdx" - - - - - - - -import SetTransactionId from "@unity-examples/AdjustEvent/setTransactionId.mdx" - - - - - - - -`transactionId` (string): 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 "@unity-signatures/AdjustEvent/setCallbackId.mdx" - - - - - - - -import SetCallbackId from "@unity-examples/AdjustEvent/setCallbackId.mdx" - - - - - - - -`callbackId` (string): A custom identifier for your event object. - - - - - - - -## addCallbackParameter - -Adds key-value information to send to your callback URL. - - - -import AddCallbackParameterSig from "@unity-signatures/AdjustEvent/addCallbackParameter.mdx" - - - - - - - -import AddCallbackParameter from "@unity-examples/AdjustEvent/addCallbackParameter.mdx" - - - - - - - -`key` (string): The data key. - -`value` (string): The data value. - - - - - - - -## addPartnerParameter - -Adds key-value information to share with partners. - - - -import AddPartnerParameterSig from "@unity-signatures/AdjustEvent/addPartnerParameter.mdx" - - - - - - - -import AddPartnerParameter from "@unity-examples/AdjustEvent/addPartnerParameter.mdx" - - - - - - - -`key` (string): The data key. - -`value` (string): The data value. - - - - diff --git a/src/content/docs/sdk/unity/reference/adjustplaystoresubscription.mdx b/src/content/docs/sdk/unity/reference/adjustplaystoresubscription.mdx deleted file mode 100644 index 1bf11256e..000000000 --- a/src/content/docs/sdk/unity/reference/adjustplaystoresubscription.mdx +++ /dev/null @@ -1,145 +0,0 @@ ---- -title: AdjustPlayStoreSubscription class -description: Use this class to store Play Store subscription information. -category-title: AdjustPlayStoreSubscription class -slug: en/sdk/unity/reference/adjustplaystoresubscription ---- - -import TrackPlayStoreSubscription from "@unity-signatures/Adjust/trackPlayStoreSubscription.mdx" - -Use this class to store Play Store subscription information. You can pass this to Adjust's servers using the `trackPlayStoreSubscription` method. - - - -## Constructor - -Instantiates a subscription object. - - - -import ConstructorSig from "@unity-signatures/AdjustPlayStoreSubscription/constructor.mdx" - - - - - - - -import Constructor from "@unity-examples/AdjustPlayStoreSubscription/adjustPlayStoreSubscription.mdx" - - - - - - - -`price` (string): 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 - -`sku` (string): The ID of the product. - -`orderId` (string): Your ID for the transaction. - -`signature` (string): The signature of the purchase data. - -`purchaseToken` (string): The unique token of the transaction. See [Google's documentation](https://developer.android.com/reference/com/android/billingclient/api/Purchase#getPurchaseToken()) for more information. - - - - - - - -## setPurchaseTime - -Sets the date of the transaction in the subscription object. - - - -import SetPurchaseTimeSig from "@unity-signatures/AdjustPlayStoreSubscription/setPurchaseTime.mdx" - - - - - - - -import SetPurchaseTime from "@unity-examples/AdjustPlayStoreSubscription/setPurchaseTime.mdx" - - - - - - - -`purchaseTime` (string): The date on which the subscription was purchased. - - - - - - - -## addCallbackParameter - -Adds key-value callback parameters to the subscription object. You can add multiple parameters by calling this method multiple times. - - - -import AddCallbackParameterSig from "@unity-signatures/AdjustPlayStoreSubscription/addCallbackParameter.mdx" - - - - - - - - -import AddCallbackParameter from "@unity-examples/AdjustPlayStoreSubscription/addCallbackParameter.mdx" - - - - - - - -`key` (string): The data key. - -`value` (string): The data value. - - - - - - - -## addPartnerParameter - -Adds key-value callback parameters to the subscription object. You can add multiple parameters by calling this method multiple times. - - - -import AddPartnerParameterSig from "@unity-signatures/AdjustPlayStoreSubscription/addPartnerParameter.mdx" - - - - - - - -import AddPartnerParameter from "@unity-examples/AdjustPlayStoreSubscription/addPartnerParameter.mdx" - - - - - - - -`key` (string): The data key. - -`value` (string): The data value. - - - - diff --git a/src/content/docs/sdk/unity/reference/adjustthirdpartysharing.mdx b/src/content/docs/sdk/unity/reference/adjustthirdpartysharing.mdx deleted file mode 100644 index db17150c0..000000000 --- a/src/content/docs/sdk/unity/reference/adjustthirdpartysharing.mdx +++ /dev/null @@ -1,139 +0,0 @@ ---- -title: AdjustThirdPartySharing class -description: Use this class to communicate a user's third party sharing preferences. -category-title: AdjustThirdPartySharing class -slug: en/sdk/unity/reference/adjustthirdpartysharing ---- - -import TrackThirdPartySharing from "@unity-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 Constructor from "@unity-signatures/AdjustThirdPartySharing/constructor.mdx"; - - - - - - - -import InitTrue from "@unity-examples/AdjustThirdPartySharing/initTrue.mdx"; - - - - - - - -`isEnabled` (bool): Whether third party sharing is enabled. - - - - - - - -## 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 "@unity-signatures/AdjustThirdPartySharing/addGranularOption.mdx"; - - - - - - - -import AddGranularOption from "@unity-examples/AdjustThirdPartySharing/addGranularOption.mdx"; - - - -You can use this method to toggle Facebook data processing options. - -import Facebook from "@unity-examples/AdjustThirdPartySharing/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` (string): The name of the partner you want to share information with. - -`key` (string): The data key. - -`value` (string): 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 "@unity-signatures/AdjustThirdPartySharing/addPartnerSharingSetting.mdx"; - - - - - - - -import AddPartnerSharingSetting from "@unity-examples/AdjustThirdPartySharing/addPartnerSharingSetting.mdx"; - - - - - - - -`partnerName` (string): The name of the partner whose settings you want to update. See the table of available partners below. -`key` (string): 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/unity/reference/index.mdx b/src/content/docs/sdk/unity/reference/index.mdx deleted file mode 100644 index fa6dfb820..000000000 --- a/src/content/docs/sdk/unity/reference/index.mdx +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: SDK reference -description: SDK reference information for the Unity SDK -category-title: Reference -slug: en/sdk/unity/reference -type: category ---- diff --git a/src/content/docs/sdk/windows/configuration.mdx b/src/content/docs/sdk/windows/configuration.mdx index bb1483cc1..bdb27c352 100644 --- a/src/content/docs/sdk/windows/configuration.mdx +++ b/src/content/docs/sdk/windows/configuration.mdx @@ -10,7 +10,7 @@ Use the methods in this document to configure the behavior of the Adjust SDK. ## Instantiate your config object -```c# title="Method signature" +```cs title="Method signature" public AdjustConfig(string appToken, string environment, Action logDelegate = null, LogLevel? logLevel = null) ``` @@ -37,7 +37,7 @@ To instantiate your config object, create a new `AdjustConfig` instance and pass -```c# +```cs string appToken = "hmqwpvspxnuo"; string environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(appToken, environment, @@ -51,13 +51,13 @@ Adjust.ApplicationLaunching(adjustConfig); ### Configure a log delegate -```c# title="Method signature" +```cs title="Method signature" public void setLogDelegate(Action logDelegate); ``` A log delegate is a function that the Adjust SDK calls to record logs. To configure a log delegate, pass your log function to the `setLogDelegate`. The Adjust SDK calls this function each time it outputs a log message. -```c# {3} +```cs {3} AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); //... adjustConfig.setLogDelegate(msg => Debug.Log(msg)); @@ -67,7 +67,7 @@ Adjust.ApplicationLaunching(config); ### Set external device identifier -```c# title="Method signature" +```cs title="Method signature" public void setExternalDeviceId(string externalDeviceId); ``` @@ -83,7 +83,7 @@ See the [External device identifiers article](https://help.adjust.com/en/article -```c# {3} +```cs {3} AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true); //... adjustConfig.setExternalDeviceId("{Your-External-Device-Id}"); @@ -97,13 +97,13 @@ You can import existing external device IDs into Adjust. This ensures that the A ### Set default link token -```c# title="Property declaration" +```cs title="Property declaration" public string DefaultTracker { get; set; } ``` 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. To set your default link token, assign your [Adjust link token](https://help.adjust.com/en/article/links#adjust-link-token) to the `DefaultTracker` property on your config instance. -```c# {3} +```cs {3} var adjustConfig = new AdjustConfig(appToken, environment, msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); adjustConfig.DefaultTracker = "{TrackerToken}"; @@ -112,13 +112,13 @@ Adjust.ApplicationLaunching(adjustConfig); ### Enable background recording -```c# title="Property declaration" +```cs title="Property declaration" public bool SendInBackground { get; set; } ``` 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. -```c# {4} +```cs {4} var adjustConfig = new AdjustConfig(appToken, environment, msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); //... @@ -129,7 +129,7 @@ Adjust.ApplicationLaunching(adjustConfig); ### Enable event buffering -```c# title="Property declaration" +```cs title="Property declaration" public bool EventBufferingEnabled { get; set; } ``` @@ -139,7 +139,7 @@ Your config object contains a boolean `EventBufferingEnabled` property that cont - `EventBufferingEnabled` (**Boolean**): Set to `true` to enable event buffering or `false` to disable event buffering. -```c# {4} +```cs {4} var adjustConfig = new AdjustConfig(appToken, environment, msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); //... @@ -150,7 +150,7 @@ Adjust.ApplicationLaunching(adjustConfig); ### Delay the start of the SDK -```c# title="Property declaration" +```cs title="Property declaration" public TimeSpan? DelayStart { get; set; } ``` @@ -160,7 +160,7 @@ To configure a startup delay, assign a **TimeSpan** value to the `DelayStart` pr - `delayStart` (**TimeSpan**): 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**. -```c# +```cs adjustConfig.DelayStart = TimeSpan.FromSeconds(5.5); ``` @@ -170,7 +170,7 @@ adjustConfig.DelayStart = TimeSpan.FromSeconds(5.5); ### Toggle offline mode -```c# title="Method signature" +```cs title="Method signature" public void SetOfflineMode(bool offline); ``` @@ -186,13 +186,13 @@ You can toggle offline mode at any time by calling the `SetOfflineMode` method w - `offline` (Boolean): Set to `true` to enable offline mode or `false` to disable offline mode. -```c# +```cs Adjust.SetOfflineMode(true); ``` ### Set push tokens -```c# title="Method signature" +```cs title="Method signature" public static void SetPushToken(string pushToken); ``` @@ -208,7 +208,7 @@ If you have access to the push token from the web view, you can call the `setPus -```c# +```cs Adjust.SetPushToken("{YourDeviceToken}"); ``` @@ -220,7 +220,7 @@ You can only call this method after the first session. This setting persists bet -```c# title="Method signature" +```cs title="Method signature" public static void SetEnabled(bool enabled); ``` @@ -230,18 +230,18 @@ You can enable or disable the SDK at any time by calling the `SetEnabled` method - `enabled` (Boolean): Set to `true` to enable the SDK or `false` to disable the SDK. -```c# +```cs Adjust.SetEnabled(false); ``` #### Check enabled status -```c# title="Method signature" +```cs title="Method signature" public static 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`). -```c# +```cs Adjust.IsEnabled(); ``` diff --git a/src/content/docs/sdk/windows/features/attribution.mdx b/src/content/docs/sdk/windows/features/attribution.mdx index 929ccf941..68dcab1c1 100644 --- a/src/content/docs/sdk/windows/features/attribution.mdx +++ b/src/content/docs/sdk/windows/features/attribution.mdx @@ -27,7 +27,7 @@ The `AdjustAttribution` class contains details about the current attribution sta ## Trigger a function when attribution changes -```c# title="Property declaration" +```cs title="Property declaration" public Action AttributionChanged { get; set; } ``` @@ -42,7 +42,7 @@ You must call the `AttributionChanged` method **before** initializing the Adjust -```c# {3,4} +```cs {3,4} var config = new AdjustConfig(appToken, environment); config.AttributionChanged = (attribution) => @@ -54,7 +54,7 @@ Adjust.ApplicationLaunching(config); -```c# "AdjustAttributionChanged" +```cs "AdjustAttributionChanged" var config = new AdjustConfig(appToken, environment); config.AttributionChanged = AdjustAttributionChanged; Adjust.ApplicationLaunching(config); @@ -70,7 +70,7 @@ private void AdjustAttributionChanged(AdjustAttribution attribution) ## Get current attribution information -```c# title="Method signature" +```cs title="Method signature" public static AdjustAttribution GetAttribution(); ``` @@ -80,6 +80,6 @@ When a user installs your app, Adjust attributes the install to a campaign. The -```c# +```cs AdjustAttribution attribution = Adjust.GetAttribution(); ``` diff --git a/src/content/docs/sdk/windows/features/callbacks.mdx b/src/content/docs/sdk/windows/features/callbacks.mdx index 72d9d7543..3db9bc7bc 100644 --- a/src/content/docs/sdk/windows/features/callbacks.mdx +++ b/src/content/docs/sdk/windows/features/callbacks.mdx @@ -32,13 +32,13 @@ Session callbacks have access to a response data object. You can use its propert ### Success callbacks -```c# title="Property declaration" +```cs title="Property declaration" public Action SessionTrackingSucceeded { get; set; } ``` Set up success callbacks to trigger functions when the SDK records a session. -```c# {3-6} +```cs {3-6} var config = new AdjustConfig(appToken, environment, msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); config.SessionTrackingSucceeded = adjustSessionSuccess => @@ -52,7 +52,7 @@ Adjust.ApplicationLaunching(config); This example shows how to log the timestamp at which the SDK recorded the session. -```c# {3-6} +```cs {3-6} var config = new AdjustConfig(appToken, environment, msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); config.SessionTrackingSucceeded = adjustSessionSuccess => @@ -64,13 +64,13 @@ Adjust.ApplicationLaunching(config); ### Failure callbacks -```c# title="Property declaration" +```cs title="Property declaration" public Action SessionTrackingFailed { get; set; } ``` Set up failure callbacks to trigger functions when the SDK fails to record a session. -```c# {3-6} +```cs {3-6} var config = new AdjustConfig(appToken, environment, msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); config.EventTrackingFailed = adjustEventFailure => @@ -84,7 +84,7 @@ Adjust.ApplicationLaunching(config); This example shows how to log the session failure message. -```c# {3-6} +```cs {3-6} var config = new AdjustConfig(appToken, environment, msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); config.SessionTrackingFailed = adjustSessionFailure => @@ -116,13 +116,13 @@ Event callbacks have access to a response data object. You can use its propertie ### Success callbacks -```c# title="Property declaration" +```cs title="Property declaration" public Action EventTrackingSucceeded { get; set; } ``` Set up success callbacks to trigger functions when the SDK records an event. -```c# {3-6} +```cs {3-6} var config = new AdjustConfig(appToken, environment, msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); config.EventTrackingSucceeded = adjustEventSuccess => @@ -136,7 +136,7 @@ Adjust.ApplicationLaunching(config); This example shows how to log the timestamp at which the SDK recorded an event. -```c# {3-6} +```cs {3-6} var config = new AdjustConfig(appToken, environment, msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); config.EventTrackingSucceeded = adjustEventSuccess => @@ -148,13 +148,13 @@ Adjust.ApplicationLaunching(config); ### Failure callbacks -```c# title="Property declaration" +```cs title="Property declaration" public Action EventTrackingFailed { get; set; } ``` Set up failure callbacks to trigger functions when the SDK fails to record an event. -```c# {3-6} +```cs {3-6} var config = new AdjustConfig(appToken, environment, msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); config.EventTrackingFailed = adjustEventFailure => @@ -168,7 +168,7 @@ Adjust.ApplicationLaunching(config); This example shows how to log an event failure message. -```c# {3-6} +```cs {3-6} var config = new AdjustConfig(appToken, environment, msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); config.EventTrackingFailed = adjustEventFailure => diff --git a/src/content/docs/sdk/windows/features/deep-links.mdx b/src/content/docs/sdk/windows/features/deep-links.mdx index 8955f7ca4..8eb430074 100644 --- a/src/content/docs/sdk/windows/features/deep-links.mdx +++ b/src/content/docs/sdk/windows/features/deep-links.mdx @@ -27,7 +27,7 @@ If a user has your app installed, it opens when they interact with a link contai Next, you need to set up your `OnActivated` event handler. This handles the activated deep link event. To set this up, add the following to your your `App.xaml.cs` file: -```c# title="App.xaml.cs" +```cs title="App.xaml.cs" // ... protected override void OnActivated(IActivatedEventArgs args) { if (args.Kind == ActivationKind.Protocol) { @@ -53,13 +53,13 @@ Your app opens when a user interacts with a link containing your **unique scheme ## Deferred deep linking -```c# title="Property declaration" +```cs title="Property declaration" public Func DeeplinkResponse { get; set; } ``` You can configure the Adjust SDK to call a delegate function when it receives a deferred deep link. This delegate function receives the deep link as a **string** argument. Once the SDK receives the deep link content from Adjust's servers, it delivers it through this delegate function and expects a **boolean** return value. This value represents whether the SDK should launch the **OnActivated** event handler. -```c# {4-14} +```cs {4-14} var adjustConfig = new AdjustConfig(appToken, environment, msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); @@ -97,7 +97,7 @@ If the user needs to be reattributed due to clicking on an Adjust deep link, thi You must call `Adjust.AppWillOpenUrl` in the `OnActivated` method of your app: -```c# {8-10} +```cs {8-10} using AdjustSdk; public partial class App : Application diff --git a/src/content/docs/sdk/windows/features/device-info.mdx b/src/content/docs/sdk/windows/features/device-info.mdx index 0efdda299..a6d0248b3 100644 --- a/src/content/docs/sdk/windows/features/device-info.mdx +++ b/src/content/docs/sdk/windows/features/device-info.mdx @@ -8,24 +8,24 @@ The Adjust SDK contains helper methods that return device information. Use these ## Adjust device identifier -```c# title="Method signature" +```cs title="Method signature" public static string GetAdid(); ``` Adjust generates a unique Adjust Device ID (ADID) for each device. Call the `GetAdid` method to return this ID as a **string**. -```c# +```cs string adid = Adjust.GetAdid(); ``` ## Windows advertising identifier -```c# title="Method signature" +```cs title="Method signature" public static string GetWindowsAdId(); ``` The Windows Advertising ID (Windows ADID) is a device-specific identifier for Windows devices. Call the `GetWindowsAdId` method to return this ID as a **string**. -```c# +```cs var windowsAdid = Adjust.GetWindowsAdId(); ``` diff --git a/src/content/docs/sdk/windows/features/events.mdx b/src/content/docs/sdk/windows/features/events.mdx index 80fb55582..a1eb12826 100644 --- a/src/content/docs/sdk/windows/features/events.mdx +++ b/src/content/docs/sdk/windows/features/events.mdx @@ -8,7 +8,7 @@ The Adjust SDK provides an `AdjustEvent` object which can be used to structure a ## Instantiate an AdjustEvent object -```c# title="Method signature" +```cs title="Method signature" public AdjustEvent(string eventToken); ``` @@ -18,14 +18,14 @@ To instantiate an event object, create a new `AdjustEvent` instance and pass the - `eventToken` (**String**): Your Adjust [event token](https://help.adjust.com/en/article/add-events#manage-your-events). -```c# {1} +```cs {1} var adjustEvent = new AdjustEvent("abc123"); Adjust.TrackEvent(adjustEvent); ``` ## Send an event -```c# title="Method signature" +```cs title="Method signature" public static void TrackEvent(AdjustEvent adjustEvent); ``` @@ -34,7 +34,7 @@ You can associate your [Adjust event tokens](https://help.adjust.com/en/article/ - 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. -```c# {2} +```cs {2} var adjustEvent = new AdjustEvent("abc123"); Adjust.TrackEvent(adjustEvent); ``` @@ -43,7 +43,7 @@ Adjust.TrackEvent(adjustEvent); This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. -```c# {14-18} +```cs {14-18} using AdjustSdk; using Windows.UI.Xaml; using Windows.UI.Xaml.Controls; @@ -84,7 +84,7 @@ namespace AdjustWSExample ## Record event revenue -```c# title="Method signature" +```cs title="Method signature" public void SetRevenue(double revenue, string currency); ``` @@ -101,7 +101,7 @@ Check the guide to [tracking purchases in different currencies](https://help.adj -```c# {2} +```cs {2} var adjustEvent = new AdjustEvent("abc123"); adjustEvent.SetRevenue(0.01, "EUR"); Adjust.TrackEvent(adjustEvent); @@ -111,7 +111,7 @@ Adjust.TrackEvent(adjustEvent); This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. The function sets the `revenue` property of this event to _`0.25`_ and the `currency` property to _`EUR`_. -```c# {14-19} +```cs {14-19} using AdjustSdk; using Windows.UI.Xaml; using Windows.UI.Xaml.Controls; @@ -153,7 +153,7 @@ namespace AdjustWSExample ## Set a unique purchase ID -```c# title="Property declaration" +```cs title="Property declaration" public string PurchaseId { get; set; } ``` @@ -161,7 +161,7 @@ You can pass an optional identifier to avoid recording duplicate events. The SDK To set the identifier, assign your purchase ID to the `PurchaseId` property on your event object. -```c# {4} +```cs {4} AdjustEvent event = new AdjustEvent("abc123"); event.SetRevenue(0.01, "EUR"); @@ -174,7 +174,7 @@ Adjust.trackEvent(event); This example shows how to record an event with the token `g3mfiw` whenever a user interacts with a button. The function sets `PurchaseId` property to `5e85484b-1ebc-4141-aab7-25b869e54c49`. -```c# {14-20} +```cs {14-20} using AdjustSdk; using Windows.UI.Xaml; using Windows.UI.Xaml.Controls; @@ -217,7 +217,7 @@ namespace AdjustWSExample ## Add callback parameters -```c# title="Method signature" +```cs title="Method signature" public void AddCallbackParameter(string key, string value); ``` @@ -227,7 +227,7 @@ You can configure callback parameters to send to your servers. Once you configur 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. -```c# {3,4} +```cs {3,4} var adjustEvent = new AdjustEvent("abc123"); adjustEvent.AddCallbackParameter("key", "value"); @@ -271,7 +271,7 @@ The resulting callback URL looks like this: http://www.mydomain.com/callback?event_token=g3mfiw&revenue_amount=0.05 ``` -```c# {14-20} +```cs {14-20} using AdjustSdk; using Windows.UI.Xaml; using Windows.UI.Xaml.Controls; @@ -314,7 +314,7 @@ namespace AdjustWSExample ## Add partner parameters -```c# title="Method signature" +```cs title="Method signature" public void AddPartnerParameter(string key, string value); ``` @@ -330,7 +330,7 @@ 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. -```c# {3,4} +```cs {3,4} var adjustEvent = new AdjustEvent("abc123"); adjustEvent.AddPartnerParameter("key", "value"); @@ -346,7 +346,7 @@ This example shows how to record an event with the token `g3mfiw` whenever a use - The `product_id` of the associated product - The `user_id` of the user who triggered the event -```c# {14-20} +```cs {14-20} using AdjustSdk; using Windows.UI.Xaml; using Windows.UI.Xaml.Controls; @@ -389,7 +389,7 @@ namespace AdjustWSExample ## Add a callback identifier -```c# title="Property declaration" +```cs title="Property declaration" public string CallbackId { get; set; } ``` @@ -397,7 +397,7 @@ You can add a custom string identifier to each event you want to measure. Adjust Set up this identifier by assigning your identifier to the `CallbackId` property on your event object. -```c# {3} +```cs {3} var adjustEvent = new AdjustEvent("abc123"); adjustEvent.CallbackId = "Your-Custom-Id"; @@ -409,7 +409,7 @@ Adjust.TrackEvent(adjustEvent); 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`. -```c# {14-19} +```cs {14-19} using AdjustSdk; using Windows.UI.Xaml; using Windows.UI.Xaml.Controls; diff --git a/src/content/docs/sdk/windows/features/preinstalled.mdx b/src/content/docs/sdk/windows/features/preinstalled.mdx index f9c134ba2..5052ef27f 100644 --- a/src/content/docs/sdk/windows/features/preinstalled.mdx +++ b/src/content/docs/sdk/windows/features/preinstalled.mdx @@ -18,7 +18,7 @@ Configuring a default link token enables you to attribute all preinstalls to a p 2. Copy this token and assign it to the [`defaultTracker` property](/en/sdk/flutter/configuration#set-default-link-token) of your config object. - ```c# {3} + ```cs {3} var config = new AdjustConfig(appToken, environment, msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose); config.DefaultTracker = "{TrackerToken}"; diff --git a/src/content/docs/sdk/windows/features/privacy.mdx b/src/content/docs/sdk/windows/features/privacy.mdx index 6064f446b..d5d91b9d1 100644 --- a/src/content/docs/sdk/windows/features/privacy.mdx +++ b/src/content/docs/sdk/windows/features/privacy.mdx @@ -8,7 +8,7 @@ The Adjust SDK contains features that you can use to handle user privacy in your ## Send right to be forgotten request -```c# title="Method signature" +```cs title="Method signature" public static void GdprForgetMe(); ``` @@ -16,6 +16,6 @@ Article 17 of the European Union's General Data Protection Regulation (GDPR) gra You can send the user's RTBF request to Adjust by calling the `GdprForgetMe` method. -```c# +```cs Adjust.GdprForgetMe(); ``` diff --git a/src/content/docs/sdk/windows/features/session-parameters.mdx b/src/content/docs/sdk/windows/features/session-parameters.mdx index 86fe8dd05..6495a74be 100644 --- a/src/content/docs/sdk/windows/features/session-parameters.mdx +++ b/src/content/docs/sdk/windows/features/session-parameters.mdx @@ -18,37 +18,37 @@ You can configure callback parameters to your servers. Once you configure parame ### Add session callback parameters -```c# title="Method signature" +```cs title="Method signature" public static void AddSessionCallbackParameter(string key, string 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. -```c# +```cs Adjust.AddSessionCallbackParameter("key", "value"); ``` ### Remove session callback parameters -```c# title="Method signature" +```cs title="Method signature" public static void RemoveSessionCallbackParameter(string 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. -```c# +```cs Adjust.RemoveSessionCallbackParameter("key"); ``` ### Reset session callback parameters -```c# title="Method signature" +```cs title="Method signature" public static void ResetSessionCallbackParameters(); ``` You can remove all session parameters if they're no longer required. To do this, call the `ResetSessionCallbackParameters` method. -```c# +```cs Adjust.ResetSessionCallbackParameters(); ``` @@ -66,37 +66,37 @@ Partner parameters don't appear in raw data by default. You can add the `{partne ### Add session partner parameters -```c# title="Method signature" +```cs title="Method signature" public static void AddSessionPartnerParameter(string key, string 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. -```c# +```cs Adjust.AddSessionPartnerParameter("key", "value"); ``` ### Remove session partner parameters -```c# title="Method signature" +```cs title="Method signature" public static void RemoveSessionPartnerParameter(string 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. -```c# +```cs Adjust.RemoveSessionPartnerParameter("key"); ``` ### Reset session partner parameters -```c# title="Method signature" +```cs title="Method signature" public static void ResetSessionPartnerParameters(); ``` You can remove all session partner parameters if they're no longer required. To do this, call the `ResetSessionPartnerParameters` method. -```c# +```cs Adjust.ResetSessionPartnerParameters(); ``` @@ -110,12 +110,12 @@ 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, assign a delay time in seconds to the [`DelayStart` property](/en/sdk/flutter/configuration#delay-the-start-of-the-sdk) on your config object. -```c# +```cs adjustConfig.DelayStart = TimeSpan.FromSeconds(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. -```c# +```cs Adjust.SendFirstPackages() ``` diff --git a/src/content/docs/sdk/windows/index.mdx b/src/content/docs/sdk/windows/index.mdx index a455e43b4..8f899a9af 100644 --- a/src/content/docs/sdk/windows/index.mdx +++ b/src/content/docs/sdk/windows/index.mdx @@ -43,7 +43,7 @@ Once you've added the Adjust SDK to your Visual Studio project, you need to inte 2. Open the `App.xaml.cs` file. 3. Add the following directive to the top of the file: -```c# title="App.xaml.cs" +```cs title="App.xaml.cs" using AdjustSdk; ``` @@ -59,7 +59,7 @@ To initialize the Adjust SDK with this config object: 1. Declare your config object in the `OnLaunched` method of your app. 2. Pass the config object as an argument to the `Adjust.ApplicationLaunching` method. -```c# +```cs using AdjustSdk; sealed partial class App : Application