GET Video Player Config With Ad Schedule

Overview

---

The following table contains important information about the GET method in regards to receiving the video player video configuration.

GET Video Player Config With Ad Schedule
Method	GET
URL or Endpoint	/player/playerId/videoId/adScheduleId.json
Headers	Authorization
Parameters	playerId, videoId, adScheduleId, api-version
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 player.
videoId	Yes	string	Unique Id of the video.
adScheduleId	Yes	string	Unique Id of the ad schedule.
api-version	No	string	Correct api-version.

Request Body

The request does not contain a request body

Response

{
  "projectId": "agmipnzz",
  "config": {
    "configId": "ptkzuris",
    "biskoId": "173802",
    "recommended": false,
    "recommendedId": null,
    "autoplay": true,
    "volume": 0.5,
    "muted": true,
    "loop": false,
    "casting": false,
    "debug": false,
    "skipAmount": 1,
    "highlightCurrentVideo": true,
    "onHoverPlay": false,
    "adsRequireInteraction": false,
    "pauseOtherVideos": true,
    "focusOnAutostart": false,
    "pauseWhenRelatedIsShown": false,
    "readQualities": false,
    "enableGravityChange": false,
    "forceSound": false,
    "chromeCastApplicationId": null,
    "showPlayerControlsDuringVideoAdvertisement": false,
    "enableHapticFeedbackOnButtonClick": false,
    "enableHapticFeedbackOnPinchToZoom": false,
    "usePortraitMode": null,
    "float": {
      "state": false,
      "onMobile": false,
      "position": "TOP_RIGHT",
      "dismissible": false,
      "requiresInteraction": false,
      "style": {
        "width": "340",
        "border": null
      }
    },
    "controls": {
      "theaterButton": true,
      "settingsButton": true,
      "chromecastButton": true,
      "nextButton": true,
      "fullscreenButton": true,
      "airplayButton": true,
      "bigPlayButton": true,
      "pictureInPictureButton": false,
      "volumeButton": true,
      "shareButton": false,
      "showHelperButton": false,
      "helperButtonImage": "",
      "showLiveIcon": false,
      "delayLiveVideosTime": 0,
      "delayLiveVideos": false,
      "showAutoPlay": false,
      "showQualities": false,
      "showCaptions": false
    },
    "lang": {
      "controls": {
        "play": "Play",
        "pause": "Pause",
        "next": "Next",
        "playNow": "Play Now",
        "nextVideoCancel": "Cancel",
        "replay": "Replay",
        "volume": "Volume",
        "mute": "Mute",
        "unmute": "Unmute",
        "settings": "Settings",
        "theater": "Theater",
        "fullScreen": "FullScreen",
        "chromecast": "Chromecast",
        "airplay": "Airplay",
        "pictureInPicture": "Picture In Picture",
        "skipIntro": "Skip Intro",
        "continueWatching": "Continue Watching",
        "continueAfterPause": "Continue playing"
      },
      "settings": {
        "quality": "Quality",
        "subtitles": "Subtitles",
        "autoplay": "Autoplay",
        "playbackRate": "Playback Rate",
        "auto": "Auto",
        "off": "Off",
        "normal": "Normal",
        "share": "Share",
        "autoplayOff": "Autoplay off",
        "autoplayOn": "Autoplay on",
        "zoomedToFill": "Zoom in",
        "zoomOut": "Zoom out",
        "originalZoom": "Original Zoom",
        "captionsOff": "Captions off",
        "live": "Live",
        "chromeCastPlayingOn": "Chromecast playing",
        "dismiss": "Dismiss"
      },
      "ads": {
        "skip": "Skip",
        "skipIn": "SkipIn",
        "visit": "Visit",
        "info": "Info",
        "simultaneousAds": "Simultaneous Ads",
        "adAnnouncement": "Ad starting in "
      }
    },
    "logo": {
      "state": false,
      "file": "",
      "position": "TOP_RIGHT",
      "defaultOpacity": 1,
      "inactiveOpacity": 0.5,
      "onClickURL": ""
    },
    "skin": {
      "controlBar": {
        "text": "#FFFFFF",
        "background": "#FFFFFF00",
        "loaderColor": "#808080",
        "controlsBackgroundAlpha": null,
        "icons": {
          "default": "#FFFFFF",
          "hover": "#FFFFFF"
        },
        "timeslider": {
          "dragger": "#CC0000",
          "progress": "#CC0000",
          "rail": "#808080",
          "buffer": "#E2E2E2"
        },
        "volume": {
          "dragger": "#FFFFFF",
          "progress": "#FFFFFF",
          "rail": "#9F9F9F",
          "notifier": "#FFFFFF"
        },
        "timesliderOnAd": {
          "dragger": "#FFFFFF",
          "progress": "#F5C338",
          "rail": "#808080"
        }
      },
      "menus": {
        "background": {
          "default": "#000000",
          "hover": "#000000"
        },
        "links": {
          "default": "#FFFFFF",
          "hover": "#CC0000"
        },
        "autoplay": {
          "autoplayOn": "#CC0000",
          "autoplayOff": "#A7A7A7"
        }
      },
      "nextVideo": {
        "background": "#2E2E2E",
        "text": "#FFFFFF",
        "timeslider": {
          "rail": "#000000",
          "progress": "#FFFFFF"
        },
        "cancel": {
          "text": "#000000",
          "background": "#FFFFFF"
        },
        "playNow": {
          "text": "#000000",
          "background": "#FFFFFF"
        },
        "icons": {
          "play": {
            "default": "#FFFFFF",
            "hover": "#FFFFFF"
          },
          "close": "#FFFFFF"
        }
      },
      "playlist": {
        "background": "#2E2E2E",
        "text": "#FFFFFF",
        "card": {
          "background": "#000000",
          "title": "#FFFFFF",
          "duration": {
            "text": "#FFFFFF",
            "background": "#1A1A1A"
          },
          "icons": {
            "play": {
              "default": "#FFFFFF",
              "hover": "#FFFFFF"
            }
          }
        },
        "icons": {
          "arrows": {
            "active": "#FFFFFF",
            "inactive": "#666666"
          },
          "close": "#FFFFFF"
        }
      }
    },
    "size": {
      "sizeType": "RESPONSIVE",
      "aspectRatio": "16:9",
      "width": 640,
      "height": 360
    },
    "autostartOnLoad": {
      "state": false,
      "onMobile": false,
      "onData": false
    },
    "autostartOnViewable": {
      "state": false,
      "onMobile": false,
      "onData": false,
      "percentageViewable": 0.5
    },
    "autopauseOnViewable": {
      "state": false,
      "percentageViewable": 0.5
    },
    "showRelatedOnPause": {
      "state": true,
      "onMobile": false,
      "from": 0.9
    },
    "socialMedia": null,
    "playbackRates": [
      0.25,
      0.5,
      0.75,
      1,
      1.25,
      1.5,
      1.75,
      2
    ],
    "prebid": {
      "configId": "malltv-video",
      "customHostUrl": "https://prebid-server.gjirafa.dev/openrtb2/auction",
      "accountId": "stored-request"
    },
    "autopauseOnCuepoint": {
      "state": false,
      "timeToPause": 0,
      "continueUnmuted": false,
      "onDesktop": false,
      "onMobile": false,
      "svgFile": ""
    },
    "adAnnouncement": {
      "state": true,
      "timeBeforeAd": 5
    },
    "afterMidrollBacktrack": {
      "state": true,
      "seconds": 3
    }
  },
  "video": {
    "videoId": "vjsnjqfa",
    "file": "https://cdn.vpplayer.tech/agmipnzz/encode/vjsnjqfa/hls/master_file.m3u8",
    "title": "pexels-shvets-production-7205597",
    "description": "",
    "publishDate": "2022-07-28 16:28:12",
    "assetId": "",
    "hasDrm": false,
    "drmLicenseUrl": null,
    "fpsCertificateUrl": null,
    "widevineLicenseUrl": null,
    "castContentType": "application/x-mpegurl",
    "castVideoSource": "",
    "thumbnail": "https://cdn.vpplayer.tech/agmipnzz/encode/vjsnjqfa/thumbnails/retina.jpg",
    "filmstrip": "https://cdn.vpplayer.tech/agmipnzz/encode/vjsnjqfa/thumbnails/filmstrip0.jpg",
    "live": false,
    "liveType": "",
    "autoRelated": "",
    "relatedVideos": "",
    "shareUrl": "",
    "tracks": [],
    "adId": "smyrfbxt",
    "startTime": 0,
    "advertising": true,
    "ads": {
      "type": "DYNAMIC",
      "isVmap": false,
      "enableProgrammability": false,
      "vmap": null,
      "VPAIDmode": null,
      "adBreaks": [
        {
          "adTagUrl": [
            "string"
          ],
          "breakType": "midroll",
          "breakTimingType": "time",
          "breakTimingValue": 0,
          "schedule": {
            "liveCount": 0,
            "type": "RECURRING",
            "protectFirst": 0,
            "protectLast": 0,
            "occurEvery": 30,
            "algorithm": null,
            "ranges": [
              {
                "startTime": 0,
                "endTime": null,
                "count": 1,
                "breaks": [
                  50
                ]
              }
            ]
          }
        }
      ],
      "bidding": false,
      "bidders": [],
      "functions": []
    },
    "playlist": {
      "state": false,
      "playlistId": "",
      "playlistVideoIndex": -1,
      "algorithm": "",
      "shareUrl": null
    },
    "skipIntro": {
      "state": false,
      "skipFrom": null,
      "skipTo": null
    },
    "flags": [
      "pr_video"
    ]
  }
}

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