SDK Migration - Android SDK (v4)

Last updated 4 days ago

This article contains the information required to update the Airbridge Android SDK. We recommend checking all the information regarding your current version and the version after the update.

Update from v2.x to v4.0

Check the information below when updating the Airbridge Android SDK to v4.0. All changes are listed.

Airbridge Interface

Summary


Unit	`initializeSDK(app: Application, config: AirbridgeOption)` Initializes the SDK with the provided app and AirbridgeOption.
Unit	`enableSDK()` Enables the SDK.
Unit	`disableSDK()` Disables the SDK.
Boolean	`isSDKEnabled()` Checks whether the SDK is currently enabled.
Unit	`startTracking()` Starts collecting and transferring events.
Unit	`setDeviceAlias(key: String, value: String)` Sets the key, value pair to the device alias.
Unit	`removeDeviceAlias(key: String)` Removes the device alias with the given key.
Unit	`clearDeviceAlias()` Clears all device aliases.
Unit	`setUserID(String)` Sets the user ID.
Unit	`setUserEmail(String)` Sets the user email.
Unit	`setUserPhone(String)` Sets the user phone number.
Unit	`setUserAttribute(key: String, value: Int)` Sets the key and value pair to the user attribute.
Unit	`setUserAttribute(key: String, value: Long)` Sets the key and value pair to the user attribute.
Unit	`setUserAttribute(key: String, value: Float)` Sets the key and value pair to the user attribute.
Unit	`setUserAttribute(key: String, value: Double)` Sets the key and value pair to the user attribute.
Unit	`setUserAttribute(key: String, value: Boolean)` Sets the key and value pair to the user attribute.
Unit	`setUserAttribute(key: String, value: String)` Sets the key and value pair to the user attribute.
Unit	`removeUserAttribute(key: String)` Removes the user attribute with the given key.
Unit	`clearUserAttributes()` Clears all user attributes.
Unit	`setUserAlias(key: String, value: String)` Sets the key and value pair to the user alias.
Unit	`removeUserAlias(key: String)` Removes the user alias with the given key.
Unit	`clearUserAlias()` Clears all user aliases.
Unit	`clearUser()` Clears all user information.
Unit	`registerPushToken(token: String)` Registers the FCM registration token to track app uninstalls.
Boolean	`isUninstallTrackingNotification(RemoteMessage)` Silent notifications are sent without any data. However, the notification may be shown to the user depending on the onMessageReceived settings. This determines whether it is a push notification to track uninstalls.
Unit	`trackEevnt(category: String, semanticAttributes: Map<String, Any> = null, customAttributes: Map<String, Any> = null)` Tracks events.
Boolean	`handleDeeplink(intent: Intent, onSuccess: OnSuccess<Uri>, onFailure: OnFailure? = null)` Handles Airbridge's deep links from the provided intent and invokes a callback based on the result.
Boolean	`handleDeferredDeeplink(onSuccess: OnSuccess<Uri?>, onFailure: OnFailure? = null)` Handles deferred deep links and invokes a callback based on the result.
Boolean	`click(trackingLink: URL, onSuccess: OnSuccess<Unit>, onFailure: OnFailure? = null)` Queries the tracking link to the server to get the deep link information and then moves according to that information if a deep link is set up. It also adds a click event for the tracking link.
Boolean	`impression(trackingLink: String, onSuccess: OnSuccess<Unit>, onFailure: OnFailure? = null)` Adds an impression event for the tracking link.
Unit	`setWebInterface(webView: WebView, webToken: String)` Enables the Android SDK to automatically pull all events from the Web SDK that is installed on the website of the WebView environment.
Boolean	`fetchDeviceUUID(onSuccess: OnSuccess<String>, onFailure: OnFailure? = null)` Fetches the Device UUID using the provided callbacks for success and failure.
Boolean	`fetchGoogleInstallReferrerDetails(onSuccess: OnSuccess<ReferrerDetails?>, onFailure: OnFailure? = null)` Fetches the Google Install Referrer.
Boolean	`fetchHuaweiInstallReferrerDetails(onSuccess: OnSuccess<ReferrerDetails?>, onFailure: OnFailure? = null)` Fetched the Huawei Install Referrer.
Boolean	`fetchOneStoreInstallReferrerDetails(onSuccess: OnSuccess<ReferrerDetails?>, onFailure: OnFailure? = null)` Fetchs the Onestore Install Referrer.
Boolean	`fetchGalaxyStoreInstallReferrerDetails(onSuccess: OnSuccess<ReferrerDetails?>, onFailure: OnFailure? = null)` Fetches the Galaxy Store Install Referrer.
Boolean	`fetchMetaInstallReferrerDetails(onSuccess: OnSuccess<ReferrerDetails?>, onFailure: OnFailure? = null)` Fetches the Meta Install Referrer.
Boolean	`fetchGoogleAdvertisingIdInfo(onSuccess: OnSuccess<AdvertisingIdInfo>, onFailure: OnFailure? = null)` Fetches the Google Advertising ID info.
Boolean	`fetchHuaweiAdvertisingIdInfo(onSuccess: OnSuccess<AdvertisingIdInfo>, onFailure: OnFailure? = null)` Fetches the Huawei Advertising ID info.

