You need to enable JavaScript to run this app.
导航

API FAQ

最近更新时间2021.05.31 18:00:02

首次发布时间2021.04.20 10:54:52

生成用户标识

1. wap注册提示授权失败,{"ret":1,"msg":"AUTHENTICATION FAILED"...},什么原因?
首先排查是否是参数传递错误或者签名失败,若以上均排查没有问题,提供req_id,火山引擎侧进一步排查;

构建列表页

  1. 获取个性化内容API, 信息流列表翻页提取怎么传参数,有什么规则没?
    没有翻页的概念,正常情况每次请求个性化推荐接口,返回6-15条内容,不会出现两刷有重复内容的情况。

  2. 个性化接口输出的内容是怎么排序的,哪个字段对应排序值?
    现在返回的内容就已经是算法采用一定策略做好了排序的,不需要关心怎么排序,直接按照数据返回进行填充就可以。

  3. 个性化内容接口,返回的封面图有几种?
    目前是返回无图,大图,三图,右图混出,通过cover_mode可以判定封面类型,0:无图;1:大图;2:三图;3:右图。图片URL里有“~tplv-tt-cs0:”字段的时候是支持自行裁剪大小的。

  4. 封面图的尺寸是多少,是否支持裁剪?
    封面图包含无图,大图,三图,右面四种,cover_image_list字段对应的为封面图,默认尺寸:大图:960*540,三图和右图:300*196,若图片URL里有“~tplv-tt-cs0:”字段,则表示支持自行裁剪大小。

  5. 个性化内容接口可以指定返回内容的条数么?
    默认每次请求,返回的数据在6-15条。不建议设置固定数量,会影响算法结果。因为推荐算法会有数量的过滤和去重,所以每次数量不一样。

  6. 个性化内容接口返回的封面图都是什么格式,如何适配IOS?
    1.在请求个性化接口的时候,增加传入一个参数:os。传android返回webp格式,传ios会返回jpg格式。

  7. 个性化推荐接口返回的group_id和group_id_str有什么区别?
    group_id是long类型,group_id_str是string类型,因为文章id有时候太长,针对js开发者,转化为long类型可能会有精度折损,所以同时返回了group_id_str,如果涉及到需要传入group_id的接口,以返回的字符串为准,并按照接口指定类型进行传参。

构建详情页

  1. 在详情页的顶部增加一个banner图,跳转到自身业务页面,或者在详情页的正文里面插入一段话,内容中有超链接跳转到自身业务,这两种方案支持吗?
    详情页为三明治式页面结构:火山引擎正文H5 + 客户端Native + 火山引擎其他区域H5;具体可以参考“详情页拼接业务模块”。客户端Native区域需要做「来源、责任方」标记,例如,该板块由XXX提供。

  2. 个性化推荐接口,返回的article_url和comment_url这个有有效期吗,过期了怎么访问详情页呢, 看获取视频播放地址有有效期的限制和访问重试机制?
    url不会过期,只有视频有有效期。但是不建议缓存article_url,以免缓存的文章已下架。比如请求个性化推荐接口后,将article_url做了缓存,几天之后再通过该URL访问文章详情页,却发现文章已经下架。如果必须缓存,建议将group_id缓存起来,访问前调用“获取文章内容”接口,提前获取文章状态。若ret为0,则文章可正常访问。

  3. app内视频详情页和新闻详情页如果要自定义UI和交互,如何实现?
    1.获取个性化内容接口返回的article_url,是对应的图文/视频详情页H5,这个使用webview直接加载就可以了,针对详情页的UI或者交互有要求的话,需要按照我们双方约定的接口规范,提供js相关接口给到我们,我们这边要做定制开发,属于UI自定义;2.获取个性化内容接口会返回video_id。通过这个字段获取视频播放地址(cdn资源),然后合作方自行实现native播放器来播放视频,并自主定义UI。

  4. 详情页如何隐藏评论/相关推荐,仅出正文?
    仅带有正文区域(详情页URL加参数:&hide_comments=1&hide_relate_news=1,仅出正文)

  5. 新闻详情h5页面支持OGP 协议吗,通过OGP协议获取分享内容?
    不支持,需要定制开发,若要分享内容,可以用share_url。

  6. video_id实时请求视频播放地址,加载到iframe,有时返回403
    403错误有两种情况:
    1.视频地址过期,需要重新请求;
    2.使用第三方域名加载了cdn播放地址;目前用我们的cdn播放地址的话,需要用native播放器播放,域名必须为火山引擎域名,不可以用h5第三方域名。

