Skip to main content

GET Player Script

Overview

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

GET Player Script
MethodGET
URL or Endpoint/player/playerId.json
HeadersAuthorization
ParametersplayerId, api-version
BodyNot Applicable

The description of the URL parameters is as follows:

URL Parameter NameMandatoryTypeDescription
playerIdYesstringUnique Id of the player.
api-versionNostringCorrect 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": null,
    "file": null,
    "title": null,
    "description": null,
    "publishDate": null,
    "assetId": null,
    "hasDrm": false,
    "drmLicenseUrl": null,
    "fpsCertificateUrl": null,
    "widevineLicenseUrl": null,
    "castContentType": null,
    "castVideoSource": null,
    "thumbnail": null,
    "filmstrip": null,
    "live": false,
    "liveType": null,
    "autoRelated": null,
    "relatedVideos": null,
    "shareUrl": null,
    "tracks": [],
    "adId": "smyrfbxt",
    "startTime": 0,
    "advertising": true,
    "ads": {
      "type": "DYNAMIC",
      "isVmap": false,
      "enableProgrammability": false,
      "vmap": null,
      "VPAIDmode": null,
      "adBreaks": [
        {
          "adTagUrl": [
            "https://pubads.g.doubleclick.net/gampad/ads?iu=/21869710533/cvc260/mall_tv/midroll_1/bigplayer/temna_doba&tfcd=0&npa=0&sz=1920x1080%7C1280x720%7C1024x576%7C768x576%7C640x480%7C640x360%7C&gdfp_req=1&output=vast&unviewed_position_start=1&vad_type=linear&env=vp&impl=s&cust_params=L2%3Dcvc260%26site%3Dmall_tv%26template%3Dbigplayer%26target_position%3Dmidroll_1%26area%3Dtemna_doba%26URL%3Dtemna-doba%2Csilene-podminky-v-koncentracnim-tabore-v%26keywords%3Dmall_tv%2Csilene_podminky_v_koncentracnim_tabore_v_hodonine_u_kunstatu_byly_predzvesti_tragickeho_osudu_moravskych_romu%2Ctemna_doba%2Cjiri_padevet%2Cvzdelavani%2Cdrama%2Cspolecnost%2Chistorie%2C5_10_minut%26safety%3D%26bisko%3D27567%2C27623%2C27637%2C27644%2C27980%2C27987%2C28295%2C28302%2C28603%2C28939%2C29009%2C29030%2C29135%2C29142%2C27910%2C29184%2C29233%2C29254%2C29338%2C29450%2C28428%2C28372%2C28365%2C29576%2C29520%2C29632%2C29982%2C30556%2C30598%2C28435%2C29443%2C27917%2C30633%2C30752%2C30822%2C29471%2C29457%2C29478%2C29464%2C30619%2C30682%2C30836%2C29527"
          ],
          "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": []
  }
}

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