GET Vertical Player Config with Ad Schedule

Overview

---

The following table contains important information about the GET method in regards to receiving the vertical player configuration for a specific video with a specific ad schedule.

GET Vertical Player Config with Ad Schedule
Method	GET
URL or Endpoint	/vertical-player/playerId/videoId/adScheduleId.json
Headers	Not Applicable
Parameters	playerId, videoId, adScheduleId
Body	Not Applicable

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
playerId	Yes	string	Unique Id of the vertical player.
videoId	Yes	string	Unique Id of the video.
adScheduleId	Yes	string	Unique Id of the ad schedule.

Request Body

The request does not contain a request body

Response

{
  "projectId": "{projectId}",
  "video": {
    "videoId": "{videoId}",
    "file": "{file}",
    "title": "{title}",
    "description": "{description}",
    "publishDate": "2024-05-28T11:44:17.062Z",
    "publishEndDate": "2024-05-28T11:44:17.062Z",
    "private": false,
    "protected": false,
    "passwordProtectedTitle": "{passwordProtectedTitle}",
    "passwordProtectedDescription": "{passwordProtectedDescription}",
    "chapterState": false,
    "chapterPath": "{chapterPath}",
    "assetId": "{assetId}",
    "hasGeoRestriction": false,
    "geoRestrictionLink": "{geoRestrictionLink}",
    "hasDrm": false,
    "drmLicenseUrl": "{drmLicenseUrl}",
    "fpsCertificateUrl": "{fpsCertificateUrl}",
    "widevineLicenseUrl": "{widevineLicenseUrl}",
    "castContentType": "{castContentType}",
    "castVideoSource": "{castVideoSource}",
    "thumbnail": "{thumbnail}",
    "filmstrip": "{filmstrip}",
    "filmstripVtt": "{filmstripVtt}",
    "live": false,
    "liveType": "{liveType}",
    "maxLiveBackDuration": 0,
    "autoRelated": "{autoRelated}",
    "relatedVideos": "{relatedVideos}",
    "shareUrl": "{shareUrl}",
    "source": "{source}",
    "author": "{author}",
    "tracks": [
      {
        "file": "{trackFile}",
        "lang": "{lang}",
        "label": "{label}"
      }
    ],
    "adId": "{adId}",
    "startTime": 0,
    "advertising": false,
    "showEngagementHeatmap": false,
    "ads": {
      "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": []
      }
    },
    "playlist": {
      "state": false,
      "playlistId": "{playlistId}",
      "playlistVideoIndex": 0,
      "algorithm": "{algorithm}",
      "shareUrl": "{shareUrl}",
      "displayType": "{displayType}",
      "fromRecommended": false
    },
    "skipIntro": {
      "state": false,
      "skipFrom": 0,
      "skipTo": 0
    },
    "flags": [],
    "tags": [],
    "customOverlays": {
      "state": false,
      "overlays": []
    },
    "videoLocking": {
      "isEnabled": false,
      "value": 0
    },
    "videoProperties": []
  },
  "config": {
    "configId": "{configId}",
    "biskoId": "{biskoId}",
    "recommended": false,
    "recommendedId": "{recommendedId}",
    "muted": false,
    "autoplay": true,
    "loop": false,
    "playlistLoop": false,
    "swipeToSkip": false,
    "autoHideOverlay": false,
    "showAuthor": false,
    "showPublishDate": false,
    "size": {
      "sizeType": "{sizeType}",
      "height": 0
    },
    "lang": {
      "controls": {
        "play": "{play}",
        "pause": "{pause}",
        "mute": "{mute}",
        "unmute": "{unmute}",
        "fullscreen": "{fullscreen}",
        "minimize": "{minimize}",
        "settings": "{settings}",
        "more": "{more}",
        "less": "{less}",
        "previous": "{previous}",
        "next": "{next}",
        "live": "{live}"
      },
      "settings": {
        "share": "{share}",
        "copy": "{copy}",
        "copyLink": "{copyLink}",
        "off": "{off}",
        "playbackRate": "{playbackRate}",
        "normal": "{normal}",
        "quality": "{quality}",
        "auto": "{auto}"
      }
    },
    "controls": {
      "play": false,
      "seekbar": false,
      "text": false,
      "fullscreen": true,
      "share": true,
      "settings": true
    },
    "skin": {
      "text": "{text}",
      "buttons": {
        "icon": "{icon}",
        "background": "{background}"
      },
      "seekbar": {
        "rail": "{rail}",
        "buffer": "{buffer}",
        "progress": "{progress}",
        "dragger": "{dragger}"
      }
    },
    "autostartOnViewable": {
      "state": false,
      "onMobile": false,
      "onData": false,
      "percentageViewable": 0.5
    },
    "autopauseOnViewable": {
      "state": false,
      "percentageViewable": 0.5
    },
    "soundSubtitleInversion": false,
    "socialMedia": []
  }
}

The response structure is identical to the GET Vertical Player Config endpoint, with the ad schedule applied to the video's ad configuration. Refer to that endpoint for complete field descriptions.

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