Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Current »

1. Login

To log in - the general login API is used. Example - https://aniviewwiki.atlassian.net/wiki/spaces/HELP/pages/155975720/Reporting+API#Login-API

2. Logout

To log out - the general logout API is used. Example - https://aniviewwiki.atlassian.net/wiki/spaces/HELP/pages/155975720/Reporting+API#Logout-API

3. Advertiser entity API

3.1. Get Advertiser List

Retrieves a list of all advertisers in the network.

Request URL:
https://manage.aniview.com/api/adserver/advertiser?format=json&countAssociateAdsources=true&expand={"targeting":["customList"]}&filter={"$and":[{"status":{"$in":[2,1]}}]}&includePartners=false

Request Method:
GET

Status Code:
200 OK

Filtering Parameters (Optional):

Parameter

Description

Values

status

status of the advertiser

Active:1, Archived:2

includePartners

whether to include partners

false,true

countAssociateAdsources

show associated adsources

false,true

expand

show targeting list

{"targeting":["customList"]}

3.2. Create Advertiser

Request URL:
Request URL:

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

Request Method:
POST

Request Example payload:

{
    "status": 1,
    "frequencyCap": {
        "frequency": 4,
        "sum": "0"
    },
    "playerSettings": {
        "tagTimeout": 20000,
        "optimizedTimeout": false,
        "maxRPM": 0
    },
    "adstxt": {
        "lines": [],
        "fileMapping": {
            "approved": {
                "value": "",
                "keyMap": {}
            },
            "domain": {
                "value": "",
                "keyMap": {}
            }
        }
    },
    "targeting": {
        "customTargeting": [],
        "domain": {
			"list": [""],
			"inclusion": true
		},
		"os": {
			"inclusion": true,
			"list": ["13", "14"]
		},
        "geography": {
            "isCountryView": true,
            "excludeUnknownGeo": false
        },
        "geographyCoor": {
            "inclusion": true,
            "list": []
        },
        "geographyZip": {
            "inclusion": true,
            "list": []
        },
        "placement": {
            "inclusion": true,
            "excludeUnknown": false
        },
        "dow": null,
        "adtxt": null,
        "targetPlatform": null,
        "idfa": {},
        "domain": null,
        "device": null,
        "os": null,
        "tag": null,
        "playerSize": null,
        "slot": null
    },
    "priceException": {
        "type": 0,
        "value": 70,
        "cutModel": 1
    },
    "thirdPartyCost": {
        "type": 0,
        "subtractionType": 1,
        "value": 70
    },
    "hasLimit": false,
    "name": "name",
    "ownerType": 1,
    "email": "email@email.com",
    "description": "Description",
    "macro": "Serving Macro"
}

Basic Request Parameters:

Parameter

description

Values

name

Advertiser Name

string

ownerType

Demand Owner

Network:1, Publisher:2, App/Site:3

email

string

description

string

macro

Serving Macro

string

hasLimit

Limit Ad Sources

true/false

limit

Ad Sources limit number

integer

limitAllChannels

Limit the amount of Ad Sources
in the WF

true/false

Targeting Parameters:

Domain:

Parameter

description

Values

inclusion

if you would like to include

true/false

list

array of list ID’s

array

Geography:

Parameter

description

Values

excludeUnknownGeo

if you would like to exclude unknown geo’s

true/false

inclusion

if you would like to include

true/false

list

specifies the possible country codes

array

Possible country codes: 

["DZ","AO","BJ","BW","BF","BI","CM","CV","CF","TD","KM","CG","CD","CI","DJ","EG","GQ","ER","ET","GA","GM","GH","GN","GW","KE","LS","LR","LY","MG","MW","ML","MR","MU","YT","MA","MZ","NA","NE","NG","RE","RW","SH","ST","SN","SC","SL","SO","ZA","SD","SZ","TZ","TG","TN","UG","EH","ZM","ZW","AF","AM","AZ","BH","BD","BT","KH","CN","CY","GE","HK","IN","ID","IR","IQ","IL","JP","JO","KZ","KP","KR","KW","KG","LA","LB","MO","MY","MV","MN","MM","NP","OM","PK","PH","QA","SA","SG","LK","SY","TW","TJ","TH","TL","TR","TM","AE","UZ","VN","YE","AX","AL","AD","AT","BY","BE","BA","BG","HR","CZ","DK","EE","FO","FI","FR","DE","GI","GR","GG","VA","HU","IS","IE","IM","IT","JE","LV","LI","LT","LU","MK","MT","MD","MC","ME","NL","NO","PL","PT","RO","RU","SM","RS","SK","SI","ES","SJ","SE","CH","UA","GB","XK","AS","AQ","AU","BV","IO","CX","CC","CK","FJ","PF","TF","GU","HM","KI","MH","FM","NR","NC","NZ","NU","NF","MP","PW","PG","PN","WS","SB","GS","TK","TO","TV","UM","VU","WF","AI","AG","AR","AW","BS","BB","BZ","BM","BO","BR","CA","KY","CL","CO","CR","CU","DM","DO","EC","SV","FK","GF","GL","GD","GP","GT","GY","HT","HN","JM","MQ","MX","MS","AN","NI","PA","PY","PE","PR","KN","LC","PM","VC","SR","TT","TC","US","UY","VE","VG","VI","BN"]
OS

