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

拆分对比实验 (Split Tests)

V1.1

loading


本节将为您介绍拆分对比实验 (Split Tests) 相关接口。该接口支持广告主创建A/B test实验广告,更快获取有效的策略测试结论,并据此优化广告投放策略。

所属权限(scope):Ads Management

所属权限(scope):Ads Management

所属权限(scope):Ads Management

所属权限(scope):Ads Management


创建拆分对比实验
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 split_tests/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
split_test_name*
string 拆分对比实验名称,同一个帐号下的拆分对比实验不许重名,小于等于 120 个英文字符
字段长度最小 1 字节,长度最大 120 字节
begin_time
integer 开始投放时间点(时间戳),大于等于 0,且小于 end_time
最小值 0,最大值 9999999999
end_time
integer 结束投放时间点(时间戳),大于等于今天,且大于 begin_time
最小值 0,最大值 9999999999
adgroup_id_list*
integer[] 拆分对比实验绑定的广告组
数组最小长度 2,最大长度 5
smart_expand_enabled
boolean 是否开启智能放量,未填写时默认为 false,是否开启智能放量
可选值:{ true, false }

使用说明

  1. 仅当拆分对比实验所绑定的广告组的状态为待审核,且之前未被绑定在其他对比拆分实验组上时,此实验才能创建成功。
  2. 由于智能放量功能正在灰度,请联系您的运营接口人确认是否可申请使用此功能。

请求示例


curl 'https://api.e.qq.com/v1.1/split_tests/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'split_test_name=test split test name' \
-d 'begin_time=1558493097' \
-d 'end_time=1558495097' \
-d 'adgroup_id_list=[123,456]' \
-d 'smart_expand_enabled=true' 
					

应答字段

名称 类型 描述
split_test_id
integer 拆分对比实验 id

应答示例

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

可视化调试工具


更新拆分对比实验
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 split_tests/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
split_test_id*
integer 拆分对比实验 id
split_test_status
enum 拆分对比实验状态,[枚举详情]
枚举列表:{ SPLIT_TEST_STATUS_NORMAL, SPLIT_TEST_STATUS_SUSPEND, SPLIT_TEST_STATUS_PUBLISH }
split_test_name
string 拆分对比实验名称,同一个帐号下的拆分对比实验不许重名,小于等于 120 个英文字符
字段长度最小 1 字节,长度最大 120 字节
adgroup_id_list
integer[] 拆分对比实验绑定的广告组
数组最小长度 2,最大长度 5

使用说明

  1. 当对比拆分实验状态更新为暂停状态或重新开启为正常状态时,该实验下绑定的所有广告组均会同步做相应的暂停或开启的状态更新。
  2. 如果需要结束实验,则需进行实验全量操作,以完成广告与实验机制的解绑。全量后,流量不再进行拆分,所有广告变为 100%流量,可根据各广告的全量推荐度及具体数据决定是否需要对广告的状态做暂停或开启操作。仅当实验状态为正常或暂停时,且该实验组绑定的广告组至少关联一个已通过审核的广告时,可修改实验状态为全量。
  3. 当实验状态为正常时,已绑定的广告组不允许再做更新。

请求示例


curl 'https://api.e.qq.com/v1.1/split_tests/update?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'split_test_status=SPLIT_TEST_STATUS_NORMAL' \
-d 'split_test_name=test split test name' \
-d 'adgroup_id_list=[123,456]' 
					

应答字段

名称 类型 描述
split_test_id
integer 拆分对比实验 id

应答示例

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

可视化调试工具


删除拆分对比实验
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 split_tests/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
split_test_id*
integer 拆分对比实验 id

使用说明

  1. 当实验状态为正常/暂停时,删除实验时会同步删除实验下绑定的所有广告。实验状态为全量时,删除实验则仅删掉实验记录,不会删除具体广告。

请求示例


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

应答字段

名称 类型 描述
split_test_id
integer 拆分对比实验 id

应答示例

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

可视化调试工具


获取拆分对比实验
全部接口
V1.1
loading

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

使用说明

  1. 如优胜广告判定未出,则优胜广告列表字段会返回空值。
  2. 已删除的实验不支持通过接口读取。

请求示例


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

应答字段

名称 类型 描述
list
struct[] 返回数组列表
account_id
integer 广告主 id,有操作权限的广告主 id
split_test_id
integer 拆分对比实验 id
split_test_status
enum 拆分对比实验状态,[枚举详情]
split_test_name
string 拆分对比实验名称,同一个帐号下的拆分对比实验不许重名,小于等于 120 个英文字符
begin_time
integer 开始投放时间点(时间戳),大于等于 0,且小于 end_time
end_time
integer 结束投放时间点(时间戳),大于等于今天,且大于 begin_time
smart_expand_enabled
boolean 是否开启智能放量,未填写时默认为 false,是否开启智能放量
adgroup_id_list
integer[] 拆分对比实验绑定的广告组
recommended_rating
enum 实验全量的推荐程度,从一星到五星代表推荐程度由低至高,实验全量的推荐程度,[枚举详情]
recommended_adgroup_id_list
integer[] 优胜广告列表
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": [
            {
                "split_test_id": 1000,
                "split_test_status": "SPLIT_TEST_STATUS_NORMAL",
                "split_test_name": "test split test name",
                "adgroup_id_list": [
                    123,
                    456
                ],
                "smart_expand_enabled": true,
                "begin_time": 1558493097,
                "end_time": 1558495097,
                "recommended_rating": "RECOMMENDED_RATING_FIVE",
                "recommended_adgroup_id_list": [
                    123
                ]
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_number": 1,
            "total_page": 1
        }
    }
}

可视化调试工具