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

拉取广告列表
全部接口
V1.1
loading

所属权限
请求地址 local/get
请求方法 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
date_range*
 struct 日期范围，最多支持查询 180 天内的数据查询，支持的最长查询跨度为 1 天
start_date*
 string 开始日期，日期格式：YYYY-MM-DD，且小于等于 end_date
字段长度为 10 字节
end_date*
 string 结束日期，日期格式：YYYY-MM-DD
字段长度为 10 字节
filtering
 struct[] 过滤条件，若此字段不传，或传空则视为无限制条件;
数组最小长度 1，最大长度 5
field*
 string 过滤字段
可选值：{ adgroup_id, calc_status, created_time, local_business_mode }
operator*
 enum 操作符
当 field 取值 adgroup_id 时，枚举列表：{ EQUALS, IN }
当 field 取值 calc_status 时，枚举列表：{ EQUALS }
当 field 取值 created_time 时，枚举列表：{ EQUALS, LESS_EQUALS, LESS, GREATER_EQUALS, GREATER }
values*
 string[] 字段取值，values 数组元素的个数限制与 operator 的取值相关

当 field 取值 calc_status 时，
枚举列表：{ CALCULATE_STATUS_PENDING, CALCULATE_STATUS_DENIED, CALCULATE_STATUS_FROZEN, CALCULATE_STATUS_SUSPEND, CALCULATE_STATUS_READY, CALCULATE_STATUS_ACTIVE, CALCULATE_STATUS_STOP, CALCULATE_STATUS_NOT_READY_IMG, CALCULATE_STATUS_ACTIVE_ACC_FROZEN, CALCULATE_STATUS_ACTIVE_ACC_LIMIT, CALCULATE_STATUS_ACTIVE_CAM_LIMIT, CALCULATE_STATUS_ACTIVE_CAM_PAUSED, CALCULATE_STATUS_PART_READY, CALCULATE_STATUS_PART_ACTIVE, CALCULATE_STATUS_LOCAL_WEPAY_PENDING }

当 field 取值 created_time 时，
字段长度为 10 字节
level*
 enum 报表类型，[枚举详情]
枚举列表：{ REPORT_LEVEL_ADVERTISER_WECHAT, REPORT_LEVEL_ADGROUP_WECHAT }
page*
 integer 页码
page_size*
 integer 每页数量

使用说明

  1. 拉取广告数据和报表数据列表。

请求示例


curl 'https://api.e.qq.com/v1.1/local/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'date_range={"start_date":"YYYY-MM-DD","end_date":"YYYY-MM-DD"}' \
-d 'filtering=[]' \
-d 'page=1' \
-d 'page_size=10'

应答字段

名称 类型 描述
list
 struct[] 广告报表混合 list 数组
campaign
 struct 计划结构
campaign_id
 int64 推广计划 id
campaign_name
 string 推广计划名称，字段长度最小 1 个等宽字符，长度最大 60 等宽字符（一个等宽字符等价于一个中文，或等于两个英文。）
adgroup
 struct 广告结构
adgroup_id
 int64 广告组 id
configured_status
 enum 客户设置的状态，[枚举详情]
adgroup_name
 string 广告组名称，同一帐号下的广告组名称不允许重复。字段长度最小 1 个等宽字符，最大 60 等宽字符（一个等宽字符等价于一个中文,或两个英文。）
begin_date
 string 开始投放日期，日期格式：YYYY-MM-DD，且日期小于等于 end_date
end_date
 string 结束日期，日期格式：YYYY-MM-DD，且大于等于 begin_date
optimization_goal
 enum 广告优化目标类型，[枚举详情]
total_budget
 integer 总预算，单位为分，每次加减单位 10000
targeting
 struct 定向详细设置，存放所有定向条件，年龄、性别定向必填，年龄需输入上下限[min, max]，性别全选时可为空
age
 struct[] 年龄定向（仅支持单年龄段，范围为 14~66，66 代表的是 66 岁及 66 岁以上）
min
 integer 年龄下限，其中 15、16、17 不可用
max
 integer 年龄上限
gender
 enum[] 性别定向（仅单选），[枚举详情]
education
 enum[] 用户学历，[枚举详情]
calc_status
 enum 计算状态，[枚举详情]
