跳到主要内容

开发指南

初始化​

获取分包渠道名称​

当接入的是头条分包，获取到的是通过头条分包打出来的子包的渠道信息，如获取不到则会获取普通分包配置中的 channelName 字段信息。

/**
 * 获取渠道名称
 *
 * @param context 上下文
 * @return 渠道名称
 */
String channelName=XDADs.getChannelName(Context context);

获取 XDSDK 分包/广告包 SDK 版本​

获取当前分包/广告包功能的版本。

String sdkVersion=XDADs.getADsSDKVersion();

设置日志开关​

设置分包/广告包的功能的提示日志是否开启。

/**
 * 设置日志开关
 *
 * @param debuggable 是否 Debug
 */
XDADs.setDebuggable(boolean debuggable);

上报自定义事件​

提供自定义事件满足 SDK 内部预定义事件之外的其他事件。

/**
 * 自定义事件
 *
 * @param eventName 自定义事件名
 * @param params    自定义事件附带参数
 */
XDADs.logCustomAction(String eventName,JSONObject params);

上报预定义事件​

/**
 * 预定义事件
 *
 * @param actionType 预设事件类型
 * @param params     附带参数
 */
XDADs.logPredefinedAction(XDADsActionType actionType,JSONObject params);

/**
 * 查看内容/商品详情
 *
 * 参数： contentType: String 内容/商品类型，如"装备"、"皮肤"等
 *       contentName: String 内容/商品名称
 *       contentID: String 内容/商品的标识符
 */
JSONObject params = new JSONObject();
params.put("contentType", "内容/商品类型");
params.put("contentName", "内容/商品名称");
params.put("contentID", "内容/商品的标识符");
XDADs.logPredefinedAction(XDADsActionType.VIEW_CONTENT, params.toString());


/* 任务/副本/新手教程完成
 *
 * 参数： questID: String 任务 ID
 *       questName: String 教学/任务/副本名
 *       questType: String 任务类型
 *       questNo: int 第几个任务
 *       isSuccess: bool 状态
 *       desc: String 其他描述
 */
JSONObject params = new JSONObject();
params.put("questID", "任务 ID");
params.put("questName", "教学/任务/副本名");
params.put("questType", "任务类型");
params.put("questNo", 1);
params.put("isSuccess", true);
params.put("desc", "其他描述");
XDADs.logPredefinedAction(XDADsActionType.QUEST, params.toString());

/* 创建角色（旧版本没有 XDADsActionType 定义创角枚举，用自定义事件方法代替）
 *
 * 参数：role: String 游戏角色名称
 */
JSONObject params = new JSONObject();
params.put("role", "游戏角色名称");
XDADs.logCustomAction("CREATE_ROLE", params.toString());

/* 等级提升
 *
 * 参数：level: int 等级, 不能小于等于 0
 */
JSONObject params = new JSONObject();
params.put("level", 1);
XDADs.logPredefinedAction(XDADsActionType.UPDATE_LEVEL, params.toString());

预定义事件说明​

public enum XDADsActionType {
    /**
     * 应用启动 SDK 要求在 Activity 的 onResume() 方法中，而不是 onCreate() 方法中去上报App启动行为
     * 参数不做限制
     * 《广点通默认支持，头条当做自定义事件处理》
     */
    START_APP("START_APP", 0),
    /**
     * 页面浏览
     * 参数不做限制
     * 《广点通默认支持，头条当做自定义事件处理》
     */
    PAGE_VIEW("PAGE_VIEW", 3),
    /**
     * 注册
     * 头条参数:String method (注册⽅方式 mobile、weixin、qq等，必须上传)，String isSuccess (是否成功，必须上传)
     * 广点通参数不限制
     * 《广点通和头条都支持》
     */
    REGISTER("REGISTER", 20),
    /**
     * 内容浏览
     * 头条参数：String type(内容类型)，String name(内容名称)，String contentID(内容 Id)
     * 广点通参数不限制
     * 《广点通和头条都支持》
     */
    VIEW_CONTENT("VIEW_CONTENT", 21),
    /**
     * 咨询
     * 参数不做限制
     * 《广点通默认支持，头条当做自定义事件处理》
     */
    CONSULT("CONSULT", 4),
    /**
     * 加入购物车
     * 头条参数：String type(商品类型)，String name(商品名称)，String contentID(商品 Id)，String number(商品数量)，String isSuccess (是否成功，"1" 代表成功)
     * 广点通参数不限制
     * 《广点通和头条都支持》
     */
    ADD_TO_CART("ADD_TO_CART", 22),

