资源位 SDK(Android)
最低兼Android版本4.2 API 17
资源位SDK主要提供两种接入方式:
原生模板
在视图对应位置进行轮播图GTouchBanner的初始化,banner配置后调用轮播图API,数据请求、banner视图的样式、图片缓存、点击跳转行为等全部通过接口下发的配置在SDK内部处理
集成与使用代码参考 GIO电商demo shopping分支的HomeFragment文件
自渲染
调用API接口GrowingTouch#loadBannerData获取banner数据模型以及响应信息,后续展示及点击逻辑由用户进行自实现
集成SDK
1. 集成GrowingIO Android无埋点SDK
添加资源位 SDK前请确保您已经集成了我们公司的埋点 SDK,版本需要在 2.6.9 及以上,详细情况请移步Android埋点SDK帮助文档。最低兼容的 Android 版本为 4.2 。
2. 添加依赖
1.5.0版本后仓库从JCenter迁移到了Maven Central, 请使用mavenCentral()替换jcenter()
2.1 在app build.gradle添加SDK依赖
v1.2.0之前的SDK升级到v1.2.0之后,若还想使用触达原生banner模板,必须集成以下相关依赖
$gtouch_version 为资源位SDK版本号,现最新的版本号为请参考SDK更新日志。
3. 需要的权限列表
所需权限同无埋点SDK
4. 初始化SDK
请将以下GrowingTouch.startWithConfig
加在您的Application 的 onCreate
方法中,且保证在埋点SDK初始化代码GrowingIO.startWithConfiguration
后
6. 代码混淆
如果您启用了代码混淆,请务必在您的proguard-rules.pro文件里加入下面的代码:
原生模板接入
1. 参数说明
v1.1.0之前使用了触达原生banner模板的SDK升级到v1.2.0之后必须修改布局文件里相关属性名,比如bannerKey改为gtouchBannerKey
配置字段 | 属性字段 | 是否必填 | 类型 | 说明 |
Bannerkey | gtouchBannerKey | 是 | string | 在服务端进行查看后配置到本地,一个bannerKey对应一个banner(唯一标识),不设置抛出IllegalArgumentException |
轮播间隔 | gtouchAutoPlayInterval | 否 | long | 不设置默认为3000ms,注意单位为ms |
自动循环 | gtouchAutoPlayAble | 否 | boolean | 不设置默认为ture |
轮播指示器样式 | gtouchPointDrawable | 否 | ResourceId | 不设置为SDK默认小圆点 |
轮播指示器位置 | gtouchIndicatorGravity | 否 | int(Gravity) | 默认为Gravity.CENTER_HORIZONTAL | Gravity.BOTTOM |
默认占位图 | gtouchPlaceholderDrawable | 否 | ResourceId | 用户设置,不设置默认为-1 |
图片的填模式 | scaleType | 否 | ImageView.ScaleType | 不设置默认为CENTER_CROP |
错位占位图 | gtouchErorReplaceDrawable | 是 | ResourceId | 用户设置,不设置抛出IllegalArgumentException |
2. 在对应视图xml中添加Banner控件(建议使用xml布局)
3. GTouchBanner初始化代码如下
自渲染接入
1. 数据模型说明
BannerData
属性字段 | 类型 | 说明 |
getName() | string | bannerd名称 |
getBannerkey() | string | banner的唯一标识 |
getItem() | List<BannerItemData> | banner的所有item,类型为bannerItemData |
BanneritemData
属性字段 | 类型 | 说明 |
getIndex() | int | index标识,从0开始 |
getTitle() | string | item的名称 |
getImageUrl() | string | bannerItem显示图片url |
2. 获取banner数据模型
使用GrowingTouch#loadBannerData(@NonNull String bannerKey,@NonNull final BannerDataCallback callback)
v1.3.0版本新增了对灵活资源位的支持,注意灵活资源位可能发生没有banner的情况,需要特殊处理。
3. bannerItem绑定对应的itemview的点击事件
使用BannerItemData#bindItemDataToClickView(final View clickView, final BannerItemOnClickListener listener)
使用bannerItem进行绑定点击事件的原因及注意事项:
添加额外依赖:com.android.support:viewpager:x.x.x(含有该依赖即可,如依赖包:com.android.support:appcompat-v7:x.x.x)
使用androidx时请同时设置android.enableJetifier为true
保证banner的展示以及点击事件能够正确传给GroiwngIO的数据端,需要使用BannerItemData#bindItemDataToClickView进行点击事件的绑定
将对应视图的点击事件实现在BannerItemOnClickListener回调时,不要进行额外的点击事件设置
保证banner的展示事件准确,需要在视图真正显示时进行BannerItemData#bindItemDataToClickView调用,注意如使用ViewPager存在预加载(无法disable),建议在类似PagerAdapter#setPrimaryItem函数中进行绑定调用
如使用ViewPager2(目前版本:androidx.viewpager2:viewpager2:1.0.0-beta03),为保证展示事件的准确性建议关闭离屏加载(类似ViewPager的预加载,默认关闭),使用预加载时在视图绑定时(在创建时将导致展示事件错乱)进行BannerItemData#bindItemDataToClickView调用
原生模板接入异常情况说明
1. 获取Banner数据失败(包括获取到的BannerItem的size为0)
当存在上一次获取到Banner数据时,将会加载上一次数据
没有上一次数据时,将会回调用户错误(onLoadDataFailed)并加载设置的错误图片
获取到的BannerItem的size为0时,原生模板所在的view会自动隐藏,界面上会有对应的隐藏动画,请开发者酌情考虑使用我们的模板。
2. 后端返回的配置数据banneritem的index不连续(包括:自渲染接入)
SDK中会将index进行去重并重新编号
3. BannerItem单张图加载失败
删除该item,删除后不存在item将会加载用户与设置的错误图片(errorReplaceDrawable)
Last updated