Deprecated Interface


Unit	`init(app: Application, config: AirbridgeConfig)` This method was deprecated in v4. use `initializeSDK(Application, AirbridgeOption)` instead
AirbridgeDeviceInfo	`getDeviceInfo()` This method was deprecated in v4. use `setDeviceAlias(String, String)`instead use `removeDeviceAlias(String)` instead use `clearDeviceAlias()` instead use `fetchDeviceUUID(OnSuccess<String>, OnFailure?)` instead use `fetchGoogleInstallReferrerDetails(OnSuccess<ReferrerDetails?>, OnFailure?)` instead use `fetchHuaweiInstallReferrerDetails(OnSuccess<ReferrerDetails?>, OnFailure?)` instead use `fetchOneStoreInstallReferrerDetails(OnSuccess<ReferrerDetails?>, OnFailure?)` instead use `fetchGalaxyStoreInstallReferrerDetails(OnSuccess<ReferrerDetails?>, OnFailure?)` instead use `fetchMetaInstallReferrerDetails(OnSuccess<ReferrerDetails?>, OnFailure?)` instead use `fetchGoogleAdvertisingIdInfo(OnSuccess<AdvertisingIdInfo>, OnFailure?)` instead use `fetchHuaweiAdvertisingIdInfo(OnSuccess<AdvertisingIdInfo>, OnFailure?)` instead
AirbridgeUser	`getCurrentUser()` This method was deprecated in v4. use `setUserID(String)` instead use `setUserEmail(String)` instead use `setUserPhone(String)` instead use `setUserAttribute(String, Int)` instead use `setUserAttribute(String, Long)`instead use `setUserAttribute(String, Float)` instead use `setUserAttribute(String, Double)` instead use `setUserAttribute(String, Boolean)` instead use `setUserAttribute(String, String)` instead use `removeUserAttribute(String)` instead use `clearUserAttributes()` instead use `setUserAlias(String, String)` instead use `removeUserAlias(String)` instead use `clearUserAlias()` instead
Unit	`expireUser()` This method was deprecated in v4. use `clearUser()` instead
Unit	`trackEvent(category: StandardEventCategory, action: String? = null, label: String? = null, value: Number? = null, customAttributes: Map<String, Any?>? = null, semanticAttributes: Map<String, Any?>? = null)` This method was removed in v4. use `trackEvent(String, Map<String, Any>?, Map<String, Any>?)` instead
Unit	`trackEvent(category: String, action: String? = null, label: String? = null, value: Number? = null, customAttributes: Map<String, Any?>? = null, semanticAttributes: Map<String, Any?>? = null)` This method was deprecated in v4. use `trackEvent(String, Map<String, Any>?, Map<String, Any>?)` instead
Unit	`trackEvent(event: Event)` This method was deprecated in v4. use `trackEvent(String, Map<String, Any>?, Map<String, Any>?)` instead
Unit	`getDeeplink(intent: Intent, callback: AirbridgeCallback<Uri>)` This method was deprecated in v4. use `handleDeeplink(Intent, OnSuccess<Uri>, OnFailure?)` instead
Unit	`click(trackingLink: String, callback: AirbridgeCallback<Boolean>? = null)` This method was deprecated in v4. use `click(String, OnSuccess<Unit>, OnFailure?)` instead
Unit	`impression(trackingLink: String)` This method was deprecated in v4. use `impression(String, OnSuccess<Unit>, OnFailure?)` instead
Unit	`setJavascriptInterface(webView: WebView, webToken: String)` This method was deprecated in v4. use `setWebInterface(WebView, String)` instead

Class changes

Added

Class name	Description
AirbridgeOption	`initializeSDK(Application, AirbridgeOption)` 에서 사용하는 Option class
AirbridgeCategory	Key of Standard Event used on `trackEvent(String, Map<String, Any>?, Map<String, Any>?)`
AirbridgeAttributes	Key of Semantic Attribute used on `trackEvent(String, Map<String, Any>?, Map<String, Any>?)`
OnSuccess	OnSuccess callback
OnFailure	OnFailure callback
AirbridgeLogLevel	Airbridge log level

Hidden

Class name	Description
Event	This class was hidden in v4. use `trackEvent(String, Map<String, Any>?, Map<String, Any>?)` instead

Class name

Description

Event

This class was hidden in v4.

use trackEvent(String, Map<String, Any>?, Map<String, Any>?) instead

Removed

