Page Comparison

Table of Contents

minLevel	1
maxLevel	6
outline	false
style	disc
type	list
printable	true

To log in - the general login API is used. Example - Login API

this step is for getting a Token to add to the request header for Authentication reasons.

2. Create

...

Ad Source:

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

...

Code Block

language	php

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

body:

CTV denamd source, Without any targeting or budgeting.

Code Block

language	php

{
  "cpm": 0,
  "playerSettings": {
    "tagTimeout": null,
    "optimizedTimeout": null,
    "maxRPM": null,
    "maxParallelBid": null
  },
  "description": null,
  "flight": {
    "isScheduled": false,
    "startDate": 1723134222,
    "endDate": 1723134222,
    "pViewValue": {
      "startDate": "2024-08-08T13:23:42.782Z",
      "endDate": "2024-08-08T13:23:42.782Z"
    }
  },
  "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": false,
      "rules": [],
      "totalCompleted": 0,
      "dailyCompleted": 0
    },
    "completion": {
      "enabled": false,
      "rules": [],
      "totalCompleted": 0,
      "dailyCompleted": 0
    },
    "revenue": {
      "enabled": false,
      "rules": [],
      "totalCompleted": 0,
      "dailyCompleted": 0
    },
    "request": {
      "enabled": false,
      "rules": [],
      "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.example.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
}

...

Code Block

language	php

{
    "data": {
        "id": null,
        "_id": {
            "$oid": "66b4c855efa3f0e54d032025"
        },
        "createdAt": 1723123797,
        "updatedAt": 1723123797,
        "iUpdatedAt": 1723123797,
        "createdBy": "xxx@aniview.com",
        "updatedBy": "xxx@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": 1723134222,
            "endDate": 1723134222,
            "pViewValue": {
                "startDate": "2024-08-08T13:23:42.782Z",
                "endDate": "2024-08-08T13:23:42.782Z"
            }
        },
        "servingMode": 1,
        "requestsPerDay": {
            "limit": 0,
            "hasLimit": false,
            "servingMode": 1,
            "frequency": null,
            "totalSent": 0,
            "lastDailyUpdate": 1723123798,
            "lastDailyInit": 1723123798,
            "advancedCappingRules": null
        },
        "optimizationSettings": {
            "hasLimit": false,
            "minFr": 0.5,
            "limit": 0,
            "timeFrame": 3,
            "denyRatio": null
        },
        "impressionCap": {
            "frequency": 4,
            "servingMode": null,
            "sum": 0,
            "lastDailyUpdate": 1723123798,
            "lastMonthlyUpdate": 1723123798,
            "lastDailyInit": 1723123798,
            "lastMonthlyInit": 1723123798,
            "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": {
                "inclusion": true,
                "list": [],
                "isCountryView": true,
                "excludeUnknownGeo": false
            },
            "geographyZip": {
                "inclusion": true,
                "list": [],
                "isCountryView": false,
                "excludeUnknownGeo": false
            },
            "geographyCoor": {
                "inclusion": true,
                "list": [],
                "isCountryView": false,
                "excludeUnknownGeo": false
            },
            "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
            },
            "customTargeting": null,
            "bot": true,
            "content": {
                "excludeSensitive": null
            }
        },
        "source": {
            "type": 9,
            "url": "https:\/\/www.example.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": null,
            "floorPriceType": 1,
            "prioritizeFP": false,
            "prioritizeConnFP": false,
            "useAppSiteTitle": null,
            "adomain": null,
            "replace": null,
            "addAVKV": null,
            "gamParams": null
        },
        "provider": 999,
        "advertiserId": null,
        "ownerPublisherId": null,
        "useAdvertiserTargeting": true,
        "debug": null,
        "accountingFeeId": null,
        "type": 1,
        "fr": null,
        "playerSettings": {
            "loop": null,
            "optimizedTimeout": null,
            "realACpm": null,
            "fp": null,
            "tagTimeout": null,
            "maxRPM": null,
            "gamMaxRPM": null,
            "vpp": null,
            "mips": null,
            "mrqs": null,
            "wsec": null,
            "noSsl": null,
            "vi": null,
            "frvi": null,
            "nc": null,
            "sdk4": null,
            "ops": null,
            "impCountOn": null,
            "vit": null,
            "vibd": null,
            "vitd": null,
            "prvi": null,
            "vpm": null,
            "cycleFreq": null,
            "timeSpan": null,
            "completionRate": null,
            "noCb": null,
            "viewabilityThreshold": null,
            "impwt": null,
            "impwc": null,
            "impwr": null,
            "dealKV": null,
            "dealVi": null,
            "lidr": null,
            "maxParallelBid": null,
            "fply": null,
            "pxsec": null,
            "flidr": null,
            "gl": null,
            "skipMode": null,
            "skipTimer": null,
            "oPlcmt": null,
            "oMute": null
        },
        "trackers": [],
        "flags": null,
        "ivt": {
            "prebid": null,
            "postbids": []
        },
        "environment": null,
        "optData": null,
        "dailyData": null,
        "frequencyCap": {
            "frequency": 4,
            "servingMode": 1,
            "sum": 0,
            "lastDailyUpdate": null,
            "lastMonthlyUpdate": null,
            "lastDailyInit": null,
            "lastMonthlyInit": null,
            "totalCompleted": null,
            "dailyCompleted": null,
            "monthlyCompleted": null,
            "advancedCappingRules": null,
            "propagateToDemand": null
        },
        "tpp": {
            "tppId": null,
            "provider": null,
            "sync": null,
            "tppAsid": null,
            "tppRecordId": "",
            "lastSync": null,
            "status": null,
            "errorReason": null,
            "tppChildNetwork": null,
            "thirdPublisherId": null
        },
        "priceException": {
            "type": 0,
            "enabled": null,
            "value": 70,
            "max": null,
            "cutModel": 1
        },
        "isOno": null,
        "ownerType": 1,
        "thirdPartyCost": {
            "type": 0,
            "enabled": null,
            "value": 70,
            "subtractionType": 1
        },
        "pm": null,
        "bo": {
            "s": null,
            "h": null,
            "l": null,
            "sv": null,
            "hv": null,
            "lv": null,
            "opd": null,
            "frFloorOpt": {
                "pad": null
            }
        },
        "ignoreNetworkConnectionFloorPrice": false,
        "ignoreFP": null,
        "ignorePartnerConnectionFloorPrice": false,
        "blockingAttributes": null,
        "prp": null,
        "fts": {
            "fta": [],
            "overOpt": null,
            "en": null
        },
        "cur": null,
        "sapr": null,
        "cappings": {
            "impression": {
                "enabled": false,
                "totalCompleted": 0,
                "dailyCompleted": 0,
                "rules": []
            },
            "completion": {
                "enabled": false,
                "totalCompleted": 0,
                "dailyCompleted": 0,
                "rules": []
            },
            "revenue": {
                "enabled": false,
                "totalCompleted": 0,
                "dailyCompleted": 0,
                "rules": []
            },
            "request": {
                "enabled": false,
                "totalCompleted": 0,
                "dailyCompleted": 0,
                "rules": []
            },
            "frequency": {
                "enabled": false,
                "rules": []
            }
        },
        "creativeType": 1,
        "originId": "66b4c855efa3f0e54d032025",
        "operationType": 1,
        "private": false
    }
}

