资源位预置事件
版本要求:资源位功能要求智能运营最低版本为:4.3.2。
若选择不采集下述预置事件,则在资源位中,‘曝光’ 和 ‘点击’ 指标为 0,且在神策分析中查询不到对应事件。
事件英文变量名 | 事件显示名 | 属性英文变量名 | 事件属性显示名 | 属性值类型 | 属性值示例或说明 | 触发时机 | 应埋点平台 | 备注 |
---|---|---|---|---|---|---|---|---|
itemShow | 物品曝光 | section_id | 资源位 ID | 字符串 | 用于区分应用推荐结果的不同资源位(运营位),如首页 banner 位、首页 feed 流、物品详情页相关推荐等。由客户在创建资源位时定义 section_id 取值,建议以 “页面_频道(或模块)” 的形式命名。 | 封面露出70%时上报,且页面未刷新时不重复上报 | Andriod/iOS 在填写“应埋点平台”字段时,请严格按照下述中所示枚举值填写,如该事件需要在安卓端和iOS端进行埋点,请填写:“Andriod/iOS”,除Android、iOS、JavaScript、小程序、服务端之外,请填写“其他”。 | 必传字段,由神策提供,并在接口调用结果中以 section_id 字段下发给客户。客户后端向前端下发推荐结果中必须带此字段,前端行为事件上报中将此字段传回。 |
strategy_id | 资源位的策略 ID | 字符串 | 该字段用于标识用户命中并生效的是资源位下的哪个策略 ID。需要注意的是,该字段是指资源位下关联了人群或者分配到了流量的策略 ID,不是推荐策略库中的策略 id。 | 必传字段,由神策提供,并在接口调用结果中以 strategy_id 字段下发给客户。客户后端向前端下发推荐结果中必须带此字段,前端行为事件上报中将此字段传回。 | ||||
retrieve_version_id | 资源位的策略版本 ID | 字符串 | 一个线上策略多次编辑会产生多个版本,该字段用于标识用户命中并生效的是资源位下的哪个策略 版本 ID。 | 可选字段,由神策提供,并在接口调用结果中以 retrieve_version_id 字段下发给客户。 | ||||
strategy_type | 策略类型 | 字符串 | 用于区分不同的策略类型,如:TOP_ITEM 表示置顶物品。 | 必传字段,由神策提供,并在接口调用结果中以 strategy_type 字段下发给客户。客户后端向前端下发推荐结果中必须带此字段,前端行为事件上报中将此字段传回。 | ||||
log_id | 请求 ID | 字符串 | 请求的唯一标识,用于将某一物品的展现和点击联系起来,某一被推荐物品在被展现和点击时,log_id 要保持一致。 | 必传字段,由神策提供,并在接口调用结果中以 log_id 字段下发给客户。客户后端向前端下发推荐结果中必须带此字段,前端行为事件上报中将此字段传回。 | ||||
item_type | 物品类型 | 字符串 | 取值只能由英文小写或者数字组成,且必须与 item 表中 item_type 的值一致。 | |||||
item_id | 物品 ID | 字符串 | 取值只能由英文小写或者数字组成,且必须与 item 表中 item_id 的值一致。 | |||||
itemClick | 物品点击 | section_id | 资源位 ID | 字符串 | 用于区分应用推荐结果的不同资源位(运营位),如首页 banner 位、首页 feed 流、物品详情页相关推荐等。由客户在创建资源位时定义 section_id 取值,建议以 “页面_频道(或模块)” 的形式命名。 | 点击物品时触发 | Andriod/iOS 在填写“应埋点平台”字段时,请严格按照下述中所示枚举值填写,如该事件需要在安卓端和iOS端进行埋点,请填写:“Andriod/iOS”,除Android、iOS、JavaScript、小程序、服务端之外,请填写“其他”。 | 必传字段,由神策提供,并在接口调用结果中以 section_id 字段下发给客户。客户后端向前端下发推荐结果中必须带此字段,前端行为事件上报中将此字段传回。 |
strategy_id | 资源位的策略 ID | 字符串 | 该字段用于标识用户命中并生效的是资源位下的哪个策略 ID。需要注意的是,该字段是指资源位下关联了人群或者分配到了流量的策略 ID,不是推荐策略库中的策略 id。 | 必传字段,由神策提供,并在接口调用结果中以 strategy_id 字段下发给客户。客户后端向前端下发推荐结果中必须带此字段,前端行为事件上报中将此字段传回。 | ||||
retrieve_version_id | 资源位的策略版本 ID | 字符串 | 一个线上策略多次编辑会产生多个版本,该字段用于标识用户命中并生效的是资源位下的哪个策略 版本 ID。 | 可选字段,由神策提供,并在接口调用结果中以 retrieve_version_id 字段下发给客户。 | ||||
strategy_type | 策略类型 | 字符串 | 用于区分不同的策略类型,如:TOP_ITEM 表示置顶物品。 | 必传字段,由神策提供,并在接口调用结果中以 strategy_type 字段下发给客户。客户后端向前端下发推荐结果中必须带此字段,前端行为事件上报中将此字段传回。 | ||||
log_id | 请求 ID | 字符串 | 请求的唯一标识,用于将某一物品的展现和点击联系起来,某一被推荐物品在被展现和点击时,log_id 要保持一致。 | 必传字段,由神策提供,并在接口调用结果中以 log_id 字段下发给客户。客户后端向前端下发推荐结果中必须带此字段,前端行为事件上报中将此字段传回。 | ||||
item_type | 物品类型 | 字符串 | 取值只能由英文小写或者数字组成,且必须与 item 表中 item_type 的值一致。 | |||||
item_id | 物品 ID | 字符串 | 取值只能由英文小写或者数字组成,且必须与 item 表中 item_id 的值一致。 | |||||
bannerShow | Banner 曝光 | section_id | 资源位 ID | 字符串 | 用于区分应用推荐结果的不同资源位(运营位),如首页 banner 位、首页 feed 流、物品详情页相关推荐等。由客户在创建资源位时定义 section_id 取值,建议以 “页面_频道(或模块)” 的形式命名,如 startuplogo(开机图)。 目前取值枚举:home_banner。 | Banner 曝光时触发 | Andriod/iOS 在填写“应埋点平台”字段时,请严格按照下述中所示枚举值填写,如该事件需要在安卓端和iOS端进行埋点,请填写:“Andriod/iOS”,除Android、iOS、JavaScript、小程序、服务端之外,请填写“其他”。 | 必传字段,由神策提供,并在接口调用结果中以 section_id 字段下发给客户。客户后端向前端下发推荐结果中必须带此字段,前端行为事件上报中将此字段传回。 |
priority | 优先级 | 字符串 | 用于区分同一帧位的多张轮播图展示的优先级,若一个帧位上只配置了一张轮播图时,优先级为 1。 | 可选字段,由神策提供,并在接口调用结果中以 priority 字段下发给客户。 | ||||
strategy_id | 资源位的策略 ID | 字符串 | 该字段用于标识用户命中并生效的是资源位下的哪个策略 ID。需要注意的是,该字段是指资源位下关联了人群或者分配到了流量的策略ID,不是推荐策略库中的策略id。 | 必传字段,由神策提供,并在接口调用结果中以 strategy_id 字段下发给客户。客户后端向前端下发推荐结果中必须带此字段,前端行为事件上报中将此字段传回。 | ||||
retrieve_version_id | 资源位的策略版本 ID | 字符串 | 一个线上策略多次编辑会产生多个版本,该字段用于标识用户命中并生效的是资源位下的哪个策略 版本 ID。 | 可选字段,由神策提供,并在接口调用结果中以 retrieve_version_id 字段下发给客户。 | ||||
rec_frame_site | Banner 序号 | 数值 | 该栏位下 Banner 的帧位顺序。 | 必传字段,由神策提供,并在接口调用结果中以 rec_frame_site 字段下发给客户。客户后端向前端下发推荐结果中必须带此字段,前端行为事件上报中将此字段传回。 | ||||
log_id | 请求 ID | 字符串 | 请求的唯一标识,用于将某一物品的展现和点击联系起来,某一被推荐物品在被展现和点击时,log_id 要保持一致。 | 该字段的取值由客户提供,客户后端需给每次的推荐请求设置唯一请求 ID 来作为 log_id,即客户的 request_id。客户后端向前端下发推荐结果中必须带此字段,前端行为上报中需将此字段传回。 | ||||
$sf_plan_strategy_id | 实验组 ID | 字符串 | AB 实验分流标识,运营策略开启 AB 实验后,用于区分用户命中的 AB 实验组名称。 | 必传字段,由神策提供,并在接口调用结果中以 experiment_name 字段下发给客户。客户后端向前端下发推荐结果中必须带此字段,前端行为事件上报中将此字段传回。 | ||||
bannerClick | Banner 点击 | section_id | 资源位 ID | 字符串 | 用于区分应用推荐结果的不同资源位(运营位),如首页 banner 位、首页 feed 流、物品详情页相关推荐等。由客户在创建资源位时定义 section_id 取值,建议以 “页面_频道(或模块)” 的形式命名,如 startuplogo(开机图)。 目前取值枚举:home_banner。 | 点击 Banner 时触发 | Andriod/iOS 在填写“应埋点平台”字段时,请严格按照下述中所示枚举值填写,如该事件需要在安卓端和iOS端进行埋点,请填写:“Andriod/iOS”,除Android、iOS、JavaScript、小程序、服务端之外,请填写“其他”。 | 必传字段,由神策提供,并在接口调用结果中以 section_id 字段下发给客户。客户后端向前端下发推荐结果中必须带此字段,前端行为事件上报中将此字段传回。 |
priority | 优先级 | 字符串 | 用于区分同一帧位的多张轮播图展示的优先级,若一个帧位上只配置了一张轮播图时,优先级为 1。 | 可选字段,由神策提供,并在接口调用结果中以 priority 字段下发给客户。 | ||||
strategy_id | 资源位的策略 ID | 字符串 | 该字段用于标识用户命中并生效的是资源位下的哪个策略 ID。需要注意的是,该字段是指资源位下关联了人群或者分配到了流量的策略ID,不是推荐策略库中的策略id。 | 必传字段,由神策提供,并在接口调用结果中以 strategy_id 字段下发给客户。客户后端向前端下发推荐结果中必须带此字段,前端行为事件上报中将此字段传回。 | ||||
retrieve_version_id | 资源位的策略版本 ID | 字符串 | 一个线上策略多次编辑会产生多个版本,该字段用于标识用户命中并生效的是资源位下的哪个策略 版本 ID。 | 可选字段,由神策提供,并在接口调用结果中以 retrieve_version_id 字段下发给客户。 | ||||
rec_frame_site | Banner 序号 | 数值 | 该栏位下 Banner 的帧位顺序。 | 必传字段,由神策提供,并在接口调用结果中以 rec_frame_site 字段下发给客户。客户后端向前端下发推荐结果中必须带此字段,前端行为事件上报中将此字段传回。 | ||||
log_id | 请求 ID | 字符串 | 请求的唯一标识,用于将某一物品的展现和点击联系起来,某一被推荐物品在被展现和点击时,log_id 要保持一致。 | 该字段的取值由客户提供,客户后端需给每次的推荐请求设置唯一请求 ID 来作为 log_id,即客户的 request_id。客户后端向前端下发推荐结果中必须带此字段,前端行为上报中需将此字段传回。 | ||||
$sf_plan_strategy_id | 实验组 ID | 字符串 | AB 实验分流标识,运营策略开启 AB 实验后,用于区分用户命中的 AB 实验组名称。 | 必传字段,由神策提供,并在接口调用结果中以 experiment_name 字段下发给客户。客户后端向前端下发推荐结果中必须带此字段,前端行为事件上报中将此字段传回。 |