文档
开发
介绍
设计
开发
运营
数据
第三方平台
开发者课堂
行业解决方案
开发者平台 社区
指南
框架
组件
API
服务端
行业对接说明
能力接入指南
开发者工具
更新日志
开发

开发 行业对接说明 内容类对接 资源卡片创建 更新接口

# Feed卡片内容类 open api 接口文档

更新时间：2024-12-24 16:34:01

# 1、创建/更新接口

# 1.1 接口概述

# （1）接口介绍

该接口用于对第三方的资源卡片进行创建或更新。

# （2）内容上传/去重 标识

内容上传以 “appID+thirdid” 作为唯一索引。为了防止创建重复资源，也以 “appId + thirdId”作为去重规则。

  • appID：小程序的appID
  • thirdid：小程序可自定义的唯一标识，支持数字、字母、字符。

# （3）上传形式

支持合集和单集两种形式：

  • 合集视频：比如番剧、影视剧等
  • 单集视频：即单独的一个视频，如一个UGC、一个电影等

# （4）上传规则

  • 合集视频：
    • 优先传封面：作为一个单独卡片，记录该合集的信息。
    • 依次传视频：需要传合集的唯一ID，用于建立关系。
  • 单集视频：
    • 无特殊规则

【注：合集视频也可以拆成单集视频发，但是作为合集视频可以分发的入口更多】

# （5）内容上传/更新逻辑

如果不存在则创建，如果已存在则在原内容上进行更新。

【注：更新是全量更新，即必须携带所有的必要字段，不能仅仅是待更新字段】

# 1.2 接口说明

项目 值
Host https://open.kuaishou.com
Path /openapi/mp/developer/feed/add
Method POST
Content-Type application/json

Request Param

参数是否必须类型备注代码示例
app_id是string应用ID, 放到 query param, 即url后面app_id=ks670191921327355224
access_token是stringtoken，放到 query param, 即 url 后面
获取方式见附录		access_token=ChFvYXV0aC5hY2Nlc3NUb2tlbhJgdeDIR4WqaJkHl
C0rWsm1IUKa4IcgTZL4NczTi5S2daYM2JSarqjH0ux80LfPfzme1sD
42QX7C--LZN61r9rsJb13mDcF5u_rSZULrXfwScjGw2WQ0L2yw3D
5BgQI6ibjGhIgQfvkqD5FqqWtQ2y0WGxSDjAiIMD5tarktstCh7XBr4
DgFPBuCK6nGPDdPa7fALvfhV0fKAUwAQ

以下参数作为json body发送

{
    "cardContent" : 1,
    "cardFormat" : 1,
    "thirdId" : "230fd23ead9000345",
    "collectionId" : "34345540023904943",
    "title" : "这是一个卡片的主标题",
    "path" : "/page/index/anima?a=b",
    "cover": "http://image.com/1.png",
    "chargeOrNot" : true,
    "updateDoneOrNot" : true,
    "episodeNumber" : 10,
    "extraInfo" : {
        "updatedNumber": 10
    },
    "videoInfo" : {
        "videoDuration": 2700,
        "actorList" : ["成龙","刘德华"],
        "typeList" : ["动作","剧情"],
        "year" : "2012",
        "district" : "中国大陆",
        "score" : 9.5,
        "directorList" :  ["周星驰","张艺谋"],
        "introduction" : "讲述了民国时期一所偏远学校中，教师们将一头驴虚报成老师冒领薪水而引发的故事",
        "roleList" :  ["李四","张三"],
        "highLightVideoId" : "552ed73fe1d13b0f"
    },
    "coverInfo" : {
        "ratio43" : "http://image.com/ratio43.png",
        "ratio34" : "http://image.com/ratio34.png",
        "ratio169" : "http://image.com/ratio169.png",
        "ratio916" : "http://image.com/ratio916.png"
    },
    "ugcInfo" : {
        "authorName" : "好个秋",
        "authorAvatar" : "http://image.com/author_1.png"
    }
}

通用规则：

合集IP 参数映射关系举例

番剧 ： third_id 100 cardFormat = 2 collection_id = null

第一集: third_id 101 cardFormat = 3 collection_id = 100

第二集 third_id 102 cardFormat = 3 collection_id = 100

具体不同视频资源基础信息举例：

单集资源--电影
姜子牙》电影		系列视频合集资源--动漫
共十话的《瑞克和莫蒂》第四季		系列视频单集资源--动漫
《瑞克和莫蒂》第四季的第五话
"cardContent" : 1,
"cardFormat" : 1,
"thirdId" : "1000001",
"collectionId" : null,
"title" : "姜子牙",
"path" : "/page/index/anima?a=b",
"cover": "http://image.com/1.png",
"chargeOrNot" : true,
"updateDoneOrNot" : true,
"episodeNumber" : 1		"cardContent" : 4,
"cardFormat" : 2,
"thirdId" : "1000002",
"collectionId" : null,
"title" : "瑞克和莫蒂 第四季",
"path" : "/page/index/anima?a=b",
"cover": "http://image.com/2.png",
"chargeOrNot" : false,
"updateDoneOrNot" : true,
"episodeNumber" : 10		"cardContent" : 4,
"cardFormat" : 3,
"thirdId" : "1000003",
"collectionId" : "1000002",
"title" : "阻止那个机器人！",
"path" : "/page/index/anima?a=b",
"cover": "http://image.com/3.png",
"chargeOrNot" : false,
"updateDoneOrNot" : true,
"episodeNumber" : 5
系列视频合集资源--小说
《西游记》		系列视频单集资源--小说
《西游记》第一回		系列视频单集资源--小说
《西游记》第一百回
"cardContent" : 10,
"cardFormat" : 2,
"thirdId" : "1000004",
"collectionId" : null,
"title" : "西游记",
"path" : "/page/index/anima?a=b",
"cover": "http://image.com/4.png",
"chargeOrNot" : false,
"updateDoneOrNot" : true,
"episodeNumber" : 100,
"extraInfo": {
 "updatedNumber": 100
},
"videoInfo": {
 "introduction":"四人西天取经，历经九九八十一难的故事",
 "typeList":["剧情","古装","神话"]
 "directorList":["吴承恩"]
 "roleList":["唐僧","孙悟空","猪八戒","沙僧"],
 "score":9.5
}		"cardContent" : 10,
"cardFormat" : 3,
"thirdId" : "1000005",
"collectionId" : "1000004",
"title" : " 灵根育孕源流出 心性修持大道生",
"path" : "/page/index/anima?a=b",
"cover": "http://image.com/5.png",
"chargeOrNot" : false,
"updateDoneOrNot" : true,
"episodeNumber" : 1,
"videoInfo": {
 "introduction":"四人西天取经，历经九九八十一难的故事",
 "typeList":["剧情","古装","神话"]
 "directorList":["吴承恩"]
 "roleList":["唐僧","孙悟空","猪八戒","沙僧"],
 "score":9.5
}		"cardContent" : 10,
"cardFormat" : 3,
"thirdId" : "1000006",
"collectionId" : "1000004",
"title" : "径回东土 五圣成真",
"path" : "/page/index/anima?a=b",
"cover": "http://image.com/6.png",
"chargeOrNot" :false,
"updateDoneOrNot" : true,
"episodeNumber" : 100,
"videoInfo": {
 "introduction":"四人西天取经，历经九九八十一难的故事",
 "typeList":["剧情","古装","神话"]
 "directorList":["吴承恩"]
 "roleList":["唐僧","孙悟空","猪八戒","沙僧"],
 "score":9.5
}

body参数说明

参数是否必须类型备注代码示例图例
基础属性     
cardContent是int资源内容类型
1-电影
2-综艺
3-电视剧
4-动漫
5-少儿
6-纪录片
7-ugc短视频
8-ugc图文
9-漫画
10-长篇小说
11-音频
12-短剧
13-短篇小说
16-小说剧		{"cardContent":1} 
cardFormat是int资源形式，用于区分合集与单集资源
1-单集资源（一般指电影）
2-多集数/章节资源合集
3-多集数/章节资源合集下的子集
例如：
电影《独行月球》，为单集资源；
电视剧《甄嬛传》，为合集资源；
电视剧《甄嬛传》第1集，为合集的子集		{"cardFormat":1} 
thirdId是string资源ID，资源的唯一标识{"thirdId":"230fd23ead9000345"} 
collectionId否string关联的合集资源的第三方资源ID
当 cardFormat=3时，必填。		{"collectionId":"34345540023904943"} 
title否string剧集名称或作品名{"title":"人类博物馆"}img
path是string跳转链接{"path":"/page/index/anima?a=b"} 
cover是string封面图片链接。
格式比例要求：比例任意，单张最大不能超过10M，仅支持JPG/PNG/WEBP格式		{"cover":"https://image.com/1.png"}img
chargeOrNot是boolean是否收费{"chargeOrNot":false}img
updateDoneOrNot是boolean是否更新完成
true-已完结
false-未完结，更新中		{"updateDoneOrNot":true}img
episodeNumber是int视频集数/作品章节数
cardFormat=1时，为1
cardFormat=2时，为合集的总集数
cardFormat=3时，为合集中第x集		{"episodeNumber": 4} 
额外属性（extraInfo）是Object此模块字段不能为null，若内部字段不传，则使用：extraInfo:{}  
extraInfo.updatedNumber否int已更新集数/章节数
当cardFormat=2时必填		{
 "extraInfo" : {
  "updatedNumber" : 10
 }
}		举例，栏目作品专区信息流：
img
extraInfo.textFileKey否string小说免费片段纯文本上传;