CTV denamd source with budgeting.

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

Code Block

language	php

"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

language	php

{
  "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
}

3. Edit

...

Ad Source:

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

Request Method:
PUT

...

Code Block

language	php

{ 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

language	php

{
  "_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": {},
  "trackers": [],
  "loopflags": "#null#"null,
    "optimizedTimeoutivt": "#null#",{
    "realACpmprebid": "#null#"null,
    "fppostbids": "#null#",[]
  },
  "tagTimeoutenvironment": "#null#"null,

   "maxRPMoptData": "#null#"null,
 
  "gamMaxRPMdailyData": "#null#"null,
 
  "vppfrequencyCap": "#null#",{
    "mipsfrequency": "#null#"4,
    "mrqsservingMode": "#null#"1,
    "wsecsum": "#null#"0,
    "noSsllastDailyUpdate": "#null#"null,
    "vilastMonthlyUpdate": "#null#"null,
    "frvilastDailyInit": "#null#"null,
    "nclastMonthlyInit": "#null#"null,
    "sdk4totalCompleted": "#null#"null,
    "opsdailyCompleted": "#null#"null,
    "impCountOnmonthlyCompleted": "#null#"null,
    "vitadvancedCappingRules": "#null#"null,
    "vibdpropagateToDemand": null
"#null#",  },
  "vitdtpp": "#null#",{
    "prvitppId": "#null#"null,
    "vpmprovider": "#null#"999,
    "cycleFreqsync": "#null#"null,
    "timeSpantppAsid": "#null#"null,
    "completionRatetppRecordId": "#null#",
    "noCblastSync": "#null#"null,
    "viewabilityThresholdstatus": "#null#"null,
    "impwterrorReason": "#null#"null,
    "impwctppChildNetwork": "#null#"null,
    "impwrthirdPublisherId": "#null#",null
  },
  "dealKVpriceException": "#null#",{
    "dealVitype": "#null#"0,
    "lidrenabled": "#null#"null,
    "maxParallelBidvalue": "#null#"70,
    "fplymax": "#null#"null,
    "pxseccutModel": "#null#",1
  },
  "flidrisOno": "#null#"null,
 
  "glownerType": "#null#"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": null1,
  },   "priceException": {     "typeservingMode": 01,
    "enabled": null,     "valuesum": 70"1000",
    "max": null,     "cutModeladvancedCappingRules": null
     1   },
      "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,   "ignoreFPfrequency": null3,
  "ignorePartnerConnectionFloorPrice": false,   "blockingAttributes": null,   "prpservingMode": null1,
  "fts": {        "ftasum": []"10000",
    "overOpt": null,     "enadvancedCappingRules": null
  },    "cur": null, }
 "sapr": "#null#",   "cappings": {]
    "impression": {
 },
    "enabledfrequency": true,{
      "totalCompletedenabled": 0false,
      "dailyCompletedrules": 0[],
      "rulestotalCompleted": [0
    }
  },
{  "creativeType": 1,
  "dTargeting": {},
   "frequencydTrackers": 1[],
  "accounting":  {
     "servingModetype": 10,
    "value": 70
  }
 "sum": "1000"}

