该 SDK 用于在落地页自动保存推广归因参数、透传来源参数,并在满足条件时自动回传点击信息,减少接入方手动处理 URL 参数、Cookie 和跳转链路的成本。
1. SDK 能力概览 #
保存归因参数自动识别 URL 中的
ps_click_id 与 ps_ref 并写入 Cookie。透传链接参数自动把当前页面中的归因参数追加到页面内的跳转链接,减少链路丢参。
自动上报点击当 URL 中带有
ps_token 时,页面加载后会自动请求点击上报接口。2. 接入方式 #
请将以下脚本放在你的落地页或站点公共模板中,建议放在页面底部或公共布局中统一引入。
<script src="https://sdk.partnershare.net/pro/sdk_v2.js"></script>
SDK 加载后会自动执行,无需额外初始化即可完成 Cookie 写入、参数透传和自动上报逻辑。
3. 自动处理流程 #
第 1 步读取当前页面 URL 参数。
第 2 步将
ps_click_id 与 ps_ref 写入 Cookie。第 3 步监听页面内
<a> 链接点击,自动把归因参数继续拼接到跳转链接中。第 4 步当 URL 中存在
ps_token 时,页面加载后自动请求点击上报接口。4. 参数说明 #
4.1 核心归因参数 #
| 参数名 | 来源 | 作用 | 说明 |
|---|---|---|---|
ps_click_id | PartnerShare 跳转链接 | 点击归因 | 点击追踪 ID,用于标识一次具体点击,优先用于后续注册、付费等事件归因 |
ps_ref | PartnerShare 跳转链接 | 邀请码归因 | 推广邀请码,用于在无法拿到点击 ID 的场景下补充归因链路 |
4.2 自动上报参数 #
| 参数名 | 作用 | 是否自动写入 Cookie | 说明 |
|---|---|---|---|
ps_token | 触发自动点击上报 | 否 | 当页面 URL 中存在该参数时,SDK 会在页面加载后自动请求点击上报接口 |
5. Cookie 约定 #
| Cookie 名 | 说明 |
|---|---|
ps_click_id | 保存点击归因 ID,便于注册或事件回传时读取 |
ps_ref | 保存邀请码归因信息,便于落地页或后续事件上报时读取 |
SDK 默认以
path=/、SameSite=Lax 写入 Cookie。若页面运行在标准 HTTPS 环境,浏览器会按当前规则处理安全属性。6. 极简链路图 #
1
推广链接访问
用户从 PartnerShare 推广链接进入你的落地页。
2
SDK 捕获参数
页面加载后自动读取 URL 中的归因参数。
3
保存并透传
归因参数写入 Cookie,并自动追加到站内跳转链接。
4
业务转化读取
注册、付费等关键节点读取归因参数并提交到业务后端。
5
事件回传
业务后端通过事件上报接口把转化结果回传给 PartnerShare。
7. 推荐接入方式 #
推荐将 SDK 部署在所有推广落地页、注册页以及关键跳转页面中,这样可以最大程度保证
ps_click_id 和 ps_ref 不丢失。如果你的页面会跳转到注册页、支付页或其他站内页面,请确保这些页面的链接是通过标准
<a> 标签跳转,SDK 才能自动完成参数透传。8. 如何在业务代码中读取归因参数 #
品牌方服务端在上报注册或付费事件前,通常需要先从前端 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');
console.log({ clickId, inviteCode });
9. 常见注意事项 #
SDK 只会自动透传当前 URL 中存在的
ps_click_id 与 ps_ref,不会自动补全其他自定义参数。自动点击上报依赖 URL 中的
ps_token;如果页面没有该参数,SDK 不会主动请求点击上报接口。如果你的页面跳转是通过前端路由、按钮脚本或异步逻辑完成,建议在对应逻辑中手动读取 Cookie 并补齐参数,不要完全依赖原生链接监听。
后续注册、付费等转化事件,请配合《事件上报》接口一起使用,才能完成完整的归因、奖励和结算闭环。