GBAnalytics 4.4.1

GBAnalytics 4.4.1

TestsTested
LangLanguage Obj-CObjective C
License Apache 2
ReleasedLast Release Oct 2016

Maintained by Luka Mirosevic.


Downloads

Total23,245
Week0
Month0

Installs

Apps40
Test Targets4
powered by Segment

GitHub

Stars21
Watchers1
Forks3
Issues0
Contributors3
Pull Requests0

Code

Files29
LOCLines of Code 995


  • By
  • Luka Mirosevic

GBAnalytics  

Abstracts away different analytics networks and provides a unified simple interface.

Supported networks

  • Mixpanel
  • Localytics
  • Amplitude
  • Parse
  • Google Analytics
  • Crashlytics
  • Answers
  • Facebook
  • Tapstream
  • Flurry
  • Firebase
  • Intercom

Usage

Add the library to your Podfile and specify the networks that you want to use. Let's say we want to use Crashlytics, Mixpanel and Localytics:

pod 'GBAnalytics', subspecs: ['Crashlytics', 'Mixpanel', 'Localytics']

Then in your project import the header (it's probably a good idea to put this in the precompiled header so that it's accessible application wide):

#import <GBAnaytics/GBAnalytics.h>

Connect to any number of networks you want in application:didFinishLaunching:withOptions:. This will automatically enable all their default stuff like session tracking, retention, etc. You can choose however few or many you need.

// Mixpanel
[GBAnalytics connectNetwork:GBAnalyticsNetworkMixpanel withCredentials:@"MixpanelToken"];

// Parse
[GBAnalytics connectNetwork:GBAnalyticsNetworkParse withCredentials:@"ParseApplicationID", @"ParseClientKey"];

// Localytics
[GBAnalytics connectNetwork:GBAnalyticsNetworkLocalytics withCredentials:@"LocalyticsAppKey"];

// Amplitude
[GBAnalytics connectNetwork:GBAnalyticsNetworkAmplitude withCredentials:@"AmplitudeAPIKey"];

// Crashlytics
[GBAnalytics connectNetwork:GBAnalyticsNetworkCrashlytics withCredentials:@"FabricAPIKey"];

// Answers
[GBAnalytics connectNetwork:GBAnalyticsNetworkAnswers withCredentials:@"FabricAPIKey"];

// Tapstream
[GBAnalytics connectNetwork:GBAnalyticsNetworkTapstream withCredentials:@"TapstreamAccountName", @"TapstreamSDKSecret"];

// Google Analytics
[GBAnalytics connectNetwork:GBAnalyticsNetworkGoogleAnalytics withCredentials:@"GoogleAnalyticsTrackingID"];

// Facebook
[GBAnalytics connectNetwork:GBAnalyticsNetworkFacebook withCredentials:@"FacebookAppID"];

// Flurry
[GBAnalytics connectNetwork:GBAnalyticsNetworkFlurry withCredentials:@"FlurryAPIKey"];

// Firebase
[GBAnalytics connectNetwork:GBAnalyticsNetworkFlurry withCredentials:@"PlistName"]; // e.g. @"GoogleService-Info"

// Intercom
[GBAnalytics connectNetwork:GBAnalyticsNetworkIntercom withCredentials:@"APIKey", @"AppID"];

Track simple event:

[GBAnalytics trackEvent:@"Pressed play button"];

Track event with parameters:

[GBAnalytics trackEvent:@"Purchased in-app" withParameters:@{@"item": @"red sword"}];

That's it, you can now use all of your favourite analytics dashboards with just one simple API.

You can still use all of the more advanced features that the individual analytics networks support by accessign them directly, GBAnalytics just helps you unify their setup and event tracking interfaces--the parts which would otherwise litter your code the most.