Class name	Description
AirbridgeConfig	This class was removed in v4. use `setWebInterface(WebView, String)` instead
StandardEventCategory	This class was removed in v4. use `AirbridgeCategory` instead
SemanticAttributes	This class was removed in v4. use `AirbridgeAttributes` instead
Product	This class was removed in v4. use `AirbridgeProduct` instead
AirbridgeCallback	This class was removed in v4. use `OnSuccess<T>`, `OnFailure` instead
OnDeferredDeeplinkReceiveListener	This class was removed in v4. use `handleDeferredDeeplink(OnSuccess<T>, OnFailure)` instead
OnDeferredDeeplinkDetermineListener	This class was removed in v4.
AirbridgeDeviceInfo	This method was removed in v4. use `setDeviceAlias(String, String)` instead use `removeDeviceAlias(String)` instead use `clearDeviceAlias()` instead use `fetchDeviceUUID(OnSuccess<String>, OnFailure?)` instead use `fetchGoogleInstallReferrerDetails(OnSuccess<ReferrerDetails?>, OnFailure?)` instead use `fetchHuaweiInstallReferrerDetails(OnSuccess<ReferrerDetails?>, OnFailure?)` instead use `fetchOneStoreInstallReferrerDetails(OnSuccess<ReferrerDetails?>, OnFailure?)` instead use `fetchGalaxyStoreInstallReferrerDetails(OnSuccess<ReferrerDetails?>, OnFailure?)` instead use `fetchMetaInstallReferrerDetails(OnSuccess<ReferrerDetails?>, OnFailure?)` instead use `fetchGoogleAdvertisingIdInfo(OnSuccess<AdvertisingIdInfo>, OnFailure?)` instead use `fetchHuaweiAdvertisingIdInfo(OnSuccess<AdvertisingIdInfo>, OnFailure?)` instead
AirbridgeUser	This method was removed in v4. use `setUserID(String)` instead use `setUserEmail(String)` instead use `setUserPhone(String)` instead use `setUserAttribute(String, Int)` instead use `setUserAttribute(String, Long)` instead use `setUserAttribute(String, Float)` instead use `setUserAttribute(String, Double)` instead use `setUserAttribute(String, Boolean)` instead use `setUserAttribute(String, String)` instead use `removeUserAttribute(String)` instead use `clearUserAttributes()` instead use `setUserAlias(String, String)` instead use `removeUserAlias(String)` instead use `clearUserAlias()` instead

Moved

Class name	Description
AdvertisingIdInfo	Moved to `co.ab180.airbridge.common` package
ReferrerDetails	Moved `co.ab180.airbridge.common` package

AirbridgeOption

AirbridgeConfig	AirbridgeOption	default value
`constructor(String, String)`	`constructor(String, String)`	-
`setSDKSignatureSecret(String, String)`	`setSDKSignatureSecret(String, String)`	-
`setLogLevel(int)`	`setLogLevel(AirbridgeLogLevel)`	`AirbridgeLogLevel.WARNING`
`setSessionTimeoutSeconds(Long)`	`setSessionTimeout(Long)`	300
`setUserInfoHashEnabled(Boolean)`	`setHashUserInformationEnabled(Boolean)`	true
`setAutoStartTrackingEnabled(Boolean)`	`setAutoStartTrackingEnabled(Boolean)`	true
`setTrackInSessionLifeCycleEventEnabled(Boolean)`	`setTrackInSessionLifeCycleEventEnabled(Boolean)`	false
`setTrackAirbridgeLinkOnly(Boolean)`	`setTrackAirbridgeDeeplinkOnlyEnabled(Boolean)`	false
`setTransmitEventOnBackgroundEnabled(Boolean)`	`setPauseEventTransmitOnBackgroundEnabled(Boolean)`	false
`setLocationCollectionEnabled(Boolean)`	`setCollectLocationEnabled(Boolean)`	false
`setFacebookDeferredAppLinkEnabled(Boolean)`	`setTrackMetaDeferredAppLinkEnabled(Boolean)`	false
`setErrorLogCollectionEnabled(Boolean)`	`setErrorLogCollectionEnabled(Boolean)`	true
`setResetEventBufferEnabled(Boolean)`	`setClearEventBufferOnInitializeEnabled(Boolean)`	false
`setSdkEnabled(Boolean)`	`setSdkEnabled(Boolean)`	true
`setAppMarketIdentifier(String)`	`setAppMarketIdentifier(String)`	“”
`setPlatform(String)`	`setSDKDevelopmentPlatform(String)`	“native”
`setEventMaximumBufferCount(Int)`	`setEventBufferCountLimit(Int)`	Int.MAX_VALUE
`setEventMaximumBufferSize(Long)`	`setEventBufferSizeLimit(Long)`	Long.MAX_VALUE
`setEventTransmitInterval(Long)`	`setEventTransmitInterval(Long)`	0
`setCustomDomains(List<String>)`	`setCustomDomains(List<String>)`	emptyList()
`setOnDeferredDeeplinkReceiveListener(OnDeferredDeeplinkReceiveListener)`	remove	-
`setOnDeferredDeeplinkDetermineListener(OnDeferredDeeplinkDetermineListener)`	remove	-
`setOnAttributionResultReceiveListener(OnAttributionResultReceiveListener)`	`setOnAttributionReceived(OnAttributionResultReceiveListener)`	null
`setFacebookOnDeviceAttribution(String)`	`setMetaInstallReferrer(String)`	null
`setLifecycleIntegration(AirbridgeLifecycleIntegration)`	`setLifecycleIntegration(AirbridgeLifecycleIntegration)`	null

