图片-精准获客

支付宝广告转化数据回传 API 相关说明 – APP 推广

支付宝广告转化回传 API 说明 – APP 推广

一、转化回传的定义

转化回传指的是广告主或代理商将自身领域内的关键用户行为数据,借助 API 传至支付宝数字推广平台(简称支付宝灯火),以增强广告效果。

如图所示,支付宝灯火的转化回传服务在请求链路中位于支付宝统一对外网关(OpenAPI 网关)之后,所以接口对接涵盖两个主要部分

1. 支付宝统一网关的对接,包括应用申请、网关鉴权等

2. 支付宝灯火转化回传接口对接,涵盖广告主鉴权、转化相关参数等。其中,支付宝开放平台统一管理所有对外接口,必须先在支付宝开放平台申请应用并获得授权,然后才能进行后续对接

支付宝广告开放平台

3. 转化 API 对接流程

编号

步骤

主要解决问题

步骤 1

构建支付宝开放平台开发者环境

  • 进行支付宝开放平台应用申请和应用授权

  • 完成支付宝 OpenAPI 网关公共参数对接

步骤 2

接入广告转化回传 API

  • 完成转化回传接口的广告主鉴权

  • 对接转化回传接口的请求参数

步骤 3

进行转化 API 联调

  • 确保接口调试成功

二、转化回传 API 对接的详细流程

步骤一:构建支付宝开放平台开发者环境

(1)支付宝开放平台接入流程说明及支付宝广告接入流程说明

(2)创建应用

若要在您的应用中运用支付宝开放产品的接口能力,需创建应用:您需要先访问蚂蚁集团开放平台(open.alipay.com),在开发者中心登记创建您的应用,此时您将获取应用的唯一标识(APPID);

若想详细了解开放平台创建应用的步骤,请参考《支付宝开放平台操作说明》。

(3)配置密钥

开发者在调用接口前需要生成 RSA 密钥,RSA 密钥包含应用私钥(APP_PRIVATE_KEY)、应用公钥(APP_PUBLIC_KEY)。生成密钥后在开放平台管理中心进行密钥配置,配置结束后能够获取支付宝公钥(ALIPAY_PUBLIC_KEY)。详情请参考《支付宝开放平台操作说明》的配置密钥部分。

(4)搭建并配置开发环境

(5)下载服务端 SDK

为助力开发者调用开放接口,我们提供了开放平台服务端 SDK,涵盖 JAVA、C#、PHP 等多种语言版本,封装了签名、验签和 HTTP 接口请求等基础功能。请先下载对应语言版本的 SDK 并引入您的开发工程。

(6)关键参数说明:

配置参数

示例值解释

获取方式/示例值

URL

支付宝网关(固定)

https://openapi.alipay.com/gateway.do

APPID

创建应用后生成

获取方式详见《支付宝开放平台操作说明》中获取 APP ID 的部分

APP_PRIVATE_KEY

由开发者自行生成的私钥

获取方式详见《支付宝开放平台操作说明》的密钥配置部分

FORMAT

参数返回格式,仅支持 json 格式(固定)

json

CHARSET

编码集,支持 GBK/UTF-8

由开发者根据实际工程编码进行配置

ALIPAY_PUBLIC_KEY

由支付宝生成的公钥

获取方式详见《支付宝开放平台操作说明》的密钥配置部分

SIGN_TYPE

生成签名字符串所运用的签名算法类型,当前支持 RSA2 和 RSA,推荐使用 RSA2

RSA2

步骤二:广告转化 API 接入

(1)支付宝广告 API 接口文档说明:https://opendocs.alipay.com/apis/01ko5r(接口细节不一致的部分以本文档及帮助中心其他文档为准)

(2)完成 OpenAPI 接入后,可进一步对接转化回传。接口对接分为公共参数、接口具体参数。

(3)公共参数:公共参数为 OpenAPI 所有接口共用,包含如鉴权等一些基本信息、相关错误码和参数参考,详见接口文档说明;

(4)接口参数:为具体使用的 API 接口所设定的接入要求

参数

类型

具体类型

是否必填

是否列表类型

描述

biz_token

基础类型

String

代理商/直投商家访问支付宝灯火平台的 token,如何获取 Token?

conversion_data_list

复杂类型

ConversionData

转化数据列表,最多 1000 条

参数

类型

具体类型

是否必填

描述

source

基础类型

String

来源,固定传:CALLBACK

biz_no

基础类型

String

