物料同步接口
更新时间:2024-06-07
物料同步接口
接口说明
百度提供的物料内容同步接口, 用于批量同步物料库数据。
请求示例
HTTP方法:POST
请求URL:https://airec.baidu.com/airec/api/omni/cms/batch-sync
Header如下:
参数名 | 类型 | 是否必填 | 说明 |
---|---|---|---|
Content-Type | - | 是 | application/json;charset=UTF-8 |
X-Gw-Ak | string | 是 | 数据表鉴权信息 |
Alias-Name | string | 是 | 数据表名称 |
code | string | 是 | 数据表类型 |
id | string | 是 | 数据表id |
请求格式
POST 方式调用
注意:要求使用由 JSON 组成的数组格式的结构体来描述一个请求的具体内容,最大支持20条。
请求参数
图文物料:
参数名 | 中文名 | 类型 | 是否必填 | 备注 |
---|---|---|---|---|
nid | 物料唯一标识 | string | 是 | 一条物料的唯一标识,物料id不能重复 |
site_name | 站点名称 | string | 否 | 站点名称 |
title | 物料标题 | string | 是 | 标题 |
content | 文章正文 | string | 是 | 文章正文,主要用来进行语义分析提取物料特征 |
publish_time | 发布时间 | long | 是 | 物料发布时间,可以用于最新物料召回的策略,13位时间戳:示例 1648561924764 |
ts | 上传时间 | long | 是 | 物料上传时间, 格式: 13位时间戳,示例 1648561924764 |
status | 状态 | int | 是 | 物料上下架状态, 0(下架)、1(上架),只有上架状态的物料可被推荐,建议上架状态的物料占比不低于60%。 |
author_id | 作者ID | string | 否 | 当前图文物料的作者id,暂不支持多个 |
author | 作者昵称 | string | 否 | 当前图文物料的作者名称,暂不支持多个 |
channels | 频道 | strings | 否 | 频道列表,数组格式,["体育", "美食"] |
tags | 自有标签 | strings | 否 | 业务方运营的标签,主要用作标签召回,支持多个值 |
category | 类别 | string | 否 | 文章类别,用于文章分类和筛选。 |
sub_category | 子类别 | string | 否 | 子类别,用于文章存在级联子分类和筛选。 |
url | 图文地址 | string | 否 | 图文地址 |
cities | 城市名称或编码列表 | strings | 否 | 所属城市列表:["beijing", "shanghai"] |
content_type | 物料类型 | string | 否 | 图文为article、视频为video,不传默认为article |
summary | 物料摘要 | strings | 否 | 物料摘要 |
search_hint | 搜索提示词 | string | 否 | 搜索提示词,["西红柿炒鸡蛋怎么做", "西红柿炒鸡蛋好吃吗"] |
商品物料:
参数名 | 中文名 | 类型 | 是否必填 | 备注 |
---|---|---|---|---|
nid | 商品唯一标识 | string | 是 | 一条商品的唯一标识,商品id不能重复 |
title | 商品标题 | string | 是 | 商品标题,主要用来进行语义分析提取物料特征 |
content | 商品描述 | string | 否 | 商品描述,主要用来进行语义分析提取商品特征 |
publish_time | 商品上架时间 | long | 是 | 商品上架时间,可以用于最新商品召回的策略,13位时间戳 |
ts | 上传时间 | long | 是 | 商品上传时间, 格式: 13位时间戳 |
status | 商品状态 | int | 是 | 商品上下架状态, 0(下架)、1(上架),只有上架状态的商品可被推荐,建议上架状态的商品占比不低于60% |
shop_id | 店铺ID | string | 否 | 当前商品物料的店铺id,暂不支持多个 |
brand | 商品品牌 | string | 否 | 商品品牌 |
tags | 商品自有标签 | strings | 否 | 商品标签,如首页展示标签“特惠”,“热卖”,或详情页“满50包邮”,“假一赔三”等 |
category | 类别 | string | 否 | 商品类别,用于商品分类和筛选。 |
sub_category | 子类别 | string | 否 | 子类别,用于商品存在级联子分类和筛选。 |
source | 商品来源类型 | string | 否 | 商品来源类型,如自营/第三方 |
price | 商品价格 | float | 否 | 商品价格 |
rating | 商品评分 | string | 否 | 商品的评分 |
cities | 城市名称或编码列表 | strings | 否 | 物料所属的城市列表,如["beijing", "shanghai"] |
媒资物料:
参数名 | 中文名 | 类型 | 是否必填 | 备注 |
---|---|---|---|---|
nid | 物料唯一标识 | string | 是 | 一条物料的唯一标识,物料id不能重复 |
title | 媒资标题 | string | 是 | 电影、剧集、节目等标题,主要用来进行语义分析提取物料特征 |
display_run_time | 媒资时长 | int | 否 | 播放时长(秒) |
content | 商品描述 | string | 否 | 商品描述,主要用来进行语义分析提取商品特征 |
publish_time | 商品上架时间 | long | 是 | 商品上架时间,可以用于最新商品召回的策略,13位时间戳 |
ts | 上传时间 | long | 是 | 商品上传时间, 格式: 13位时间戳 |
status | 商品状态 | int | 是 | 商品上下架状态, 0(下架)、1(上架),只有上架状态的商品可被推荐,建议上架状态的商品占比不低于60% |
shop_id | 店铺ID | string | 否 | 当前商品物料的店铺id,暂不支持多个 |
brand | 商品品牌 | string | 否 | 商品品牌 |
tags | 商品自有标签 | strings | 否 | 商品标签,如首页展示标签“特惠”,“热卖”,或详情页“满50包邮”,“假一赔三”等 |
category | 类别 | string | 否 | 商品类别,用于商品分类和筛选。 |
sub_category | 子类别 | string | 否 | 子类别,用于商品存在级联子分类和筛选。 |
source | 商品来源类型 | string | 否 | 商品来源类型,如自营/第三方 |
price | 商品价格 | float | 否 | 商品价格 |
rating | 商品评分 | string | 否 | 商品的评分 |
cities | 城市名称或编码列表 | strings | 否 | 物料所属的城市列表,如["beijing", "shanghai"] |
country | 国家地区 | string | 否 | 发布国家 |
year | 上映年份 | string | 否 | 上映年份,用作特征,如生成某年的排行榜。 |
desc | 媒资描述 | string | 否 | 视频描述,主要用来进行语义分析提取物料特征 |
actors | 演员列表 | strings | 否 | 演员列表,支持多个值 |
directors | 创作者 | strings | 否 | 媒资创作者/导演/出品方id,支持多个值 |
view_point | 看点 | string | 否 | 内容看点 |
score | 评分 | string | 否 | 评分 |
data_source | 物料来源(电信/移动/联通/其它) | string | 是 | 运营商或运营商编码: 电信/移动/联调/其它 |
epi_type | 媒资类型 | string | 否 | 物料类型,program单剧集、series连续剧/系列剧、episode子集、channel频道、schedule节目单、album专栏、subject专题 |
content_type | 内容类型 | string | 否 | 指定内容是视频还是图文类型 |
base_tags | 媒资标签 | strings | 否 | 内容标签,支持多个值 |
op_tags | 运营标签 | strings | 否 | 业务方运营的标签 |
show_tags | 展示标签 | strings | 否 | 展示标签 |
valid_time | 生效时间 | long | 否 | 物料生效时间, 用于控制物料可被推荐的生效时间,13位时间戳 |
expire_time | 过期时间 | long | 否 | 物料失效时间,用于控制物料过期后不被推荐的场景,13位时间戳 |
publish_time | 发布时间 | long | 是 | 发布时间, 格式: 13位时间戳 |
operator_id | 运营商ID | string | 否 | 运营商(电信、联通、移动等) |
operator_name | 运营商名称 | string | 否 | 运营商(电信、联通、移动等) |
provider_id | 供应商ID, 直播情况下为直播的频道ID | string | 否 | 供应方ID,媒资提供商或者来源,用作特征 |
provider_name | 供应商, 直播情况下为直播的频道名称 | string | 否 | 供应方名称,媒资提供商或者来源,用作特征 |
need_pay | 是否付费 | int | 否 | 是否付费,0(不付费)、1(付费) |
channels | 频道 | strings | 否 | 用户自定义标签,可在推荐接口作为推荐条件进行数据过滤 |
ts | 上传时间 | long | 是 | 物料上传时间, 格式: 13位时间戳 |
url | 视频地址 | string | 否 | 视频地址 |
language | 影视语言 | string | 否 | 媒资所用语言,用作特征 |
award | 获奖 | string | 否 | 用作特征 |
definition | 清晰度 | string | 否 | 用作特征 |
cities | 城市名称或编码列表 | strings | 否 | 物料所属的城市列表 |
live_tags | 直播时间戳标签列表 | strings | 否 | 直播标签 |
media_code | 媒资编码 | string | 否 | 媒资编码 |
base_tag_codes | 媒资编码 | strings | 否 | 媒资编码 |
compere | 主持人 | strings | 否 | 主持人 |
type | 类型标识 | string | 是 | 包含电视剧、电影、综艺、儿童动漫、新闻、音乐、体育、纪录片、游戏、直播、短内容合辑、戏曲、公开课,其他类型填未知,用作特征 |
type_code | 类型标识编码 | string | 否 | 类型标识编码 |
heat | 热度 | float | 否 | 热度 |
is_subset | 是否是子集(如花千骨第二集) | int | 否 | 是否是子集(如花千骨第二集),0(不是)、1(是) |
series_type | 系列剧类型 | string | 否 | 连续剧/系列片 |
vod_type | 剧集类型 | string | 否 | vod:单剧集 episode:连续剧子集 series2:系列剧子集 |
biz_domain | 业务类型 | string | 否 | 0 :IPTV 业务(默认) 2 :WEBTV 业务 3:混合 IPTV 和 WEBTV业务 |
poster | 竖图文件路径 | string | 否 | 海报,对应内容的竖图文件在图片服务器中保存路径 |
still | 横图文件路径 | string | 否 | 海报,对应内容的横图文件在图片服务器中保存路径 |
opimg1 | 运营图1文件路径 | string | 否 | /op/op1.img 运营图1文件在图片服务器中保存路径 |
opimg2 | 运营图2文件路径 | string | 否 | /op/op2.img 运营图2文件在图片服务器中保存路径 |
base_mark | 基础角标标识 | string | 否 | 基础角标标识,如/base/mark.img |
op_mark | 运营角标标识 | string | 否 | 运营角标标识,如/op/mark.img |
ext1 | string类型拓展字段1 | string | 否 | string类型拓展字段1 |
ext2 | string类型拓展字段2 | string | 否 | string类型拓展字段2 |
ext3 | string类型拓展字段3 | string | 否 | string类型拓展字段3 |
ext_list1 | string list类型拓展字段1 | strings | 否 | string list类型拓展字段1 |
ext_list2 | string list类型拓展字段2 | strings | 否 | string list类型拓展字段2 |
ext_list3 | string list类型拓展字段3 | strings | 否 | string list类型拓展字段3 |
status | 物料上下架状态 | int | 是 | 物料状态:0下架,1上架 |
请求示例
[{
"nid": "nid_1",
"site_name": "mr.yesterday",
"title": "杂诗-王维-1",
"content": "双燕初命子,五桃新作花, 来日绮窗前,寒梅著花未。",
"author_id": "author_123456_id_1",
"publish_time": 1648561924764,
"status": 1,
"ts": 1609768813182
}]
返回格式
JSON格式
返回参数
参数名 | 类型 | 是否必填 | 说明 |
---|---|---|---|
success | boolean | 是 | 成功标识 |
code | string | 是 | 响应码:0正常,其他异常 |
message | string | 否 | 响应描述 |
result | dict | 是 | 响应数据 |
返回示例
{
"success": true,
"code": "0",
"message": null,
"result": null
}