You need to enable JavaScript to run this app.
导航

Android

最近更新时间2024.01.11 14:22:22

首次发布时间2023.11.09 20:00:09

一、简介

火山引擎DataSail提供埋点数据上报Android SDK,用户在开通DataSail服务之后,可以通过Android SDK将埋点数据上报到火山云DataSail。

二、前置准备

服务开通

请确保您已开通了您需要访问的服务。您可前往火山引擎控制台开通全域数据集成服务,详见服务开通

获取安全凭证

Access Key(访问密钥)是访问火山引擎服务的安全凭证,包含Access Key ID(简称为AK)和Secret Access Key(简称为SK)两部分。您可登录火山引擎控制台,前往访问控制访问密钥 中创建及管理您的Access Key。更多信息可参考访问密钥帮助文档

三、集成SDK

引入仓库

Gradle 7.0 以下:

// 在 project 级别的 build.gradle 中添加 maven 仓库
// 在 allprojects 的 repositories 中添加 maven 仓库
allprojects {
    repositories {
        maven {
            url 'https://artifact.bytedance.com/repository/Volcengine/'
        }
        // 其他仓库
    }
}

Gradle 7.0 及以上:

// 在 project 级别的 setting.gradle 中添加 maven 仓库
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {// 省略其他
        maven{
            url 'https://artifact.bytedance.com/repository/Volcengine/'
        }
    }
}

引入SDK

在app module级别的build.gradle文件中,在dependencies里引入SDK。

// 在build.gradle文件的dependencies中引入SDK
implementation 'com.volcengine.datasail:datasail:1.0.2-alpha.2'
四、使用

获取应用信息

1、获取AppId/应用ID

  1. 申请应用:DataSail-应用管理-新建应用

  2. AppID查看

2、获取TenantID/租户ID

3、获取Endpoint & TaskKey

实时埋点 endpoint & taskKey

Endpoint

https://datasail01-cn-beijing.volceapplog.com/v1/production/general/collect/{DataSail 采集任务ID}/list/

TaskKey

  1. 新建数据采集任务:DataSail-数据采集-采集管理-新建采集任务

  2. 采集任务TaskKey查看




启动

可以参考以下代码进行启动

DataSailConfig config = new DataSailConfig.Builder()
        .setAppId(appId)
        .setTenantId(tenantId)
        .setTaskKey(taskKey)
        .setDomain(domain)
        .build();
DataSailAgent agent = new DataSailAgent(this, config);

埋点

JSONObject properties = new JSONObject();
try {
    properties.put("key1", "value1");
    properties.put("key1", "value1");
} catch (JSONException e) {
    e.printStackTrace();
}
client.track("event_key", properties);

埋点验证

1、启动时开启埋点验证功能

agent.setVerificationEnabled(true)

2、获取在启动后,本地设备ID

String clientId = agent.getClientId();

3、在火山产品页面进行埋点验证,详见用户手册:埋点实时验证