如何集成

请参考下方文档来集成 GrowingIO 无埋点或埋点 SDK.

---

添加maven仓库

在 project 级别的build.gradle文件中添加Maven仓库

buildscript {
    repositories {
        // 添加maven仓库
        mavenCentral()
        // 如果使用 SNAPSHOT 版本，则需要使用如下该仓库。
        maven { url "https://s01.oss.sonatype.org/content/repositories/snapshots/" }
        // 3.5.1版本开始，插件发布在gradlePluginPortal
        gradlePluginPortal()
    }
}

allprojects {
    repositories {
        // 添加maven仓库
        mavenCentral()
        // 如果使用 SNAPSHOT 版本，则需要使用如下该仓库。
        maven { url "https://s01.oss.sonatype.org/content/repositories/snapshots/" }
    }
}

集成无埋点SDK

无埋点SDK能够在不修改代码的情况下，自动帮助应用获取页面浏览，页面点击等埋点事件。

如何依赖

添加插件

在 project 级别的build.gradle文件中添加插件路径

buildscript {
    repositories {
        // 添加maven仓库
        mavenCentral()
        // 如果使用 SNAPSHOT 版本，则需要使用如下该仓库。
        maven { url "https://s01.oss.sonatype.org/content/repositories/snapshots/" }
        // 3.5.1版本开始，插件发布在gradlePluginPortal
        gradlePluginPortal()
    }
    dependencies {
        //GrowingIO 无埋点 SDK plugin
        classpath 'com.growingio.android:autotracker-gradle-plugin:3.5.4'
    }
}

在 app 级别的 build.gradle 文件中添加 com.growingio.android.autotracker 插件

apply plugin: 'com.android.application'
//添加 GrowingIO 插件
apply plugin: 'com.growingio.android.autotracker'

...

关于插件

插件最新发布版本为 Github Releases

关于如何在 Android Gradle Plugin 7 及其更高版本使用插件请参考 SDK 插件说明

添加代码依赖

在需要用到的应用级别下的 build.gradle 文件中添加代码依赖

依赖

apply plugin: 'com.android.application'

dependencies {
    implementation 'com.growingio.android:autotracker-cdp:3.5.4'
}

BoM

apply plugin: 'com.android.application'

dependencies {
  // Import the BoM for the GrowingIO platform
  implementation platform('com.growingio.android:autotracker-bom:3.5.4')

  //GrowingIO 无埋点 SDK
  implementation 'com.growingio.android:autotracker-cdp'
}

关于版本

最新版本请参考 Github Release

添加URL Scheme

URL Scheme 是 GrowingIO SDK 从外部唤醒应用时使用的唯一标识。把 URL Scheme 添加到您的项目，以便使用圈选,Mobile Debugger 及深度链接等功能时唤醒应用。 将应用的 URLScheme 和应用权限添加到您的 AndroidManifest.xml 中的 LAUNCHER Activity 下。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.growingio.testdemo">
​
    <uses-permission android:name="android.permission.INTERNET" />

    <application
        android:name=".YourApplication"
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <activity android:name=".LauncherActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
            <!--请添加这里的整个 intent-filter 区块，并确保其中只有一个 data 字段-->
            <intent-filter>
                <data android:scheme="growing.您的URL Scheme" />
                <action android:name="android.intent.action.VIEW" />
                <category android:name="android.intent.category.DEFAULT" />
                <category android:name="android.intent.category.BROWSABLE" />
            </intent-filter>
            <!--请添加这里的整个 intent-filter 区块，并确保其中只有一个 data 字段-->
        </activity>
    </application>
</manifest>

SDK初始化配置

请将 SDK 的初始化代码放入 Application 的 onCreate 中。为使 App 合规，请参考合规步骤

java

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();

        // Config GrowingIO
        // YourAccountId eg: 0a1b4118dd954ec3bcc69da5138bdb96
        // Your URLScheme eg: growing.xxxxxxxxxxx
        // YourServerHost eg: https://api.growingio.com 需要填写完整的url地址
        // YourDatasourceId eg: 11223344aabbcc
        CdpAutotrackConfiguration sConfiguration = new CdpAutotrackConfiguration("Your AccountId", "Your URLScheme")
                .setDataCollectionServerHost("Your ServerHost")
                .setDataSourceId("Your DataSourceId")
                .setDebugEnabled(BuildConfig.DEBUG);
        GrowingAutotracker.startWithConfiguration(this,sConfiguration);
    }
}

kotlin

class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()

        // Config GrowingIO
        // YourAccountId eg:0a1b4118dd954ec3bcc69da5138bdb96
        // Your URLScheme eg:growing.xxxxxxxxxxx
        // YourServerHost eg:http://106.75.81.105:8080
        // YourDatasourceId eg: 11223344aabbcc
        val sConfiguration = CdpAutotrackConfiguration("Your AccountId", "Your URLScheme")
            .setDataCollectionServerHost("Your ServerHost")
            .setDataSourceId("Your DataSourceId")
            .setDebugEnabled(BuildConfig.DEBUG)
        GrowingAutotracker.startWithConfiguration(this, sConfiguration)
    }
}

