android – How to correctly use and track App-invites?-ThrowExceptions

Exception or error:


Google allows to perform app-invites and also track how well they improve your app installations:

The problem

I made a simple app invite, and it seems people do use it, using this code:

public static Intent getAppInviteIntent(Context context) {
    return new AppInviteInvitation.IntentBuilder(title,appName).setCustomImage(imageUri).setMessage(message).setCallToActionText(download).build();

startActivityForResult(getAppInviteIntent(this), GOOGLE_APP_INVITES_REQUEST_CODE);

This works, but in the Analytics webpage, I can’t find a way to show the statistics of the app-invite, and that’s even though they say it’s automatic (here). Sadly, even what I’ve found seem quite old and they use deprecated functions.

What I’ve tried

I thought that maybe it’s not quite automatic (because the tutorial has some extra code for the receiver part too, here), and that we might need to add some code, as this docs say :

When the user accepts an invitation and installs the app, getInvitation(GoogleApiClient, Activity, boolean) will update the invitation state to installed and return the invitation data in an intent accessed from AppInviteInvitationResult using getInvitationIntent()

Looking at Google’s sample (here), I’ve noticed they created 2 activities. One is the main activity, which does have a call to “getInvitation” , and another is called “DeepLinkActivity” , and handles deep links (which is probably for extra data, like coupons).

I’ve also found some stackOverflow questions about the tracking (like here), but all I see is that people didn’t succeed tracking yet.

The questions

  1. What is the minimal code needed in order to track the invitations and how well they work, as shown on the video? What should be configured in Analytics page itself? I don’t use deep linking currently, so I don’t want to use it.

  2. It seems that Google moved the app-invites feature to “firebase” gradle repositories. Is it a must-have? What are the advantages? We currently use the previous ones (“…” ). The dashboard of FireBase doesn’t seem to include as much UI for analytics as Google Analytics. Not to mention of app-invites.

  3. If the answer to #1 is that I need to use “getInvitationIntent”, does it have to be on the main activity of the app ? Does it have to be in an activity at all (maybe broadcastReceiver?) ?

  4. It seems it’s possible to also invite to IOS too ( as shown here and here, using “setOtherPlatformsTargetApplication”). Is this correct? How does it work? What happens when an IOS user clicks the link? What should be put into the parameter of “clientId” and where do I get it from ?

  5. Does G+ have app-invites? If so, does it also have analytics?

How to solve:

Great questions. I’ll do my best to answer everything. Please ask if you need clarification.

Analytics tracking requires a tracking Id that you’ll need to set using setGoogleAnalyticsTrackingId(String trackingId), which I don’t see in your example. This tracking Id is then handed to the downstream events that record analytics tracking events for you:

  • When invitations are send (both email and sms).
  • When the invited user accepts the invitation by clicking on the invitation link or button.
  • When the developer calls getInvitation()
  • When the developer calls convertInvitation()

So, to answer your specific questions, here goes:

  1. Just add your tracking ID to the builder as described above, and all the tracking events will be reported. No need for a deeplink, that’s optional on invites.
  2. Yes, appinvites api is copied to firebase while retaining the original. For now they are exactly the same. Future improvements will be in firebase, so migrate when you have time.
  3. getInvitationIntent() is called on the result returned in the callback from getInvitation(), so the callback should be within an activity. Also, since you’ll only expect an invitation immediately after launch, you really only need to check in the main activity and any activity that would be launched from intent filters that trigger on the deeplink. Sounds like you don’t use deeplinks, so only the main activity. Generally you should call getInvitation() from all activities that may be directly launched from an invitation, this is how you determine if your app is launched from an invitation.
  4. Yes, invites can go cross-platform in both directions, iOS -> android, and android -> iOS. You need to define both apps in the same project in, which is necessary to associate them. If there is more than one iOS app in the project, that api call is necessary to disambiguate the iOS app that is paired with the android app. The ClientID parameter is generated in the console when you create the OAuth Client Id using the pulldown menu from credentials section.
  5. There isn’t any separate G+ invites.



  1. The Firebase Dynamic Links on Android documentation explains how to view the analytics data shown directly in the Firebase console. The critical step is to follow the Firebase setup instructions, most importantly:


apply plugin: ‘’

The Firebase analytics integration has been streamlined from the legacy integration that required a tracking Id. Now with Firebase only setup and a call to getInvitation() are needed. No additional code or tracking ids required. Remember it takes up to 24 hours to see the results in the console. However, you can see the messages being sent immediately which is a great indication that it’s working. Just enable verbose logging as described in Analytics Log Events documentation.

  1. The Firebase and android developer documentation for appinvites are identical.

  2. Yes, you must call getInvitation() to get analytics tracking, and do the setup as described above.

  3. The iOS and Android equivalence apps should be in the same project. Just move them to a single project in the Firebase console. You can just remove one from it’s existing project and add it to the other to make a combined project. The change should be reflected instantly.

Leave a Reply

Your email address will not be published. Required fields are marked *