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

推广目标 (Promoted object)

V1.1

loading


本节将为您介绍推广目标 (Promoted object) 相关接口。推广目标决定了广告推广的内容属性,目前 Marketing API 支持普通链接、腾讯开放平台安卓应用、苹果IOS应用、微信品牌页、微信本地门店等多种推广目标类型。其中腾讯开放平台安卓应用、苹果IOS应用在投放广告前,需要调用推广目标接口登记应用相关信息。关于推广目标更详细的介绍可以参考【推广目标】章节。


创建推广目标
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 promoted_objects/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
promoted_object_type*
enum 推广目标类型,[枚举详情]
枚举列表:{ PROMOTED_OBJECT_TYPE_APP_ANDROID, PROMOTED_OBJECT_TYPE_APP_IOS, PROMOTED_OBJECT_TYPE_APP_ANDROID_MYAPP, PROMOTED_OBJECT_TYPE_APP_ANDROID_UNION, PROMOTED_OBJECT_TYPE_QQ_BROWSER_MINI_PROGRAM, PROMOTED_OBJECT_TYPE_MINI_GAME_QQ }

微信公众账号逻辑

仅支持{PROMOTED_OBJECT_TYPE_APP_ANDROID,PROMOTED_OBJECT_TYPE_APP_IOS}
promoted_object_id*
string 推广目标 id,详见 [推广目标类型]
字段长度最小 1 字节,长度最大 128 字节

请求示例


curl 'https://api.e.qq.com/v1.1/promoted_objects/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'promoted_object_type=PROMOTED_OBJECT_TYPE_APP_IOS' \
-d 'promoted_object_id=C3C2X' 
					

应答字段

名称 类型 描述
promoted_object_id
string 推广目标 id,详见 [推广目标类型]

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "promoted_object_id": "C3C2X"
    }
}

可视化调试工具


更新推广目标
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 promoted_objects/update
请求方法 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
promoted_object_type*
enum 推广目标类型,[枚举详情]
枚举列表:{ PROMOTED_OBJECT_TYPE_APP_ANDROID, PROMOTED_OBJECT_TYPE_APP_IOS, PROMOTED_OBJECT_TYPE_APP_ANDROID_MYAPP, PROMOTED_OBJECT_TYPE_APP_ANDROID_UNION, PROMOTED_OBJECT_TYPE_QQ_BROWSER_MINI_PROGRAM, PROMOTED_OBJECT_TYPE_MINI_GAME_QQ }

微信公众账号逻辑

仅支持{PROMOTED_OBJECT_TYPE_APP_ANDROID,PROMOTED_OBJECT_TYPE_APP_IOS}
promoted_object_id*
string 推广目标 id,详见 [推广目标类型]
字段长度最小 1 字节,长度最大 128 字节

请求示例


curl 'https://api.e.qq.com/v1.1/promoted_objects/update?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'promoted_object_type=PROMOTED_OBJECT_TYPE_APP_IOS' \
-d 'promoted_object_id=C3C2X' 
					

应答字段

名称 类型 描述
promoted_object_id
string 推广目标 id,详见 [推广目标类型]

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "promoted_object_id": "C3C2X"
    }
}

可视化调试工具


获取推广目标
全部接口
V1.1
loading

所属权限 Ads Management,Ads Insights
请求地址 promoted_objects/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,最大长度 2
field*
string 过滤字段
可选值:{ promoted_object_type, promoted_object_id, created_time, last_modified_time }
operator*
enum 操作符
当 field 取值 promoted_object_type 时,枚举列表:{ EQUALS }
当 field 取值 promoted_object_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 取值 promoted_object_type 时,
枚举列表:{ PROMOTED_OBJECT_TYPE_APP_ANDROID, PROMOTED_OBJECT_TYPE_APP_IOS, PROMOTED_OBJECT_TYPE_APP_ANDROID_MYAPP, PROMOTED_OBJECT_TYPE_APP_ANDROID_UNION, PROMOTED_OBJECT_TYPE_QQ_BROWSER_MINI_PROGRAM, PROMOTED_OBJECT_TYPE_LOCAL_ADS, PROMOTED_OBJECT_TYPE_EXCHANGE_APP_ANDROID_MYAPP, PROMOTED_OBJECT_TYPE_MINI_GAME_QQ }

