获取广告

请求参数

标有*的参数为必填项

名称	类型	描述
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。

应答字段

名称	类型	描述
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	小游戏蹊径落地页开关，当投放版位含优量汇时、推广目标是微信小游戏推广目标时，落地页使用「微信小游戏」落地页时，支持使用「蹊径落地页」（白名单灰度中）
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 列表
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	创意形式类型
keyword_id_list	integer[]	关键词 id 列表
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	总页数

curl --location --request GET '/v1.3/ads/get' \ --header 'access_token;' \ --header 'timestamp;' \ --header 'nonce;' \ --header 'fields;' \ --data-urlencode 'account_id=<ACCOUNT_ID>' \ --data-urlencode 'filtering=[{"field":"ad_name","operator":"EQUALS","values":["推广广告"]}]' \ --data-urlencode 'page=1' \ --data-urlencode 'page_size=10' \ --data-urlencode 'is_deleted=false'

{ "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": [], "keyword_id_list": [] }, "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 } } }

请求参数

Header 参数

access_token

string

必需

以Query Parameter方式在请求路径中传递。授权令牌，完成 OAuth 2.0 授权后获得，参考授权认证章节。

默认值:

<ACCESS_TOKEN>

timestamp

string

必需

以Query Parameter方式在请求路径中传递。当前的时间戳，单位为秒，允许客户端请求最大时间误差为300秒。
MarketingAPI 所使用的时间戳，若无特殊说明，均为秒级时间戳
MarketingAPI 所使用的时区为GMT+8，例如当时间戳为1494840119时，表示 2018-05-15 17:21:59

默认值:

nonce

string

必需

以Query Parameter方式在请求路径中传递。随机字串标识，不超过32个字符，由调用方自行生成，需保证全局唯一性。

默认值:

<NONCE>

fields

string

必需

指定返回的字段列表，为选填字段，如不填写，则根据默认值进行返回

Body 参数application/x-www-form-urlencoded

account_id

integer

必需

广告主帐号 id，有操作权限的帐号 id，不支持代理商 id

示例值:

<ACCOUNT_ID>

filtering

string

可选

过滤条件，若此字段不传，或传空则视为无限制条件，详见 [过滤条件]
数组最小长度 1，最大长度 6

示例值:

[{"field":"ad_name","operator":"EQUALS","values":["推广广告"]}]

page

string

可选

搜索页码，默认值：1
最小值 1，最大值 99999

示例值:

page_size

string

可选

一页显示的数据条数，默认值：10。最小值 1，最大值 100

示例值:

is_deleted

string

可选

是否已删除，true：是，false：否
可选值：{ true, false }

示例值:

false

application/json

Body

code

integer

必需

message

string

必需

message_cn

string

必需

data

object

必需

list

array [object {16}]

返回信息列表

必需

page_info

object

分页配置信息

必需

请求参数#

应答字段#

请求参数

返回响应

请求参数

应答字段