菜单

广告源管理(新版v3)

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

1. 获取广告源列表

1.1 请求URL

https://openapi.toponad.com/v3/units/list

1.2 请求方式

GET

1.3 请求参数

字段类型是否必传备注
app_idsArray[String]NTaku应用ID列表,数量最大限制为100
placement_idsArray[String]NTaku广告位ID列表,数量最大限制为100
network_idsArray[Int]NTaku三方平台账号ID列表,数量最大限制为100
startIntN起始偏移量,默认0
limitIntN获取个数,,最大限制为1000,默认1000,

1.4 响应参数

字段类型是否必传备注
totalIntY搜索条件下的总数
itemsArray[Object]Y广告源信息列表
items.idIntY广告源ID
items.nameStringY广告源名称
items.app_idStringYTaku的应用ID
items.placement_idStringYTaku的广告位ID
items.network_idIntYTaku广告平台账号ID
items.nw_firm_idIntY广告平台ID

1.5 样例

请求样例:

curl --location --request GET 'https://openapi.toponad.com/v3/units/list?app_ids=a63f5cced466da&placement_ids=b1ehgn65hup6v0,b640ae1464e7e9&network_ids=4779,4780&start=0&limit=200 ' \
--header 'X-Up-Key: 877f8ae9c6e9ca82c0===b5fff594c373axxx' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1626056011000' \
--header 'Content-Type: application/json' \
--data-raw ''

返回样例:

{
    "total": 10,
    "items": [
        {
            "app_id": "a6392a1c24510e",
            "placement_id": "b6392a1d36f73f",
            "network_id": 5117,
            "id": 2279787,
            "name": "ADX",
            "nw_firm_id":15
        },
        {
            "app_id": "a6392a1c24510e",
            "placement_id": "b6392a1d59c06f",
            "network_id": 5117,
            "id": 2279797,
            "name": "ADX",
             "nw_firm_id":15
        }
    ]
}

2. 获取广告源详情

2.1 请求URL

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

2.2 请求方式

GET

2.3 请求参数

字段类型是否必传备注
idsArray[Int]Y广告源ID列表,数量最大限制为100,最小限制为1

2.4 响应参数

字段类型是否必传备注
-Array[Object]Y广告源信息列表
_.idIntY广告源ID
_.nameStringY 广告源名称
_.network_idIntYTaku广告平台账号ID
_.placement_idStringYTaku的广告位ID
_.typeIntY广告源类型,枚举值说明如下:
2:普通广告源
4:adx广告源
10:兜底广告源
12:客户端竞价广告源
13:服务端竞价广告源
_.mix_formatIntN混合样式,注意:只有某些平台才有该属性,枚举说明:
-1或和广告位format值一样:非混合类型
0:混合native类型
1:混合rewarded_video类型
2:混合banner类型
3:混合interstitial类型
4:混合splash类型
_.adsource_tokenObjectY广告源配置参数,三方广告平台或自定义关联三方平台详见【新附录三方广告平台详细参数】规范的属性列<adsource_token>,自定义广告平台时需满足json object格式,该属性暂不支持adx广告源(流量分组相关)
_.auto_unit_swIntY自动广告源开关,某些平台才有:1开,2关
_.nw_firm_idIntY广告平台ID

2.5 样例

请求样例:

curl --location --request GET 'https://openapi.toponad.com/v3/units?ids=417018,374133' \
--header 'X-Up-Key: 877f8ae9c6e9ca82c0===b5fff594c373axxx' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1626056011000' \
--header 'Content-Type: application/json' \
--data-raw ''

返回样例:

[
    {
        "id": 374133,
        "placement_id": "b6049c640e6ad1",
        "network_id": 4779,
        "name": "穿山甲_rv_3",
        "type": 2,
        "mix_format": -1,
        "adsource_token": {
            "app_id": "5343323",
            "personalized_template": "1",
            "slot_id": "4566363563"
        },
        "auto_unit_sw": 2,
         "nw_firm_id":15
    },
    {
        "id": 417018,
        "placement_id": "b6049c640e6ad1",
        "network_id": 4779,
        "name": "穿山甲_rv_6",
        "type": 2,
        "mix_format": -1,
        "adsource_token": {
            "app_id": "5343323",
            "personalized_template": "0",
            "slot_id": "324ewrwe"
        },
        "auto_unit_sw": 2,
         "nw_firm_id":15
    }
]

