GET Ad Schedule Config

Overview

---

The following table contains important information about the GET method in regards to receiving the ad schedule configuration by id for the vertical player.

GET Ad Schedule Config
Method	GET
URL or Endpoint	/vertical-player/adSchedule/adScheduleId.json
Headers	Not Applicable
Parameters	adScheduleId
Body	Not Applicable

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
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": [],
  "bidding": false,
  "bidders": [],
  "functions": [],
  "enableDemandManager": false,
  "demandManager": null,
  "frequency": null,
  "maxCap": 0,
  "initialDelay": null,
  "adCycleDelayMs": 0,
  "adRetryLimit": 0,
  "adCycleRestartMs": 0,
  "banner": null,
  "overrides": {
    "state": false,
    "prerollCount": 0,
    "cuepoints": []
  }
}

The description of the response fields is as follows:

Top-Level Properties

Field Name	Type	Description
type	string	Type of ad breaks (e.g., "DYNAMIC", "STATIC").
isVmap	boolean	Whether the ad schedule uses VMAP format.
enableProgrammability	boolean	Whether ad programmability is enabled.
vmap	string	URL of the VMAP ad schedule.
skipAllAds	boolean	Whether all ads can be skipped.
VPAIDmode	string	VPAID rendering mode.
adBreaks	array[object]	List of ad break configurations.
bidding	boolean	Whether header bidding is enabled.
bidders	array[object]	List of header bidding bidder configurations.
functions	array[object]	List of ad macro function configurations.
enableDemandManager	boolean	Whether the demand manager (prebid) is enabled.
demandManager	object	Demand manager (prebid) configuration.
frequency	object	Ad frequency capping configuration.
maxCap	integer	Maximum number of ad impressions per frequency period.
initialDelay	object	Initial delay configuration before the first ad plays.
adCycleDelayMs	integer or null	Delay in milliseconds between ad cycles.
adRetryLimit	integer or null	Maximum number of ad request retries on failure.
adCycleRestartMs	integer or null	Time in milliseconds before an ad cycle restarts.
banner	object	Banner ad configuration.
overrides	object	Per-video ad overrides configuration.

overrides Properties

Field Name	Type	Description
state	boolean	Whether video-level ad overrides are active.
prerollCount	integer	The number of preroll ads to play, overriding the ad schedule default.
cuepoints	array[integer]	List of custom midroll ad cue point times in seconds.

If the action is successful, the service sends back an HTTP 200 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