    /**
     * 付费
     * 头条参数：String type(内容类型，非必传)，String name(商品/内容名，非必传)，String contentID(商品 ID / 内容 ID，非必传)
     * String number(商品数量，非必传)，String channel(支付渠道名 如支付宝、微信等，非必传)，String currency(真实货币类型，非必传)
     * String isSuccess(是否成功，"1" 表示成功，必须上传)，String amount(本次支付的真实金额(必须上传，单位：⼈⺠币元，不能为 "0")
     * 广点通不限制
     * 《广点通和头条都支持》
     */
    PURCHASE("PURCHASE", 24),
    /**
     * 搜索
     * 参数不做限制
     * 《广点通默认支持，头条当做自定义事件处理》
     */
    SEARCH("SEARCH", 5),
    /**
     * 加入收藏
     * 参数不做限制
     * 《广点通默认支持，头条当做自定义事件处理》
     */
    ADD_TO_WISHLIST("ADD_TO_WISHLIST", 6),
    /**
     * 开始结算/提交购买
     * 头条参数：String type(商品类型)，String name(商品名称)，String contentID(商品 Id)，
     * String number(商品数量)，String isVirtualCurrency(是否是虚拟货币 "1" 代表是)，
     * String virtualCurrency(货币名称)，String currency(真实货币名称)，
     * String isSuccess(是否成功 "1" 代表成功，String amount(本次支付的金额)
     * 广点通参数不做限制
     * 《广点通和头条都支持》
     */
    INITIATE_CHECKOUT("INITIATE_CHECKOUT", 23),
    /**
     * 下单
     * 参数不做限制
     * 《广点通默认支持，头条当做自定义事件处理》
     */
    COMPLETE_ORDER("COMPLETE_ORDER", 2),
    /**
     * 下载应用
     * 参数不做限制
     * 《广点通默认支持，头条当做自定义事件处理》
     */
    DOWNLOAD_APP("DOWNLOAD_APP", 7),
    /**
     * 评分
     * 参数不做限制
     * 《广点通默认支持，头条当做自定义事件处理》
     */
    RATE("RATE", 8),
    /**
     * 预定
     * 参数不做限制
     * 《广点通默认支持，头条当做自定义事件处理》
     */
    RESERVATION("RESERVATION", 9),
    /**
     * 分享
     * 参数不做限制
     * 《广点通默认支持，头条当做自定义事件处理》
     */
    SHARE("SHARE", 1),
    /**
     * 申请，用于金融广告主申请贷款、开卡等
     * 参数不做限制
     * 《广点通默认支持，头条当做自定义事件处理》
     */
    APPLY("APPLY", 10),
    /**
     * 领取卡券，用于 web 落地页领取卡券等优惠信息的行为
     * 参数不做限制
     * 《广点通默认支持，头条当做自定义事件处理》
     */
    CLAIM_OFFER("CLAIM_OFFER", 11),
    /**
     * 导航，用于web落地页点击跳转到地图的行为
     * 参数不做限制
     * 《广点通默认支持，头条当做自定义事件处理》
     */
    NAVIGATE("NAVIGATE", 12),
    /**
     * 商品推荐，动态创意客户直接传算好的推荐结果时使用
     * 参数不做限制
     * 《广点通默认支持，头条当做自定义事件处理》
     */
    PRODUCT_RECOMMEND("PRODUCT_RECOMMEND", 13),
    /**
     * 登录
     * 头条参数：String method (注册⽅方式 mobile、weixin、qq 等必须上传)，String isSuccess (是否成功，"1" 表示成功，必须上传)
     * 广点通参数不限制
     * 《广点通当做自定义事件处理，头条默认支持》
     */
    LOGIN("LOGIN", 14),
    /**
     * 停留时长统计(与 ON_PAUSE 结合使用，****仅头条 SDK 有效***)，需要在每个 Activity 的 onResume 方法中调⽤
     * <--参数类型--> Context
     * 《仅头条支持》
     */
    ON_RESUME("ON_RESUME", 25),
    /**
     * 停留时长统计(与 ON_RESUME 结合使用，****仅头条 SDK 有效***)，需要在每个 Activity 的 onPause 方法中调⽤
     * <--参数类型--> Context
     * 《仅头条支持》
     */
    ON_PAUSE("ON_PAUSE", 26),
    /**
     * 绑定账号
     * 头条参数：String type(账号类型),String isSuccess(是否成功,"1"表示成功)
     * 广点通参数不限制
     * 《广点通默认支持，头条当做自定义事件处理》
     */
    ACCESS_ACCOUNT("ACCESS_ACCOUNT", 18),
    /**
     * 完成节点（如教学任务、副本等）
     * 头条参数：String questID(节点 Id)，String name(节点名称)，String type(节点类型)
     * String number(节点编号)，String isSuccess (是否成功，"1" 表示成功)， String desc(节点描述)
     * 广点通参数不限制
     * 《广点通当做自定义事件处理，头条默认支持》
     */
    QUEST("QUEST", 16),
    /**
     * 付费渠道
     * 头条参数：String channel(付费渠道)，String isSuccess(是否成功，"1" 表示成功)
     * 广点通参数不限制
     * 《广点通默认支持，头条当做自定义事件处理》
     */
    ACCESS_PAYMENT_CHANNEL("ACCESS_PAYMENT_CHANNEL", 17),
    /**
     * 升级
     * 头条参数：String level (等级，如 "12"，"13")
     * 广点通参数不限制
     * 《广点通当做自定义事件处理，头条默认支持》
     */
    UPDATE_LEVEL("UPDATE_LEVEL", 15),
    /**
     * 设置用户唯一标识
     * 头条参数：String userUniqueId (用户标识)
     * 广点通参数不限制
     * 《广点通当做自定义事件处理，头条默认支持》
     */
    USER_UNIQUE_ID("USER_UNIQUE_ID", 19);
}

