菜单

聚合管理的AB测试及流量分组管理

注意:接入Api前请先熟悉api签名机制(参考接口鉴权说明), 即Api请求样例中的一些http请求头的来源

1. 获取指定广告位下的所有聚合分组

1.1 请求URL

https://api.toponad.net/v3/mediation_group/:placement_id

1.2 请求方式

GET

1.3 请求参数

1.4 返回参数

字段 类型 是否必传 备注
data Object Y 返回结果数据
data.mediation_group_id Int Y 聚合分组ID
data.mediation_group_name String Y A/B测试分组名字
data.abtest_group_item_id Int Y A/B测试分组ID
data.traffic_variation Int Y A/B测试分组权重
data.is_pending Bool Y 是否待生效分组 false 测试中 true 待生效分组
data.timezone Int Y 开始时间的时区 -12~12 = 西12区 ~ 东12区 待生效才会有值
data.start_time Int Y 开始时间,时间戳 待生效才会有值

1.5 样例

请求样例:

curl --location --request GET 'https://api.toponad.net/v3/mediation_group/b60f6e9480e4ba' \
--header 'X-Up-Key: ee609bfc9112c50ca4936fdecc43713e7eaxxxx' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1626056011000' \
--header 'Content-Type: application/json' \
--data-raw ''

返回样例:

{
    "data": [
        {
            "mediation_group_id": 116112,
            "mediation_group_name": "A\u7ec4",
            "abtest_group_item_id": 10000080,
            "traffic_variation": 2,
            "is_pending": false,
            "time_zone": 0,
            "start_time": 0
        },
        {
            "mediation_group_id": 116113,
            "mediation_group_name": "B\u7ec4",
            "abtest_group_item_id": 10000081,
            "traffic_variation": 1,
            "is_pending": false,
            "time_zone": 0,
            "start_time": 0
        },
        {
            "mediation_group_id": 116114,
            "mediation_group_name": "C\u7ec4",
            "abtest_group_item_id": 10000082,
            "traffic_variation": 1,
            "is_pending": false,
            "time_zone": 0,
            "start_time": 0
        }
    ]
}

2. 获取指定聚合分组下的所有流量分组

注意:流量分组做了实验,同一个segment_id可能会有多条(对应不同的实验组abtest_group_item_id),文档暂时不体现,待升级

2.1 请求URL

https://api.toponad.net/v3/mediation_segment/:mediation_group_id

2.2 请求方式

GET

2.3 请求参数

2.4 返回参数

字段 类型 是否必传 备注
data Array[Object] Y 返回结果数据
data.segment_id Int Y 流量分组ID
data.segment_name String Y 流量分组名字
data.priority Int Y 流量分组权重
data.parallel_request_number Int Y 并发请求数
data.auto_load Int Y 默认0表示关,只能传0或正整数 对于Banner,可以设置自动刷新时间,大于0表示自动刷新时间 对于RV和插屏,仅控制自动请求的开关状态,非0表示开
data.hour_cap Int Y 展示上限(小时),-1 表示无限制
data.day_cap Int Y 展示上限(天),-1 表示无限制
data.pacing Int Y 展示间隔(秒),-1 表示无限制
data.rules Array[Object] Y 流量分组的规则列表
data.rules.type Int Y 规则类型,默认规则为地区,枚举值说明: 0: 地区(集合) 2: 天(星期)(集合) 3: 网络(集合),注意:集合里内容必须是小写且前后不能包含空格,可选值如下:2g,3g,4g,5g,wifi 4: 小时/1225/2203(区间) 5: 自定义规则(custom) 8: 应用版本号 (集合) 9: SDK版本号 (集合) 10: 设备类型(集合),注意:集合里内容必须是小写且前后不能包含空格,可选值如下:iphone,ipad 11: 设备品牌(集合),集合里可选值如下(小写): Apple,Acer,Advan,Amazon,Asus,Blackshark,Coolpad, GIONEE,Google,Hisense,Honor,HTC,Huawei,Infinix, Lanix,LeEco,Lenovo,LGE,Meitu,Meizu,MetroPCS, Motorola,Nokia,Nubia,OnePlus,OPPO,Qcom,Realme, Redmi,Samsung,Sharp,Smartfren,Smartisan,Sony,TCL, Tecno,Verizon,Vivo,Xiaomi,ZTE,360 12: 系统版本 (集合) 17: 设备ID (集合) 20: 安装时间小时(值) 21: 安装时间天 (值) 22: 安装时间周 (值) 23: 渠道 (集合),支持包括/不包括 24: 子渠道 (集合),支持包括/不包括 25: IDFA状态 (值),支持等于,可选值如下,1(有IDFA);2(无IDFA) 26: 安装时间自然天 (值) 53:新版自定义规则(custom_v2)
data.rules.rule Int Y 具体规则,默认为包含,枚举值说明: 0: 包含(集合) 1: 不包含(集合) 2: 大于等于(值) 3: 小于等于(值) 4: 区间内(区间) 5: 区间外(区间) 6: 自定义规则(custom) 7: 大于(值) 8: 小于(值)
data.rules.content Object Y 规则内容,规则详见附录(流量分组规则数据格式)规范

 

