SDK接入配置-Android集成文档-开发测试-穿山甲广告平台

帮助中心

中文

后可查看全部文档

帮助文档

新手引导

合作注册

流量管理

业务规范

开发测试

GroMore

电商联盟

内容输出

闭环电商

财务结算

开发测试/Android集成文档/SDK接入配置

SDK接入配置

最近更新 2026-05-11 16:19:57

一、穿山甲SDK下载与接入

请您注册登录穿山甲后台，在后台中接入中心下载穿山甲 SDK并接入，下载具体入口如下：

在开发者平台进入“接入与测试”-“广告变现”，可下载对应SDK并查看接入文档，点击跳转

二、工程配置

此版本SDK不适用于中国以外的安卓商店/渠道。开发者如果有海外流量对接需求，可前往Pangle官网咨询，以便获取到正确的海外专属SDK版本。

1. 注意事项

68版本起，穿山甲SDK支持minSdkVersion为24，即兼容的最小手机系统为7.0，7.0以下手机运行穿山甲SDK将会初始化和加载广告失败，minSdkVersion相关工程编译问题可以参考如下：

若开发者主项目minSdkVersion >= 24，可正常使用，忽略该项。
若开发者主项目minSdkVersion < 24，编译过程遇到 Manifest merger failed : uses-sdk:minSdkVersion xx cannot be smaller than version 24 declared in library csj相关库 /Users/xxx/AndroidManifest.xml问题，可参考以下2种解决方案，选择其一即可，也可参考官方解决。

修改主项目的最低版本minSdkVersion为24即可解决
主项目AndroidManifest.xml调整tools : overrideLibrary标签解决，如果开发者主项目清单已经有tools.overrideLibrary标签，则在已有包名后，增加穿山甲相关库名，并以逗号隔开，如果主项目清单没有该标签，则新增该标签再添加相关库名

复制

在项目的build.gradle中添加SDK下载库依赖：implementation 'com.squareup.okhttp3:okhttp:3.12.1'

2. SDK集成

我们建议您使用Gradle依赖更轻松地管理 Android Studio 项目的库依赖，而不是直接下载并安装 SDK。

版本	v7.6.1.2
MD5值	8c34b9cf2943242cf7a883690118c284

2.1 方式一：mave集成

步骤一：添加仓库

AGP版本要求：AGP版本要求>= 3.3.3 ，开发者可根据自身情况进行升级

在project级别的build.gradle文件中添加Maven的引用

复制

步骤二：添加依赖

在主module的build.gradle文件添加SDK依赖，sdk版本请以穿山甲平台接入中心披露的版本号为准

复制

2.2 方式二：手动集成

导入aar及SDK依赖的jar包：将平台下载的SDK解压后获得的open_ad_sdk.aar复制到Application Module/libs文件夹(没有的话须手动创建), 并将以下代码添加到您app的build.gradle中：

复制

2.3 AndroidManifest配置

2.3.1 权限声明

SDK隐私协议及获取用途请点击查看详情 link

复制

注意: 穿山甲SDK不强制获取以上权限，即使没有获取可选权限SDK也能正常运行；建议在广告请求前合适的时机调用SDK提供的方法获取以上权限，将帮助穿山甲优化投放广告精准度和用户的交互体验，提高eCPM。

复制

2.3.2 provider配置

为不影响下载类型广告使用，无论APP处于任何阶段provider都需要在清单文件中正常配置，如果您的应用需要在Anroid7.0及以上环境运行，请在AndroidManifest中添加如下代码：

复制

在res/xml目录下，新建一个xml文件file_paths，在该文件中添加如下代码：

复制

若SDK版本<73xx版本，为不影响到广告的转化及收益，单进程或多进程请务必在清单文件中配置xxx.TTMultiProvider，73xx及以上版本则不需要配置TTMultiProvider

复制

${applicationId} 必须与开发者包名保持一致，否则会引发崩溃问题
为了适配下载和安装相关功能，在工程中引用的包 com.android.support:support-v4:28.0.0，建议使用28.0.0以及以上版本

2.3.3 运行环境配置

2.3.3.1 系统版本

广告SDK可运行于Android 7.0 (API Level 24) 及以上版本。<uses-sdk android:minSdkVersion="24" android:targetSdkVersion="30" />

如果开发者声明targetSdkVersion到API 23以上，请确保调用本SDK的任何接口前，已经申请到了SDK要求的所有权限，否则SDK部分特性可能受限

2.3.3.2 支持架构

75xx及以上：SDK默认支持arm64-v8a

75xx以下：SDK默认支持armeabi-v7a,arm64-v8a两种架构

如果有其他架构（armeabi架构）需求，请联系技术支持同学获取；

您可以在应用中的build.gradle中使用abiFilters选择支持的架构。如下所示：

复制

2.3.3.3 代码混淆

如果您需要使用proguard混淆代码，需确保不要混淆SDK的代码。以aar包里的混淆文件为准， SDK代码被混淆后会导致广告无法展现或者其它异常

2.3.3.4 资源混淆

从平台下载的SDK包中whiteList.txt 白名单上的资源不支持混淆，未成功 keep 白名单内的资源，会导致穿山甲部分资源被清理，进而出现广告无法展示、崩溃等问题。

三、初始化

注意事项