当 field 取值 promoted_object_id 且 operator 取值 IN 时,
字段长度最小 0 字节,长度最大 128 字节

当 field 取值 promoted_object_id 时,
字段长度最小 0 字节,长度最大 128 字节

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

当 field 取值 last_modified_time 时,
字段长度为 10 字节
page
integer 搜索页码,默认值:1
最小值 1,最大值 99999
page_size
integer 一页显示的数据条数,默认值:10
最小值 1,最大值 100

使用说明

  1. 每次调用该接口,系统将自动至应用宝或 app store 拉取最新的下载链接。

请求示例


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

应答字段

名称 类型 描述
list
struct[] 返回信息列表
promoted_object_name
string 推广目标名称
promoted_object_id
string 推广目标 id,详见 [推广目标类型]
promoted_object_type
enum 推广目标类型,[枚举详情]
promoted_object_spec
struct 推广目标详细信息
app_ios_spec
struct IOS 应用信息,从苹果 App Store 拉取的 IOS 应用信息
packname
string 应用的包名
version
string 应用的版本
icon
string 应用图标地址
icon_512
string 应用图标地址,分辨率固定 512x512
average_rating
string 应用评分
package_size
string 应用包大小,单位字节
genres
string[] 应用分类,来自外系统的分类,目前仅用于广告展示
package_download_url
string 应用安装包下载地址
app_android_spec
struct android 应用信息,从腾讯开放平台拉取的 android 应用信息
packname
string 应用的包名
version
string 应用的版本
icon
string 应用图标地址
average_rating
string 应用评分
package_size
string 应用包大小,单位字节
genres
string[] 应用分类,来自外系统的分类,目前仅用于广告展示
package_download_url
string 应用安装包下载地址
channel_package_spec
struct[] 渠道包详细信息列表
app_android_channel_package_id
string 安卓应用渠道包 id,当前特指投放腾讯开放平台安卓应用的渠道包 id,从推广目标模块的读取接口可以获取

微信公众账号逻辑

1.同一个 campaign 下推广的渠道包信息必须是同一个
2.渠道包信息不支持修改
package_name
string 包名称
app_android_union_spec
struct 广告包 app 应用信息
packname
string 应用的包名
version
string 应用的版本
icon
string 应用图标地址
package_size
string 应用包大小,单位字节
package_md5
string 应用安装包 md5
package_download_url
string 应用安装包下载地址
channel_package_spec
struct[] 渠道包详细信息列表
app_android_channel_package_id
string 安卓应用渠道包 id,当前特指投放腾讯开放平台安卓应用的渠道包 id,从推广目标模块的读取接口可以获取

微信公众账号逻辑

1.同一个 campaign 下推广的渠道包信息必须是同一个
2.渠道包信息不支持修改
package_name
string 包名称
app_android_myapp_spec
struct 应用宝 app 信息
packname
string
version
string
icon
string
package_size
string
channel_package_spec
struct[] 渠道包详细信息列表
app_android_channel_package_id
string 安卓应用渠道包 id,当前特指投放腾讯开放平台安卓应用的渠道包 id,从推广目标模块的读取接口可以获取

微信公众账号逻辑

1.同一个 campaign 下推广的渠道包信息必须是同一个
2.渠道包信息不支持修改
package_name
string 包名称
qq_browser_mini_program
struct QQ 浏览器小程序信息
packname
string
icon
string
local_ads_spec
struct 本地门店信息
shop_name
string 门店名称
address
string 门店地址
telphone
string 门店电话
system_industry_id
string 门店行业 id
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_cn": "",
    "data": {
        "list": [
            {
                "promoted_object_id": "C3C2X",
                "promoted_object_type": "PROMOTED_OBJECT_TYPE_APP_IOS",
                "promoted_object_spec": {
                    "app_ios_spec": {
                        "packname": "com.test.pack",
                        "version": "7.7.8",
                        "icon": "http://www.example.com/image/1",
                        "icon_512": "http://www.example.com/image/2",
                        "average_rating": "3.5",
                        "package_size": "323156992",
                        "genres": [
                            "社交",
                            "娱乐"
                        ],
                        "package_download_url": "https://itunes.apple.com/cn/app/qq/id444934666"
                    }
                },
                "created_time": 1491019858,
                "last_modified_time": 1491098468
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_number": 1,
            "total_page": 1
        }
    }
}

可视化调试工具

V1.1

loading