小红书广告事件管理API回传技术接入流程

发布时间：2024-04-18浏览次数：55

3.20更新：对接文档更新，对历史对接成功的客户没有任何影响；新客户对接鉴权取消，对接效率更高

一、接入流程

小红书广告回传数据接入流程

二、接入准备

1.通过聚光平台（小红书广告平台）获取投放账号id（advertiserId）

小红书广告获取投放账户

2.聚光回传联调。

三、回传数据接口

1.通信协议

支持通过HTTPS通道进行请求通信。为了获得更高的安全性，推荐您使用HTTPS通道发送请求。

2.请求方法

支持HTTPS POST方法发送请求，这种方式下请求参数需要包含在请求的Body中。

3.请求参数

上报字段	字段名称	格式	是否必须	样例及说明
广告主id	advertiser_id	string	是	"1233223"
转发方法	method	string	是	固定为"aurora.leads"
token	access_token	string	是	"38F06A2B7207377EF379388F2A896DA501" 获取方式见【获取accessToken】章节
转化事件类型 id	event_type	string	是	"101"，具体见【转化事件详细说明】
转化发生时间	conv_time	long	是	1687683565558，时间戳格式，毫秒
click_id	click_id	string	是	事件对应的click_id，同页面跳转click_id

转化事件详细说明：

事件名称	事件类型id	事件描述
表单提交	101	用户在页面内完成表单填写并提交，可以作为优化目标
有效表单	102	提交线索的用户进一步完成了一次有价值的行为，具体行为取决于广告主业务模式，如预约到店等
电话拨打	111	用户点击给商家拨打电话，可以作为优化目标
电话接通	112	商家给用户拨打电话，可接通
微信复制	121	用户完成个人或公众号复制行为，引导用户加粉，可以作为优化目标
微信加好友	122	用户完成个人或公众号加粉
负向样本	200	不可直接作为广告的优化目标使用，但回传后将有利于优化整体的小红书广告效果
身份认证	131	用户完成身份认证，比如金融类可能会用身份证号、人脸识别做身份认证
付费	141	用户完成商品购买行为，可以作为优化目标

四、附录

1.异常情况排查

每一个请求在返回的http Response Header中返回了Cat-Msg-Id，如果请求异常，可以将此Cat-Msg-Id 发到群里，便于排查

示例：

Cat-Msg-Id

karen-gateway-openapi-ac190997.27624-464187-1023

2.错误码

特殊情况

传递的body无法解析，则httpcode为400

（1）成功

code	msg	描述
0	成功	成功

（2）通用