Profile: youtube-video

Profile Schema

The youtube-video profile identifies a document representing a YouTube video asset.

The youtube-video profile is intended to be used as a “type” profile.

Structure

The youtube-video profile specifies the following attributes:

Name Type Required? Explanation
embedSize string No DEPRECATED - The relative size to display the embedded YouTube player on a webpage

This value MUST be small, medium, large, or x-large
displaySize string No The relative size to display the embedded YouTube player on a webpage.

This value MUST be small, medium, large, or x-large
headline string No The person, organization, or series associated with this video for attribution purposes
startTime integer No The number of seconds in the video to start playback

This value MUST be greater than or equal to zero
subheadline string No The caption used for the embedded video link
videoId string Yes The ID used to identify this video; see the “ID” section below

ID

The ID specified via videoId is used to identify the video to YouTube’s API; this can be used to construct URLs or embeds. For more information on using YouTube’s API, see the official documentation.

Example youtube-video document 

{
  "id": "12345",
  "profiles": [
    {
      "href": "/v1/profiles/youtube-video",
      "rels": [
        "type"
      ]
    },
    {
      "href": "/v1/profiles/document"
    }
  ],

  "embedSize": "medium",
  "displaySize": "small",
  "headline": "NPR Tiny Desk",
  "subheadline": "Tuxedo Tiny Desk Concert",
  "startTime": 0,
  "videoId": "0WyqHfJOj-I"
}

© 2024 npr