Update VAST Tag

This endpoint updates VAST Tag.

HTTP Request

POST https://adelion.com/api/ortb/vasttag/update

Parameter	Type	Description	Requirement
Id	`int`	VAST Tag ID.	required
Name	`string`	VAST Tag’s name.	optional
Tags	`int[]`	List of Tags’ IDs.	optional
Bidfloor	`float`	Minimum bid expressed in CPM. Value will be used as a bidfloor in RTB auctions.	optional
DspBidfloorMargin	`float`	Margin percentage to add to bidfloor which is sent to advertiser’s DSP RTB EP. For example, if publisher’s bidfloor is $5 and Margin is 20%, advertiser will receive $6 bidfloor.	optional
PublisherProfitShare	`float`	Percentage of a profit (bid price minus bidfloor) from DSP RTB EP’s advertiser that VAST Tag’s publisher earns.	optional
Keywords	`string`	Comma separated list of keywords describing the site/app.	optional
SiteDomain	`string`	Domain of the site.	optional
AppName	`string`	App name.	optional
AppBundle	`string`	A platform-specific application identifier intended to be unique to the app and independent of the exchange. On Android, these should be bundle or package names (e.g., com.foo.mygame), on iOS, these are numeric IDs.	optional
AppStoreUrl	`string`	App store URL for an installed app.	optional
MaxQps	`int`	Maximum queries per second - Maximum number of requests to receive from the VAST Tag in one second. Set to 0 for unlimited requests.	optional
Tmax	`int`	Maximum time in milliseconds to wait for the response from DSP RTB EP’s server.	optional
AuctionType	`int`	Type of RTB auction within the platform. 1 - First Price, 2 - Second Price Plus.	optional
Secure	`int`	Indicates if the VAST Tag requires secure HTTPS URL creative assets and markup. 0 - No, 1 - Yes.	optional
Waterfall	`int`	Follow additional VAST wrappers if no ad is returned. 0 - No, 1 - Yes.	optional
SetSchainComplete	`int`	If turned on, schain will be set as complete (complete=1) when making requests to DSP EPs, otherwise it will be complete=0. 0 - No, 1 - Yes.	optional
IabCategories	`string[]`	IAB categories of the site/app where ads will be displayed. See Info -> Get IAB categories for a list of available categories.	optional
AdPosition	`int`	Video position on screen. See Info -> ORTB Ad Position for a list of available ad positions.	optional
Width	`int`	Video width. See ORTB Info -> ORTB Banner Sizes for a list of available video sizes (combination of Width and Height).	optional
Height	`int`	Video height. See ORTB Info -> ORTB Banner Sizes for a list of available video sizes (combination of Width and Height).	optional
Linearity	`int`	Indicates if the impression must be linear or nonlinear. See Info -> ORTB Video Linearity for a list of available linearities.	optional
Placement	`int`	Video placement type. See Info -> ORTB Placement for a list of available video placement types.	optional
RequestsDailyLimit	`int`	Number of requests to receive per day. The system will even out distribution of requests throughout the day, ie. “day shaping”. Set to 0 for unlimited requests.	optional
BidsDailyLimit	`int`	Number of bids per day. The system will even out distribution of bids throughout the day, ie. “day shaping”. Set to 0 for unlimited bids.	optional
ImpressionsDailyLimit	`int`	Number of impressions per day. The system will even out distribution of impressions throughout the day, ie. “day shaping”. Set to 0 for unlimited impressions.	optional
ImpressionsLimitPerIp	`int`	Daily limit of impressions per IP address. Set to 0 for unlimited impressions per IP address.	optional
SpentDailyLimit	`float`	Maximum daily amount (USD) to spend on VAST Tag. Set to 0 for unlimited amount.	optional
WebEnabled	`int`	Enable Web traffic. 0 - Disabled, 1 - Enabled.	optional
AppEnabled	`int`	Enable App traffic. 0 - Disabled, 1 - Enabled.	optional
MaxIvt	`float`	Filter traffic from inventory with IVT greater than this value.	optional
DomainsBrandsListMode	`int`	Block or allow publisher domains or brand names: 0 - Blacklist, 1 - Whitelist.	optional
DomainsBrandsList	`int[]`	List of Domain Lists’ IDs to block or allow.	optional
AppsListMode	`int`	Block or allow publisher applications by their application identifiers: 0 - Blacklist, 1 - Whitelist.	optional
AppsList	`int[]`	List of App Lists’ IDs to block or allow.	optional
SizesListMode	`int`	Block or allow creatives’ sizes: 0 - Blacklist, 1 - Whitelist.	optional
SizesList	`string[]`	List of creatives’ sizes to block or allow. Size must be in format “WIDTHxHEIGHT”.	optional
IpBlacklists	`int[]`	List of IP Lists’ IDs to use for IP block.	optional
NonEmptyReferer	`int`	Ad impression or click with no referer will be filtered: 1 - Enabled, 0 - Disabled.	optional
RefererMatch	`int`	Referer in ad impression or click and site URL should match: 1 - Enabled, 0 - Disabled.	optional
IpMatch	`int`	Real user’s IP address in ad impression or click and user IP parameter should match: 1 - Enabled, 0 - Disabled.	optional
UaMatch	`int`	Real user’s User Agent in ad impression or click and user agent parameter should match: 1 - Enabled, 0 - Disabled.	optional
AllowIpV6	`int`	Allow IPv6 addresses. 1 - Enabled, 0 - Disabled.	optional
CheckSiteLive	`int`	Check if source website is live. 1 - Enabled, 0 - Disabled.	optional
CheckAppStore	`int`	Check if app is live on its application store (App Store, Google Play, etc.). 1 - Enabled, 0 - Disabled.	optional
AdDomainsBrandsBlacklist	`string`	List of domains or brand names to block, separated by new line.	optional
AdAppsBlacklist	`string`	Blacklist of applications by their application identifiers, separated by new line. On Android, these should be bundle or package names (e.g., com.foo.mygame), on iOS, these are numeric IDs.	optional
CridListMode	`int`	Block or allow Creative IDs: 0 - Blacklist, 1 - Whitelist.	optional
CridList	`string`	List of Creative IDs to block or allow, separated by new line.	optional
BlockedAdIabCategories	`string[]`	Ads with these IAB categories will not be displayed. See Info -> Get IAB categories for a list of available categories.	optional
BlockedAdAttributes	`int[]`	Ads with these ad attributes will not be displayed. See ORTB Info -> ORTB Creative Attribute for a list of available ad attributes.	optional
Countries	`object[]`	Array of Country objects that should be sent like in JSON example. CC values in objects must be ISO-3166-1-alpha-2 country codes. See Info -> Get countries for a list of available countries.	optional
Os	`object[]`	Array of Os objects that should be sent like in JSON example. Not all operating systems have their versions, so for them you don’t have to include Versions array in object. See Info -> Get operating systems for a list of available operating systems and their versions.	optional
Browsers	`object[]`	Array of Browser objects that should be sent like in JSON example. Not all web browsers have their versions, so for them you don’t have to include Versions array in object. See Info -> Get web browsers for a list of available web browsers and their versions.	optional
DeviceTypes	`int[]`	Array of Device Type Rev objects that should be sent like in JSON example. See ORTB Info -> ORTB Device Type Rev for a list of available device types.	optional
Campaigns	`int[]`	Array of Campaigns’ IDs to connect to the VAST Tag. This will make the Campaign Ad appear for VAST Tag if all the targeting is matched.	optional
DspRtbEps	`int[]`	Array of DSP RTB EPs’ IDs to connect to the VAST Tag. This will make the DSP RTB EP appear for VAST Tag if all the targeting is matched.	optional
DspVastTags	`int[]`	Array of DSP VAST Tags’ IDs to connect to the VAST Tag. This will make the DSP VAST Tag appear for VAST Tag if all the targeting is matched.	optional

