广告平台管理

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

1. 创建和修改广告平台Publisher、App维度参数

1.1 请求URL

https://api.toponad.net/v1/set_networks

1.2 请求方式

POST

1.3 请求参数

1.4 返回参数

注意：响应错误时（http响应状态码不是200），部分错误描述如下：

1.“network is report error“：请求参数is_open_report数值错误

2.“network name repeated"：同一个广告平台创建相同名字账号错误

3.“network auth_content xxx error”：请求参数auth_content缺失或错误，请检查是否开通报表和附录（三方广告平台详细参数）规范

4.“failed to verify network auth_content”：开通报表时校验三方network参数错误或者三方校验超时，请检查三方network参数是否正确，或者稍后重试

5.“network app_auth_content xxx error”：请求参数network_app_info.app_auth_content缺失或错误，请参考附录（三方广告平台详细参数）规范

6."appid error"：参数network_app_info.app_id无效

1.5 样例

请求样例：

curl --location --request POST 'https://api.toponad.net/v1/set_networks' \
--header 'X-Up-Key: 877f8ae9c6e9ca82c0===b5fff594c373axxx' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1626161553000' \
--header 'Content-Type: application/json' \
--data-raw '{
	"network_name": "Default",
	"nw_firm_id": 2,
	"network_id": 226,
	"is_open_report": 2,
	"auth_content": {
		"account_id": "pub-1310074477383748",
		"oauth_key": "1/CW8VoZRbc5UCscXs3ddTXzwT9LQ71uFUMSE6iEwcRlk"
	},
	"network_app_info": [
		{
			"app_id": "a5bc9921f7fdb4",
			"app_auth_content": {
				"app_id": "ca-app-pub-1310074477383748~6985182465"
			}
		}
	]
}'

返回样例：

{
    "network_name": "Default",
    "nw_firm_id": 2,
    "network_id": 226,
    "is_open_report": 2,
    "auth_content": {
        "account_id": "pub-1310074477383748",
        "oauth_key": "1/CW8VoZRbc5UCscXs3ddTXzwT9LQ71uFUMSE6iEwcRlk"
    },
    "network_app_info": [
        {
            "app_id": "a5bc9921f7fdb4",
            "app_auth_content": {
                "app_id": "ca-app-pub-1310074477383748~6985182465"
            }
        }
    ]
}

2. 获取广告平台Publisher、App维度参数

2.1 请求URL

https://api.toponad.net/v1/networks

2.2 请求方式

GET

2.3 请求参数

无

2.4 返回参数

2.5 样例

请求样例：

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

返回样例：

[
    {
        "network_name": "Default",
        "nw_firm_id": 1,
        "network_id": 307,
        "is_open_report": 2,
        "network_app_info": [
            {
                "app_id": "appid1",
                "app_auth_content": {
                    "app_id": "24234234",
                    "app_token": "1"
                }
            }
        ]
    },
    {
        "network_name": "24523423",
        "nw_firm_id": 1,
        "network_id": 1418,
        "is_open_report": 2,
        "network_app_info": [
            {
                "app_id": "appid2",
                "app_auth_content": {
                    "app_id": "232323",
                    "app_token": "1"
                }
            }
        ]
    }
]

3. 自定义广告平台的创建和修改

3.1 请求URL

https://api.toponad.net/v1/set_custom_network

3.2 请求方式

POST

3.3 请求参数

3.4 返回参数

注意：响应错误时（http响应状态码不是200），部分错误描述如下：

1.“network id error“：修改操作时没传network_id或所传network_id无效

2.“network firm name is repeated”：已创建有相同名字的自定义广告平台，不允许重复

3.“invalid firm id”：修改操作时没传nw_firm_id或者nw_firm_id和network_id不匹配

3.5 样例

请求样例：

curl --location --request POST 'https://api.toponad.net/v1/set_custom_network' \
--header 'X-Up-Key: 877f8ae9c6e9ca82c0675b5fff594c373axxx' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1626161553000' \
--header 'Content-Type: application/json' \
--data-raw '{
	"nw_firm_id": 1000068,
	"nw_firm_name": "第555",
	"network_id": 33,
	"network_name": "默认账号112",
	"firm_adapters": [
	 {
		 "platform": 1,
		 "format": 0,
		 "adapter" : "com.topon"
	 },
	 {
		 "platform": 2,
		 "format": 1,
		 "adapter" : "com.topon"
	 }
	]
}'

返回样例：

{
    "nw_firm_id": 1000068,
     "nw_firm_name": "第555",
     "network_id": 33,
     "network_name": "默认账号112",
     "firm_adapters": [
         {
             "platform": 1,
             "format": 0,
             "adapter" : "com.topon"
         },
         {
             "platform": 2,
             "format": 1,
             "adapter" : "com.topon"
         }
     ]
 }

4. 获取自定义广告平台Publisher维度信息

4.1 请求URL

https://api.toponad.net/v1/custom_networks

4.2 请求方式

GET

4.3 请求参数

无

4.4 返回参数

4.5 样例

请求样例：

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

返回样例：

[
    {
        "nw_firm_id": 1000068,
         "nw_firm_name": "第555",
         "network_id": 33,
         "network_name": "默认账号112",
         "firm_adapters": [
             {
                 "platform": 1,
                 "format": 0,
                "adapter" : "com.topon"
             },
             {
                 "platform": 2,
                 "format": 1,
                 "adapter" : "com.topon"
             }
         ]
     },
     {
        "nw_firm_id": 1000069,
         "nw_firm_name": "第555",
         "network_id": 33,
         "network_name": "默认账号112",
         "firm_adapters": [
             {
                 "platform": 1,
                 "format": 0,
                "adapter" : "com.topon"
             },
             {
                 "platform": 2,
                 "format": 1,
                 "adapter" : "com.topon"
             }
         ]
     }
]

5. 绑定平台账号的APP维度参数

5.1 请求URL

https://api.toponad.net/v3/networks/app_auths

5.2 请求方式

POST

5.3 请求参数

5.4 返回参数

5.5 样例

请求样例：

curl --location --request POST 'https://api.toponad.net/v3/networks/app_auths' \
--header 'X-Up-Key: 877f8ae9c6e9ca82c0675b5fff594c373axxx' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1626161553000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "items" : [
        {
            "network_id" : 28574,
            "app_id" : "a644751967e00d",
            "app_auth_content": {

            }  
        },
        {
            "network_id" : 28574,
            "app_id" : "a644751f9f034c",
            "app_auth_content": {

            }  
        },
                {
            "network_id" : 28575,
            "app_id" : "a644751967e00d",
            "app_auth_content": {

            }  
        }      
    ]
}'

返回样例：

{

}