入门与指南专题介绍帐号管理营销资产广告管理数据洞察人群管理数据接入接口清单
授权认证 帐号管理 营销资产 广告管理 数据洞察 辅助工具 用户行为数据 用户人群数据 用户标签数据 用户属性数据
附录

广告 (Ad)

V1.1

loading


本节将为您介绍广告 (Ad) 相关接口。广告(ad)包含了呈现给受众的广告创意信息(可能是文字、图片、视频等一种或多种元素的组合),也继承了广告组上的投放站点、时间、出价、定向等信息。通过这两者的属性信息确保了该创意能够在预期的价格和时间呈现给指定的受众。关于广告更详细的介绍可以参考【广告】章节。


创建广告

ads/add

POST

*为必填项
名称 类型 描述
account_id*
integer 广告主帐号 id,有操作权限的帐号 id,不支持代理商 id
adgroup_id*
integer 广告组 id
adcreative_id*
integer 广告创意 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 }
  • 曝光监控地址(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
integer 广告 id
{
    "code": 0,
    "message": "",
    "message_ch": "",
    "data": {
        "ad_id": "<AD_ID>"
    }
}


更新广告

ads/update

POST

*为必填项
名称 类型 描述
account_id*
integer 广告主帐号 id,有操作权限的帐号 id,不支持代理商 id
ad_id*
integer 广告 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 }
  • 曝光监控地址(impression_tracking_url)、点击监控地址(click_tracking_url)、是否支持赞转评枚举(feeds_interaction_enabled)仅在部分创意规格下设置有效,具体可通过 [创意规格查询工具] 进行查询。

curl 'https://api.e.qq.com/v1.1/ads/update?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'ad_id=<AD_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
integer 广告 id
{
    "code": 0,
    "message": "",
    "message_ch": "",
    "data": {
        "ad_id": "<AD_ID>"
    }
}


获取广告

ads/get

GET

*为必填项
名称 类型 描述
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 字节,长度最大 120 字节


当 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 }
  • is_deleted 参数不传时默认为 false,只返回未删除记录。
  • is_deleted 参数为 true 时,需要同时在 filtering 传参数 last_modified_time。
  • 当根据广告 id 进行查询且 is_deleted 参数不传或为 false 时,获取的广告列表包含已删除的广告。

curl -G 'https://api.e.qq.com/v1.1/ads/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'filtering=[{"field":"ad_name","operator":"EQUALS","values":["推广广告"]}]' \
-d 'page=1' \
-d 'page_size=10' \
-d 'is_deleted=false' 
					
名称 类型 描述
list
struct[] 返回信息列表
campaign_id
integer 推广计划 id
adgroup_id
integer 广告组 id
ad_id
integer 广告 id
ad_name
string 广告名称(字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
adcreative
struct 广告创意
adcreative_id
integer 广告创意 id
adcreative_name
string 广告创意名称,同一帐号下的广告创意名称不允许重复(字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。)
campaign_id
integer 推广计划 id
adcreative_template_id
integer 创意规格 id,具体请咨询您的运营接口人,也可通过 [创意规格查询工具] 进行查询
adcreative_elements
struct 创意元素,不同 adcreative_template_id 要求的元素不尽相同,具体情况可通过 [创意规格查询工具] 进行查询
page_type
enum 落地页类型,[枚举详情]
page_spec
struct 落地页信息,根据不同 promoted_object_type 和 page_type,要求的 page_spec 信息不同
page_id
integer 落地页 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_game_spec
struct 小游戏落地页信息
mini_game_tracking_parameter
string 小游戏监控参数
site_set
enum[] 投放站点集合,当前单站点或者 SITE_SET_TENCENT_NEWS+SITE_SET_TENCENT_VIDEO 的组合,[枚举详情]
promoted_object_type
enum 推广目标类型,[枚举详情]
promoted_object_id
string 推广目标 id,详见 [查询推广目标 id]
created_time
integer 创建时间(时间戳)
last_modified_time
integer 最后修改时间(时间戳)
configured_status
enum 客户设置的状态,[枚举详情]
system_status
enum 系统状态,[枚举详情]
audit_spec
struct[] 多站点的审核结果信息,仅当 automatic_site_enabled=true 或 site_set 传入多个值时,此字段会返回
site_set
enum 站点信息,[枚举详情]
system_status
enum 系统状态,[枚举详情]
reject_message
string 审核消息
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 总页数
{
    "code": 0,
    "message": "",
    "message_ch": "",
    "data": {
        "list": [
            {
                "campaign_id": "<CAMPAIGN_ID>",
                "adgroup_id": "<ADGROUP_ID>",
                "ad_id": "<AD_ID>",
                "ad_name": "推广广告",
                "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
                },
                "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"
                    }
                ],
                "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
        }
    }
}


删除广告

ads/delete

POST

*为必填项
名称 类型 描述
account_id*
integer 广告主帐号 id,有操作权限的帐号 id,不支持代理商 id
ad_id*
integer 广告 id

curl 'https://api.e.qq.com/v1.1/ads/delete?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'ad_id=<AD_ID>' 
					
名称 类型 描述
ad_id
integer 广告 id
{
    "code": 0,
    "message": "",
    "message_ch": "",
    "data": {
        "ad_id": "<AD_ID>"
    }
}