-
Notifications
You must be signed in to change notification settings - Fork 365
Changelog
Obsolete, please use this doc instead:
v6.0.0 (2022-01-02)
- Remove Messages & Experiments feature, for more detail, please check this post:
- Deprecate both the Mixpanel default property
$google_play_services
and tracking Install Referrer in favor of not being marked as containing Ads.
v5.9.6 (2021-12-14)
- java.lang.ClassNotFoundException when calling MixpanelAPI.getInstance in 5.9.3 #766
- Please add trailing slashes to request endpoints in the Android SDK. #764
- Remove integrations code for braze and airship #770
- Readme change: rebrand for live view report to events report #767
v5.9.5 (2021-10-19)
- Add trailing slashes to request endpoint to in parity with iOS #765
- Android 4 NullPointerException #763
- Mixpanel 5.9.3 org/jacoco/agent/rt/internal_8ff85ea/Offline #761
v5.9.4 (2021-10-08)
- Fix java.lang.NoClassDefFoundError: Failed resolution of: Lorg/jacoco/agent/rt/internal_8ff85ea/Offline #762
v5.9.3 (2021-10-07)
- Remove typo in the class name
LocalBroadcastManager
for reflection #760
- Google Play policy to update targetSdkVersion to 30 #756
- Failed resolution of: Lcom/google/firebase/iid/FirebaseInstanceId #744
- Mixpanel using legacy support libs in reflection calls - can't drop jetifier due to this #717
v5.9.2 (2021-10-07)
- remove legacy support libs in reflection calls #759
- Upgrade targetSdkVersion to 30 #758
- Add explicit exported flag to activities #755
- Crash in v5.9.1, java.lang.AssertionError @ WebSocketImpl.java:675 #757
- In-app messages cause: IllegalArgumentException: Software rendering doesn't support hardware bitmaps #753
- Mixpanel.addPushDeviceToken ? #752
- User profile are not showing on mixpanel dashborad #751
- SHA-1 usaged flagged as a security risk #750
- Rejecting re-init on previously-failed class java.lang.Class<com.mixpanel.android.mpmetrics.InstallReferrerPlay>: java.lang.NoClassDefFoundError: Failed resolution of: Lcom/android/installreferrer/api/InstallReferrerStateListener; #746
- App crashing with ConcurrentModificationException in Mixpanel SDK code #720
- In-app messages cause android app crash "Software rendering doesn't support hardware bitmaps" #711
- Improve README for the quick start guide #749
- Add a CHANGELOG placeholder #747
- Add github workflow for auto release #745
- Migrate to Github Actions for CI #743
May 18th - 2021
- Migrate to Airship 12.x for the integration https://github.com/mixpanel/mixpanel-android/pull/742
April 29th - 2021
- add
setUseIpAddressForGeolocation
,setEnableLogging
andsetServerURL
. Now you can disable/enagle geo location tracking or the server URL in the run time https://github.com/mixpanel/mixpanel-android/pull/739
- Prevent the out of memory crash when adding events to the SQLiteDatabase https://github.com/mixpanel/mixpanel-android/pull/737
- Enable tracking null property value https://github.com/mixpanel/mixpanel-android/pull/736
- Fix string compare https://github.com/mixpanel/mixpanel-android/pull/735
Mar 25th - 2021
- Crash prevention on getScaledScreenshot when rootView is not measured yet https://github.com/mixpanel/mixpanel-android/pull/729
Mar 9th - 2021
-
Replace deprecated view drawing cache API https://github.com/mixpanel/mixpanel-android/pull/724
-
Change Android mixpanel default properties ($app_release, $app_build_number) from number to string https://github.com/mixpanel/mixpanel-android/pull/723
Jan 15th - 2021
-
Remove the legacy gesture tracker that causes crashes https://github.com/mixpanel/mixpanel-android/pull/721
-
Use SecureRandom instead of Random https://github.com/mixpanel/mixpanel-android/pull/697
Sept 24th - 2020
-
Fix crash MixpanelNotificationRouteActivity.handleRouteIntent https://github.com/mixpanel/mixpanel-android/pull/707
-
Fix the crash for android 5.x if the rich notifiction with a button https://github.com/mixpanel/mixpanel-android/pull/706
June 29th - 2020
- Fix
SecurityException
crash onInstallReferrerPlay
class. More info: https://github.com/mixpanel/mixpanel-android/issues/700
April 21st - 2020
- Remove unused intent filter from activity
- Fix routing activity bug that made a push action to be repeated when the app was open again
- Add option to disable automatic flushing when the app goes into the background. Add the following to you
<application>
tag on yourAndroidManifest.xml
if you don't want the SDK to automatically flush its queues when the app goes into the background:
<meta-data android:name="com.mixpanel.android.MPConfig.FlushOnBackground"
android:value="false" /
March 25th - 2020
- Added
$radio
property (iOS parity) as a super property. You'll need to request permission forREAD_PHONE_STATE
if you want to have access to that property. - Ensure web links are always open in a browser
- Fixed tracking
Message Received
under certain cases. - Added compatibility with installreferrer 1.0 (
IllegalArgumentException
was thrown - fixes https://github.com/mixpanel/mixpanel-android/issues/678)
March 10th - 2020
- Catch all exceptions when reading referrer details from Google Play to avoid potential crash
March 4th - 2020
- Referrer details are now fetched from Google Play since
INSTALL_REFERRER
message is no longer supported by Google. If you have the following lines, please remove them from yourAndroidManifest.xml
:
Remove:
<receiver
android:name="com.mixpanel.android.mpmetrics.InstallReferrerReceiver"
android:exported="true">
<intent-filter>
<action android:name="com.android.vending.INSTALL_REFERRER" />
</intent-filter>
</receiver>
You now need to use a new Google dependency to be able to track your referrer details. Update your build.gradle
file and add the following dependency:
Add:
dependencies {
implementation 'com.android.installreferrer:installreferrer:1.1'
...
}
As before, Mixpanel referrer track will inspect the referrer and not only set a new property referrer
but will also look for the following keys and set them as event properties separately (if available): utm_source
, utm_medium
, utm_term
, utm_content
and utm_campaign
.
-
ConcurrentModificationException
using super properties (https://github.com/mixpanel/mixpanel-android/issues/658) - Track session lengths as a numbers and not strings.
- In-app notification
NullPointerException
. - Capture exception when writing on SQLite and restore state.
- Do not allow
null
values asdistinct_id
.
February 13th - 2020
- Additional support for rich push notifications: you can now include images, buttons, and more
- You can now track when a push notification was dismissed. Replacing existing events (backwards compatible) and adding new ones:
$push_notification_received
,$push_notification_tap
,$push_notification_dismissed
for notifications sent from Mixpanel. - Add geolocation flag to people updates (https://github.com/mixpanel/mixpanel-android/pull/656)
- Always union an existing device token. Useful if the device token was removed previously but still valid.
November 27th - 2019
- Added back
MixpanelAPI.getInstance(this, MY_TOKEN, optOutStatusDefaultFlag)
- Check if the tweak name is null to avoid potential crash when declaring it.
November 22nd - 2019
- Crash when formatting timezones due to OEM bug https://github.com/mixpanel/mixpanel-android/issues/567
- Fix
ArrayOutOfBoundsException
due to OEM bug https://github.com/mixpanel/mixpanel-android/issues/241 - Use current loop handler when waiting for UA integration
- Better FCM initialization to avoid warnings and fix crash when using other FCM providers https://github.com/mixpanel/mixpanel-android/issues/608
- Added
$ae_total_app_sessions
and$ae_total_app_session_length
. Parity with iOS (thanks @Ivansap!) - Allow passing super properties when initializing the library. Addresses https://github.com/mixpanel/mixpanel-android/issues/597
May 29th - 2019
- Fix fading on takeover in-app notifications not being present for some Android devices
May 10th - 2019
- Avoid
OutOfMemoryError
when loading in-app notifications in low-end devices - Do not send
$carrier
property if empty. Parity with other SDKs - Preserve user opt-out status when initializing the SDK
March 21st - 2019
- Set, add, and remove groups the user belongs to.
- Track events with specific groups
- Support for group-level profiles—set, update, and remove properties on account/group objects in Mixpanel
March 14th - 2019
Currently users have no control over when an in-app notification shows up. With this release users can now control when an in-app gets displayed based on an event that they track within their app. This "trigger" event is defined during message creation at www.mixpanel.com.
You can additionally filter the event based on properties that are tracked along with the event for even finer controls.
March 7th - 2019
- Use
LruCache
fromandroid.util
and remove any dependencies with supportv4 library - Push token was not set-up correctly if a user was not identified
public class CustomMixpanelFirebaseMessaging extends MixpanelFCMMessagingService {
@Override
protected void onMessageReceived(Context context, Intent intent) {
if (intent.getExtras().containsKey("mp_message")) {
intent.putExtra("mp_message", "CUSTOM MESSAGE");
}
super.onMessageReceived(context, intent);
}
}
Google doesn't allow an app to have more than one handler for com.google.firebase.MESSAGING_EVENT
intent filter. Only the first registered service will handle a firebase message. If you need to use multiple push providers, you can now easily access Mixpanel FCM handler from your custom class. Register your custom FirebaseMessagingService service and:
public class PushProvidersHandler extends FirebaseMessagingService {
@Override
public void onNewToken(String s) {
super.onNewToken(s);
MixpanelFCMMessagingService.addToken(s);
}
@Override
public void onMessageReceived(RemoteMessage remoteMessage) {
super.onMessageReceived(remoteMessage);
if (remoteMessage.getData().containsKey("mp_message")) {
MixpanelFCMMessagingService.showPushNotification(getApplicationContext(), remoteMessage.toIntent());
}
}
}
February 20th - 2019
GCM has been officially removed from the SDK. The following information is useful for existing and new Mixpanel customers:
How to remove GCM from an existing app
- Open your
AndroidManifest.xml
file an remove the following permissions since they are included in FCM already:
<uses-permission android:name="com.google.android.c2dm.permission.RECEIVE" />
<uses-permission android:name="android.permission.GET_ACCOUNTS" />
<uses-permission android:name="android.permission.WAKE_LOCK" />
<permission android:name="YOUR_PACKAGE.permission.C2D_MESSAGE" android:protectionLevel="signature" />
<uses-permission android:name="YOUR_PACKAGE.permission.C2D_MESSAGE" />
- Remove the following tag from your
AndroidManifest.xml
file:
<receiver android:name="com.mixpanel.android.mpmetrics.GCMReceiver"
android:permission="com.google.android.c2dm.permission.SEND" >
<intent-filter>
<action android:name="com.google.android.c2dm.intent.RECEIVE" />
<action android:name="com.google.android.c2dm.intent.REGISTRATION" />
<category android:name="YOUR_PACKAGE" />
</intent-filter>
</receiver>
- Remove GCM from your gradle dependencies:
dependencies {
compile 'com.google.android.gms:play-services-gcm:10.0.1' // Remove this line
....
}
- Remove any reference to
People.initPushHandling(senderId)
since it's no longer used:
MixpanelAPI.getInstance(this).getPeople().initPushHandling(SENDER_ID); // Remove this line
How to add FCM to your app
- Add the following tag inside your
application
tag in yourAndroidManifest.xml
file:
<application>
...
<service
android:name="com.mixpanel.android.mpmetrics.MixpanelFCMMessagingService"
android:enabled="true"
android:exported="false">
<intent-filter>
<action android:name="com.google.firebase.MESSAGING_EVENT"/>
</intent-filter>
</service>
...
</application>
- Add FCM to your gradle dependencies. You should already have Google Services added, but double check that's the case:
buildscript {
...
dependencies {
classpath 'com.google.gms:google-services:4.1.0'
...
}
}
dependencies {
implementation 'com.google.firebase:firebase-messaging:17.3.4' // It must be higher than 16.2.0
...
}
apply plugin: 'com.google.gms.google-services'
-
Place your
google-services.json
file to your Android project. You can grab that file from your Firebase Console center. -
We suggest to update your GCM API Key on mixpanel.com and use your FCM Server Key instead. Notice that your existing GCM Key it's now called Legacy token and it is still supported.
-
Enjoy!
January 31st - 2019
- Pass flag to backend indicating when $distinct_id might have been set to a pre-existing $distinct_id value instead of a generated UUID (used when resolving aliases)
April 10th - 2018
- Prevent double tracking for some experiments
- Prevent tweaks declaration before they have been explicitly declared in code. Fixes https://github.com/mixpanel/mixpanel-android/issues/531
- Fix in-app notification crash https://github.com/mixpanel/mixpanel-android/issues/516
- Tweaks are cleared after calling
reset()
now. - Added logic to prevent dup events at ingestion time
- Apply all editor changes at once when connected to Mixpanel UI builder
- Increase data expiration max time value
February 20th - 2018 You can now change Mixpanel endpoints at runtime by using the following APIs:
MPConfig.getInstance(this).setEventsEndpoint("https://myapp.company.com/trackendpoint/");
MPConfig.getInstance(this).setPeopleEndpoint("https://myapp.company.com/peopleendpoint/");
MPConfig.getInstance(this).setDecideEndpoint("https://myapp.company.com/decidepoint/");
If you wish to restore Mixpanel values you can use the following APIs:
MPConfig.getInstance(this).setMixpanelEventsEndpoint();
MPConfig.getInstance(this).setMixpanelPeopleEndpoint();
MPConfig.getInstance(this).setMixpanelDecideEndpoint();
January 23rd - 2018
- Fixes
IllegalStateException
when removing a mini in-app notification (https://github.com/mixpanel/mixpanel-android/issues/516)
January 04th - 2018
- Remove unused code
- Fix https://github.com/mixpanel/mixpanel-android/issues/505
December 11th - 2017
- Added support for Urban Airship integration. Learn more here: https://mixpanel.com/platform
- Fix
NullPointerException
onPair.hashCode()
: https://github.com/mixpanel/mixpanel-android/issues/507 and https://github.com/mixpanel/mixpanel-android/issues/515
October 9th - 2017
- When running an experiment with multiple tweaks, only one was applied.
- We now persist variants as soon as the SDK receives them. In our previous release we relied on the call of
joinExperimentsIfAvailable()
method. - We now apply persisted tweaks even if they are not declared yet.
September 23rd - 2017
- We now persist Tweaks and AB test experiments!
- Android Oreo support. If you want to customize your notifications channel for devices running 26 or above you can use the following new keys:
<meta-data android:name="com.mixpanel.android.MPConfig.NotificationChannelId"
android:value="mixpanel_id" />
<meta-data android:name="com.mixpanel.android.MPConfig.NotificationChannelName"
android:value="mixpanel" />
<meta-data android:name="com.mixpanel.android.MPConfig.NotificationChannelImportance"
android:value="4" /> <!-- IMPORTANCE_HIGH -->
- Add option to specify whether or not Mixpanel will determine geolocation information using the client IP (see
ip=1
in https://mixpanel.com/help/reference/http for more information). Example of use:
<meta-data android:name="com.mixpanel.android.MPConfig.UseIpAddressForGeolocation"
android:value="false" />
- You can now specify maximum and minimum values for your tweaks with
longTweak
intTweak
doubleTweak
andfloatTweak
.
- Fix
SecurityException
crash on some Samsung devices running 7.0 due to missingBLUETOOTH
permission (fixes https://github.com/mixpanel/mixpanel-android/issues/424) - Call
onMixpanelTweakUpdated
only after tweaks are updated (fixes https://github.com/mixpanel/mixpanel-android/issues/472) - Fix random crash on emulators (https://github.com/mixpanel/mixpanel-android/issues/417)
- Fix crash using mini in-app notifications when trying to remove a notification while the activity was being destroyed (fixes https://github.com/mixpanel/mixpanel-android/issues/400)
- Fix crash if we tried to show an in-app before
people.identify()
is called (fixes https://github.com/mixpanel/mixpanel-android/issues/449) - Fix
BadParceableException
for activities with unparceable intents (fixes https://github.com/mixpanel/mixpanel-android/issues/251) - Specify locale to calculate session length so session lengths are always in seconds.
- Various AB tests and Codeless events improvements (see PR for more details https://github.com/mixpanel/mixpanel-android/pull/492)
- Remove fallback urls support. The following meta-tags won't have any effect:
com.mixpanel.android.MPConfig.DisableFallback
com.mixpanel.android.MPConfig.EventsFallbackEndpoint
com.mixpanel.android.MPConfig.DecideFallbackEndpoint
com.mixpanel.android.MPConfig.PeopleFallbackEndpoint
- Change thread priority from
THREAD_PRIORITY_LESS_FAVORABLE
toTHREAD_PRIORITY_BACKGROUND
- Track whether the user tapped on the primary or secondary button in an in-app notification. We also now track
$campaign_open
even if there is no cta url - Cast
campaign_id
andmessage_id
to integers
June 23rd - 2017
- Prevent in-app notifications from showing more than once (https://github.com/mixpanel/mixpanel-android/pull/469)
June 19th - 2017
- We added support for tracking Mixpanel smart notifications (https://github.com/mixpanel/mixpanel-android/pull/467)
June 6th - 2017
- Fix memory leak https://github.com/mixpanel/mixpanel-android/issues/463
- Add
eventElapsedTime()
API to retrieve the time elapsed for the named event sincetimeEvent()
was called.
May 26th - 2017
Fixes #464
May 22nd - 2017
With this release we are adding automatic tracking of common mobile events. These events include tracking app sessions, first app opens, app updated, and app crashed.
The feature will be rolled out slowly to all our users, and can be turned on in Project settings under Autotrack.
To configure the tracking of app sessions, we now expose two new configurations to provide lower and upper bounds on the session lengths that your app will track. For example, to only track app sessions with a minimum duration of 3 seconds and maximum duration of 5 minutes:
<meta-data android:name="com.mixpanel.android.MPConfig.MinimumSessionDuration"
android:value="3000" />
<meta-data android:name="com.mixpanel.android.MPConfig.SessionTimeoutDuration"
android:value="300000" />
April 24th - 2017
- Fix crash when takeover activity is not defined in the AndroidManifest.xml https://github.com/mixpanel/mixpanel-android/pull/451
April 14th - 2017
Fixes:
- Fix ConcurrentModificationException in Tweaks https://github.com/mixpanel/mixpanel-android/issues/414
- Fix ConcurrentModificationException on
OnMixpanelUpdatesReceivedListener
https://github.com/mixpanel/mixpanel-android/issues/395 - Update log output to be consistent with property names
-
getActiveNetworkInfo
proper handling: it could returnnull
. Fix https://github.com/mixpanel/mixpanel-android/pull/445
New features:
- Thanks to https://github.com/mixpanel/mixpanel-android/pull/283 you can now specify your notifications behavior (sound, vibration, etc..) by using a meta-tag:
<meta-data
android:name="com.mixpanel.android.MPConfig.NotificationDefaults"
android:value="1"/>
You can use any of the following values: https://developer.android.com/reference/android/app/Notification.html#DEFAULT_ALL
April 3rd - 2017
We have fully removed surveys after three months of being deprecated.
March 8th - 2017
Remove BLUETOOTH
permission and make it optional again.
March 1st - 2017
Fix crash for API below 21 (#434)
February 24th - 2017
Fix NoSuchMethodError
for API below 23 when showing a mini in-app notification (#431)
February 20th - 2017
We now can track open push notifications (for API 14 and above). Events that will be automatically sent (like iOS):
-
$app_open
will be tracked if the user taps on the push notification. campaign_id and message_id are sent as well as message_type=push. -
$campaign_received
will be tracked if the app receives a push while the app is running in the foreground. Same properties as before are sent.
February 14th - 2017
In addition to the standard dark or light message templates, you can now customize the format of your in-app messages to ensure they are on-brand:
- Customize text, background, and button colors
- Remove image fades
- Select large or standard image footprints by hiding text
- Add a secondary call-to-action button for multiple deep-linking paths
Improvements:
- Custom logger. Use
MPLog
and customize your minimum log level.
December 21st - 2016
- Crash fixes:
-
ConcurrentModificationException
when usingaddOnMixpanelUpdatesReceivedListener
. -
ConcurrentModificationException
when usingTweaks.getDefaultValues()
-
NullPointerException
when destroying a survey.
-
- Improvements:
- No network attempts to visual editor if it's not connected (this will remove all the error logs you guys are seeing in debug mode).
- New meta-tag flag:
com.mixpanel.android.MPConfig.IgnoreInvisibleViewsVisualEditor
. Set this boolean to true if you don't want invisible views to be sent to our visual editors (AB Test or Codeless).
September 2nd - 2016
-
Crash fixes:
-
NoClassDefFoundError
on some Samsung devices when usingBluetoothAdapter
-
-
Bug Fixes:
- Tweak-related bugs with some of our improvements (below).
-
Improvements:
-
New API:
getPushRegistrationId
to retrieve the device push token through a mixpanel instance. -
Add proguard rules.
-
Ability to remove a single push token through
clearPushRegistrationId(token)
. -
Ability to remove a people property through
remove(name, value)
-
Ability to disable the
ViewCrawler
(AB Test/Codeless) for specific project tokens (handy if you have multiple mixpanel instances). To use this feature:<meta-data android:name="com.mixpanel.android.MPConfig.DisableViewCrawlerForProjects" android:resource="@array/my_project_list" />
And define the following on your
array.xml
:<resources> <string-array name="my_project_list"> <item>project token 1</item> <item>project token 2</item> </string-array> </resources>
-
Ability to add listeners to know when tweaks are updated:
MixpanelAPI.getInstance(context, API_TOKEN). addOnMixpanelTweakUpdatedListener(<your listener>)
- Push notification enhancements: From mixpanel.com you can now use the following keys as part of a push notification payload:
mp_icnm_l
Large icon to be used on a push notification.mp_icnm_w
White icon to be used on Lollipop and above.mp_color
Color to be used on Lollipop and above (#argb). Example of a payload:{"mp_icnm":"an_icon", "mp_icnm_l":"big_icon", "mp_icnm_w":"white_icon","mp_color":"#FFAA0000"}
- Time events are persisted across user sessions.
- Upgrade GCM and avoid using deprecated GCM APIs. Your Google Play Services library must be 7.5.0 or above
-
July 1st - 2016
- Crash fixes:
- Activity life cycle callbacks in old Android APIs.
-
OutOfMemoryError
for in-app and ab test. -
NullPointerException
when accessing people profiles after resetting a Mixpanel instance.
- Bug Fixes:
- Resize survey texts to fit any screen.
- AB Test working in emulators running new Android APIs.
- Proper data resetting after calling
reset()
.
- Improvements:
- Hide next/previous arrows on surveys when there are no next/previous questions.
- Added an LRU Cache to re-use & quickly access images.
May 11st - 2016
- Bug fixes:
- Get real available memory to avoid displaying small images when there's enough space.
- In-app notifications: improved layout for certain devices (no overlap with text and correct image alignment).
April 22nd - 2016
- New features:
- New in-app notification styles: dark & light!
- Added
OfflineMode
- Bug fixes:
- Clear pre-filled answers on surveys
- Exit A/B test experiments when they are turned off
March 25th - 2016
- New features:
- Surveys are now translated to spanish.
- Automatically flush events when the app goes to the background. Available for Android API 14 and above.
- Flush all events in the queue regardless of its size.
- New HTTP test cases
- Crash fixes:
- NPE if the context is a
BridgeContext
. - Handle all exceptions on
HttpService
to avoid crash. - Strict Mode: Leak when registering a sensor listener.
-
Survey
parceable: wrongCREATOR
object.
- NPE if the context is a
- Bug fixes:
- Remove
GET_ACCOUNTS
permission. - Remove unused play services. Only
gcm
andbase
are needed.
- Remove
February 9th - 2016
- New features:
- Let user disable any
decide
API (i.e. no surveys, no notifications and no AB testing) by configuring the meta-data. Example:
<meta-data android:name="com.mixpanel.android.MPConfig.DisableDecideChecker" android:value="true" />
- Let user disable any the
ViewCrawler
by configuring the meta-data. Example:
- Let user disable any
* Removed debug flush interval. If you are setting `com.mixpanel.android.MPConfig.DebugFlushInterval` on your `AndroidManifest.xml` you should remove it since it won't have any effect.
* Implemented a back-off mechanism when server is busy to avoid repeated and consecutive requests.
* Crash fixes:
* Add tracking to match iOS SDK: survey received, survey shown and correct app build number/app version.
* Wrong `ViewGroup` casting.
* Displaying notifications when backgrounding the app.
* Out of memory when displaying big images in notifications.
* Bug fixes:
* Memory leak when using `SensorManager`.
* Clear user-related notifications/surveys/ab testing after setting a new `disctinctId`.
* Remove `tools:ignore` properties (`AllowsBackUp` and `GradleOverrides`).
* No AB test tracking for original variant under certain circumstances.
* RTL layouts were wrongly rendered.
* Repeated notifications/surveys when using ad blocker apps.
#### [v4.7.0](https://github.com/mixpanel/mixpanel-android/releases/tag/v4.7.0)
* Add the support for API 23
* Enhance the inapp notification rendering
#### [v4.6.4](https://github.com/mixpanel/mixpanel-android/releases/tag/v4.6.4)
* Add a feature where the images of in-app notifications will be
* cached locally after the first successful download
#### [v4.6.3](https://github.com/mixpanel/mixpanel-android/releases/tag/v4.6.3)
* Fix a bug where the user defined listener (by calling
mMixpanel.getPeople().addOnMixpanelUpdatesReceivedListener())
is not called on new variants receiving
#### [v4.6.1](https://github.com/mixpanel/mixpanel-android/releases/tag/v4.6.1)
* The Mixpanel library no longer uses the default SSLSocketFactory
from the system schema registry, instead preferring the system
defaults. Most users will not need to make any changes to their
integrations. To change the SSL settings that the Mixpanel library
uses, call MPConfig.getInstance(context).setSSLSocketFactory(socketFactory)
#### [v4.6](https://github.com/mixpanel/mixpanel-android/releases/tag/v4.6.0)
* Mixpanel A/B testing is now supported on Android. Users can
register and recieve A/B testing tweaks and alter application look
and feel using the Mixpanel A/B testing tool.
* Addition of
trackMap(String, Map<String, Object>)
registerSuperPropertiesMap(String, Map<String, Object>)
registerSuperPropertiesOnceMap(String, Map<String, Object>)
setMap(Map<String, Object>)
setOnceMap(Map<String, Object)
which allow updates to properties and user profiles without
requiring the construction of a JSONObject.
* updateSuperProperties() which allows users to update super
properties in place, in a thread-safe manner.
* addition of merge() to the People API
* Many Mixpanel logtags have changed to conform to the expectation
that all logtags should be under 23 characters long.
* Added a new configuration for flush interval when the app is in debug mode, defaults to 1 second
#### [v4.5.3](https://github.com/mixpanel/mixpanel-android/releases/tag/v4.5.3)
* Disable $app_open event by default. Users can opt-in to sending automatic $app_open events by adding
#### [v4.5.2](https://github.com/mixpanel/mixpanel-android/releases/tag/v4.5.2)
* Low level features to allow for more advanced push notifications
* Bugfix, honor DisableFallback setting in checks for surveys and in-app notifications
#### [v4.5.1](https://github.com/mixpanel/mixpanel-android/releases/tag/v4.5.1)
* Update pom to allow users of gradle and maven to use the library without specifying packaging aar packaging.
* Fix issue that prevented building from source in Eclipse
#### [v4.5](https://github.com/mixpanel/mixpanel-android/releases/tag/v4.5.0)
* Introducing dynamic event binding! Developers and stakeholders can now bind Mixpanel events to
user interactions using the UI in the Mixpanel web application.
* added timeEvent, for automatically adding duration to events with a begin and end.
* New configuration directives
The 4.5 version of the library allows for meta-data of the form
This tag will only be useful in specific circumstances, for users with certain kinds of exotic custom builds.
Most users of the library will not require it.
(You'll get messages in your logs if the library thinks that you need it)
When included in your Manifest with value="true", this tag disables the use of the connection
gesture to the mobile event binding UI in the Mixpanel web application. Events created and bound in the UI
will still be sent by the application, this directive just disables use the connection gesture
to pair with a Mixpanel to create and edit event bindings. If the application is run in an
emulator, it will still check for pairing with the editor.
When included in your Manifest with value="true", this tag disables pairing with the mobile
event binding UI in the Mixpanel web application. Events created and bound in the UI will
still be sent by the application, this directive just disables the emulator binding behavior. Use of
the connection gesture on a physical device will still work for pairing with the editor.
* Easier use of Proguard with the library
To use the Mixpanel library with Proguarded builds, add the following to your proguard.cfg file
-keep class com.mixpanel.android.abtesting.** { ; } -keep class com.mixpanel.android.mpmetrics.* { ; } -keep class com.mixpanel.android.surveys.* { ; } -keep class com.mixpanel.android.util.* { ; } -keep class com.mixpanel.android.java_websocket.* { *; }
-keepattributes InnerClasses
-keep class **.R -keep class *.R$ { ; }
Mixpanel uses the R class of your package to facilitate easier dynamic tracking across builds of your application.
* The deprecated methods setFlushInterval and checkForSurvey are now no-ops
This method was deprecated in version 4.0, and now is a no-op. To change the flush
interval for your application, use the com.mixpanel.android.MPConfig.FlushInterval
meta-data tag in your manifest. To get available surveys, call getSurveyIfAvailable()
* The minimum Android OS version necessary for surveys, in-app notifications, and dynamic event binding
has been increased to JellyBean/API 16. The minimum OS version to use basic tracking features
has been increased to Gingerbread/API 9.
#### [v4.4.1](https://github.com/mixpanel/mixpanel-android/releases/tag/v4.4.1)
* Improved support for Push notifications in Android Lollipop/API
21. Users sending push notifications to Lollipop devices should
include some version of Google Play Services in their build. In
include Google Play Services, add the following to your
build.gradle file:
compile "com.google.android.gms:play-services:3.1+" // Any version above 3.1 will work
#### [v4.3.1](https://github.com/mixpanel/mixpanel-android/releases/tag/v4.3.1)
* This is a bugfix release only, to alter the handling of Surveys and In-App notifications when
activities are removed or move to the background.
#### [v4.3.0](https://github.com/mixpanel/mixpanel-android/releases/tag/v4.3.0)
* Added support for App Links tracking
* Added a way to get super properties
#### [v4.2.2](https://github.com/mixpanel/mixpanel-android/releases/tag/v4.2.2)
* Removed lint warnings from build
* Fixed issue that could cause NullPointerExceptions to be thrown from the library
if a user was identified as null
* Handle attempts to load In-app notifications in low memory conditions
#### v4.2.1
* Fixed a bug that would cause events to be dropped when the device thinks it has a valid network
connection, but cannot actually send data over it.
#### [v4.2.0](https://github.com/mixpanel/mixpanel-android/releases/tag/v4.2.0)
* `showSurveyById` and `showNotificationById` have been added for precise control over which
survey or notification should be displayed.
* Added several default properties for Mixpanel People profiles. Each call to `set()` will now
automatically include the application version name, Android version, and manufacturer, make, and
model of the phone.
#### [v4.1.0](https://github.com/mixpanel/mixpanel-android/releases/tag/v4.1.0)
This version adds support for Android in-app notifications.
* There is now an additional theme parameter on the SurveyActivity declaration in AndroidManifest.xml
that is used for full screen in-app notifications.
* A new unified set of functions have been created to make it easier to fetch and display surveys
and in-app notifications.
* `getSurveyIfAvailable()` and `getNotificationIfAvailable()` have been added to fetch Survey and
InAppNotification objects when the library has successfully received them. You may use these objects
to display your own custom surveys or in-app notifications.
* `showSurveyIfAvailable()` and `showNotificationIfAvailable()` have been added to display surveys and
notifications when the library has successfully received them.
* `addOnMixpanelUpdatesReceivedListener()` and `removeOnMixpanelUpdatesReceivedListener()` have been added
so you may be notified when the library has successfully received a survey or in-app notification in the
background.
* `showSurvey()` and `checkForSurvey()` functions have been deprecated.
* `com.mixpanel.android.MPConfig.AutoCheckForSurveys` has been deprecated. The option has been renamed
to `com.mixpanel.android.MPConfig.AutoShowMixpanelUpdates`. It is also now used for both surveys and in-app
notifications.
* `com.mixpanel.android.MPConfig.TestMode` has been added. This option, when set to true, will render
your in-app notifications and surveys but not track that they have been displayed. If you have multiple
notifications/surveys, calls the respective show/get methods will simply rotate through them.
* `MixpanelAPI.logPosts()` has been deprecated. Set the `com.mixpanel.android.MPConfig.EnableDebugLogging`
flag to true to now get extensive debugging output.
* The minimum Android version necessary for surveys and in-app notifications has been increased to 14,
Ice Cream Sandwich to improve stability.
* `MixpanelAPI.alias()` has been added.
* The default library manifest no longer merges in recommended tags by default, as this was breaking
builds for some users. You'll need to follow the steps in https://mixpanel.com/help/reference/android
to configure your manifest for automatic referrer tracking, push notifications, in-app messages,
and surveys. The recommended `<application>` tag in your app is
<!-- This receiver will allow your application to register for
and receive Mixpanel push notifications.
Make sure to change YOUR_PACKAGE_NAME to your own applications package. -->
<receiver android:name="com.mixpanel.android.mpmetrics.GCMReceiver"
android:permission="com.google.android.c2dm.permission.SEND" >
<intent-filter>
<action android:name="com.google.android.c2dm.intent.RECEIVE" />
<action android:name="com.google.android.c2dm.intent.REGISTRATION" />
<category android:name="YOUR_PACKAGE_NAME" />
</intent-filter>
</receiver>
<!-- This receiver will allow your application to record referrer
parameters as super properties automatically -->
<receiver android:name="com.mixpanel.android.mpmetrics.InstallReferrerReceiver" android:exported="true">
<intent-filter>
<action android:name="com.android.vending.INSTALL_REFERRER" />
</intent-filter>
</receiver>
- Default event storage is now 5 days.
This is a major release, with significant changes to library behavior.
-
Changes to the steps required to integrate the Mixpanel library in your project.
In previous releases, the Mixpanel library was distributed as a jar file. As of 4.0.0, use of the library varies with the build tools chosen.
For building with Eclipse or ant, download the Mixpanel repository and follow the steps outlined here, for "Referencing a Library Project": http://developer.android.com/tools/projects/projects-eclipse.html#ReferencingLibraryProject
For building with Gradle or Android Studio- add the following dependency to your build.gradle file
dependencies { compile "com.mixpanel.android:mixpanel-android:4.0.0@aar" }
A version of each release is hosted in Maven central, and will not require you to manually download or install any artifacts.
-
Support for
getPeople().union()
,getPeople().setOnce()
, andgetPeople().unset()
has been added. -
Fallback to HTTP from HTTPS is disabled by default
In previous releases, the Mixpanel library would automatically fall back to communicating over HTTP if HTTPS communication failed. This was to facilitate use on Android 2.2 (Froyo) and older OS versions, which had poor support for modern SSL certificates.
In the 4.0.0, HTTP fallback behavior is disabled by default, but can be reenabled for users who intend to ship to older devices by adding the following tags to the
<application>
tag in the Application's AndroidManifest.xml:<meta-data android:name="com.mixpanel.android.MPConfig.DisableFallback" android:value="false" />
-
Support for Mixpanel surveys. Support takes the form of two new API calls and some new default automatic behavior
-
MixpanelAPI.getPeople().checkForSurveys()
will query Mixpanel for surveys targeted to the current user, and pass a Survey object to a callback when a survey is found, or null if no Survey could be found -
MixpanelAPI.getPeople().showSurvey()
will launch a new Activity that shows the given survey to the user, and send the results of the survey to Mixpanel -
Unless configured with
com.mixpanel.android.MPConfig.AutoCheckForSurveys
metadata, applications using the Mixpanel library will automatically query for and show an available survey on application startup.
-
-
Passing a null token or null context to
MixpanelAPI.getInstance()
will result in a null return value. -
Automatic
$bluetooth_enabled
property will only be added automatically on devices with OS version greater than API 18/OS version 4.3/Jelly Bean MR2. This feature had a critical bug on older platforms, and was not in popular use. -
Users can now configure
MixpanelAPI
behavior by including<meta-data>
tags in the<application>
tag of their apps. The following meta-data keys are supported:-
com.mixpanel.android.MPConfig.FlushInterval
(value: a time in milliseconds)If provided, the library will use this interval instead of the default as a target maximum duration between attempts to flush data to Mixpanel's servers.
-
com.mixpanel.android.MPConfig.DisableFallback
(value: a boolean)If provided and equal to "false", the library will attempt to send data over HTTP if HTTPS fails
-
com.mixpanel.android.MPConfig.AutoCheckForSurveys
(value: a boolean)If provided and equal to "false", the Mixpanel library will not attempt to retrieve and show surveys automatically, users can still show surveys using
MixpanelAPI.getPeople().checkForSurvey()
andMixpanelAPI.getPeople().showSurvey()
-
-
Automatic referrer tracking from the Google Play Store
Adding the following to the main
<application>
tag in your AndroidManfest.xml will automatically set super properties associated with the referrer to your Google Play Store listing:<receiver android:name="com.mixpanel.android.mpmetrics.InstallReferrerReceiver" android:exported="true"> <intent-filter> <action android:name="com.android.vending.INSTALL_REFERRER" /> </intent-filter> </receiver>
-
Previous version of the library allowed setting "distinct_id" as a superProperty, and would use this value as the distinct id for event tracking. This behavior has been removed, and super properties with the name "distinct_id" will be ignored. Callers can still provide their own value for "distinct_id" in the properties argument to track.
-
A scary stack trace log in the common, not-scary case of fallback from HTTPS to HTTP has been removed.
-
MixpanelAPI.setFlushInterval()
has been deprecated. Use<meta-data android:name="com.mixpanel.android.MPConfig.FlushInterval" android:value="XXX" />
instead, where "XXX" is the desired interval in milliseconds. -
MixpanelAPI.enableFallbackServer()
has been deprecated. Use<meta-data android:name="com.mixpanel.android.MPConfig.DisableFallback" android:value="true" />
to disable fallback to HTTP if HTTPS is unavailable.
- Internal changes to improve startup performance.
-
Calls to
increment()
now accept more general types (doubles instead of longs) existing calls should work without changes, types are strictly more general. -
Payloads of
increment()
are treated as doubles rather than longs in the internal library
-
The library now falls back to HTTP communication if HTTPS communication is unavailable. In particular, this may occur in early versions of Android that only support a small set of certificate authorities. To disable this behavior, call
MixpanelAPI.enableFallbackServer(yourMainActivity, false);
-
More robust handling of internal threads and work queues.
The Mixpanel library now owns one, continuous thread for handling messages (rather than spawning a thread on demand.)
-
Improvements to internal library error handling.
- Bugfix and test for providing metadata with revenue analytics messages
-
Support for Mixpanel Revenue analytics
The Mixpanel library now supports revenue analytics. To track income, call
Mixpanel.getPeople().trackCharge(amount, properties)
where amount is a double representing the amount of the charge, and properties is a possibly null collection of properties associated with the charge.
-
Major change to configuration necessary for push notifications
In version 3.0, you will need to add the following receiver to the tag in your AndroidManifest.xml file to receive push notifications using initPushNotification.
<receiver android:name="com.mixpanel.android.mpmetrics.GCMReceiver" android:permission="com.google.android.c2dm.permission.SEND" > <intent-filter> <action android:name="com.google.android.c2dm.intent.RECEIVE" /> <action android:name="com.google.android.c2dm.intent.REGISTRATION" /> <category android:name="YOUR_PACKAGE_NAME" /> </intent-filter> </receiver>
Be sure to replace "YOUR_PACKAGE_NAME" above with the package name of your project (The value of the "package" attribute in your tag.)
-
Backward incompatible change: Major change to the handling of automatically assigned distinct ids
In version 3.0, library-assigned distinct ids are randomly generated and stored as needed. If you are upgrading from an older version that used the automatically generated distinct id, and you want to maintain the same distinct id across upgrades, you can generate it with the following code:
String androidId = Settings.Secure.getString(mContext.getContentResolver(), Settings.Secure.ANDROID_ID); String oldStyleId = Build.PRODUCT + '_' + androidId; mMixpanel.identify(oldStyleId);
-
Stop using version in artifact name
New versions of the Mixpanel library are named "MixpanelAPI.jar", rather than "MixpanelAPI_vXXX.jar".
- Use SSL api endpoint by default
- Fix to of initPushHandling
-
Changes to handling of catastrophic database failures (for example, full disks)
The Mixpanel library will now truncate its database in the face of full disks or corrupted databases.
-
Changes to default properties sent with every event
"Built-in" properties and names have changed for richer and more accurate names, and to conform with future versions of the iOS library.
-
Experimental Feature: Allow users to set default timing for sending server messages
Users can use MixpanelAPI.setFlushInterval to increase or decrease the default frequency of server messages.
-
More robust tests
-
Changes to error handling
Mixpanel will no longer retry sending messages when it encounters out of memory errors during send.
-
Support for Mixpanel push notifications
The Mixpanel library now handles registering for and receiving Google Cloud Messaging notifications sent from the Mixpanel interface. See https://mixpanel.com/docs/people-analytics/android-push for instructions on getting started using Mixpanel to engage directly with users of your application.
-
ant-based build system for core libraries
To build the core library, type 'ANDROID_HOME=/path/to/android/sdk ant library' at your command line.
-
API brought closer to Mixpanel Javascript and iPhone APIs
Main class now named "MixpanelAPI", as in iPhone library
Methods renamed to align with iPhone API method names
People Analytics features are now accessed via the MixpanelAPI.People class, accessed via MixpanelAPI.getPeople()
People.identify is now independent of MixpanelAPI.identify
User identity and super properties now persist across application shutdown
-
More explicit threading model
Eliminated dependency on external Looper for timing of messages sent to Mixpanel
-
Extensive documentation
Public APIs are now more thoroughly documented
-
Unit Tests provided as part of core code
Unit tests are an Eclipse project under test/, are run against the demo application
- Added support for Mixpanel People
- Added MPConfig object for easier configurability
- MPMetrics.VERSION now available
- Improved debugging information available
- Event queuing submission model revamped
Due to an unexplained increase in Sqlite insertion times on ICS, we now use a background thread to queue up events being sent.
- Add country geolocation by default. Now all events tracked will have the property 'Country.'
- Convert MPMetrics into a singleton, fixing a rare race caused by multiple instances.
- Reduce the number of flushes being called when events are backed up.
- Correctly check status of API call result
- Better support for using multiple tokens within a single Android application
-
Removed the funnel() methods. Funnels have been built from events for some time now, and this update to Android simply reflects that change we have made. The proper way to perform funnel analysis is to create a funnel based on events that you are sending. For more information, please see http://mixpanel.com/api/docs/guides/funnel-analysis
-
Renamed the event method to track, to be more consistent with the existing APIs. Furthermore, the propeties object passed to the new track method is no longer a HashMap, but a JSONObject. This will cause types to be correctly preseved in Segmentation.