获取转化归因
请求地址
https://api.e.qq.com/v3.0/conversions/get
请求方法
GET
所属权限
广告管理(Ads Management)
请求参数
参数名 | 描述 |
---|---|
access_token | 授权令牌,完成 OAuth 2.0 授权后获得,参考开发者环境 |
timestamp | 当前的时间戳,单位为秒,允许客户端请求最大时间误差为 300 秒。MarketingAPI 所使用的时间戳,若无特殊说明,均为秒级时间戳签名算法。MarketingAPI 所使用的时区为 GMT+8,例如当时间戳为 1494840119 时,表示 2017-05-15 17:21:59 |
nonce | 随机字串标识,不超过 32 个字符,由调用方自行生成,需保证全局唯一性 |
fields | get 接口增加 fields 字段,用于指定返回参数的字段列表,为选填字段。fields 取值范围为 get 接口返回的 list 中的字段。如不填写,则根据默认值进行返回 |
请求体类型
application/json
请求体参数
阅读说明:Y - 必填;C - 条件选填(conditional),请关注“描述”信息;空 - 非必填
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
account_id | integer | Y | 推广帐号 id或 DataNexus 账号 id |
filtering | array | 过滤条件,若此字段不传,或传空则视为无限制条件,详见文档底部的 filtering 结构,数组,最大长度 10 | |
field | string | Y | 过滤字段,可选值:{ conversion_id, promoted_object_type, promoted_object_id, conversion_name, site_set, optimization_goal, deep_behavior_optimization_goal, deep_worth_optimization_goal, deep_worth_advanced_goal, access_status, cost_type, create_source_type, app_android_channel_package_id, marketing_scene, live_video_mode, live_video_sub_mode, conversion_link_id, impression_feedback_url, attribution_window, campaign_type } |
operator | enum | Y | 操作符,当 field 取值 promoted_object_type 时,枚举列表:{ EQUALS };当 field 取值 promoted_object_id 时,枚举列表:{ EQUALS };当 field 取值 app_android_channel_package_id 时,枚举列表:{ EQUALS };当 field 取值 conversion_id 时,枚举列表:{ EQUALS };当 field 取值 impression_feedback_url 时,枚举列表:{ EQUALS };当 field 取值 attribution_window 时,枚举列表:{ EQUALS };当 field 取值 conversion_link_id 时,枚举列表:{ EQUALS };当 field 取值 create_source_type 时,枚举列表:{ EQUALS };当 field 取值 conversion_name 时,枚举列表:{ CONTAINS };当 field 取值 site_set 时,枚举列表:{ IN };当 field 取值 optimization_goal 时,枚举列表:{ EQUALS };当 field 取值 deep_behavior_optimization_goal 时,枚举列表:{ EQUALS };当 field 取值 deep_worth_optimization_goal 时,枚举列表:{ EQUALS };当 field 取值 deep_worth_advanced_goal 时,枚举列表:{ EQUALS };当 field 取值 access_status 时,枚举列表:{ IN };当 field 取值 cost_type 时,枚举列表:{ EQUALS };当 field 取值 marketing_scene 时,枚举列表:{ EQUALS };当 field 取值 live_video_mode 时,枚举列表:{ EQUALS };当 field 取值 live_video_sub_mode 时,枚举列表:{ EQUALS };当 field 取值 campaign_type 时,枚举列表:{ EQUALS } |
values | string[] | Y | 字段取值,values 数组的个数限制与 operator 的取值相关,详见文档底部的 filtering 结构 |
page | integer | 搜索页码,默认值:1,最大值 99999 | |
page_size | integer | 一页显示的数据条数,默认值:10,最大值 2000 |
请求体示例
curl -G 'https://api.e.qq.com/v1.1/conversions/get?access_token=<ACCESS_TOKEN>×tamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'filtering=[]' \
-d 'page=1' \
-d 'page_size=10'
应答体结构
名称 | 类型 | 描述 |
---|---|---|
list | array | 返回信息列表 |
conversion_id | integer | 转化 id |
conversion_name | string | 转化名称,字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。) |
access_type | enum | 上报方式, 见 枚举值 |
claim_type | enum | 归因方式,见 枚举值 |
feedback_url | string | 监控链接,点击监测链接用于接收平台的点击信息,需输入合法 url,可参考文档:https://developers.e.qq.com/docs/ads/ads/3rdtracking 。当自归因为 true 并且 conversion_scene 为 ANDROID 或者 iOS,Feedback_URL 必填 |
self_attributed | boolean | 是否自归因,当选择 true 代表自归因,自行匹配转化数据后上报给平台,当选择 false 代表全量上报,将产生的所有转化数据上报给平台进行归因,上报方式为 API 时必须为 TRUE,上报方式为 SDK/JS 时必须为 FALSE |
optimization_goal | enum | 优化目标类型,见 枚举值 中的广告优化目标类型列表。也可通过查询优化目标权限 接口进行查询 |
deep_behavior_optimization_goal | enum | 深度优化行为目标,见 枚举值 中的广告深度优化转化目标类型列表,深度优化行为目标和深度优化 ROI 目标仅可填写其中一个 |
deep_worth_optimization_goal | enum | 深度优化 ROI 目标,见 枚举值 中的广告深度优化转化目标类型列表,深度优化行为目标、深度优化 ROI 和深度强化 ROI 目标仅可填写其中一个 |
user_action_set_id | integer | 数据源 id,当是否自归因选择 true 时,数据源 id 不可填,当是否自归因选择 false 时,如果该 APP 在当前账户下可见多个数据源,则需要手动指定一个,其他情况可不填 |
user_action_set_key | string | SDK 接入时对应的密钥,与 user_action_set_id 相对应,当过滤条件里按照转化 id 筛选时返回该字段 |
site_set_enable | boolean | 当前站点是否可用,true:是,false:否 |
is_deleted | boolean | 是否已删除,true:是,false:否 |
access_status | enum | 接入状态,枚举列表:[枚举详情] |
create_source_type | enum | 转化创建来源,如 SELF_CREATED,PLATFORM 等,当想要拉取 PLATFORM 类型的转化时,请指定[link href='promoted_object_type'],明确推广商品类型,[link href='create_source_type']转化创建来源[/link],[枚举详情] |
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 为正常。 |
promoted_object_id | string | 推广目标 id,详见 [推广目标] |
conversion_scene | enum | 转化场景,网页及微信小程序转化场景无需输入推广目标 id,[枚举详情] |
owner_id | integer | 转化的拥有者 id,即创建该转化的账号 id |
deep_worth_advanced_goal | enum | 强化 ROI 目标,深度优化行为目标、深度优化 ROI 和深度强化 ROI 目标仅可填写其中一个,枚举列表:[枚举详情] |
conversion_link_id | integer | 转化链路 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 。白名单账户可选填 |
feedback_id | integer | 监控链接组 id |
attribution_window | integer | 曝光归因窗口期 |
deep_behavior_advanced_goal | enum | 加强优化行为目标,加强优化行为目标和加强优化 ROI 目标仅可填写其中一个,枚举列表:[枚举详情] |
deep_behavior_advanced_goal_min_price | integer | 加强优化行为目标最低出价,单位分 |
deep_behavior_advanced_goal_max_price | integer | 加强优化行为目标最高出价,单位分 |
deep_optimization_goal_type | enum | 深度优化目标类型,如 SELF_OG,AUTO_OG 等,[link href='deep_optimization_goal_type']深度优化目标类型[/link],[枚举详情] |
page_info | object | 分页信息 |
page | integer | 当前页码 |
page_size | integer | 一页显示的数据条数,默认值:10,最小值 1,最大值 100 |
total_number | integer | 总行数 |
total_page | integer | 总页数 |
应答示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"list": [
{
"conversion_id": 12345,
"conversion_name": "测试转化",
"access_type": "ACCESS_TYPE_API",
"claim_type": "CLAIM_TYPE_ACTIVATION",
"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__",
"self_attributed": true,
"optimization_goal": "OPTIMIZATIONGOAL_APP_ACTIVATE",
"deep_behavior_optimization_goal": "OPTIMIZATIONGOAL_APP_REGISTER",
"is_deleted": false,
"app_android_channel_package_id": "0;10000534",
"promoted_object_id": "100873919",
"conversion_scene": "CONVERSION_SCENE_ANDROID"
}
],
"page_info": {
"page": 1,
"page_size": 10,
"total_number": 1,
"total_page": 1
}
}
}
该内容是否有帮助?