Publisher Connection API

1 1. Login
2 2. Logout
3 3. Publisher Channel entity API

The Publisher Channel is a tool to gather one or multiple ad sources inside a Publisher account under one channel inside a Network account. This also means the channel is the bridge between the ad sources and the ad auction.

1. Login

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

2. Logout

To log out - the general logout API is used. Example - Reporting API | Logout API

3. Publisher Channel entity API

3.1 Get Channels List

Retrieves a list of all Channels in the network.
Request URL:
https://manage.aniview.com/api/adserver/connections?format=json&expand%5B%5D=publisherId&expand%5B%5D=nothingToDo&expand%5B%5D=originPublisherId&expand%5B%5D=origin&expand%5B%5D=advertiserId&expand%5B%5D=originPublisherId&expand%5B%5D=zipTargetingListName&expand%5B%5D=coorTargetingListName&expand%5B%5D=tppRecordId&filter=%7B%22$and%22:%5B%7B%22type%22:%7B%22$in%22:%5B3,2%5D%7D%7D,%7B%22status%22:%7B%22$in%22:%5B1,2,3,5,6,0%5D%7D%7D%5D%7D&pager=%7B%22pageIndex%22:1,%22pageSize%22:50%7D&sort=%7B%22updatedAt%22:-1%7D

Request Method:
GET

Status Code:
200 OK

Filtering Parameters (Optional):

Parameter	Description	Value
expand%5B%5D		publisherId
expand%5B%5D		nothingToDo
expand%5B%5D		originPublisherId
expand%5B%5D		origin
expand%5B%5D		advertiserId
expand%5B%5D		originPublisherId
expand%5B%5D		zipTargetingListName
expand%5B%5D		coorTargetingListName
expand%5B%5D		tppRecordId
filter		%7B%22$and%22:%5B%7B%22type%22:%7B%22$in%22:%5B3,2%5D%7D%7D,%7B%22status%22:%7B%22$in%22:%5B1,2,3,5,6,0%5D%7D%7D%5D%7D
pager		%7B%22pageIndex%22:1,%22pageSize%22:50%7D
sort		%7B%22updatedAt%22:-1%7D

3.2 Create Publisher Connection

Request URL:
Request URL:

https://manage.aniview.com/api/adserver/networkconnection?format=json
O

https://manage.aniview.com/api/adserver/networkconnection?format=json&addNewChannel=true

Request Method:
POST

Parameter	Description	Value
playerSettings__tagTimeout		Integer
playerSettings__optimizedTimeout		Boolean
playerSettings__maxRPM		Integer
playerSettings__maxParallelBid		Integer
description		String
flight__isScheduled		Boolean
flight__startDate		Integer
flight__endDate		Integer
flight__pViewValue__startDate		2023-05-25T07:30:52.839Z
flight__pViewValue__endDate		2023-05-25T07:30:52.839Z
impressionCap__frequency		Integer
impressionCap__sum		Integer
impressionCap__totalCompleted		Integer
impressionCap__dailyCompleted		Integer
impressionCap__monthlyCompleted		Integer
impressionCap__advancedCappingRules__conditionType		and
supplyImpressionCap__frequency		Integer
supplyImpressionCap__sum		Integer
supplyImpressionCap__totalCompleted		Integer
supplyImpressionCap__dailyCompleted		Integer
supplyImpressionCap__monthlyCompleted		Integer
supplyImpressionCap__servingMode		Integer
supplyRequestsPerDay__limit		Integer
supplyRequestsPerDay__hasLimit		Boolean
frequencyCap__sum		Integer
frequencyCap__frequency		Integer
frequencyCap__servingMode		Boolean
supplyFrequencyCap__sum		Integer
supplyFrequencyCap__frequency		Integer
supplyFrequencyCap__servingMode		Boolean
supplyFrequencyCap__propagateToDemand		Boolean
optimizationSettings__limit		Boolean
optimizationSettings__minFr		Float
optimizationSettings__timeFrame		Integer
optimizationSettings__hasLimit		Boolean
name		String
provider		Integer
requestsPerDay__limit		Integer
requestsPerDay__hasLimit		Boolean
requestsPerDay__servingMode		Boolean
requestsPerDay__advancedCappingRules__conditionType		and
servingMode		Integer
source__type		Integer
source__url		String
source__clickThroughUrl		String
source__mime		Object
source__bidder		String
source__protocols		Object
source__at
source__test
source__timeout
source__tmax
source__mimes
source__placement
source__frameworks
source__floorPriceType		Integer
source__prioritizeFP		Boolean
source__prioritizeConnFP		Boolean
source__cookieSync__provider
status		Integer
type		Integer
accounting__type	0 is Revshare, 1 is CPM	Integer
accounting__value		Integer
publisherId		String
origin	Channel ID	String
platformLink__environment		Integer
platformLink__platformID
originPublisherId	Network ID	String
dTargeting__bot		Boolean
dTargeting__geography__isCountryView		Boolean
dTargeting__geography__excludeUnknownGeo		Boolean
dTargeting__geographyCoor__inclusion		Boolean
dTargeting__geographyZip__inclusion		Boolean
dTargeting__placement__inclusion		Boolean
dTargeting__placement__excludeUnknown		Boolean
dTargeting__dow
dTargeting__adtxt
dTargeting__domain__inclusion		Boolean
dTargeting__device
dTargeting__os
dTargeting__tag
dTargeting__playerSize
dTargeting__targetPlatform
dTargeting__slot
tpp__provider		Integer
tpp__tppRecordId		Integer
ignoreNetworkConnectionFloorPrice		Boolean
ignorePartnerConnectionFloorPrice		Boolean
useAdvertiserTargeting		Boolean
originConnectionType		Integer
ownerType		Integer
floorPrice		Integer

