The Velocidi Android SDK is open-source and can be found at github.com/velocidi/velocidi-android-sdk.
Velocidi SDK is published to Maven central as a single module. Please reference the badge above or go to the release page to check our latest version.
To install the SDK in your application you just need to add the following dependency to the
You also need to add the following permissions to ensure the good functioning of the SDK.
In your application
We highly recommend initializing the SDK on the
onCreate method in your
If you don't already have an
Application subclass, you can also instantiate it in your
MainActivity although it is not recommended.
track method allows you to collect user activity performed in your application.
This method is expecting a tracking event, in the format of a JSON string or a
org.json.JSONObject with the event details. For more information check our documentation
match method allows you to identify a user across multiple channels (Browser, Mobile App, CRM, ...).
By performing a match between multiple ids you are telling Velocidi CDP that these are the same user
and all the information retrieved with either one of these IDs belongs to the same user.
A typical use case for this is, during the login action,
to associate the user's email with Google's Advertising ID.
For more information about Cross-Channel Matches go to https://docs.velocidi.com/collect/matches/ .
Velocidi's SDK does not collect any user ID by default. These IDs have to be explicitly provided when executing the requests. We recommend taking a look at Android's documentation about Best practices for unique identifiers.
Google Advertising ID (GAID) is a user-resettable identifier that uniquely identifies a particular user for advertising use cases.
This ID can be fetched using Android's Adversiting ID library. A comprehensive guide with examples on how to get the GAID can be found in Android's documentation in Get a user-resettable advertising ID. Once we have the GAID, it can be used like any other ID.