MIMO COMMON SDK 集成文档

v5.1.7_20220228

一、SDK介绍

米盟广告SDK (Android) 是由小米联盟官方推出,帮助开发者在安卓平台上轻松实现广告变现的软件工具包。

目前米盟广告SDK提供各种广告形式给客户端集成,SDK支持的广告形式包括:

二、SDK 接入说明

1、接入方式

1> aar接入

将aar文件的SDK复制到 Application Module/libs 文件夹(没有的话需手动创建),并将以下代码添加到 Application Module/build.gradle中

2> maven接入

第一步,在您工程的build.gradle添加如下maven配置项

credentials中的内容是米盟为开发者提供用于访问maven仓库的认证信息

第二步,添加完成之后,在build.gradle添加米盟SDK依赖项

2、申请应用APP ID 和 广告位ID

开发者需要前往米盟SPP,注册开发者账户,并创建应用。相关帮助请见:点击此处

3、接入注意事项

  1. 请使用小米手机调试,且仅支持Android4.4以上的系统
  2. 在测试环境调试成功后,替换为自己的广告位id,并关闭调试环境,即可申请上架

三、接入准备

1、AndroidManifest.xml 配置

权限配置

如果app目标sdk版本是23及以上,需要在程序中显式申请权限,例子如下:

适配Android 9.0,由于部分广告下载地址依然是http链接,因此需要在这里增加以下声明

其中network_security_config内容如下

SDK需要的provider声明:

其中 file_paths.xml 文件内容如下

若您的项目中本身也需要fileProvider,可与上述的provider合并。合并时在file_paths.xml 中加入文件路径即可。

2、build.gradle配置

3、混淆配置

如果您需要使用proguard混淆代码,需确保不要混淆SDK的代码。请在混淆文件中添加如下配置:

4、初始化SDK

在使用SDK请求广告之前,您需要初始化联盟SDK。 调用如下接口:

注:SDK初始化接口必须在用户选择同意隐私协议后调用,若用户拒绝隐私协议,不可调用该广告SDK初始化接口

初始化接口说明

fail code说明

code含义
4000本地执行API错误导致初始化错误码
5000传入context为null

以下为调试开关,上线需关闭,默认均为false

SDK日志的prefix关键字为zeus-mimo

当debug开关关闭的情况下,只会输出error日志

当debug开关打开时,可以输出更多调试日志

注意:开发者在接入遇到问题时,如果需要协助排查,请提供完整的系统log日志

四、具体广告接入方式 (具体可参考demo)

1、BANNER 广告

请求广告

展示广告

展示广告, 支持等比缩放,bannerViewScale取值范围(0,1]

销毁广告,在不需要广告的时候进行销毁

相关接口

2、插屏广告(图片&全屏视频&半屏视频)

新加插屏半屏视频广告类型,已经创建了广告位的开发者需要在后台自己勾选新的预算类型可增加收入,新创建广告位的开发者会默认勾选图片和视频预算。

请求广告

展示广告

销毁广告,在不需要广告的时候进行销毁

相关接口

3、激励视频广告

请求广告

展示广告

销毁广告,在不需要广告的时候进行销毁

相关接口

4、开屏广告

请注意:暂不支持SDK内竖版开屏广告类型,如您有竖版开屏的广告需求,请根据SSP后台提示启动系统开屏广告位

加载并展示广告

销毁广告

相关接口

5、原生模板广告

请注意:信息流广告在V5.0.0版本起升级为原生模板广告,支持个性化调整模板样式:

请求广告

展示广告

销毁广告

相关接口

6、原生自渲染广告

自渲染广告需明确标示广告来源,小米广告logo文件详见压缩包png文件

请求广告

广告数据对象接口说明

销毁广告,在不需要广告的时候进行销毁

相关接口

7、原生视频

请求广告

注册广告行为监听

registerInteraction方法及参数说明

获取广告视图

销毁广告

当您在不需要使用广告时,销毁广告,并释放资源

控制是否静音播放

8、个性化推荐广告开关设置

注意:默认为打开个性化推荐广告开关,此设置是时时生效,可以在任何地方设置

1、打开个性化推荐广告

MimoSdk.setPersonalizedAdEnabled(true);

2、关闭个性化推荐广告

MimoSdk.setPersonalizedAdEnabled(false);

五、SDK调试

开发者接入SDK时,应用包可能还未上架应用商店,在接入的时候,建议使用demo中的测试广告位进行调试,保证接入方式无问题。

测试使用的appid:2882303761517518052

广告类型测试广告位ID
横幅802e356f1726f9ff39c69308bfd6f06a
插屏半屏图片(横版)1d576761b7701d436f5a9253e7cf9572
插屏半屏图片(竖版)67b05e7cc9533510d4b8d9d4d78d0ae9
插屏半屏视频(横版)b7c62fa1f3db17b661e3adc650414f41
插屏半屏视频(竖版)7844b678553cc3f3b9b9048a48f145a4
插屏半屏图片和视频(横版)7b6435ad4d1e6d87ddba2415de6ba65b
插屏半屏图片和视频(竖版)eda5f9bcf641d588758b27b290d8b4f1
全屏插屏视频(横版)9b31b19c061a4db0d5f4f004cf16c92d
全屏插屏视频(竖版)ea7b05ddc1a85d3d04ab0231b3b5e4bb
激励视频广告(横版)17853953c5adafd100f24cd747edd6b7
竖版激励视频(竖版)92d90db71791e6b9f7caaf46e4a997ec
横版开屏94f4805a2d50ba6e853340f9035fda18
原生模板-上文下图4966931579570a31c70269f560e9577e
原生模板-左文右图e8cad3a962d8f5ccb3e42a5c2427107d
原生模板-左图右文(A版)4cc5ca1fa86d05c3c9dbec05ce5bb1b8
原生模板-左图右文(B版)8577377ac0a045a5187a5506f3cf6ba6
原生模板-上图下文(大图)8f02fd1f100b57f536da160a84fa95a6
原生模板-上图下文(组图)9d72e47b9640044d1f6bcbd4d3277d19
原生模板-横版视频模板ffc009779b4a62177fffe3d594bb35ff
自渲染大图(仅图片)702b6a3b2f67a52efd3bdbf51fbef5fe
自渲染大图(仅视频)737fd8fce83832ffac1da2244d24add5
自渲染——大图(图片+视频混出)270c1630710a858d633aaf752025eae2
自渲染——小图60d2a98004f3a2a3625a1665796e0ebb
自渲染——组图c020c2cbc40301a2a18fe32977bddcaa
如果接入能正常显示广告,则说明广告接入无问题。此时替换成自己的appid和广告位id,并关闭调试环境即可见到广告展现。 

六、错误码

code含义备注
300001广告位不存在请确认广告位是否是开启状态
300002广告位在米盟SSP被暂停开发者关闭了广告位
300003upId不存在 
300004广告位被加入黑名单通常是因为有作弊嫌疑,请联系米盟解决
300005应用在米盟SSP被暂停开发者暂停了应用下所有广告位
300006应用被加入黑名单通常是因为有作弊嫌疑,请联系米盟解决
300007应用不存在确认广告位的应用信息是否正确
300009应用未上架 
100401被联盟投放限制过滤根据开发者在SSP后台设置的屏蔽策略屏蔽广告
100402请求包名与注册包名不一致请求包名与注册包名不一致将不返回广告
101101广告位内部解析错误 内部错误请联系米盟解决
101102内部错误请联系米盟解决
101103内部错误请联系米盟解决
101104内部错误请联系米盟解决
300215频控限制更换调试设备解决
300216请联系米盟解决请联系米盟解决
300217请联系米盟解决请联系米盟解决
300218请联系米盟解决请联系米盟解决
300220请联系米盟解决请联系米盟解决
300221请联系米盟解决请联系米盟解决
300222请联系米盟解决请联系米盟解决
300223请联系米盟解决请联系米盟解决
300224请联系米盟解决请联系米盟解决
300225请联系米盟解决请联系米盟解决
300226请联系米盟解决请联系米盟解决
300227请联系米盟解决请联系米盟解决
300228请联系米盟解决请联系米盟解决
300217请联系米盟解决请联系米盟解决

如根据以上的解决方案仍未解决问题,可开启debug调试环境,获取报错日志,放到txt文件中提供给我们,不用做任何tag筛选。

使用调试环境时,请使用测试广告位id和测试appid,正式环境广告位id和测试环境广告位id只能在相应环境下使用,不能混用。测试环境广告位id在本文第五节提供,正式环境广告位id在您的米盟账户中相应媒体下创建,正式环境中,不同媒体的广告位的广告位id不能混用。

以下为开启调试环境的方式

上架提审前,必须关闭调试开关,否则无法正常计费,示例:

可将问题截图与报错日志等邮件至mi-ssp@xiaomi.com,会有专人进行处理。

如有个人信息查询或删除等要求也可以发邮件到mi-ssp@xiaomi.com