优量汇数据上报集成版 Android SDK 接入文档

概述

本文档旨在帮助应用开发者在程序中快速植入腾讯优量汇开发者平台提供的广告，并对后项的变现与增长数据进行分析。作为应用开发者，您只需要进行简单配置，就可以在您的应用中显示定制的广告，并进行相应的数据上报和分析。
关于 SDK 的具体使用方法，请仔细阅读下面的文档。

前期内测阶段，开发者需申请白名单，才可使用数据上报集成版SDK。白名单申请请联系您的运营经理。

接入指引

开发环境

确保您的开发及部署环境符合以下标准：

• 开发工具：推荐 AndroidStudio

• 部署目标：Android 4.1 及其以上

• SDK版本：官网最新版本

注册开户

开发者需在腾讯优量汇开发者平台上进行注册，在平台审核通过后，开发者就成为了腾讯优量汇的正式会员。

主要API

public class GDTDetectEvent {
    /**
     * 事件类构造方法，传入一个事件名，唯一标识该事件，该标识不能为 null 或者空字符串
     * {@link GDTDetectEventName} 类中预定义了一些事件名，带有前缀"gt_"的事件为预定义事件，用户自定义事件时不可占用
     */
    public GDTDetectEvent(String eventCode);

    /**
     * 向事件中添加参数
     * 注意事项：
     * 1. 这些参数最后会转换为 json 字符串，json 字符串总长度不能超过 10K。
     * 2. 如果 value 是自定义类型，请务必重写 {@link Object#toString()} 方法，否则会是”类名+哈希值“。
     */ 
    public void put(String key, Object value);
}

public class GDTDataDetector {
    /**
     * 上报事件
     */
    public void report(GDTDetectEvent event);
}

使用示例

1.首先需要初始化 SDK 注册流量侧的 AppId 信息，推荐在Application中运行

@Override
public void onCreate() {
    GDTADManager.getInstance().initWith(this, appId);
}

2.调用DataDetector接口，进行事件上报。

public void test() {
    // 定义事件
    GDTDetectEvent event = new GDTDetectEvent(eventName);
    // 事件中添加参数
    event.put("key", "value");
    // 上报
    GDTDataDetector.getInstance().report(event);
}

行为事件上报

针对行为事件上报，通过SDK需要上报3个字段：事件标识、字段标识、字段值。

	描述	类型	是否必填	限制	样例
事件名称	事件名称	string	用户在开发者平台新建事件时必填；SDK无需上报	30个字符串以内	事件名A
事件标识	用来标识需要上报的事件，SDK上报时以该标识为准	string	必填	仅支持数字/字母/下划线	your_event_id
字段名称	用于事件上报的附属字段	string	用户在开发者平台新建事件时必填；SDK无需上报	100个字符串以内	事件附属字段名称A
字段标识	用于事件上报的附属字段标识，可通过代码识别对应数据	string	选填	仅支持数字/字母/下划线；每个事件最多可建10个字段标识	max_lev
字段值	用户自定义上报	string	选填	如果字段标识和字段值非空，需要可以序列化成jsonString，且总长度不能超过10KB	100

优量汇目前提供标准化事件和自定义事件两种。

标准化事件

标准化事件的事件名称/事件标识和字段名称/字段标识都是固定的，不可修改，开发者参考标准化事件列表上报即可，字段值可自定义上报

• 标准化行为上报的规范指引，游戏开发者必须上报如下行为。
  数据上报集成版SDK - 标准化上报行为列表
• 也可详见开发者平台 - 数据中心 -事件管理-- 行为事件管理 模块，筛选标准化事件查看标准化行为事件枚举值。
• 其中，内购收入上报：内购付费金额需要上报到标准定义事件gt_purchase下，字段标识统一定义为amount（付费金额单位：元，保留小数点后两位），数据统计会按照本字段统一处理，如无上报，则无法统计内购收入及用户情况。

自定义事件

开发者可在腾讯优量汇开发者平台自定义事件：数据中心--事件数据--行为事件管理。开发者自定义事件后，可按自定义事件上报数据，并在事件分析报表查看。

点击新建事件，可自定义事件。

事件分析报表

开发者上报了标准化事件或自定义事件数据后，即可在腾讯优量汇开发者平台查看相应的事件数据统计。数据中心--事件数据--事件分析报表

事件分析报表

• 上报用户数UV：触发事件上报的用户总量，单个用户触发两次事件时将被计数两次
• 上报次数PV：触发事件上报的总次数

一体化数据：数据报表、用户价值看板

一体化数据页面目前两个页面：数据报表和用户价值看板。其中，数据指标包含买量类、用户类、变现类数据。
买量类：买量类数据指标需要提前与您的运营经理联系开通白名单后才可查看；
用户类：接入数据上报集成版SDK，并上报了相应行为事件数据后，即可查看相应的用户类数据；
变现类：开发者分成收入请以数据中心-广告数据 页面数据为准，一体化数据模块中变现数据是为了分析不同渠道的用户变现价值，两份数据统计口径和统计方式不同，所以收入会有差异，请开发者了解；

• 买量类数据：买量广告消耗、买量广告曝光量、买量广告点击量、买量广告转化量、买量点击率、买量转化率、买量千次展示成本、买量点击成本、买量转化成本、买量APP激活人数、买量APP激活成本；
• 用户类数据：活跃用户数、广告用户数、人均广告变现收入、广告用户人均广告变现收入、人均广告曝光量、广告用户人均曝光量、人均停留时长、广告渗透率、新增用户数、次日留存量、次留率、新增用户2日留存率、新增用户3日留存率....新增用户30日留存率等；
• 变现类数据：广告变现收入、广告变现千次展示收入、变现曝光量、变现点击量、变现点击率、LTV0、LTV1.......LTV30、账面ROI、新增用户广告变现ROI0、新增用户广变现ROI1、新增用户广告变现ROI30等；