SDK 在落地页自动保存推广归因参数、把参数透传到站内跳转链接,并在满足条件时自动回传点击。
接入后无需手动处理 URL 参数、Cookie 和跳转链路,注册、付费等事件回传时直接从 Cookie 读取归因参数。
1. 能力概览 #
| 能力 | 说明 |
|---|---|
| 保存归因参数 | 识别 URL 中的 ps_click_id 与 ps_ref,写入 Cookie |
| 透传链接参数 | 监听页面内 <a> 标签点击,把归因参数追加到站内跳转链接 |
| 自动上报点击 | URL 中带有 ps_token 时,页面加载后自动请求点击上报接口 |
2. 接入方式 #
在落地页或站点公共模板中引入以下脚本,建议放在页面底部或公共布局中统一引入。
<script src="https://sdk.partnershare.net/pro/sdk_v2.js"></script>
SDK 加载后自动执行,无需初始化调用。
3. 执行流程 #
- 读取当前页面 URL 参数。
- 将
ps_click_id与ps_ref写入 Cookie。 - 监听页面内
<a>链接点击,把归因参数追加到跳转链接。 - URL 中存在
ps_token时,页面加载后自动请求点击上报接口。
4. 参数说明 #
| 参数 | 来源 | 写入 Cookie | 说明 |
|---|---|---|---|
ps_click_id | PartnerShare 推广链接跳转 | 是 | 点击追踪 ID,标识一次具体点击,注册、付费等事件优先按该值归因 |
ps_ref | PartnerShare 推广链接跳转 | 是 | 推广邀请码,无法获取点击 ID 时用于补充归因 |
ps_token | PartnerShare 推广链接跳转 | 否 | 存在时触发自动点击上报 |
5. Cookie 约定 #
| Cookie | 说明 |
|---|---|
ps_click_id | 点击归因 ID,注册或事件回传时读取 |
ps_ref | 邀请码,落地页或后续事件回传时读取 |
Cookie 以 path=/、SameSite=Lax 写入。HTTPS 环境下按浏览器规则处理安全属性。
6. 归因链路 #
- 用户从 PartnerShare 推广链接进入落地页。
- SDK 读取 URL 中的
ps_click_id、ps_ref并写入 Cookie。 - 用户在站内跳转时,SDK 把归因参数追加到链接。
- 注册、付费等节点,前端读取 Cookie 中的归因参数提交给业务后端。
- 业务后端调用 推广转化事件回传 接口回传转化。
7. 读取归因参数 #
服务端回传注册或付费事件前,先由前端读取 Cookie 并提交到业务后端:
function getCookie(name) {
const match = document.cookie.match(new RegExp('(^| )' + name + '=([^;]+)'));
return match ? decodeURIComponent(match[2]) : '';
}
const clickId = getCookie('ps_click_id');
const inviteCode = getCookie('ps_ref');
8. 接入注意事项 #
- SDK 部署在所有推广落地页、注册页和关键跳转页面,避免
ps_click_id与ps_ref丢失。 - 只有通过标准
<a>标签的跳转会被自动透传。前端路由、按钮脚本或异步跳转需在对应逻辑中手动读取 Cookie 并补齐参数。 - SDK 只透传
ps_click_id与ps_ref,不处理其他自定义参数。 - 自动点击上报依赖 URL 中的
ps_token,没有该参数时 SDK 不会请求点击上报接口。