Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagephp
{ Content-Type: application/json,
  X-Bamboo-Token: "yourAuthToken<your_Auth_Token>" }

body:

CTV denamd source, Without any targeting or budgeting.

...

CTV denamd source with budgeting.

if you want to add budgeting it is in the “cappings” object:

Code Block
languagephp
"cappings": {
    "impression": {
      "enabled": true,
      "rules": [
        {
          "frequency": 1,
          "sum": "1000",
          "servingMode": 1
        }
      ],
      "totalCompleted": 0,
      "dailyCompleted": 0
    },
    "completion": {
      "enabled": false,
      "rules": [],
      "totalCompleted": 0,
      "dailyCompleted": 0
    },
    "revenue": {
      "enabled": false,
      "rules": [],
      "totalCompleted": 0,
      "dailyCompleted": 0
    },
    "request": {
      "enabled": true,
      "rules": [
        {
          "frequency": 3,
          "sum": "10000",
          "servingMode": 1
        }
      ],
      "totalCompleted": 0,
      "dailyCompleted": 0
    },
    "frequency": {
      "enabled": false,
      "rules": [],
      "totalCompleted": 0
    }
  },
Info

AdSource API: for more information about the capping object you can see it here: https://aniviewwiki.atlassian.net/wiki/spaces/HELP/pages/2057699370/Ad+Source+API#3.3.-Create-Ad-Source

...

body:

Code Block
languagephp
{
  "cpm": 0,
  "playerSettings": {
    "tagTimeout": null,
    "optimizedTimeout": null,
    "maxRPM": null,
    "maxParallelBid": null
  },
  "description": null,
  "flight": {
    "isScheduled": false,
    "startDate": 1723123852,
    "endDate": 1723123852,
    "pViewValue": {
      "startDate": "2024-08-08T10:30:52.641Z",
      "endDate": "2024-08-08T10:30:52.641Z"
    }
  },
  "impressionCap": {
    "frequency": 4,
    "sum": 0,
    "totalCompleted": 0,
    "dailyCompleted": 0,
    "monthlyCompleted": 0
  },
  "completionCap": {
    "frequency": 4,
    "sum": 0,
    "totalCompleted": 0,
    "dailyCompleted": 0,
    "monthlyCompleted": 0,
    "servingMode": 1
  },
  "revenueCap": {
    "frequency": 4,
    "sum": 0,
    "totalCompleted": 0,
    "dailyCompleted": 0,
    "monthlyCompleted": 0,
    "servingMode": 1
  },
  "supplyImpressionCap": {
    "frequency": 4,
    "sum": 0,
    "totalCompleted": 0,
    "dailyCompleted": 0,
    "monthlyCompleted": 0,
    "servingMode": 1
  },
  "supplyCompletionCap": {
    "frequency": 4,
    "sum": 0,
    "totalCompleted": 0,
    "dailyCompleted": 0,
    "monthlyCompleted": 0,
    "servingMode": 1
  },
  "supplyRevenueCap": {
    "frequency": 4,
    "sum": 0,
    "totalCompleted": 0,
    "dailyCompleted": 0,
    "monthlyCompleted": 0,
    "servingMode": 1
  },
  "supplyRequestsPerDay": {
    "limit": 0,
    "hasLimit": false
  },
  "frequencyCap": {
    "sum": 0,
    "frequency": 4,
    "servingMode": 1
  },
  "supplyFrequencyCap": {
    "sum": 0,
    "frequency": 4,
    "servingMode": 1,
    "propagateToDemand": true
  },
  "cappings": {
    "impression": {
      "enabled": true,
      "rules": [
        {
          "frequency": 1,
          "sum": "1000",
          "servingMode": 1
        }
      ],
      "totalCompleted": 0,
      "dailyCompleted": 0
    },
    "completion": {
      "enabled": false,
      "rules": [],
      "totalCompleted": 0,
      "dailyCompleted": 0
    },
    "revenue": {
      "enabled": false,
      "rules": [],
      "totalCompleted": 0,
      "dailyCompleted": 0
    },
    "request": {
      "enabled": true,
      "rules": [
        {
          "frequency": 3,
          "sum": "10000",
          "servingMode": 1
        }
      ],
      "totalCompleted": 0,
      "dailyCompleted": 0
    },
    "frequency": {
      "enabled": false,
      "rules": [],
      "totalCompleted": 0
    }
  },
  "optimizationSettings": {
    "limit": 0,
    "minFr": 0.5,
    "timeFrame": 3,
    "hasLimit": false
  },
  "name": "Streamr.ai test",
  "provider": 999,
  "requestsPerDay": {
    "limit": 0,
    "hasLimit": false,
    "servingMode": 1
  },
  "servingMode": 1,
  "source": {
    "type": 9,
    "url": "https://www.exapmle.com",
    "clickThroughUrl": null,
    "mime": null,
    "bidder": null,
    "protocols": null,
    "at": null,
    "test": null,
    "timeout": null,
    "rtb": {},
    "tmax": null,
    "mimes": null,
    "frameworks": null,
    "placement": null,
    "floorPriceType": 1,
    "prioritizeFP": false,
    "prioritizeConnFP": false,
    "cookieSync": {
      "provider": "#null#"
    }
  },
  "status": 1,
  "targeting": {
    "bot": true,
    "customTargeting": [],
    "content": {},
    "geography": {
      "isCountryView": true,
      "inclusion": true,
      "excludeUnknownGeo": false,
      "list": []
    },
    "geographyCoor": {
      "inclusion": true,
      "list": []
    },
    "geographyZip": {
      "inclusion": true,
      "list": []
    },
    "placement": {
      "inclusion": true,
      "excludeUnknown": false
    },
    "dow": null,
    "adtxt": null,
    "domain": {
      "list": [],
      "inclusion": true
    },
    "device": null,
    "os": null,
    "deviceType": null,
    "tag": null,
    "playerSize": null,
    "targetPlatform": null,
    "idfa": {},
    "slot": null
  },
  "type": 1,
  "accounting": {
    "type": 1,
    "value": 0.7
  },
  "ivt": {},
  "publisherId": null,
  "origin": null,
  "platformLink": {
    "environment": 1,
    "platformID": null
  },
  "dTargeting": {},
  "trackers": [],
  "dTrackers": [],
  "fts": {
    "fta": []
  },
  "bo": {
    "frFloorOpt": {}
  },
  "creativeType": 1,
  "tpp": {
    "provider": null,
    "tppAsid": null,
    "tppRecordId": null,
    "tppChildNetwork": null
  },
  "ignoreNetworkConnectionFloorPrice": false,
  "ignorePartnerConnectionFloorPrice": false,
  "useAdvertiserTargeting": true,
  "thirdPartyCost": {
    "type": 0,
    "subtractionType": 1,
    "value": 70
  },
  "priceException": {
    "type": 0,
    "value": 70,
    "cutModel": 1
  },
  "ownerType": 1
}

