...
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 :
...
Request Method:
PUT
Request Example payload:
Parameter | Description |
|---|---|
_id > $oid$o | Channel ID |
| Code Block |
|---|
{
"_id": {
"$oid$o": "619fa8239cf366335221bae4"
},
"trackers": [
{
"e": "impression",
"url": "https://www.mako.co.il",
"t": 1,
"tsp": 100
}
]
} |
...
Status Code:
200 OK
Request Example payload:
Parameter | Description |
|---|---|
_id > $oid | Channel ID |
_id > adSources | Object containing adsources and priority |
| Code Block |
|---|
{"_id":{"$oid":"6211f80558f94129955ab635"},"adSources":[{"id":"60eddbed496b092021128718","priority":"1"},{"id":"60eddbeb496b092021128716","priority":"1"}]} |
...
Status Code:
200 OK
Request Example payload:
Parameter | Description |
|---|---|
_id > $oid | Channel ID |
_id > adSources | Should be an empty array |
| Code Block |
|---|
{"_id":{"$oid":"6211f80558f94129955ab635"},"adSources":[]} |
3.7 Bulk Add Adsources to the Channel
Request URL:
https://manage.aniview.com/api/adserver/channel/{channel_id}?format=json&expand=%7B%22prp%22:true,%22publisher%22:true,%22ibvPT%22:true,%22adUnits%22:true,%22adSources%22:%5B%22cap%22,%22analytics%22,%22advertiserId%22,%22averageCpm%22%5D%7D
In {channel_id} put the channel id you want to add adsources to.
Request Method:
PUT
Headers:
| Code Block | ||
|---|---|---|
| ||
{ Content-Type: application/json,
X-Bamboo-Token: "<your_Auth_Token>" } |
Body:
Inside the adSources put all the ad sources id you want to bulk add, like so:
| Code Block | ||
|---|---|---|
| ||
{
"_id": {
"$oid": "66c32c5d7d7c3914df0c3434"
},
"fp": null,
"environment": null,
"type": 1,
"creativeType": 1,
"adSources": [
{
"id": "667bb6e1bbd4fec0e705f32c",
"priority": "0"
},
{
"id": "66c49dc58b1fd0f7260acf15",
"priority": "0"
},
{
"id": "66b60c65d401fd65f908de84",
"priority": "0"
},
{
"id": "66b49b6f18153aa7ee0a0f11",
"priority": "0"
},
{
"id": "66b499d54a48a6e4ae009b7b",
"priority": "0"
}
]
} |
Response:
200 OK