Request Example payload :

{
  "cpm": 0,
  "playerSettings": {
    "tagTimeout": 20000,
    "optimizedTimeout": false,
    "maxRPM": 0,
    "maxParallelBid": 0
  },
  "description": null,
  "flight": {
    "isScheduled": false,
    "startDate": 1685010652,
    "endDate": 1685010652,
    "pViewValue": {
      "startDate": "2023-05-25T07:30:52.839Z",
      "endDate": "2023-05-25T07:30:52.839Z"
    }
  },
  "impressionCap": {
    "frequency": 4,
    "sum": "0",
    "totalCompleted": 0,
    "dailyCompleted": 0,
    "monthlyCompleted": 0,
    "advancedCappingRules": {
      "conditions": [],
      "conditionType": "and"
    }
  },
  "supplyImpressionCap": {
    "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
  },
  "optimizationSettings": {
    "limit": 0,
    "minFr": 0.5,
    "timeFrame": 3,
    "hasLimit": false
  },
  "name": "Please delete",
  "provider": 999,
  "requestsPerDay": {
    "limit": "0",
    "hasLimit": false,
    "servingMode": 1,
    "advancedCappingRules": {
      "conditions": [],
      "conditionType": "and"
    }
  },
  "servingMode": 1,
  "source": {
    "type": 9,
    "url": "",
    "clickThroughUrl": null,
    "mime": null,
    "bidder": null,
    "protocols": null,
    "at": null,
    "test": null,
    "timeout": null,
    "rtb": {},
    "tmax": null,
    "mimes": null,
    "placement": null,
    "frameworks": null,
    "floorPriceType": 1,
    "prioritizeFP": false,
    "prioritizeConnFP": false,
    "cookieSync": {
      "provider": "#null#"
    }
  },
  "status": 1,
  "targeting": {},
  "type": 2,
  "accounting": {
    "type": 0,
    "value": 0
  },
  "ivt": {},
  "publisherId": "[Enter publisher ID]",
  "origin": "[Enter channel ID]",
  "platformLink": {
    "environment": 1,
    "platformID": null
  },
  "originPublisherId": "[Enter publisher ID]",
  "dTargeting": {
    "bot": true,
    "customTargeting": [],
    "geography": {
      "isCountryView": true,
      "excludeUnknownGeo": false
    },
    "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,
    "tag": null,
    "playerSize": null,
    "targetPlatform": null,
    "idfa": {},
    "slot": null
  },
  "trackers": [],
  "dTrackers": [],
  "fts": {},
  "tpp": {
    "provider": 999,
    "tppRecordId": null
  },
  "ignoreNetworkConnectionFloorPrice": false,
  "ignorePartnerConnectionFloorPrice": false,
  "useAdvertiserTargeting": false,
  "originConnectionType": 2,
  "thirdPartyCost": {},
  "priceException": {},
  "ownerType": 1,
  "floorPrice": 0
}

3.3 Update Channel Properties

Request URL:
https://manage.aniview.com/api/adserver/networkconnection/${Channel_Id}?format=json

Request Method:
PUT

Request Example payload:

Parameter	Description

Parameter	Description
_id > $oid$o	Channel ID

3.4. Delete Channel

Request URL:

Request URL: https://manage.aniview.com/api/adserver/networkconnection/${Channel_Id}?format=json

Request Method:
Delete

Status Code:
200 OK

Request Example payload:

Parameter	Description

Parameter	Description
_id > $oid	Channel ID

{"_id":{"$oid":"6211f80558f94129955ab635"},"adSources":[{"id":"60eddbed496b092021128718","priority":"1"},{"id":"60eddbeb496b092021128716","priority":"1"}]}

3.5. Get Channel properties (including associated ad sources)

Request URL:

Request URL: https://manage.aniview.com/api/adserver/networkconnection/${Channel_Id}?format=json

Some ad sources may directly target domains/apps instead of targeting lists. To get those domains/apps, add &expand={"adSources": ["defaultDomain"]}, like:

https://manage.aniview.com/api/adserver/networkconnection/${Channel_Id}?expand=%7B%22adSources%22%3A+%5B%22defaultDomain%22%5D%7D

Request Method:
Get

Status Code:
200 OK