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

获取广告
全部接口
V1.1
loading

所属权限 Ads Management,Ads Insights
请求地址 ads/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
filtering
 struct[] 过滤条件，若此字段不传，或传空则视为无限制条件，详见 [过滤条件]
数组最小长度 1，最大长度 6
field*
 string 过滤字段
可选值：{ ad_id, configured_status, system_status, ad_name, campaign_id, adgroup_id, created_time, last_modified_time }
operator*
 enum 操作符
当 field 取值 ad_id 时，枚举列表：{ EQUALS, IN }
当 field 取值 configured_status 时，枚举列表：{ EQUALS }
当 field 取值 system_status 时，枚举列表：{ EQUALS }
当 field 取值 ad_name 时，枚举列表：{ EQUALS, CONTAINS }
当 field 取值 campaign_id 时，枚举列表：{ EQUALS }
当 field 取值 adgroup_id 时，枚举列表：{ EQUALS, IN }
当 field 取值 created_time 时，枚举列表：{ EQUALS, LESS_EQUALS, LESS, GREATER_EQUALS, GREATER }
当 field 取值 last_modified_time 时，枚举列表：{ EQUALS, LESS_EQUALS, LESS, GREATER_EQUALS, GREATER }
values*
 string[] 字段取值，values 数组的个数限制与 operator 的取值相关，详见 [过滤条件]
当 field 取值 configured_status 时，
枚举列表：{ AD_STATUS_NORMAL, AD_STATUS_SUSPEND }

当 field 取值 system_status 时，
枚举列表：{ AD_STATUS_NORMAL, AD_STATUS_PENDING, AD_STATUS_DENIED, AD_STATUS_PARTIALLY_PENDING, AD_STATUS_PARTIALLY_NORMAL, AD_STATUS_PREPARE, AD_STATUS_DELETED, AD_STATUS_INVALID }

当 field 取值 ad_name 时，
字段长度最小 1 字节，长度最大 180 字节


当 field 取值 created_time 时，
字段长度为 10 字节

当 field 取值 last_modified_time 时，
字段长度为 10 字节
page
 integer 搜索页码，默认值：1
最小值 1，最大值 99999
page_size
 integer 一页显示的数据条数，默认值：10。最小值 1，最大值 100
is_deleted
 boolean 是否已删除，true：是，false：否
可选值：{ true, false }
weixin_official_accounts_upgrade_enabled
 boolean 针对微信公众号账户是否使用升级的新调用方式，true：使用升级的新方式，false：不使用，不传则默认值 false ；详细情况请查看公告[Marketing API 微信公众平台账户服务升级]
可选值：{ true, false }

使用说明

  1. is_deleted 参数不传时默认为 false，只返回未删除记录。
  2. is_deleted 参数为 true 时，需要同时在 filtering 传参数 last_modified_time。
  3. 当根据广告 id 进行查询且 is_deleted 参数不传或为 false 时，获取的广告列表包含已删除的广告。
  4. created_time 和 last_modified_time 的 values 值为时间戳，单位为秒，时区为 GMT+8。

请求示例


curl -G 'https://api.e.qq.com/v1.1/ads/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'filtering=[{"field":"ad_name","operator":"EQUALS","values":["推广广告"]}]' \
-d 'page=1' \
-d 'page_size=10' \
-d 'is_deleted=false'

应答字段

名称 类型 描述
list
 struct[] 返回信息列表
campaign_id
 int64 推广计划 id
adgroup_id
 int64 广告组 id，为了不同投放端体验的一致性，在创建广告时如广告创意 dynamic_adcreative_spec 字段不为空且对应广告组缺失 dynamic_ad_spec 或 product_source 内容，系统会自动将广告创意中 dynamic_ad_spec 或 product_source 内容写入对应广告组。
ad_id
 int64 广告 id
ad_name
 string 广告名称，字段长度最小 1 个等宽字符，长度最大 60 等宽字符（即字段最大长度为 60 个中文字或全角标点，120 个英文字或半角标点。一个等宽字符等价于一个中文，等价于两个英文。）
adcreative_id
 int64 广告创意 id
adcreative
 struct 广告创意
adcreative_id
 int64 广告创意 id
adcreative_name
 string 广告创意名称，字段长度最小 1 个等宽字符，长度最大 60 等宽字符（即字段最大长度为 60 个中文字或全角标点，120 个英文字或半角标点。一个等宽字符等价于一个中文，等价于两个英文。）
campaign_id
 int64 推广计划 id
adcreative_template_id
 integer 创意形式 id，具体请咨询您的运营接口人，也可通过创意形式查询工具进行查询
adcreative_elements
 struct 创意元素，不同 adcreative_template_id 要求的元素不尽相同，其中部分创意形式的文案元素支持换行能力，使用“\n ”表示换行，占 0.5 个等宽字符，建议行数不超过 6 行，具体情况可通过 [创意规格查询工具] 进行查询
