参数

说明

setCodeId

平台创建的代码位ID 以9开头9位数

setAdCount

请求数量1-3条，建议设置1

setImageAcceptedSize

设置请求广告的尺寸 单位：px

setAdLoadType()

用于标注此次的广告请求用途为预加载（当做缓存）还是实时加载，方便后续为开发者优化相关策略，传入参数值：
UNKNOWN：未知，默认值，开发者未传入，或当此次加载的广告用途未知时使用
PRELOAD：预加载，当此次加载的广告用途为预加载（当作缓存）时使用
LOAD：实时加载，当此次加载的广告用途为实时播放时使用

方法

说明

onError()

请求失败回调

onFeedAdLoad()

请求成功回调，参考demo获取广告元素并自行渲染

回调

说明

onError()

广告请求失败回调 返回的错误码(code)说明详见链接

onDrawFeedAdLoad()

广告请求成功的回调，获取广告视频播放的view并放入广告容器中

类型

方法

返回类型

说明

回调监听

setVideoAdListener(TTFeedAd.VideoAdListener var1)

void

设置广告交互监听回调

setDownloadListener(TTAppDownloadListener var1);

void

设置广告下载监听回调

registerViewForInteraction((ViewGroup) convertView, images, clickViewList, creativeViewList,adViewHolder.mDislike,new TTNativeAd.AdInteractionListener()

void

重要! 这个涉及到广告计费，必须正确调用。请参考5. 信息流广告行为监听 接入
convertView：必须使用ViewGroup。
clickViews：可点击的View的列表
reativeViews ：用于下载或者拨打电话的View
directDownloadViews：用于前置展示七要素点击直接下载的view
dislikeView：dislike按钮
listener：点击回调

获取广告元素

getVideoDuration();

int

获取广告视频时长

getAdViewWidth()

int

获取广告view的宽度

getAdViewHeight()

int

获取广告view的高度

getVideoCoverImage()

TTImage

获取视频封面图

getAdLogo()

Bitmap

获取穿山甲穿山甲logo，图片大小：80*80

getTitle()

String

获取广告标题

getDescription()

String

获取广告标描述

getIcon()

TTImage

获取广告icon

getSource()

String

广告描述

getImageList()

List<TTImage>

获取广告图片Image list

getInteractionType()

获取广告的交互类型
2：在浏览器内打开 （普通类型）
3：在app中打开
4：下载应用
5：拨打电话
其他： 未知类型

getImageMode()

int

获取广告类型
3：大图
2：单图
4：组图
16：竖图
5：横版视频
15：竖版视频
166：直播拉流

getAdView()

View

获取视频View，不支持返回视频url，开发者需要将视频view添加到容器

其他

getMediaExtraInfo()

Map<String, Object>

获取广告其他信息

setCanInterruptVideoPlay(boolean var1)

/

draw广告特有，可在广告加载完成后调用此方法设置是否允许视频区域响应点击，并且暂停/继续播放视频广告。
true: 允许视频区域响应点击，用于暂停/继续播放控制
false (默认): 禁止视频区域响应点击

setPauseIcon(Bitmap var1, int var2)

/

draw广告特有，设置视频广告的暂停图标及其大小。

自定义播放器

已回收，存量媒体不影响使用

getCustomVideo().getVideoUrl()

String

视频url

getCustomVideo().reportVideoPause(long var1)

void

上报视频暂停播放事件，var1 播放时长

getCustomVideo().reportVideoContinue(long var1);

void

上报视频继续播放事件，var1 播放时长

getCustomVideo().reportVideoFinish()

void

上报视频播放完成事件

getCustomVideo().reportVideoFinish()

void

上报视频播放中断事件，var1 播放时长

getCustomVideo().reportVideoBreak(long var1)

void

上报视频播放中断事件，var1 播放时长

getCustomVideo().reportVideoAutoStart();

void

上报视频自动播放事件， var1 播放时长

getCustomVideo().reportVideoStartError(int var1, int var2)

void

上报视频开始播放错误事件，var1 错误码，var2 其他错误码

getCustomVideo().reportVideoError(long var1, int var2, int var3)

void

上报视频开始播放错误事件，var1 播放时长，var2 错误码，var3 其他错误码

方法

说明

onAdClicked()

点击普通区域回调

onAdCreativeClick()

点击创意区域回调

onAdShow()

广告展示回调

方法

说明

onIdle()

绑定下载监听回调， 未开始下载

onDownloadActive(long totalBytes, long currBytes, String fileName, String appName);

下载中回调
@totalBytes 安装包总字节数 -1 ：未知
@currBytes 当前已下载的字节数
@fileName 下载文件名称
@appName 当前下载的APP名

onDownloadPaused(long totalBytes, long currBytes, String fileName, String appName)

下载暂停回调
@totalBytes 安装包总字节数 -1 ：未知
@currBytes 当前已下载的字节数
@fileName 下载文件名称
@appName 当前下载的APP名

onDownloadFailed(long totalBytes, long currBytes, String fileName, String appName)

下载失败回调
@totalBytes 安装包总字节数 -1 ：未知
@currBytes 当前已下载的字节数
@fileName 下载文件名称
@appName 当前下载的APP名

onDownloadFinished(long totalBytes, String fileName, String appName);

下载完成回调
@totalBytes 安装包总字节数 -1 ：未知
@fileName 下载文件名称
@appName 当前下载的APP名

nInstalled(String fileName, String appName);

安装完成回调
@fileName 下载文件名称
@appName 当前下载的APP名

方法

说明

onIdle()

绑定下载监听回调

onDownloadActive()

下载中回调

onDownloadPaused()

下载暂停回调

onDownloadFailed()

下载失败回调

onDownloadFinished()

下载完成回调

onInstalled()

安装完成回调

方法

说明

onClickRetry()

广告点击重试的回调

onClick()

广告点击查看详情或下载回调

onVideoAdComplete()

广告播放完成

方法

说明

onItemClick()

自定义样式情况下用户点击filterWord回调

onSelected()

默认dislike样式，点击filterWord回调。开发者可以在此回调中移除广告

onCancel()

默认dislike样式，点击取消回调

onShow()

默认dislike样式，dislike弹窗展示回到

获取下载应用信息

获取广告七要素

说明

ad.getComplianceInfo( )

开发者先调用ad.getComplianceInfo( )获得广告下载应用相关信息后再获取对应的七要素信息

getAppName()

获取应用名称

getAppVersion()

获取应用版本号

getDeveloperName()

获取开发者公司名称

getPrivacyUrl()

获取隐私协议

getPermissionsMap()

获取权限名称及权限描述列表

getPermissionUrl()

获取权限列表url

getFunctionDescUrl()

获取产品功能url

优化方案

方案概述

媒体要求

示意图（供参考）

样式优化

直播拉流&直播样式

当返回广告时，根据imagemode=166区分是否为直播拉流广告，如是：

1. 适配直播拉流，即可展示直播实时画面
2. 取主播名称/头像等字段做直播样式展示(字段获取不到可联系技术支持开通权限)

1. 使用穿山甲sdk播放器
2. 双端都支持直播拉流，iOS需68xx及以上

优惠券样式

当返回直播广告（pro_type为2）或短视频广告（pro_type为1）时，根据coupon.has_coupon（1 有优惠券，0无优惠券）区分是否带优惠券，如有获取优惠券金额等字段用作样式展示

无

新增软广位

软文

在feed流/draw流场景，可以在原有代码位之外新开代码位，将这批代码位线下提供给BD配置只返回特定直播广告

1. Android默认支持闭环saas，即用户观看直播间，下单等行为不需要外挑抖音，在媒体应用内完成闭环；
2. 提供新增代码位的rit用于配置
3. 在新增rit上：标注“来自抖音”，替代原本“广告”角标（如不标“来自抖音”，存在法务监管风险）

push

在app内任意场景新增push卡片样式，作为特殊代码位，代码位的配置和展示逻辑同上（需标注“来自抖音”），请求时机媒体决定，一次拉取1条广告

1.5卡

在feed流上新增1.5卡片样式，作为特殊代码位，代码位的配置和展示逻辑同上（需标注“来自抖音”），设置X个代码位、每个代码位每次拉取1条广告

一级分类

字段含义

字段名

是否必传

字段格式

备注

直播间信息
live_room

主播头像 icon

avatar_url

必传

string

主播名称

author_nickname

必传

string

粉丝量

follower_count

必传

int64

在线观看人数

watch_count

必传

int64

在线观看人数较少，推荐用粉丝量

商品信息
product

商品图片

img_list

必传

[]string

商品名称

name

必传

string

商品展示价

effective_price

必传

int64

单位：元

商品展示价

effective_price_origin

必传

int64

单位：分

商品划线价(原价)

regular_price

非必传

int64

单位：元

商品划线价(原价)

regular_price_origin

非必传

int64

单位：分

商品分类

category

非必传

object

商品销量

sell_num

必传

int64

券信息
coupon

是否有券

has_coupon

有券时必传

bool

优惠券类型（26 - 满减券）

type

有券时必传

int64

优惠面额

amount

有券时必传

int64

单位：元

优惠券使用门槛

threshold

是满减券时会有

int64

单位：元

优惠券开始生效时间

start_time

有券时必传

string

生效时间和过期时间粒度较粗，可以采用固定文案 “领取后 30 分钟内有效”

优惠券过期时间

expire_time

有券时必传

string

一级分类

字段含义

字段名

是否必传

字段格式

备注

店铺信息

店铺名称

shop_name

必传

string

商品信息
product

商品图片

image

必传

string

商品名称

name

必传

string

商品服务

service_text

string

“限时秒杀”

商品价格

market_price

必传

int64

单位：元

商品价格

market_price_origin

必传

int64

单位：分

商品最低价格

discount_price

非必传

int64

单位：元

商品最低价格

discount_price_origin

非必传

int64

单位：分

商品分类

category

必传

object

商品销量

sell_num

必传

int64

券信息
coupon

是否有券

has_coupon

有券时必传

bool

优惠券类型（26 - 满减券）

type

有券时必传

int64

优惠面额

amount

有券时必传

int64

单位：元

优惠券使用门槛

threshold

是满减券时会有

int64

单位：元

优惠券开始生效时间

start_time

有券时必传

string

生效时间和过期时间粒度较粗，可以采用固定文案 “领取后 30 分钟内有效”

优惠券过期时间

expire_time

有券时必传

string