By default, GBAnalytics will not send any events for builds in the Debug configuration (unless you've modified your schemes, then this applies to all builds in the Simulator) to prevent littering your analytics dashboards with test data. If you DO want to send data when running on the Simulator, for example for testing integrations, then make sure you enable it:

GBAnalytics.force = YES;

Advanced usage

What happens if you want to send some events to Mixpanel, and some other events to Flurry? Real world example: you want to send absolutely everything to Flurry and GA because they're free, but you only want to send the important stuff to Mixpanel because each event there costs you $$$. In this case you associate certain networks with a "route" and events posted on that route will be sent only to those networks:

// I'm creating a "common" route for the myriad of events which are interesting, but not interesting enough to pay Mixpanel for
[GBAnalytics[@"common"] routeToNetworks:GBAnalyticsNetworkFlurry, GBAnalyticsNetworkGoogleAnalytics, nil];

// And I'm creating a second route called "important" for the rare high-value stuff where I want to say use Mixpanel's people analytics (for instance)
[GBAnalytics[@"important"] routeToNetworks:GBAnalyticsNetworkMixpanel, nil];

Then you just send your events on the corresponding route:

// not so important event which happens all the time and I only want sent to Flurry and GA
[GBAnalytics[@"common"] trackEvent:@"Pressed play button"];

// very important event which I want sent to Mixpanel
[GBAnalytics[@"important"] trackEvent:@"Upgraded to pro version" withParameters:@{@"source": @"blue nag screen"}];

You might be wondering how come at first we didn't specify any route for our events... When you don't explictly specify a route (i.e. you use [GBAnalytics trackEvent:@"My Event"] instead of [GBAnalytics[@"myRoute"] trackEvent:@"My Event"]) you're just using a shorthand convenience for the default route (which happens to be defined as kGBAnalyticsDefaultEventRoute). The same applies to the [GBAnalytics routeToNetworks:] method. This is just syntactic sugar, the calls are identical.

Routes give you the convenience of being able to configure event destinations once in a centralised place, while still giving you the power to send each event to exactly the network(s) you want.

If you want to override which network the default route sends to, you can do so as well:

// The following two are equivalent:
[GBAnalytics routeToNetworks:GBAnalyticsNetworkFlurry, GBAnalyticsNetworkGoogleAnalytics, nil];
[GBAnalytics[@"kGBAnalyticsDefaultEventRoute"] routeToNetworks:GBAnalyticsNetworkFlurry, GBAnalyticsNetworkGoogleAnalytics, nil];

By default, the default route (kGBAnalyticsDefaultEventRoute) will send events to all connected networks, so if you just want to keep things simple and not worry about routes and send all events to all connected networks, you can ignore this API. If you do want to use custom routes (i.e. route != kGBAnalyticsDefaultEventRoute), the default behaviour is to not send any events until the networks to route to are explicitly specified using routeToNetworks:, in other words if you want to use [GBAnalytics[@"someCustomRoute"] trackEvent:@"Beat the final level"], then make sure you call [GBAnalytics[@"someCustomRoute"] routeToNetworks:...] first or the events won't be sent anywhere.

There are also some settings you can configure for different networks, which you can set before you connect to the networks. Check the GBAnalyticsNetworks.h and GBAnalyticsSettings.h headers for the full list. To configure some settings for Mixpanel, you would do the following:

GBAnalytics.settings.Mixpanel.flushInterval = 5.0;
GBAnalytics.settings.Mixpanel.shouldShowNetworkActivityIndicator = NO;
[GBAnalytics connectNetwork:GBAnalyticsNetworkMixpanel withCredentials:@"MixpanelToken"];

Crashlytics/Fabric Server-side Symbolication

For Crashlytics/Fabric to be able to symbolicate your crash reports, your app needs to send the dSYM file up to the Crashlytics servers. You probably want to do this automatically at post-build time:

  • Add a "Run Script" build phase to the target.
# Crashlytics/Fabric dSYM upload
"${PODS_ROOT}/Fabric/run" <API_KEY> <BUILD_SECRET>

Also ensure that your project's Debug Information Format (under Build Settings) is set to DWARF with dSYM File for all build configurations.

This script assumes that you have installed GBAnalytics using CocoaPods in which case the framework will be in the PODS_ROOT. If you added GBAnalytics manually, then you should update the script to point to the Crashlytics run binary location.

Install

Add to your project's Podfile (only include the subspecs that you are using):

pod 'GBAnalytics', subspecs: ['GoogleAnalytics', 'Flurry', 'Crashlytics', 'Answers', 'Tapstream', 'Facebook', 'Mixpanel', 'Parse', 'Localytics', 'Amplitude', 'Firebase', 'Intercom']

And run this in your project folder:

pod install

Lastly, if you use Crashlytics, add the build script to your project (see above).

Requirements & Details

  • Built using ARC
  • Supports iOS 6 and above
  • Does not use Apple's UDID.
  • DOES use Apple's IDFA so make sure you tick the correct boxes in iTunes Connect (always tick "this app uses the advertising identifier for attribution", if you show ads then also tick "this app shows ads", and if you use some of the attribution information from the analytics' networks' SDKs' to customise the user experience then tick that box too).

Copyright & License

Copyright 2016 Goonbee

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.