3. 创建广告源

注意:创建广告源成功后默认是解绑+关闭状态(因为这些属性是流量分组相关的,即在不同流量分组会不一样),需要再次调用聚合管理的广告源管理Api2或Api5来根据需要在指定流量分组绑定和开启

3.1 请求URL

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

3.2 请求方式

POST

3.3 请求参数

字段类型是否必传备注
placement_idStringYTaku的广告位ID
itemsArray[Object]Y广告源信息列表
items.nameStringY 广告源名称
items.network_idIntYTaku广告平台账号ID
items.typeIntY广告源类型,注意:某些平台才支持竞价广告源,并且同一个平台可能有些广告位样式支持竞价,有些样式又不支持,具体请参考新附录三方广告平台详细参数】的属性列<支持的竞价类型>,
枚举值说明如下:
2:常规广告源
10:兜底广告源
12:客户端竞价广告源
13:服务端竞价广告源
items.mix_formatIntY混合样式,非混合类型传-1即可,注意:只有某些平台才支持该属性,-1或者和广告位format值一样都代表非混合类型 ,混合类型需要申请权限(联系运营同学),不同三方平台参数文档请联系运营同学获取权限文档
枚举说明:
-1: 非混合类型
0:混合native类型
1:混合rewarded_video类型
2:混合banner类型
3:混合interstitial类型
4:混合splash类型
items.adsource_tokenObjectY广告源配置参数,混合类型时的三方平台参数文档请联系运营同学,非混合类型的三方广告平台或自定义关联三方平台详见新附录三方广告平台详细参数】规范的属性列<adsource_token>,自定义广告平台时需满足json object格式,该属性暂不支持adx广告源(流量分组相关)

3.4 返回参数

字段类型是否必传备注
itemsArray[Object]N成功的广告源信息列表,索引位置和请求参数items索引位置一一对应
items.idIntY添加成功后的广告源ID
errsArray[Object]N错误广告源信息列表,注意:
1. 列表为空,则标识操作成功
2. 列表不为空,则列表标识哪些广告源校验不通过,所有广告源(包括校验通过)操作失败
errs.indexIntN错误item在请求参数items中的索引位置,从0开始,0的时候可能不返回字段
errs.codeIntN错误码
errs.msgStringN错误信息

3.5 样例

请求样例:

curl --location --request POST 'https://openapi.toponad.com/v3/units' \
--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": "b64993cxxxx",
    "items": [
        {
            "network_id": 4778,
            "name": "xcj_admob_openapi1",
            "adsource_token": {
                "unit_id":"123456790000",
                "orientation":"1"
            },
            "mix_format":-1,
            "type": 2
        }
    ] 
}'

返回样例:

{
    "errs": [
        {
            "index": 0,
            "code": 4000,
            "msg": "the unit type is invalid"
        }
    ]
}

4. 修改广告源

4.1 请求URL

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

4.2 请求方式

PUT

4.3 请求参数

字段类型是否必传备注
placement_idStringYTaku的广告位ID
itemsArray[Object]Y广告源信息列表
items.idIntY 广告源ID
items.nameStringY 广告源名称
items.adsource_tokenObjectY广告源配置参数,三方广告平台或自定义关联三方平台详见【新附录三方广告平台详细参数】规范的属性列<adsource_token>,纯自定义广告平台时需满足json object格式,该属性暂不支持adx广告源(流量分组相关)

4.4 返回参数

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

4.5 样例

请求样例:

curl --location --request PUT 'https://openapi.toponad.com/v3/units' \
--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": "b64993cxxxx",
    "items": [
        {
            "id": 4778,
            "name": "xcj_admob_openapi1",
            "adsource_token": {
                "unit_id":"123456790000",
                "orientation":"1"
            }
        }
    ]
}'

返回样例:

{

}


5. 批量删除广告源

注意:暂时还是v1, 待后续升级v3

5.1 请求URL

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

5.2 请求方式

POST

5.3 请求参数

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

5.4 返回参数

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

5.5 样例

请求样例:

curl --location --request PUT 'https://openapi.toponad.com/v1/del_units' \
--header 'X-Up-Key: 877f8ae9c6e9ca82c0==5b5fff594c373axxx' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1626161553000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "adsource_ids":[19683]
}'

返回样例:

{
    "msg": "suc"
}


上一个
广告源管理(过期)
下一个
AB测试管理
最近修改: 2025-08-21Powered by