SDK Initialization

Airbridge.init(Application, AirbridgeConfig) has been changed to Airbridge.initializeSDK(Application, AirbridgeOption).

AirbridgeConfig has been changed to AirbridgeOption. AirbridgeConfig.Builderhas been changed to AirbridgeOptionBuilder. Some function names in the AirbridgeOptionBuilder have been changed or deleted.

Refer to the example below.

123456
override fun onCreate() {
    super.onCreate()
    val option = AirbridgeOptionBuilder("YOUR_APP_NAME", "YOUR_APP_SDK_TOKEN")
        .build()
    Airbridge.initializeSDK(this, option)
}

1234567
@Override
public void onCreate() {
    super.onCreate();
    AirbridgeOption option = new AirbridgeOptionBuilder("YOUR_APP_NAME", "YOUR_APP_SDK_TOKEN")
        .build();
    Airbridge.initializeSDK(this, option);
}

Deep Link

The function name has been changed from getDeeplink() to handleDeeplink(). AirbridgeCallback has been removed. The OnSuccess and OnFailure listener have been added. You can check whether the function worked by its return value.

12345
val result = Airbridge.handleDeeplink(
    intent = intent
    onSuccess = { },
    onFailure = { }
)
val result = Airbridge.handleDeeplink(
    intent = intent
    onSuccess = { },
    onFailure = { }
)

12345
boolean result = Airbridge.handleDeeplink(
        intent,
        uri -> { },
        throwable -> { }
);
boolean result = Airbridge.handleDeeplink(
        intent,
        uri -> { },
        throwable -> { }
);

We have improved the existing deferred deep link code logic that adds a listener to make screen transitions more convenient. The previous method of adding a listener has been removed. Instead, you can receive deferred deep links through the Airbridge interface.

You can call handleDeeplink and its value from the activity configuration.
You can check with the result value whether the deferred deep links can be handled.
Deferred deep links are designed to be acquired only once after the app install. If the value is already acquired or called first, the result is false.

1234
val result = Airbridge.handleDeferredDeeplink(
    onSuccess = { },
    onFailure = { }
)
val result = Airbridge.handleDeferredDeeplink(
    onSuccess = { },
    onFailure = { }
)

1234
boolean result = Airbridge.handleDeferredDeeplink(
        uri -> { },
        throwable -> { }
);
boolean result = Airbridge.handleDeferredDeeplink(
        uri -> { },
        throwable -> { }
);

In-app events and user data

The following APIs have been deleted. Also, StandardEventCategory, SemanticAttributes, and Product have been removed.

trackEvent(category: StandardEventCategory, action: String? = null, label: String? = null, value: Number? = null, customAttributes: Map<String, Any?>? = null, semanticAttributes: Map<String, Any?>? = null)
trackEvent(category: String, action: String? = null, label: String? = null, value: Number? = null, customAttributes: Map<String, Any?>? = null, semanticAttributes: Map<String, Any?>? = null)
trackEvent(event: Event)

New APIs have been added.

trackEvent(category: String, semanticAttributes: Map<String, Any>? = null, customAttributes: Map<String, Any>? = null)
AirbridgeCategory has been added. The event category string is predefined.
The function override and objects (SemanticAttributes, Product) for passing additional information were deleted.
Instead, it has been modified to transmit attributes through a map. The key value of the map is predefined in AirbridgeAttribute as a string. Custom attributes can be sent directly as a string.

Refer to the AirbridgeCategory, AirbridgeAttribute mapping and trackEvent function below.

Key	Type	Value
SIGN_UP	String	airbridge.user.signup
SIGN_IN	String	airbridge.user.signin
SIGN_OUT	String	airbridge.user.signout
HOME_VIEWED	String	airbridge.ecommerce.home.viewed
PRODUCT_LIST_VIEWED	String	airbridge.ecommerce.productList.viewed
SEARCH_RESULTS_VIEWED	String	airbridge.ecommerce.searchResults.viewed
PRODUCT_VIEWED	String	airbridge.ecommerce.product.viewed
ADD_PAYMENT_INFO	String	airbridge.addPaymentInfo
ADD_TO_WISHLIST	String	airbridge.addToWishlist
ADDED_TO_CART	String	airbridge.ecommerce.product.addedToCart
INITIATE_CHECKOUT	String	airbridge.initiateCheckout
ORDER_COMPLETED	String	airbridge.ecommerce.order.completed
ORDER_CANCELED	String	airbridge.ecommerce.order.canceled
START_TRIAL	String	airbridge.startTrial
SUBSCRIBE	String	airbridge.subscribe
UNSUBSCRIBE	String	airbridge.unsubscribe
AD_IMPRESSION	String	airbridge.adImpression
AD_CLICK	String	airbridge.adClick
COMPLETE_TUTORIAL	String	airbridge.completeTutorial
ACHIEVE_LEVEL	String	airbridge.achieveLevel
UNLOCK_ACHIEVEMENT	String	airbridge.unlockAchievement
RATE	String	airbridge.rate
SHARE	String	airbridge.share
SCHEDULE	String	airbridge.schedule
SPEND_CREDITS	String	airbridge.spendCredits

