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

获取个性化内容

最近更新时间2023.11.21 14:41:58

首次发布时间2021.10.18 11:12:18

客户侧调用该接口获取个性化推荐的内容,目前支持的内容体裁有图文、横版短视频、竖版小视频。
每次请求,火山引擎侧默认返回的内容条数在6-15条不等,内容信息包括内容标题、封面图,作者名称、阅读数、播放量、发布时间、点赞数、分享数等,客户侧可使用这些数据,自定义实现UI效果。

注意

  • 个性化推荐接口耗时正常情况不超过1s,为容忍网络抖动或突发流量,超时时间建议设置为3s。
  • 尽量不要预加载,否则会造成内容浪费,影响推荐效果。如果您为了提升客户端体验流畅度进行了预加载,建议您将内容放到首页进行展现,可以更好的保障推荐效果。
  • 同一个用户需要对应唯一的用户标识,也就是在调用wap注册接口时,该用户的Uuid需要保持不变。否则将会被火山引擎侧推荐系统识别为新用户,进而影响推荐效果。涉及更改用户标识,请提前与火山引擎侧沟通,以免造成指标骤降。

请求方式

请求方法

GET/POST(Content-Type: application/x-www-form-urlencoded)

请求url

https://mercury.volcengineapi.com/?Action=ContentStreamV2&Version=2021-01-01

请求header

ServiceName:content

请求参数

参数描述类型是否必填说明
ApiVersion接口版本int固定传4
Partner渠道号String
AccessToken用户身份标识StringAccessToken需要通过wap注册接口获取
Timestamp10位时间戳,单位:秒long为保证安全,timestamp 与当前时间戳相关绝对值不能超过3600 秒
Category频道IDString登陆火山引擎内容定制控制台,创建应用-场景-频道后,生成的频道ID就是这里的Category。创建频道步骤请参见:信息流运营操作手册
Dt设备型号String如iphone5s、Galaxy。主要用于推荐分析,提升推荐效果
DeviceBrand设备厂商String如Apple、Samsung。主要用于推荐分析,提升推荐效果
Os操作系统String如 Android、IOS。主要用于推荐分析,提升推荐效果。注意:IOS系统如果没有正确传入此参数,返回的封面图可能为webp格式,导致图片解析失败。
OsVersion操作系统版本String如4.0.4。主要用于推荐分析,提升推荐效果。火山引擎侧内容详情页会根据此参数进行适配。
ClientVersion应用的版本号String比如1.0.1。主要用于数据排查,提升业务指标

AllowStick

是否输出置顶文章

int

1:是,0:否,默认是0。
您需要结合自身场景控制该参数的传递,比如C端非首刷或者下拉刷新不需要置顶时,控制不传此参数即可。

注意

当同时满足如下几个条件,才会返回置顶内容:
1.在火山引擎内容定制控制台添加并发布了置顶内容;
2.AllowStick值为1;
3.传入的Category和火山引擎内容定制控制台的频道ID正确匹配。

StressTest

是否为压测

int

1:是,0:否,默认为0。
当您需要进行压力测试时,必须填入此参数,否则会因命中火山引擎侧的限流机制,而被拦截

OffPersonalRec

是否关闭个性化推荐

int

1:是,随机推荐内容,
0:否,个性化推荐内容,
默认为0

Ip设备ipString客户服务端调用此接口,传递的是客户客户端的ip地址

City

城市名称

String

比如:北京,编码为utf-8。
当请求“本地”频道时,必须填入此参数,否则无法返回本地内容。目前本地频道支持的城市见下文说明。

AllowForceInsert请求强插内容(取值0代表关闭,1代表开启)int频道首刷时传递为1,非首刷场景为0

响应参数

除了“公共参数”外,Result结构

参数
描述
类型
说明
Result
内容数据
List<Result>
默认随机返回6-15条内容数据

请求示例

public static void main(String[] args) {
        //初始化一个service
        StreamService streamService = StreamServiceImpl.getInstance();

        //设置ak,sk 此为请求的凭证
        streamService.setAccessKey("ak");
        streamService.setSecretKey("sk");

        //初始化一个request
        GetListRequest req = new GetListRequest();
        req.setTimestamp(LocalDateTime.now().toEpochSecond(ZoneOffset.of("+8")));
        req.setAccessToken("accessToken");
        req.setCategory("category");
        req.setPartner("partner");
        req.setOs("ios");
        req.setClientVersion("3.1.1");
        try {
            GetListResponseV2 response = streamService.getListV2(req);
            System.out.println(JSON.toJSONString(response));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20231115205304BC70AF85A8C20B1B4FCD",
        "Action": "ContentStreamV2",
        "Version": "2021-01-01",
        "Service": "content",
        "Region": "cn-beijing",
        "Error": {
            "CodeN": 0,
            "Code": "",
            "Message": ""
        }
    },
    "Result": [
        {
            "Abstract": "",
            "ArticleType": "短视频",
            "ArticleUrl": "https://open.toutiao.com/a7297943953491132963/?***",
            "CommentUrl": "https://open.toutiao.com/a7297943953491132963/comment/?***",
            "CoverImages": [
                {
                    "Url": "https://p9-open-sign.byteimg.com/***",
                    "Height": 540,
                    "Width": 960
                }
            ],
            "CoverMode": 1,
            "DiggCount": 1,
            "GroupId": "7297943953491132963",
            "HasVideo": true,
            "PublishTime": 1699184988,
            "ShareUrl": "https://open.toutiao.com/a7297943953491132963/?***",
            "Title": "#不止好酒更有健康  #陕西吃啥更攒劲  #中国劲酒 羊肉配劲酒",
            "UserInfo": {
                "AvatarUrl": "https://p3-open-sign.onewsimg.com/user-avatar/***",
                "Description": "情感生活能量\n唱响优质生活,感谢平台,欢迎大家关注",
                "Follow": false,
                "FollowerCount": 100215,
                "HomePage": "https://open.toutiao.com/u941622862552752/?***",
                "Name": "***",
                "UserId": 941622862552752,
                "UserVerified": false,
                "VerifiedContent": ""
            },
            "VideoWatchCount": 381,
            "VideoDetail": {
                "VideoDuration": 40.17,
                "VideoList": [
                    {
                        "Url": "http://partner.365yg.com/video/url/?***",
                        "Height": 720,
                        "Width": 1280,
                        "Definition": "720p"
                    }
                ]
            },
            "IsStick": false,
            "FilterWords": [
                {
                    "Id": "8:0",
                    "Name": "看过了"
                },
               ...
            ],
            "DataSource": "stream3"
        }
    ]
}

