Channels API
The channel is a tool to gather multiple ad sources under one source that will be then connected with a template to create a tag. This also means the channel is the bridge between the ad sources and the ad auction.
1. Login
To log in - the general login API is used. Example - https://aniviewwiki.atlassian.net/wiki/spaces/HELP/pages/155975720/Reporting+API#Login-API
2. Logout
To log out - the general logout API is used. Example - https://aniviewwiki.atlassian.net/wiki/spaces/HELP/pages/155975720/Reporting+API#Logout-API
3. Channels entity API
3.1 Get Channels List
Retrieves a list of all Channels in the network.
Request URL:
https://manage.aniview.com/api/adserver/channel?format=json&expand={"publisher":true}&filter={"$and":[{"status":{"$in":[1]}},{"environment":{"$in":}}]}
Request Method:
GET
Status Code:
200 OK
Filtering Parameters (Optional):
Parameter | Description | Values |
|---|---|---|
status | advertiser status | Active:1, Archived:2 |
environment | environment type | Mobile Web : 1, Descktop: 2, In APP : 3, CTV : 4, Web : 5, INAPP/CTV:6 |
3.2 Create Channels
Request URL:
Request URL:
https://manage.aniview.com/api/adserver/channel?format=json
Request Method:
POST
Parameter | Description | Values |
|---|---|---|
name | Channel name | string |
optimized |
| boolean |
vpp | VPAID Player Priority | JS : 1, SWF : 2, JS Over MP4 : 3 |
fp |
|
|
environment |
| Mobile Web : 1, Descktop: 2, In APP : 3, CTV : 4, Web : 5, INAPP/CTV:6 |
syncChannel |
|
|
revShare | Revenue Share | true : 1, false : 0 |
sid | App/Site id |
|
minRpm |
|
|
interval |
|
|
maximp |
|
|
custom |
|
|
optModel | Optimization Model | “realtime“/”cb_regr”/”cb_clf”/”mlp_regr”/”mab_ucb” |
optModelV | Optimization Model Version | “v1“/”v2” |
publisher | Publisher ID |
|
maxrun |
|
|
Accounting object in the create request:
Parameter | Description | Values |
|---|---|---|
type |
| Fixed CPM:0, Rev Share:1 |
enabled |
|
|
value | The CPM/Rev Share value |
|
max |
|
|
cutModel |
|
|
IVT object in the create request:
Parameter | Description | Values |
|---|---|---|
prebid |
|
|
postbids |
|
|
Player settings object in the create request:
Parameter | Description | Values |
|---|---|---|
tagTimeout | Time the player waits until adsource finds ad |
|
optimizedTimeout |
|
|
maxRPM |
|
|
Ad source object in the create request:
Parameter | Description | Values |
|---|---|---|
priority |
| PRIORITY 1:1, PRIORITY 2:2,PRIORITY 3:3, VERIFIED:0 |
id |
| ad source id |
Request Example payload :
{
"name": "test123",
"fp": 3,
"environment": 1,
"adTxt": false,
"syncChannel": null,
"accounting": {
"type": 1,
"enabled": null,
"value": 2,
"max": null,
"cutModel": null
},
"optimized": true,
"revShare": 0,
"type": null,
"maxrun": null,
"sid": "61505e2cbc30de6ac2434a64",
"minRpm": 0,
"interval": null,
"maximp": null,
"custom": null,
"optModel": "realtime",
"optModelV": "v1",
"publisher": "61505e2cbc30de6ac2434a64",
"ivt": {
"prebid": null,
"postbids": []
},
"trackers": [
{
"e": "impression",
"url": "https://www.mako.co.il",
"t": 1,
"tsp": 100
}
],
"playerSettings": {
"tagTimeout": 20000,
"optimizedTimeout": false,
"maxRPM": 0,
"vpp": 1
},
"adSources": [
{
"priority": 1,
"id": "619e37a5cb292273663abeb7"
}
]
}3.3 Update Channel Properties
Request URL:
https://manage.aniview.com/api/adserver/channel/${Channel_Id}?format=json
Request Method:
PUT
Request Example payload:
Parameter | Description |
|---|---|
_id > $oid$o | Channel ID |
{
"_id": {
"$oid$o": "619fa8239cf366335221bae4"
},
"trackers": [
{
"e": "impression",
"url": "https://www.mako.co.il",
"t": 1,
"tsp": 100
}
]
}3.4. Delete Channel
Request URL:
Request URL: https://manage.aniview.com/api/adserver/channel/${Chanel_ID}?format=json
Request Method:
Delete
Status Code:
200 OK
Request Example payload:
Parameter | Description |
|---|---|
_id > $oid | Channel ID |
_id > adSources | Object containing adsources and priority |
{"_id":{"$oid":"6211f80558f94129955ab635"},"adSources":[{"id":"60eddbed496b092021128718","priority":"1"},{"id":"60eddbeb496b092021128716","priority":"1"}]}3.5. Get Channel properties (including associated ad sources)
Request URL:
Request URL: https://manage.aniview.com/api/adserver/channel/${Channel_ID}
Some ad sources may directly target domains/apps instead of targeting lists. To get those domains/apps, add &expand={"adSources": ["defaultDomain"]}, like:
https://manage.aniview.com/api/adserver/channel/${Channel_ID}?expand=%7B%22adSources%22%3A+%5B%22defaultDomain%22%5D%7D
Request Method:
Get
Status Code:
200 OK
3.6. Remove All Adsources in the Channel
Request URL:
Request URL: https://manage.aniview.com/api/adserver/channel/${Channel_ID}
Request Method:
PUT
Status Code:
200 OK
Request Example payload:
Parameter | Description |
|---|---|
_id > $oid | Channel ID |
_id > adSources | Should be an empty array |