Key	Type	Value
ACTION	String	action
LABEL	String	label
VALUE	String	value
CURRENCY	String	currency
ORIGINAL_CURRENCY	String	originalCurrency
PRODUCTS	String	products
PRODUCT_ID	String	productID
PRODUCT_NAME	String	name
PRODUCT_PRICE	String	price
PRODUCT_QUANTITY	String	quantity
PRODUCT_CURRENCY	String	currency
PRODUCT_POSITION	String	position
PRODUCT_CATEGORY_ID	String	categoryID
PRODUCT_CATEGORY_NAME	String	categoryName
PRODUCT_BRAND_ID	String	brandID
PRODUCT_BRAND_NAME	String	brandName
PERIOD	String	period
IS_RENEWAL	String	isRenewal
RENEWAL_COUNT	String	renewalCount
PRODUCT_LIST_ID	String	productListID
CART_ID	String	cartID
TRANSACTION_ID	String	transactionID
TRANSACTION_TYPE	String	transactionType
TRANSACTION_PAIRED_EVENT_CATEGORY	String	transactionPairedEventCategory
TRANSACTION_PAIRED_EVENT_TIMESTAMP	String	transactionPairedEventTimestamp
TOTAL_QUANTITY	String	totalQuantity
QUERY	String	query
IN_APP_PURCHASED	String	inAppPurchased
CONTRIBUTION_MARGIN	String	contributionMargin
ORIGINAL_CONTRIBUTION_MARGIN	String	originalContributionMargin
LIST_ID	String	listID
RATE_ID	String	rateID
RATE	String	rate
MAX_RATE	String	maxRate
ACHIEVEMENT_ID	String	achievementID
SHARED_CHANNEL	String	sharedChannel
DATE_TIME	String	datetime
DESCRIPTION	String	description
IS_REVENUE	String	isRevenue
PLACE	String	place
SCHEDULE_ID	String	scheduleID
TYPE	String	type
LEVEL	String	level
SCORE	String	score
AD_PARTNERS	String	adPartners
IS_FIRST_PER_USER	String	isFirstPerUser

123456789101112131415161718192021222324252627
Airbridge.trackEvent(
    AirbridgeCategory.ORDER_COMPLETED,
    mapOf(
        // action
        AirbridgeAttribute.ACTION to "Tool",
        // label
        AirbridgeAttribute.LABEL to "Hammer",
        // value
        AirbridgeAttribute.VALUE to 10,
        // semantic attribute (provided by sdk)
        AirbridgeAttribute.CURRENCY to "USD",
        AirbridgeAttribute.PRODUCTS to listOf(
            mapOf(
                // semantic attribute value (provided by sdk)
                AirbridgeAttribute.PRODUCT_ID to "12345",
                // semantic attribute value (not provided by sdk)
                "name" to "PlasticHammer",
            ),
        ),
        // semantic attribute (not provided by sdk)
        "totalQuantity" to 1,
    ),
    mapOf(
        // custom attribute
        "promotion" to "FirstPurchasePromotion",
    )
)
Airbridge.trackEvent(
    AirbridgeCategory.ORDER_COMPLETED,
    mapOf(
        // action
        AirbridgeAttribute.ACTION to "Tool",
        // label
        AirbridgeAttribute.LABEL to "Hammer",
        // value
        AirbridgeAttribute.VALUE to 10,
        // semantic attribute (provided by sdk)
        AirbridgeAttribute.CURRENCY to "USD",
        AirbridgeAttribute.PRODUCTS to listOf(
            mapOf(
                // semantic attribute value (provided by sdk)
                AirbridgeAttribute.PRODUCT_ID to "12345",
                // semantic attribute value (not provided by sdk)
                "name" to "PlasticHammer",
            ),
        ),
        // semantic attribute (not provided by sdk)
        "totalQuantity" to 1,
    ),
    mapOf(
        // custom attribute
        "promotion" to "FirstPurchasePromotion",
    )
)