page_type
 enum 落地页类型，[枚举详情]
page_spec
 struct 落地页信息，根据不同 promoted_object_type 和 page_type，要求的 page_spec 信息不同
page_id
 int64 落地页 id
page_url
 string 落地页 url
mini_program_spec
 struct 小程序落地页，mini_program_id 和 mini_program_path 要同时填写
mini_program_id
 string 小程序 id
mini_program_path
 string 小程序路径
mini_program_paths
 string[] 小程序落地页 path 列表
mini_program_openlink_option
 enum 小程序蹊径落地页开关选项，当投放版位含优量汇时、落地页使用「微信小程序」落地页时，支持使用「蹊径落地页」,默认开启，[枚举详情]
mini_game_spec
 struct 小游戏落地页信息
mini_game_tracking_parameter
 string 小游戏监控参数，需以英文字符?开头，如：?channel=xxxx，字段长度最小 1 个等宽字符，长度最大 250 个等宽字符（即字段最大长度为 250 个中文字或全角标点，500 个英文字或半角标点。一个等宽字符等价于一个中文，等价于两个英文。）
mini_game_openlink
 string openlink 地址字段，当投放版位含优量汇时、推广目标是微信小游戏推广目标时，支持填写「微信小游戏落地页的 openlink 地址」（白名单灰度中），什么是 opelink 可参考[微信开放文档]
mini_game_openlink_page_spec
 struct 小游戏蹊径落地页，当投放版位含优量汇时、推广目标是微信小游戏推广目标时，落地页使用「微信小游戏」落地页时，支持使用「蹊径落地页」（白名单灰度中）；注意不能同时和「 mini_game_openlink 」同时使用，否则会被蹊径落地页链接覆盖。
landing_page_type
 enum openlink 落地页页面类型，不大于 1024 个英文字符或数字，[枚举详情]
landing_page_id
 integer 落地页 id
mini_game_openlink_switch
 boolean 小游戏蹊径落地页开关，当投放版位含优量汇时、推广目标是微信小游戏推广目标时，落地页使用「微信小游戏」落地页时，支持使用「蹊径落地页」（白名单灰度中）
wechat_channels_spec
 struct 微信视频号落地页
id
 string 视频号 id
nonce_id
 string 视频号 nonce_id
username
 string 视频号 username
live_id
 string 视频号 live_id
live_title
 string 视频号 live_title
live_notice_id
 string 视频号 live_notice_id
nick_name
 string 视频号 nickname
live_ad_item
 struct 转化组件
is_use_component
 integer 是否启用直播间跳转组件
is_use_cheer_icon
 integer 是否启用直播间喝彩图
is_use_bg_img
 integer 是否启用直播背景图配置
conv_component
 struct 转化组件
page_id
 int64 落地页 id
title
 string conv_component title
img_url
 string conv_component img_url
desc
 string conv_component desc
button_text
 string conv_component button_text
cheer_icon_info
 struct[] 喝彩图
icon_url
 string 视频号 icon_url
samp_rate
 integer 喝彩图 samp_rate
bg_img_url
 string bg_img_url
begin_time
 integer begin_time
feed_page_conf
 struct[] feed 页面配置
ad_type
 integer 配置类型(8 关注按钮 9 跳转原生页)，配置类型
canvas_id
 integer 落地页 id
canvas_type
 integer 原生页模版 id
button_title
 string 按钮文案
feed_card_info
 struct 视频号个性化转化组件
icon_url
 string 视频号 feed_card_info icon_url
desc
 string 视频号 feed_card_info desc
card_type
 integer 视频号个性化组件类型
dest_url
 string 视频号 feed_card_info dest_url
free_trade_ad_info
 struct 互选广告组件信息
thumb
 struct 品牌图片
url
 string 视频号 free_trade_ad_info img_url
width
 integer 视频号图片视频大小
height
 integer 视频号图片视频大小
size
 integer 视频号图片视频大小
material_id
 string 视频号图片视频素材 id
image_list
 struct[] 推广图片
url
 string 视频号 free_trade_ad_info img_url
width
 integer 视频号图片视频大小
height
 integer 视频号图片视频大小
size
 integer 视频号图片视频大小
material_id
 string 视频号图片视频素材 id
title
 string 视频号 free_trade_ad_info title
desc
 string 视频号 free_trade_ad_info desc
back_color_rgb
 string free_trade_ad_info back_color_rgb
button_list
 struct[] 视频号个性化组件按钮信息
text
 string button_info text
dest_type
 integer 跳转类型
dest_url
 string 视频号 button_info dest_url
page_type
 integer 落地页类型
page_id
 int64 落地页 id