示例效果图

图文视频

本地频道-城市列表

当请求“本地”频道时,需要同时传入City,目前支持的城市如下

序号城市名
A安阳, 鞍山, 安庆, 安康, 阿坝, 阿拉善, 阿克苏, 阿勒泰, 阿里, 安顺, 澳门
B北京, 蚌埠, 保定, 本溪, 包头, 亳州, 滨州, 白城, 百色, 白山, 白银, 宝鸡, 保山, 巴彦淖尔, 巴中, 北海, 毕节, 博尔塔拉, 巴音郭楞
C重庆, 成都, 长春, 长沙, 承德, 常州, 滁州, 巢湖, 沧州, 常德, 昌都, 昌吉, 长治, 朝阳, 潮州, 郴州, 楚雄, 赤峰, 池州, 崇左
D大连, 东莞, 德州, 丹东, 大理, 大庆, 大同, 大兴安岭, 达州, 德宏, 德阳, 定西, 迪庆, 东营
E鄂州, 鄂尔多斯, 恩施
F福州, 阜阳, 佛山, 抚州, 防城港, 抚顺, 阜新
G广州, 贵阳, 桂林, 赣州, 广元, 甘南, 甘孜, 广安, 贵港, 果洛, 固原
H杭州, 合肥, 哈尔滨, 海口, 衡阳, 邯郸, 呼和浩特, 黄冈, 黄石, 湖州, 衡水, 呼伦贝尔, 黄山, 海北, 海东, 海南, 海西, 哈密, 汉中, 鹤壁, 河池,鹤岗, 黑河, 和田, 河源, 菏泽, 贺州, 红河, 淮安, 淮北, 怀化, 淮南, 黄南, 惠州, 葫芦岛
J吉林, 济南, 九江, 揭阳, 酒泉, 嘉兴, 荆州, 锦州, 佳木斯, 吉安, 江门, 焦作, 嘉峪关, 金昌, 晋城, 景德镇, 荆门, 金华, 济宁, 晋中,鸡西, 济源
K昆明, 开封, 喀什, 克拉玛依, 克孜勒苏
L兰州, 廊坊, 六安, 乐山, 来宾, 柳州, 聊城, 莱芜, 拉萨, 洛阳, 凉山, 连云港, 辽阳, 辽源, 丽江, 临沧, 临汾, 临夏, 临沂, 林芝, 丽水,六盘水, 陇南, 龙岩, 娄底, 漯河, 泸州, 吕梁
M绵阳, 马鞍山, 茂名, 眉山, 梅州, 牡丹江
N南京, 南昌, 南宁, 宁波, 南通, 南充, 南平, 南阳, 那曲, 内江, 怒江, 宁德
P莆田, 濮阳, 盘锦, 攀枝花, 平顶山, 平凉, 萍乡, 普洱
Q青岛, 秦皇岛, 泉州, 衢州, 曲靖, 黔东南, 黔南, 黔西南, 庆阳, 清远, 钦州, 齐齐哈尔, 七台河
R日照, 日喀则
S上海, 深圳, 沈阳, 石家庄, 三门峡, 三明, 三亚, 商洛, 商丘, 苏州, 汕头, 汕尾, 十堰, 遂宁, 上饶, 山南, 绍兴, 邵阳, 双鸭山, 朔州, 四平, 松原, 绥化, 随州, 宿迁, 宿州, 石嘴山, 韶关
T天津, 太原, 唐山, 台州, 塔城, 泰安, 铁岭, 台湾, 泰州, 天水, 铜川, 通化, 通辽, 铜陵, 铜仁, 吐鲁番
W武汉, 温州, 无锡, 乌鲁木齐, 芜湖, 潍坊, 威海, 渭南, 文山, 乌海, 乌兰察布, 武威, 吴忠, 梧州
X西安, 厦门, 湘潭, 徐州, 许昌, 信阳, 西宁, 咸阳, 宣城, 新乡, 湘西, 襄阳, 咸宁, 孝感, 锡林郭勒, 兴安, 邢台, 新余, 忻州, 西双版纳, 香港
Y扬州, 银川, 宜昌, 岳阳, 榆林, 烟台, 雅安, 延安, 延边, 盐城, 阳江, 阳泉, 宜宾, 伊春, 宜春, 伊犁, 营口, 鹰潭, 益阳, 永州, 玉林, 运城, 云浮, 玉树, 玉溪
Z珠海, 肇庆, 张家口, 中山, 淄博, 驻马店, 枣庄, 张家界, 张掖, 漳州, 湛江, 昭通, 郑州, 镇江, 中卫, 周口, 舟山, 株洲, 自贡, 资阳, 遵义