12345678910111213141516171819202122232425262728
Airbridge.trackEvent(
        AirbridgeCategory.ORDER_COMPLETED,
        new HashMap() {{
            // action
            put(AirbridgeAttribute.ACTION, "Tool");
            // label
            put(AirbridgeAttribute.LABEL, "Hammer");
            // value
            put(AirbridgeAttribute.VALUE, 10);
            // semantic attribute (provided by sdk)
            put(AirbridgeAttribute.CURRENCY, "USD");
            put(AirbridgeAttribute.PRODUCTS, Arrays.asList(
                new HashMap() {{
                    // semantic attribute value (provided by sdk)
                    put(AirbridgeAttribute.PRODUCT_ID, "12345");
                    // semantic attribute value (not provided by sdk)
                    put("name", "PlasticHammer");
                }}
            ));
            // semantic attribute (not provided by sdk)
            put("totalQuantity", 1);
            
        }},
        new HashMap() {{
            // custom attribute
            put("promotion", "FirstPurchasePromotion");
        }}
);
Airbridge.trackEvent(
        AirbridgeCategory.ORDER_COMPLETED,
        new HashMap() {{
            // action
            put(AirbridgeAttribute.ACTION, "Tool");
            // label
            put(AirbridgeAttribute.LABEL, "Hammer");
            // value
            put(AirbridgeAttribute.VALUE, 10);
            // semantic attribute (provided by sdk)
            put(AirbridgeAttribute.CURRENCY, "USD");
            put(AirbridgeAttribute.PRODUCTS, Arrays.asList(
                new HashMap() {{
                    // semantic attribute value (provided by sdk)
                    put(AirbridgeAttribute.PRODUCT_ID, "12345");
                    // semantic attribute value (not provided by sdk)
                    put("name", "PlasticHammer");
                }}
            ));
            // semantic attribute (not provided by sdk)
            put("totalQuantity", 1);
            
        }},
        new HashMap() {{
            // custom attribute
            put("promotion", "FirstPurchasePromotion");
        }}
);

AirbridgeUser has been deleted. You can now access the interface through the Airbridge interface that was previously accessible through AirbridgeUser.

Instead of accessing the code through Airbridge.getUserInfo(), you need to replace it with the following Airbridge interface.

123456789101112131415161718
fun setUserID(id: String)
fun setUserEmail(email: String)
fun setUserPhone(phone: String)

fun setUserAttribute(key: String, value: Int)
fun setUserAttribute(key: String, value: Long)
fun setUserAttribute(key: String, value: Float)
fun setUserAttribute(key: String, value: Double)
fun setUserAttribute(key: String, value: Boolean)
fun setUserAttribute(key: String, value: String)
fun removeUserAttribute(key: String)
fun clearUserAttributes()

fun setUserAlias(key: String, value: String)
fun removeUserAlias(key: String)
fun clearUserAlias()

fun clearUser()
fun setUserID(id: String)
fun setUserEmail(email: String)
fun setUserPhone(phone: String)

fun setUserAttribute(key: String, value: Int)
fun setUserAttribute(key: String, value: Long)
fun setUserAttribute(key: String, value: Float)
fun setUserAttribute(key: String, value: Double)
fun setUserAttribute(key: String, value: Boolean)
fun setUserAttribute(key: String, value: String)
fun removeUserAttribute(key: String)
fun clearUserAttributes()

fun setUserAlias(key: String, value: String)
fun removeUserAlias(key: String)
fun clearUserAlias()

fun clearUser()

123456789101112131415161718
void setUserID(String id)
void setUserEmail(String email)
void setUserPhone(String phone)

void setUserAttribute(String key, int value)
void setUserAttribute(String key, long value)
void setUserAttribute(String key, float value)
void setUserAttribute(String key, double value)
void setUserAttribute(String key, boolean value)
void setUserAttribute(String key, String value)
void removeUserAttribute(String key)
void clearUserAttributes()

void setUserAlias(String key, String value)
void removeUserAlias(key: String)
void clearUserAlias()

void clearUser()
void setUserID(String id)
void setUserEmail(String email)
void setUserPhone(String phone)

void setUserAttribute(String key, int value)
void setUserAttribute(String key, long value)
void setUserAttribute(String key, float value)
void setUserAttribute(String key, double value)
void setUserAttribute(String key, boolean value)
void setUserAttribute(String key, String value)
void removeUserAttribute(String key)
void clearUserAttributes()

void setUserAlias(String key, String value)
void removeUserAlias(key: String)
void clearUserAlias()

void clearUser()

AirbridgeDeviceInfo has been deleted. The interface that was accessed through AirbridgeDeviceInfo has been modified so that it can now be accessed through the Airbridge interface.

AirbridgeCallback has been deleted and OnSuccess, OnFailure listener has been added. You can receive the success status through this listener.

You need to replace the codes that enables access through Airbridge.getDeviceInfo() with the following Airbridge interface.

Device UUID

1234
val result = Airbridge.fetchDeviceUUID(
    onSuccess = { },
    onFailure = { }
)
val result = Airbridge.fetchDeviceUUID(
    onSuccess = { },
    onFailure = { }
)

1234
boolean result = Airbridge.fetchDeviceUUID(
        uuid -> { },
        throwable -> { }
    );
boolean result = Airbridge.fetchDeviceUUID(
        uuid -> { },
        throwable -> { }
    );

