ZendeskConnect Android SDK release notes

At a glance: Android SDK release notes starting from V4.x.

Android SDK V6 release notes

Android SDK integration guide for marketers

Android SDK V6 release notes

Version	Release date	Maintenance only	Notes
6.5.1	2021-12-29		Bugfix: Deeplink resolution with UDL for apps that use the Out-of-Store with Channel option.
6.5.0	2021-12-07		Refactoring and internal changes.
6.4.3	2021-11-14		Bugfix: Fixed a bug introduced in  V6.4.2with LinkGenerator causing the creation of links with missing URL parameters.
6.4.2	2021-10-24		Bugfix: pid parameter being appended twice to custom URLs generated by LinkGenerator. Bugfix: Extra / was added to the af_dp value when using LinkGenerator to create custom URI schemes. Bugfix: both IMEI and AndroidID collected, if the app triggered the collection of only one of them.
6.4.1	2021-10-17		Bugfix: Fixed compilation error when using Gradle version below 3.5.4.
6.4.0	2021-09-12		Added API: setSharingFilterForPartners lets you configure which partners the SDK should exclude from data-sharing. As of this version, setSharingFilter and setSharingFilterForAllPartners are deprecated.
6.3.2	2021-06-06		New API: setDisableAdvertisingIdentifiers
6.3.1	2021-05-26		New API: performOnDeepLinking Added the ability to trigger the User Invite API before calling start/after calling stop Bugfix: Fixed an issue where a call to waitForCustomerUserId wasn't released even after calling setCustomerUserId
6.3.0	2021-04-29		Bugfix: Wrong invocation of onConversionDataFail upon in-app event send request failure Bugfix: motion sensor metric collection (for fraud detection) Bugfix: Obfuscation-related fix to UDL Technical update to the OneLink API
6.2.3	2021-03-04	Yes
6.2.0	2021-02-07		New API: setPartnerData
6.1.4	2021-01-12		Added support for DexGuard V9
6.1.3	2020-12-24		New API: addPushNotificationDeepLinkPath (supports Movable Ink)
6.1.1	2020-12-03		Added support Samsung Galaxy Store referrer Minor bug fixes and performance improvements.
6.1.0	2020-11-09		Added support for Unified deep linking API
6.0.1	2020-10-28	Yes
6.0.0	2020-10-14		Major changes to SDK functionality and API including deprecation and method name changes. Learn more

Android V6.0.0 release notes

Methods removed/deprecated or renamed

Methods removed/deprecated

The following methods have been removed from the SDK:

• sendDeepLinkData

• trackAppLaunch

• setPluginDeepLinkData

• setConsumeAFDeepLinks

• setHostName

Methods renamed

API name (before V6)	Current API name (V6 and later)
stopTracking	stop
setCustomerIdAndTrack	setCustomerIdAndLogSession
startTracking	start
trackLocation	logLocation
reportTrackSession	logSession
trackEvent	logEvent
setDeviceTrackingDisabled	anonymizeUser
validateAndTrackInAppPurchase	validateAndLogInAppPurchase
isStopTracking	isStopped
trackAndOpenStore	logAndOpenStore
trackCrossPromoteImpression	logCrossPromoteImpression
trackInvite	logInvite

Renamed interface

Interface name (before V6)	Current interface name (V6 and later)
ZendeskConnectTrackingRequestListener	ZendeskConnectRequestListener

Android SDK V5 release notes

Android SDK V5 release notes

