Update from v1.x to v4.0
Check the information below when updating the iOS SDK to v4.0. The iOS SDK name has changed from “AirBridge” to “Airbridge,” and the “AirBridge class” has changed to “Airbridge class.” Functions and options have been renamed.SDK installation and initialization
The CocoaPods package name, SwiftPackageManager Git address, and direct install download URL have changed. Delete the existing iOS SDK and reinstall it by following the Airbridge guide. TheAirBridge.getInstance function used to initialize the SDK has been changed to the Airbridge.initializeSDK function. Also, the option setting functions have been changed to the AirbridgeOption and AirbridgeOptionBuilder classes.
SDK’s options are no longer changed at runtime. Refer to the mapping below to write your new SDK initialization code.
Mapping for AirbridgeOptionBuilder
Mapping for AirbridgeOptionBuilder
Example) AirbridgeOptionBuilder
Example) AirbridgeOptionBuilder
Deep Linking
TheAirBridge.setDeeplinkCallback function has been replaced by the Airbridge.handleDeeplink function and handleDeferredDeeplink function.
Required: Deep links
Required: Deep links
You need to implement the existing
AirBridge.setDeeplinkCallback function by separating it into a function that handles scheme deep links registered in the Airbridge dashboard and another function that handles other deep links. Please refer to the following DeeplinkHandler class.AirBridge.deeplink().handle (or handleUniversalLink) and AirBridge.deeplink().handleURLSchemeDeeplink have been replaced by Airbridge.trackDeeplink.
Required task - Deeplink processing
Required task - Deeplink processing
-
Remove the part that calls the
AirBridge.deeplink().handle(orhandleUniversalLink) andAirBridge.deeplink().handleURLSchemeDeeplinkfunctions depending on the system method. -
You call the
Airbridge.trackDeeplinkfunction and theAirbridge.handleDeeplinkfunction.
Airbridge.handleDeeplink function provides a scheme deep link with true when an Airbridge deeplink is entered. If it is not an Airbridge deeplink, it does not provide a callback with false.- Call a function that processes the scheme deeplink executed to Airbridge in the
onSuccesscallback.
Airbridge.handleDeeplink function returns true when an Airbridge deeplink is inputted, and converts it to a Scheme deeplink and passes it on to onSuccess. And if a URL that is not an Airbridge deeplink is inputted or SDK is not initialized, it simply returns false.Required: Deferred deep links
Required: Deferred deep links
In the part where SDK is initialized, it calls the The
Airbridge.handleDeferredDeeplink function. It calls a function that processes scheme deep links run by Airbridge in the onSuccess callback.Airbridge.handleDeferredDeeplink function waits for the acquisition of Airbridge deeplinks with true if Airbridge deeplinks are entered, or converts them into scheme deeplinks and passes them to onSuccess. You can use the corresponding scheme deeplink to send users to the set destination.If there is no stored Airbridge deeplink, it delivers nil. If the SDK has not been initialized or if you did not call the Airbridge.handleDeferredDeeplink function for the first time, it delivers false.co.ab180.airbridge.trackingLink.customDomains key in Info.plist.
The changed method is to add them by calling the setTrackingLinkCustomDomains function during the SDK initialization phase.
Required: Custom domains
Required: Custom domains
Please call the setTrackingLinkCustomDomains function in the SDK initialization code.
In-app event and user data
AttentionEnter the value to the
AirbridgeAttribute.VALUE instead of to the totalValue.The logic where totalValue overwrites the value when using totalValue of setSemantics and defining the value with setValue has been removed from SDK v4.Airbridge.trackEvent function.
Follow the instructions below to change the ABInAppEvent class and setAction, setLabel, setValue, setSemantics, and setCustoms to the Airbridge.trackEvent function.
- setCategory: If you are using ABCategory, you should use AirbridgeCategory. If you are using a String, enter it in the category parameter as is.
- setAction: Enter the AirbridgeAttribute.ACTION key in the semanticAttributes parameter.
- setLabel: Enter in the AirbridgeAttribute.LABEL key of the semanticAttributes parameter.
- setValue: Enter in the AirbridgeAttribute.VALUE key of the semanticAttributes parameter.
- setSemantics: If you are using ABSemanticsKey as the key in the semanticAttributes parameter, useAirbridgeAttribute. If you are using String, enter it as is. The value is entered regardless of the key.
- setCustoms: In the customAttributes parameter, enter the key and value as they are.
Mapping for AirbridgeCategory
Mapping for AirbridgeCategory
Mapping for AirbridgeAttribute
Mapping for AirbridgeAttribute
Example) Airbridge.trackEvent function
Example) Airbridge.trackEvent function
The AirBridge.setDeviceAlias related functions have been replaced with AirBridge.setDeviceAlias related functions.
The AirBridge.state().setUser related functions have been replaced with Airbridge.setUser related functions. The setUser function that sets user information at once is not supported.
Additional settings
TheAirBridge.placement().click function and the AirBridge.placement().impression function have been replaced with the Airbridge.clickfunction and the Airbridge.impression function.
The AirBridge.webInterface().inject function has been replaced by Airbridge.setWebInterface function.
Update within v1.x
See the major changes in each version of the iOS SDK.v1.36.0 - Deep Link
For apps registered with Airbridge after September 4, 2023, an issue where the deep link URL provided in the deep link callback was decoded twice from the content entered in the Airbridge dashboard has been resolved. This issue was found in versions v1.34.0 to v1.35.1.v1.34.0 - Deep Link
For apps registered with Airbridge after September 4, 2023, the “airbridge_referrer” will no longer be added to the deep link URL provided in the deep link callback and will instead pass it to the information entered in the Airbridge Dashboard. Contact your Airbridge CSM if your Airbridge App was created before September 4, 2023, and want to apply this change. If you don’t have a dedicated CSM, contact the Airbridge Help Center.v1.33.0 - SKAdNetwork
When a user updates an app with iOS SDK v1.33.0 or earlier to v1.33.0 or later, the last calculated conversion value will be finalized.v1.32.1 - User privacy
The default setting fortrackingAuthorizeTimeout was changed from 0 seconds to 30 seconds.