11111
剧本ID:
966540
角色: 1男0女 字数: 1286
作者:新晋鲸民675940
关注
0
0
0
0
简介
111
普本古代玄幻仙侠
角色
张三
这个角色非常的神秘,他的简介遗失在星辰大海~
正文

剧本流量埋点客户端对接文档1. 目的该文档仅用于客户端接入剧本流量埋点。客户端需要上报两类事件:exposure:剧本卡片完成一次有效曝光detail_enter:用户成功进入剧本详情页2. 接口2.1 请求地址POST /event-tracking/article/flow2.2 请求方式POSTJSON body2.3 请求示例{ "events": [ { "type": "exposure", "event_id": "4f58b334-1db9-4f11-a8d0-cc3b26f2f001", "article_id": 12345, "scene_code": "discover_guess_like", "page_session_id": "discover-20260515-abc123" }, { "type": "detail_enter", "event_id": "4f58b334-1db9-4f11-a8d0-cc3b26f2f002", "article_id": 12345, "scene_code": "discover_guess_like", "page_session_id": "discover-20260515-abc123" } ] } 3. 字段说明3.1 请求字段字段名类型必填说明eventsarray是事件列表,支持批量上报3.2 单条事件字段字段名类型必填适用事件说明typestring是全部事件类型,取值见下文event_idstring是全部事件唯一 ID,每条事件都必须唯一article_idint是全部当前剧本 IDscene_codestring是全部当前入口标识,取值见下文page_session_idstringexposure 必填,detail_enter 建议传曝光必填,访问建议当前页面会话 ID3.3 服务端自动处理字段以下字段不需要客户端传:uid:服务端从登录态获取event_time:服务端记录当前时间4. 事件类型枚举取值含义上报时机exposure一次有效曝光卡片满足曝光条件后上报detail_enter一次详情页成功进入详情页真正打开成功后上报5. 上报规则5.1 exposure 上报规则客户端在列表页中,当剧本卡片满足曝光条件后,上报 exposure。要求:同一页面会话内,同一 scene_code + article_id 只上报一次不要在接口返回时直接上报不要在卡片刚渲染时直接上报需要在客户端确认“达到曝光条件”后再上报推荐做法:页面进入时生成 page_session_id页面生命周期内复用同一个 page_session_id本地维护一个已曝光集合某个剧本首次满足曝光条件时再上报示例:{ "type": "exposure", "event_id": "4f58b334-1db9-4f11-a8d0-cc3b26f2f001", "article_id": 12345, "scene_code": "discover_guess_like", "page_session_id": "discover-20260515-abc123" } 5.2 detail_enter 上报规则客户端在用户成功进入剧本详情页后,上报 detail_enter。要求:不是点击卡片时上报是详情页真正打开成功后上报示例:{ "type": "detail_enter", "event_id": "4f58b334-1db9-4f11-a8d0-cc3b26f2f002", "article_id": 12345, "scene_code": "discover_guess_like", "page_session_id": "discover-20260515-abc123" } 6. event_id 生成规则event_id 用于标识一条唯一事件。要求:每条事件都生成一个新的 event_id不要复用旧值推荐使用 UUID示例:4f58b334-1db9-4f11-a8d0-cc3b26f2f0014f58b334-1db9-4f11-a8d0-cc3b26f2f0027. page_session_id 生成规则page_session_id 用于标识“用户这一次浏览该页面”的会话范围。要求:每次进入一个流量列表页时生成一个新的 page_session_id页面刷新后重新生成退出页面再进入后重新生成同一页面生命周期内复用同一个 page_session_id推荐格式:页面标识-日期-随机串示例:discover-20260515-abc123room-script-20260515-xyz7898. scene_code 枚举客户端只能使用下面约定好的入口枚举,不允许自由拼接字符串。中文入口scene_code剧本发现页-bannerdiscover_banner剧本发现页-找本列表discover_list剧本发现页-找本列表-推荐discover_list_recommend剧本发现页-排行榜discover_rank剧本宝藏馆treasure_gallery外语本专区foreign_language_zone活动详情页activity_detail荣誉殿堂honor_hall剧本发现页-编辑力荐discover_editor_pick编辑力荐详情页editor_pick_detail剧本发现页-新剧推送discover_new_release剧本发现页-榜单区discover_rank_block剧本发现页-推荐作者discover_recommend_author剧本发现页-外语本discover_foreign_language剧本发现页-猜你喜欢discover_guess_like房间剧本-导航页-bannerroom_script_nav_banner房间剧本-鲸选-今日必玩room_script_today_pick房间剧本-鲸选-新本强推room_script_new_hot房间剧本-鲸选-编辑推荐room_script_editor_pick房间剧本-鲸选-获奖剧本room_script_award房间剧本-鲸选-大bannerroom_script_big_banner房间剧本-鲸选-猜你想玩room_script_guess_like房间剧本-榜单room_script_rank房间剧本-本库列表room_script_library_list房间剧本-本库-推荐模块room_script_library_recommend9. 批量上报建议支持批量上传多个事件,建议客户端按以下方式使用:同一页面短时间内产生多条曝光事件时,合并到一次请求里访问事件也可以和曝光事件一起批量提交但每条事件仍然必须拥有独立的 event_id示例:{ "events": [ { "type": "exposure", "event_id": "uuid-1", "article_id": 1001, "scene_code": "discover_banner", "page_session_id": "discover-20260515-abc123" }, { "type": "exposure", "event_id": "uuid-2", "article_id": 1002, "scene_code": "discover_banner", "page_session_id": "discover-20260515-abc123" }, { "type": "detail_enter", "event_id": "uuid-3", "article_id": 1002, "scene_code": "discover_banner", "page_session_id": "discover-20260515-abc123" } ] } 10. 客户端接入结论客户端接入时,只需要保证以下几点:正确区分 exposure 和 detail_enter每条事件生成唯一 event_id曝光事件带上正确的 page_session_id只使用约定好的 scene_code曝光在满足条件后上报访问在详情页真正打开成功后上报做到以上几点即可完成客户端对接。

剧本流量埋点客户端对接文档1. 目的2. 接口2.1 请求地址2.2 请求方式2.3 请求示例3. 字段说明3.1 请求字段3.2 单条事件字段3.3 服务端自动处理字段4. 事件类型枚举5. 上报规则5.1 exposure 上报规则5.2 detail_enter 上报规则6. event_id 生成规则7. page_session_id 生成规则8. scene_code 枚举9. 批量上报建议10. 客户端接入结论

打开APP