...

Request URL:
https://manage.aniview.com/api/adserver/adsource/66b49e7dcaf21a06fd0e17d7?format=json

Request Method:
PUT

...

Code Block
languagephp
{ Content-Type: application/json,
  X-Bamboo-Token: "yourAuthToken<your_Auth_Token>" }
Info

...

AdSource API: if you want more information about the targeting object you can see it here: https://aniviewwiki.atlassian.net/wiki/spaces/HELP/pages/2057699370/Ad+Source+API#3.3.-Create-Ad-Source

Here is an example of adding targeting to existing

body:

Code Block
languagephp
{
  "_id": {
    "$oid": "66b49e7dcaf21a06fd0e17d7"
  },
  "id": null,
  "createdAt": 1723113085,
  "updatedAt": 1723113085,
  "iUpdatedAt": 1723113085,
  "createdBy": "atara@aniview.com",
  "updatedBy": "atara@aniview.com",
  "status": 1,
  "name": "Streamr.ai test",
  "description": null,
  "publisherId": "565c56d3181f46bd608b459a",
  "restoreFrom": null,
  "lastAuditTrailId": null,
  "cpm": 0,
  "useMappedValues": null,
  "useMappedCPM": null,
  "floorKey": null,
  "averageCpm": null,
  "cpr": null,
  "optimizedCpmSync": null,
  "fpOptimization": null,
  "haCpm": null,
  "flight": {
    "isScheduled": false,
    "startDate": 1723123852,
    "endDate": 1723123852,
    "pViewValue": {
      "startDate": "2024-08-08T10:30:52.000Z",
      "endDate": "2024-08-08T10:30:52.000Z"
    }
  },
  "servingMode": 1,
  "requestsPerDay": {
    "limit": 0,
    "hasLimit": false,
    "servingMode": 1,
    "frequency": null,
    "totalSent": 0,
    "lastDailyUpdate": 1723113086,
    "lastDailyInit": 1723113086,
    "advancedCappingRules": null
  },
  "optimizationSettings": {
    "hasLimit": false,
    "minFr": 0.5,
    "limit": 0,
    "timeFrame": 3,
    "denyRatio": null
  },
  "impressionCap": {
    "frequency": 4,
    "servingMode": null,
    "sum": 0,
    "lastDailyUpdate": 1723113086,
    "lastMonthlyUpdate": 1723113086,
    "lastDailyInit": 1723113086,
    "lastMonthlyInit": 1723113086,
    "totalCompleted": 0,
    "dailyCompleted": 0,
    "monthlyCompleted": 0,
    "advancedCappingRules": null,
    "propagateToDemand": null
  },
  "completionCap": {
    "sum": 0,
    "frequency": 4,
    "servingMode": 1,
    "totalCompleted": 0,
    "monthlyCompleted": 0,
    "dailyCompleted": 0,
    "advancedCappingRules": {
      "conditions": [],
      "conditionType": null
    }
  },
  "revenueCap": {
    "sum": 0,
    "frequency": 4,
    "servingMode": 1,
    "totalCompleted": 0,
    "monthlyCompleted": 0,
    "dailyCompleted": 0,
    "advancedCappingRules": {
      "conditions": [],
      "conditionType": null
    }
  },
  "targeting": {
    "domain": {
      "inclusion": true,
      "list": [],
      "excludeEmptyDomain": false
    },
    "geography": {
      "isCountryView": true,
      "inclusion": true,
      "excludeUnknownGeo": false,
      "list": [
        "US",
        "UA"
      ]
    },
    "geographyZip": {
      "inclusion": true,
      "list": []
    },
    "geographyCoor": {
      "inclusion": true,
      "list": []
    },
    "device": null,
    "os": null,
    "deviceType": null,
    "tag": null,
    "playerSize": null,
    "targetPlatform": null,
    "dow": null,
    "adtxt": null,
    "customRules": null,
    "idfa": [],
    "euConsent": null,
    "ccpa": null,
    "buyeruid": null,
    "euConsentRtb": null,
    "slot": null,
    "placement": {
      "inclusion": true,
      "excludeUnknown": false,
      "list": [
        "1",
        "3"
      ]
    },
    "customTargeting": [],
    "bot": true,
    "content": {
      "excludeSensitive": false
    }
  },
  "source": {
    "type": 9,
    "url": "https://www.exapmle.com",
    "clickThroughUrl": null,
    "platform": null,
    "platformId": null,
    "mode": null,
    "videos": null,
    "environment": null,
    "mimes": null,
    "frameworks": null,
    "bidder": null,
    "protocols": null,
    "at": null,
    "test": null,
    "tmax": null,
    "protoVersion": null,
    "placement": null,
    "iapd": null,
    "prebid": null,
    "prebidServer": null,
    "platformLink": null,
    "rtb": {
      "maxbitrate": null,
      "instl": null,
      "skip": null,
      "dnt": null,
      "pos": null,
      "rtbGap": null,
      "siteId": null,
      "tagId": null,
      "zoneId": null,
      "accountId": null,
      "sizeId": null,
      "playbackMethod": null,
      "provider": null,
      "providerPubId": null,
      "providerPubId2": null,
      "cookieSyncId": null,
      "tokens": null,
      "groupId": null,
      "custom": null,
      "privateAuction": null,
      "proxyRequest": null,
      "deals": null,
      "inventoryId": null,
      "maxDuration": null,
      "ext": null,
      "publisher": null,
      "rwdd": null
    },
    "plover": null,
    "cookieSync": {
      "provider": "#null#"
    },
    "floorPriceType": 1,
    "prioritizeFP": false,
    "prioritizeConnFP": false,
    "useAppSiteTitle": null,
    "adomain": null,
    "replace": null,
    "addAVKV": null
  },
  "provider": 999,
  "advertiserId": null,
  "ownerPublisherId": null,
  "useAdvertiserTargeting": true,
  "debug": null,
  "accountingFeeId": null,
  "type": 1,
  "fr": null,
  "playerSettings": {
 },
  "looptrackers": "#null#",
 [],
  "optimizedTimeoutflags": "#null#"null,
    "realACpmivt": "#null#",{
    "fpprebid": "#null#"null,
    "tagTimeoutpostbids": "#null#",[]
  },
  "maxRPMenvironment": "#null#"null,
 
  "gamMaxRPMoptData": "#null#"null,

   "vppdailyData": "#null#"null,
    "mipsfrequencyCap": "#null#",{
    "mrqsfrequency": "#null#"4,
    "wsecservingMode": "#null#"1,
    "noSslsum": "#null#"0,
    "vilastDailyUpdate": "#null#"null,
    "frvilastMonthlyUpdate": "#null#"null,
    "nclastDailyInit": "#null#"null,
    "sdk4lastMonthlyInit": "#null#"null,
    "opstotalCompleted": "#null#"null,
    "impCountOndailyCompleted": "#null#"null,
    "vitmonthlyCompleted": "#null#"null,
    "vibdadvancedCappingRules": "#null#"null,
    "vitdpropagateToDemand": null
"#null#",  },
  "prvitpp": "#null#",{
    "vpmtppId": "#null#"null,
    "cycleFreqprovider": "#null#"999,
    "timeSpansync": "#null#"null,
    "completionRatetppAsid": "#null#"null,
    "noCbtppRecordId": "#null#",
    "viewabilityThresholdlastSync": "#null#"null,
    "impwtstatus": "#null#"null,
    "impwcerrorReason": "#null#"null,
    "impwrtppChildNetwork": "#null#"null,
    "dealKVthirdPublisherId": null
"#null#",  },
  "dealVipriceException": "#null#",{
    "lidrtype": "#null#"0,
    "maxParallelBidenabled": "#null#"null,
    "fplyvalue": "#null#"70,
    "pxsecmax": "#null#"null,
    "flidrcutModel": 1
"#null#",  },
  "glisOno": null,
  "#null#ownerType": 1,
    "skipModethirdPartyCost": "#null#",{
    "skipTimertype": "#null#"0,
    "oPlcmtenabled": "#null#"null,
    "oMutevalue": "#null#"70,
  },   "trackerssubtractionType": [] 1
  },
  "flagspm": null,
  "ivtbo": {
    "prebids": null,
    "postbidsh": []null,
   },
  "environmentl": null,
    "optDatasv": null,
    "dailyDatahv": null,
    "frequencyCaplv": {null,
    "frequencyopd": 4null,
    "servingModefrFloorOpt": {
 1,     "sumpad": 0,null
    }
  },
  "lastDailyUpdateignoreNetworkConnectionFloorPrice": nullfalse,

   "lastMonthlyUpdateignoreFP": null,
 
  "lastDailyInitignorePartnerConnectionFloorPrice": nullfalse,
 
  "lastMonthlyInitblockingAttributes": null,
 
  "totalCompletedprp": null,

   "dailyCompletedfts": null,{
    "monthlyCompletedfta": null[],
    "advancedCappingRulesoverOpt": null,
    "propagateToDemanden": null
  },
  "tppcur": {null,
    "tppIdsapr": null"#null#",

   "providercappings": 999,{
    "syncimpression": {
 null,     "tppAsidenabled": nulltrue,
      "tppRecordIdtotalCompleted": ""0,
      "lastSyncdailyCompleted": null0,
      "statusrules": [
null,       "errorReason": null, {
    "tppChildNetwork": null,     "thirdPublisherIdfrequency": null
1,
 },   "priceException": {     "typeservingMode": 01,
    "enabled": null,     "valuesum": 70"1000",
    "max": null,     "cutModeladvancedCappingRules": 1null
        },
      "isOno": null,]
   "ownerType": 1},
    "thirdPartyCostcompletion": {
      "typeenabled": 0false,
      "enabledtotalCompleted": null0,
      "valuedailyCompleted": 700,
      "subtractionTyperules": []
 1   },
 
"pm": null,   "borevenue": {
      "senabled": nullfalse,
      "htotalCompleted": null0,
      "ldailyCompleted": null0,
      "svrules": null []
    },
    "hvrequest": {
 null,     "lvenabled": nulltrue,
      "opdtotalCompleted": null0,
      "frFloorOptdailyCompleted": {0,
      "padrules": [
null     }   },{
  "ignoreNetworkConnectionFloorPrice": false,   "ignoreFP": null,   "ignorePartnerConnectionFloorPricefrequency": false3,
  "blockingAttributes": null,   "prp": null,   "ftsservingMode": {1,
    "fta": [],     "overOptsum": null"10000",
    "en": null   },   "curadvancedCappingRules": null,
  "sapr": "#null#",   "cappings": { }
   "impression": {  ]
    "enabled": true,
},
     "totalCompletedfrequency": 0,{
      "dailyCompletedenabled": 0false,
      "rules": [],
      "totalCompleted": 0
{    }
   },
  "frequencycreativeType": 1,
  "dTargeting": {},
  "dTrackers": [],
  "servingModeaccounting": 1,{
    "type": 0,
    "sumvalue": "1000",70
  }
}

4.create Channel:

Request URL:
https://manage.aniview.com/api/adserver/adsource?format=json

Request Method:
POST

Headers:

Code Block
languagephp
{ Content-Type: application/json,
   X-Bamboo-Token: "advancedCappingRules": null
        }
      ]
    },
    "completion": {
 <your_Auth_Token>" }

body:

Code Block
languagephp
{
  "creativeType": 1,
  "type": 1,
  "name": "New Channel - Video",
  "optimized": true,
  "accounting": {
    "enabled": falsenull,

     "totalCompletedtype": 01,

     "dailyCompletedvalue": 0,
  },
   "rulesplayerSettings": []{
    }"tagTimeout": null,
    "revenueoptimizedTimeout": {
 null,
    "enabledmaxRPM": falsenull,
 
    "totalCompletedmaxParallelBid": 0,null
  }
}

response:

200 OK

Code Block
languagephp
{
  "dailyCompletedid": 0null,
  "_id": {
    "rules$oid": []
"66b4a6075167de7dcd004671"
   },
 
  "requestcreatedAt": {1723115015,
  "updatedAt": 1723115015,
  "enablediUpdatedAt": true1723115015,
  "createdBy": "atara@aniview.com",
  "totalCompletedupdatedBy": 0,
   "atara@aniview.com",
  "dailyCompletedstatus": 01,
  
   "rulesname": ["New Channel - Video",
  "description": null,
 { "publisherId": "565c56d3181f46bd608b459a",
    "restoreFrom": null,
   "frequencylastAuditTrailId": 3null,
   "instanceId": "565c56d3181f46bd608b459a",
  "optimized": true,
  "servingModeoptModel": 1null,
  "optModelV": null,
  "accounting": {
    "sumtype": "10000"1,
    "enabled": null,
    "value": 0,
    "advancedCappingRulesmax": null,
    "cutModel": null
  },
  "revShare": null,
  ]
"ivt": null,
  "fp": }null,
  "sid": null,
  "frequencynlasid": {null,
  "trackers": null,
  "enabledimpcoc": falsenull,
  "environment": null,
  "rulesadTxt": []true,
  "ovrdPbSchain": null,
  "totalCompletedovrdParSchain": 0null,
  "rmvParSchain": null,
}  "syncChannel": }null,
  "creativeTypetype": 1,
  "optData": null,
  "dTargetingpublisher": {}null,
  "dTrackersplayerSettings": [],
  "accountingmaxrun": {null,
  "maximp": null,
  "typeinterval": 0null,
  "custom": null,
  "valueminRpm": 70
  }
}

4.create Channel:

Request URL:
https://manage.aniview.com/api/adserver/adsource?format=json

Request Method:
POST

Headers:

Code Block
languagephp
{ Content-Type: application/json,
  X-Bamboo-Token: "yourAuthToken" }

body:

Code Block
languagephp
{
  "creativeType": 1null,
  "limitAdvertisers": null,
  "isSessionIdEnabled": null,
  "limitAdvertisersList": null,
  "typeadstxt": 1null,
  "nametimeoutMs": "Newnull,
Channel - Video"enableMbq": null,
  "optimizedmbq": truenull,
  "accountingenableInventoryPartnerDomain": {
 null,
  "enabledipd": null,
    "typeuseAppSiteIpd": 1null,

   "valueprp": 0
  }null,
  "playerSettingsisGam": {
 null,
  "tagTimeoutibv": null,
 
  "optimizedTimeoutibvPT": null,

   "maxRPMbo": null,
 
  "maxParallelBidab": null
,
 } }

response:

200 OK

Code Block
languagephp
{
  "id"adSources": null,
  "_idcreativeType": {1,
    "$oidoriginId": "66b4a6075167de7dcd004671"
  },
  "createdAtoperationType": 17231150151,
  "updatedAtprivate": 1723115015,
  "iUpdatedAt": 1723115015,
  "createdBy": "atara@aniview.com",
  "updatedBy": "atara@aniview.com",
  "status": 1,
  "name": "New Channel - Video",
  "description": null,
  "publisherId": "565c56d3181f46bd608b459a",
  "restoreFrom": null,
  "lastAuditTrailId": null,
  "instanceId": "565c56d3181f46bd608b459a",
  "optimized": true,
  "optModel": null,
  "optModelV": null,
  "accounting": {
    "type": 1,
    "enabled": null,
    "value": 0,
    "max": null,
    "cutModel": null
  },
  "revShare": null,
  "ivt": null,
  "fp": null,
  "sid": null,
  "nlasid": null,
  "trackers": null,
  "impcoc": null,
  "environment": null,
  "adTxt": true,
  "ovrdPbSchain": null,
  "ovrdParSchain": null,
  "rmvParSchain": null,
  "syncChannel": null,
  "type": 1,
  "optData": null,
  "publisher": null,
  "playerSettings": [],
  "maxrun": null,
  "maximp": null,
  "interval": null,
  "custom": null,
  "minRpm": null,
  "limitAdvertisers": null,
  "isSessionIdEnabled": null,
  "limitAdvertisersList": null,
  "adstxt": null,
  "timeoutMs": null,
  "enableMbq": null,
  "mbq": null,
  "enableInventoryPartnerDomain": null,
  "ipd": null,
  "useAppSiteIpd": null,
  "prp": null,
  "isGam": null,
  "ibv": null,
  "ibvPT": null,
  "bo": null,
  "ab": null,
  "adSources": null,
  "creativeType": 1,
  "originId": "66b4a6075167de7dcd004671",
  "operationType": 1,
  "private": false
}

5.Associate adsorce with channel:

Request URL:
https://manage.aniview.com/api/adserver/adsource?format=json

Request Method:
PUT

Headers:

Code Block
languagephp
{ Content-Type: application/json,
  X-Bamboo-Token: "yourAuthToken" }

body:

inside the adSources object you will add the id you got from the create ad source response

Code Block
languagephp
{
  "_id": {
    "$oid": "66b4a6075167de7dcd004671"
  },
  "fp": null,
  "environment": null,
  "type": 1,
  "creativeType": 1,
  "adSources": [
    {
      "id": "66b495171fabcdd581028849",
      "priority": "1"
    }
  ]
}

Response:

200 OK

Code Block
languagephp
{
    "data": {false
}
Info

Channels API: https://aniviewwiki.atlassian.net/wiki/spaces/HELP/pages/2044461057/Channels+API#3.2-Create-Channels

You can associate an AdSource directly when creating the channel with the adSources field

Code Block
languagejson
"adSources": [
    {
      "id": "66b495171fabcdd581028849",
      "priority": "1"
    }
]

5.Associate adsorce with channel:

Request URL:
https://manage.aniview.com/api/adserver/channel/66b47928e5f3ab42e003c5b4?format=json

Request Method:
PUT

Headers:

Code Block
languagephp
{ Content-Type: application/json,
  X-Bamboo-Token: "<your_Auth_Token>" }

body:

inside the adSources object you will add the id you got from the create ad source response

Code Block
languagephp
{
   "_id":{
      "$oid":"66b4a6075167de7dcd004671"
   },
   "adSources":[
      {
         "id":"66b495171fabcdd581028849",
         "priority":"0"
      }
   ]
}

Response:

200 OK

Code Block
languagephp
{
    "data": {
        "id": null,
        "_id": {
            "$oid": "66b4a6075167de7dcd004671"
        },
        "createdAt": 1723115015,
        "updatedAt": 1723124989,
        "iUpdatedAt": 1723124989,
        "createdBy": "atara@aniview.com",
        "updatedBy": "atara@aniview.com",
        "status": 1,
        "name": "New Channel - Video",
        "description": null,
        "publisherId": "565c56d3181f46bd608b459a",
        "restoreFrom": null,
        "lastAuditTrailId": null,
        "instanceId": "565c56d3181f46bd608b459a",
        "optimized": true,
        "optModel": null,
        "optModelV": null,
        "accounting": {
            "type": 1,
            "enabled": null,
            "value": 0,
            "max": null,
            "cutModel": null
        },
        "revShare": 0,
        "idivt": null, {
            "_idprebid": {null,
            "$oidpostbids": "66b4a6075167de7dcd004671"[]
        },
        "createdAtfp": 17231150150,
        "updatedAtsid": 1723124989null,
        "iUpdatedAtnlasid": 1723124989null,
        "createdBytrackers": "atara@aniview.com"[],
        "updatedByimpcoc": "atara@aniview.com"null,
        "statusenvironment": 1null,
        "nameadTxt": "Newtrue,
 Channel - Video"      "ovrdPbSchain": false,
        "descriptionovrdParSchain": nullfalse,
        "publisherIdrmvParSchain": "565c56d3181f46bd608b459a"false,
        "restoreFromsyncChannel": null,
        "lastAuditTrailIdtype": null1,
        "instanceIdoptData": "565c56d3181f46bd608b459a"null,
        "optimizedpublisher": truenull,
        "optModelplayerSettings": null[],
        "optModelVmaxrun": null,
        "accountingmaximp": {
   null,
        "typeinterval": 1null,
  
         "enabledcustom": null,
  
         "valueminRpm": 0,
            "maxlimitAdvertisers": nullfalse,
   
        "cutModelisSessionIdEnabled": nullfalse,
        }"limitAdvertisersList": null,
        "revShareadstxt": 0null,
        "ivttimeoutMs": {
   null,
        "prebidenableMbq": nullfalse,
  
         "postbidsmbq": []null,
        "enableInventoryPartnerDomain": }false,
        "fpipd": 0null,
        "siduseAppSiteIpd": nullfalse,
        "nlasidprp": {
   null,         "trackersprs": [],
            "impcocmm": null,
            "environmentcmm": null,
        "adTxt": true},
        "ovrdPbSchainisGam": falsenull,
        "ovrdParSchainibv": false,
        "rmvParSchainibvPT": falsenull,
        "syncChannelbo": null,
        "typeab": 1null,
        "optDataadSources": null,[
         "publisher": null,  {
      "playerSettings": [],         "maxrundata": {
 null,         "maximp": null,         "intervalid": null,
          "custom": null,         "minRpm_id": 0, {
              "limitAdvertisers": false,         "isSessionIdEnabled$oid": "66b495171fabcdd581028849"
false,         "limitAdvertisersList": null,         "adstxt": null},
          "timeoutMs": null,         "enableMbqcreatedAt": false1723110679,
        "mbq": null,            "enableInventoryPartnerDomainupdatedAt": false1723110679,
          "ipd": null,         "useAppSiteIpdiUpdatedAt": false1723110679,
 
      "prp": {             "prscreatedBy": []"atara@aniview.com",
            "mm": null,             "cmm": null"updatedBy": "atara@aniview.com",
           },         "isGamstatus": null1,
          "ibv": false,         "ibvPTname": null "Streamr.ai test",
        "bo": null,            "abdescription": null,
        "adSources": [            "publisherId": "565c56d3181f46bd608b459a",
   {                 "datarestoreFrom": {null,
                    "idlastAuditTrailId": null,
                    "_idcpm": {
   0,
                    "$oiduseMappedValues": "66b495171fabcdd581028849"null,
                    "useMappedCPM": }null,
                    "createdAtfloorKey": 1723110679null,
                    "updatedAtaverageCpm": 17231106790,
                    "iUpdatedAtcpr": 1723110679null,
                    "createdByoptimizedCpmSync": "atara@aniview.com"null,
                    "updatedByfpOptimization": "atara@aniview.com"null,
                    "statushaCpm": 1null,
                    "nameflight": "Streamr.ai test", {
                        "descriptionisScheduled": nullfalse,
                        "publisherIdstartDate": "565c56d3181f46bd608b459a",1723121460,
                        "restoreFromendDate": null1723121460,
                    "lastAuditTrailId": null,   "pViewValue": {
                "cpm": 0,             "startDate": "2024-08-08T09:51:00.363Z",
       "useMappedValues": null,                    "endDate": "useMappedCPM": null,2024-08-08T09:51:00.363Z"
                      "floorKey": null, }
                   "averageCpm": 0},
                    "cprservingMode": null1,
                    "optimizedCpmSyncrequestsPerDay": {
   null,                     "fpOptimizationlimit": null0,
                        "haCpmhasLimit": nullfalse,
                        "flightservingMode": {1,
                        "isScheduledfrequency": falsenull,
                        "startDatetotalSent": 17231214600,
                        "endDatelastDailyUpdate": 17231214601723110679,
                        "pViewValuelastDailyInit": {
   1723110679,
                        "startDateadvancedCappingRules": "2024-08-08T09:51:00.363Z",null
                    },
       "endDate": "2024-08-08T09:51:00.363Z"            "optimizationSettings": {
           }                "hasLimit": false,
    },                     "servingModeminFr": 1,0.5,
                        "requestsPerDaylimit": {0,
                        "limittimeFrame": 03,
                        "hasLimitdenyRatio": false,null
                        "servingMode": 1,
  },
                     "frequencyimpressionCap": null,{
                        "totalSentfrequency": 04,
                        "lastDailyUpdateservingMode": 1723110679null,
                        "lastDailyInitsum": 17231106790,
                        "advancedCappingRuleslastDailyUpdate": null1723110679,
                        "lastMonthlyUpdate": }1723110679,
                        "optimizationSettingslastDailyInit": {1723110679,
                        "hasLimitlastMonthlyInit": false1723110679,
                        "minFrtotalCompleted": 0.5,
                        "limitdailyCompleted": 0,
                        "timeFramemonthlyCompleted": 30,
                        "denyRatioadvancedCappingRules": null
   ,
                },                     "impressionCap"propagateToDemand": {null
                        "frequency": 4,
  },
                     "servingModecompletionCap": null,{
                        "sum": 0,
                        "lastDailyUpdatefrequency": 17231106794,
                        "lastMonthlyUpdateservingMode": 17231106791,
                        "lastDailyInittotalCompleted": 17231106790,
                        "lastMonthlyInitmonthlyCompleted": 17231106790,
                        "totalCompleteddailyCompleted": 0,
                        "dailyCompletedadvancedCappingRules": 0, {
                            "monthlyCompletedconditions": 0[],
                            "advancedCappingRulesconditionType": null,
                        "propagateToDemand": null}
                    },
                    "completionCaprevenueCap": {
                        "sum": 0,
                        "frequency": 4,
                        "servingMode": 1,
                        "totalCompleted": 0,
                        "monthlyCompleted": 0,
                        "dailyCompleted": 0,
                        "advancedCappingRules": {
                            "conditions": [],
                            "conditionType": null
                        }
                    },
                    "revenueCaptargeting": {
                        "sumdomain": 0, {
                            "frequencyinclusion": 4true,
                            "servingModelist": 1[],
                            "totalCompletedexcludeEmptyDomain": 0,false
                        "monthlyCompleted": 0},
                        "dailyCompletedgeography": 0, {
                            "advancedCappingRulesinclusion": {true,
                            "conditionslist": [],
                            "conditionTypeisCountryView": nulltrue,
                        }    "excludeUnknownGeo": false
               },         },
           "targeting": {            "geographyZip": {
                            "domaininclusion": {true,
                            "inclusionlist": true[],
                            "listisCountryView": []false,
                            "excludeEmptyDomainexcludeUnknownGeo": false
                        },
                        "geographygeographyCoor": {
                            "inclusion": true,
                            "list": [],
                            "isCountryView": truefalse,
                            "excludeUnknownGeo": false
                        },
                        "geographyZipdevice": {
   null,
                        "inclusionos": truenull,
   
                        "listdeviceType": [],
   null,
                        "isCountryViewtag": falsenull,
                            "excludeUnknownGeoplayerSize": null,
false                        "targetPlatform": }null,
                        "geographyCoordow": {
   null,
                        "inclusionadtxt": truenull,
  
                         "listcustomRules": []null,
  
                         "isCountryViewidfa": false[],
                            "excludeUnknownGeoeuConsent": null,
false                        "ccpa": }null,
                        "devicebuyeruid": null,
                        "oseuConsentRtb": null,
                        "deviceTypeslot": null,
                        "tagplacement": {
   null,                         "playerSizeinclusion": nulltrue,
                            "targetPlatformexcludeUnknown": null,false
                        "dow": null},
                        "adtxtcustomTargeting": null,
                        "customRulesbot": nulltrue,
                        "idfacontent": [],{
                            "euConsentexcludeSensitive": null,
                        "ccpa": null,}
                         "buyeruid": null,
   },
                    "euConsentRtbsource": null,{
                        "slottype": null2,
                        "placementurl": {
   "https:\/\/www.example.com",
                        "inclusionclickThroughUrl": truenull,
   
                        "excludeUnknownplatform": null,
false                        "platformId": }null,
                        "customTargetingmode": null,
                        "botvideos": truenull,
                        "contentenvironment": null,
{                        "mimes": null,
    "excludeSensitive": null                   "frameworks": null,
    }                    "bidder": }null,
                        "sourceprotocols": {null,
                        "typeat": 2null,
                        "urltest": "https:\/\/www.example.com"null,
                        "clickThroughUrltmax": null,
                        "platformprotoVersion": null,
                        "platformIdplacement": null,
                        "modeiapd": null,
                        "videosprebid": null,
                        "environmentprebidServer": null,
                        "mimesplatformLink": null,
                        "frameworksrtb": null, {
                            "biddermaxbitrate": null,
                            "protocolsinstl": null,
                            "atskip": null,
                            "testdnt": null,
                            "tmaxpos": null,
                        "protoVersion    "rtbGap": null,
                            "placementsiteId": null,
                            "iapdtagId": null,
                            "prebidzoneId": null,
                            "prebidServeraccountId": null,
                            "platformLinksizeId": null,
                            "rtbplaybackMethod": {null,
                            "maxbitrateprovider": null,
                            "instlproviderPubId": null,
                            "skipproviderPubId2": null,
                            "dntcookieSyncId": null,
                            "postokens": null,
                            "rtbGapgroupId": null,
                            "siteIdcustom": null,
                            "tagIdprivateAuction": null,
                            "zoneIdproxyRequest": null,
                            "accountIddeals": null,
                            "sizeIdinventoryId": null,
                            "playbackMethodmaxDuration": null,
                            "providerext": null,
                            "providerPubIdpublisher": null,
                            "providerPubId2rwdd": null,
                            "cookieSyncId": null},
                            "tokensplover": null,
   
                        "groupIdcookieSync": null,
   
                        "customfloorPriceType": null1,
  
                         "privateAuctionprioritizeFP": nullfalse,

                           "proxyRequestprioritizeConnFP": nullfalse,
   
                        "dealsuseAppSiteTitle": null,
                            "inventoryIdadomain": null,
                            "maxDurationreplace": null,
   
                        "extaddAVKV": null,
                        "gamParams": null
    "publisher": null,               },
             "rwdd": null      "provider": 999,
                 },   "advertiserId": null,
                    "ploverownerPublisherId": null,
                        "cookieSync": null,
   "useAdvertiserTargeting": true,
                    "floorPriceTypedebug": 1null,
   
                    "prioritizeFPaccountingFeeId": falsenull,
  
                     "prioritizeConnFPtype": false1,

                       "useAppSiteTitlefr": null,

                       "adomainplayerSettings": null,{
                        "replaceloop": null,
                        "addAVKVoptimizedTimeout": null,
                        "gamParamsrealACpm": null,
                        "fp": }null,
                        "providertagTimeout": 999null,
                        "advertiserIdmaxRPM": null,
                        "ownerPublisherIdgamMaxRPM": null,
                        "useAdvertiserTargetingvpp": truenull,
                        "debugmips": null,
                        "accountingFeeIdmrqs": null,
                        "typewsec": 1null,
                        "frnoSsl": null,
                        "playerSettingsvi": {null,
                        "loopfrvi": null,
                        "optimizedTimeoutnc": null,
                        "realACpmsdk4": null,
                        "fpops": null,
                        "tagTimeoutimpCountOn": null,
                        "maxRPMvit": null,
                        "gamMaxRPMvibd": null,
                        "vppvitd": null,
                        "mipsprvi": null,
                        "mrqsvpm": null,
                        "wseccycleFreq": null,
                        "noSsltimeSpan": null,
                        "vicompletionRate": null,
                        "frvinoCb": null,
                        "ncviewabilityThreshold": null,
                        "sdk4impwt": null,
                        "opsimpwc": null,
                        "impCountOnimpwr": null,
                        "vitdealKV": null,
                        "vibddealVi": null,
                        "vitdlidr": null,
                        "prvimaxParallelBid": null,
                        "vpmfply": null,
                        "cycleFreqpxsec": null,
                        "timeSpanflidr": null,
                        "completionRategl": null,
                        "noCbskipMode": null,
                        "viewabilityThresholdskipTimer": null,
                        "impwtoPlcmt": null,
                        "impwcoMute": null,
                    },
                    "impwrtrackers": null,
   [],
                    "dealKVflags": null,
 
                      "dealViivt": null,{
                        "lidrprebid": null,
                        "maxParallelBidpostbids": null,[]
                        "fply": null,
  },
                     "pxsecenvironment": null,
  
                     "flidroptData": null,
  
                     "gldailyData": null,
  
                     "skipModefrequencyCap": null,{
                        "skipTimerfrequency": null4,
                        "oPlcmtservingMode": null1,
                        "oMutesum": 0,
    null                    "lastDailyUpdate": }null,
                        "trackerslastMonthlyUpdate": [],null,
                        "flagslastDailyInit": null,
                        "ivtlastMonthlyInit": {null,
                        "prebidtotalCompleted": null,
                        "postbidsdailyCompleted": [] null,
                        "monthlyCompleted": }null,
                        "environmentadvancedCappingRules": null,
                        "optDatapropagateToDemand": null,
                    "dailyData": null},
                    "frequencyCaptpp": {
                        "frequencytppId": 4null,
                        "servingModeprovider": 1null,
                        "sumsync": 0null,
                        "lastDailyUpdatetppAsid": null,
                        "lastMonthlyUpdatetppRecordId": null"",
                        "lastDailyInitlastSync": null,
                        "lastMonthlyInitstatus": null,
                        "totalCompletederrorReason": null,
                        "dailyCompletedtppChildNetwork": null,
                        "monthlyCompletedthirdPublisherId": null,
                    },
   "advancedCappingRules": null,                "priceException": {
       "propagateToDemand": null                "type": 0,
   },                     "tppenabled": {null,
                        "tppIdvalue": null70,
                        "providermax": null,
                        "synccutModel": null, 1
                    },
                    "tppAsidisOno": null,
                        "tppRecordIdownerType": "",
   1,
                    "lastSyncthirdPartyCost": null,{
                        "statustype": null0,
                        "errorReasonenabled": null,
                        "tppChildNetworkvalue": null70,
                        "thirdPublisherIdsubtractionType": null1
                    },
                    "priceExceptionpm": {null,
                        "typebo": 0,{
                        "enableds": null,
                        "valueh": 70null,
                        "maxl": null,
                        "cutModelsv": null,
    1                    "hv": }null,
                        "isOnolv": null,
                        "ownerTypeopd": 1null,
                        "thirdPartyCostfrFloorOpt": {
                            "typepad": 0,null
                        "enabled": null,}
                    },
                    "valueignoreNetworkConnectionFloorPrice": 70false,

                       "subtractionTypeignoreFP": null,
1                    "ignorePartnerConnectionFloorPrice": }false,
                    "pmblockingAttributes": null,
                    "boprp": {
   null,
                    "sfts": null,{
                        "hfta": null[],
                        "loverOpt": null,
                        "sven": null,
                        "hv": null,
   },
                    "lvcur": null,

                       "opdsapr": null,

                       "frFloorOptcappings": {
  
                         "padimpression": null{
                        }    "enabled": false,
               },             "totalCompleted": 0,
      "ignoreNetworkConnectionFloorPrice": false,                     "ignoreFPdailyCompleted": null0,
                    "ignorePartnerConnectionFloorPrice": false,               "rules": []
     "blockingAttributes": null,                  },
  "prp": null,                     "ftscompletion": {
                            "ftaenabled": []false,
                            "overOpttotalCompleted": null0,
                            "endailyCompleted": null0,
                    },                     "cur"rules": null,[]
                    "sapr": null,                     "cappings": {},
                        "impressionrevenue": {
                            "enabled": false,
                            "totalCompleted": 0,
                            "dailyCompleted": 0,
                            "rules": []
                        },
                        "completionrequest": {
                            "enabled": false,
                            "totalCompleted": 0,
                            "dailyCompleted": 0,
                            "rules": []
                        },
                        "revenuefrequency": {
                            "enabled": false,
                            "totalCompletedrules": 0,[]
                        }
   "dailyCompleted": 0,                },
            "rules": []       "creativeType": 1,
                },    "analytics": {
                   "request":  {   "bid": 0,
                        "enabledrevenue": false0,
  
                         "totalCompletedrequest": 0,
  
                         "dailyCompletedimpression": 0,
  
                         "rulesncpm": []0,
                        }"rpm": 0,
                        "frequencybidRate": 0,
{                        "fillRate": 0
   "enabled": false,                }
            "rules": []   },
                "priority": 1,
    }            "id": "66b495171fabcdd581028849"
       },     }
        ],
        "creativeType": 1,
                    "analytics": {
                        "bid": 0,
                        "revenue": 0,
                        "request": 0,
                        "impression": 0,
                        "ncpm": 0,
                        "rpm": 0,
                        "bidRate": 0,
                        "fillRate": 0
                    }
                },
                "priority": 1,
                "id": "66b495171fabcdd581028849"
            }
        ],
        "creativeType": 1
    }
}}
}


