v4

latestOpenAPI 3.0.3raw.githubusercontent.com2023-03-26273865.4 KB

Experiences

Publish In-Page Experience

Publish the specified In-Page Experience. This will initiate a publish, you can poll the GET endpoint for fetching the In-Page Experience to check its published status to see when publishing completes

post/accounts/{{account_id}}/experiences/{experience_id}/actions/publish

Response

SUCCESS

idstring

ID of the In-Page Experience

accountIdnumber

Video Cloud account ID

namestring required

Name of the In-Page Experience

descriptionstring

Description for the In-Page Experience

inactiveboolean

Whether the In-Page Experience is offline (inactive)

heightnumber

Fixed height of the In-Page Experience (null for responsive height)

widthnumber

Fixed width of the In-Page Experience (null for responsive width)

templatestring required

ID of the template

templateVersionstring

Version of the template

The locale of the In-Page Experience

playbackApiBaseUrlstring

Base URL for fetching video information from the Playback API. For IP restricted accounts this should be set to https://edge-elb.api.brightcove.com/playback/v1, otherwise this should be null

policyKeystring

Policy key for fetching video information from the Playback API.

youtubeKeystring

Auto-generated key for fetching YouTube video information from Gallery.

layoutsExperienceLayouts

Collection of layout options for the In-Page Experience. The keys for this can be found in the template layouts metadata

publishAttemptedAtstring

ISO-8601 date when the last publish was attempted

publishedAtstring

ISO-8601 date when the last successful publish happened

publishFailedAtstring

ISO-8601 date when the last failed publish happened

updatedAtstring

ISO-8601 date when the In-Page Experience was last updated

createdAtstring

ISO-8601 date when the In-Page Experience was created

publishedUrlstring

URL to the published In-Page Experience. null if the Experience has never been published

previewUrlstring

URL for previewing the In-Page Experience. This URL is valid for 24 hours and is re-generated for each request to the API

themestring

ID of the theme to use for styling this In-Page Experience. Can also be light or dark to use the built-in light and dark themes

hasChangesboolean

Whether the In-Page Experience has been modified since the last time it was published

The current published status of the In-Page Experience

Example response

{
  "id": "111111111111",
  "accountId": 1111111111111,
  "name": "Sample In-Page Experience",
  "description": "A sample In-Page Experience for demonstration purposes",
  "template": "ee-single-video",
  "templateVersion": "1.0.0",
  "styles": {
    "global": {
      "color": "rgba(255, 0, 0, 1)",
      "backgroundColor": "blue",
      "fontSize": "14"
    },
    "anchor": {
      "color": "rgba(255, 0, 0, 1)",
      "backgroundColor": "blue",
      "fontSize": "14"
    },
    "navigation": {
      "color": "rgba(255, 0, 0, 1)",
      "backgroundColor": "blue",
      "fontSize": "14"
    },
    "videoInfo": {
      "color": "rgba(255, 0, 0, 1)",
      "backgroundColor": "blue",
      "fontSize": "14"
    },
    "videoTitle": {
      "color": "rgba(255, 0, 0, 1)",
      "backgroundColor": "blue",
      "fontSize": "14"
    },
    "videoDescription": {
      "color": "rgba(255, 0, 0, 1)",
      "backgroundColor": "blue",
      "fontSize": "14"
    },
    "overlay": {
      "color": "rgba(255, 0, 0, 1)",
      "backgroundColor": "blue",
      "fontSize": "14"
    },
    "overlayTitle": {
      "color": "rgba(255, 0, 0, 1)",
      "backgroundColor": "blue",
      "fontSize": "14"
    },
    "overlayDescription": {
      "color": "rgba(255, 0, 0, 1)",
      "backgroundColor": "blue",
      "fontSize": "14"
    },
    "overlayBanner": {
      "color": "rgba(255, 0, 0, 1)",
      "backgroundColor": "blue",
      "fontSize": "14"
    },
    "nowPlaying": {
      "color": "rgba(255, 0, 0, 1)",
      "backgroundColor": "blue",
      "fontSize": "14"
    },
    "playButton": {
      "color": "rgba(255, 0, 0, 1)",
      "backgroundColor": "blue",
      "fontSize": "14"
    },
    "sharing": {
      "color": "rgba(255, 0, 0, 1)",
      "backgroundColor": "blue",
      "fontSize": "14"
    },
    "overlaySharing": {
      "color": "rgba(255, 0, 0, 1)",
      "backgroundColor": "blue",
      "fontSize": "14"
    },
    "eventCountdown": {
      "color": "rgba(255, 0, 0, 1)",
      "backgroundColor": "blue",
      "fontSize": "14"
    },
    "calendarReminder": {
      "color": "rgba(255, 0, 0, 1)",
      "backgroundColor": "blue",
      "fontSize": "14"
    }
  }
}