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

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

所属权限 Ads Management
请求地址 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 日期范围,最多支持查询 90 天内的数据查询,支持的最长查询跨度为 1 天

微信公众账号逻辑

最多支持查询 30 天内的数据查询,支持的最长查询跨度为 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 }
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_SUSPEND, CALCULATE_STATUS_READY, CALCULATE_STATUS_ACTIVE, CALCULATE_STATUS_STOP }

当 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 拉取 ad 结构
campaign_id
integer 推广计划 id
campaign_name
string 推广计划名称,字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
adgroup
struct 拉取广告结构(计划数据较少放一起了)
adgroup_id
integer 广告组 id
adgroup_name
string 广告组名称,同一帐号下的广告组名称不允许重复。字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
begin_date
string 开始投放日期,日期格式:YYYY-MM-DD,且日期小于等于 end_date
targeting
struct 定向详细设置,存放所有定向条件,附近推场景年龄、性别定向必填
age
struct[] 年龄定向(仅支持单年龄段,范围为 14~66,66 代表的是 66 岁及 66 岁以上,如 18~66 代表大于等于 18 岁)
min
integer 年龄最小值限制,其中 15、16、17 不可用
max
integer 年龄最大值限制
gender
enum[] 性别定向(仅单选),[枚举详情]
poi_list
string[] 微信门店 poi list,附近推场景下必填
cold_start_audience
integer[] 冷启动人群包列表
adcreative
struct 拉取创意结构
adcreative_id
integer 广告创意 id
adcreative_name
string 广告创意名称,字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
adcreative_elements
struct 创意元素,不同 adcreative_template_id 要求的元素不尽相同,其中部分创意形式的文案元素支持换行能力,使用“\n ”表示换行,占 0.5 个等宽字符,建议行数不超过 6 行,具体情况可通过 [创意规格查询工具] 进行查询
page_type
enum 落地页类型,[枚举详情]
page_spec
struct 落地页信息,根据不同 promoted_object_type 和 page_type,要求的 page_spec 信息不同
mini_program_spec
struct 小程序落地页,mini_program_id 和 mini_program_path 要同时填写
mini_program_id
string 小程序 id
mini_program_path
string 小程序路径
ad
struct 拉取 ad 结构
ad_id
integer 广告 id
ad_name
string 广告名称,字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。),同一帐号下的广告名称不允许重复
account_metric
struct 报表效果数据
cost
integer 花费-展示指标,单位为“分”
view_count
integer 曝光量-展示指标
valid_click_count
integer 点击量-展示指标
ctr
float 点击率
order_count
integer 下单量,用户通过该广告进行商品成交(如下单提交、在线支付)的次数,接入转化跟踪后可统计。微信广告主可用
web_order_cost
integer 下单成本-转化指标(网页类)-成交后行为,单位为“分”
order_roi
float 订单 ROI
channels_video_play_pv
integer 视频播放次数
channels_video_play_time
integer 视频播放时长
channels_heart_pv
integer 视频点赞次数
channels_heart_dedup_pv
integer 视频点赞人数
channels_comment_pv
integer 视频评论次数
channels_comment_uv
integer 视频评论人数
channels_share_pv
integer 视频分享次数
channels_share_uv
integer 视频分享人数
channels_follow_pv
integer 视频点赞总数
channels_follow_dedup_pv
integer 视频点赞总数
channels_feeds_heart_pv
integer Feeds 内视频点赞总数
channels_feeds_heart_uv
integer Feeds 内视频点赞人数
channels_feeds_comment_pv
integer Feeds 内视频评论总次数
channels_feeds_share_pv
integer Feeds 内视频分享总次数
channels_feeds_video_play_pv
integer Feeds 内视频播放总次数
exp_pv
integer 观看量(次)
canvas_cpn_coupons_get_pv
integer 优惠券领取量
canvas_cpn_coupons_cost
integer 优惠券领取成本
canvas_cpn_coupons_use_pv
integer 优惠使用量
purchase
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": "<ADGROUP_ID>",
                    "adgroup_name": "推广广告",
                    "targeting": {
                        "age": [],
                        "gender": []
                    },
                    "poi_list": [],
                    "cold_start_audience": []
                },
                "adcreative": {
                    "adcreative_id": "<ADCREATIVE_ID>",
                    "adcreative_name": "广告创意",
                    "adcreative_elements": {
                        "image_list": []
                    },
                    "page_spec": {
                        "mini_program_spec": []
                    }
                },
                "ad": {
                    "ad_id": "<AD_ID>"
                },
                "account_metric": []
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_page": 1
        }
    }
}

可视化调试工具