开发 能力接入指南 批量挂载能力
# 批量挂载能力
更新时间:2024-02-29 11:54:30
# 能力简介
通过快手开放平台 - 开放接口批量同步内容 ,并在内容上关联小程序,则视频在传播时,小程序会以锚点形式展现在视频详情页左下角 ,展现形态和短视频挂载小程序一致(快手小程序平台与快手开放平台非一个平台) 。
# 应用方法
在快手开放平台(非小程序平台)注册并审批完成后,使用 创建视频 (opens new window) 能力批量创建视频,视频发布成功后,使用视频挂载小程序挂件能力,将小程序挂载到视频上 。
# 操作指导
# 批量挂载权限申请
说明项 | 内容 |
申请入口 | 小程序开发者平台 / 流量管理 / 批量挂载 |
申请条件 | 小程序需已上线,且已开通“短视频挂载”能力 需要一个已上线的快手开放平台应用,用于关联开通批量挂载能力 |
注意事项 | 请注意不要混淆" 快手开放平台的应用ID" 和小程序的" Appid " 批量挂载能力依赖短视频挂载能力,若短视频挂载能力因内容不相关或运营违规等问题被收回,批量挂载能力将同步收回 |
问题反馈 | 请在开发者社区反馈相关问题 |
# 创建视频
创建一个视频需要执行发起上传、上传视频、发布视频 三个步骤,具体参见 快手开放平台文档 (opens new window) 。
特别注意: 创建视频时所需要的 app_id、 access_token 参数非小程序。
# 视频挂载小程序
在批量上传的视频左下角添加小程序组件,用户点击组件即可跳转进入该小程序对应落地页,具体方式参见以下说明 :
调用该接口前,需要保证:
说明项 | 内容 |
---|---|
小程序已上线 | 开发者需要在小程序开发者平台拥有自己的小程序,需已上线并开通短视频挂载能力 |
开放平台应用ID | 要关联的开放平台应用已经上线,在授权时指定scope:user_video_mp_plc,来请求用户授权在他的视频上挂载挂件 |
挂载小程序组件前需要保证作品已发布成功 | 如果是通过“创建视频”接口 (opens new window)发布的作品,需要延时挂载小程序。作品的发布是一个异步的过程,从publish接口成功返回到作品真正发布成功1分钟左右的延时,建议采用延时任务+失败重试的方式来挂载小程序,作品发布成功的标志是:使用“查询视频”接口 (opens new window)能获取到作品信息 |
# 接口地址
POST: https://open.kuaishou.com/openapi/photo/mp_plc/bind
content-type: x-www-form-urlencoded
注意:需要在用户授权接口的scope参数中添加user_video_mp_plc,获取对用户视频挂载小程序挂件的授权
# 请求参数
参数 | 类型 | 含义 | 是否必填 |
access_token | string | oauth令牌,需要包含scope:user_video_mp_plc的授权 | 是 |
app_id | string | 快手开放平台注册后生成的id | 是 |
photo_id | string | 作品id,作品需要满足: 1、作品存在且发布成功 2、token中的用户是此作品的作者 3、作品未挂载过小程序挂件 | 是 |
plc_mp_app_id | string | 挂载的小程序的app_id,需满足: 1、存在且为小程序类型 2、已在小程序平台中把当前用户id配置到“可发布当前小程序挂件”的用户白名单中 | 是 |
plc_title | string | 小程序组件的标题 | 是 |
plc_mp_path | string | 小程序组件跳转到的小程序页面路径 | 是 |
# 响应结果示例
{
"result": 1,
"error_msg" : ""
}
# 响应结果的字段说明
字段 | 字段说明 |
---|---|
result | 错误码,1表示成功 |
error_msg | 错误提示信息 |
# 错误码含义
错误码 | 含义 |
10000304 | 标题检测到敏感词 |
10000412 | app信息不存在 |
10001000 | 作品id不正确 |
10001001 | 作品不存在(如果是通过open api发布的作品,可能是发布还未成功) |
10001002 | 当前用户不是此作品的作者 |
10001004 | 当前用户不在可挂载小程序挂件的用户白名单中 如有此错误,请联系小程序管理员添加用户到白名单中 |
10001005 | 作品上已经绑定了小程序的挂件,不可以重复绑定 |
10001006 | 参数plc_mp_app_id对应的app不是小程序 |
10001007 | path非法(path检测是以最新版本的小程序包为准) |
10001008 | 小程序与当前应用不存在有效的关联关系 |
10000500 | token不在有效期内或appid不正确 |
# 运营规范
通过接口批量上传视频挂载小程序,其展现形态与手动发布视频挂载小程序一致 ,开发者在应用该能力时需要保证快手视频-小程序挂载文案-小程序落地⻚三者间有较强的相关性。
违规行为 | 处罚说明 |
---|---|
无相关性或相关性较弱 | 若发现视频-小程序锚点文案-小程序落地⻚三者间无相关性或相关性较弱:解绑挂载内容,如实际情况严重或多次出现不相关性,关闭该小程序视频挂载能力。 |
虚假宣传、诱导点击及其他低质不合规问题 | 挂载文案、小程序落地⻚出现虚假宣传、诱导点击及其他低质不合规问题:解绑相关挂载内容 ,并关闭该小程序视频挂载能力,并视违规程度将小程序下架;同一主体下多个帐号均存在类似违规行为的,根据违规程度对该主体下所有小程序采取限制功能直至拒绝再向该主体提供任何注册或认证服务。 |
上一篇:《短视频挂载能力》
下一篇:《直播间挂载能力》
仍有疑问? 前往社区提问