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

创建广告
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 ads/add
请求方法 post

全局参数

全局参数是指每一个接口都需要使用到的参数。详情参考,代码案例参考

参数名称 参数类型
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 中的字段。如不填写,则根据默认值进行返回

特定请求头参数

该接口支持一些特定请求头的参数,该参数支持放入请求的请求头中,注意不是请求体中。

请求头名称 描述
X-Request-Id 资源请求的唯一 id,该请求头参数用于保证接口重试的幂等性,即当请求参数是 A 时,X-Request-Id 为 B 时,即使重复请求,API 侧永远不会新建一个全新的广告资源,避免重试的时候重复创建。如果在创建时重复传入相同的请求参数和 X-Request-Id,那么会返回该 X-Request-Id 对应的唯一的广告资源。支持的接口列表参考投放接口错误处理指引章节

请求参数

标有*的参数为必填项

名称 类型 描述
account_id*
integer 广告主帐号 id,有操作权限的帐号 id,不支持代理商 id
adgroup_id*
int64 广告组 id,为了不同投放端体验的一致性,在创建广告时如广告创意 dynamic_adcreative_spec 字段不为空且对应广告组缺失 dynamic_ad_spec 或 product_source 内容,系统会自动将广告创意中 dynamic_ad_spec 或 product_source 内容写入对应广告组。
adcreative_id*
int64 广告创意 id
ad_name*
string 广告名称,字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
字段长度最小 1 字节,长度最大 180 字节
configured_status
enum 客户设置的状态,[枚举详情]
枚举列表:{ AD_STATUS_NORMAL, AD_STATUS_SUSPEND }
impression_tracking_url
string 曝光监控地址,监控地址主域只允许白名单内的域名,详见 [第三方监控]
字段长度最小 0 字节,长度最大 1023 字节
click_tracking_url
string 点击监控地址,监控地址主域只允许白名单内的域名,详见 [第三方监控]
字段长度最小 0 字节,长度最大 1024 字节
feeds_interaction_enabled
boolean 是否支持赞转评
可选值:{ true, false }

使用说明

  1. 曝光监控地址(impression_tracking_url)、点击监控地址(click_tracking_url)、是否支持赞转评枚举(feeds_interaction_enabled)仅在部分创意规格下设置有效,具体可通过 [创意规格查询工具] 进行查询。

请求示例


curl 'https://api.e.qq.com/v1.1/ads/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'adgroup_id=<ADGROUP_ID>' \
-d 'adcreative_id=<ADCREATIVE_ID>' \
-d 'ad_name=推广广告' \
-d 'configured_status=AD_STATUS_NORMAL' \
-d 'impression_tracking_url=http://miaozhen.com/track?from=tencent&aid=30304' \
-d 'click_tracking_url=http://miaozhen.com/track2?from=tencent&aid=30304' \
-d 'feeds_interaction_enabled=INTERACTION_DISABLED' 
					

应答字段

名称 类型 描述
ad_id
int64 广告 id

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "ad_id": "<AD_ID>"
    }
}

可视化调试工具

相关阅读