GET Player by PublicId

Overview

---

The following table contains important information about the GET method in regards to receiving the player by using the public ID.

GET Player by PublicId
Method	GET
URL or Endpoint	/api/projects/projectId/players/id
Headers	Authorization
Parameters	projectId, id
Body	Not Applicable

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
projectId	Yes	string	Unique Id of the project.
id	Yes	string	Unique id of the player.

Request Body

The request does not contain a request body

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "publicId": "ptkzupxi",
    "name": "Player with updated config renamed",
    "loopContent": true,
    "muteOnStart": true,
    "floatOnScroll": true,
    "autoPauseWhenNotViewable": false,
    "enablePlayBackRateControls": false,
    "sharing": true,
    "casting": true,
    "googleAnalytics": true,
    "includeCompatibilityScript": true,
    "showContentTitle": true,
    "showContentDescription": true,
    "showControls": false,
    "recommendation": false,
    "advertising": false,
    "showControlsOnVPAID": true,
    "outstreamPlayer": true,
    "dispAdverisementAbove": true,
    "autoCollapseAfterAds": true,
    "preloadAds": false,
    "companionAds": false,
    "playAdsMuted": true,
    "keepVisibleWhenControlsHidden": false,
    "debug": null,
    "theaterButton": true,
    "chromeCastButton": null,
    "nextButton": null,
    "airplayButton": null,
    "settingsButton": true,
    "bigPlayButton": null,
    "autoPlay": null,
    "muted": null,
    "floatDismissible": null,
    "logoOn": false,
    "adsRequireInteraction": null,
    "focusOnAutoStart": null,
    "floatOnMobile": null,
    "floatRequiresInteraction": null,
    "floatWidth": null,
    "logoUrl": "",
    "logoOnClickUrl": null,
    "logoDefaultOpacity": 1,
    "logoInactiveOpacity": 0.5,
    "channelUrl": null,
    "cloudHostedPlayerLibrary": "https://vp-dev.gjirafa.net/player/ptkzupxi.js",
    "width": null,
    "height": 340,
    "adScheduleId": null,
    "playerSizeTypeId": 1,
    "preloadOptionId": 1,
    "defaultBandwidthEstimateOptionId": 1,
    "sharingTypeId": null,
    "logoPositionOptionId": 1,
    "floatPositionOptionId": 4,
    "responsiveSizeOptionId": 1,
    "releaseChannelId": 7,
    "sharingTooltip": "",
    "rightClickText": "",
    "rightClickUrl": "",
    "countDownMessage": "This video will resume in xx seconds MSGGGGG",
    "cueText": "Advertisement REKLAMA",
    "skipCountDown": null,
    "companionAdsDivID": null,
    "companionAdsWidth": 0,
    "companionAdsHeight": 0,
    "volume": null,
    "skipAmount": null,
    "Play": "Play",
    "Pause": "Pause",
    "Next": "Next",
    "Replay": "Replay",
    "Volume": "Volume",
    "Mute": "Mute",
    "UnMute": "Unmute",
    "Settings": "Settings",
    "FullScreen": "FullScreen",
    "Chromecast": "Chromecast",
    "Airplay": "Airplay",
    "Quality": "Quality",
    "Subtitles": "Subtitles",
    "Theater": "Theater",
    "Skip": null,
    "SkipIn": null,
    "Visit": null,
    "Info": null,
    "autoStartOn": false,
    "autoStartOnData": false,
    "autoStartPlayPercentage": 0,
    "autoPauseOn": false,
    "autoPausePercentage": 0,
    "pauseOtherVideos": false,
    "autoStartOnLoad": null,
    "autoStartOnLoadMobile": null,
    "autoStartOnLoadOnData": null,
    "autoStartOnViewableOn": null,
    "autoStartOnViewableMobile": null,
    "autoStartOnViewableOnData": null,
    "autoStartOnViewablePercentage": null,
    "autoPauseOnViewableOn": null,
    "autoPauseOnViewablePercentage": null,
    "releaseChannel": {
      "id": 7,
      "name": "v1.5",
      "originalPath": "vpplayer/templates/v15/vp-player.js",
      "templateOriginalPath": "https://vp-dev.gjirafa.net/vps/vpplayer/templates/v15/vp-player.js"
    },
    "playerSizeType": {
      "id": 1,
      "name": "Responsive"
    },
    "preloadOption": {
      "id": 1,
      "name": "None",
      "value": "none",
      "tooltipText": "Incurs no additional bandwidth usage, but does not ensure immediate playback. The player begins to load media only when the viewer clicks play."
    },
    "defaultBandwidthEstimateOption": {
      "id": 1,
      "name": "None",
      "value": "0"
    },
    "sharingType": null,
    "responsiveSizeOption": {
      "id": 1,
      "name": "16:9"
    },
    "logoPositionOption": {
      "id": 1,
      "name": "Top right (default)",
      "value": "TOP_RIGHT"
    },
    "floatPositionOption": {
      "id": 4,
      "name": "Bottom left",
      "value": "BOTTOM_LEFT"
    },
    "adSchedule": null,
    "defaultConfig": null,
    "playerSocialNetworks": [],
    "controlBarTextColor": "ffffff",
    "controlBarIconsDefaultColor": "ffffff",
    "controlBarIconsHoverColor": "ffffff",
    "controlBarTimesliderProgressColor": "cc0000",
    "controlBarTimesliderRailColor": "808080",
    "controlBarTimesliderDraggerColor": "ffffff",
    "controlBarBackgroundColor": "ffffff00",
    "controlBarTimesliderBufferColor": "e2e2e2",
    "controlBarVolumeDraggerColor": "ffffff",
    "controlBarVolumeProgressColor": "ffffff",
    "controlBarVolumeRailColor": "9f9f9f",
    "controlBarVolumeNotifierColor": "ffffff",
    "controlBarTimeSliderOnAdDraggerColor": "ffffff",
    "controlBarTimeSliderOnAdProgressColor": "f5c338",
    "controlBarTimeSliderOnAdRailColor": "808080",
    "menuLinksDefaultColor": "ffffff",
    "menuLinksHoverColor": "cc0000",
    "menuBackroundDefaultColor": "000000",
    "menuBackroundHoverColor": "000000",
    "menuAutoplayOnColor": "cc0000",
    "menuAutoplayOffColor": "a7a7a7",
    "tooltipsTextColor": "ffffff",
    "tooltipsBackroundColor": "ffffff"
  },
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
publicId	string	The public ID of the player.
name	string	The name of the player.
loopContent	bool	Indicates whether the content should be looped.
muteOnStart	bool	Indicates whether the player is muted on start.
floatOnScroll	bool	Indicates whether the player should be in a float state when scrolling.
autoPauseWhenNotViewable	bool	Indicates whether the player should pause when it becomes unviewbale.
enablePlaybackRateControls	bool	Indicates whther the playback rate controls are enabled.
sharing	bool	Indicates whether the sharing option is available.
casting	bool	Indicates whether the casting option is available.
googleAnalytics	bool	Indicates whether Google Analytics are enabled.
includeCompatibilityScript	bool	Indicates wether the compatibility script is included.
showContentTitle	bool	Indicates whether the player should show the content title.
showContentDescription	bool	Indicates whether the playr should show the content description.
showControls	bool	Indicates whether the playr should show the controls.
recommendation	bool	Indicates whether the recommendation section is enabled.
advertising	bool	Indicates whether advertising is enabled.
showControlsOnVPAID	bool	Indicates whether the player should show the controls on VPAID.
oustreamPlayer	bool	Indicates whether the player is outstreamed.
dispAdvertisementAbove	bool	Indicates whether the advertisement above the player should be displayed.
autoCollapseAfterAds	bool	Indicates whether the player should auto collapse after ads.
preloadAds	bool	Indicates whether ads should be preloaded.
companionAds	bool	Indicates whether companion ads are enabled.
playAdsMuted	bool	Indicates whether ads should be played on mute
keepVisibleWhenControlsHidden	bool	Indicates whether the player is visible when the controls are hidden.
debug	bool	Indicates wether debugging is enabled.
chromeCastButton	bool	Indicates whether the chromecast button is enabled.
nextButton	bool	Indicates whether the next button is enabled.
airplayButton	bool	Indicates whether the airplay button is enabled.
settingsButton	bool	Indicates whether the settings button is enabled.
bigPlayButton	bool	Indicates whether the main play button is enabled.
autoPlay	bool	Indicates whether auto play is enabled.
muted	bool	Indicates whether the player is muted.
floatDismissible	bool	Indicates whether the float option is dismissible.
logoOn	bool	Indicates whether the logo is on the player.
adsRequireInteraction	bool	Indicates whether the ads require interaction.
focusOnAutoStart	bool	Indicates whether the player is in a focus state on auto start.
floatOnMobile	bool	Indicates whether the player should have a float state on mobile versions.
floatRequiresInteraction	bool	Indicates whether the float option requires interaction.
floatWidth	string	Indicates the width of the float
logoUrl	string	The URL of the logo.
logoOnClickUrl	string	The URL of the "on click" state of the logo.
logoDefaultOpacity	integer($int32)	The default opacity of the logo.
logoInactiveOpacity	integer($int32)	The opacity of the logo when it is inactive.
channelUrl	string	The URL of the channel.
cloudHostedPlayerLibrary	string	The URL of the cloud hosted player library.
width	integer($int32)	The width of the player.
height	integer($int32)	The height of the player
adScheduleId	integer($int32)	The Id of the ad schedule.
playerSizeTypeId	integer($int32)	The Id of the player size type.
prelaodOption	integer($int32)	The preload option.
defaultBandwidthEstimateOption	integer($int32)	The default bandwidth estimate option.
sharingTypeId	integer($int32)	The id of the sharing type.
logoPositionOptionId	integer($int32)	The id of the logo position option.
floatPositionOption	integer($int32)	The id of the float position option.
responsiveOptionId	integer($int32)	The id of the responsive option.
releaseChannelId	integer($int32)	The id of the release channel.
sharingTooltip	string	The sharing tooltip. Appears when the cursor is positioned over the sharing icon.
rightClickText	string	The text that appears when you right-click.
rightClickUrl	string	The URL of the right-click.
countDownMessage	string	Indicates the time until the video starts.
cueText	string	The cue text of the ad.
skipCountDown	string	Indicates whether the countdown should be skipped.
companionAdsDivId	string	The div id of the companion ads.
companionAdsWidth	integer($int32)	The height of the companion ad.
companionAdsHeight	integer($int32)	The height of the companion ad.
volume	integer($int32)	The volume of the player.
skipAmount	integer($int32)	The amount of seconds a skip makes.
play	string	The word "play" in a specific language.
Pause	string	The word "pause" in a specific language.
Next	string	The word "next" in a specific language.
Replay	string	The word "replay" in a specific language.
Volume	string	The word "volume" in a specific language.
Mute	string	The word "mute" in a specific language.
Unmute	string	The word "unmute" in a specific language.
Settings	string	The word "settings" in a specific language.
Fullscreen	string	The word "fullscreen" in a specific language.
Chromecast	string	The word "chromecast" in a specific language.
Airplay	string	The word "airplay" in a specific language.
Quality	string	The word "quality" in a specific language.
Subtitles	string	The word "subtitles" in a specific language.
Theater	string	The word "theater" in a specific language.
Skip	string	The word "skip" in a specific language.
SkipIn	string	The word "skip in" in a specific language.
Visit	string	The word "visit" in a specific language.
Info	string	The word "info" in a specific language.
autoStartOn	bool	Indicates whether the player has auto start enabled.
autoStartOnData	bool	Indicates whether the player has auto start enabled.
autoStartPlayPercentage	integer($int32)	Indicates on which percentage is auto start enabled.
autoPauseOn	bool	Indicates whether the player has auto pause enabled.
autoPauseOnPercentage	integer($int32)	Indicates on which percentage is auto pause enabled.
pauseOtherVideos	bool	Indicates whether the other videos should be paused.
autoStartOnLoad	Object	An object with the autostart properties of the player when the page loads.
autoStartOnLoadMobile	bool	Specifies if playback should start on load when the user is on mobile.
autoStartOnLoadOnData	bool	Specifies if playback should start on load when the user is on mobile data.
autoStartOnViewable	Object	An object with the autostart properties of the player dependin on its viewability.
autoStartOnViewableMobile	bool	Specifies if this property should be on when the user is on mobile data.
autoStartOnViewableOnData	bool	Specifies if this property should be on when the user is on mobile data.
autoStartOnViewablePercentage	integer($int32)	Value range: 1-0, specifies what percentage of the video should be visible for video to start.
autoPauseOnViewableOn	bool	An object with the auto pause properties.
autoPauseOnViewablePercentage	integer($int32)	Value range: 1-0, specifies what percentage of the video should be visible for video to start.
releaseChannel	Object	Returns the release channel.
id	integer($int32)	The id of the release channel.
name	string	The name of the release channel.
originalPath	string	The original path of the release channel.
templateOriginalPath	string	The original path of the template release channel.
playerSizeType	Object	Returns the player size type.
id	integer($int32)	The id of the player size type.
name	string	The name of the player size type.
preloadOption	Object	Returns the preload option.
id	integer($int32)	The id of the preload option.
name	string	The name of the preload option.
value	string	The value of the preload option.
tooltipText	string	Gives a description about the preload option.
defaultBandwidthEstimateOption	Object	Returns the default bandwidth estimate option.
id	integer($int32)	The id of the default bandwidth estimate option.
name	string	The name of the default bandwidth estimate option.
value	string	The value of the default bandwidth estimate option.
sharingType	Object	Returns the sharing type
responsiveSizeOption	Object	Returns the responsive size option.
id	integer($int32)	The id of the responsive size option.
name	string	The name of the responsive size option.
logoPositionOption	Object	Returns the logo position option.
id	integer($int32)	The id of the logo position option.
name	string	The name of the logo position option.
value	string	The value of the logo position option.
floatPositionOption	Object	Returns the float position option.
id	integer($int32)	The id of the float position option.
name	string	The name of the float position option.
value	string	The value of the float position option.
adScheduleId	string	The id of the ad schedule.
defaultConfig	Object	Object that contains all of the configurations.
playerSocialNetworks	array[Object]	Returns the social networks of the player.
controlbartextcolor	string	Indicates the color of the control bar.
controlbariconsdefaultcolor	string	Indicates the color of the control bar icon.
controlbariconshovercolor	string	Indicates the color of the control bar when hovering.
controlbartimesliderprogresscolor	string	Indicates the color of the control bar slider.
controlbartimesliderrailcolor	string	Indicates the color of the control bar timeslider.
controlbartimesliderdraggercolor	string	Indicates the color of the dragger of the control bar timeslider.
controlbartimesliderbuffercolor	string	Indicates the color of the buffer of the control bar timeslider.
controlbarvolumedraggercolor	string	Indicates the color of the control bar volume dragger.
controlbarvolumeprogresscolor	string	Indicates the color of the control bar volume progress.
controlbarvolumerailcolor	string	Indicates the color of the control bar volume rail.
controlbarvolumenotifiercolor	string	Indicates the color of the control bar volume notifier.
menulinksdefaultcolor	string	Indicates the color of the links menu.
menulinkshovercolor	string	Indicates the color of the links menu when hovering.
menubackrounddefaultcolor	string	Indicates the color of the menu background.
menubackroundhovercolor	string	Indicates the color of the menu background when hovering.
menuautoplayoncolor	string	Indicates the color of the menu auto-play when on.
menuautoplayoffcolor	string	Indicates the color of the menu auto-play when off.
controlbarbackgroundcolor	string	Indicates the color of the control bar background.
tooltipstextcolor	string	Indicates the color of the tooltips text.
tooltipsbackroundcolor	string	Indicates the color of the tooltips background.
controlbartimeslideronaddraggercolor	string	Indicates the color of the dragger of the control bar timeslider.
controlbartimeslideronadprogresscolor	string	Indicates the color of the ad progress of the control bar timeslider.
controlbartimeslideronadrailcolor	string	Indicates the color of the ad rail of the control bar timeslider.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

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