帮助与文档

> >

主要涉及以下类:

  • YLInit:整个SDK的主入口,单例,主要提供初始化,配置用户信息。
  • YLFeedRequest: 单例,加载频道列表、视频列表的功能
  • YLReport: 单例,用于用户行为和视频上报
  • ChannelList:频道列表的model类
  • Channel:单个频道的model类
  • MediaList:频道下视频列表
  • MediaInfo:视频的model类

一、初始化

在自定义Application的OnCreate中添加以下代码,初始化我们的SDK。

  • 代码示例:

  • 方法说明:
方法名 参数 类型 描述 是否必须参数
setApplication context Application 设置Context
setAccessToken token String 设置token,token由一览提供
setAccessKey key String 设置key,key由一览提供
setSid sid String 设置渠道号,sid
setUid uid String 为了获取更加准确的跨平台的个性化推荐内容,鼓励用户配置应用的唯一userId

 

二、数据请求

1.请求频道列表数据

  • 代码示例

  • 方法说明

  • 接口返回 ChannelList
名称 类型 描述
data List< Channel > 频道列表

其中,单个频道的数据模型Channel各字段含义如下:

名称 类型 描述
id String 频道id
name String 频道名称

 

2.请求频道下视频列表

  • 代码示例

  • 方法说明:

  • 接口返回 MediaList
名称 类型 描述
data List< MediaInfo > 视频列表

其中,单个频道的数据模型MediaInfo各字段含义如下:

名称 类型 描述
log_id String 推荐id
video_id String 视频id
title String 视频名称
tags String 视频标签,格式 “热血长安, 默剧, 恶搞”
h5_url String h5打开地址
image String 封面图
duration long 时长,单位 s
provider Provider 内容提供者
publish_date String 视频生成时间,格式:”2018-01-01 12:00:00″
video_w int 视频宽
video_h int 视频高
play_num int 视频播放数
like_num int 喜欢数
create_time long 视频生产时间
update_time long 视频更新时间

 

三、数据上报

数据上报在一览内容提供平台有着极其重要的作用,可以为App用户提供更为精准和个性化的推荐,进而提高VV和PV,增加收入。所以建议开发者接入sdk后,必须准确的调用数据上报。

com.yilan.sdk.report.YLReport

1.视频展示上报

  • 调用时机

在视频item(mediainfo)展示时调用

注意: 为了节省流量,app开发者应尽量避免同一视频的展示上报事件多次上传。 快速滑动列表产生的曝光,因用户未来得及观看,不能算作有效展示事件。建议在每个列表项展示0.5s后再进行上报。

  • 代码示例

  • 方法说明

  • 接口返回

以RecyclerView为例,给出一种曝光统计方案
  • 覆写Adapter. onViewAttachedToWindow

  • 如果在ViewPager+Fragment列表里面展示上报,为了更加精确。可以在可以采用如下方式:

2.视频点击上报

  • 调用时机

在点击每个视频item时,调用

  • 代码示例

  • 方法说明

  • 接口返回

更多ApiDoc,可在官网下载离线包后查看ApiDoc文档

 

相关文档