获取表单线索（Leads）
V1.1
loading
V1.1
loading
本节将为您介绍获取表单线索（Leads）相关关接口。 关于异步任务更详细的介绍可以参考【数据洞察】章节。
- date_range/time_range 为销售线索填写的时间，如未指定，则默认查询当天的数据。
- 如需根据推广计划创建的时间或者推广计划 id 进行过滤，可以通过使用 filtering 结构进行调用。
- 如数据量级较大，请缩小时间范围并使用过滤条件获取数据。
- 接口默认仅拉取微信朋友圈的销售线索数据，如需获取非朋友圈流量的数据，可以通过使用 position_type = POSITION_TYPE_WECHAT_OTHERS 进行过滤。
- 接口仅支持通过微信广告主授权获得的 access_token 进行调用。
- 由于归因系统有一定失败概率，部分销售线索无法归因至特定广告，相关线索 campaign_id、adgroup_id 信息为空。
- 由于归因系统有一定失败概率，部分销售线索无法归因至特定广告，相关线索 campaign_id、adgroup_id 信息为空，wechat_campaign_id、wechat_adgroup_id 为 0。
所属权限（scope）：Ads Insight
获取销售线索(待废弃)
全部接口
V1.1
loading
V1.1
loading
| 所属权限 | |
| 请求地址 | wechat_leads/get |
| 请求方法 | get |
全局参数
全局参数是指每一个接口都需要使用到的参数。详情参考，代码案例参考。
| 参数名称 | 参数类型 |
|---|---|
| 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 中的字段。如不填写，则根据默认值进行返回 |
请求参数
标有*的参数为必填项
| 名称 | 类型 | 描述 |
|---|---|---|
|
date_range
|
struct | 时间范围（即将废弃，请使用 time_range），根据表单最后提交时间进行查询，默认查询当天的数据，最长跨度 1 年，最多支持下载最近 1 年的表单明细数据 |
|
start_date*
|
string | 开始日期，期格式，YYYY-mm-dd，且小于等于 end_date 字段长度为 10 字节 |
|
end_date*
|
string | 结束日期，日期格式，YYYY-mm-dd 字段长度最小 0 字节，长度最大 10 字节 |
|
time_range
|
struct | 时间范围，根据表单最后提交时间进行查询。date_range 和 time_range 只能填写一项。默认查询当天的数据，最长跨度 1 年，最多支持下载最近 1 年的表单明细数据 |
|
start_time*
|
integer | 开始时间戳，精确到秒，限一年内，且小于 end_time 最小值 0，最大值 9999999999 |
|
end_time*
|
integer | 结束时间戳，精确到秒，大于 start_time 最小值 0，最大值 9999999999 |
|
filtering
|
struct[] | 过滤条件，若此字段不传，或传空则视为无限制条件，详见 [过滤条件] 数组最小长度 0，最大长度 100 |
|
field*
|
string | 过滤字段 可选值：{ campaign_id, campaign_created_time, position_type } |
|
operator*
|
enum | 操作符 当 field 取值 campaign_id 时，枚举列表：{ EQUALS, IN } 当 field 取值 campaign_created_time 时，枚举列表：{ GREATER_EQUALS, GREATER_EQUALS } 当 field 取值 position_type 时，枚举列表：{ EQUALS } |
|
values*
|
string[] | 字段取值 values 数组的个数限制与 operator 的取值相关，详见 [过滤条件] 当 field 取值 position_type 时， 枚举列表：{ POSITION_TYPE_WECHAT_MOMENTS, POSITION_TYPE_WECHAT_OTHERS } |
|
page
|
integer | 搜索页码，默认值：1 最小值 1，最大值 99999 |
|
page_size
|
integer | 一页显示的数据条数，默认值：10 最小值 1，最大值 100 |
使用说明
请求示例
curl -G 'https://api.e.qq.com/v1.1/wechat_leads/get?access_token=<ACCESS_TOKEN>×tamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'date_range={"start_date":"YYYY-MM-DD","end_date":"YYYY-MM-DD"}' \
-d 'time_range={"start_time":1558810018,"end_time":1558840608}' \
-d 'filtering=[{"field":"campaign_id","operator":"EQUALS","values":[456792]}]' \
-d 'page=1' \
-d 'page_size=10'
应答字段
| 名称 | 类型 | 描述 |
|---|---|---|
|
list
|
struct[] | 返回信息列表 |
|
adgroup_id
|
int64 | 广告组 id |
|
leads_info
|
struct[] | 销售线索信息 |
|
key
|
string | 销售线索键名 |
|
value
|
string | 销售线索键值 |
|
campaign_id
|
int64 | 推广计划 id |
|
campaign_name
|
string | 推广计划名称 |
|
adgroup_name
|
string | 广告组名称，同一帐号下的广告组名称不允许重复。字段长度最小 1 个等宽字符，长度最大 60 等宽字符（即字段最大长度为 60 个中文字或全角标点，120 个英文字或半角标点。一个等宽字符等价于一个中文，等价于两个英文。） |
|
agency_id
|
string | 微信服务商 id |
|
agency_name
|
string | 服务商名称 |
|
click_id
|
string | 点击 id |
|
page_info
|
struct | 分页配置信息 |
|
page
|
integer | 搜索页码 |
|
page_size
|
integer | 一页显示的数据条数 |
|
total_number
|
integer | 总条数 |
|
total_page
|
integer | 总页数 |
应答示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"list": [
{
"adgroup_id": 123456,
"leads_info": [
{
"key": "姓名",
"value": "唐"
},
{
"key": "称呼",
"value": "2"
},
{
"key": "手机",
"value": "12222222222"
},
{
"key": "提交时间",
"value": "2019-01-05 08:24:36"
}
],
"campaign_id": 12345,
"campaign_name": "test",
"adgroup_name": "test",
"agency_id": 50254,
"agency_name": "test",
"click_id": "1234567"
}
],
"page_info": {
"page": 1,
"page_size": 10,
"total_number": 1,
"total_page": 1
}
}
}可视化调试工具
问题仍未解决？
请前往腾讯广告反馈中心在线提交问题，我们的人工客服将为你服务
获取销售线索(待废弃)
全部接口
V1.1
loading
V1.1
loading
| 所属权限 | |
| 请求地址 | leads/get |
| 请求方法 | get |
全局参数
全局参数是指每一个接口都需要使用到的参数。详情参考，代码案例参考。
| 参数名称 | 参数类型 |
|---|---|
| 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 |
|
time_range*
|
struct | 时间范围： 1、最多支持查询最近 1 年的表单明细数据 2、单次查询的最长跨度为 1 年 3、该时间表示表单最后提交时间 |
|
start_time*
|
integer | 开始时间戳，精确到秒，限一年内，且小于 end_time 最小值 0，最大值 9999999999 |
|
end_time*
|
integer | 结束时间戳，精确到秒，大于 start_time 最小值 0，最大值 9999999999 |
|
position_type*
|
enum | 广告位类型，[枚举详情] 枚举列表：{ POSITION_TYPE_WECHAT_MOMENTS, POSITION_TYPE_WECHAT_OTHERS } |
|
filtering
|
struct[] | 过滤条件，若此字段不传，或传空则视为无限制条件，详见 [过滤条件] 过滤条件中，微信计划相关信息的与广点通计划相关信息不能同时设置，即{wechat_campaign_id, wechat_campaign_created_time} 与{campaign_id，campaign_created_time}不能同时使用 数组最小长度 0，最大长度 100 |
|
field*
|
string | 过滤字段 可选值：{ campaign_id, campaign_created_time, wechat_campaign_id, wechat_campaign_created_time } |
|
operator*
|
enum | 操作符 当 field 取值 campaign_id 时，枚举列表：{ EQUALS, IN } 当 field 取值 campaign_created_time 时，枚举列表：{ GREATER_EQUALS, GREATER_EQUALS } 当 field 取值 wechat_campaign_id 时，枚举列表：{ EQUALS, IN } 当 field 取值 wechat_campaign_created_time 时，枚举列表：{ GREATER_EQUALS, GREATER_EQUALS } |
|
values*
|
string[] | 字段取值，values 数组的个数限制与 operator 的取值相关，详见 [过滤条件] |
|
page
|
integer | 搜索页码，默认值：1 最小值 1，最大值 99999 |
|
page_size
|
integer | 一页显示的数据条数，默认值：10 最小值 1，最大值 100 |
使用说明
请求示例
curl -G 'https://api.e.qq.com/v1.1/leads/get?access_token=<ACCESS_TOKEN>×tamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'time_range={"start_time":1558810018,"end_time":1558840608}' \
-d 'filtering=[{"field":"campaign_id","operator":"EQUALS","values":[456792]}]' \
-d 'page=1' \
-d 'page_size=10'
应答字段
| 名称 | 类型 | 描述 |
|---|---|---|
|
list
|
struct[] | 返回信息列表 |
|
campaign_id
|
int64 | 推广计划 id |
|
campaign_name
|
string | 推广计划名称 |
|
adgroup_id
|
int64 | 广告组 id |
|
adgroup_name
|
string | 广告组名称 |
|
wechat_adgroup_id
|
integer | 微信广告组 id |
|
lead_spec_list
|
struct[] | 销售线索信息 |
|
key
|
string | 销售线索键名 |
|
value
|
string | 销售线索键值 |
|
wechat_campaign_id
|
integer | 微信推广计划 id |
|
wechat_campaign_name
|
string | 微信推广计划名称 |
|
wechat_adgroup_name
|
string | 微信广告组名称 |
|
wechat_agency_id
|
string | 微信服务商 id |
|
wechat_agency_name
|
string | 微信代理商名称 |
|
click_id
|
string | 点击 id |
|
page_info
|
struct | 分页配置信息 |
|
page
|
integer | 搜索页码 |
|
page_size
|
integer | 一页显示的数据条数 |
|
total_number
|
integer | 总条数 |
|
total_page
|
integer | 总页数 |
应答示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"list": [
{
"campaign_id": "<CAMPAIGN_ID>",
"adgroup_id": "<ADGROUP_ID>",
"adgroup_name": "推广广告",
"wechat_adgroup_id": 123456,
"lead_spec_list": [
{
"key": "姓名",
"value": "唐"
},
{
"key": "称呼",
"value": "2"
},
{
"key": "手机",
"value": "12222222222"
},
{
"key": "提交时间",
"value": "2019-01-05 08:24:36"
}
],
"wechat_campaign_id": 12345,
"wechat_campaign_name": "test",
"wechat_adgroup_name": "test",
"wechat_agency_id": 50254,
"wechat_agency_name": "test",
"click_id": "1234567"
}
],
"page_info": {
"page": 1,
"page_size": 10,
"total_number": 1,
"total_page": 1
}
}
}可视化调试工具
问题仍未解决？
请前往腾讯广告反馈中心在线提交问题，我们的人工客服将为你服务