Install referrer

fetch Google Install referrer

1234
val result = Airbridge.fetchGoogleInstallReferrerDetails(
    onSuccess = { },
    onFailure = { }
)
val result = Airbridge.fetchGoogleInstallReferrerDetails(
    onSuccess = { },
    onFailure = { }
)

1234
boolean result = Airbridge.fetchGoogleInstallReferrerDetails(
        referrerDetails -> { },
        throwable -> { }
);
boolean result = Airbridge.fetchGoogleInstallReferrerDetails(
        referrerDetails -> { },
        throwable -> { }
);

fetch Huawei Install referrer

1234
val result = Airbridge.fetchHuaweiInstallReferrerDetails(
    onSuccess = { },
    onFailure = { }
)
val result = Airbridge.fetchHuaweiInstallReferrerDetails(
    onSuccess = { },
    onFailure = { }
)

1234
boolean result = Airbridge.fetchHuaweiInstallReferrerDetails(
        referrerDetails -> { },
        throwable -> { }
    );
boolean result = Airbridge.fetchHuaweiInstallReferrerDetails(
        referrerDetails -> { },
        throwable -> { }
    );

fetch Galaxy store Install referrer

1234
val result = Airbridge.fetchGalaxyStoreInstallReferrerDetails(
    onSuccess = { },
    onFailure = { }
)
val result = Airbridge.fetchGalaxyStoreInstallReferrerDetails(
    onSuccess = { },
    onFailure = { }
)

1234
boolean result = Airbridge.fetchGalaxyStoreInstallReferrerDetails(
        referrerDetails -> { },
        throwable -> { }
    );
boolean result = Airbridge.fetchGalaxyStoreInstallReferrerDetails(
        referrerDetails -> { },
        throwable -> { }
    );

fetch Meta Install referrer

1234
val result = Airbridge.fetchMetaInstallReferrerDetails(
    onSuccess = { },
    onFailure = { }
)
val result = Airbridge.fetchMetaInstallReferrerDetails(
    onSuccess = { },
    onFailure = { }
)

1234
boolean result = Airbridge.fetchMetaInstallReferrerDetails(
        referrerDetails -> { },
        throwable -> { }
    );
boolean result = Airbridge.fetchMetaInstallReferrerDetails(
        referrerDetails -> { },
        throwable -> { }
    );

Advertising ID

fetch Google Advertising ID

1234
val result = Airbridge.fetchGoogleAdvertisingIdInfo(
    onSuccess = { },
    onFailure = { }
)
val result = Airbridge.fetchGoogleAdvertisingIdInfo(
    onSuccess = { },
    onFailure = { }
)

1234
boolean result = Airbridge.fetchGoogleAdvertisingIdInfo(
        advertisingIdInfo -> { },
        throwable -> { }
    );
boolean result = Airbridge.fetchGoogleAdvertisingIdInfo(
        advertisingIdInfo -> { },
        throwable -> { }
    );

fetch Huawei Advertising ID

1234
val result = Airbridge.fetchHuaweiAdvertisingIdInfo(
	onSuccess = { },
	onFailure = { }
)
val result = Airbridge.fetchHuaweiAdvertisingIdInfo(
	onSuccess = { },
	onFailure = { }
)

1234
boolean result = Airbridge.fetchHuaweiAdvertisingIdInfo(
        advertisingIdInfo -> { },
        throwable -> { }
    );
boolean result = Airbridge.fetchHuaweiAdvertisingIdInfo(
        advertisingIdInfo -> { },
        throwable -> { }
    );

AirbridgeDeviceInfo has been deleted. There is no function to receive the attribution result through the Airbridge interface. However, it can be received through the listener of AirbridgeOption, which is an existing method.

123456789101112
class App : Application() {

    override fun onCreate() {
        super.onCreate()
        val option: AirbridgeOption = AirbridgeOptionBuilder("YOUR_APP_NAME", "YOUR_APP_SDK_TOKEN")
            .setOnAttributionReceived { result ->
                // do something
            }
            .build()
        Airbridge.initializeSDK(this, option)
    }
}
class App : Application() {

    override fun onCreate() {
        super.onCreate()
        val option: AirbridgeOption = AirbridgeOptionBuilder("YOUR_APP_NAME", "YOUR_APP_SDK_TOKEN")
            .setOnAttributionReceived { result ->
                // do something
            }
            .build()
        Airbridge.initializeSDK(this, option)
    }
}

123456789101112131415
class App extends Application {
    
    @Override
    public void onCreate() {
        super.onCreate();
        
        Airbridge.initializeSDK(this,
                new AirbridgeOptionBuilder("YOUR_APP_NAME", "YOUR_APP_SDK_TOKEN")
                        .setOnAttributionReceived(result -> {
                            // do something
                        })
                        .build()
                );
    }
}
class App extends Application {
    
