通用转化
app推广转化
供广告商家通过openapi上报通用类(非app推广)的转化明细数据,用于广告投放效果的追踪和广告投放的优化。
公共请求参数
业务请求参数
biz_token|业务令牌必选string(128)
【描述】代理商/直投商家访问灯火平台的token。
【示例值】hyjofejnnlp89730202bcklhh
conversion_data_list|转化明细数据必选conversiondata[]
【描述】转化数据列表, 最多1000条
source必选string(100)
【描述】来源,固定传:common_target
【枚举值】
通用类转化事件类型: common_target
app推广类转化事件类型: callback
【示例值】common_target
principal_tag必选string(100)
【描述】商家标签。
【示例值】hyjofejnnlp89730202bcklhh
conversion_type|转化事件类型数字必选string(128)
【描述】转化事件类型,参见
【枚举值】
小程序交易笔数(api回传): 215
小程序收藏(api回传): 219
小程序页面浏览(api回传): 225
【示例值】225
biz_no|转化流水号必选string(128)
【描述】转化流水号,由商家自主定义作为转化数据唯一标识,用于幂等判断,如果已有转化数据,将直接更新不再新增
【示例值】zybnom890437mvcu
uuid_type必选string(50)
【描述】转化用户唯一标志类型:
- pid:表示转化用户唯一标识(非自建站转化事件类型均使用该type)
- pid_encrypt:加密后的转化用户标识,自建站转化事件类型适用(自建站转化事件类型编码:445~450)
- pid:表示转化用户唯一标识(非自建站转化事件类型均使用该type)
- pid_encrypt:加密后的转化用户标识,自建站转化事件类型适用(自建站转化事件类型编码:445~450)
【枚举值】
转化客户唯一标志类型: pid
加密后的转化用户标识,自建站转化事件类型适用: pid_encrypt
【示例值】pid
uuid必选string(512)
【描述】转化用户(发生真实转化的c端用户)唯一标识:
- 当uuid_type=pid时,传2088uid(例:208801217938xxxx; 若uuid获取不到,可参考接入指南中的常见问题);
- 当uuid_type=pid_encrypt时,uuid传通过自建推广页留资数据查询接口获取到的encrypt_uid字段值
- 当uuid_type=pid时,传2088uid(例:208801217938xxxx; 若uuid获取不到,可参考接入指南中的常见问题);
- 当uuid_type=pid_encrypt时,uuid传通过自建推广页留资数据查询接口获取到的encrypt_uid字段值
【示例值】dsfasdgfsdg
conversion_time必选number(128)
【描述】转化发生的真实时间,北京时间时间戳,单位:秒
【示例值】12389637
property_list必选conversionproperty[]
【描述】归因字段,不同转化类型的归因字段是不一样的,具体字段值参见
key必选string(128)
【描述】归因字段key
【示例值】tinyapp_id
value必选string(5000)
【描述】归因字段value
【示例值】2021xxxxxx
conversion_amount可选string(100)
【描述】当转化类型涉及交易金额时需要填入,单位:分
【示例值】20
creative_id可选string(100)
【描述】创意id
备注:当join_channel=merchant,且未传callback_ext_info参数的情况下,创意id必传(creative_id需为所属账户下创意id)
备注:当join_channel=merchant,且未传callback_ext_info参数的情况下,创意id必传(creative_id需为所属账户下创意id)
【示例值】6785
callback_ext_info可选string(2000)
【描述】转化回调扩展信息,通过或者获取,需url decode后传回。
备注:若回传了callback_ext_info,则转化用户(发生真实转化的c端用户)以callback_ext_info为准,此时uuid可以使用固定值"2088uid"
回传格式可以参考接入指南中的常见问题
备注:若回传了callback_ext_info,则转化用户(发生真实转化的c端用户)以callback_ext_info为准,此时uuid可以使用固定值"2088uid"
回传格式可以参考接入指南中的常见问题
【示例值】haxlrvroqhtgh2cqlhjfkx_0hr80f7kteabhmkgd_xssxpf2pwv-a_peaqvw2fs-6fclshsxmmu4ctx0x61swqck4qme3ydxzrjynz_gyjq8iv4mncm0d8ohkfidwyox
cid|广告点击id可选string(256)
【描述】点击id, 用于精准归因,通过或者获取(宏:__cid__)
不同的事件类型是否支持cid参见
不同的事件类型是否支持cid参见
【示例值】8e91eca2-930d-4b4e-bb38-1ba74146cd06
attribute_list|转化事件属性信息可选conversionproperty[]
【描述】转化属性信息:
- 不同事件类型是否支持转化属性参见;
- 不同的事件类型支持的转换属性不一样,具体参见
- 不同事件类型是否支持转化属性参见;
- 不同的事件类型支持的转换属性不一样,具体参见
key必选string(128)
【描述】转化事件属性key
【示例值】goods_price
value必选string(5000)
【描述】转化事件属性value
【示例值】1000
常见请求示例
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.data.dataservice.ad.conversion.upload&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
-f 'app_auth_token=${app_auth_token}' \
-f 'biz_content={
"biz_token":"hyjofejnnlp89730202bcklhh",
"conversion_data_list":[
{
"conversion_time":12389637,
"uuid_type":"pid",
"source":"common_target",
"uuid":"dsfasdgfsdg",
"creative_id":"6785",
"property_list":[
{
"value":"2021xxxxxx",
"key":"tinyapp_id"
}
],
"principal_tag":"hyjofejnnlp89730202bcklhh",
"conversion_amount":"20",
"attribute_list":[
{
"value":"1000",
"key":"goods_price"
}
],
"conversion_type":"225",
"biz_no":"zybnom890437mvcu",
"callback_ext_info":"haxlrvroqhtgh2cqlhjfkx_0hr80f7kteabhmkgd_xssxpf2pwv-a_peaqvw2fs-6fclshsxmmu4ctx0x61swqck4qme3ydxzrjynz_gyjq8iv4mncm0d8ohkfidwyox",
"cid":"8e91eca2-930d-4b4e-bb38-1ba74146cd06"
}
]
}'
说明:本示例仅供参考。
公共响应参数
业务响应参数
无业务响应参数
响应示例
正常示例
异常示例
{
"alipay_data_dataservice_ad_conversion_upload_response": {
"code": "10000",
"msg": "success"
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}
说明:本示例仅供参考。
公共错误码
业务错误码
错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|
system_error | 系统繁忙 | 1. 该接口为幂等接口,可先重试3次。 2. 请检查接口路径是否正确。 3. 保留接口调用参数现场,服务恢复后重新调用。 |
invalid_parameter | 参数有误参数有误参数有误请按照接口文档定义参数 | 1.请按照接口文档检查参数。 2. 如果第1步检查无误,则保存接口调用参数现场。 3. 联系对接运营或产品,提供参数调用现场及调用时间,对接运营或产品联系接口开发进行排查。 |
biz_error | 业务异常业务异常业务异常请按照接口文档定义参数 | 1.请按照接口文档检查参数。 2. 如果第1步检查无误,则保存接口调用参数现场。 3. 联系对接运营或产品,提供参数调用现场及调用时间,对接运营或产品联系接口开发进行排查 |
biz_token_error | biztoken校验失败 | 1.确认biz_token参数值是否为空,biz_token不能为空
2.若biz_token不为空,确认biz_token参数格式是否正确,例:biz_token参数应为下划线格式
3. 如果以上检查无误,则保存接口调用参数现场。联系对接运营或产品,提供参数调用现场及调用时间,对接运营或产品联系接口开发进行排查 |
no_data_purview | 数据越权 | 1. 请检查参数中biz_token与principal_tag是否存在越权,如:principal_tag非biz_token所属账号下商家。 2. 请检查参数中principal_tag与creative_id是否存在越权,如:creative_id或callback_ext_info解析出的创意id非principal_tag所属账号下创意。
3.其他参数如group_id、plan_id若上传,检查方式同creative_id。
4.如果以上检查无误,则保存接口调用参数现场。联系对接运营或产品,提供参数调用现场及调用时间,对接运营或产品联系接口开发进行排查 |
null_argument | 接口必填入参为空 | 1.请根据接口文档入参说明,检查必填参数是否为空 |