2.5 样例

请求样例:

curl --location --request GET 'https://api.toponad.net/v3/mediation_segment/116112' \
--header 'X-Up-Key: 877f8ae9c6e9ca82c0===b5fff594c373axxx' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1626056011000' \
--header 'Content-Type: application/json' \
--data-raw ''

返回样例:

{
    "data": [
        {
            "segment_id": 600270,
            "segment_name": "sdk_and_brand",
            "priority": 8,
            "parallel_request_number": 1,
            "auto_load": 0,
            "hour_cap": -1,
            "day_cap": -1,
            "pacing": -1,
            "rules": [
                {
                    "type": 9,
                    "rule": 7,
                    "content": "5.2.1"
                },
                {
                    "type": 11,
                    "rule": 1,
                    "content": [
                        "apple",
                        "acer",
                        "advan"
                    ]
                }
            ]
        },
        {
            "segment_id": 600262,
            "segment_name": "sdk",
            "priority": 9,
            "parallel_request_number": 1,
            "auto_load": 20,
            "hour_cap": 2,
            "day_cap": 3,
            "pacing": 4,
            "rules": [
                {
                    "type": 9,
                    "rule": 7,
                    "content": "5.2.1"
                }
            ]
        },
        {
            "segment_id": 0,
            "segment_name": "Default Segment",
            "priority": 10,
            "parallel_request_number": 1,
            "auto_load": 0,
            "hour_cap": -1,
            "day_cap": -1,
            "pacing": -1,
            "rules": []
        }
    ]
}

3. 创建流量分组

3.1 请求URL

https://api.toponad.net/v3/mediation_segment

3.2 请求方式

POST

3.3 请求参数

字段 类型 是否必传 备注
app_id String Y 应用ID
placement_id String Y 广告位ID
mediation_group_id Int Y 聚合分组ID
segment_name String Y 流量分组名称
timezone Int N 流量分组时区,取值范围[-12,12],分别代表[UTC-12,UTC+12]注意: 1.规则存在时区属性时(天/小时/安装时间自然天)不传默认为0时区(UTC+0) 2.规则不存在时区属性时,可不传
rules Array[Object] Y 流量分组规则信息列表
rules.type Int Y