4. Create Channel:

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

Request Method:
POST

Headers:

Code Block

language	php

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

body:

Code Block

language	php

{
    "advancedCappingRulescreativeType": null1,
  "type": 1,
  "name": "New }Channel - Video",
    ]
    },
 "optimized": true,
  "completionaccounting": {
 
    "enabled": falsenull,

     "totalCompletedtype": 01,

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

response:

200 OK

Code Block

language	php

{
  "dailyCompletedid": 0null,
  "_id": {
    "rules$oid": []
"66b4a6075167de7dcd004671"
   },
 
  "requestcreatedAt": {1723115015,
  "updatedAt": 1723115015,
  "enablediUpdatedAt": true1723115015,
  "createdBy": "atara@aniview.com",
  "totalCompletedupdatedBy": 0"atara@aniview.com",
  "status": 1,
  "dailyCompletedname": 0,"New Channel - Video",
   "rulesdescription": [null,
  "publisherId": "565c56d3181f46bd608b459a",
  "restoreFrom": null,
{  "lastAuditTrailId": null,
  "instanceId": "565c56d3181f46bd608b459a",
  "optimized": true,
  "frequencyoptModel": 3null,
  "optModelV": null,
  "accounting": {
    "servingModetype": 1,
    "enabled": null,
    "sumvalue": "10000"0,
    "max": null,
    "advancedCappingRulescutModel": null
  },
  "revShare": null,
 } "ivt": null,
  "fp": null,
]  "sid": null,
 }, "nlasid": null,
  "frequencytrackers": {null,
  "impcoc": null,
  "enabledenvironment": falsenull,
  "adTxt": true,
  "rulesovrdPbSchain": []null,
  "ovrdParSchain": null,
  "totalCompletedrmvParSchain": 0null,
  "syncChannel": null,
}  "type": }1,
  "creativeTypeoptData": 1null,
  "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

language	php

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

body:

Code Block

language	php

{
  "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

language	php

{
  "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,
  "syncChannelfalse
}

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

language	json

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

5. Associate Ad Source with Channel:

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

Request Method:
PUT

Headers:

Code Block

language	php

{ 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

language	php

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

Response:

200 OK

Code Block

language	php

{
    "data": {
        "id": null,
  "type": 1,      "optData_id": {
 null,   "publisher": null,   "playerSettings": [],   "maxrun$oid": "66b4a6075167de7dcd004671"
null,   "maximp": null,   "interval": null},
  "custom": null,      "minRpmcreatedAt": null1723115015,
    "limitAdvertisers": null,   "isSessionIdEnabledupdatedAt": null1723124989,
    "limitAdvertisersList": null,   "adstxtiUpdatedAt": null1723124989,
    "timeoutMs": null,   "enableMbqcreatedBy": null"atara@aniview.com",
  "mbq": null,      "enableInventoryPartnerDomainupdatedBy": null,"atara@aniview.com",
    "ipd": null,   "useAppSiteIpdstatus": null1,
  "prp": null,      "isGamname": null,"New Channel - Video"ibv":,
null,   "ibvPT     "description": null,
        "bopublisherId": null,"565c56d3181f46bd608b459a",
        "abrestoreFrom": null,
        "adSourceslastAuditTrailId": null,
  "creativeType": 1,      "originIdinstanceId": "66b4a6075167de7dcd004671565c56d3181f46bd608b459a",
        "operationTypeoptimized": 1,true,
        "privateoptModel": null,
 false }

to know more about the channel call you can enter this link https://aniviewwiki.atlassian.net/wiki/spaces/HELP/pages/2044461057/Channels+API#3.2-Create-Channels

5.Associate adsorce with channel:

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

Request Method:
PUT

Headers:

Code Block

language	php

{ Content-Type: application/json,   X-Bamboo-Token: "yourAuthTokenoptModelV" }

body:

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

Code Block

language	php

{: null,
        "_idaccounting": {
     "$oid": "66b4a6075167de7dcd004671"   },   "fptype": null,1,
            "environmentenabled": null,
    "type": 1,   "creativeType": 1,   "adSourcesvalue": 0,
[     {       "idmax": "66b495171fabcdd581028849"null,
            "prioritycutModel": "1" null
        },
  ] }

Response:

200 OK

Code Block

language	php

{     "datarevShare": {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",
        "descriptionovrdPbSchain": nullfalse,
        "publisherIdovrdParSchain": "565c56d3181f46bd608b459a"false,
        "restoreFromrmvParSchain": nullfalse,
        "lastAuditTrailIdsyncChannel": null,
        "instanceIdtype": "565c56d3181f46bd608b459a"1,
        "optimizedoptData": truenull,
        "optModelpublisher": null,
        "optModelVplayerSettings": null[],
        "accountingmaxrun": {
   null,
        "typemaximp": 1null,
   
        "enabledinterval": null,
   
        "valuecustom": 0null,
  
         "maxminRpm": null0,
   
        "cutModellimitAdvertisers": nullfalse,
        "isSessionIdEnabled": }false,
        "revSharelimitAdvertisersList": 0null,
        "ivtadstxt": {
   null,
        "prebidtimeoutMs": null,
   
        "postbidsenableMbq": []false,
        }"mbq": null,
        "fpenableInventoryPartnerDomain": 0false,
        "sidipd": null,
        "nlasiduseAppSiteIpd": nullfalse,
        "trackersprp": [],{
            "impcocprs": null,[],
            "environmentmm": null,
            "adTxtcmm": true,null
        "ovrdPbSchain": false},
        "ovrdParSchainisGam": falsenull,
        "rmvParSchainibv": false,
        "syncChannelibvPT": null,
        "typebo": 1null,
        "optDataab": null,
        "publisheradSources": null,[
        "playerSettings": [],    {
      "maxrun": null,         "maximpdata": {
null,          "interval": null,         "customid": null,
         "minRpm": 0,           "limitAdvertisers_id": false, {
              "isSessionIdEnabled": false,         "limitAdvertisersList$oid": "66b495171fabcdd581028849"
null,         "adstxt": null,         "timeoutMs": null},
          "enableMbq": false,         "mbqcreatedAt": null1723110679,
        "enableInventoryPartnerDomain": false,            "ipdupdatedAt": null1723110679,
         "useAppSiteIpd": false,           "prpiUpdatedAt": 1723110679,
{              "prs": [],     "createdBy": "atara@aniview.com",
      "mm": null,             "cmmupdatedBy": null "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": null,
"66b495171fabcdd581028849"                    "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,
                        "lastAuditTrailIdpViewValue": null,{
                            "cpmstartDate": 0,"2024-08-08T09:51:00.363Z",
                            "useMappedValuesendDate": null,"2024-08-08T09:51:00.363Z"
                     "useMappedCPM": null,  }
                  "floorKey": null  },
                    "averageCpmservingMode": 01,
                    "cprrequestsPerDay": {
   null,                     "optimizedCpmSynclimit": null0,
                        "fpOptimizationhasLimit": nullfalse,
                        "haCpmservingMode": null1,
                        "flightfrequency": {null,
                        "isScheduledtotalSent": false0,
                        "startDatelastDailyUpdate": 17231214601723110679,
                        "endDatelastDailyInit": 17231214601723110679,
                        "pViewValueadvancedCappingRules": { null
                    },
                    "startDateoptimizationSettings": "2024-08-08T09:51:00.363Z",{
                        "hasLimit": false,
    "endDate": "2024-08-08T09:51:00.363Z"                   "minFr": 0.5,
    }                    "limit": }0,
                        "servingModetimeFrame": 13,
                    "requestsPerDay": {   "denyRatio": null
                    "limit": 0,
  },
                     "hasLimitimpressionCap": false,{
                        "servingModefrequency": 14,
                        "frequencyservingMode": null,
                        "totalSentsum": 0,
                        "lastDailyUpdate": 1723110679,
                        "lastDailyInitlastMonthlyUpdate": 1723110679,
                        "advancedCappingRuleslastDailyInit": null1723110679,
                    },    "lastMonthlyInit": 1723110679,
               "optimizationSettings": {                         "hasLimit"totalCompleted": false0,
                        "minFrdailyCompleted": 0.5,
                        "limitmonthlyCompleted": 0,
                        "timeFrameadvancedCappingRules": 3null,
                        "denyRatiopropagateToDemand": null
                    },
                    "impressionCapcompletionCap": {
                        "frequencysum": 40,
                        "servingModefrequency": null4,
                        "sumservingMode": 01,
                        "lastDailyUpdatetotalCompleted": 17231106790,
                        "lastMonthlyUpdatemonthlyCompleted": 17231106790,
                        "lastDailyInitdailyCompleted": 17231106790,
                        "lastMonthlyInitadvancedCappingRules": 1723110679,
{
                       "totalCompleted": 0,                         "dailyCompleted"conditions": 0,
              [],
         "monthlyCompleted": 0,                         "advancedCappingRules"conditionType": 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,{
                        "advancedCappingRules": {   "inclusion": true,
                            "conditionslist": [],
                            "conditionTypeisCountryView": null true,
                            "excludeUnknownGeo": false
   }                     },
                        "targetinggeographyZip": {
                            "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": false
null,                         "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": falsenull,
                        "platformId": }null,
                        "customTargetingmode": null,
                        "botvideos": truenull,
                        "contentenvironment": {
   null,
                        "excludeSensitivemimes": null,
                        }
     "frameworks": null,
              },                     "sourcebidder": {null,
                        "typeprotocols": 2null,
                        "urlat": "https:\/\/www.example.com"null,
                        "clickThroughUrltest": null,
                        "platformtmax": null,
                        "platformIdprotoVersion": null,
                        "modeplacement": null,
                        "videosiapd": null,
                        "environmentprebid": null,
                        "mimesprebidServer": null,
                        "frameworksplatformLink": null,
                        "bidderrtb": null,{
                            "protocolsmaxbitrate": null,
                            "atinstl": null,
                            "testskip": null,
                            "tmaxdnt": null,
                            "protoVersionpos": null,
                            "placementrtbGap": null,
                            "iapdsiteId": null,
                            "prebidtagId": null,
                            "prebidServerzoneId": null,
                            "platformLinkaccountId": null,
                            "rtbsizeId": {null,
                            "maxbitrateplaybackMethod": null,
                            "instlprovider": null,
                            "skipproviderPubId": null,
                            "dntproviderPubId2": null,
                            "poscookieSyncId": null,
                            "rtbGaptokens": null,
                            "siteIdgroupId": null,
                            "tagIdcustom": null,
                            "zoneIdprivateAuction": null,
                            "accountIdproxyRequest": null,
                            "sizeIddeals": null,
                            "playbackMethodinventoryId": null,
                            "providermaxDuration": null,
                            "providerPubIdext": null,
                            "providerPubId2publisher": null,
                            "cookieSyncIdrwdd": null,
                            "tokens": null,
   },
                        "groupIdplover": null,
                            "customcookieSync": null,
   
                        "privateAuctionfloorPriceType": null1,
 
                          "proxyRequestprioritizeFP": nullfalse,
   
                        "dealsprioritizeConnFP": nullfalse,
  
                         "inventoryIduseAppSiteTitle": null,
  
                         "maxDurationadomain": null,
  
                         "extreplace": null,
  
                         "publisheraddAVKV": null,
  
                         "rwddgamParams": null
                    },
   },                 "provider": 999,
      "plover              "advertiserId": null,
  
                     "cookieSyncownerPublisherId": null,
                        "floorPriceTypeuseAdvertiserTargeting": 1true,
   
                    "prioritizeFPdebug": falsenull,
 
                      "prioritizeConnFPaccountingFeeId": falsenull,
   
                    "useAppSiteTitletype": null1,
  
                     "adomainfr": null,
  
                     "replaceplayerSettings": null,{
                        "addAVKVloop": null,
                        "gamParamsoptimizedTimeout": null,
                        "realACpm": }null,
                        "providerfp": 999null,
                        "advertiserIdtagTimeout": null,
                        "ownerPublisherIdmaxRPM": null,
                        "useAdvertiserTargetinggamMaxRPM": truenull,
                        "debugvpp": null,
                        "accountingFeeIdmips": null,
                        "typemrqs": 1null,
                        "frwsec": null,
                        "playerSettingsnoSsl": {null,
                        "loopvi": null,
                        "optimizedTimeoutfrvi": null,
                        "realACpmnc": null,
                        "fpsdk4": null,
                        "tagTimeoutops": null,
                        "maxRPMimpCountOn": null,
                        "gamMaxRPMvit": null,
                        "vppvibd": null,
                        "mipsvitd": null,
                        "mrqsprvi": null,
                        "wsecvpm": null,
                        "noSslcycleFreq": null,
                        "vitimeSpan": null,
                        "frvicompletionRate": null,
                        "ncnoCb": null,
                        "sdk4viewabilityThreshold": null,
                        "opsimpwt": null,
                        "impCountOnimpwc": null,
                        "vitimpwr": null,
                        "vibddealKV": null,
                        "vitddealVi": null,
                        "prvilidr": null,
                        "vpmmaxParallelBid": null,
                        "cycleFreqfply": null,
                        "timeSpanpxsec": null,
                        "completionRateflidr": null,
                        "noCbgl": null,
                        "viewabilityThresholdskipMode": null,
                        "impwtskipTimer": null,
                        "impwcoPlcmt": null,
                        "impwroMute": null,
                        "dealKV": null},
                        "dealVitrackers": null,
   [],
                    "lidrflags": null,
   
                    "maxParallelBidivt": null,{
                        "fplyprebid": null,
                        "pxsecpostbids": null,[]
                        "flidr": null,
   },
                    "glenvironment": null,
                        "skipModeoptData": null,
                        "skipTimerdailyData": null,
  
                     "oPlcmtfrequencyCap": null,{
                        "oMutefrequency": 4,
    null                    "servingMode": }1,
                        "trackerssum": []0,
                        "flagslastDailyUpdate": null,
                        "ivtlastMonthlyUpdate": {null,
                        "prebidlastDailyInit": null,
                        "postbidslastMonthlyInit": [] null,
                        "totalCompleted": }null,
                        "environmentdailyCompleted": null,
                        "optDatamonthlyCompleted": null,
                        "dailyDataadvancedCappingRules": null,
                    "frequencyCap": {   "propagateToDemand": null
                    "frequency": 4,
  },
                     "servingModetpp": 1,{
                        "sumtppId": 0null,
                        "lastDailyUpdateprovider": null,
                        "lastMonthlyUpdatesync": null,
                        "lastDailyInittppAsid": null,
                        "lastMonthlyInittppRecordId": null"",
                        "totalCompletedlastSync": null,
                        "dailyCompletedstatus": null,
                        "monthlyCompletederrorReason": null,
                        "advancedCappingRulestppChildNetwork": null,
                        "propagateToDemandthirdPublisherId": null
                    },
                    "tpppriceException": {
                        "tppIdtype": null0,
                        "providerenabled": null,
                        "syncvalue": null70,
                        "tppAsidmax": null,
                        "tppRecordIdcutModel": "", 1
                    },
                    "lastSyncisOno": null,
 
                      "statusownerType": null1,
   
                    "errorReasonthirdPartyCost": null,{
                        "tppChildNetworktype": null0,
                        "thirdPublisherIdenabled": null,
                    },    "value": 70,
               "priceException": {        "subtractionType": 1
               "type": 0,    },
                    "enabledpm": null,
   
                    "valuebo": 70,{
                        "maxs": null,
                        "cutModelh": null,
    1                    "l": }null,
                        "isOnosv": null,
                        "ownerTypehv": 1null,
                        "thirdPartyCostlv": {null,
                        "typeopd": 0null,
                        "enabledfrFloorOpt": {
   null,                         "valuepad": 70,null
                        "subtractionType":}
1                     },
                    "pmignoreNetworkConnectionFloorPrice": nullfalse,
                    "boignoreFP": {
null,
                       "signorePartnerConnectionFloorPrice": nullfalse,
                        "hblockingAttributes": null,
   
                    "lprp": null,
   
                    "svfts": null,{
                        "hvfta": null[],
                        "lvoverOpt": null,
                        "opden": null,
                    },
   "frFloorOpt": {                "cur": null,
           "pad": null        "sapr": null,
               }     "cappings": {
              },              "impression": {
      "ignoreNetworkConnectionFloorPrice": false,                     "ignoreFPenabled": nullfalse,
                    "ignorePartnerConnectionFloorPrice": false,       "totalCompleted": 0,
             "blockingAttributes": null,               "dailyCompleted": 0,
      "prp": null,                     "ftsrules": {[]
                        "fta": []},
                        "overOptcompletion": null,{
                        "en": null   "enabled": false,
                },            "totalCompleted": 0,
                            "curdailyCompleted": null,0,
                            "saprrules": 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. Pull VAST:

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.

Template for web:
https://gov.aniview.com/api/adserver/vast3/?AV_PUBLISHERID={publisher_id}&AV_CHANNELID={channel_id}&AV_URL=[URL_MACRO]&cb=[TIMESTAMP_MACRO]&AV_WIDTH=[WIDTH_MACRO]&AV_HEIGHT=[HEIGHT_MACRO]&AV_CCPA=[CCPA_MACRO]&AV_GDPR=[GDPR_MACRO]&AV_CONSENT=[CONSENT_MACRO]&s2s=1
Template for In-App:
https://gov.aniview.com/api/adserver/vast3/?AV_PUBLISHERID={publisher_id}&AV_CHANNELID={channel_id}&AV_URL=[URL_MACRO]&cb=[TIMESTAMP_MACRO]&AV_WIDTH=[WIDTH_MACRO]&AV_HEIGHT=[HEIGHT_MACRO]&AV_SCHAIN=[SCHAIN_MACRO]&AV_CCPA=[CCPA_MACRO]&AV_GDPR=[GDPR_MACRO]&AV_CONSENT=[CONSENT_MACRO/?AV_PUBLISHERID={publisher_id}&AV_CHANNELID={channel_id}&cb=[TIMESTAMP_MACRO]&AV_WIDTH=[WIDTH_MACRO]&AV_HEIGHT=[HEIGHT_MACRO]&AV_APPNAME=[APPNAME_MACRO]&AV_APPSTOREURL=[APPSTOREURL_MACRO]&AV_APPPKGNAME=[BUNDLE_ID_MACRO]&AV_IDFA=[IDFA_MACRO]&AV_LATITUDE=[LATITUDE_MACRO]&AV_LONGITUDE=[LONGITUDE_MACRO]&AV_CCPA=[CCPA_MACRO]&AV_GDPR=[GDPR_MACRO]&AV_CONSENT=[CONSENT_MACRO]&AV_CONTENT_URL=[CONTENT_URL]&AV_CONTENT_TITLE=[TITLE]&AV_CONTENT_EPISODE=[EPISODE]&AV_CONTENT_SERIES=[SERIES]&AV_CONTENT_SEASON=[SEASON]&AV_CONTENT_CAT=[CONTENT_CATEGORY]&AV_CONTENT_KEYWORDS=[KEYWORDS]&AV_CONTENT_NETWORK=[NETWORK]&AV_CONTENT_ID=[CONTENT_ID]&AV_CONTENT_CHANNEL=[CONTENT_CHANNEL]&AV_CONTENT_CONTEXT=[CONTENT_CONTEXT]&AV_CONTENT_GENRE=[GENRE]&AV_CONTENT_LENGTH=[LENGTH]&AV_CONTENT_LANGUAGE=[LANGUAGE]&AV_CONTENT_RATING=[RATING]&s2s=1
Template for In-App server:
https://gov.aniview.com/api/adserver/vast3/?AV_PUBLISHERID={publisher_id}&AV_CHANNELID={channel_id}&cb=[TIMESTAMP_MACRO]&AV_WIDTH=[WIDTH_MACRO]&AV_HEIGHT=[HEIGHT_MACRO]&AV_APPNAME=[APPNAME_MACRO]&AV_APPSTOREURL=[APPSTOREURL_MACRO]&AV_APPPKGNAME=[BUNDLE_ID_MACRO]&AV_IDFA=[IDFA_MACRO]&AV_LATITUDE=[LATITUDE_MACRO]&AV_LONGITUDE=[LONGITUDE_MACRO]&AV_SCHAIN=[SCHAIN_MACRO]&AV_CCPA=[CCPA_MACRO]&AV_GDPR=[GDPR_MACRO]&AV_CONSENT=[CONSENT_MACRO]&s2s=1Template for In-App server:
https://gov.aniview.com/api/adserver/vast3/?AV_PUBLISHERID={publisher_id}&AV_CHANNELID={channel_id}&cb=[TIMESTAMP_MACRO]&AV_WIDTH=[WIDTH_MACRO]&AV_HEIGHT=[HEIGHT_MACRO]&AV_APPNAME=[APPNAME_MACRO]&AV_APPSTOREURL=[APPSTOREURL_MACRO]&AV_APPPKGNAME=[BUNDLE_ID_MACRO]&AV_IDFA=[IDFA_MACRO]&AV_LATITUDE=[LATITUDE_MACRO]&AV_LONGITUDE=[LONGITUDE_MACRO]&AV_SCHAIN=[SCHAIN_MACRO]&AV_CCPA=[CCPA_MACRO]&AV_GDPR=[GDPR_MACRO]&AV_CONSENT=[CONSENT_MACROAV_CONTENT_URL=[CONTENT_URL]&AV_CONTENT_TITLE=[TITLE]&AV_CONTENT_EPISODE=[EPISODE]&AV_CONTENT_SERIES=[SERIES]&AV_CONTENT_SEASON=[SEASON]&AV_CONTENT_CAT=[CONTENT_CATEGORY]&AV_CONTENT_KEYWORDS=[KEYWORDS]&AV_CONTENT_NETWORK=[NETWORK]&AV_CONTENT_ID=[CONTENT_ID]&AV_CONTENT_CHANNEL=[CONTENT_CHANNEL]&AV_CONTENT_CONTEXT=[CONTENT_CONTEXT]&AV_CONTENT_GENRE=[GENRE]&AV_CONTENT_LENGTH=[LENGTH]&AV_CONTENT_LANGUAGE=[LANGUAGE]&AV_CONTENT_RATING=[RATING]&s2s=1
Template for ssai:
https://gov.aniview.com/api/adserver/vast3/?AV_PUBLISHERID={publisher_id}&AV_CHANNELID={channel_id}&cb=[TIMESTAMP_MACRO]&AV_WIDTH=[WIDTH_MACRO]&AV_HEIGHT=[HEIGHT_MACRO]&AV_APPNAME=[APPNAME_MACRO]&AV_APPSTOREURL=[APPSTOREURL_MACRO]&AV_APPPKGNAME=[BUNDLE_ID_MACRO]&AV_IDFA=[IDFA_MACRO]&AV_IFA_TYPE=[IFA_TYPE]&AV_LATITUDE=[LATITUDE_MACRO]&AV_LONGITUDE=[LONGITUDE_MACRO]&AV_CCPA=[CCPA_MACRO]&AV_GDPR=[GDPR_MACRO]&AV_CONSENT=[CONSENT_MACRO]&AV_CONTENT_URL=[CONTENT_URL]&AV_CONTENT_TITLE=[TITLE]&AV_CONTENT_EPISODE=[EPISODE]&AV_CONTENT_SERIES=[SERIES]&AV_CONTENT_SEASON=[SEASON]&AV_CONTENT_CAT=[CONTENT_CATEGORY]&AV_CONTENT_KEYWORDS=[KEYWORDS]&AV_CONTENT_NETWORK=[NETWORK]&AV_CONTENT_ID=[CONTENT_ID]&AV_CONTENT_CHANNEL=[CONTENT_CHANNEL]&AV_CONTENT_CONTEXT=[CONTENT_CONTEXT]&AV_CONTENT_GENRE=[GENRE]&AV_CONTENT_LENGTH=[LENGTH]&AV_CONTENT_LANGUAGE=[LANGUAGE]&AV_CONTENT_RATING=[RATING]&AV_UPAL=[NONCEID]&ssai=1

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

7. Generate a report for the

...

Campaign :

Request URL:

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

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

Request Method:
POSTGET

Headers:

Code Block

language	php

{ 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.

...

Versions Compared

Old Version 1

New Version Current

Key

2. Create

Ad Source:

CTV denamd source, Without any targeting or budgeting.

CTV denamd source with budgeting.

3. Edit

Ad Source:

4. Create Channel:

4.create Channel:

5. Associate Ad Source with Channel:

5.Associate adsorce with channel:

6. Pull VAST:

7. Generate a report for the

Campaign :

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

1. Login

2. Create

Ad Source:

CTV denamd source, Without any targeting or budgeting.

CTV denamd source with budgeting.

3. Edit

Ad Source:

4. Create Channel:

4.create Channel:

5. Associate Ad Source with Channel:

5.Associate adsorce with channel:

6. Pull VAST:

7. Generate a report for the

Campaign :