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

获取推广计划
全部接口
V1.1
loading

所属权限 Ads Management,Ads Insights
请求地址 campaigns/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,最大长度 5
field*
string 过滤字段
可选值:{ campaign_id, configured_status, campaign_name, campaign_type, promoted_object_type, created_time, last_modified_time }

微信公众账号逻辑

不能支持:created_time,configure_status,campaign_name
能支持:campaign_id,campaign_type,promoted_object_type,last_modified_time
使用 last_modified_time 作为过滤条件时,operator 仅支持 GREATER_EQUALS
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 }
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 }

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

当 field 取值 last_modified_time 时,
字段长度为 10 字节

微信公众账号逻辑

当 field 取值 configured_status 时,
枚举列表:{AD_STATUS_NORMAL,AD_STATUS_SUSPEND}

当 field 取值 campaign_type 时,
枚举列表:{CAMPAIGN_TYPE_NORMAL,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_LOCAL_ADS_WECHAT,PROMOTED_OBJECT_TYPE_LEAD_AD}
page
integer 搜索页码,默认值:1
最小值 1,最大值 99999
page_size
integer 一页显示的数据条数,默认值:10。最小值 1,最大值 100
is_deleted
boolean 是否已删除,true:是,false:否
可选值:{ true, false }

使用说明

  1. 当且仅当根据推广计划 id 进行查询时,获取的推广计划列表包含已删除的推广计划。

请求示例


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

应答字段

名称 类型 描述
list
struct[] 返回信息列表
campaign_id
integer 推广计划 id
campaign_name
string
configured_status
enum 客户设置的状态,[枚举详情]

微信公众账号逻辑

1.该字段默认值为 AD_STATUS_NORMAL
2.当且仅当该 campaign 下拥有一个审核通过的广告且在线(已达设置的上线时段),才允许暂停
campaign_type
enum 推广计划类型,[枚举详情]
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:销售线索
daily_budget
integer 日预算,单位为分
budget_reach_date
integer 日预算到达日期,值为最近一次触达日预算的日期,如无触达记录则为空,如:20170501,表示最近一次到达日预算的日期是 5 月 1 日,若今天是 5 月 1 日,则表示今天已经到达日预算
created_time
integer 创建时间(时间戳)
last_modified_time
integer 最后修改时间(时间戳)
speed_mode
enum 投放速度模式

微信公众账号逻辑

仅支持 SPEED_MODE_STANDARD,不支持加速
is_deleted
boolean 是否已删除,true:是,false:否
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>",
                "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
        }
    }
}

可视化调试工具

相关阅读