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

联盟流量包（Union Position Packages）

V1.1

loading

本节将为您介绍联盟流量包（Union Position Packages）相关接口。通过此接口可以将筛选的联盟媒体流量打包成流量包，在广告投放中使用，帮助广告在联盟投放的效果提升。该功能灰度开放，如有接入需求，请联系对接渠道运营同事线下进行申请。

所属权限（scope）：Ads Management

所属权限（scope）：Ads Management

所属权限（scope）：Ads Management

联盟流量包模块
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 union_position_packages/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
union_package_name*
 string 流量包名称，同一帐号下的流量包名称不允许重复，最多可创建 300 个流量包（字段长度最小 1 个等宽字符，长度最大 60 等宽字符（即字段最大长度为 60 个中文字或全角标点，120 个英文字或半角标点。一个等宽字符等价于一个中文，等价于两个英文。）
字段长度最小 1 字节，长度最大 180 字节
promoted_object_type
 enum 推广目标类型，[枚举详情]
枚举列表：{ 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_LEAD_AD }
promoted_object_id
 string 推广目标 id
字段长度最小 1 字节，长度最大 128 字节
union_package_type*
 enum 流量包类型 枚举列表：UNION_PACKAGE_TYPE_INCLUDE（定投）、UNION_PACKAGE_TYPE_EXCLUDE（屏蔽），流量包类型，[枚举详情]
枚举列表：{ UNION_PACKAGE_TYPE_INCLUDE, UNION_PACKAGE_TYPE_EXCLUDE }
union_position_id_list*
 integer[] 优量汇广告位 id 列表
数组最小长度 1，最大长度 2000

请求示例


curl 'https://api.e.qq.com/v1.1/union_position_packages/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=1044283059' \
-d 'union_position_id_list=[13978]'

应答字段

名称 类型 描述
union_package_id
 integer 流量包 id

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "union_package_id": 16417
    }
}

可视化调试工具

联盟流量包获取接口
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 union_position_packages/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
filtering
 struct[] 过滤条件，若此字段不传，或传空则视为无限制条件
数组长度为 1
field*
 string 过滤字段
可选值：{ union_package_type }
operator*
 enum 操作符
当 field 取值 union_package_type 时，枚举列表：{ EQUALS }
values*
 string[] 字段取值，values 数组的个数限制与 operator 的取值相关
当 field 取值 union_package_type 时，
枚举列表：{ UNION_PACKAGE_TYPE_INCLUDE, UNION_PACKAGE_TYPE_EXCLUDE }
page
 integer 搜索页码，获取指定页数据，大于等于 1，小于等于实际总页数，若不传则视为 1
最小值 1，最大值 99999
page_size
 integer 一页获取的数据条数，1-100，默认为 10
最小值 1，最大值 100

请求示例


curl -G 'https://api.e.qq.com/v1.1/union_position_packages/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'filtering=[]' \
-d 'page=1' \
-d 'page_size=10'

应答字段

名称 类型 描述
list
 struct[] 返回数组列表
union_package_id
 integer 流量包 id
union_package_name
 string 流量包名称，同一帐号下的流量包名称不允许重复，最多可创建 300 个流量包（字段长度最小 1 个等宽字符，长度最大 60 等宽字符（即字段最大长度为 60 个中文字或全角标点，120 个英文字或半角标点。一个等宽字符等价于一个中文，等价于两个英文。）
union_package_type
 enum 流量包类型 枚举列表：UNION_PACKAGE_TYPE_INCLUDE（定投）、UNION_PACKAGE_TYPE_EXCLUDE（屏蔽），流量包类型，[枚举详情]
union_position_id_list
 integer[] 优量汇广告位 id 列表
created_time
 integer 创建时间，unix 时间戳，精确到秒
last_modified_time
 integer 最后修改时间，unix 时间戳，精确到秒
page_info
 struct 分页配置信息
page
 integer 搜索页码，获取指定页数据，大于等于 1，小于等于实际总页数，若不传则视为 1
page_size
 integer 一页获取的数据条数，1-100
total_number
 integer 总条数
total_page
 integer 总页数

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "union_package_id": 16417,
                "union_position_id_list": [
                    13978
                ],
                "created_time": 1491019858,
                "last_modified_time": 1491098468
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_number": 1,
            "total_page": 1
        }
    }
}

可视化调试工具

联盟流量包删除接口
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 union_position_packages/delete
请求方法 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
union_package_id*
 integer 流量包 id

请求示例


curl 'https://api.e.qq.com/v1.1/union_position_packages/delete?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'union_package_id=16417'

应答字段

无

应答示例

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

可视化调试工具

广告资源

广告技术

开发文档

辅助工具

帮助支持

手机浏览开发者官网

Copyright © 1998 - Tencent Inc. All Rights Reserved.