    @Override
    public void onCreate() {
        super.onCreate();
        
        Airbridge.initializeSDK(this,
                new AirbridgeOptionBuilder("YOUR_APP_NAME", "YOUR_APP_SDK_TOKEN")
                        .setOnAttributionReceived(result -> {
                            // do something
                        })
                        .build()
                );
    }
}

AirbridgeCallback has been deleted and OnSuccess, OnFailure listeners have been added. You can check the operation status of the function through the return value.

click

12345
fun click(
    trackingLink: String,
    onSuccess: OnSuccess<Unit>? = null,
    onFailure: OnFailure? = null
): Boolean
fun click(
    trackingLink: String,
    onSuccess: OnSuccess<Unit>? = null,
    onFailure: OnFailure? = null
): Boolean

12345
boolean click(
    @NonNull String trackingLink,
    @Nullable OnSuccess<Unit> onSuccess,
    @Nullable OnFailure onFailure
)
boolean click(
    @NonNull String trackingLink,
    @Nullable OnSuccess<Unit> onSuccess,
    @Nullable OnFailure onFailure
)

impression

12345
fun impression(
    trackingLink: String,
    onSuccess: OnSuccess<Unit>? = null,
    onFailure: OnFailure? = null
): Boolean
fun impression(
    trackingLink: String,
    onSuccess: OnSuccess<Unit>? = null,
    onFailure: OnFailure? = null
): Boolean

12345
boolean impression(
    @NonNull String trackingLink,
    @Nullable OnSuccess<Unit> onSuccess,
    @Nullable OnFailure onFailure
)
boolean impression(
    @NonNull String trackingLink,
    @Nullable OnSuccess<Unit> onSuccess,
    @Nullable OnFailure onFailure
)

Hybrid app integration

The function name has been changed from setJavascriptInterface() to setWebInterface().

1
Airbridge.setWebInterface(webview, "YOUR_WEB_TOKEN")
Airbridge.setWebInterface(webview, "YOUR_WEB_TOKEN")

Update within v2.x

Refer to the major changes in each version of the Android SDK.

v2.24.0

For Airbridge apps created after September 4, 2023, we’ve resolved the issue where the deep-link URL provided in the deep-link callback was decoding the content entered in the Airbridge dashboard twice.

This issue occurred in Android SDK from v2.22.0 to v2.23.0.

v2.21.2

An initialization option has been added to stop sending events when the app is in the background.

You can use the AirbridgeConfig#setTransmitEventOnBackgroundEnabledfunction to stop sending events when the app is in the background.
The default value is true. When true, the remaining events are sent even when the app is in the background.

v2.21.1

deeplink.page is not supported. From 2.21.1 onwards, we recommend writing code using the abr.ge deep link domain.

deeplink.page is still supported and operates for backward compatibility.

v2.19.1

Changes have been made so that ORGANIC_REOPEN, FOREGROUND events that occur within the session time are not collected by default.

If you are using a version before 2.19.1 and you are collecting ORGANIC_REOPEN, FOREGROUND events, you can continue collecting these events through AirbridgeConfig#setTrackInSessionLifeCycleEventEnabled.
The default value is false, meaning ORGANIC_REOPEN and FOREGROUND events are not collected.

BACKGROUNDevents have been removed.

v2.18.0

Deeplink Pageview events will only be collected when Airbridge.click is called.

Was this page helpful?

Have any questions or suggestions?

SDK Migration - Android SDK (v4)

Update from v2.x to v4.0

List of all changes

Airbridge Interface

Summary

Deprecated Interface

Class changes

Added

Hidden

Removed

Moved

AirbridgeOption

SDK Initialization

Deep Link

Required: Deferred deep link processing

In-app events and user data

Event Category of Standard Events provided by the SDK (AirbridgeCategory)

Semantic Attributes provided by the SDK (AirbridgeAttribute)

Example) trackEvent function

Required: Airbridge interface

Required: OnSuccess, OnFailure

Device UUID

Install referrer

Advertising ID

Example) click and impression functions

Hybrid app integration

Update within v2.x

v2.24.0

v2.21.2

v2.21.1

v2.19.1

v2.18.0

SDK Migration - Android SDK (v4)self.__wrap_n!=1&&self.__wrap_b(":R29jtt7ppjtsba:",0.5)

Update from v2.x to v4.0

List of all changes

Airbridge Interface

Summary

Deprecated Interface

Class changes

Added

Hidden

Removed

Moved

AirbridgeOption

SDK Initialization

Deep Link

Required: Deferred deep link processing

In-app events and user data

Event Category of Standard Events provided by the SDK (AirbridgeCategory)

Semantic Attributes provided by the SDK (AirbridgeAttribute)

Example) trackEvent function

Required: Airbridge interface

Required: OnSuccess, OnFailure

Device UUID

Install referrer

Advertising ID

Example) click and impression functions

Hybrid app integration

Update within v2.x

v2.24.0

v2.21.2

v2.21.1

v2.19.1

v2.18.0

SDK Migration - Android SDK (v4)