接口文档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 }

微信公众账号逻辑

仅支持:ad_id,campaign_id
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 }

使用说明

  1. is_deleted 参数不传时默认为 false,只返回未删除记录。
  2. is_deleted 参数为 true 时,需要同时在 filtering 传参数 last_modified_time。
  3. 当根据广告 id 进行查询且 is_deleted 参数不传或为 false 时,获取的广告列表包含已删除的广告。

请求示例


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
integer 推广计划 id
adgroup_id
integer 广告组 id
ad_id
integer 广告 id
ad_name
string 广告名称,字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
adcreative_id
integer 广告创意 id
adcreative
struct 广告创意

微信公众账号逻辑

不支持
adcreative_id
integer 广告创意 id
adcreative_name
string 广告创意名称,字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
campaign_id
integer 推广计划 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
integer 落地页 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_game_spec
struct 小游戏落地页信息
mini_game_tracking_parameter
string 小游戏监控参数,需以英文字符?开头,如:?channel=xxxx,字段长度最小 1 个等宽字符,长度最大 250 个等宽字符(即字段最大长度为 250 个中文字或全角标点,500 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
override_canvas_head_option
enum 原生推广页顶部素材和广告创意素材之间的替换关系,(仅在朋友圈广告使用原生推广页情况下有效),[枚举详情]
site_set
enum[] 投放版位集合,当前单版位或者 SITE_SET_TENCENT_NEWS+SITE_SET_TENCENT_VIDEO+SITE_SET_MOBILE_UNION+SITE_SET_MOBILE_INNER+SITE_SET_KANDIAN+SITE_SET_QQ_MUSIC_GAME 的组合,[枚举详情]

微信公众账号逻辑

仅支持 SITE_SET_WECHAT, SITE_SET_MINI_GAME_WECHAT
promoted_object_type
enum 推广目标类型,[枚举详情]

微信公众账号逻辑

支持读取的推广目标类型:
PROMOTED_OBJECT_TYPE_APP_ANDROID:Android 应用
PROMOTED_OBJECT_TYPE_APP_IOS:IOS 应用
PROMOTED_OBJECT_TYPE_ECOMMERCE:电商推广
PROMOTED_OBJECT_TYPE_LINK_WECHAT:微信品牌页
PROMOTED_OBJECT_TYPE_LOCAL_ADS_WECHAT:本地广告(微信推广)
PROMOTED_OBJECT_TYPE_LEAD_AD:销售线索
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 视频播放结束页类型,[枚举详情]
configured_status
enum 客户设置的状态,[枚举详情]

微信公众账号逻辑

不支持设置
system_status
enum 系统状态,[枚举详情]
audit_spec
struct[] 多版位的审核结果信息,仅当 automatic_site_enabled=true 或 site_set 传入多个值时,此字段会返回
site_set
enum 版位信息,[枚举详情]
system_status
enum 系统状态,[枚举详情]
reject_message
string 审核消息
impression_tracking_url
string 曝光监控地址,监控地址主域只允许白名单内的域名,详见 [第三方监控]

微信公众账号逻辑

不支持该能力,仅支持传入空字符串
click_tracking_url
string 点击监控地址,监控地址主域只允许白名单内的域名,详见 [第三方监控]

微信公众账号逻辑

不支持该能力,仅支持传入空字符串
feeds_interaction_enabled
boolean 是否支持赞转评

微信公众账号逻辑

非微信流量功能,不支持设置,仅支持传入 false
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"
                    }
                ],
                "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
        }
    }
}

可视化调试工具

相关阅读