注意

GrowingAutotracker.startWithConfiguration第一个参数为 ApplicationContext 对象。

查看集成效果

运行应用，若 Logcat 中输出了 !!! Thank you very much for using GrowingIO. We will do our best to provide you with the best service. !!! !!! GrowingIO Tracker version: 3.4.4 !!! 则说明SDK已经集成成功。

若在初始化中打开了Debug setDebugEnabled(true) ，则可以在 Logcat 中看到每个事件的log日志输出。

至此，就完成了无埋点 SDK 的集成。

另外，您可使用 GioKit 辅助插件 进行集成验证。

集成埋点SDK

埋点 SDK只自动采集用户访问事件和APP关闭事件，其他事件均需要开发同学调用相应埋点 API 采集埋点事件。 埋点相较于无埋点集成步骤会更简单，也不需要添加额外的插件。

添加依赖

只需要在应用级别下的 build.gradle 文件中添加tracker依赖即可。

依赖

apply plugin: 'com.android.application'

dependencies {
    //GrowingIO 埋点 SDK
    implementation 'com.growingio.android:tracker-cdp:3.5.4'
}

BoM

apply plugin: 'com.android.application'

dependencies {
  // Import the BoM for the GrowingIO platform
  implementation platform('com.growingio.android:autotracker-bom:3.5.4')

  //GrowingIO 埋点 SDK
  implementation 'com.growingio.android:tracker-cdp'
}

添加URLScheme

以便唤醒App

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.growingio.testdemo">
​
    <uses-permission android:name="android.permission.INTERNET" />

    <application
        android:name=".YourApplication">
        <activity android:name=".LauncherActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
            <!--请添加这里的整个 intent-filter 区块，并确保其中只有一个 data 字段-->
            <intent-filter>
                <data android:scheme="growing.您的URLScheme" />
                <action android:name="android.intent.action.VIEW" />
                <category android:name="android.intent.category.DEFAULT" />
                <category android:name="android.intent.category.BROWSABLE" />
            </intent-filter>
            <!--请添加这里的整个 intent-filter 区块，并确保其中只有一个 data 字段-->
        </activity>
    </application>
</manifest>

SDK初始化配置

请将 SDK 的初始化代码放入 Application 的 onCreate 中。为使 App 合规，请参考合规步骤

java

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        // Config GrowingIO
        // YourAccountId eg: 0a1b4118dd954ec3bcc69da5138bdb96
        // Your URLScheme eg: growing.xxxxxxxxxxx
        // YourServerHost eg: https://api.growingio.com 需要填写完整的url地址
        // YourDatasourceId eg: 11223344aabbcc
        CdpTrackConfiguration sConfiguration = new CdpTrackConfiguration("Your AccountId", "Your URLScheme")
                .setDataCollectionServerHost("Your ServerHost")
                .setDataSourceId("Your DataSourceId")
                .setDebugEnabled(BuildConfig.DEBUG);
        GrowingTracker.startWithConfiguration(this, sConfiguration);
    }
}

kotlin

class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        // Config GrowingIO
        // YourAccountId eg: 0a1b4118dd954ec3bcc69da5138bdb96
        // Your URLScheme eg: growing.xxxxxxxxxxx
        // YourServerHost eg: https://api.growingio.com 需要填写完整的url地址
        // YourDatasourceId eg: 11223344aabbcc
        val sConfiguration: CdpTrackConfiguration =
            CdpTrackConfiguration("Your AccountId", "Your URLScheme")
                .setDataCollectionServerHost("Your ServerHost")
                .setDataSourceId("Your DataSourceId")
                .setDebugEnabled(BuildConfig.DEBUG)
        GrowingTracker.startWithConfiguration(this, sConfiguration)
    }
}

混淆

SDK中已经默认集成了混淆规则，R8 在编译项目时会自动应用其规则。

如果混淆后还出现问题，可以在您的 proguard-rules.pro 中加入如下代码：

-keep class com.growingio.** {
    *;
}
-dontwarn com.growingio.**

查看集成效果

运行应用，若 Logcat 中输出了 !!! Thank you very much for using GrowingIO. We will do our best to provide you with the best service. !!! !!! GrowingIO Tracker version: 3.4.2 !!! 则说明SDK已经集成成功。

若在初始化中打开了Debug setDebugEnabled(true) ，则可以在 Logcat 中看到每个事件的log日志输出。

至此，就完成了埋点 SDK 的集成。

另外，您可使用 GioKit 辅助插件 进行集成验证。