6.Get VAST for testing:

Use this template to get the VAST for testing in .

In the avAV_publisher PUBLISHERID query parameter you will your Aniview Account ID.

In the AV_CHANNELID query parameter please put the account id that will be
provided to you, and in av_channel put the channel id from the channel call response.

...

channel id from the channel call response in step 4/5.

To learn more about the macros you can visit here: Macros

...

https://manage.aniview.com/api/adserver/stats/report?format=json&asFile=false&async=true&reportFormat=json&reportJsonSave=true&utcTime=true&reportOrigin=false&id=null&returnReport=false&runAsAsync=false&s=1723122450903&generateOrigin=ui-summary&dimensions=&metrics=inventory,request,bid,impression,revenue,totalCost&query=%7B%7D&startDate=1723075200&endDate=1723161599&tzo=0&collection=false&igq=false&drm=false&cb=false&includeHeaders=true&selectedDb=false&type=1&schedulingType=today&schedulingDateRangeValue=null

  • startDate: Required - Linux date, UNIX Timestamp, of the start time of the report The following link can be used for the date conversion - https://www.epochconverter.com/

  • endDate: Required parameters - Linux date, UNIX Timestamp, of the start and end time of the report
    The following link can be used for the date conversion - https://www.epochconverter.com/

  • tzo: Optional - 2 : Time zone offset in hours (optional)

  • type: X (optional) - by default it’s Ad Server report (1)

  • from UTC. Reports are generated in UTC timezone.

  • dimensions: list of dimensions separated with an encoded comma (“,”) - you can use an encoder like https://meyerweb.com/eric/tools/dencoder/

  • metrics: list of metrics separated with an encoded comma (“,”) - you can use an encoder like https://meyerweb.com/eric/tools/dencoder/

  • format: csv or json

  • query: HTML encoded query filter - you can use an encoder like https://meyerweb.com/eric/tools/dencoder/
    Sample query (before encoding): &query={"ncid":{"$in":[Vb9fea5181f46d4388b5555"]}}
    In this sample, it filters the report to include data only from the specified network channel

To read more about all the metrics and dimension and the call in general visit: Reporting API

Request Method:
POSTGET

Headers:

Code Block
languagephp
{ Content-Type: application/json,
  X-Bamboo-Token: "yourAuthToken<your_Auth_Token>" }

Response:

200 OK

  • Use the link in reportUrl to download the csv report file.

...