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

广告预览 (Adcreative Preview)

V1.1

loading

本节将为您介绍广告预览 (Adcreative Preview)相关接口。关于广告预览更详细的介绍可以参考【广告预览】章节。特别说明:当且仅当广告各层级(campaign、adgroup、ad、adcreative)均已创建成功后,才支持调用广告预览接口。


创建预览
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 adcreative_previews/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 中的字段。如不填写,则根据默认值进行返回

请求参数

参数仅适用于腾讯广告平台及微信公众平台。其中,标有的内容表示,该参数在微信公众平台使用时,描述不同。标有*的参数为必填项

名称 类型 描述
account_id*
integer 推广帐号 id,有操作权限的帐号 id,包括代理商和广告主帐号 id
adgroup_id
integer 广告组 id
campaign_id
integer 推广计划 id,仅支持预览为朋友圈广告
user_id_type*
enum 受众 id 类型,[枚举详情]
枚举列表:{ USER_ID_TYPE_WECHAT_ID, USER_ID_TYPE_QQ_ID }
user_id_list*
string[] 受众 id 列表
数组最小长度 1,最大长度 10
字段长度最小 1 字节,长度最大 120 字节

使用说明

  1. 当且仅当推广计划类型为朋友圈时,可写入 campain_id。
  2. 所有类型都允许使用 adgroup_id,,推荐使用 adgroup_id 创建预览。
  3. 微信流量广告仅可创建 USER_ID_TYPE_WECHAT_ID 的广告预览。
  4. 非微信流量广告预览时长固定为 24 小时。

请求示例


curl 'https://api.e.qq.com/v1.1/adcreative_previews/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'adgroup_id=<ADGROUP_ID>' \
-d 'campaign_id=<CAMPAIGN_ID>' \
-d 'user_id_type=USER_ID_TYPE_WECHAT_ID' \
-d 'user_id_list=[1324657]' 
					

应答字段

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": ""
}

可视化调试工具


获取预览受众
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 adcreative_previews/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
field*
string 过滤字段
可选值:{ campaign_id, adgroup_id }
operator*
enum 操作符
当 field 取值 campaign_id 时,枚举列表:{ EQUALS }
当 field 取值 adgroup_id 时,枚举列表:{ EQUALS }
values*
string[] 字段取值,values 数组的个数限制与 operator 的取值相关,详见 [过滤条件]

使用说明

  1. 传 campaign_id 时,仅支持推广计划类型为朋友圈广告的 campaign_id。

请求示例


curl -G 'https://api.e.qq.com/v1.1/adcreative_previews/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'filtering=[{"field":"campaign_id ","operator":"EQUALS","values":["<CAMPAIGN_ID>"]}]' 
					

应答字段

名称 类型 描述
list
struct[] 返回信息列表
user_id
string 受众 id
user_id_type
enum 受众 id 类型,[枚举详情]

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "user_id": "<USER_ID>",
                "duration": 5
            }
        ]
    }
}

可视化调试工具