metric_detail
 struct 广告报表指标, 当 level 等于 REPORT_LEVEL_ADGROUP_WECHAT 返回
cost
 integer 花费-展示指标，单位为“分”
valid_click_count
 integer 点击量-展示指标
ctr
 float 点击率
exp_pv
 integer 曝光量
canvas_cpn_coupons_get_pv
 integer 优惠券领取量（广告提供的落地页小程序）
canvas_cpn_coupons_cost
 integer 优惠券领取成本（广告提供的落地页小程序）
canvas_cpn_coupons_use_pv
 integer 优惠使用量（广告提供的落地页小程序）
purchase
 integer 优惠券购买
promotion_claim_offer_pv
 integer 优惠券领取量（服务商/商家自己的小程序）
page_visit_store_pv
 integer 使用量（服务商/商家自己的小程序)
weapp_exp_pv
 integer 推广页浏览量（服务商/商家自己的小程序）
promotion_claim_offer_cost
 integer 领券成本（服务商/商家自己的小程序）
page_visit_store_amount
 integer 消费金额（服务商/商家自己的小程序)
buy_coupons_pv
 integer 优惠券购买次数（服务商/商家自己的小程序)
buy_coupons_cost
 integer 购券成本（服务商/商家自己的小程序)
quest_reservation_uv
 integer 线索收集量（广告提供的落地页/服务商/商家自己的小程序）
cvs_exp_pv
 integer 推广页浏览量（广告提供的落地页小程序）
cvs_exp_cost
 integer 推广页浏览成本（广告提供的落地页小程序）
weapp_exp_cost
 integer 推广页浏览成本（服务商/商家自己的小程序）
quest_reservation_uv_cost
 integer 线索收集成本（广告提供的落地页/服务商/商家自己的小程序）
reach_store_pay_gmv
 integer 到店支付金额（通过微信支付归因）
reach_store_pay_uv
 integer 到店支付人数（通过微信支付归因）
reach_store_pay_pv
 integer 到店支付次数（通过微信支付归因）
reach_store_pay_roi
 float 广告投放 ROI（到店支付金额 / 广告消耗）
clk_pv_avg
 float 人均点击次数（点击次数/ 点击人数）
reach_store_pay_arpu
 float 人均消费（到店支付金额/ 到店人数）
click_user_count
 integer 点击人数，在广告外层进行点击操作的独立用户数，微信广告主可用
reject_message
 string 驳回原因
poi_list
 string[] 门店 poi list, poi id 从腾讯地图打点获取
cold_start_audience
 integer[] 扩量种子人群（原冷启动人群名称升级扩量种子人群）
1、系统会学习您选择的人群包数据，帮助提升广告投放效果；
2、仅支持人群类型为 CUSTOMER_FILE（号码文件人群）的可用人群 id、且人群数量大于 100 时；
poi_radius
 integer 最大投放半径范围，单位为米
local_business_mode
 enum 附近推模式，[枚举详情]
adcreative
 struct 拉取创意结构
adcreative_id
 int64 广告创意 id
adcreative_name
 string 创意名称，长度最小 1 个等宽字符，最大 60 等宽字符（一个等宽字符等价于一个中文，或等价于两个英文。）
adcreative_template_id
 integer 创意规格 id，具体请咨询您的运营接口人，也可通过 [创意规格查询工具] 进行查询
adcreative_elements
 struct 创意元素，不同 adcreative_template_id 要求的元素不尽相同，其中部分创意形式的文案元素支持换行能力，使用“\n ”表示换行，占 0.5 个等宽字符，建议行数不超过 6 行，具体情况可通过 [创意规格查询工具] 进行查询
page_type
 enum 落地页类型，目前提供两类落地页能力，一是广告侧提供的小程序原生页模板，二是广告主自定义的小程序页面，[枚举详情]
page_spec
 struct 落地页信息，不同 page_type 填写的信息不同。page_type 为 PAGE_TYPE_MINI_PROGRAM_WECHAT 时需填写 mini_program_spec，page_type 为 PAGE_TYPE_MINI_PROGRAM_CANVAS_WECHAT 时需填写 alita_page_spec
mini_program_spec
 struct 小程序落地页，mini_program_id 和 mini_program_path 要同时填写
mini_program_id
 string 小程序原始 id，格式类似 gh_xxxxx
