Schema piece - VideoObject

Describes an individual video (usually in the context of an embedded media object).

Triggers

Should be added as top-level nodes in the graph, as/when required by other nodes. E.g., when a WebPage contains an embedded video.

Required properties

A valid VideoObject must have the following properties.

  • @id: The site's home URL appended by #/schema/video/{{ID}}, where {{ID}} is a unique identifier.
  • name: The title of the video.
  • description: A description of the video (falling back to the caption, then to 'No description').
  • thumbnailUrl: A reference-by-ID to an imageObject.
  • uploadDate: The date the video was published, in ISO 8601 format.

Failure scenarios

If any of the required fields are missing or invalid, the node should not be output.

If the node is not output, any entities which would otherwise have declared a relationship with the Video (e.g., as a part of an Article) should remove those references.

Optional properties

The following should be added whenever available and valid:

  • caption: A caption summarising the video.
  • contentUrl: A URL pointing directly to the video file.
  • embedUrl: A URL pointing to a player for the video.
  • duration: The duration of the video in ISO 8601 format.
  • width: The width of the video in pixels.
  • height: The height of the video in pixels.
  • isFamilyFriendly: Whether the video should be considered 'family friendly', default to 'yes', may be set to 'no'.
  • inLanguage: The language code for the content of the video; e.g., en-GB.

Conditional properties

Optional properties which should only be output when the required criteria is met.

On AMP templates

  • publisher: A reference-by-ID to the publisher of the video.

Examples

Minimum criteria

{
"@context": "https://schema.org",
"@graph": [
{
"@type": "videoObject",
"@id": "https://www.example.com/#/schema/video/abc123",
"name": "Example video",
"description": "Example video description",
"thumbnailUrl": {
"@id": "https://www.example.com/#/schema/image/abc123"
},
"uploadDate": "2016-03-31T08:00:00+08:00"
}
]
}

Extended criteria

{
"@context": "https://schema.org",
"@graph": [
{
"@id": "https://www.example.com/#/schema/video/abc123",
"@type": "videoObject",
"contentUrl": "https://www.example.com/videos/video123.mp4",
"description": "Example video description",
"duration": "PT1M54S",
"embedUrl": "https://www.example.com/videos/embed/video123/",
"height": 640,
"inLanguage": "en-US",
"isFamilyFriendly": "yes",
"name": "Example video",
"thumbnailUrl": {
"@id": "https://www.example.com/#/schema/image/abc123"
},
"uploadDate": "2016-03-31T08:00:00+08:00",
"width": 480
}
]
}