Parameter

description

Values

inclusion

if you would like to include

true/false

list

specifies the possible country codes

array

{ "ANDROID": 1, "IOS_IPHONE_IPOD": 2, "WINDOWS": 3, "OSX": 4, "LINUX": 5, "BLACKBERRY": 6, "WINDOWS_PHONE": 7, "IOS_IPAD": 8, "ROKU": 9, "TV": 10, "TIZEN": 11, "FIRE": 12, "WEB": 13, "CHROME": 14, "VIZIO_SMARTCAST": 15, "XBOX": 16, "CHROMECAST": 17, "FEDORA": 18, "KAI": 19, "PLAYSTATION": 20, "OTHER": 100 }
Player size:

Parameter

Values

Small (width: < 400 px)

2

Medium (width: 400 - 640 px)

3

Large (width: > 640 px)

4

Custom

5

User Consent:

Parameter

description

Values

idfa

Exclude empty AV_IDFA

true/false

euConsent

Exclude empty GDPR Consent in EU

true/false

ccpa

Exclude empty CCPA in California

true/false

buyeruid

Exclude empty Buyer UID in RTB(Cookie Sync Miss)

true/false

Adtxt (under the targeting object):
adtxt": { "inclusion": true, "list": [${list_id}] }
Placement:

Parameter

Values

In-Stream

1

In-Banner

2

In-Article

3

In-Feed

4

Floating or Sticky

5

Price exceptions:

Parameter

description

Values

cutModel

Exception Cut Model

{ "Override Conection": 1,

"Demand Cut/Share": 2,

"Cut Form CPM/Revanue": 3 }

value

Fixed CPM

indeger

max

Max CPM

indeger

type

{ "Fixed CPM": 0, "Rev Share": 1 }

Third party cost:

Parameter

Values

type

{ "Fixed CPM": 1, "Rev Share": 0 }

subtractionType

{ "Before": 1, "After": 2 }

value

integer

Trackers:

Parameter

description

Values

e

stage

t

type

url

site address

URL address

tsp

percentage of time a tracker will be activated

1-100

Player Settings:

Parameter

description

Values

tagTimeout

Timeout Time

1,000 - 60,000

maxRPM

Max Requests per Minute. The calculation is 60 / *configured_number*
Example: If set to 2, the adsoure will send request every 30 seconds.

integer

vpp

VPAID Player Priority

{ "Js":1,

"SWF":2,

"JS Over MP4" : 3 }

Frequency Cap:

Parameter

description

Values

frequency

Frequency Capping

{ "Daily": 1, "Weekly": 2, "Unlimited": 3, "Hourly": 5 }

sum

number of times per day

Integer

Status Code:
200 OK

3.3. Edit Advertiser

Request URL:

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

Request payload:

Request Method:
Put

Status Code:
200 OK

Request payload:

{
    "_id": {
        "$oid": "advertiser id"
    },
    "email": "email@email.com",
    "accountingFeeId": null,
    "trackers": [],
    "frequencyCap": {
        "frequency": 4,
        "servingMode": null,
        "sum": "0",
        "lastDailyUpdate": null,
        "lastMonthlyUpdate": null,
        "lastDailyInit": null,
        "lastMonthlyInit": null,
        "totalCompleted": null,
        "dailyCompleted": null,
        "monthlyCompleted": null,
        "advancedCappingRules": {
            "conditions": [],
            "conditionType": null
        },
        "propagateToDemand": false
    },
    "adstxt": {
        "advertisers": null,
        "fileURL": null,
        "tabName": null,
        "fileMapping": {
            "approved": {
                "value": "",
                "keyMap": []
            },
            "domain": {
                "value": "",
                "keyMap": []
            }
        },
        "lines": []
    },
    "hasLimit": false,
    "limit": 1,
    "limitAllChannels": false,
    "targeting": {
        "domain": null,
        "geography": {
            "isCountryView": true,
            "inclusion": false,
            "excludeUnknownGeo": false
        },
        "geographyZip": {
            "inclusion": true,
            "list": []
        },
        "geographyCoor": {
            "inclusion": true,
            "list": []
        },
        "device": null,
        "os": 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": []
    },
    "priceException": {
        "type": 0,
        "enabled": null,
        "value": 70,
        "max": null,
        "cutModel": 1
    },
    "playerSettings": {
        "tagTimeout": 20000,
        "optimizedTimeout": false,
        "maxRPM": 0
    },
    "thirdPartyCost": {
        "type": 0,
        "enabled": null,
        "value": 70,
        "subtractionType": 1
    },
    "macro": "Serving Macro",
    "ownerType": 1,
    "status": 1,
    "name": "name12",
    "description": "Description",
    "publisherId": "publisherId",
    "restoreFrom": null,
    "adsourceOriginId": null,
    "lastAuditTrailId": null,
    "id": null,
    "createdAt": 1636543818,
    "updatedAt": 1636545000,
    "iUpdatedAt": 1636545000,
    "createdBy": "dashbord login email",
    "updatedBy": "dashbord login email",
    "$edit": true
}

3.4. Delete Advertiser

Request URL:

Request URL: https://manage.aniview.com/api/adserver/advertiser/{$advertiser_id}?format=json&fupdate=true

Request Method:
Delete

Status Code:
200 OK

  • No labels