接口文档SDK业务专题开发者工具

新增转化归因
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 conversions/add
请求方法 post

全局参数

全局参数是指每一个接口都需要使用到的参数。详情参考,代码案例参考

参数名称 参数类型
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 中的字段。如不填写,则根据默认值进行返回

请求参数

参数仅适用于腾讯广告平台及微信公众平台。其中,标有的内容表示,该参数在微信公众平台使用时,描述不同。标有*的参数为必填项

名称 类型 描述
account_id*
integer 推广帐号 id,有操作权限的帐号 id,包括代理商和广告主帐号 id
conversion_name*
string 转化名称,字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
字段长度最小 1 字节,长度最大 120 字节
access_type*
enum 上报方式,[枚举详情]
枚举列表:{ ACCESS_TYPE_SDK, ACCESS_TYPE_API }
conversion_scene*
enum 转化场景,[枚举详情]
枚举列表:{ CONVERSION_SCENE_ANDROID, CONVERSION_SCENE_IOS }
promoted_object_id*
string 推广目标 id,详见 [推广目标]
字段长度最小 0 字节,长度最大 128 字节
claim_type*
enum 归因方式,SDK 上报方式时归因方式只能为 CLAIM_TYPE_ACTIVATION,[枚举详情]
枚举列表:{ CLAIM_TYPE_ACTIVATION, CLAIM_TYPE_CLICK }
feedback_url
string 监控链接,点击监测链接用于接收平台的点击信息,需输入合法 url,可参考文档:https://developers.e.qq.com/docs/ads/ads/3rdtracking 。当自归因为 true 时,Feedback_URL 必填
字段长度最大 2048 字节
self_attributed*
boolean 是否自归因,当选择 true 代表自归因,自行匹配转化数据后上报给平台,当选择 false 代表全量上报,将产生的所有转化数据上报给平台进行归因,上报方式为 API 时必须为 TRUE,上报方式为 SDK 时必须为 FALSE
可选值:{ true, false }
optimization_goal*
enum 优化目标类型,支持的优化目标及对应的深度优化目标可通过“查询优化目标权限”接口进行查询,[枚举详情]
枚举列表:{ OPTIMIZATIONGOAL_BRAND_CONVERSION, OPTIMIZATIONGOAL_FOLLOW, OPTIMIZATIONGOAL_CLICK, OPTIMIZATIONGOAL_IMPRESSION, OPTIMIZATIONGOAL_APP_DOWNLOAD, OPTIMIZATIONGOAL_APP_ACTIVATE, OPTIMIZATIONGOAL_APP_REGISTER, OPTIMIZATIONGOAL_ONE_DAY_RETENTION, OPTIMIZATIONGOAL_APP_PURCHASE, OPTIMIZATIONGOAL_ECOMMERCE_ORDER, OPTIMIZATIONGOAL_ECOMMERCE_CHECKOUT, OPTIMIZATIONGOAL_LEADS, OPTIMIZATIONGOAL_ECOMMERCE_CART, OPTIMIZATIONGOAL_PROMOTION_CLICK_KEY_PAGE, OPTIMIZATIONGOAL_VIEW_COMMODITY_PAGE, OPTIMIZATIONGOAL_ONLINE_CONSULTATION, OPTIMIZATIONGOAL_TELEPHONE_CONSULTATION, OPTIMIZATIONGOAL_PAGE_RESERVATION, OPTIMIZATIONGOAL_DELIVERY, OPTIMIZATIONGOAL_MESSAGE_AFTER_FOLLOW, OPTIMIZATIONGOAL_CLICK_MENU_AFTER_FOLLOW, OPTIMIZATIONGOAL_PAGE_EFFECTIVE_ONLINE_CONSULT, OPTIMIZATIONGOAL_PAGE_EFFECTIVE_PHONE_CALL }
deep_behavior_optimization_goal
enum 深度优化行为目标,深度优化行为目标和深度优化 ROI 目标仅可填写其中一个,枚举列表:[枚举详情]
枚举列表:{ OPTIMIZATIONGOAL_NONE, OPTIMIZATIONGOAL_BRAND_CONVERSION, OPTIMIZATIONGOAL_FOLLOW, OPTIMIZATIONGOAL_CLICK, OPTIMIZATIONGOAL_IMPRESSION, OPTIMIZATIONGOAL_APP_DOWNLOAD, OPTIMIZATIONGOAL_APP_ACTIVATE, OPTIMIZATIONGOAL_APP_REGISTER, OPTIMIZATIONGOAL_ONE_DAY_RETENTION, OPTIMIZATIONGOAL_APP_PURCHASE, OPTIMIZATIONGOAL_ECOMMERCE_ORDER, OPTIMIZATIONGOAL_ECOMMERCE_CHECKOUT, OPTIMIZATIONGOAL_LEADS, OPTIMIZATIONGOAL_ECOMMERCE_CART, OPTIMIZATIONGOAL_PROMOTION_CLICK_KEY_PAGE, OPTIMIZATIONGOAL_VIEW_COMMODITY_PAGE, OPTIMIZATIONGOAL_ONLINE_CONSULTATION, OPTIMIZATIONGOAL_TELEPHONE_CONSULTATION, OPTIMIZATIONGOAL_PAGE_RESERVATION, OPTIMIZATIONGOAL_DELIVERY, OPTIMIZATIONGOAL_MESSAGE_AFTER_FOLLOW, OPTIMIZATIONGOAL_CLICK_MENU_AFTER_FOLLOW, OPTIMIZATIONGOAL_PAGE_EFFECTIVE_ONLINE_CONSULT, OPTIMIZATIONGOAL_PAGE_EFFECTIVE_PHONE_CALL, OPTIMIZATIONGOAL_CONFIRM_EFFECTIVE_LEADS_CONSULT, OPTIMIZATIONGOAL_CONFIRM_EFFECTIVE_LEADS_PHONE, OPTIMIZATIONGOAL_LEADS_COLLECT, OPTIMIZATIONGOAL_FIRST_PURCHASE, OPTIMIZATIONGOAL_APPLY, OPTIMIZATIONGOAL_PRE_CREDIT, OPTIMIZATIONGOAL_CREDIT, OPTIMIZATIONGOAL_WITHDRAW_DEPOSITS, OPTIMIZATIONGOAL_PROMOTION_VIEW_KEY_PAGE, OPTIMIZATIONGOAL_MOBILE_APP_CREATE_ROLE, OPTIMIZATIONGOAL_CANVAS_CLICK, OPTIMIZATIONGOAL_PROMOTION_CLAIM_OFFER, OPTIMIZATIONGOAL_ECOMMERCE_ADD_TO_WISHLIST, OPTIMIZATIONGOAL_CONFIRM_EFFECTIVE_LEADS_RESERVATION, OPTIMIZATIONGOAL_PAGE_RECEIPT, OPTIMIZATIONGOAL_PAGE_SCAN_CODE, OPTIMIZATIONGOAL_SELECT_COURSE, OPTIMIZATIONGOAL_CONFIRM_POTENTIAL_CUSTOMER_PHONE, OPTIMIZATIONGOAL_MOBILE_APP_AD_INCOME, OPTIMIZATIONGOAL_MOBILE_APP_ACCREDIT, OPTIMIZATIONGOAL_PURCHASE_MEMBER_CARD }
deep_worth_optimization_goal
enum 深度优化 ROI 目标,深度优化行为目标和深度优化 ROI 目标仅可填写其中一个,枚举列表:[枚举详情]
枚举列表:{ GOAL_NONE, GOAL_7DAY_PURCHASE_ROAS, GOAL_15DAY_PURCHASE_ROAS, GOAL_30DAY_PURCHASE_ROAS, GOAL_60DAY_PURCHASE_ROAS, GOAL_30DAY_MONETIZATION_ROAS, GOAL_30DAY_ORDER_ROAS, GOAL_1DAY_PURCHASE_ROAS, GOAL_1DAY_MONETIZATION_ROAS, GOAL_3DAY_PURCHASE_ROAS, GOAL_3DAY_MONETIZATION_ROAS, GOAL_7DAY_MONETIZATION_ROAS, GOAL_15DAY_MONETIZATION_ROAS }
user_action_set_id
integer 数据源 id,当是否自归因选择 false 时,数据源 id 必填;当是否自归因选择 true 时,数据源 id 不可填

使用说明

  1. 接口灰度开放中,如有接入需求,请联系运营人员申请权限。

请求示例


curl 'https://api.e.qq.com/v1.1/conversions/add?access_token=<ACCESS_TOKEN>&timestamp=<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 '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' 
					

应答字段

名称 类型 描述
conversion_id
integer 转化 id

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "conversion_id": 12345
    }
}

可视化调试工具