weapp_info
 struct 小程序/小游戏信息
gh_id
 string weapp_info gh_id
user_name
 string weapp_info user_name
app_id
 string weapp_info app_id
from_page_id
 integer 落地页 id
dynamic_show_type
 integer 转化数据类型
dynamic_show_text
 string 转化数据项文本
contest_info
 struct 问答信息组件
export_event_id
 string 视频号 contest_info export_event_id
question_id
 integer 问题 id
page_url
 string
mini_program_data
 struct 小程序跳转
mini_program_gh_id
 string
mini_program_path
 string
mini_program_app_id
 string
mini_game_data
 struct 小游戏跳转
mini_game_gh_id
 string
mini_game_monitor_query_string
 string 小游戏监控参数，需以英文字符?开头，如：?channel=xxxx，字段长度最小 1 个等宽字符，长度最大 250 个等宽字符（即字段最大长度为 250 个中文字或全角标点，500 个英文字或半角标点。一个等宽字符等价于一个中文，等价于两个英文。）
mini_game_app_id
 string
ios_app_id
 string IOS 应用直达 AppId
android_app_id
 string 安卓应用直达 AppId
is_full_screen_open_landing_page
 integer 视频号二跳是否全屏打开
channels_shop_product_spec
 struct
product_id
 integer 微信小店商品 id
shop_id
 string 微信小店 id
live_recycle_flag
 integer 直播广告重复使用标志
free_trade_ad_info
 struct 互选广告组件信息
thumb
 struct 品牌图片
url
 string 视频号 free_trade_ad_info img_url
width
 integer 视频号图片视频大小
height
 integer 视频号图片视频大小
size
 integer 视频号图片视频大小
material_id
 string 视频号图片视频素材 id
image_list
 struct[] 推广图片
url
 string 视频号 free_trade_ad_info img_url
width
 integer 视频号图片视频大小
height
 integer 视频号图片视频大小
size
 integer 视频号图片视频大小
material_id
 string 视频号图片视频素材 id
title
 string 视频号 free_trade_ad_info title
desc
 string 视频号 free_trade_ad_info desc
back_color_rgb
 string free_trade_ad_info back_color_rgb
button_list
 struct[] 视频号个性化组件按钮信息
text
 string button_info text
dest_type
 integer 跳转类型
dest_url
 string 视频号 button_info dest_url
page_type
 integer 落地页类型
page_id
 int64 落地页 id
weapp_info
 struct 小程序/小游戏信息
gh_id
 string weapp_info gh_id
user_name
 string weapp_info user_name
app_id
 string weapp_info app_id
from_page_id
 integer 落地页 id
dynamic_show_type
 integer 转化数据类型
dynamic_show_text
 string 转化数据项文本
rewardquest_free_trade_ad_info
 struct 小任务中间页
thumb
 struct 视频号图片信息
url
 string 参数
width
 number 整数
height
 number 整数
size
 number 整数
material_id
 number 整数
image_list
 struct[] 小任务推广图片
url
 string 参数
width
 number 整数
height
 number 整数
size
 number 整数
material_id
 number 整数
title
 string 小任务中间页品牌名称
desc
 string 小任务中间页推广文案
back_color_rgb
 string 16 进制颜色
dynamic_show_type
 enum 数据展示的数据类型，素材下方展示账户内积累的展示推广目标相关的转化数据，吸引用户点击。
投放指引：[枚举详情]
dynamic_show_text
 enum 数据展示转化行为，仅 conversion_data_type 为 CONVERSION_DATA_ADMETRIC 时可设置
可使用的版位可通过 [创意规格查询工具] 进行查询，[枚举详情]
btn_text
 enum 链接名称类型，[枚举详情]
export_id_hash_value
 integer 视频号直播间 id hash 值
head_img_url
 string 视频号头像
override_canvas_head_option
 enum 原生推广页顶部素材和广告创意素材之间的替换关系，（仅在朋友圈广告使用原生推广页情况下有效），[枚举详情]
dynamic_product_spec
 struct 动态多商品广告落地页信息，仅支持 MDPA 广告使用动态落地页(见 dynamic_adcreative_spec.landing_page_url_type) 时填写
page_url
 string 动态落地页 url
mini_program_paths
 string[] 动态多商品广告小程序落地页 path 列表
wechat_official_account_spec
 struct 落地页公众号信息
app_id
 string 公众号 appId
search_brand_area_spec
 struct 搜一搜超级品专落地页信息
search_brand_area_keyword
 string 跳转超级品专搜索关键词
channels_shop_product_spec
 struct
product_id
 integer 微信小店商品 id
shop_id
 string 微信小店 id
site_set
 enum[] 投放版位集合，当前单版位或者 SITE_SET_TENCENT_NEWS+SITE_SET_TENCENT_VIDEO+SITE_SET_MOBILE_UNION+SITE_SET_KANDIAN+SITE_SET_QQ_MUSIC_GAME 的组合，[枚举详情]