对于预定义事件的 JSONObject 参数，SDK 对 json 的 key 有固定格式要求（以下未列举出来的可自定义 key 的格式）：

XDADsActionTypeJSONObject json 参数说明(默认字符串类型)
REGISTERkey: "method" // 注册方式；
key: "isSuccess"(Boolean) // 是否成功（必须上传）
LOGINkey: "method" // 注册方式；
key: "isSuccess"(Boolean) // 是否成功（必须上传）
USER_UNIQUE_IDkey: "userUniqueID" // 用户唯一标识
QUESTkey: "questID" // 任务 ID
key: "questName" // 教学/任务/副本名称
key: "questType" // 任务类型
key: "questNo"(Integer) // 第几个任务
key: "isSuccess"(Boolean) // 状态
key: "desc" // 其他描述
UPDATE_LEVELkey: "level" (Integer) // 当前等级
VIEW_CONTENTkey: "contentType" // 商品类型
key: "contentName" // 商品名称
key: "contentID" // 商品 ID
ADD_TO_CARTkey: "contentType" // 商品类型
key: "contentName" // 商品名称
key: "contentID" // 商品 ID
key: "contentNum"(Integer) // 商品数量
key: "isSuccess"(Boolean) // 是否成功
INITIATE_CHECKOUTkey: "contentType" // 商品/内容类型
key: "contentName" // 商品/内容名称
key: "contentID" // 商品/内容 ID
key: "contentNum"(Integer) // 商品/内容数量
key: "isVirtualCurrency"(Boolean) // 是否使用虚拟货币
key: "virtualCurrency" // 虚拟货币（如"钻石"、"金币"等）
key: "currency" // 支付货币类型
key: "isSuccess"(Boolean) // 是否成功
PURCHASEkey: "contentType" // 商品/内容类型
key: "contentName" // 商品/内容名称
key: "contentID" // 商品/内容 ID
key: "contentNum"(Integer) // 商品/内容数量
key: "paymentChannel" // 支付渠道
key: "currency" // 货币币种
key: "isSuccess"(Boolean) // 是否成功
key: "currencyAmount"(Integer) // 金额
ACCESS_PAYMENT_CHANNELkey: "paymentChannel" // 支付渠道
key: "isSuccess"(Boolean) // 是否成功
ACCESS_ACCOUNTkey: "accountType" // 社交账号类型
key: "isSuccess"(Boolean) // 是否成功