{
  "VastTag": {
    "Id": 1,
    "Name": "VAST Tag 1",
    "Tags": [
      1
    ],
    "Bidfloor": 0.5,
    "DspBidfloorMargin": 5.0,
    "PublisherProfitShare": 90.0,
    "Keywords": "",
    "SiteDomain": "",
    "AppName": "",
    "AppBundle": "",
    "AppStoreUrl": "",
    "MaxQps": 0,
    "Tmax": 300,
    "AuctionType" : 2,
    "Secure": 1,
    "Waterfall": 1,
    "SetSchainComplete": 0,
    "IabCategories": [
      "IAB1-1",
      "IAB2-1",
      "IAB3"
    ],
    "AdPosition": 4,
    "Width": 300,
    "Height": 250,
    "Linearity": 1,
    "Placement": 1,
    "RequestsDailyLimit": 0,
    "BidsDailyLimit": 0,
    "ImpressionsDailyLimit": 0,
    "ImpressionsLimitPerIp": 5,
    "SpentDailyLimit": 0.0,
    "WebEnabled": 1,
    "AppEnabled": 1,
    "MaxIvt": 50.0,
    "DomainsBrandsListMode": 0,
    "DomainsBrandsList": [
      1
    ],
    "AppsListMode": 0,
    "AppsList": [
      1
    ],
    "SizesListMode": 1,
    "SizesList": [
      "300x250",
      "320x480"
    ],
    "IpBlacklists": [
      1
    ],
    "NonEmptyReferer": 1,
    "RefererMatch": 1,
    "IpMatch": 1,
    "UaMatch": 1,
    "AllowIpV6": 1,
    "CheckSiteLive": 0,
    "CheckAppStore": 0,
    "AdDomainsBrandsBlacklist": "",
    "AdAppsBlacklist": "",
    "CridListMode": 0,
    "CridList": "",
    "BlockedAdIabCategories": [
      "IAB1-1",
      "IAB2-1",
      "IAB3",
      "IAB2-4"
    ],
    "BlockedAdAttributes": [
      8,
      9
    ],
    "Countries": [
      {
        "CC": "US"
      }
    ],
    "Os": [
      {
        "Family": "Windows",
        "Versions": [
          {
            "Major": "10",
            "Minor": ""
          }
        ]
      }
    ],
    "Browsers": [
      {
        "Family": "Chrome"
      }
    ],
    "DeviceTypes": [
      1,
      2,
      3,
      4,
      5
    ],
    "Campaigns": [
      1
    ],
    "DspRtbEps": [
      1
    ],
    "DspVastTags": [
      1
    ]
  }
}