Version	Release date	Maintenance only	Notes
5.4.6	2020-11-09		Added support for Huawei AppGallery referrer.
5.4.4	2020-10-01		Added support for SDK to handle multiple redirects from ESPs Bug fixes and maintenance
5.4.3	2020-07-30		Extended logging and debugging capabilities Bug fixes and maintenance Support for Google install referrer V2
5.4.1	2020-06-30		Allow advertisers to control sharing data with integrated partners/networks. Learn more Bug fixes and maintenance
5.4.0	2020-06-03		Full support for automatically collecting OAID Multi-referrer support: SDK can collect Huawei and Google referrers SDK performance improvements Bug fixes and maintenance
5.3.0	2020-04-27		Access the latest direct deep linking conversion data anytime, via onAppOpenAttribution method Additional parameters available for cross-promotion impressions Bug fix: fixed problems with a. and b. file names in Windows sendDeepLinkData method to get attribution data even if the user is deep linked into a specific activity has been deprecated in favor of the startTracking() method
5.2.0	2020-03-10		Allow initialization of SDK in any activity Extended security, logging, and debugging capabilities Bug fixes and maintenance
5.1.2	2020-02-19	Yes
5.1.1	2020-01-23	Yes
5.1.0	2020-01-06		Target to Android 9 (API level 28) according to Google target API level requirements Improvements for anti-fraud protections - for Protect360 clients Optional module for collecting OAID (relevant for China domestic) - Xiaomi and Huawei (see https://github.com/ZendeskConnectSDK/appsflyer-oaid). Bug fix: fixed crash when using setOneLinkCustomDomain for ESPs
5.0.2	2019-12-23	Yes
5.0.1	2019-12-12	Yes
5.0.0	2019-11-12		Bug fixes and maintenance Major changes to SDK functionality and API including deprecation and method name changes. Learn more

Android V5.0.0 release notes

Improved SDK response time

Starting with SDK V5.0.0 improved GCD response time for organic installs.

Methods removed or renamed

Method name changes

Install conversion data method names are now the same for Android and ioS. This impacts methods that handle:

• conversion data on install
• errors if data is not available

Conversion data method name changes

Android name prior to SDK V5	iOS name prior to SDK V5	Standardized name
onInstallConversionDataLoaded	onConversionDataReceived	onConversionDataSuccess
onInstallConversionFailure	onConversionDataRequestFailure	onConversionDataFail

Methods removed

The following methods were deprecated in previous SDK versions. They have now been removed from the SDK.

Android

• setGCMProjectID (String projectNumber)
• setGCMProjectNumber (String projectNumber)
• setGCMProjectNumber (Context context, String projectNumber)
• enableUninstallTracking (String senderId)
• setAppUserId (String id)
• setUserEmail (String email)
• setCollectFingerPrint (boolean isCollect) 
• getAttributionId (ContentResolver contentResolver)
• FirebaseInstanceIdListener class (instance of FirebaseInstanceIdService)

 iOS

• loadConversionDataWithDelegate: (id<ZendeskConnectTrackerDelegate>)delegate
• setHost:(NSString *)host 

Changes to get conversion data format

In this version, for each install or app open, the SDK returns a map object that contains conversion data (GCD) such as media source and campaign name. In previous SDK versions, GCD returned only parameters that had a value

Starting with this version, all parameters are returned, including those without a value. Parameters without value have a null value. 

 Example

An install follows a click on the following URL:

https://app.appsflyer.com/com.sample.app?pid=super_media_source&c=awesome_campaign
&campaign_id=1234&af_sub1=promo

The responses are as follows:

GCD response prior to SDK V5 GCD response starting SDK V5

 {
    "install_time": "2019-11-11 15:00:59.828",
    "media_source": "super_media_source",
    "orig_cost": "0.0",
    "advertising_id": "215d8172-c61e-4d0c-9eb2-aa4d0971ed8c",
    "af_status": "Non-organic",
    "is_first_launch": "true",
    "af_sub1": "promo",
    "af_click_lookback": "7d",
    "cost_cents_USD": "0",
    "iscache": "true",
    "click_time": "2019-11-11 15:00:35.102",
    "campaign": "awesome_campaign",
    "campaign_id": "1234",
}
    

 {
    "adgroup": null,
    "campaign": "awesome_campaign",
    "media_source": "super_media_source",
    "adset_id": null,
    "campaign_id": 1234,
    "iscache": true,
    "install_time": "2019-11-11 15:00:59.828",
    "adgroup_id": null,
    "af_sub5": null,
    "click_time": "2019-11-11 15:00:35.102",
    "agency": null,
    "cost_cents_USD": "0",
    "advertising_id": "215d8172-c61e-4d0c-9eb2-aa4d0971ed8",
    "adset": null,
    "af_sub3": null,
    "af_siteid": null,
    "http_referrer": null,
    "orig_cost": "0.0",
    "af_sub4": null,
    "af_cpi": null,
    "af_sub1": "promo",
    "af_click_lookback": "7d",
    "af_sub2": null,
    "af_status": "Non-organic",
    "is_first_launch": "true",
    "retargeting_conversion_type": "none"
}
    

GCD returns the same structure no matter the data. If a parameter is empty, it is included in GCD with a null value. This makes it easier for developers to process GCD without having to adjust the GCD processing logic, irrespective of whether certain parameters are included or not. To learn more about conversion data in different scenarios, see here.

Android SDK V4 release notes

V4.8.5-V4.11.0

V4.11.0 - October 22, 2019

• Improved logging for better debug capabilities for the following:
  • ESP
  • Branded Links resolving
  • onInstallConversionData and onAppOpenAttribution.
• Bug fixes and maintenance

V4.10.3 - September 15, 2019

• Bug fixes and maintenance
• Support for Open Advertiser ID (OAID) 

V4.10.2 - July 14, 2019

• Bug fixes and maintenance

V4.10.1 - July 1, 2019

• Bug fixes and maintenance

V4.10.0 - May 14, 2019

• SDK improvements for developers using ProGuard.
• Bug fixes and maintenance

V4.9.0 - March 17, 2019

• setResolveDeepLinkURLs API for resolving OneLinks wrapped with another Universal Link
• Fix for push notification recording when the discarded push notification recording of the previous payload contained the same pid and was still in memory.
• Typo fix from af_county to af_country
• Bug fixes and maintenance

V4.8.20 - February 13, 2019

• Improved zero-rating capabilities for cellular providers
• Bug fixes and maintenance

V4.8.19 - December 26, 2018

• Fixed issue where the method waitForCustomerUserId() breaks generateLink
• Bug fixes and maintenance

V4.8.18 - November 11, 2018

• Fixed deep linking issues from trampoline activities
• Improved accuracy of re-engagement when moving between background and foreground
• Bug fixes and maintenance

V4.8.17 - November 2, 2018

• Fix for an issue related to conflicts in ProGuard causing loss of app launch data in some cases. This issue affected only SDK version 4.8.16

V4.8.16 - October 31, 2018

• Bug fixes and maintenance

V4.8.15 - August 27, 2018

• Additional SDK Events: Subscribe, Start Trial, Ad Click, Ad View
• Bug fixes and maintenance

V4.8.14 - July 31, 2018

• Added setOutOfStore and getOutOfStore APIs for dynamically setting the AF_STORE value
• Added onTrackingRequestFailure and onTrackingRequestSuccess APIs for receiving a confirmation that the tracking request was successfully received by the ZendeskConnect servers

V4.8.13 - June 20, 2018

• Fixed bug in an edge case where IMEI was missing when passed explicitly through setImeiData API
• Bug fixes and maintenance

V4.8.12 - May 27, 2018

• Fixed app crashing when using JUnit test that uses Robolectric
• Bug fixes and maintenance

V4.8.11 - May 2, 2018

• Bug fixes and maintenance

V4.8.10 - April 26, 2018

• Added setPreinstallAttribution API
• Bug fixes and maintenance

V4.8.9 - April 2, 2018

• Collect IMEI only if GooglePlayServices doesn't exist on the device and it's not possible to retrieve GAID on that device
• Bug fixes and maintenance

V4.8.8 - March 11, 2018

• Added API for delaying SDK initialization until customerUserID is provided
• Bug fixes and maintenance.

V4.8.7 - January 25, 2018

• isStopTracking API to shut down all SDK activities
• af_content event parameter

V4.8.6 - December 5, 2017

• Fix for malformed JSON in Android API 18 and lower

V4.8.5 - November 29, 2017

• Support for new Google referrer API
• New init method which receives context

Until V4.8.4 (deprecated versions)

V4.8.4 - November 14, 2017

• Added a flag to getConversionData is_first_launch which indicates if this is the first launch of the application. This flag allows developers to identify the first launch of the app easily within the getConversionData callback response which is returned in every launch. Possible values for is_first_launch are "true" or "false"
• Bug fixes and maintenance

V4.8.3 - September 27, 2017

• Added support for http referrer data in getConversionData

V4.8.2 - September 19, 2017

• Fix in sendDeepLinkData(this) for apps that deep link to multiple activities

V4.8.1 - September 17, 2017

• Improved protection against in-app events called before SDK initialization

V4.8.0 - September 3, 2017

• User Invite APIs
• Cross-promotion APIs
• Custom time between sessions
• Support for Zero Rating for Cellular Providers
• Additional event parameter af_projected_revenue
• Bug fixes and maintenance
• Additional init method introduced - ZendeskConnectLib.getInstance().init(AF_DEV_KEY,conversionDataListener);

V4.7.4 - June 28, 2017

• Improved handling of multiple ScheduledExecutorService shutdowns
  

V4.7.3 - June 6, 2017

• Enhancements for mParticle integration

V4.7.2 - May 22, 2017

• Fixed minor memory leak issue
• Improved accuracy of Uninstall measurement
• Fixed ProGaurd warning which affected uninstall measurement
• Bug fixes and maintenance

V4.7.1 - February 22, 2017

• Fixed warning triggered by ProGuard

V4.7.0 - February 13, 2017

• Additional Event Parameters
• Support for Firebase based uninstall measurement
• Bug fixes and maintenance

Android SDK checksums

ZendeskConnect uses md5 checksums:

V6 checksums

Android SDK version	Checksum
6.5.1	261928cfc55b27a6c2ab19cf9081d705
6.5.0	2a6d500fd4939a8faa47bbbba97288b6
6.4.3	c62f9359d6b5497d54e248c526c5f547
6.4.2	dc385fb62eaf68aff2e7f9c1c0ed19ea
6.4.1	94945db2c0e81baab79535393f210f1b
6.4.0	d7910a35901d4299b54259f1c1bbe2d6
6.3.2	46bc92bb2eed1416de28ccccb3a28620
6.3.1	ca47af77ffbcd7525e82d0bdaaef5b91
6.3.0	f969bb5a62885e8084794d5334787275
6.2.3	bab1309f77acd1f0453372150c82694a
6.2.0	fc727698c7b8bfb1ca448726492931b4
6.1.4	983785b1c30a15e8fac029e370bb3b73
6.1.3	c0392a091659dc445a1014e14da6a31a
6.1.1	0a18fafb2826c90b3388b371a3cbdeec
6.1.0	e8d6df04ac2642b2d7b16efb57f315e9
6.0.1	9ebeb6f4f49476667c07d0e8eb1aa2e8
6.0.0	cff3d453ea94e67182f5b1b023aeb1c1

V5 checksums

Android SDK version	Checksum
5.4.6	4f1bdc33ac0d6dd3f9b75411c3c0a06c
5.4.4	13a04913cf61276238f54e5e2d73e88d
5.4.3	7b1caef46942c70edcd2e59cad69e439
5.4.1	e4eb21c0030f376857b53e2e30022fc8
5.4.0	8c0270f6c3e7e58b1db42be82cc341d8
5.3.0	d602dd28d9ee807855e5426d6a9b7ebf
5.2.0	64fe94447def6d99549d3274ce908f09
5.1.2	1a7dbb23aad32d697835f3ec29337ca9
5.1.1	dfea6a49e6ae57fc2c700f6dcd904bc1
5.1.0	89cc7e08a0430180e64f3cccf955768f
5.0.2	c113618ea379531cba6ce42bc4c79d72
5.0.1	db0502faa5b02102dd99ac6cec666d04
5.0.0	98f1f78ae5f63cb4f40ba838d3d1be22

V4 checksums

Android SDK version	Checksum
4.10.3	855186d68912810fa47897262a9ba0a0
4.10.2	13ed5716d5a8583eeee527f01bd2a69d
4.10.1	ab3e49bb4640990267466b7852cd3de7
4.10.0	b5fb55ee76cd6a742d9bd25b910745a1
4.9.0	afa49524ddceda28ca1648946489a6b0
4.8.20	2f59d0f8db09b92f8261475a1d0807d0
4.8.19	baf8fa419f38de52cef6091de32aca86
4.8.18	3a0641720811a25542449f1927daf13e
4.8.17	3a0641720811a25542449f1927daf13e
4.8.16	501be427b0c2a831e148649131ce3fc0
4.8.15	7b6759a006d72d3a7c78ec80160c3502
4.8.14	bc4facd80958d0600b4d000104e524d9
4.8.13	bc4facd80958d0600b4d000104e524d9
4.8.12	171569002d93fb8d49787b363192973f
4.8.11	4419af159a42e4ee7a218ef8615e2abb
4.8.10	468ad04e4a2088ba7af9c45d42f4ed6d
4.8.9	9a923bbbf3f6c7cc19b900e49644da2c
4.8.8	6dee4814986061a0723cc9f844796e2e
4.8.7	ca13997ccb781a5935e91983b7be81ea
4.8.6	da117a3e9e05df7dd28297df762cfbfa
4.8.5	f8ea07b8a60d664541686ba7064730f5
4.8.4	b10f185c1094cf283b11339810a47c87
4.8.3	7f94ec175b948c5009bfbfe2fb25b2b0
4.8.2	3e34b55e13cd3f8d387b1a33c20105eb
4.8.1	6c2930d2997a7b2b6ab7b3ecf0e3135b
4.8.1	468ad04e4a2088ba7af9c45d42f4ed6d
4.8.1	4419af159a42e4ee7a218ef8615e2abb latest
4.8.0	32d67577ce59b2072475e509579baece
4.7.4	7e649e6a1cf8999ca39b05402946b3d6
4.7.3	e30c020f8ee5dd3af274fa94ef414a38
4.7.2	945aaaca554aa8b2f96219f25eed9777
4.7.1	862c349025e4725d4e5044a190c60337
4.7.0	b060ad140ffd0c8f2b3febb26122d173