Skip to content

Swrve/swrve-segment-android-kit

Repository files navigation

analytics-android-integration-swrve

Swrve integration for analytics-android.

Installation

In your top-level project build.gradle add:

repositories {
    maven {
        url = 'https://maven.google.com'
    }
}

To install the Segment-Swrve integration, simply add this line to your gradle file:

dependencies {
    compile 'com.segment.analytics.android:analytics:4.10.4'
    compile 'com.swrve.segment:analytics-android-integration-swrve:3.0.0'
}

Usage

After adding the dependency, you must register the integration with our SDK. To do this, import the Swrve integration:

import com.swrve.segment.SwrveIntegration;
import com.swrve.sdk.config.SwrveConfig;

And add the following line:

int appId = -1;
String apiKey = "api_key";

SwrveConfig swrveConfig = new SwrveConfig();
// To use the EU stack, include this in your config.
// swrveConfig.setSelectedStack(SwrveStack.EU);

Analytics analytics = new Analytics.Builder(this, "write_key")
                          .use(SwrveIntegration.createFactory(application, appId, apiKey, swrveConfig))
                          .build();

Identity

In order to use Swrve's identity functionality, you must use Segment's identify method with the key swrve_external_id in the traits dictionary. This is deliberately separate from the Segment user id, since Swrve does not allow the use of email or other PII as an external identifier.

Identifying in Swrve:

Analytics.with(this).identify("SEGMENT_USER_ID", new Traits().putValue("swrve_external_id","EXTERNAL_USER_ID") );

Install Specific Version of Swrve SDK

By default this integration pulls in the latest vanilla version of the Swrve SDK. If you rather want to use a specific version, simply exclude them from the integration and specify the required versions in your build.gradle file directly.

For example, if you wanted to use the Firebase flavored Swrve SDK:

compile('com.swrve.segment:analytics-android-integration-swrve:2.0.0') {
    exclude group: 'com.swrve.sdk.android', module: 'swrve'
}
compile 'com.swrve.sdk.android:swrve-firebase:6.0.2'

License

© Copyright Swrve Mobile Inc or its licensors. Distributed under the Apache 2.0 License.
Google Play Services Library Copyright © 2012 The Android Open Source Project. Licensed under the Apache 2.0 License.
Gradle Copyright © 2007-2011 the original author or authors. Licensed under the Apache 2.0 License.