构建分享页

  1. 个性化推荐返回的每个新闻都会有配图吗,针对分享页,无封面的情况下,是否可以从自身图库配图?
    目前返回的新闻配图模式有四种:通过cover_mode可以判定封面类型,0:无封面;1:大图;2:三图;3:右图。针对无图情况,可以设置默认兜底图片。
  2. 支持分享火山引擎的内容到微信朋友圈或者公众号或微信小程序吗?
    目前火山引擎支持常见的微信卡片分享,微信朋友圈分享,暂不支持微信小程序、公众号分享,若有需求可单独联系对应BD/产品同学。

点赞

阅读量

收藏

不感兴趣

  1. 负反馈选项的内容是火山引擎传给合作方,选择了选项之后,包括隐藏当前新闻,屏蔽关键词等操作,是火山引擎来处理吗?
    负反馈分两种:不感兴趣,举报。不感兴趣:通过文章dislike接口,上报不感兴趣,其中filter_words表示不感兴趣的原因,在获取个性化内容接口会返回该字段,类型是list。具体的UI效果由合作方自己实现,请求dislike接口之后,关键词屏蔽和文章删除由火山引擎这边实现。举报:通过report_type来表示举报原因,string类型,UI由合作方实现,请求举报接口成功后,文章处理等由火山引擎实现。

举报

  1. 负反馈选项的内容是火山引擎传给合作方,选择了选项之后,包括隐藏当前新闻,屏蔽关键词等操作,是火山引擎来处理吗?
    负反馈分两种:不感兴趣,举报。不感兴趣:通过文章dislike接口,上报不感兴趣,其中filter_words表示不感兴趣的原因,在获取个性化内容接口会返回该字段,类型是list。具体的UI效果由合作方自己实现,请求dislike接口之后,关键词屏蔽和文章删除由火山引擎这边实现。举报:通过report_type来表示举报原因,string类型,UI由合作方实现,请求举报接口成功后,文章处理等由火山引擎实现。

展示评论

相关推荐

  1. 获取相关推荐数据的方法只有API吗,有h5链接的形式吗
    详情页默认是带有相关推荐的,如果需要单独拼接相关推荐模块,需要用API获取,并针对相关推荐场景进行数据回传。

  2. 相关推荐API返回的数据中没有作者信息,这个能提供下吗
    请求url拼接参数need_media_info=1即可

PUSH功能

  1. push数据回传接口,push_show如果不传是否会有影响
    因为发送和到达之间是有一定折损的,如果没办法同步到达状态这个信息,推荐就只能用发送来代替,这中间折损的文章会直接被当成负例,对推荐效果有一定影响。所以必须要传。

关注功能

  1. 调用关注接口进行关注,返回NOT ALLOWED TO ACCESS
    需要提供partner,火山引擎添加访问白名单。并注意以下两点:
    1.需要在获取access_token的时候绑定ouid(合作方自己的登陆账号id),然后用绑定过ouid的access_token请求关注相关接口;wap注册
    2.所有关注相关的接口,都需要传这六个公共参数,如果不传ouid,关注关系是随设备走,换了设备关注关系就消失了 通用参数

作者主页

数据回传

  1. 数据回传验证接口,请求返回999
    1.首先需要提供accesstoken或者完整请求url,字节侧进行设备配置;2.需要先操作APP,上报数据后,然后再请求verify接口。

  2. 客户端展现是指曝光吗?
    是的,针对列表页有曝光的视频或者文章进行上报。上报时机可参考:在列表页点击Home,或退到后台,或切换了module(模块页面),比如从列表页进入详情页,或锁屏,或切换频道等,满足任意一条就上报,具体参考:客户端展现上报

  3. push数据回传接口,push_show如果不传是否会有影响
    因为发送和到达之间是有一定折损的,如果没办法同步到达状态这个信息,推荐就只能用发送来代替,这中间折损的文章会直接被当成负例,对推荐效果有一定影响。所以必须要传。

  4. 详情页都是用的火山引擎的H5页面,因为用户直接浏览和操作的都是火山引擎的前端页面,具体该怎么进行数据上报?
    如果都是用的我们的H5,需要上报的事件包括:列表页的客户端展现(曝光),点击,详情页停留时长;
    但是建议视频用native实现,相比于H5实现视频,native的形式播放性能更好,上报信息更全,更有助于推荐。这种方式需要上报:点击,详情页停留时长,视频开始播放,视频结束播放,列表页客户端展现(曝光);
    停留时长就是上报您在详情页的停留时长,在点击Home/锁屏/返回列表页/退出APP等场景,需要上报,针对于详情页内的交互,比如点击详情页内的相关推荐跳到其他页面,这种你们监听不到不需要上报