Add RTB EP

This endpoint adds RTB EP.

HTTP Request

POST https://adelion.com/api/ortb/rtbep/add`

Parameter	Type	Description	Requirement
PublisherId	`int`	Owner publisher’s ID.	required
Name	`string`	RTB EP’s name.	optional
Tags	`int[]`	List of Tags’ IDs.	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 RTB EP’s publisher earns.	optional
RevenueCountingMethod	`int`	Determines how spend and revenue is counted: 0 - nurl, 1 - burl, 2 - Markup Display.	optional
CheckAdsTxt	`int`	Check ads.txt for the site: 0 - No, 1 - Yes, allow supplier until crawled, 2 - Yes, deny supplier until crawled.	optional
CheckAppAdsTxt	`int`	Check app-ads.txt for the app: 0 - No, 1 - Yes, allow supplier until crawled, 2 - Yes, deny supplier until crawled.	optional
CheckSellersJson	`int`	Check sellers.json for the supplier: 0 - No, 1 - Yes, allow supplier until crawled, 2 - Yes, deny supplier until crawled.	optional
MaxQps	`int`	Maximum queries per second - Maximum number of requests to receive from the RTB EP in one second. Set to 0 for unlimited requests.	optional
TmaxAdjust	`int`	Subtraction in milliseconds from received tmax from the publisher. Useful for compensating latency from publisher to our servers.	optional
AutoOptimize	`int`	Enable automatic requests optimization. 0 - Disabled, 1 - Enabled.	optional
PopAdmXml	`int`	Enable XML in adm field in bid response for Pop ads. 0 - Disabled, 1 - Enabled.	optional
PrebidJs	`int`	Determines if RTB EP is Prebid.js endpoint. 0 - No, 1 - Yes.	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 RTB EP. Set to 0 for unlimited amount.	optional
BannerEnabled	`int`	Enable Banner Ads. 0 - Disabled, 1 - Enabled.	optional
VideoEnabled	`int`	Enable Video Ads. 0 - Disabled, 1 - Enabled.	optional
AudioEnabled	`int`	Enable Audio Ads. 0 - Disabled, 1 - Enabled.	optional
NativeEnabled	`int`	Enable Native Ads. 0 - Disabled, 1 - Enabled.	optional
PopEnabled	`int`	Enable Pop Ads. 0 - Disabled, 1 - Enabled.	optional
WebEnabled	`int`	Enable Web traffic. 0 - Disabled, 1 - Enabled.	optional
AppEnabled	`int`	Enable App traffic. 0 - Disabled, 1 - Enabled.	optional
MinBidfloor	`float`	Allow bid request only if Bidfloor is greater than this value.	optional
MaxBidfloor	`float`	Allow bid request only if Bidfloor is less than this value.	optional
MaxIvt	`float`	Filter traffic from inventory with IVT greater than this value.	optional
MaxSchainNodes	`int`	Allow only requests with maximum schain nodes (hops) of 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
PubIdListMode	`int`	Block or allow Pub IDs: 0 - Blacklist, 1 - Whitelist.	optional
PubIdList	`string`	List of Pub IDs to block or allow, separated by new line.	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
Schain	`int`	Allow only requests with schain. 1 - Enabled, 0 - Disabled.	optional
CompleteSchain	`int`	Allow only requests with complete schain. 1 - Enabled, 0 - Disabled.	optional
PreventSchainLoop	`int`	Block requests with own schain node, if any schain node has “asi” value equal to own schain (sellers.json) domain. 1 - Enabled, 0 - Disabled.	optional
IabCategories	`string[]`	IAB categories of the site/app to enable (filter) for RTB EP. See Info -> Get IAB categories for a list of available categories.	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
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 RTB EP. This will make the Campaign Ad appear in RTB EP response if all the targeting is matched.	optional
DspRtbEps	`int[]`	Array of DSP RTB EPs’ IDs to connect to the RTB EP. This will make the DSP RTB EP appear in RTB EP response if all the targeting is matched.	optional
DspVastTags	`int[]`	Array of DSP VAST Tags’ IDs to connect to the RTB EP. This will make the DSP VAST Tag appear in RTB EP response if all the targeting is matched.	optional
DspPopFeeds	`int[]`	Array of XML DSP Pop Feeds’ IDs to connect to the RTB EP. This will make the XML DSP Pop Feed appear in RTB EP response if all the targeting is matched.	optional