mini_program_path
 string 小程序路径
alita_page_spec
 struct 微信小程序原生页
button_tips
 string 优惠描述，包括使用规则，不超过 60 个字
coupon_title
 string 优惠标题，不超过 10 个字
begin_date
 string 开始日期，日期格式：YYYY-MM-DD，且小于等于 end_date
end_date
 string 结束日期，日期格式：YYYY-MM-DD
profile_id
 integer profileId 自定义昵称和头像，大于 0 且小于 2^63
profile_type
 enum 头像类型,使用自定义类型需要传 profile id，通过该字段实现类型的切换，[枚举详情]
account_metric
 struct 账户维度报表指标, 当 level 等于 REPORT_LEVEL_ADVERTISER_WECHAT 返回
cost
 integer 花费-展示指标，单位为“分”
valid_click_count
 integer 点击量-展示指标
ctr
 float 点击率
exp_pv
 integer 曝光量
canvas_cpn_coupons_get_pv
 integer 优惠券领取量（广告提供的落地页小程序）
canvas_cpn_coupons_cost
 integer 优惠券领取成本（广告提供的落地页小程序）
canvas_cpn_coupons_use_pv
 integer 优惠使用量（广告提供的落地页小程序）
purchase
 integer 优惠券购买
promotion_claim_offer_pv
 integer 优惠券领取量（服务商/商家自己的小程序）
page_visit_store_pv
 integer 使用量（服务商/商家自己的小程序)
weapp_exp_pv
 integer 推广页浏览量（服务商/商家自己的小程序）
promotion_claim_offer_cost
 integer 领券成本（服务商/商家自己的小程序）
page_visit_store_amount
 integer 消费金额（服务商/商家自己的小程序)
buy_coupons_pv
 integer 优惠券购买次数（服务商/商家自己的小程序)
buy_coupons_cost
 integer 购券成本（服务商/商家自己的小程序)
quest_reservation_uv
 integer 线索收集量（广告提供的落地页/服务商/商家自己的小程序）
cvs_exp_pv
 integer 推广页浏览量（广告提供的落地页小程序）
cvs_exp_cost
 integer 推广页浏览成本（广告提供的落地页小程序）
weapp_exp_cost
 integer 推广页浏览成本（服务商/商家自己的小程序）
quest_reservation_uv_cost
 integer 线索收集成本（广告提供的落地页/服务商/商家自己的小程序）
reach_store_pay_gmv
 integer 到店支付金额（通过微信支付归因）
reach_store_pay_uv
 integer 到店支付人数（通过微信支付归因）
reach_store_pay_pv
 integer 到店支付次数（通过微信支付归因）
reach_store_pay_roi
 float 广告投放 ROI（到店支付金额 / 广告消耗）
clk_pv_avg
 float 人均点击次数（点击次数/ 点击人数）
reach_store_pay_arpu
 float 人均消费（到店支付金额/ 到店人数）
click_user_count
 integer 点击人数，在广告外层进行点击操作的独立用户数，微信广告主可用
page_info
 struct 拉取创意结构
page
 integer 页码
page_size
 integer 每页数量
total_page
 integer 总页数
total_num
 integer 总条数

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "campaign": {
                    "campaign_id": "<CAMPAIGN_ID>"
                },
                "adgroup": {
                    "adgroup_id": 123456789,
                    "adgroup_name": "推广广告",
                    "targeting": {
                        "age": [],
                        "gender": [],
                        "education": []
                    },
                    "metric_detail": [],
                    "reject_message": "Reject message example",
                    "poi_list": [],
                    "cold_start_audience": []
                },
                "adcreative": {
                    "adcreative_id": "<ADCREATIVE_ID>",
                    "adcreative_name": "广告创意",
                    "adcreative_template_id": "<ADCREATIVE_TEMPLATE_ID>",
                    "adcreative_elements": {
                        "image_list": []
                    },
                    "page_spec": {
                        "mini_program_spec": [],
                        "alita_page_spec": []
                    }
                },
                "account_metric": []
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_page": 1
        }
    }
}

可视化调试工具

广告资源

广告技术

开发文档

辅助工具

帮助支持

手机浏览开发者官网

Copyright © 1998 - Tencent Inc. All Rights Reserved.