行为同步接口

更新时间：2024-11-13

行为同步接口

接口说明

百度提供的交互行为数据批量同步接口，适用于在线实时调用，回传用户行为。

请求示例

HTTP方法：POST

请求URL：https://airec.baidu.com/airec/api/omni/ms/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	物料唯一标识nid	string	是	物料唯一标志，当nid非必需时，推荐传入空字符串""
uid	用户UID	string	是	用户唯一标志
event	用户行为	string	是	行为类型：show展现、click点击、collect收藏、follow关注、like喜欢、dislike不喜欢、search搜索、share分享、comment评论等
ts	行为发生时间	long	是	行为发生时间，毫秒，格式: 13位时间戳，如1648561924764
traceid	推荐trace id	string	是	推荐请求唯一标志, 来自百度推荐接口的traceid;如果是非百度推荐的行为数据则传selftrace
query	搜索query	string	否	用户的搜索query
scene_type	行为场景类型	string	否	用户行为场景，p_rec:个性化推荐场景、r_rec:相关推荐场景、h_rec:热门推荐场景、search:搜索场景
event_scene	行为的场景标识	string	否	行为的场景，可以传入客户自定义的场景标识，如首页，详情页等场景id
event_value	行为信息	string	否	用户行为信息。支持将nid、tags、author_id加入黑名单，仅当event值为dislike时，该配置才会生效，示例传参：'dislike_class:tags=科技'

商品行为：

参数名	中文名	类型	是否必填	备注
nid	物料唯一标识nid	string	是	物料唯一标志，当nid非必需时，推荐传入空字符串""
uid	用户UID	string	是	用户唯一标志
event	用户行为	string	是	行为类型：show展现、click点击、collect收藏、follow关注、like喜欢、dislike不喜欢、search搜索、share分享、comment评论等
ts	行为发生时间	long	是	行为发生时间，毫秒，格式: 13位时间戳，如1648561924764
traceid	推荐trace id	string	是	推荐请求唯一标志, 来自百度推荐接口的traceid;如果是非百度推荐的行为数据则传selftrace
query	搜索query	string	否	用户的搜索query
scene_type	行为场景类型	string	否	用户行为场景，p_rec:个性化推荐场景、r_rec:相关推荐场景、h_rec:热门推荐场景、search:搜索场景
event_scene	行为的场景标识	string	否	行为的场景，可以传入客户自定义的场景标识，如首页，详情页等场景id
event_value	行为信息	string	否	用户行为信息。支持将nid、tags、author_id加入黑名单，仅当event值为dislike时，该配置才会生效，示例传参：'dislike_class:tags=科技'

媒资行为：

参数名	中文名	类型	是否必填	备注
nid	物料唯一标识nid	string	是	物料唯一标志，当nid非必需时，推荐传入空字符串""
uid	用户UID	string	是	用户唯一标志
event	用户行为	string	是	行为数据类型, 购买buy 搜索点击search_click 曝光rec_show 推荐点击rec_click 直播tv_playing 点播vod_playing回看tvod_playing 时移timeshift 不喜欢dislike等
ts	行为发生时间	long	是	行为发生时间，毫秒，格式: 13位时间戳，如1648561924764
traceid	推荐trace id	string	是	推荐请求唯一标志, 来自百度推荐接口的traceid;如果是非百度推荐的行为数据则传selftrace
context_id	详情页媒资id	string	否	详情页媒资id
event_value	行为信息	string	否	用户行为信息。支持将nid、tags、author_id加入黑名单，仅当event值为dislike时，该配置才会生效，示例传参：'dislike_class:tags=科技'
scene_type	行为场景类型	string	否	用户行为场景，p_rec:个性化推荐场景、r_rec:相关推荐场景、h_rec:热门推荐场景、search:搜索场景
base_tags	媒资标签	strings	否	内容标签,支持多个值
actors	演员列表	strings	否	演员列表，支持多个值
directors	创作者	strings	否	媒资创作者/导演/出品方id,支持多个值
channels	频道	strings	否	用户自定义标签，可在推荐接口作为推荐条件进行数据过滤
epi_type	媒资类型	string	否	物料类型，program单剧集、series连续剧/系列剧、episode子集、channel频道、schedule节目单、album专栏、subject专题
type	类型标识	string	是	包含电视剧、电影、综艺、儿童动漫、新闻、音乐、体育、纪录片、游戏、直播、短内容合辑、戏曲、公开课，其他类型填未知，用作特征

请求示例

[{
    "uid": "uid_1001",
    "nid": "nid_1001",
    "event": "dislike",
    "ts": 1609768813182,
    "traceid": "traceid_1001", 
    "query": "王维", 
    "scene_type": "0", 
    "event_scene": "scene_1",
    "event_value": "dislike_class:tags=科技"}
}]

返回格式

JSON格式

返回参数

参数名	类型	是否必填	说明
success	boolean	是	成功标识
code	string	是	响应码：0正常，其他异常
message	string	是	响应描述
result	dict	是	响应数据

返回示例

{
    "success": true,
    "code": "0",
    "message": null,
    "result": null
}

行为数据traceid获取方法

（1）历史行为数据

默认传selftrace

（2）新行为数据

调用百度推荐接口的场景

推荐系统会为每一次推荐请求结果分配唯一id，用户在调取个性化推荐或者相关推荐接口时请保存此id，将推荐给用户的物料反馈行为回传给推荐系统。

非调用百度推荐接口的场景默认传selftrace

操作指南

用户同步接口

百度智能云

智能推荐引擎 AI_REC

智能推荐引擎 AI_REC

行为同步接口

行为同步接口

行为数据traceid获取方法