进程设置：SDK支持多进程，主进程必须初始化，其他进程若有使用到穿山甲广告业务也需要初始化(初始化包括init和start两部分)，单进程多次初始化SDK以第一次初始设置的信息为主。若项目是单进程supportMultiProcess必须更改为false；若项目是多进程，supportMultiProcess则需要设置true。多进程中如果每个进程中都需要展示广告，则每个进程都需进行SDK的初始化操作；多进程涉及WebView的使用，用户想要使用自己的数据路径，可以在SDK初始化之前调用WebView.setDataDirectorySuffix()判断多进程方法：a、穿山甲sdk初始化，b、穿山甲广告获取，c、穿山甲广告展示这三个关键点的调用在不同进程则为多进程，多进程效率不如单进程高，如非必要尽量不要使用多进程开关，
初始化配置TTAdSdk.init仅进行初始化，不会获取个人信息, 如果要展示广告，需要再调用TTAdSdk.start方法appId为必填内容(应用ID：5开头的7位数字)，若appid是通过服务端下发的，那么在初始化前需要做不为空的判断。接入过程中强烈建议双端分别使用各自的应用ID进行测试，否则可能会影响收益。allowShowNotify(true) 默认为true，即允许sdk展示通知栏提示，若设置为false则会导致通知栏不显示下载进度，存在违规风险，请勿随意更改。
provider配置无论单进程还是多进程都必须配置穿山甲所需provider无论平台应用处于测试状态还是正式状态都需要配置providerSDK版本<V73xx，为了不影响广告的转化及收益，请务必在清单文件中配xxx.TTMultiProvider
混淆配置如果您的应用对资源进行混淆（如andResGuard），请不要混淆穿山甲的任何资源，防止资源找不到而发生崩溃的问题。SDK压缩文件内whiteList.txt 白名单上的资源不支持混淆，开发者在SDK更新迭代过程中需要重新检查一遍白名单内容。

1. 步骤一：初始化SDK

TTAdSdk.init仅进行初始化，不会获取个人信息，需要在隐私协议后调用TTAdSdk.start方法及广告请求

复制

2. 步骤二：启动SDK

复制

3. 接口说明

3.1 初始化

穿山甲SDK初始化API必须在主线程中调用，穿山甲会将初始化操作放在子线程执行。

复制

调用TTAdSdk.start后，可以通过TTAdSdk.isSdkReady判断初始化状态

复制

初始化失败状态码

错误码	说明
4000	本地执行API错误导致初始化错误码
4201	1. SDK需要依赖 appcompat-v7 库；复制 implementation "com.android.support:appcompat-v7:28.0.0" 2.架构不匹配时会提示该错误，SDK默认支持armeabi-v7a,arm64-v8a两种架构； 3. 若为androidx项目，请检查androidx及gradle相关配置是否正确；

3.2 TTAdManager对象

TTAdManager对象为整个SDK的入口接口，可用于广告获取、权限请求、版本号获取等

复制

3.2.1 接口说明

方法	返回类型	说明
createAdNative(Context context)	TTAdNative	创建广告对象TTAdNative
requestPermissionIfNecessary(Context context)	void	部分机型需要主动申请权限，如 READ_PHONE_STATE权限
tryShowInstallDialogWhenExit(Context context, final ExitInstallListener listener)	boolean	退出时尝试显示"提示安装app"对话框：true显示对话框；false不显示对话框
getSDKVersion()	String	获取穿山甲sdk版本号
setThemeStatus(int themeStatus)	void	设置主题类型，0：正常模式；1：夜间模式；默认为0；传非法值，按照0处理
getThemeStatus()	int	获取当前主题类型

3.3 隐私协议配置

3.3.1 使用示例

复制

3.3.2 接口说明

注意事项

重写getTTLocation()之前需要设置isCanUseLocation()
重写getDevImei()之前需要先设置isCanUsePhoneState()

方法	返回类型	说明
isCanUseLocation()	boolean	是否允许SDK主动使用地理位置信息： true可以获取，false禁止获取。默认为true
getTTLocation()	TTLocation	地理位置参数，当isCanUseLocation=false时，可传入地理位置信息，穿山甲sdk使用您传入的地理位置信息
isCanUsePhoneState()	boolean	是否允许SDK主动使用手机硬件参数，如：imei true可以使用，false禁止使用。默认为true
getDevImei()	String	当isCanUsePhoneState=false时，可传入imei信息，穿山甲sdk使用您传入的imei信息
isCanUseWifiState()	boolean	是否允许SDK主动使用ACCESS_WIFI_STATE权限 true可以使用，false禁止使用。默认为true
isCanUseWriteExternal()	boolean	是否允许SDK主动使用WRITE_EXTERNAL_STORAGE权限 true可以使用，false禁止使用。默认为true
getDevOaid()	String	开发者可以传入oaid 信通院OAID的相关采集——如何获取OAID： 1. 移动安全联盟官网http://www.msa-alliance.cn/ 2. 信通院统一SDK下载http://msa-alliance.cn/col.jsp?id=120
alist()	boolean	是否允许SDK主动获取设备上应用安装列表的采集权限 true可以使用，false禁止使用。默认为true
isCanUseAndroidId()	boolean	是否允许SDK降低ANDROID_ID的采集频率默认true 允许， false 不允许
isCanUsePermissionRecordAudio()	boolean	是否允许SDK在申明和授权了的情况下使用录音权限 return true 允许 false 不允许
Map<String,Object> map = new HashMap<String,Object>(); map.put（"motion_info",0） return map;	Map	支持传入"motion_info"字段表示是否允许采集传感器。 0不允许采集，1允许采集，传其他值或不实现该协议方法默认为采集

3.4 广告配置

3.4.1 个性化广告设置

开发者可以调用接口，向用户提供退出个性化广告的能力。退出后看到的广告相关度会降低，详细使用请参考个性化广告设置

3.4.2 屏蔽未成年广告限制

开发者通过穿山甲提供的接口回传的用户年龄设置需配合穿山甲媒体平台配置使用，两者缺一不可，否则无法生效。详细使用请参考屏蔽未成年广告限制

本篇目录

产品中心

友情链接

解决方案

了解更多

学习中心

帮助中心

关注我们

服务邮箱

邮箱：union_service@bytedance.com