规则类型,默认规则为地区,枚举值说明:
0: 地区(集合)
2: 天(星期)(集合)
3: 网络(集合),注意:集合里内容必须是小写且前后不能包含空格,可选值如下:2g,3g,4g,5g,wifi
4: 小时/1225/2203(区间)
5: 自定义规则(custom)
8: 应用版本号 (集合)
9: SDK版本号 (集合)
10: 设备类型(集合),注意:集合里内容必须是小写且前后不能包含空格,可选值如下:iphone,ipad
11: 设备品牌(集合),集合里可选值如下: Apple,Acer,Advan,Amazon,Asus,Blackshark,Coolpad, GIONEE,Google,Hisense,Honor,HTC,Huawei,Infinix, Lanix,LeEco,Lenovo,LGE,Meitu,Meizu,MetroPCS, Motorola,Nokia,Nubia,OnePlus,OPPO,Qcom,Realme, Redmi,Samsung,Sharp,Smartfren,Smartisan,Sony,TCL, Tecno,Verizon,Vivo,Xiaomi,ZTE,360
12: 系统版本 (集合)
17: 设备ID (集合)
20: 安装时间小时(值)
21: 安装时间天 (值)
22: 安装时间周 (值)
23: 渠道 (集合),支持包括/不包括
24: 子渠道 (集合),支持包括/不包括
25: IDFA状态 (值),支持等于,可选值如下,1(有IDFA);2(无IDFA)
26: 安装时间自然天 (值)
53:新版自定义规则(custom_v2)

详情看流量分组规则(新)

rules.rule Int Y 具体规则,默认为包含,枚举值说明:
0: 包含(集合)
1: 不包含(集合)
2: 大于等于(值)
3: 小于等于(值)
4: 区间内(区间)
5: 区间外(区间)
6: 自定义规则(custom)
7: 大于(值)
8: 小于(值)
12:新版自定义规则(custom_v2)
rules.content Object Y 规则内容,规则详见附录(流量分组规则数据格式)规范

3.4 返回参数

字段 类型 是否必传 备注
id Int Y 流量分组ID

3.5 样例

请求样例:

curl --location --request POST 'https://api.toponad.net/v3/mediation_segment' \
--header 'X-Up-Key: 877f8ae9c6e9ca82c0==5b5fff594c373axxx' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1626161553000' \
--header 'Content-Type: application/json' \
--data-raw '{
    'app_id'             : 'a60f54770a583d',
    'placement_id'       : 'b60f6e9480e4ba',
    'mediation_group_id' : 116112,
    'segment_name'       : 'sdk_and_brand',
    'rules'              : [
        {
            "rule"    : 7,
            "type"    : 9,
            "content" : "5.2.1",
        },
        {
            "type"    : 11,
            "rule"    : 1,
            "content" : [
                "apple",
                "acer",
                "advan",
            ],
        },

    ]
}'

返回样例:

{
    "id": 600271
}

4. 调整流量分组优先级

4.1 请求URL

https://api.toponad.net/v3/mediation_segment_priority/:mediation_group_id

4.2 请求方式

PUT

4.3 请求参数

字段 类型 是否必传 备注
app_id String Y 应用ID
placement_id String Y 广告位ID
segment_ids Array[Int] Y 流量分组ID列表

4.4 返回参数

字段 类型 是否必传 备注
segment_ids Array[int] Y 流量分组ID列表

4.5 样例

请求样例:

curl --location --request PUT 'https://api.toponad.net/v3/mediation_segment_priority/116112' \
--header 'X-Up-Key: 877f8ae9c6e9ca82c0==5b5fff594c373axxx' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1626161553000' \
--header 'Content-Type: application/json' \
--data-raw '{
    'app_id'       : 'a60f54770a583d',
    'placement_id' : 'b60f6e9480e4ba',
    'segment_ids'  : [
        600269,
        600268,
        600265,
        600264,
        600263,
        600261,
        600258,
        600270,
        600262
    ]
}'

返回样例:

{
    "ids": [
         600269,
        600268,
        600265,
        600264,
        600263,
        600261,
        600258,
        600270,
        600262
    ]
}

5. 更新流量分组

5.1 请求URL

https://api.toponad.net/v3/mediation_segment/:segment_id

5.2 请求方式

PUT

5.3 请求参数

字段 类型 是否必传 备注
app_id String Y 应用ID
placement_id String Y 广告位ID
mediation_group_id Int Y 聚合分组ID
segment_name String Y 流量分组名称
timezone Int N 流量分组时区,取值范围[-12,12],分别代表[UTC-12,UTC+12]注意: 1.规则存在时区属性时(天/小时/安装时间自然天)不传默认为0时区(UTC+0) 2.规则不存在时区属性时,可不传
rules Array[Object] Y 流量分组规则信息列表
rules.type Int Y 规则类型,默认规则为地区,枚举值说明: 0: 地区(集合) 2: 天(星期)(集合) 3: 网络(集合),注意:集合里内容必须是小写且前后不能包含空格,可选值如下:2g,3g,4g,5g,wifi 4: 小时/1225/2203(区间) 5: 自定义规则(custom) 8: 应用版本号 (集合) 9: SDK版本号 (集合) 10: 设备类型(集合),注意:集合里内容必须是小写且前后不能包含空格,可选值如下:iphone,ipad 11: 设备品牌(集合),集合里可选值如下: Apple,Acer,Advan,Amazon,Asus,Blackshark,Coolpad, GIONEE,Google,Hisense,Honor,HTC,Huawei,Infinix, Lanix,LeEco,Lenovo,LGE,Meitu,Meizu,MetroPCS, Motorola,Nokia,Nubia,OnePlus,OPPO,Qcom,Realme, Redmi,Samsung,Sharp,Smartfren,Smartisan,Sony,TCL, Tecno,Verizon,Vivo,Xiaomi,ZTE,360 12: 系统版本 (集合) 17: 设备ID (集合) 20: 安装时间小时(值) 21: 安装时间天 (值) 22: 安装时间周 (值) 23: 渠道 (集合),支持包括/不包括 24: 子渠道 (集合),支持包括/不包括 25: IDFA状态 (值),支持等于,可选值如下,1(有IDFA);2(无IDFA) 26: 安装时间自然天 (值)
rules.rule Int Y 具体规则,默认为包含,枚举值说明: 0: 包含(集合) 1: 不包含(集合) 2: 大于等于(值) 3: 小于等于(值) 4: 区间内(区间) 5: 区间外(区间) 6: 自定义规则(custom) 7: 大于(值) 8: 小于(值) 9: 等于(值)
rules.content Object Y 规则内容,规则详见附录(流量分组规则数据格式)规范

5.4 返回参数

字段 类型 是否必传 备注
id Int Y 流量分组ID

5.5 样例

请求样例:

curl --location --request PUT 'https://api.toponad.net/v3/mediation_segment/600262' \
--header 'X-Up-Key: 877f8ae9c6e9ca82c0==5b5fff594c373axxx' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1626161553000' \
--header 'Content-Type: application/json' \
--data-raw '{
    'app_id'             : 'a60f54770a583d',
    'placement_id'       : 'b60f6e9480e4ba',
    'mediation_group_id' : 116112,
    'segment_name'       : 'new_CHINA_update',
    'rules'              : [
        {
            "rule"    : 7,
            "type"    : 9,
            "content" : "5.2.1",
        },
    ]
}'

返回样例:

{
    "id": 600262
}

6. 删除流量分组

注意:这个流量分组在做实验时不能删除

6.1 请求URL

https://api.toponad.net/v3/mediation_segment/:segment_id

6.2 请求方式

DELETE

6.3 请求参数

字段 类型 是否必传 备注
placement_id String Y 广告位ID
mediation_group_id Int Y 聚合分组ID

6.4 返回参数

字段 类型 是否必传 备注
id Int Y 流量分组ID

6.5 样例

请求地址样例:

https://api.toponad.net/v3/mediation_segment/600267

请求参数样例:

curl --location --request DELETE 'https://api.toponad.net/v3/mediation_segment/600267' \
--header 'X-Up-Key: 877f8ae9c6e9ca82c0==5b5fff594c373axxx' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1626161553000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "placement_id"       : 'b60f6e9480e4ba',
    "mediation_group_id" : 116112
}'

返回样例:

{
    "id": 600267
}

7. 批量修改流量分组在waterfall的属性(已过期,使用Api9

7.1 请求URL

https://api.toponad.net/v3/mediation_segment/:mediation_group_id/segment_id/:segment_id/attributes

7.2 请求方式

POST

7.3 请求参数

字段 类型 是否必传 备注
parallel_request_number Int Y 并发请求数
auto_load Int N 默认0表示关,只能传0或正整数 对于Banner,可以设置自动刷新时间,大于0表示自动刷新时间 对于RV和插屏,仅控制自动请求的开关状态,非0表示开
hour_cap Int N 展示上限(小时),-1 表示无限制
day_cap Int N 展示上限(天),-1 表示无限制
pacing Int N 展示间隔(秒),-1 表示无限制

7.4 返回参数

字段 类型 是否必传 备注
id Int Y 流量分组ID

7.5 样例

请求样例:

curl --location --request POST 'https://api.toponad.net/v3/mediation_segment/116112/segment_id/600262/attributes' \
--header 'X-Up-Key: 877f8ae9c6e9ca82c0==5b5fff594c373axxx' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1626161553000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id" : 600262
    "auto_load" : 20,
    "hour_cap" : 2,
    "day_cap" : 3,
    "pacing" : 4
}'

返回样例:

{
    "id": 600262
}

8. 获取广告位流量分组高级设置策略

注意:流量分组做了实验,同一个segment_id可能会有多条(对应不同的实验组abtest_group_item_id),文档暂时不体现,待升级

8.1 请求URL

https://api.toponad.net/v3/mediation_segment/strategies

8.2 请求方式

GET

8.3 请求参数

字段 类型 是否必传 备注
placement_id String Y TopOn的广告位ID,可通过【广告位管理Api1】创建广告位后获取
currency String Y 返回数据中币种相关属性的币种单位,例如竞价底价bid_floor

8.4 返回参数

- Array[Object] Y 广告源信息列表
_.mediation_group_id Int Y TopOn聚合分组ID
_.segment_id Int Y TopOn聚合分组下流量分组ID,0代表默认分组
_.segment_name String Y 流量分组名字,注意:空字符串代表默认分组
_.bid_floor Double Y 竞价底价,注意:-1代表不限
_.parallel_req_type Int Y 并行请求类型,枚举说明: 1:固定数量请求(默认) 2:同价格并行请求 备注:选择固定数量请求,广告源将按最大并行请求数顺序发起请求,如果请求异常则顺序请求下一广告源。选择同价格并行请求(TopOn SDK v5.9.20及以上),广告源将以价格为优先级顺序,按最大可并行数发起请求,如果全部请求异常,则顺序请求下一优先级广告源。广告展示不受并行影响,会严格遵循广告源优先级排序。
_.parallel_req_num Int N 并行请求数,有效区间[1,10],推荐2,默认值参考开发者后台,注意:固定数量请求时才返回 备注:并行条数为1表示串行请求,若条数为n(n>1),TopOn同时向前n个广告源发送请求;如果全部请求异常,TopOn继续向第n+1到第2n个广告源发送请求,依此类推。并行请求适用于广告展示高频的场景。
_.offer_request_num Int Y 广告加载条数,有效区间:[1,100],注意:暂时只有原生样式支持,其他样式可忽略 备注:从v5.7.6( v5.7.06)版本开始,SDK支持针对广告源维度设置广告请求条数。支持广告源一次返回多条广告的广告平台:腾讯广告、快手广告、穿山甲
_.hour_cap Int Y 展示上限(小时),枚举说明: -1:表示无限制(默认) 正整数:上限数量,范围[1,1000] 备注:设置单个用户在每个小时内的广告展示次数上限
_.day_cap Int Y 展示上限(天),枚举说明: -1:表示无限制 (默认) 正整数:上限数量,范围[1,1000] 备注:设置单个用户在每天内的广告展示次数上限
_.pacing Int Y 展示间隔(秒),枚举说明: -1:表示无限制 (默认) 正整数:间隔的秒时间,范围[1,10000000] 备注:设置本次展示到下一次请求之间的时间间隔

8.5 样例

请求样例:

 
curl --location --request GET https://api.toponad.net/v3/mediation_segment/strategies?currency=USD&placement_id=b648a83d80eaxx' \
--header 'X-Up-Key: 877f8ae9c6e9ca82c0===b5fff594c373axxx' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1626056011000' \
--header 'Content-Type: application/json' \
--data-raw ''

