GET Ad Schedule Config

Overview

---

The following table contains important information about the GET method in regards to receiving the ad schedule's configuration in json.

GET Playlist by PublicId
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": "string",
  "isVmap": true,
  "enableProgrammability": true,
  "vmap": "string",
  "skipAllAds": true,
  "VPAIDmode": "string",
  "adBreaks": [
    {
      "adTagUrl": [
        "string"
      ],
      "breakType": "string",
      "breakTimingType": "string",
      "breakTimingValue": 0,
      "schedule": {
        "liveCount": 0,
        "type": "string",
        "protectFirst": 0,
        "protectLast": 0,
        "occurEvery": 0,
        "algorithm": "string",
        "ranges": [
          {
            "startTime": 0,
            "endTime": "string",
            "count": 0,
            "offset": 0,
            "breaks": [
              0
            ]
          }
        ]
      }
    }
  ],
  "bidding": true,
  "bidders": [],
  "functions": [],
  "enableDemandManager": true,
  "demandManager": {
    "prebidUrl": "string",
    "bidderTimeOut": 0,
    "serverTimeOut": 0,
    "coppaInventory": true,
    "enableCache": true,
    "adUnits": "string"
  },
  "frequency": {
    "type": "string",
    "value": 0
  },
  "maxCap": 0,
  "initialDelay": {
    "type": "string",
    "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.

Field Name	Type	Description
type	string	The type of ad schedule.
isVmap	bool	Indicates if the schedule uses a VMAP.
enableProgrammability	bool	Specifies whether programmability features are enabled for ad selection.
vmap	string	The VMAP configuration or URL if applicablied.
skipAllAds	bool	If true, skips all ads during playback.
VPAIDmode	string	Specifies the mode of VPAID.
adBreaks	array	A list of ad break configurations defining when and how ads play.
adTagUrl	array	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	number	Specifies the break timing value.
schedule	object	Configuration object for ad repetition, protection, and algorithm rules.
liveCount	number	Number of ads to show in a live stream context.
type	string	The type of scheduling strategy.
protectFirst	number	Number of content units to protect from ad insertion at the beginning.
protectLast	number	Number of content units to protect from ad insertion at the end.
occurEvery	number	Frequency at which ads occur.
algorithm	string	Specifies the scheduling algorithm.
ranges	array	Custom time ranges within which ad breaks should be applied.
startTime	number	The start time of the custom ad range.
endTime	string	The end time of the custom ad range.
count	number	The number of ads allowed in this time range.
offset	number	Offset value applied before inserting the ad break.
breaks	array	Break points in time where ads should be inserted.
bidding	bool	Determines whether header bidding is active for ad selection.
bidders	array	List of bidders participating in header bidding auctions.
functions	array	Custom functions that can be applied during the ad execution process.
enableDemandManager	bool	Enables the Demand Manager integration for managing ad demand sources.
demandManager	object	Configuration for the Demand Manager integration.
prebidUrl	string	URL to fetch Prebid.js configuration or script.
bidderTimeOut	number	Timeout (in ms) for how long to wait for bidders to respond.
serverTimeOut	number	Timeout (in ms) for server-side auction logic to complete.
coppaInventory	bool	Whether inventory should be marked as COPPA (child-appropriate) compliant.
enableCache	bool	Indicates whether caching of bid responses is enabled.
adUnits	string	Ad units used in the demand configuration.
frequency	object	Settings related to frequency capping of ad display.
type	string	The type of frequency rule.
value	number	The value that defines the limit based on the frequency type.
maxCap	number	Defines the maximum number of ads to be shown overall.
initialDelay	object	Configuration for the delay before the first ad appears.
type	string	Type of delay (e.g., fixed, dynamic).
value	number	Value of the delay in seconds or milliseconds.
adCycleDelayMs	number	Delay between ad cycles in milliseconds.
adRetryLimit	number	Maximum number of retry attempts for failed ads.
adCycleRestartMs	number	Time in milliseconds to wait before restarting the ad cycle.

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