GET Ad Schedule Config

Overview

---

The following table contains important information about the GET method in regards to receiving the ad schedule configuration as JSON.

GET Ad Schedule Config
Method	GET
URL or Endpoint	/api/projects/projectId/ad-schedules/adScheduleId.json
Headers	Authorization
Parameters	projectId, adScheduleId
Body	Not Applicable

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
projectId	Yes	string	Unique ID of the project.
adScheduleId	Yes	string	Unique ID of the ad schedule.

Request Body

The request does not contain a request body.

Response

{
  "type": "{type}",
  "isVmap": false,
  "enableProgrammability": false,
  "vmap": "{vmap}",
  "skipAllAds": false,
  "VPAIDmode": "{VPAIDmode}",
  "adBreaks": [
    {
      "adTagUrl": [
        "{adTagUrl}"
      ],
      "breakType": "{breakType}",
      "breakTimingType": "{breakTimingType}",
      "breakTimingValue": 0,
      "schedule": {
        "liveCount": 0,
        "type": "{type}",
        "protectFirst": 0,
        "protectLast": 0,
        "occurEvery": 0,
        "algorithm": "{algorithm}",
        "ranges": [
          {
            "startTime": 0,
            "endTime": "{endTime}",
            "count": 0,
            "offset": 0,
            "breaks": [
              0
            ]
          }
        ]
      }
    }
  ],
  "bidding": false,
  "bidders": [],
  "functions": [],
  "enableDemandManager": false,
  "demandManager": {
    "prebidUrl": "{prebidUrl}",
    "bidderTimeOut": 0,
    "serverTimeOut": 0,
    "coppaInventory": false,
    "enableCache": false,
    "adUnits": "{adUnits}"
  },
  "frequency": {
    "type": "{type}",
    "value": 0
  },
  "maxCap": 0,
  "initialDelay": {
    "type": "{type}",
    "value": 0
  },
  "adCycleDelayMs": 0,
  "adRetryLimit": 0,
  "adCycleRestartMs": 0
}

Information about the fields that appear when you receive the response are displayed in the table below.

Top-Level Properties

Field Name	Type	Description
type	string	The type of ad schedule.
isVmap	boolean	Indicates if the schedule uses a VMAP.
enableProgrammability	boolean	Indicates whether programmability features are enabled for ad selection.
vmap	string	The VMAP configuration URL if applicable.
skipAllAds	boolean	If true, skips all ads during playback.
VPAIDmode	string	Specifies the VPAID mode.
adBreaks	array[object]	A list of ad break configurations defining when and how ads play.
bidding	boolean	Indicates whether header bidding is active for ad selection.
bidders	array[object]	List of bidders participating in header bidding auctions.
functions	array[object]	Custom functions applied during the ad execution process.
enableDemandManager	boolean	Indicates whether the Demand Manager integration is enabled.
demandManager	object	Configuration for the Demand Manager integration.
frequency	object	Settings related to frequency capping of ad display.
maxCap	integer	Maximum number of ads to be shown overall.
initialDelay	object	Configuration for the delay before the first ad appears.
adCycleDelayMs	integer	Delay between ad cycles in milliseconds.
adRetryLimit	integer	Maximum number of retry attempts for failed ads.
adCycleRestartMs	integer	Time in milliseconds to wait before restarting the ad cycle.

adBreaks Properties

Field Name	Type	Description
adTagUrl	array[string]	List of VAST tag URLs associated with the ad break.
breakType	string	The type of break (e.g., preroll, midroll, postroll).
breakTimingType	string	Defines how the break timing is determined.
breakTimingValue	integer	The break timing value.
schedule	object	Configuration for ad repetition, protection, and algorithm rules.

schedule Properties

Field Name	Type	Description
liveCount	integer	Number of ads to show in a live stream context.
type	string	The type of scheduling strategy.
protectFirst	integer	Number of seconds to protect from ad insertion at the beginning.
protectLast	integer	Number of seconds to protect from ad insertion at the end.
occurEvery	integer	Frequency in seconds at which ads occur.
algorithm	string	The scheduling algorithm used.
ranges	array[object]	Custom time ranges within which ad breaks are applied.

ranges Properties

Field Name	Type	Description
startTime	integer	The start time of the custom ad range in seconds.
endTime	string	The end time of the custom ad range.
count	integer	The number of ads allowed in this time range.
offset	integer	Offset value applied before inserting the ad break.
breaks	array[integer]	Break points in seconds where ads are inserted.

demandManager Properties

Field Name	Type	Description
prebidUrl	string	URL to fetch Prebid.js configuration or script.
bidderTimeOut	integer	Timeout in milliseconds for bidder responses.
serverTimeOut	integer	Timeout in milliseconds for server-side auction logic.
coppaInventory	boolean	Whether inventory is marked as COPPA compliant.
enableCache	boolean	Indicates whether caching of bid responses is enabled.
adUnits	string	Ad units used in the demand configuration.

frequency Properties

Field Name	Type	Description
type	string	The type of frequency rule.
value	integer	The limit value based on the frequency type.

initialDelay Properties

Field Name	Type	Description
type	string	The type of delay.
value	integer	The delay value.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed