新增转化归因
请求地址
https://api.e.qq.com/v3.0/conversions/add
请求方法
POST
所属权限
广告管理(Ads Management)
请求参数
参数名 | 描述 |
---|---|
access_token | 授权令牌,完成 OAuth 2.0 授权后获得,参考开发者环境 |
timestamp | 当前的时间戳,单位为秒,允许客户端请求最大时间误差为 300 秒。MarketingAPI 所使用的时间戳,若无特殊说明,均为秒级时间戳签名算法。MarketingAPI 所使用的时区为 GMT+8,例如当时间戳为 1494840119 时,表示 2017-05-15 17:21:59 |
nonce | 随机字串标识,不超过 32 个字符,由调用方自行生成,需保证全局唯一性 |
请求体类型
application/json
请求体参数
阅读说明:Y - 必填;C - 条件选填(conditional),请关注“描述”信息;空 - 非必填
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
account_id | integer | Y | 推广帐号 id或 DataNexus 账号 id |
conversion_name | string | Y | 转化名称,字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)字段长度最小 1 字节,长度最大 120 字节 |
access_type | enum | Y | 上报方式, 见 枚举值 |
conversion_scene | enum | Y | 转化场景,网页及微信小程序转化场景无需输入推广目标 id,见 枚举值 |
promoted_object_id | string | 推广目标 id,字段长度最小 0 字节,长度最大 128 字节 | |
app_android_channel_package_id | string | 安卓应用渠道包 id,在投放推广目标类型为 Android 应用且接入方式为 SDK 的情况下,可以填写 Market API 中android_union_channel_packages/add接口创建的腾讯广告渠道包的渠道包 id。 只可以选择自定义渠道包 id 非空的渠道包,且只会将自定义渠道包 id 一致的数据计入转化量。 渠道包 id 可以从推广目标模块的读取接口获取,渠道包 id 字段由 xx;yy 两部分组成,在写入时 xx 会被置为 0,0 为正常。字段长度最小 1 字节,长度最大 128 字节 | |
claim_type | enum | Y | 归因方式,见 枚举值 |
feedback_url | string | C | 监控链接,点击监测链接用于接收平台的点击信息,需输入合法 url,可参考 点击监测链接使用指南。当自归因为 true 并且 conversion_scene 为 ANDROID 或者 iOS,Feedback_URL 必填,字段长度最大 2048 字节 |
landing_page_url | string | 请填写推广的落地页链接,与上报协议中的 url 保持一致,腾讯广告将根据此链接生成落地页唯一 id,相同域名相同优化目标不同落地页地址可以不用再次创建转化 id。feedback_url 与 landing_page_url 必须至少填写其中一个参数。在自归因 Web 转化场景中,建议填写 feedback_url 并使用 callback 上报行为数据。在非自归因 Web 转化场景中,可以不填写 feedback_url 填写 landing_page_url 并使用 click_id 上报行为数据。字段长度最大 2048 字节,无默认值 | |
mini_program_id | string | 小程序 id。微信小程序转化场景、企业微信场景必填。企业微信场景输入和企业微信绑定的微信小程序 id,字段长度最小 1 字节,长度最大 384 字节,无默认值 | |
self_attributed | boolean | Y | 是否自归因,当选择 true 代表自归因,自行匹配转化数据后上报给平台,当选择 false 代表全量上报,将产生的所有转化数据上报给平台进行归因,上报方式为 API 时必须为 TRUE,上报方式为 SDK/JS 时必须为 FALSE,可选值:{ true, false } |
optimization_goal | enum | Y | 优化目标类型,见 枚举值 中的广告优化目标类型列表。也可通过查询优化目标权限 接口进行查询 |
deep_behavior_optimization_goal | enum | 深度优化行为目标,见 枚举值 中的广告深度优化转化目标类型列表,深度优化行为目标和深度优化 ROI 目标仅可填写其中一个 | |
deep_worth_optimization_goal | enum | 深度优化 ROI 目标,见 枚举值 中的广告深度优化转化目标类型列表,深度优化行为目标、深度优化 ROI 和深度强化 ROI 目标仅可填写其中一个 | |
deep_worth_advanced_goal | enum | 强化 ROI 目标,见 枚举值 中的广告深度优化转化目标类型列表,深度优化行为目标、深度优化 ROI 和深度强化 ROI 目标仅可填写其中一个 | |
user_action_set_id | integer | C | 数据源 id,当是否自归因选择 true 时,数据源 id 不可填,当是否自归因选择 false 时,如果该 APP 在当前账户下可见多个数据源,则需要手动指定一个,其他情况可不填 |
conversion_link_id | integer | C | 转化链路 id,当转化场景为 CONVERSION_SCENE_WEB 或者 CONVERSION_SCENE_WECHAT_MINI_PROGRAM 并且上报方式为 ACCESS_TYPE_API 时,可填写转化链路 id,其余情况不支持。详见 转化归因链路明细 |
impression_feedback_url | string | 监控链接,曝光监测链接用于接收平台的曝光信息,需输入合法 url,可参考文档:https://developers.e.qq.com/docs/ads/ads/3rdtracking 。白名单账户可选填,字段长度最大 2048 字节 | |
feedback_id | integer | 监控链接组 id | |
attribution_window | integer | 曝光归因窗口期,默认窗口期为 7 天 | |
deep_behavior_advanced_goal | enum | 加强优化行为目标,见 枚举值 中的广告优化目标类型列表,加强优化行为目标和加强优化 ROI 目标仅可填写其中一个 | |
deep_optimization_goal_type | enum | 深度优化目标类型,见 枚举值 中的深度优化目标类型 |
请求体示例
curl 'https://api.e.qq.com/v1.1/conversions/add?access_token=<ACCESS_TOKEN>×tamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'conversion_name=测试转化' \
-d 'access_type=ACCESS_TYPE_API' \
-d 'conversion_scene=CONVERSION_SCENE_ANDROID' \
-d 'promoted_object_id=100873919' \
-d 'app_android_channel_package_id=0;10000534' \
-d 'claim_type=CLAIM_TYPE_ACTIVATION' \
-d 'feedback_url=http://wwww.qq.com?a=__CLICK_ID__&b=__CLICK_TIME__&c=__MUID__&d=__ACCOUNT_ID__&f=__CALLBACK__&g=__DEVICE_OS_TYPE__&h=__HASH_MAC__&i=__HASH_OAID__&j=__OAID__&k=__HASH_ANDROID_ID__&l=__PROMOTED_OBJECT_ID__&o=__AD_ID__' \
-d 'self_attributed=true' \
-d 'optimization_goal=OPTIMIZATIONGOAL_APP_ACTIVATE' \
-d 'deep_behavior_optimization_goal=OPTIMIZATIONGOAL_APP_REGISTER'
应答体结构
No data |
应答示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"conversion_id": 12345
}
}
该内容是否有帮助?