Response

{
  "Status": "Ok",
  "VastTag": {
    "Id": 1,
    "TeamId": 1,
    "PublisherId": 1,
    "PublisherName": "Publisher",
    "Name": "VAST Tag 1",
    "Tags": [
      1
    ],
    "Bidfloor": 0.5,
    "DspBidfloorMargin": 5.0,
    "PublisherProfitShare": 90.0,
    "Keywords": "",
    "SiteDomain": "",
    "AppName": "",
    "AppBundle": "",
    "AppStoreUrl": "",
    "MaxQps": 0,
    "Tmax": 300,
    "AuctionType" : 2,
    "Secure": 1,
    "Waterfall": 1,
    "SetSchainComplete": 0,
    "IabCategories": [
      "IAB1-1",
      "IAB2-1",
      "IAB3"
    ],
    "AdPosition": 4,
    "Width": 300,
    "Height": 250,
    "Linearity": 1,
    "Placement": 1,
    "RequestsDailyLimit": 0,
    "BidsDailyLimit": 0,
    "ImpressionsDailyLimit": 0,
    "ImpressionsLimitPerIp": 5,
    "SpentDailyLimit": 0.0,
    "WebEnabled": 1,
    "AppEnabled": 1,
    "MaxIvt": 50.0,
    "DomainsBrandsListMode": 0,
    "DomainsBrandsList": [
      1
    ],
    "AppsListMode": 0,
    "AppsList": [
      1
    ],
    "SizesListMode": 1,
    "SizesList": [
      "300x250",
      "320x480"
    ],
    "IpBlacklists": [
      1
    ],
    "NonEmptyReferer": 1,
    "RefererMatch": 1,
    "IpMatch": 1,
    "UaMatch": 1,
    "AllowIpV6": 1,
    "CheckSiteLive": 0,
    "CheckAppStore": 0,
    "AdDomainsBrandsBlacklist": "",
    "AdAppsBlacklist": "",
    "CridListMode": 0,
    "CridList": "",
    "BlockedAdIabCategories": [
      "IAB1-1",
      "IAB2-1",
      "IAB3",
      "IAB2-4"
    ],
    "BlockedAdAttributes": [
      8,
      9
    ],
    "Countries": [
      {
        "CC": "US",
        "Country": "United States"
      }
    ],
    "Os": [
      {
        "Family": "Windows",
        "Versions": [
          {
            "Major": "10",
            "Minor": ""
          }
        ]
      }
    ],
    "Browsers": [
      {
        "Family": "Chrome"
      }
    ],
    "DeviceTypes": [
      1,
      2,
      3,
      4,
      5
    ],
    "Auth": "yI4de6",
    "Qps": 534,
    "AccManagerId": 5,
    "AccManagerName": "John Doe",
    "Status": 0,
    "StatusString": "Active",
    "ZoneUrls": [
      {
        "Region": "us-east",
        "ZoneUrl": "https://us-east1.adelion.com/vast?zone=%d&auth=%s&ip={ip}&ua={ua}&width={width}&height={height}&linearity={linearity}&pos={pos}&placement={placement}&site_url={site_url}&app_bundle={app_bundle}&app_name={app_name}&app_store_url={app_store_url}&bidfloor={bidfloor}&minduration={minduration}&maxduration={maxduration}&startdelay={startdelay}&category={category}&device_type={device_type}&device_make={device_make}&device_model={device_model}&os={os}&osv={osv}&lang={lang}&ifa={ifa}&series={series}&season={season}&context={context}&cb={cb}"
      }
    ],
    "StatsByDate": "https://adelion.com/api/ortb/stats/publisher/vast?username=publisher1&auth=7sdd23&zone=1&date_from={date_from}&date_to={date_to}&columns=DateStats,Requests,NetImpressions,Spent",
    "Campaigns": [
      1
    ],
    "DspRtbEps": [
      1
    ],
    "DspVastTags": [
      1
    ]
  }
}

Failure

{
  "Status": "Error",
  "Error": "[error description]"
}

Error Code	Meaning
400	Bad Request — You sent a body that isn’t JSON.
401	Unauthorized — Your access token is invalid.
406	Not Acceptable — Some value(s) inside JSON are missing or malformed, or requested object is not found.
500	Internal Server Error — We had a problem with our server. Try again later.