promoted_object_type
 enum 推广目标类型，[枚举详情]
promoted_object_id
 string 推广目标 id，详见 [查询推广目标 id]
created_time
 integer 创建时间（时间戳）
last_modified_time
 integer 最后修改时间（时间戳）
playable_page_material_id
 string 互动推广页落地页 id，（待废弃，请改为使用 video_end_page 进行设置）
video_end_page
 struct 视频播放结束页，（当前仅支持互动推广页）
end_page_id
 string 视频播放结束页 id
end_page_type
 enum 视频播放结束页类型，[枚举详情]
enable_breakthrough_siteset
 boolean 是否支持版位突破，广告版位选择“微信朋友圈”，当广告有机会获得更多曝光与转化时，将可能投放到微信公众号与小程序版位，若不传值默认为 true
creative_template_category
 string 创意形式类型
configured_status
 enum 客户设置的状态，[枚举详情]
system_status
 enum 系统状态，[枚举详情]
audit_spec
 struct[] 多版位的审核结果信息，仅当 automatic_site_enabled=true 或 site_set 传入多个值时，此字段会返回
site_set
 enum 版位信息，[枚举详情]
system_status
 enum 系统状态，[枚举详情]
reject_message
 string 审核消息
element_reject_detail_info
 struct[] 元素拒绝原因详情
element_name
 string 元素名
element_value
 string 元素值
element_type
 string 元素类型
reason
 string 审核消息
case_doc
 string 案例 url
case_content
 string 案例内容富文本
reject_info_location
 struct[] 元素拒绝原因详情
x
 integer x 轴位置
y
 integer y 轴位置
width
 integer 宽度
height
 integer 高度
time_second
 float 视频时间点
location_img_url
 string 标注结果图 url
img_url
 string 帧图片 url
related_img_url
 string 种子图 url
impression_tracking_url
 string 曝光监控地址，监控地址主域只允许白名单内的域名，详见 [第三方监控]
click_tracking_url
 string 点击监控地址，监控地址主域只允许白名单内的域名，详见 [第三方监控]
feeds_interaction_enabled
 boolean 是否支持赞转评
reject_message
 string 审核消息
is_deleted
 boolean 是否已删除，true：是，false：否
is_dynamic_creative
 boolean 是否是动态创意广告自动生成的，true：是，false：否
created_time
 integer 创建时间（时间戳）
last_modified_time
 integer 最后修改时间（时间戳）
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>",
                "ad_id": "<AD_ID>",
                "ad_name": "推广广告",
                "adcreative_id": "<ADCREATIVE_ID>",
                "adcreative": {
                    "adcreative_id": "<ADCREATIVE_ID>",
                    "adcreative_name": "广告创意",
                    "campaign_id": "<CAMPAIGN_ID>",
                    "adcreative_template_id": "<ADCREATIVE_TEMPLATE_ID>",
                    "adcreative_elements": {
                        "image": "123456:f4c8a3bc4deb305fb74cb08ed395b98c"
                    },
                    "page_type": "PAGE_TYPE_DEFAULT",
                    "page_spec": {
                        "page_url": "https://www.example.com"
                    },
                    "site_set": [
                        "SITE_SET_WECHAT"
                    ],
                    "promoted_object_type": "PROMOTED_OBJECT_TYPE_LINK_WECHAT",
                    "created_time": 1491019858,
                    "last_modified_time": 1491098468,
                    "video_end_page": []
                },
                "configured_status": "AD_STATUS_NORMAL",
                "system_status": "AD_STATUS_NORMAL",
                "audit_spec": [
                    {
                        "site_set": [
                            "SITE_SET_WECHAT"
                        ],
                        "system_status": "AD_STATUS_NORMAL",
                        "reject_message": "Reject message example",
                        "element_reject_detail_info": [
                            {
                                "reject_info_location": []
                            }
                        ]
                    }
                ],
                "impression_tracking_url": "http://miaozhen.com/track?from=tencent&aid=30304",
                "click_tracking_url": "http://miaozhen.com/track2?from=tencent&aid=30304",
                "feeds_interaction_enabled": "INTERACTION_DISABLED",
                "reject_message": "Reject message example",
                "is_deleted": false,
                "created_time": 1491019858,
                "last_modified_time": 1491098468
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_number": 1,
            "total_page": 1
        }
    }
}

可视化调试工具

相关阅读

广告微信朋友圈广告投放指引oCPA 智能出价广告投放指引动态商品广告投放指引

广告资源

广告技术

开发文档

辅助工具

帮助支持

手机浏览开发者官网

Copyright © 1998 - Tencent Inc. All Rights Reserved.