- [videojs-schema](#videojs-schema) - [Options](#options) - [Description metadata](#description-metadata) - [Install](#install) # videojs-schema A plugin for the Brightcove Player to inject metadata from a Video Cloud video in to the page as [Schema.org](https://schema.org/VideoObject) structured data. It uses the JSON-LD format [supported by Google for video SEO](https://developers.google.com/search/docs/guides/intro-structured-data), e.g. ```html ``` As seen by Google: https://search.google.com/structured-data/testing-tool/u/0/#url=http%3A%2F%2Fplayers.brightcove.net%2F906043040001%2F5WnZb7ptr_default%2Findex.html%3FvideoId%3Dref%3Abunnyfull The embedUrl is only included if the social plugin is present and its `removeEmbed` option is not `true`. ## Options `schemaId` - the value to use as `@id` in the metadata. This must be a unique URI which represents the video, but not necessarily a "real" URL. This is arbitrary and might be a value like `https://mydomain.com/videos/{id}` or `https://videos.mydomain.com#{id}` or `https://mydomain.com/article-about-video-{id}#the-video`. Accepts `{id}`, `{referenceId}`, `{playerId}`, `{embedId}` and `{accountId}` as macros. Defaults to `https://players.brightcove.net/{accountId}/{playerId}_{embedId}/index.html?videoId={id}` `keywords` - if `true`, include tags as keywords. Default is `false`. `excludeTags` - array of tags to not include as keywords in the schema metadata, e.g. `["youtubesync"]` `baseObject` - an option object of properties onto which to build the video specific metadata. For example this could be used to include a publisher object: `includeEmbedUrl` - if `false`, no embed url is included. Inlcuding thisURL may be expected by search engines. Default is `true`. `skipRules` - used to exclude videos from having schema metadata generated, based on their video cloud metadata. Can be tags and / or custom fields. If multiple tags, fields or both are specified, matching any excludes. `skipRules.customFields` - any object of field-value pairs. If a field present and set to the value in the video's custom fields, no schema metadata is created. e.g. `{category: 'unlisted'}` `skipRules.tags` - any array of one or more tags. If any one is present in the video's metadata, no schema metadata is created. e.g. `['notthistag']` `transcript` - if `true`, a captions or subtitles track with a matching language will be added as a transcript. Default is `false`. `transcriptMatchAny` - if `true` and `transcript` is also `true`, a transcript will be added from the first usable track, if there is no language match. Default is `false`. ```json "baseObject": { "publisher": { "@type": "Organization", "name": "Publisher name", "logo": { "@type": "ImageObject", "url": "https://example.com/logo.jpg", "width": 600, "height": 60 } } } ``` `preferLongDescription` - if `true`, use the long description if available. If `false`, or `true` and long description is not set then the (short) description field will be used. Default is `false`. ## Description metadata By default, the short description field is used as the description text. If the `preferLongDescription` option is set, the long description will be used instead, falling back to short description if empty. If the short description (or both long and short descriptions with `preferLongDescription`) is empty, then the title is used since no description is considered invlaid schema. ## Install Add [as a plugin to a player in Video Cloud Studio][plugins]: - Under "plugins" click "add a plugin", 'custom plugin" - Plugin name is `schema` - Javascript URL is `https://cdn.jsdelivr.net/npm/videojs-schema/dist/videojs-schema.min.js` - No CSS - Leave blank unless using options above, in which case ```json { "schemaId": "https://example.com/my/url/{id}" } ``` - Save, then publish [plugins]: [https://support.brightcove.com/configuring-player-plugins]