{

 "extraInfo" : {

  "textFileKey" :"f2b8ccd4-02d3-4d7b-ab03-02a9b4a93a"

 }

}

 
分发属性（videoInfo，以下字段影响分发效果，能传均传）是Object此模块字段不能为null，若内部字段不传，则使用：videoInfo:{}  
videoInfo.videoDuration否int视频时长，单位为秒
当cardContent=1/2/3/4/5/6/7/8 必填
当cardFormat=2时，填任意大于0的数值即可		{
 "videoInfo" : {
 "videoDuration" : 1200,
 "typeList" : ["奇幻","搞笑"","萌系"],
 "actorList" : ["成龙","刘德华"],
 "year" : "2020",
 "district" : "中国大陆",
 "score" : 9.5,
 "directorList" : ["周星驰","张艺谋"],
 "introduction" : "讲述了民国时期一所偏远学校中，教师们将一头驴虚报成老师冒领薪水而引发的故事",
 "roleList" : ["周星星","张三"],
 "highLightVideoId" : "552ed73fe1d13b0f"
}		 
videoInfo.introduction否string简介  
videoInfo.typeList否string list作品标签
最多三个标签，最多不超过24个字符，1个中文字等于2个字符,数字和英文均等于1个字符		 img
videoInfo.directorList否string list导演/作者  
videoInfo.actorList否string list主要演员，一般指真人  
videoInfo.roleList否string list主要角色，一般指作品中的虚拟人物  
videoInfo.year否string上映年份
当entranceList包含“6”且cardContent=1/2/3/4/5/6/7/8 必填		 img
videoInfo.district否string上映地区
当entranceList包含“6” 且cardContent=1/2/3/4/5/6/7/8必填		  
videoInfo.score否double评分（满分为10分）  
videoInfo.highLightVideoId否string高光片段视频ID，通过Feed卡片上传视频 open api 接口文档获取
支持的cardFormat：1/2		videoId在上传完成后不一定可用，需要等转码完成后才可用，如果videoId未转码完成，该接口会报错，提示开发者需要重试 
分发补充字段（coverInfo）是Object此字段不能为null，若内部字段不传，则使用：coverInfo:{}  
coverInfo.ratio43否string宽高比为 4:3 的封面
格式比例要求：比例任意，单张最大不能超过10M，仅支持JPG/PNG/WEBP格式		{
 "coverInfo" : {
  "ratio43" : "",
  "ratio34" : "",
  "ratio169" : "",
  "ratio916" : ""
 }
}		 
coverInfo.ratio34否string宽高比为 3:4 的封面
格式比例要求：比例任意，单张最大不能超过10M，仅支持JPG/PNG/WEBP格式		  
coverInfo.ratio169否string宽高比为 16:9 的封面
格式比例要求：比例任意，单张最大不能超过10M，仅支持JPG/PNG/WEBP格式		  
coverInfo.ratio916否string宽高比为 9:16 的封面
格式比例要求：比例任意，单张最大不能超过10M，仅支持JPG/PNG/WEBP格式		  
UCG字段（ugcInfo，仅cardContent=8需填写）     
ugcInfo.authorName否stringugc 内容的作者名{
 "ugcInfo" : {
  "authorName" : "好个秋",
  "authorAvatar" : "https://image.com/author_1.png"
 }
}		img
ugcInfo.authorAvatar否stringugc 内容作者头像  

response

{
    "result": 1,
    "error_msg": "success"
}

错误码说明

ERROR CODE 描述 处理方式
1 成功
10000200 参数错误 根据error_msg提示，检查参数是否合法
100200102 无效的 access_token 重新获取 access_token
10000412 小程序应用信息不存在 检查自己的appId 是否写错
10000500 内部错误 保存错误现场，反馈给小程序开发团队
10000505 视频转码中 开发者稍后重试接口，等待highLightVideoId转码成功
10000411 内容不存在 如果确定内容有上传过，重试删除
仍有疑问? 前往社区提问
Copyright ©2024, All Rights Reserved