Placement API

1. Batch Create And Update Placements

1.1 Request URL

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

1.2 Request method

POST

1.3 Request params

params	type	required	notes
count	Int	Y	Quantity of created placements
app_id	String	Y	APP ID of created placements
placements.placement_name	String	Y	Placement name. max length 30
placements.placement_id	String	N	Placement id (Incoming when modified)
placements.adformat	String	Y	Native,banner,rewarded_video,interstitial,splash
placements.template	Int	N	Configurations for native ads: 0: standard 1: Native Banner 2: Native Splash
placements.template.cdt	Int	N	Template is Native Splash: countdown time, default 5s
placements.template.ski_swt	Int	N	Template is Native Splash: it can skipped or not, it could be skipped by default. 0: No 1: Yes
placements.template.aut_swt	Int	N	Template is Native Splash: it can be auto closed or not, it could be auto closed by default. 0: No 1: Yes
placements.template.auto_refresh_time	Int	N	Template is Native Banner: it can be auto refreshed or not, it could not be auto refreshed by default -1: no auto refresh 0-n: auto refresh time (s)
remark	String	N	Remarks information
status	Int	N	Placement's status

1.4 Return data

fields	type	required	notes
app_id	String	Y	App ID
placement_name	String	Y	Placement name
placement_id	String	Y	Placement ID
adformat	String	Y	Native, banner, rewarded video, interstitial, splash
placements.template	Int	N	Configurations for native ads: 0: standard 1: Native Banner 2: Native Splash
placements.template.cdt	Int	N	Template is Native Splash: countdown time, default 5s
placements.template.ski_swt	Int	N	Template is Native Splash: it can skipped or not, it could be skipped by default. 0: No 1: Yes
placements.template.aut_swt	Int	N	Template is Native Splash: it can be auto closed or not, it could be auto closed by default. 0: No 1: Yes
placements.template.auto_refresh_time	Int	N	Template is Native Banner: it can be auto refreshed or not, it could not be auto refreshed by default -1 no auto refresh 0-n auto refresh time (s)
remark	String	N	Remarks information
status	Int	N	Placement's status

1.5 Sample

Request sample:

{
    "count": 1,
    "app_id": "a5c41a9ed1679c",
    "placements": [
        {
            "placement_name": "6",
            "adformat": "native",
            "remark": "remark",
            "template":2,
            "template_extra":{
                "cdt":55,
                "ski_swt":1,
                "aut_swt":1
            }

        }

    ]
}

Return sample:

[
    {
        "app_name": "test1",
        "app_id": "a5c41a9ed1679c",
        "platform": 2,
        "placement_id": "b1bv57tielnlts",
        "placement_name": "6",
        "adformat": "native",
        "remark": "remark",
        "template": 2,
        "template_extra": {
            "cdt": 55,
            "ski_swt": 1,
            "aut_swt": 1
        }
    }
]

2. Get Placement List

2.1 Request URL

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

2.2 Request method

POST

2.3 Request params

params	type	required	notes
app_ids	Array[String]	N	eg: ["abc", "acc"]
placement_ids	Array[String]	N	eg: ["abc", "acc"]
start	Int	N	Default 0 (Not required when both app and ad slot are specified)
limit	Int	N	Default 100 (Not required when both app and ad slot are specified)

2.4 Return data

fields	type	required	notes
app_id	String	Y	App ID
app_name	String	Y	App name
platform	Int	Y	1 or 2 (1: android,2: IOS)
placement_id	String	N	-
placement_name	String	N	-
adformat	String	N	-
placements.template	Int	N	Configurations for native ads: 0: standard 1: Native Banner 2: Native Splash
placements.template.cdt	Int	N	Template is Native Splash: countdown time, default 5s
placements.template.ski_swt	Int	N	Template is Native Splash: it can skipped or not, it could be skipped by default. 0: No 1: Yes
placements.template.aut_swt	Int	N	Template is Native Splash: it can be auto closed or not, it could be auto closed by default. 0: No 1: Yes
placements.template.auto_refresh_time	Int	N	Template is Native Banner: it can be auto refreshed or not, it could not be auto refreshed by default -1 no auto refresh 0-n auto refresh time (s)
remark	String	N	Remarks information
status	Int	N	Placement's status

2.5 Sample

Request sample:

{
    "placement_ids":["b5bc9bc2951216"]
}

Return sample:

[
    {
        "app_name": "topontest",
        "app_id": "a5bc9921f7fdb4",
        "platform": 2,
        "placement_id": "b5bc9bc2951216",
        "placement_name": "topontest_rewardvideo",
        "adformat": "rewarded_video"
    }
]

3. Batch Delete Placemens

3.1 Request URL

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

3.2 Request method

POST

3.3 Request params

params	type	required	notes
placement_ids	Array[String]	Y	eg: ["abc", "acc"]

3.4 Return data

fields	type	required	notes
msg	String	N	-

3.5 Sample

Request sample:

{
    "placement_ids":["b5bc9bc2951216"]
}

Return sample:

{
    "msg": "suc"
}