JSON-LD Tagging


Our player supports JSON-LD tagging (“JavaScript Object Notation for Linked Data”). JSON-LD tagging is enabled by default in the playout settings.

JSON-LD tags provide structured data: a standardized format for providing information about a page. Using JSON-LD helps search engines to better understand the content of your page, resulting in better (video) SEO.

When using JavaScript embeds, a JSON-LD block is injected directly into the <head> of the parent page, making it fully visible to search engines. When using iframe embeds, however, the JSON-LD block is injected into the <head> of the iframe. Search engines generally do not crawl iframe content, so the structured data will not be indexed. For the best SEO results, use JavaScript embeds.

The JSON-LD block contains either a schema.org VideoObject, a schema.org AudioObject, or a schema.org MediaObject, depending on the clip’s media type.

1.0 | What the JSON-LD block contains

The generated JSON-LD block includes the following properties:

PropertyDescription
nameClip title
descriptionClip description
thumbnailUrlThumbnail image URL (640×360)
uploadDateDate and time the clip was created (ISO 8601)
durationClip duration (ISO 8601, e.g. PT1H23M45S)
embedUrlThe embed or deep link URL for the clip
authorAuthor field from the clip metadata
keywordsClip categories and tags
interactionStatisticView count, expressed as a WatchAction, ListenAction, or ConsumeAction
transcriptFull transcript text, if available
hasPartArray of Clip objects for each chapter or highlight, including startOffset, endOffset, and a timestamped URL
Note:

contentUrl (the direct file URL) is intentionally not included. Google’s structured data requirements for video rich results accept either contentUrl or embedUrl. The player emits embedUrl, which satisfies this requirement.

If a clip has chapters or highlights, these are automatically included in the JSON-LD block as hasPart entries. This enables Google’s Key Moments feature, which displays chapter timestamps directly in Search results, allowing users to jump to a specific part of your video from the search page.

To take advantage of Key Moments, add chapters or highlights to your clips via the Media Clip editor.

2.0 | Example JSON-LD

The following example displays the JSON-LD of a sample video:

3.0 | Disable JSON-LD tagging

JSON-LD tagging is enabled by default in the playout settings. To disable JSON-LD tagging:

  • Click to expand Media Library in the left menu panel.
  • Click Playouts and select a playout.
  • Open the Miscellaneous tab.

  • Scroll down to Disable JSON-LD tagging.

4.0 | When JSON-LD tagging is automatically disabled

In addition to the manual setting above, JSON-LD tagging is automatically disabled in the following situations:

  • The page already contains a JSON-LD block: if a <script type="application/ld+json"> tag is already present on the page, the player will not inject an additional block, to avoid conflicts with existing structured data.
  • Suggest/recommended playlist: tagging is disabled when the player is loaded as part of a suggest or recommended clips playlist.
  • Outstream-as-instream: tagging is disabled when the player is configured in outstream-as-instream mode.

Was this article helpful?

Related Articles

Contact Support
Can't find the answer you're looking for?
Contact Support