转化流水号,由商家自主定义作为转化数据的唯一标识,用于幂等判断,如果已有转化数据,将直接更新不再新增

conversion_type

基础类型

String

转化事件类型,参见《广告转化 API 事件类型枚举 – APP 推广转化》,具体 conversion_type 可与平台运营小二沟通后确认

attribute_list

复杂类型

List<ConversionProperty>

转化属性信息

  • 不同事件类型是否支持转化属性参见《广告转化 API 事件类型枚举 – APP 推广转化》

  • 不同的事件类型支持的转化属性不一样,具体参见《转化属性说明介绍》

conversion_time

基础类型

Long

转化发生的真实时间,北京时间时间戳,单位:秒

conversion_amount

基础类型

String

当转化类型为 APP 购买金额时需要填入,单位:分

uuid_type

基础类型

String

转化用户(发生真实转化的 C 端用户)唯一标识类型:

  • OAID_MD5:OAID 原值 MD5 加密后的值

  • IDFA_MD5:IDFA 原值 MD5 加密后的值

  • IP_UA:IP_UA 拼接值,以下划线拼接

  • CAID:CAID 原值

  • IMEI: IMEI 原值

uuid

基础类型

String

转化用户(发生真实转化的 C 端用户)唯一标识,根据 uuid_type 传不同类型的值

  • uuid_type=OAID_MD5: uuid 传的值为《三方广告监测上报规范 – APP 推广》或《落地页宏替换》的__OAID_MD5__宏参下发的值

  • uuid_type=IDFA_MD5: uuid 传的值为《三方广告监测上报规范 – APP 推广》或《落地页宏替换》的__IDFA_MD5__宏参下发的值

  • uuid_type=IP_UA: uuid 传的值《三方广告监测上报规范 – APP 推广》或《落地页宏替换》的__IP__宏参下发的值与__UA__宏参下发的值通过"_"拼接后的字符串

  • uuid_type=CAID:uuid 传的值为《三方广告监测上报规范 – APP 推广》或《落地页宏替换》的__CAID__宏参下发的值

  • uuid_type=IMEI:uuid 传的值为《三方广告监测上报规范 – APP 推广》或《落地页宏替换》的__IMEI__宏参下发的值

callback_ext_info

基础类型

String

转化回调扩展信息,通过《三方广告监测上报规范 – APP 推广》或《落地页宏替换》获取的宏: __CALLBACK_EXT_INFO__,需 url decode 后传回

cid

基础类型

String

点击 id,用于精准归因,通过《三方广告监测上报规范 – APP 推广》或《落地页宏替换》获取宏:__CID__

  • 不同的事件类型是否支持 cid 参见《广告转化 API 事件类型枚举 – APP 推广转化》

  • 新版转化目标必填,老版转化目标非必填

三、完成转化 API 开发接入后,联系平台运营小二协助完成联调上线。联调方式主要有以下三种:

1.

图片[1]-支付宝广告转化数据回传 API 相关说明 – APP 推广-精准获客

方式一:转化回传模块 mock 联调

适用场景:用于技术侧验证数据上报接口是否畅通。流程:

(1)广告主完成接口开发后,使用 mock 数据调用转化上报接口

(2)支付宝灯火研发侧确认是否成功接收数据

2. mock 数据获取方式:

(1)需 mock 字段:callback_ext_info

(2)app 类转化事件:向接口技术支持人员提供测试创意 id 以获取专属 callback_ext_info 值

(3)非 app 类转化事件:可固定使用 hAXLRVRoQHTgh2CQLhjfkX_0HR80F7ktEabHmKgD_XSSXPF2Pwv-a_pEAQVW2FS-6FCLShsXMMU4Ctx0X61swqcK4Qme3YdxzrjynZ_gYjQ8Iv4MNcM0d8oHKFiDWyOx

3. 方式二:创意必现

操作文档:https://adpub.alipay.com/adrlark/vdpk3awys7iytrhm

路径:工具→账户工具→创意必现

支付宝广告创意必现

4. 方式三:转化联调

提示:需搭配新转化事件使用,请联系支付宝灯火小二加白后使用

步骤

使用方法

第一步:

点击新建联调任务

第二步:

筛选需要进行联调的转化事件,及转化事件绑定的创意

第三步:

点击:下一步,生成测试广告

</

© 版权声明
THE END
喜欢就支持一下吧
点赞10 分享
评论 抢沙发

请登录后发表评论

    暂无评论内容