Direct Campaign Workflow

1. Login

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

Request Method:
POST

Headers:

body:

CTV denamd source, Without any targeting or budgeting.

Response:

200 OK

• Here you get the entire adsource object and the id in _id for other calls later.

CTV denamd source with budgeting.

body:

3. Edit Ad Source:

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

Request Method:
PUT

Status Code:
200 OK

Headers:

body:

4. Create Channel:

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

Request Method:
POST

Headers:

body:

response:

200 OK

5. Associate Ad Source with Channel:

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

Request Method:
PUT

Headers:

body:

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

Response:

200 OK

6. Pull VAST:

• 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}&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_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 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

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 - Epoch Converter

• endDate: Required - Linux date, UNIX Timestamp, of the end time of the report
  The following link can be used for the date conversion - Epoch Converter

• tzo: Optional - Time zone offset in hours from UTC. Reports are generated in UTC timezone.

• dimensions: list of dimensions separated with an encoded comma (“,”) - you can use an encoder like URL Decoder/Encoder

• metrics: list of metrics separated with an encoded comma (“,”) - you can use an encoder like URL Decoder/Encoder

• format: json

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

Request Method:
GET

Headers:

Response:

200 OK

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