目录 1. 简介 准备工作 用户注册 取得广告位 ID 添加力美 Unity3D 资源文件 配置 Manifest 文件 SDK 功能说明 创建 Banner 广告..

Transcription

1 力美媒体主 Android SDK 使用说明 SDK Version: limei_android_sdk_ 北京力美广告有限公司

2 目录 1. 简介 准备工作 用户注册 取得广告位 ID 添加力美 Unity3D 资源文件 配置 Manifest 文件 SDK 功能说明 创建 Banner 广告 创建全屏广告 创建插屏广告 创建积分墙 设置积分及响应事件返回的文件 广告主激活 查询积分 减少积分 监听广告事件 数据统计... 11

3 4.1. 广告主和数据统计逻辑 数据统计 API 上线流程 力美 Unity3d SDK 使用技巧 常见问题 联系我们... 15

4 1. 简介 非常感谢您加入力美广告平台, 并且成为力美广告平台的合作开发者! 以下内容将帮助您完成在 Unity3D for Android 系统上与力美广告 SDK 的整合 Android_SDK_V2.7.0 支持 Android1.6(Level-4) 及以上版本 压缩包内容 名称 说明 Unity3D_UserGuide_Android_CN.pdf 开发者文档 Plugins 资源插件包 SampleApp 多个示例程序代码, 帮您迅速熟悉 SDK 的使用方式 2. 准备工作 2.1. 用户注册 进入力美官方网站 ( 页面点击 免费注册 按钮, 或在浏览器地址栏中直接输入 即可进入注册页面 填写好自己的邮箱 ( 作为登录账户 ) 密码及联系方式后, 提交 2.2. 取得广告位 ID 如果想在 APP 中使用力美的广告, 首先需要创建应用和获取相应广告位 ID(AdUnitID) 当新建应用之后, 添加广告位后即可获得广告位 ID, 如下图所示

5 点此处创建广告位 用此 ID 去配置 SDK 广告位 ID(AdUnitID) 是力美用来区分和识别不同广告类型的唯一标识, 开发者在登录力美开发者后台, 便 可创建广告位 新创建的广告位只有通过审核, 才会有相应的广告填充 如需帮助请联系客服人员, 联系方式看 联 系我们 首先, 把申请到的广告位 ID 加入到, Plugins/Android/res/values/string.xml 文件中 : <string name="bannerid">banner 的广告位 id</string> <string name="adwallid"> 广告墙的广告位 id</string> <string name="fullid"> 全屏广告的广告位 id</string> <string name="cid"> 广告主创意 id</string> 如没有某个 id 为空即可, 如 <string name="fullid"></string> 2.3. 添加力美 Unity3D 资源文件 Plugins: 开发过程中拷贝到 Unity3D 工程 Assets 下, 工程结构如下图 :

6 2.4. 配置 Manifest 文件 力美广告 SDK 需要 Internet 的连接已获取广告数据 因此, 开发者需要在当前程序的 AndroidManifest.xml 添加相应的必要的权限 如果您正使用 Eclipse, 请紧跟一下步骤 第一步, 在项目窗口中选中 AndroidManifest.xml 文件 ; 第二步, 双击或者按 F3 打开文件 ; 第三步, 选择 AndroidManifest.xml 中的标签来显示纯 xml 文本 ; 第四步, 在 <manifest></manifest> 标签之间插入一下代码 必选权限 <uses-permission android:name="android.permission.internet" /> <uses-permission android:name="android.permission.read_phone_state" /> <uses-permission android:name="android.permission.write_external_storage" /> <uses-permission android:name="android.permission.access_network_state" /> <uses-permission android:name="android.permission.access_wifi_state" /> 可选权限 从版本 开始,Limei SDK 已经全面支持富媒体标准 (ORMMA Level 2 以及 MARID 1.0) 丰富 的炫动广告, 交互广告, 基于位置服务的广告需要更多本地设备的权限来开启 以下授权添加后, 力美广告平 台将具有更好的人机交互体验和全新特性支持 关于 ORMMA 和 MARID 的新特性, 请参考 : 位置权限将使设备可以接收地理位置相关的广告 <uses-permissionandroid:name="android.permission.access_fine_location"/> 地图权限允许用户快速定位和查看目标地图 <uses-permissionandroid:name="android.permission.write_gservices"/>

7 电话和短信权限是让用户可以直接拨打广告中的电话和发送短信 <uses-permission android:name="android.permission.send_sms"/> <uses-permission android:name="android.permission.call_phone"/> 日程表权限可以方便用户记录和参与相关广告活动 <uses-permissionandroid:name="android.permission.write_calendar"/> 震动感应权限式互动广告的重要组成部分 <uses-permissionandroid:name="android.permission.vibrate"/> 允许一个程序获取信息有关当前或最近运行的任务 <uses-permissionandroid:name="android.permission.get_tasks"/> 此外为了使积分墙正常工作, 开发者需要在 AndroidManifest.xml 的 <application> 标签内加入如下声明 <activityandroid:name="cn.immob.sdk.util.lmactionhandler"></activity> <activityandroid:name="cn.immob.sdk.browseractivity"></activity> <serviceandroid:name="cn.immob.sdk.net.downloadservice"></service> <receiver android:name="cn.immob.sdk.brocastreceiver.appchangebrocastreceiver"> <intent-filter> <action android:name="android.intent.action.boot_completed" /> <action android:name="android.intent.action.package_added" /> <data android:scheme="package" /> </intent-filter> </receiver> 3. SDK 功能说明 3.1. 创建 Banner 广告 Banner 的创建非常简单, 只需参考一下步骤即可以代码方式完成广告添加操作 1. 在另一个页面加载广告 banner 显示在顶部 : jo.call("addbannerview",true,false, dc483fd9e819fbc9ecc06594ddc3d96a );

8 2. 在当前页面加载广告 banner 显示在顶部 : jo.call("addbannerview",false,false, dc483fd9e819fbc9ecc06594ddc3d96a ); 1. 在另一个页面加载广告 : jo.call("addbannerview",true,true, dc483fd9e819fbc9ecc06594ddc3d96a ); 2. 在当前页面加载广告 banner 显示在底部 : jo.call("addbannerview",false,true, dc483fd9e819fbc9ecc06594ddc3d96a ); 3.2. 创建全屏广告 和 Banner 广告一样, 全屏广告的创建过程非常简单 只需要 : //1. 在另一个页面加载广告 : jo.call("addadwallview",true, 7d89fb8a7e3f1e6915ee230e6b ); //2. 在当前页面加载广告 : jo.call("addadwallview",false, 7d89fb8a7e3f1e6915ee230e6b ); 3.3. 创建插屏广告 jo.call("addhalffbannerview", e996b55bdd64b3f1d1a7b76a4 ); 3.4. 创建积分墙 //1. 在另一个页面加载广告 :

9 jo.call("addfullview",true, 0f470c7647f9a7b0550d562638fcb577 ); //2. 在当前页面加载广告 : jo.call("addfullview",false, 0f470c7647f9a7b0550d562638fcb577 ); 3.5. 设置积分及响应事件返回的文件 1. 未设置默认为 Main Camera jo.call("setcamera","camera"); 3.6. 广告主激活 激活广告的过程非常简单, 只需要修改创意 id 可以完成激活 3.7. 查询积分 //1. 查询积分 jo.call("getscore", 0f470c7647f9a7b0550d562638fcb577 ); //2. 积分返回参数 str 为返回的积分, 当 str 大于等于 0 时为返回的积分数,str 为 -1 时为查询错误 voidqueryscore(string str) { Score = str; 3.8. 减少积分 //1. 减少积分 AndroidJavaClassjc = new AndroidJavaClass( com.unity3d.player.unityplayer ); AndroidJavaObjectjo = jc.getstatic<androidjavaobject>( currentactivity ); jo.call( reducescore, 20, 0f470c7647f9a7b0550d562638fcb577 ); //2. 减少积分状态返回参数 str 为返回的查询积分的状态, 当 str 等于 0 时为减少积分成功,str 为 -1 时为减少积分失败 voidreducescore(string str)

10 { educescore = str; 3.9. 监听广告事件 Limei SDK 提供了丰富的事件回报机制来通知开发者相应的广告状态变化 注意 : 广告事件回报机制仅限于在当前页面打开的 banner, 广告墙, 全屏广告, 即调用广告第二个参数为 false 时 在新建页面打开的暂不支持 voidonadreceived() { voidondismissscreen() { voidonfailedtoreceivead(string ecode) { voidonleaveapplication() { voidonpresentscreen() { 此外,AdListener 中定义的事件将会在以下的情况下被调用到 事件方法名称 场景 onadreceived 1. 广告请求成功

11 onfailedtoreceivead 1. 广告请求失败 2.AdUnitID 对应的广告位被关闭 3. 当前无可用网络 ondismissscreen 1. 当全屏,banner, 积分墙, 视频广告被用户关闭时 2. 当广告位被广告创意关闭或隐藏时 onleaveapplication 1. 因为广告点击打开外置浏览器离开 APP 时 2. 因为广告点击打开系统原生地图程序离开 APP 时 3. 积分墙内直接启动已经安装的程序 onpresentscreen 1. 当广告位被广告创意恢复显示时 2. 当广告位被开启显示时 3. 因为广告点击在程序内打开地图视图时 4. 数据统计 4.1. 广告主和数据统计逻辑 力美数据统计 API 不但为广告主提供软件激活判定, 同时也可以为一般开发者提供详细的用户使用状态的数据 需要知道当前网络的连接情况并且需要联网获取一些数据 因此, 需要保证当前程序的 AndroidManifest.xml 中有必要的权限 <uses-permission android:name="android.permission.internet" /> <uses-permissionandroid:name="android.permission.access_network_state" /> <uses-permission android:name="android.permission.access_wifi_state" /> 4.2. 数据统计 API 数据统计 API 使用简单, 只需要参考以下步骤就可以完成 App 在服务器端的统计请求 需要注意的是该方法 在应用程序生命周期内 ( 进入 / 退出 ) 只可以被调用一次, 多次调用无效

12 注意 : 广告主需要保证以下代码被嵌入到程序的执行主逻辑当中, 并保证其在程序启动后最短的时间内被调用 到 注意 : 对于已经注册为力美开发者的媒体, 如果预期会成为力美积分墙的广告主, 可以预先将统计逻辑置入已 发布的 APP 中 (cid 可以取空字符串, 只需改变创意 id 即可 ) 这样在推广时可以节省更新和审核的时间 4.3. 上线流程 当广告主完成数据统计 API 的整合, 并且将 App 发布至 Google Play 或需要推广的平台, 广告主需要将相关 下载页面链接发送给力美客服 service@limei.com 邮箱, 力美工作人员会在 3 个工作日内审核你的作品, 如果审 核通过,APP 会正式出现在广告墙上 5. 力美 Unity3d SDK 使用技巧 这里讲解关于 sdkunity.jar 包是如何生成的 因为力美 sdk 从 2.7 以后增加了对插屏广告的支持, 同时插 屏广告的使用方式也与其他类型广告 (banner 积分墙 全屏广告 ) 不太一样, 如果开发者想自己生成 /bin/sdkunity.jar, 只需要参考 LiMeiUnity 工程稍做修改即可 工程目录如下 :

13 插屏广告的展示方式 : 1. 创建力美 sdk 对象并添加到你的容器中 ImmobView immobview = new ImmobView(context, 你在力美平台申请的广告位 ID ); // 如果你需要上传其他参数, 请填写到 hashtable 中 // HashTable params = new HashTable(); // params.put( accountname, zhangsan ); // params.put( channelid, abcdefgaaa ); // immobview.setuserinfo(params); Layout.addView(immobView); 2. 展示广告 If(immobView.isAdReady()){ immobview.display(); else{ // 处理你的其他业务逻辑 编写完成后将工程 src 目录下源代码打成 jar 文件, 并拷到 /Plugins/Android/bin 目录下即可 Ps:

14 1. 如果你的工程 src 目录下源代码引用了资源文件 (Res 目录下 ), 需要将 res 目录下的文件拷贝到 /Plugins/Android/res 目录下 2. 如果你需要在 AndroidManifest.xml 增加新的配置, 需要将新增的配置也一同拷贝到 /Plugins/Adnroid/AndroidManifes.xml 中 6. 常见问题 Q: 什么是 AD_Unit_ID? A:AD_Unit_ID 是力美广告系统内区分每个广告位的唯一标识, 它由开发者在创建应用广时创建 一旦建立, 其和 某一具体的广告类型将永久绑定 Q: ImmobSDK 最低支持的 Android 版本是什么? A:ImmobSDK 可以支持 Android1.6(Level-4) 及以上版本 Q: 为什么我的程序在 Android2.3 的模拟器上崩溃了? A:ImmobSDK 基于 WebView 和 JS 脚本通信技术构建, 但由于 Android2.3 的模拟器上 JS 脚本和本地代码通讯 实现存在问题 致使 ImmobSDK 的很多功能无法再 2.3 模拟器上完成 建议开发者在其他版本的模拟器上完成调 试 更多信息请参考 : Q: 为什么程序安装后第一次开启广告特别耗时? A: ImmobSDK 采用先进的预缓存 压缩技术来保证每次开启广告时的效率, 但因为预缓存技术的引用 广告位基 础框架会被在第一次加载时下载, 所以导致额外的时间开销 但此下载和操作, 为用户在日后的使用中提供了更加 完美和快速的体验 Q: 为什么我在模拟器上积分墙只能显示框架和背景, 无法刷新出内容? A: 由于服务器端的限制,ImmobSDK 在模拟器上运行时只会显示积分墙的基础框架 开发者只需把 APK 上传到 真机上运行, 或进行真机 OTA USB 调试 即可显示完整广告墙

15 Q: 我可以控制独立的广告请求么? A:ImmobSDK 采用高度集成化的广告请求策略, 所有的内部请求已经完整的封装与 js 框架内部 无需单独控制 Q: 我已经初始化并且开启积分墙了, 同时也对 SDK 设置了网游账号, 但还是在查询积分时返回错误 ( 用户不存在 )? A: 积分墙的独立用户创建于该用户第一次点击积分墙上的应用时, 在此之前所有该用户的积分查询和消费请求都因 为缺少数据而无法返回 7. 联系我们 感谢您的阅读, 如果您在阅读完本文档以后还有问题, 可以通过以下方式联系我们 : 邮箱 :service@immob.com 电话 :+86 (10) QQ: