菜单

广告源管理（过期）

注意：已过期，使用新版Api: 广告源管理 (新版v3)

1. 批量创建和修改广告源

注意：在应用下创建新广告平台的广告源时，需要先调用【广告平台管理Api1】创建新广告平台的Publisher和App维度参数

1.1 请求URL

https://openapi.toponad.com/v1/set_units

1.2 请求方式

POST

1.3 请求参数

字段	类型	是否必传	备注
count	Int	Y	创建或修改的广告源总数
ecpm_currency	String	N	请求参数units中的default_ecpm币种单位，默认为开发者账号币种，可选USD，CNY
units	Array[Object]	Y	广告源信息列表，数量最大限制为10，注意： 1. 同一个Taku平台账号对应的第三方平台的广告源唯一标识（例如腾讯平台的广告源唯一标识为广告位ID，对应请求参数adsource_token属性中的unit_id）不能重复创建Taku不同广告源，各三方平台的广告源唯一标识见【附录三方广告平台详细参数】规范中adsource_token列的后面带'(唯一)'的key
units.network_id	Int	Y	广告平台账号ID，可通过【广告平台管理Api1】创建广告平台后获取
units.adsource_id	Int	N	广告源ID，修改时必传
units.adsource_name	String	Y	广告源名称
units.adsource_token	Object	Y	广告平台Unit维度参数，非自定义广告平台详见【附录三方广告平台详细参数】规范，自定义广告平台时需满足json object格式
units.placement_id	String	Y	Taku的广告位ID，可通过【广告位管理Api1】创建广告位后获取
units.default_ecpm	String	Y	广告源默认价格，注意： 1. ecpm是流量分组维度下属性，如果想修改ecpm,请调用7.2接口修改 2. 该接口不可修改ecpm,若要修改其它属性（例如adsource_name），则和创建时传一样ecpm即可，后期升级接口时会优化体验
units.header_bidding_switch	Int	N	Header Bidding 开关，默认为关闭，注意：只有部分广告平台的部分广告位样式支持Header Bidding，详情见【附录支持开启Header Bidding 的广告平台和广告样式】，创建后不可修改，即修改操作可不传，枚举值说明： 1：关（默认） 2：开
units.bottom_type	Int	N	是否为兜底广告源，注意：只有普通广告源才支持设置是否兜底，并且激励视频、插屏、原生、Banner类型的广告源默认不允许设置兜底类型，需要联系运营人员开通权限，枚举值说明： 0：非兜底（默认） 1：是兜底

1.4 返回参数

字段	类型	是否必传	备注
units	Array[Object]	Y	广告源信息列表
units.network_id	Int	Y	广告平台账号ID，可通过【广告位管理Api2】获取该ID
units.adsource_id	Int	N	广告源ID，修改时必传
units.adsource_name	String	Y	广告源名称
units.adsource_token	Object	Y	广告平台Unit维度参数，详见【附录三方广告平台详细参数】规范中adsource_token列
units.placement_id	String	Y	Taku的广告位ID
units.default_ecpm	String	Y	广告源默认价格
units.header_bidding_switch	Int	N	Header Bidding 开关，默认为关闭，注意：只有部分广告平台的部分广告位样式支持Header Bidding，详情见【附录支持开启Header Bidding 的广告平台和广告样式】，创建后不可修改，即修改操作可不传，枚举值说明： 1：关（默认） 2：开
units.bottom_type	Int	N	是否为兜底广告源，注意：只有普通广告源才支持设置是否兜底，并且激励视频、插屏、原生、Banner类型的广告源默认不允许设置兜底类型，需要联系运营人员开通权限，枚举值说明： 0：非兜底（默认） 1：是兜底
units.ecpm_currency	String	Y	ecpm币种单位，对应请求时的参数ecpm_currency
units.errors	String	N	错误信息（错误时返回）,部分错误描述如下： 1. "header_bidding_switch error"：请求参数header_bidding_switch值错误或某些平台暂时不支持开启HB 2. “network_id check network error”：请求参数network_id非法 3. "network_id auth content decode error"：广告平台publisher维度参数未设置，检查确认后调用【广告平台管理Api1】或者在开发者后台设置重新编辑该平台保存 4. "network_id error please check": 广告平台publisher维度参数未设置 5. “network app param error, please check”：广告平台的app维度参数未设置，注意：批量创建广告源之前必须确认对应的三方广告平台的app维度参数已经绑定到了Taku的对应应用，并且每个应用只需绑定一次即可，具体绑定方式有如下两种：（1）调用8.1接口（若果是自定义平台则调用【广告位管理Api5】）进行绑定：请求参数中的network_app_info.app_id即为要绑定到的Taku的应用ID，network_app_info.app_auth_content即为三方平台的app维度参数，具体详情参考【广告位管理Api1】（2）在开发者后台进行绑定，页面操作流程：选中广告平台（变现平台）-->点击对应账号的广告源管理-->点击关联应用进行绑定即可（左边的应用列表即该平台账号已经绑定app维度参数的Taku应用） 6. “ad_souce_token param empty error“: 请求参数adsource_token未传 7. "adsource_id error"：请求参数adsource_id非法 8. "ad_souce_token auth error"：请求参数adsource_token填写错误或缺失 9. "ad_souce_token error:xxx is null"：adsource_token参数里的对应key缺失 10. "ad_souce_token error:xxx is err: example: xxx"：adsource_token参数里的对应key枚举值非法 11. "ad_source_name repeated"：不允许创建重复名字的广告源 12. "repeated unit error": 同一个Taku平台账号对应的第三方平台的广告源唯一标识（例如腾讯平台的广告源唯一标识为广告位ID，对应请求参数adsource_token属性中的unit_id）不能重复创建Taku不同广告源，各三方平台的广告源唯一标识见【附录三方广告平台详细参数】规范中adsource_token列的后面带'(唯一)'的key 13. “the network and placement format does not support header bidding”：广告平台和广告样式不支持开启Header Bidding，详情参考【附录支持开启Header Bidding 的广告平台和广告样式】

1.5 样例

请求样例：

{
    "count": 2,
    "units": [
        {
            "network_id": 307,
            "adsource_name": "5234",
            "adsource_token": {
                "unit_id": "fasfasf",
                "is_video": "0",
                "personalized_template": "1",
                "size": "320x50",
                "layout_type": "1"
            },
            "placement_id": "b5bc993ab0966a",
            "default_ecpm": "69"
        },
        {
            "network_id": 225,
            "adsource_name": "5234",
            "adsource_id": 19759,
            "adsource_token": {
                "slot_id": "fasfasf",
                "is_video": "0",
                "personalized_template": "1",
                "size": "640x100",
                "layout_type": "1"
            },
            "placement_id": "b5bc993ab0966a",
            "default_ecpm": "69"
        }
    ]
}

返回样例：

    [
        {
            "network_id": 307,
            "adsource_id": 19743,
            "adsource_name": "23423423423",
            "adsource_token": {
                "size": "sdsd",
                "unit_id": "xcxc"
            },
            "placement_id": "12312312",
            "default_ecpm": "",
            "errors": "adsource_id error",
            "ecpm_currency": "USD"
        },
        {
            "network_id": 307,
            "adsource_name": "asfdasdasd",
               "adsource_token": {
                "size": "asfasd",
                "unit_id": "asdasdafsdddd"
            },
            "placement_id": "123123123",
            "default_ecpm": "",
            "errors": "ad_source_name repeated",
            "ecpm_currency": "USD"
        }
    ]

2. 获取广告源列表

2.1 请求URL

https://openapi.toponad.com/v1/units

2.2 请求方式

POST

2.3 请求参数

字段	类型	是否必传	备注
network_firm_ids	Array[Int]	N	广告平台ID列表，默认所有广告平台ID，各广告平台ID可查看文档获取：聚合平台概况注意：和start, limit参数一起使用时，以start+limit条件获取到的广告源个数为准
app_ids	Array[String]	N	应用ID列表，默认所有应用ID，可通过【应用管理Api2】获取已创建的应用ID 注意：和start, limit参数一起使用时，以start+limit条件获取到的广告源个数为准
placement_ids	Array[String]	N	广告位ID列表，默认所有广告位ID，可通过【广告位管理Api2】获取已创建的广告位ID 注意：和start, limit参数一起使用时，以start+limit条件获取到的广告源个数为准
adsource_ids	Array[Int]	N	广告源ID列表，默认所有广告源ID 注意：和start, limit参数一起使用时，以start+limit条件获取到的广告源个数为准
start	Int	N	起始偏移量，默认0
limit	Int	N	获取个数，默认0，如果network_firm_ids，app_ids，placement_ids，adsource_ids都不传时则最大一次性获取100
metrics	Array[String]	N	指定返回的字段，默认全部返回，可选字段：nw_firm_id，network_id，network_name，adsource_id，adsource_name，adsouce_token，app_id，app_name，platform，placement_id，placement_name，placement_format，waterfall
ecpm_currency	String	N	ecpm币种单位，不传时默认USD，可选CNY，返回参数waterfall_list中的ecpm价格根据该字段传对应单位值

2.4 返回参数

字段	类型	是否必传	备注
network_id	Int	N	广告平台账号ID
network_name	String	N	广告平台账号名称
nw_firm_id	Int	N	广告平台ID
adsource_id	Int	N	广告源ID
adsource_name	String	N	广告源名称
adsource_token	Object	N	广告源配置参数
app_id	String	N	Taku的应用ID
app_name	String	N	Taku的应用名称
platform	Int	N	客户端系统类型，枚举值说明： 1: Android 2: IOS
placement_id	String	N	Taku的广告位ID
placement_name	Object	N	Taku的广告位名称
placement_format	String	N	广告位广告形式，枚举值：native、banner、rewarded_video、interstitial、splash
ecpm_currency	String	Y	ecpm币种单位，对应请求时的参数ecpm_currency
waterfall_list	Array[Object]	N	当前正在使用该广告源的waterfall信息
bottom_type	Int	N	是否为兜底广告源，注意：只有普通广告源才支持设置是否兜底，并且激励视频、插屏、原生、Banner类型的广告源默认不允许设置兜底类型，需要联系运营人员开通权限，枚举值说明： 0：非兜底（默认） 1：是兜底
waterfall_list.ecpm	String	N	waterfall关联的ecpm
waterfall_list.auto_ecpm	String	N	waterfall自动优化的ecpm
waterfall_list.header_bidding_switch（已废弃无效）	Int	N	是否支持headerbidding，注意：header_bidding_switch非waterfalls属性，已废弃
waterfall_list.auto_switch	Int	N	是否开启了自动优化，枚举值说明： 1: 关闭 2: 开启
waterfall_list.day_cap	Int	N	daycap
waterfall_list.hour_cap	Int	N	hour cap
waterfall_list.pacing	Int	N	pacing
waterfall_list.segment_name	String	N	segment名称
waterfall_list.segment_id	Int	N	关联的segment_id
waterfall_list.parallel_request_number	Int	N	关联的segment的并发请求数
waterfall_list.is_abtest	Int	N	是否是测试组，默认为默认组，枚举值说明： 0: 默认组 1: 测试组
waterfall_list.mediation_group_id	Int	N	聚合分组ID
waterfall_list.remark	String	N	广告源+流量分组维度的备注信息

2.5 样例

请求样例：

{
    "adsource_ids":[19683]
}

返回样例：

[
    {
        "nw_firm_id": 12,
        "network_name": "Default",
        "adsource_id": 19683,
        "adsource_name": "Unity Ads_int_2",
        "adsource_token": {
            "game_id": "234234",
            "placement_id": "23434"
        },
        "app_id": "232323",
        "app_name": "234234",
        "platform": 2,
        "placement_id": "234234234234",
        "placement_name": "234234234",
        "placement_format": "3",
        "ecpm_currency": "USD",
        "waterfall_list": [
            {
                "ecpm": "1",
                "auto_ecpm": "",
                "header_bidding_switch": 1,
                "auto_switch": 1,
                "day_cap": 0,
                "hour_cap": 0,
                "pacing": 0,
                "name": "日韩",
                "segment_id": 123,
                "priority": 3,
                "parallel_request_number": 2,
                "remark": "test"
            },
            {
                "ecpm": "2",
                "auto_ecpm": "",
                "header_bidding_switch": 1,
                "auto_switch": 1,
                "day_cap": -1,
                "hour_cap": -1,
                "pacing": -1,
                "name": "ipad",
                "segment_id": 456,
                "priority": 2,
                "parallel_request_number": 2,
                "remark": "test"
            }
        ]
    }
]

3. 批量删除广告源

3.1 请求URL

https://openapi.toponad.com/v1/del_units

3.2 请求方式

POST

3.3 请求参数

字段	类型	是否必传	备注
adsource_ids	Array[Int]	Y	广告源ID列表，数量最大限制为10，广告源id列表可通过【Api1】创建广告源后获取

3.4 返回参数

字段	类型	是否必传	备注
msg	String	N	结果描述，比如"suc"代表删除成功

3.5 样例

请求样例：

{
    "adsource_ids":[19683]
}

返回样例：

{
    "msg": "suc"
}

上一个

聚合管理的广告源管理

下一个

广告源管理（新版v3）

最近修改: 2025-08-21Powered by

大纲