快速接入
本文介绍如何快速接入 XDSDK。
申请 XD Client ID
为正常使用 XDSDK 的功能，需申请开通应用，请按照 XDSDK 需求及流程规范 进行申请。还需要在 TapTap 开发者后台 配置安卓包名、安卓签名文件 MD5、iOS bundleId 后才可以使用 TapTap 登录对应平台，否则会报 signature not signed 错误。
项目配置
为保证 XDSDK 的功能一致性，需要添加 XDConfig.json 文件进行游戏的参数设置，以下是 XDConfig.json 文件的模版及说明。
提示
XDConfig.json 的内容需要去除注释，文件内容需遵循 JSON 数据的格式及语法，否则可能会出现编译时或运行时的问题。建议通过 json.cn 进行格式检查。
{
"region_type": "CN", // 必填：国内:CN, 海外:Global 固定值
"client_id": "***", // 必填：XD 平台申请的 XD client id，必填，有可能和 Tap client Id 不一样
"app_id": "***", // 必填：XD 平台申请的 app id
"idfa_enabled":false, // 必填：控制 iOS 平台上是否收集 IDFA 数据，true: 收集，false: 不收集
"game_name":"***", // 可选：国内授权前置显示的游戏名，不加的话会默认读取应用配置
"tapsdk": { // 必填：TapSDK 参数
"client_id": "***", // 必填：游戏在 TapTap 开发者中心的 client id
"client_token": "***", // 必填：游戏在 TapTap 开发者中心的 client token
"server_url": "***", // 必填：游戏在 TapTap 开发者中心域名配置中的服务器地址
"db_config": {
"enable": true, // 必填：是否开启 TapDB 模块，true: 开启，false: 关闭
"channel": "TapTap", // 必填：渠道信息
"game_version": "1.***.**" // 必填：游戏版本号
},
"permissions": [
"public_profile", // 必填
"email", // 国内不能加，海外必须
"phone", // 海外不能加，国内必须
"user_friends" // 可选：如果您有好友相关的需求，可以加上这个权限
]
},
"logout_url": "***", // 必填：账号注销访问链接，否则打开注销页面空白, 国内：https://logout-xdsdk.xd.cn, 海外：https://logout-xdsdk.xd.com
"web_pay_url": "***", // 必填：Android 网页支付访问链接，国内：https://sdkpay.xd.cn，海外：https://sdkpay.xd.com
"webpay_url_for_pc": "***", // 必填：PC 网页支付访问链接。国内：https://sdkpay.xd.cn，海外：https://sdkpay.xd.com
"report_url": "***", // 可选：如果游戏使用 TapSupport([TapSupport 接入请参考](https://developer.taptap.cn/docs/sdk/tap-support/features)) 作为客服系统，则可不填。否则请联系我们获取参数
"apple": { // 可选: PC 和 Android 上的 Apple 授权参数，参数请联系 PMO 获取
"service_id":"***"
},
"google": { // 可选： Google 参数
"CLIENT_ID": "***", // iOS Google 授权参数，格式为 ***.apps.googleusercontent.com
"CLIENT_ID_FOR_ANDROID": "***", // Android Google 授权参数，格式为 ***.apps.googleusercontent.com
"CLIENT_ID_FOR_PC": "***" // PC Google 授权参数 ，格式为 ***.apps.googleusercontent.com
},
"wechat": { // 可选： 微信参数
"app_id": "***",
"universal_link":"***"
},
"qq": { // 可选： QQ 参数
"app_id": "***",
"universal_link":"***"
},
"weibo": { // 可选： 微博参数
"app_id": "***",
"universal_link":"***"
},
"xhs": { // 可选： 小红书参数
"app_id_ios": "***",
"app_id_android": "***",
"universal_link":"***"
},
"douyin": { // 可选： 抖音参数
"app_id": "***"
},
"aliyun": { // 可选： 手机号一键登录和推送参数
"phone_auth_token_ios":"***",
"phone_auth_token_android":"***",
"push_key_ios":"***",
"push_secret_ios":"***",
"push_key_android":"***",
"push_secret_android":"***"
},
"ad_config": { // 可选：广告分包埋点配置
"tt_config": { // 可选：今日头条广告配置
"app_id": "123456",
"app_name": "Demo",
"ios_enable" : false // 可选，今日头条 iOS SDK 开关，默认关闭
},
"gdt_config": { // 可选：腾讯广点通配置
"user_action_set_id": "***", // 可选：在 DMP 上获得的行为数据源 ID
"app_secret_key": "***" // 可选：在 DMP 上获得的 AppSecretKey
}
},
"facebook": { // 可选：Facebook 参数
"app_id": "***",
"client_token": "***",
"permissions": [
"public_profile", // 必填
"email", // 必填
"user_friends" // 可选：如果您有好友相关的需求，可以加上这个权限
]
},
"line": { // 可选：Line 参数
"channel_id": "***"
},
"twitter": { // 可选：Twitter 参数
"consumer_key": "***",
"consumer_secret": "***"
},
"firebase": { // 可选： Firebase 埋点控制，需要的话填 true ，且需要从 Firebase 官网后台下载对应的 plist 或 json 配置文件加到工程内
"enableTrack": true
},
"adjust": { // 可选： ADJust 参数
"app_token": "***",
"events": [ // 必填： ADJust 事件必须提前配置
{
"event_name": "eventName1",
"token": "token1"
},
{
"event_name": "eventName2",
"token": "token2"
}
]
},
"appsflyer": { // 可选： AppsFlyer 参数
"app_id": "***", // iOS 的苹果 App Store Id(如 1423432423)
"dev_key_ios": "***",
"dev_key_android": "***"
}
}
ad_config 配置说明
"ad_config" 为 Android 平台上为分包/广告包功能的配置选项，不使用该功能时可不进行配置。详细的配置值请参考分包广告包功能介绍中的广告包埋点 SDK 说明
| key | value 说明 | |
|---|---|---|
| type | 广告埋点类型，值为："TT" 或 "GDT" | |
| tt_config | 今日头条广告 SDK 的配置，在 "type" 为 "GDT" 时，可不填，如填写时该配置无效 | |
| app_id | 今日头条广告 SDK 的 appID | |
| app_name | 今日头条广告 SDK 的 appName | |
| gdt_config | 腾讯广点通 SDK 的配置，在 "type" 为 "TT" 时，可不填，如填写时该配置无效 | |
| user_action_set_id | 在 DMP系统 上获得的行为数据源 ID，可不填 | |
| app_secret_key | 在 DMP系统 上获得的AppSecretKey，可不填 |
集成 XDSDK
原生接入方式：
Unity 接入方式：
UE 接入方式：