快速集成

本文档主要讲述 Android 原生包接入 引力引擎 的技术接入方案，在开始接入前，建议您先阅读 接入前准备以了解接入必备的基础概念。

1. 获取 AccessToken

您可以在设置-应用管理页面点击 查看参数 按钮获取当前应用的 AccessToken ，请妥善保存避免泄露。

2. 集成 SDK

2.1 自动集成(推荐)

• 在 Project 级别的 build.gradle 文件中添加如下配置依赖：

maven { url 'https://nexus.gravity-engine.com/repository/maven-releases/' }
maven { url 'https://nexus.gravity-engine.com/repository/maven-snapshots/' }
maven { url 'https://developer.huawei.com/repo' }
maven { url 'https://developer.hihonor.com/repo' }

• Module 工程目录下的 build.gradle 文件中添加依赖项：

implementation ("cn.gravity.android:GravityEngineSDK:${LATEST_VERSION}")
// 添加依赖
implementation "com.huawei.hms:ads-identifier:3.4.62.300"//华为SDK
implementation 'com.hihonor.mcs:ads-identifier:1.0.3.300'//荣耀SDK

${LATEST_VERSION} 请参见发版记录 请使用其中最新版本的 version 以保证获得引力及时的更新支持。

2.2 手动集成

• 下载并解压最新 Android SDK 包，您可以在SDK下载下载最新版本 SDK aar 包
• 在项目 libs 文件夹中添加 GravityEngineSDK.aar
• 在 Project 级别的 build.gradle 文件中添加如下配置依赖：

// 添加 repo 地址
maven { url 'https://developer.huawei.com/repo' }
maven { url 'https://developer.hihonor.com/repo' }

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar','*.aar'])
    // 添加依赖
    implementation "com.huawei.hms:ads-identifier:3.4.62.300"//华为SDK
    implementation "com.hihonor.mcs:ads-identifier:1.0.3.300"//荣耀SDK
}

3. 配置并启动 SDK

// 在主线程中配置并启动SDK
GEConfig config = GEConfig.getInstance(context, ACCESS_TOKEN);
config.enableAndroidId(true); // 传入 false，则表示关闭 Androidid采集，非必须不要关闭，会影响归因率！5.0.9 及以上版本支持
config.enableOAID(true); // 传入 false，则表示关闭 OAID采集，非必须不要关闭，会影响归因率！5.0.9 及以上版本支持
config.enableIMEI(true); // 传入 false，则表示关闭 IMEI 采集，非必须不要关闭，会影响归因率！5.0.9 及以上版本支持
config.enableMAC(true); // 传入 false，则表示关闭 mac采集，非必须不要关闭，会影响归因率！5.0.16及以上版本支持
// 保存此实例，后续调用方法均需要用到
GravityEngineSDK gravityEngineSDKInstance = GravityEngineSDK.setupAndStart(config);

参数说明：

• ACCESS_TOKEN : 在第一步中获取的项目通行证 AccessToken

应用每次启动都要执行 SDK 的启动逻辑，建议在用户同意隐私政策弹窗之后尽早调用。

4. 初始化

在用户可以获取到用户唯一性 ID 时调用此方法，推荐首次安装启动时调用，请启动应用之后尽早调用。

gravityEngineSDKInstance.initialize(ACCESS_TOKEN, USER_CLIENT_ID, USER_CLIENT_NAME, CHANNEL, new InitializeCallback() {
    @Override
    public void onFailed(String errorMsg, JSONObject initializeBody) {
        Log.d(TAG, "initialize failed " + errorMsg);
    }

    @Override
    public void onSuccess(JSONObject responseJson, JSONObject initializeBody) {
        Log.d(TAG, "initialize success");
    }
}, ENABLE_SYNC_ATTRIBUTION);

参数说明：

5.事件上报

5.1 业务注册事件上报

如果您的应用不需要追踪用户注册行为，可以跳过此事件接入。此功能仅适用于需要统计业务注册转化数据的场景。

该方法可多次调用，每次调用都会上报一个用户注册事件（计算指标时会去重）

当用户完成应用内业务注册后，您可以调用 trackRegisterEvent 方法来上报用户注册事件($AppRegister)给引力，引力会使用该事件统计后台计算指标：标准_注册数

方法示例

public String trackRegisterEvent()

gravityEngineSDKInstance.trackRegisterEvent();

public String trackPayEvent(int payAmount, String payType, String orderId, String payReason, String payMethod)

gravityEngineSDKInstance.trackPayEvent(300, "CNY", "order_id" + System.currentTimeMillis(), "月卡", "支付宝");

public String trackAdShowEvent(String adUnionType, String adPlacementId, String adSourceId, String adType, String adnType, float ecpm)

// 上报广告观看事件
gravityEngineSDKInstance.trackAdShowEvent("topon", "placement_id", "ad_source_id", "reward", "csj", 1);

public String trackWithdrawEvent(int payAmount, String payType, String orderId, String payReason, String payMethod)

gravityEngineSDKInstance.trackWithdrawEvent(300, "CNY", "order_id" + System.currentTimeMillis(), "用户首次提现", "支付宝");