Skip to main content

GET Outstream Player Page

Overview

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

GET Outstream Player Page
MethodGET
URL or Endpoint/outstream-player/playerId/adscheduleId.html
HeadersAuthorization
ParametersplayerId, adscheduleId
BodyNot Applicable

The description of the URL parameters is as follows:

URL Parameter NameMandatoryTypeDescription
playerIdYesstringUnique Id of the player.
adScheduleIdYesstringUnique id of the ad schedule.

Request Body​

The request does not contain a request body

Response​

<!DOCTYPE html>
<html>
<head>
    <meta charset='utf-8'>
    <meta property='og:url' content='https://host-dev.vpplayer.tech/outstream-player/{adscheduleid}/{adscheduleid}.html'>
    <meta property='og:title' content='Test-Embed-Dev'>
    <meta property='og:type' content='adSchedule'>
    <meta property='og:video:type' content='video/mp4'>
    <meta property='og:video:height' content='650'>
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <style type='text/css'>
        #outstream-player_{adscheduleid}_{adscheduleid}_div {
            position: absolute;
        }
        .vp-window-top {
            padding: unset !important;
        }
    </style>
    <script type='text/javascript'>
    </script>
</head>
<body>

   <style>
        body {
            overflow: hidden;
            margin: 0;
            height: 100%;
            width: 100%;
        }
    </style>

    <script>
        window.biskoQueue = window.biskoQueue || [];
    </script>
    <div><div id='outstream-player_{adscheduleid}_{playerId}_div'></div></div>
    <script>
        (function () {
            var head = document.head;
            var script;
            function setupPlayer() {
                if (script) return;
                script = document.createElement('script');
                script.async = 1;
                script.src ='https://host-dev.vpplayer.tech/outstream-player/{playerId}/{adScheduleId}.js';
                head.appendChild(script);
            }

            window.addEventListener('load', function () {

                setTimeout(function () { setupPlayer(); }, 100);

                document.getElementById('outstream-player_{adscheduleid}_{playerId}_div').classList.add('vp-window-top');

            })

        })();

    </script>
</body>
</html>

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