腾讯优量汇 Android SDK 接入文档
Version:4.610.1480
概述
说明
本文档旨在帮助 Android 应用开发者在程序中快速植入腾讯优量汇开发者平台提供的广告。作为应用开发者,您只需要进行简单配置,就可以在您的应用中显示定制的广告。关于 SDK 的具体使用方法,请仔细阅读下面的文档。
背景
开发环境
- 操作系统:支持 Linux/Mac/Windows 系统,具体依赖开发者选择的 IDE
- 开发工具:支持 Android studio、Eclipse、Intellij
- 部署目标:接入优量汇流量的应用
- 支持设备:运行了 Android 4.0 以及以上系统的 Android 设备
- 接入方式:下载 aar 或 gradle。如使用 gradle,版本号需大于等于 4.370.1240,请参考下方:
implementation 'com.qq.e.union:union:版本号' // 普通版本
术语介绍
- APPID:媒体 ID,是您在腾讯优量汇开发者平台创建媒体时获得的 ID,这个 ID 是我们在广告网络中识别您应用的唯一 ID。
- POSID:广告位 ID,是您在腾讯优量汇开发者平台为您的媒体所创建的某种类型的广告位置的 ID。
权限申请
部分广告样式的接入需要权限,您可以联系腾讯优量汇运营进行了解和权限申请。在腾讯优量汇开发者平台新建广告位时您只能看到您有相应权限的广告位类型。
禁止优量汇SDK采集用户相关信息
此接口所有参数默认值是true,即同意优量汇SDK获取用户设备相关信息。
允许流量方设置此接口参数值为false,即禁止优量汇SDK获取用户设备信息。
目前支持参数为 "android_id"、"device_id"
示例代码如下:
Map<String, Boolean> params = new HashMap<>();
// 允许优量汇SDK采集android_id
params.put("android_id", true);
// 不允许优量汇SDK采集device_id
params.put("device_id", false);
GlobalSetting.setAgreeReadPrivacyInfo(params);
设置优量汇SDK转化优化信息
此接口所有参数默认值是true,即开启转化优化能力。
允许流量方设置此接口参数值为false,即关闭转化优化能力。
目前支持参数为"soate"
方法如下:
Map<String,Boolean> params = new HashMap<>();
// 唤起行为能力,用于设置应用安装完成后是否显示打开应用的提示弹窗,不设置或设置为true都显示打开应用弹窗,设置为false不显示弹窗,也不会自动打开应用
params.put("soate", false);
GlobalSetting.setConvOptimizeInfo(params);
广告位创建流程
在您的媒体通过审核后,可以在腾讯优量汇开发者平台选择“新建广告位”。
步骤说明:
- 1.在新建广告位之前,确保您已经下载最新版SDK并阅读完说明文档,了解如何在您的媒体中使用广告位 ID
- 2.选择需要嵌入广告的媒体名称。注意此处只可选择已通过审核的媒体
- 3.广告位名称用于区分媒体内设置的各个广告位,方便您在后台进行统一管理和查看数据报表;目前支持接入的广告类型包含:开屏广告、激励广告、插屏广告、 横幅(Banner) 广告、信息流广告、详情页插入广告、视频贴片广告等;接入方式包含优量汇渲染、开发者自渲染等
- 4.点击完成按钮以后即获得对应该广告位的 ID 号
- 5.成功得到广告位ID以后,您可以在应用代码内使用该ID进行广告联调测试(见“接入代码”部分)
- 6.通过测试后去掉测试代码部分(TestAd),即可发布带有优量汇广告位的 Android 应用
支持广告类型及对应接入方式及简介
优量汇支持以下几种广告类型,您可以根据开发需要选择合适的广告:
广告类型 | 简介 | 适用场景 |
---|---|---|
开屏广告 | 开屏广告以App启动作为曝光时机,提供5s的可感知广告展示。用户可以点击广告跳转到目标页面;或者点击右上角的“跳过”按钮,跳转到app内容首页。 | APP启动时 |
激励广告 | 指将短视频融入到app场景当中,成为app“任务”之一,用户观看短视频广告后可以得到一些应用内奖励。 | 常见于游戏内的广告样式,多出现在游戏的复活、登录等位置,或者网服类app的一些增值服务场景。建议开发者在分析媒体属性和功能的基础上,判断是否嵌入 |
插屏广告 | 插屏半屏是移动广告的一种常见形式,在应用流程中弹出,当应用展示插页式广告时,用户可以选择点按广告,访问其目标网址,也可以将其关闭,返回应用。插屏全屏广告:是移动广告的一种常见形式,在应用自然流畅结束时全屏弹出,当应用展示插页式广告时,用户可以选择点按广告,访问其目标网址,也可以将其关闭,返回应用。 | 在应用执行流程的自然停顿点,适合投放这类广告 |
横幅(Banner)广告 | Banner广告(横幅广告)位于app顶部、中部、底部任意一处,横向贯穿整个app页面;当用户与app互动时,Banner广告会停留在屏幕上,并可在一段时间后自动刷新。 | 常见的展现场景为:文章页末尾,详情页面底部,信息流顶部等。 |
信息流/详情页插入/视频贴片/沉浸式视频流 广告 | 各类贴合内容场景的广告类型。 | 适用于App 推荐列表(信息流)里、App 详情页内随内容呈现插入、在视频片头、片尾或随片播放等位置 |
开发者自渲染 | 您可自行定义广告布局样式和展示场景。 | APP信息流中、任何您希望展示广告的地方、APP中视频内容的框内插入 |