{
  "RtbEp": {
    "PublisherId": 1,
    "Name": "RTB EP 1",
    "Tags": [
      1
    ],
    "DspBidfloorMargin": 5.0,
    "PublisherProfitShare": 90.0,
    "RevenueCountingMethod": 2,
    "CheckAdsTxt": 1,
    "CheckAppAdsTxt": 1,
    "CheckSellersJson": 1,
    "MaxQps": 0,
    "TmaxAdjust": 0,
    "AutoOptimize": 1,
    "PopAdmXml": 0,
    "PrebidJs": 0,
    "RequestsDailyLimit": 0,
    "BidsDailyLimit": 0,
    "ImpressionsDailyLimit": 0,
    "ImpressionsLimitPerIp": 5,
    "SpentDailyLimit": 0.0,
    "BannerEnabled": 1,
    "VideoEnabled": 1,
    "AudioEnabled": 1,
    "NativeEnabled": 1,
    "PopEnabled": 1,
    "WebEnabled": 1,
    "AppEnabled": 1,
    "MinBidfloor": 0.0,
    "MaxBidfloor": 20.0,
    "MaxIvt": 50.0,
    "MaxSchainNodes": 0,
    "DomainsBrandsListMode": 0,
    "DomainsBrandsList": [
      1
    ],
    "AppsListMode": 0,
    "AppsList": [
      1
    ],
    "SizesListMode": 1,
    "SizesList": [
      "300x250",
      "320x480"
    ],
    "PubIdListMode": 0,
    "PubIdList": "",
    "IpBlacklists": [
      1
    ],
    "NonEmptyReferer": 1,
    "RefererMatch": 1,
    "IpMatch": 1,
    "UaMatch": 1,
    "AllowIpV6": 1,
    "CheckSiteLive": 0,
    "CheckAppStore": 0,
    "Schain": 0,
    "CompleteSchain": 0,
    "PreventSchainLoop": 1,
    "IabCategories": [
      "IAB1-1",
      "IAB2-1",
      "IAB3"
    ],
    "AdDomainsBrandsBlacklist": "",
    "AdAppsBlacklist": "",
    "CridListMode": 0,
    "CridList": "",
    "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
    ],
    "DspPopFeeds": [
      1
    ]
  }
}

Response

{
  "Status": "Ok",
  "RtbEp": {
    "Id": 1,
    "TeamId": 1,
    "PublisherId": 1,
    "PublisherName": "Publisher",
    "Name": "RTB EP 1",
    "Tags": [
      1
    ],
    "DspBidfloorMargin": 5.0,
    "PublisherProfitShare": 90.0,
    "RevenueCountingMethod": 2,
    "CheckAdsTxt": 1,
    "CheckAppAdsTxt": 1,
    "CheckSellersJson": 1,
    "MaxQps": 0,
    "TmaxAdjust": 0,
    "AutoOptimize": 1,
    "PopAdmXml": 0,
    "PrebidJs": 0,
    "RequestsDailyLimit": 0,
    "BidsDailyLimit": 0,
    "ImpressionsDailyLimit": 0,
    "ImpressionsLimitPerIp": 5,
    "SpentDailyLimit": 0.0,
    "BannerEnabled": 1,
    "VideoEnabled": 1,
    "AudioEnabled": 1,
    "NativeEnabled": 1,
    "PopEnabled": 1,
    "WebEnabled": 1,
    "AppEnabled": 1,
    "MinBidfloor": 0.0,
    "MaxBidfloor": 20.0,
    "MaxIvt": 50.0,
    "MaxSchainNodes": 0,
    "DomainsBrandsListMode": 0,
    "DomainsBrandsList": [
      1
    ],
    "AppsListMode": 0,
    "AppsList": [
      1
    ],
    "SizesListMode": 1,
    "SizesList": [
      "300x250",
      "320x480"
    ],
    "PubIdListMode": 0,
    "PubIdList": "",
    "IpBlacklists": [
      1
    ],
    "NonEmptyReferer": 1,
    "RefererMatch": 1,
    "IpMatch": 1,
    "UaMatch": 1,
    "AllowIpV6": 1,
    "CheckSiteLive": 0,
    "CheckAppStore": 0,
    "Schain": 0,
    "CompleteSchain": 0,
    "PreventSchainLoop": 1,
    "IabCategories": [
      "IAB1-1",
      "IAB2-1",
      "IAB3"
    ],
    "AdDomainsBrandsBlacklist": "",
    "AdAppsBlacklist": "",
    "CridListMode": 0,
    "CridList": "",
    "Countries": [
      {
        "CC": "US",
        "Country": "United States"
      }
    ],
    "Os": [
      {
        "Family": "Windows",
        "Versions": [
          {
            "Major": "10",
            "Minor": ""
          }
        ]
      }
    ],
    "Browsers": [
      {
        "Family": "Chrome"
      }
    ],
    "DeviceTypes": [
      1,
      2,
      3,
      4,
      5
    ],
    "Auth": "druw8f",
    "Qps": 534,
    "AccManagerId": 5,
    "AccManagerName": "John Doe",
    "Status": 0,
    "StatusString": "Active",
    "ZoneUrls": [
      {
        "Region": "us-east",
        "ZoneUrl": "https://us-east1.adelion.com/rtb?zone=1&auth=I6rQH0"
      }
    ],
    "StatsByDate": "https://adelion.com/api/ortb/stats/publisher/rtb?username=publisher1&auth=7sdd23&zone=1&date_from={date_from}&date_to={date_to}&columns=DateStats,Requests,Wins,Bills,NetImpressions,Spent",
    "Campaigns": [
      1
    ],
    "DspRtbEps": [
      1
    ],
    "DspVastTags": [
      1
    ],
    "DspPopFeeds": [
      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.