获取推广计划

请求参数

标有*的参数为必填项

名称	类型	描述
account_id*	integer	广告主帐号 id，有操作权限的帐号 id，不支持代理商 id
filtering	struct[]	过滤条件，若此字段不传，或传空则视为无限制条件，详见 [过滤条件] 数组最小长度 1，最大长度 5
field*	string	过滤字段可选值：{ campaign_id, configured_status, campaign_name, campaign_type, promoted_object_type, created_time, last_modified_time, buying_type }
operator*	enum	操作符当 field 取值 campaign_id 时，枚举列表：{ EQUALS, IN } 当 field 取值 configured_status 时，枚举列表：{ EQUALS } 当 field 取值 campaign_name 时，枚举列表：{ EQUALS, CONTAINS } 当 field 取值 campaign_type 时，枚举列表：{ EQUALS } 当 field 取值 promoted_object_type 时，枚举列表：{ EQUALS } 当 field 取值 created_time 时，枚举列表：{ EQUALS, LESS_EQUALS, LESS, GREATER_EQUALS, GREATER } 当 field 取值 last_modified_time 时，枚举列表：{ EQUALS, LESS_EQUALS, LESS, GREATER_EQUALS, GREATER } 当 field 取值 buying_type 时，枚举列表：{ EQUALS }
values*	string[]	字段取值，values 数组的个数限制与 operator 的取值相关，详见 [过滤条件] 当 field 取值 configured_status 时，枚举列表：{ AD_STATUS_NORMAL, AD_STATUS_SUSPEND } 当 field 取值 campaign_name 时，字段长度最小 1 字节，长度最大 180 字节当 field 取值 campaign_type 时，枚举列表：{ CAMPAIGN_TYPE_SEARCH, CAMPAIGN_TYPE_NORMAL, CAMPAIGN_TYPE_WECHAT_OFFICIAL_ACCOUNTS, CAMPAIGN_TYPE_WECHAT_MOMENTS } 当 field 取值 promoted_object_type 时，枚举列表：{ PROMOTED_OBJECT_TYPE_APP_ANDROID, PROMOTED_OBJECT_TYPE_APP_IOS, PROMOTED_OBJECT_TYPE_ECOMMERCE, PROMOTED_OBJECT_TYPE_LINK_WECHAT, PROMOTED_OBJECT_TYPE_APP_ANDROID_MYAPP, PROMOTED_OBJECT_TYPE_APP_ANDROID_UNION, PROMOTED_OBJECT_TYPE_LOCAL_ADS_WECHAT, PROMOTED_OBJECT_TYPE_QQ_BROWSER_MINI_PROGRAM, PROMOTED_OBJECT_TYPE_LINK, PROMOTED_OBJECT_TYPE_QQ_MESSAGE, PROMOTED_OBJECT_TYPE_QZONE_VIDEO_PAGE, PROMOTED_OBJECT_TYPE_LOCAL_ADS, PROMOTED_OBJECT_TYPE_ARTICLE, PROMOTED_OBJECT_TYPE_LEAD_AD, PROMOTED_OBJECT_TYPE_TENCENT_KE, PROMOTED_OBJECT_TYPE_EXCHANGE_APP_ANDROID_MYAPP, PROMOTED_OBJECT_TYPE_QZONE_PAGE_ARTICLE, PROMOTED_OBJECT_TYPE_QZONE_PAGE_IFRAMED, PROMOTED_OBJECT_TYPE_QZONE_PAGE, PROMOTED_OBJECT_TYPE_APP_PC, PROMOTED_OBJECT_TYPE_MINI_GAME_WECHAT, PROMOTED_OBJECT_TYPE_MINI_GAME_QQ, PROMOTED_OBJECT_TYPE_COUPON_WECHAT, PROMOTED_OBJECT_TYPE_APP_PROMOTION, PROMOTED_OBJECT_TYPE_WECHAT_CHANNELS, PROMOTED_OBJECT_TYPE_WECHAT_OFFICIAL_ACCOUNT, PROMOTED_OBJECT_TYPE_MINI_PROGRAM_WECHAT, PROMOTED_OBJECT_TYPE_APP_QUICK_APP } 当 field 取值 created_time 时，字段长度为 10 字节当 field 取值 last_modified_time 时，字段长度为 10 字节当 field 取值 buying_type 时，枚举列表：{ BUYINGTYPE_AUCTION, BUYINGTYPE_CONTRACT, BUYINGTYPE_RESERVED, BUYINGTYPE_FIXED_PRICE }
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.
当且仅当根据推广计划 id 进行查询时，获取的推广计划列表包含已删除的推广计划。
2.
created_time 和 last_modified_time 的 values 值为时间戳，单位为秒，时区为 GMT+8。

curl --location --request GET '/v1.3/campaigns/get' \ --header 'access_token;' \ --header 'timestamp;' \ --header 'nonce;' \ --header 'fields;' \ --data-urlencode 'account_id=<ACCOUNT_ID>' \ --data-urlencode 'filtering=[{"field":"configured_status","operator":"EQUALS","values":["AD_STATUS_SUSPEND"]}]' \ --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>", "campaign_name": "五一节大促推广计划", "configured_status": "AD_STATUS_SUSPEND", "campaign_type": "CAMPAIGN_TYPE_NORMAL", "promoted_object_type": "PROMOTED_OBJECT_TYPE_APP_IOS", "daily_budget": 50000, "budget_reach_date": 20170501, "created_time": 1491019858, "last_modified_time": 1491098468, "speed_mode": "SPEED_MODE_STANDARD", "is_deleted": false } ], "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，最大长度 5

示例值:

[{"field":"configured_status","operator":"EQUALS","values":["AD_STATUS_SUSPEND"]}]

page

integer

可选

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

示例值:

page_size

integer

可选

一页显示的数据条数，默认值：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 {11}]

返回信息列表

必需

page_info

object

分页配置信息

必需

请求参数#

请求参数

返回响应

请求参数