返回样例:

[
    {
        "mediation_group_id": 273566,
        "segment_id": 0,
        "segment_name": "",
        "bid_floor": 1.25,
        "parallel_req_type": 1,
        "parallel_req_num": 7,
        "auto_refresh_time": -1,
        "hour_cap": 100,
        "day_cap": 200,
        "pacing": 300
    },
    {
        "mediation_group_id": 273566,
        "segment_id": 652072,
        "segment_name": "渠道",
        "bid_floor": -1,
        "parallel_req_type": 2,
        "auto_refresh_time": 15,
        "hour_cap": 100,
        "day_cap": 200,
        "pacing": 300
    }
]

9. 修改广告位流量分组高级设置策略

注意:若果其中存某个流量分组在做实验,则不会更新这个流量分组(操作成功,但是实际没有生效),没有做实验的流量分组则更新成功,待升级

9.1 请求URL

https://api.toponad.net/v3/mediation_segment/strategies

9.2 请求方式

PUT

9.3 请求参数

字段 类型 是否必传 备注
placement_id String Y TopOn的广告位ID,可通过【广告位管理Api1】创建广告位后获取
currency String Y items数据中币种相关属性的币种单位,例如竞价底价bid_floor
items Array[Object] Y 流量分组高级设置策略数据列表
items.mediation_group_id Int Y TopOn聚合分组ID
items.segment_id Int Y TopOn聚合分组下流量分组ID,0代表默认分组
items.bid_floor Double N 竞价底价,枚举说明 -1:代表不限(默认), 其他值:最大值10000,美元最小值0.01,人民币最小值0.1 不传或传0代表不修改 备注:竞价底价具体支持的广告平台及SDK版本请查看头部竞价说明。当广告平台出价低于竞价底价时TopOn将会过滤此出价结果。设置竞价底价会降低竞价广告源的填充和收益,请谨慎设置。如果在流量分组和广告源同时设置了竞价底价,优先使用广告源的竞价底价(竞价底价最小值,人民币为¥0.1,美元为 $0.01)。
items.parallel_req_type Int N 并行请求类型,枚举说明: 1:固定数量请求(默认) 2:同价格并行请求 不传或传0代表不修改 备注:选择固定数量请求,广告源将按最大并行请求数顺序发起请求,如果请求异常则顺序请求下一广告源。选择同价格并行请求(TopOn SDK v5.9.20及以上),广告源将以价格为优先级顺序,按最大可并行数发起请求,如果全部请求异常,则顺序请求下一优先级广告源。广告展示不受并行影响,会严格遵循广告源优先级排序。
items.parallel_req_num Int N 并行请求数,有效区间[1,10],推荐2,默认值参考开发者后台,注意:固定数量请求时才可设置数量,非固定固定数量请求不传即可 不传或传0代表不修改 备注:并行条数为1表示串行请求,若条数为n(n>1),TopOn同时向前n个广告源发送请求;如果全部请求异常,TopOn继续向第n+1到第2n个广告源发送请求,依此类推。并行请求适用于广告展示高频的场景。
items.hour_cap Int N 展示上限(小时),枚举说明: -1:表示无限制(默认) 正整数:上限数量,范围[1,1000] 不传或传0代表不修改 备注:设置单个用户在每个小时内的广告展示次数上限
items.day_cap Int N 展示上限(天),枚举说明: -1:表示无限制(默认) 正整数:上限数量,范围[1,1000] 不传或传0代表不修改 备注:设置单个用户在每天内的广告展示次数上限
items.pacing Int N 展示间隔(秒), 枚举说明: -1:表示无限制(默认) 正整数:间隔的秒时间,范围[1,10000000] 不传或传0代表不修改 备注:设置本次展示到下一次请求之间的时间间隔
items.nw_timeout Int N 广告源超时时间(毫秒) 正整数:间隔的毫秒时间,范围[100,60000] 不传则代表不修改
items.device_perf_opt_sw Int N 设备性能优化模式 1-开,2-关 默认2 不传则代表不修改
items.wf_lscb_type Int N 广告位填充成功回调模式 1: 展示优先 2: 价格优先 不传则代表不修改
items.wf_loadts Int N 瀑布流填充等待时间(毫秒): 正整数:间隔的毫秒时间,范围[1000,120000] 不传则代表不修改
items.max_cached_num Int N 最大缓存数量 正整数:范围[-1,1000] -1为无限,不能配置0 不传则代表不修改
items.sdk_timeout Int N 广告位请求超时时间(秒) [1,5000]
items.cached_offers_num Int N Waterfall执行结束的广告数量 范围[1,5] 不传则代表不修改
items.hb_bid_timeout Int N 最长竞价时间(毫秒) 正整数:间隔的毫秒时间,范围[1,120000] 不传则代表不修改
items.bottom_req_time Int N 兜底请求发起时间(毫秒) 正整数:范围[0,5000] 不传则代表不修改
items.strategy_cache_timeout Int N 广告位策略更新超时时间(秒) 正整数:范围[0,100] 不传则代表不修改
items.pl_up_status_timeout Int N 广告位填充冷却时间(秒) 正整数:范围[0,1000] 不传则代表不修改
items.ad_up_status_timeout Int N 广告源填充冷却时间(秒) 正整数:范围[0,1000] 不传则代表不修改
items.bid_wait_other_time Int N 兜底请求发起时间(毫秒) 正整数:间隔的毫秒时间,范围[0,5000] 不传则代表不修改
items.byuid_wt Int N 获取buyeruid最大等待时间(毫秒) 正整数:间隔的毫秒时间,范围[1,100000] 不传则代表不修改
items.auto_refresh_time Int N 自动刷新 整数:范围[-1,1000] -1为自动刷新,不能配置0 大于0是手动刷新 不传则代表不修改
items.s2s_bd_max Int N 最大缓存有效数 整数:范围[-1,5] -1为自动刷新,不能配置0 不传则代表不修改
items.req_ug_numsp Int N 并行请求数,有效区间[1,10],并行类型为2的时候生效 不传或传0代表不修改 备注:并行条数为1表示串行请求,若条数为n(n>1),TopOn同时向前n个广告源发送请求;如果全部请求异常,TopOn继续向第n+1到第2n个广告源发送请求,依此类推。并行请求适用于广告展示高频的场景。
items.rotation_num Int N 轮播数量(插屏样式生效) 整数:范围[1,5] 默认1 不传则代表不修改
items.rotation_inter Int N 轮播间隔(毫秒)(插屏样式生效) 整数:范围[2000,30000] 不传则代表不修改

9.4 返回参数

字段 类型 是否必传 备注
items Array[Object] N 错误广告源信息列表,注意: 1. 列表为空,则标识操作成功 2. 列表不为空,则列表标识哪些item校验不通过,所有item(包括校验通过)操作失败
items.index Int Y 错误item所在的索引,从0开始
items.err_code Int Y 错误码
items.err_msg String Y 错误信息

9.5 样例

请求样例:

curl --location --request PUT 'https://api.toponad.net/v3/mediation_segment/strategies' \
--header 'X-Up-Key: 877f8ae9c6e9ca82c0==5b5fff594c373axxx' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1626161553000' \
--header 'Content-Type: application/json' \
--data-raw {
    "placement_id" : "b648a83d80eaxx",
    "currency" : "CNY",
    "items" : [
        {
            "mediation_group_id":273566,
            "segment_id":0,
            "bid_floor": -1,
            "parallel_req_type":1,
            "parallel_req_num": 7,
            "auto_refresh_time":-1,
            "hour_cap":100,
            "day_cap":200,
            "pacing":300,
            "intel_opt_cache":1
        }
    ]
}'

 

返回样例:

{

}

上一个
广告平台管理
下一个
聚合管理的广告源管理
最近修改: 2026-04-21Powered by