atom-Android is the official ironSource.atom SDK for the Android.
Add the repository to your gradle config file
repositories {
maven { url "https://raw.github.com/ironSource/atom-android/mvn-repo/" }
}and add dependency for Atom SDK
dependencies {
compile 'io.ironsourceatom.sdk:atom-sdk:1.3.0'
}
Add repository for you pom.xml
<repositories>
<repository>
<id>atom-java</id>
<url>https://raw.github.com/ironSource/atom-android/mvn-repo/</url>
<snapshots>
<enabled>true</enabled>
<updatePolicy>always</updatePolicy>
</snapshots>
</repository>
</repositories>and add dependency for Atom SDK
<dependencies>
<dependency>
<groupId>io.ironsourceatom.sdk</groupId>
<artifactId>atom-sdk</artifactId>
<version>1.3.0</version>
</dependency>
</dependencies>The SDK provides a tracker class which contains a local SQLite DB and tracks events based on certain parameters.
You can use track() method in order to track the events to an Atom Stream. The tracker accumulates The tracker accumulates events and flushes them when it meets one of the following conditions: events and flushes them when it meets one of the following conditions:
- Flush Interval has been reached (default: 10 seconds).
- Bulk Length has been reached (default: 4 events).
- Maximum Request Limit has been reached (default: 1MB).
In case of failure the tracker will preform an exponential back-off with jitter. The tracker stores events in a local SQLITE database.
The Report Job Service should be added from Android API version 21 and above:
<service android:name="io.ironsourceatom.sdk.ReportJobService"
android:exported="true"
android:permission="android.permission.BIND_JOB_SERVICE" />Note:
RECEIVE_BOOT_COMPLETE permission is recommended to be used for the JobScheduler
to allow resending unsent reports after device reboots
OR Report Service for API version less than 21:
<service android:name="io.ironsourceatom.sdk.ReportService" />Add IronSourceAtom to your main activity. For example:
import io.ironsourceatom.sdk.IronSourceAtomFactory;
import io.ironsourceatom.sdk.IronSourceAtomTracker;
public class BaseMainActivity extends Activity {
private IronSourceAtomFactory ironSourceAtomFactory;
private static final String TAG = "SDK_EXAMPLE";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main_v2);
// Create and config IronSourceAtomFactory instance
ironSourceAtomFactory = IronSourceAtomFactory.getInstance(this);
ironSourceAtomFactory.enableErrorReporting();
ironSourceAtomFactory.setBulkSize(5);
ironSourceAtomFactory.setFlushInterval(3000);
ironSourceAtomFactory.setAllowedNetworkTypes(IronSourceAtomFactory.NETWORK_MOBILE | IronSourceAtomFactory.NETWORK_WIFI);
ironSourceAtomFactory.setAllowedOverRoaming(true);
}
public void sendReport(View v) {
int id = v.getId();
String stream = "your.atom.stream";
// Atom tracking url
String url = "http://track.atom-data.io";
String bulkURL = "http://track.atom-data.io/bulk";
String authKey = ""; // Pre-shared HMAC auth key
// Configure tracker
IronSourceAtomTracker tracker = ironSourceAtomFactory.newTracker(authKey);
tracker.setISAEndPoint(url);
tracker.setISABulkEndPoint(bulkURL);
// Android Tracker Example
JSONObject params = new JSONObject();
try {
params.put("event_name", "ANDROID_TRACKER");
params.put("id", "" + (int) (100 * Math.random()));
} catch (JSONException e) {
Log.d(TAG, "Failed to track your json");
}
Log.d("[Tracking event]", params.toString());
tracker.track(stream, params);
// Will send this event immediately
try {
params.put("event_name", "ANDROID_TRACKER_SEND_NOW");
params.put("id", "" + (int) (100 * Math.random()));
} catch (JSONException e) {
Log.d(TAG, "Failed to track your json");
}
Log.d("[TRACKER_SEND_NOW]", params.toString());
tracker.track(stream, params, true);
Log.d("[TRACKER_FLUSH]", "FLUSHING TRACKED EVENTS");
tracker.flush();
}
}The sdk supports an option to track internal errors to a separate stream in order to be able
to debug errors at the client side.
- Create the following table at your Redshift DB:
CREATE TABLE schema.table (
timestamp TIMESTAMP WITHOUT TIME ZONE,
sdk_version CHARACTER VARYING(10),
connection CHARACTER VARYING(20),
platform CHARACTER VARYING(20),
os CHARACTER VARYING(40),
api_version CHARACTER VARYING(10),
manufacturer CHARACTER VARYING(20),
model CHARACTER VARYING(20),
locale CHARACTER VARYING(10),
details CHARACTER VARYING(2000)
);-
Create a stream at the atom-console
-
Setup and enable debug:
ironSourceAtomFactory.setErrorStream("YOUR.ATOM.ERROR.STREAM");
ironSourceAtomFactory.setErrorStreamAuth("YOU.AUTH.KEY");
ironSourceAtomFactory.enableErrorReporting();- Added JobScheduler for handling connectivity changes for devices >= Lollipop (Android 5.0/API 21)
- Back-off class is now independent form the Flush Interval param
- Merged reportHandler and reportService -> ReportService
- Moved intent out of the reportIntent -> ReportData
- Removed simple report service (there is no need for this)
- Refactored some code to make it more Android-style
- Updated compileSdkVersion to API 25 in build.gradle
- Added integration test
- Updated Travis conf
- Added the option to import the project with Maven and Gradle.
- Added error tracking
- Updated tests and coverage
- Tracker service
- SQLite DB for presidency
- Low level methods simple service: putEvent and putEvents.
You can use our example(sample) for sending data to Atom:
