开发指引
更新时间:2026.10.221、开发前准备
1.1、熟悉微信支付接口规则
1.2、准备开发参数
在发起接口请求时,开发者还需传入一些必要参数,如brand_id(品牌ID)、品牌API证书私钥、公钥等,获取方式详见:品牌商户模式开发必要参数说明。
|
1.3、权限申请
联系微信支付运营人员开通「联合投放接入」能力权限。
确认本品牌可用的投放计划ID。调用接口时必须使用本品牌当前可用的投放计划ID。
2、业务基础概念
概念 | 说明 |
|---|---|
投放计划ID | |
plan_ids | 用户在本品牌下可投放的投放计划ID列表 |
用户标识 | OpenID 或手机号 MD5;整批请求必须使用同一类型的用户标识 |
配置的生效方式 | 调用 批量设置用户联合投放配置API 会用本次请求的 plan_ids 完全覆盖该用户在本品牌下原有 plan_ids,非增量追加; 应答返回HTTP 200 后,配置就会开始生效,无异步的回调通知 |
3、接入全流程
3.1、准备用户标识列表(非API)
在本地按规范准备一份需要配置的用户标识列表:
整个列表中的用户标识,需要与后续调用接口使用的标识类型
identifier_type保持一致(即全部为 OpenID,或全部为手机号 MD5)。手机号 MD5 全部为 32 位小写十六进制。
OpenID 对应 appid 已与本品牌绑定。
|
3.2、批量查询用户联合投放配置(API)
新增/更新用户联合投放配置前,建议先调用批量查询用户联合投放配置拿到用户当前配置的plan_ids信息。
|
3.3、本地合并计算用户最终的plan_ids(非API)
结合查询到的用户当前配置信息,按品牌方自身业务规则在本地计算每个用户的最终需要群配置的 plan_ids,建议分场景按以下方式计算:
活动开始前:原 plan_ids 并集新增活动对应的plan_id
活动结束后:原 plan_ids 去掉活动对应的plan_id(若为空数组建议检查确认下,以免误操作清空用户全部配置)
其他场景:直接按自身业务规则算出最终集合后设置
3.4、批量设置用户联合投放配置(API)
调用批量设置用户联合投放配置提交最终设置名单。
|
单个用户的plan_ids配置生效示例:
plan_ids配置场景 | 实际生效效果 |
|---|---|
传 [10001, 10002] | 该用户在本品牌下可参与的联合投放有 {10001, 10002} |
用户原本的plan_ids是 [10001, 10002],本次请求传 [10001] | 该用户在本品牌下可参与的联合投放有 {10001}(原 10002 被移除) |
传 [] 空数组 | 清空该用户在本品牌下的所有联合投放配置 |
该用户本次请求中未出现 | 该用户在本品牌下的现有联合投放配置不变 |
3.5、生效确认
调用 批量设置用户联合投放配置API 应答返回HTTP 200 后,配置就会开始生效,无异步的回调通知,下一次曝光投放命中匹配时即可读到最新配置。
若业务侧观察不到效果,优先核对:
1、是否在正确的 user_identifier × plan_id 维度观察;
2、中间是否有其它程序再次调用了设置接口覆盖了配置。
4、接口接入说明
4.1、必接接口
API名称 | 描述 |
|---|---|
查询本品牌下一批用户当前的 plan_ids。单次 1-150。限频:按 brand_id 维度 20/秒。 | |
全量覆盖本品牌下一批用户的 plan_ids。单次 200-2000。前置条件:已确认本品牌可用 plan_ids;增量场景建议先查询再合并。 |
