The following examples demonstrate some of the common scenarios for Watch Actions.
Sample entities of each type
Movie
A Movie entity representing a fictional movie named "My Favorite Movie"
{
"@context": ["http://schema.org", {"@language": "en"}],
"@type": "Movie",
"@id": "http://www.example.com/my_favorite_movie",
"url": "http://www.example.com/my_favorite_movie",
"name": "My Favorite Movie",
"potentialAction": {
"@type": "WatchAction",
"target": {
"@type": "EntryPoint",
"urlTemplate": "http://www.example.com/my_favorite_movie?autoplay=true",
"inLanguage": "en",
"actionPlatform": [
"http://schema.org/DesktopWebPlatform",
"http://schema.org/MobileWebPlatform",
"http://schema.org/AndroidPlatform",
"http://schema.org/AndroidTVPlatform",
"http://schema.org/IOSPlatform",
"http://schema.googleapis.com/GoogleVideoCast"
]
},
"actionAccessibilityRequirement": {
"@type": "ActionAccessSpecification",
"category": "subscription",
"availabilityStarts": "2018-07-21T10:35:29Z",
"availabilityEnds": "2019-10-21T10:35:29Z",
"requiresSubscription": {
"@type": "MediaSubscription",
"name": "Example Package",
"commonTier": true,
"@id": "http://www.example.com/example_package"
},
"eligibleRegion": [
{
"@type": "Country",
"name": "US"
},
{
"@type": "Country",
"name": "CA"
}
]
}
},
"sameAs": "https://en.wikipedia.org/wiki/my_favorite_movie",
"releasedEvent": {
"@type": "PublicationEvent",
"startDate": "2008-01-20",
"location": {
"@type": "Country",
"name": "US"
}
},
"description": "This is my favorite movie.",
"actor": [
{
"@type": "Person",
"name": "John Doe",
"sameAs": "https://en.wikipedia.org/wiki/John_Doe"
},
{
"@type": "Person",
"name": "Jane Doe",
"sameAs": "https://en.wikipedia.org/wiki/Jane_Doe"
}
],
"identifier": [
{
"@type": "PropertyValue",
"propertyID": "IMDB_ID",
"value": "tt0123456"
}
]
}
TVSeries
A TVSeries entity representing a fictional TV show named "My Favorite TV Show"
{
"@context": ["http://schema.org", {"@language": "en"}],
"@type": "TVSeries",
"@id": "http://www.example.com/my_favorite_tv_show/",
"url": "http://www.example.com/my_favorite_tv_show/",
"name": "My Favorite TV Show",
"potentialAction": {
"@type": "WatchAction",
"target": {
"@type": "EntryPoint",
"urlTemplate": "http://www.example.com/my_favorite_tv_show/watch?autoplay=true",
"inLanguage": "en",
"actionPlatform": [
"http://schema.org/DesktopWebPlatform",
"http://schema.org/MobileWebPlatform",
"http://schema.org/AndroidPlatform",
"http://schema.org/AndroidTVPlatform",
"http://schema.org/IOSPlatform",
"http://schema.googleapis.com/GoogleVideoCast"
]
},
"actionAccessibilityRequirement": {
"@type": "ActionAccessSpecification",
"category": "subscription",
"requiresSubscription": {
"@type": "MediaSubscription",
"name": "Example Package",
"commonTier": true,
"@id": "https://example.com/package/example"
},
"availabilityStarts": "2017-07-21T10:35:29Z",
"availabilityEnds": "2018-10-21T10:35:29Z",
"eligibleRegion": [
{
"@type": "Country",
"name": "US"
},
{
"@type": "Country",
"name": "CA"
}
]
}
},
"sameAs": "https://en.wikipedia.org/wiki/my_favorite_tv_show",
"releasedEvent": {
"@type": "PublicationEvent",
"startDate": "2008-01-20",
"location": {
"@type": "Country",
"name": "US"
}
},
"popularityScore": {
"@type": "PopularityScoreSpecification",
"value": 4.1,
"eligibleRegion": [
{
"@type": "Country",
"name": "US"
},
{
"@type": "Country",
"name": "CA"
}
]
},
"description": "This is my favorite TV show.",
"contentRating": "RATING NOT KNOWN",
"actor": [
{
"@type": "Person",
"name": "John Doe",
"sameAs": "https://en.wikipedia.org/wiki/john_doe"
},
{
"@type": "Person",
"name": "Jane Doe",
"sameAs": "https://en.wikipedia.org/wiki/jane_doe"
}
],
"identifier": [
{
"@type": "PropertyValue",
"propertyID": "IMDB_ID",
"value": "tt0903747"
}
]
}
```
TVEpisode
A TVEpisode entity representing a 14th episode of the 7th season of the fictional TV show named "My Favorite TV Show"
{
"@context": ["http://schema.org", {"@language": "en"}],
"@type": "TVEpisode",
"@id": "http://www.example.com/my_favorite_tv_show/s7/e14",
"url": "http://www.example.com/my_favorite_tv_show/s7/e14",
"name": "John Doe returns with a horse",
"episodeNumber": 14,
"contentRating": "TVPG TV-MA",
"partOfSeason": {
"@type": "TVSeason",
"@id": "http://www.example.com/my_favorite_tv_show/s7",
"seasonNumber": 7
},
"partOfSeries": {
"@type": "TVSeries",
"@id": "http://www.example.com/my_favorite_tv_show",
"name": "My Favorite TV Show",
"sameAs": "https://en.wikipedia.org/wiki/my_favorite_tv_show"
},
"potentialAction": {
"@type": "WatchAction",
"target": {
"@type": "EntryPoint",
"urlTemplate": "http://www.example.com/my_favorite_tv_show/s7/e14?autoplay=true",
"inLanguage": "en",
"actionPlatform": [
"http://schema.org/DesktopWebPlatform",
"http://schema.org/MobileWebPlatform",
"http://schema.org/IOSPlatform",
"http://schema.org/AndroidPlatform",
"http://schema.org/AndroidTVPlatform",
"http://schema.googleapis.com/GoogleVideoCast"
]
},
"actionAccessibilityRequirement": {
"@type": "ActionAccessSpecification",
"category": "subscription",
"requiresSubscription": {
"@type": "MediaSubscription",
"name": "Example Package",
"commonTier": true,
"@id": "https://example.com/package/example"
},
"availabilityStarts": "2017-07-21T10:35:29Z",
"availabilityEnds": "2018-10-21T10:35:29Z",
"eligibleRegion": [
{
"@type": "Country",
"name": "US"
},
{
"@type": "Country",
"name": "CA"
}
]
}
},
"sameAs": "https://en.wikipedia.org/wiki/john_doe_returns_with_a_horse",
"duration": "PT00H25M",
"releasedEvent": {
"@type": "PublicationEvent",
"startDate": "2014-01-09",
"location": {
"@type": "Country",
"name": "US"
}
},
"popularityScore": {
"@type": "PopularityScoreSpecification",
"value": 3.9,
"eligibleRegion": "EARTH"
},
"description": "John Doe returns to the village three years after his disappearance.",
"actor": [
{
"@type": "Person",
"name": "John Doe",
"sameAs": "https://en.wikipedia.org/wiki/john_doe"
},
{
"@type": "Person",
"name": "Jane Doe",
"sameAs": "https://en.wikipedia.org/wiki/jane_doe"
}
],
"identifier": {
"@type": "PropertyValue",
"propertyID": "IMDB_ID",
"value": "tt3453320"
}
}
TVSeason
A TVSeason entity representing the 7th season of a fictional TV show named "My Favorite TV Show"
{
"@context": ["http://schema.org", {"@language": "en"}],
"@type": "TVSeason",
"@id": "http://www.example.com/my_favorite_tv_show/s7",
"url": "http://www.example.com/my_favorite_tv_show/s7",
"name": "Season 7",
"seasonNumber": 7,
"partOfSeries": {
"@type": "TVSeries",
"@id": "http://www.example.com/my_favorite_tv_show",
"name": "My Favorite TV Show",
"sameAs": "https://en.wikipedia.org/wiki/my_favorite_tv_show"
},
"potentialAction": {
"@type": "WatchAction",
"target": {
"@type": "EntryPoint",
"urlTemplate": "http://www.example.com/my_favorite_tv_show/s7/watch?autoplay=true",
"inLanguage": "en",
"actionPlatform": [
"http://schema.org/DesktopWebPlatform",
"http://schema.org/MobileWebPlatform",
"http://schema.org/IOSPlatform",
"http://schema.org/AndroidPlatform",
"http://schema.org/AndroidTVPlatform",
"http://schema.googleapis.com/GoogleVideoCast"
]
},
"actionAccessibilityRequirement": {
"@type": "ActionAccessSpecification",
"category": "subscription",
"requiresSubscription": {
"@type": "MediaSubscription",
"name": "Example Package",
"commonTier": true,
"@id": "https://example.com/package/example"
},
"availabilityStarts": "2017-07-21T10:35:29Z",
"availabilityEnds": "2018-10-21T10:35:29Z",
"eligibleRegion": [
{
"@type": "Country",
"name": "US"
},
{
"@type": "Country",
"name": "CA"
}
]
}
},
"sameAs": "https://en.wikipedia.org/wiki/my_favorite_tv_show_(season_7)",
"releasedEvent": {
"@type": "PublicationEvent",
"startDate": "2010-09-23",
"location": {
"@type": "Country",
"name": "US"
}
},
"description": "The seventh season of My Favorite TV Show.",
"actor": [
{
"@type": "Person",
"name": "John Doe",
"sameAs": "https://en.wikipedia.org/wiki/john_doe"
},
{
"@type": "Person",
"name": "Jane Doe",
"sameAs": "https://en.wikipedia.org/wiki/jane_doe"
}
]
}
Organization (TV Operator)
An Organization entity representing a fictional TV service provider, "Example Cable TV Company", which provides Live TV service over a cable network
{
"@context":"http://schema.org",
"@type":"Organization",
"@id": "http://example.com/example_cable_tv_company",
"name": "Example Cable TV Company",
"sameAs": "https://en.wikipedia.org/wiki/example_cable_company"
}
CableOrSatelliteService
A CableOrSatelliteService representing the cable TV services in New York (DMA_ID=501), which are provided by the nationwide TV service provider "Example Cable TV Company"
{
"@context":"http://schema.org",
"@type":"CableOrSatelliteService",
"@id":"http://example.com/example_cable_tv_company_new_york",
"name":"Example Cable TV Company - New York",
"provider": {
"@type": "Organization",
"@id": "http://example.com/example_cable_tv_company",
},
"areaServed":[
{
"@type": "GeoShape",
"@id": "http://example.com/newyork_01",
"identifier": [
{
"@type": "PropertyValue",
"propertyID": "DMA_ID",
"value": "501"
}
]
}
]
}
Organization
An Organization entity representing the channel "ExampleTV Channel", which is offered to users by a fictional TV service provider "Example Cable TV Company" in New York
{
"@context":"http://schema.org",
"@type":"Organization",
"@id":"http://example.com/exampletv",
"name":"ExampleTV Channel",
"sameAs": "https://en.wikipedia.org/wiki/exampletv"
}
BroadcastService
A BroadcastService entity representing the channel "ExampleTV Channel", which is offered to users by a fictional TV service provider "Example Cable TV Company" in New York. The BroadcastService entities provides the details of deep links and access requirement for the channel
{
"@context":"http://schema.org",
"@type":"BroadcastService",
"@id":"https://www.example.com/exampletv/broadcast/hd",
"name": "ExampleTV Channel",
"description": "A fictional TV broadcast service in HD",
"broadcastDisplayName":"ExampleTV-Channel",
"broadcastAffiliateOf":{
"@type":"Organization",
"@id":"http://www.example.com/exampletv"
},
"potentialAction": {
"@type": "WatchAction",
"target": [
{
"@type": "EntryPoint",
"urlTemplate": "http://www.example.com/exampletv/broadcast/hd?autoplay=true",
"inLanguage": "en",
"actionPlatform": [
"http://schema.org/DesktopWebPlatform",
"http://schema.org/MobileWebPlatform",
"http://schema.org/AndroidPlatform",
"http://schema.org/AndroidTVPlatform",
"http://schema.org/IOSPlatform"
]
},
{
"@type": "EntryPoint",
"urlTemplate": "http://www.example.com/exampletv/broadcast/androidtv/hd?autoplay=true",
"inLanguage": "en",
"actionPlatform": [
"http://schema.googleapis.com/GoogleVideoCast"
]
}
],
"actionAccessibilityRequirement": {
"@type": "ActionAccessSpecification",
"category": "subscription",
"requiresSubscription": {
"@type": "MediaSubscription",
"@id": "http://www.example.com/exampletv/basic_subscription",
"name": "Basic subscription",
"identifier": "example.com:basic",
"commonTier": true
},
"eligibleRegion": [
{
"@type": "Country",
"name": "US"
}
]
}
},
"identifier": [
{
"@type": "PropertyValue",
"propertyID": "TMS_ID",
"value": "102610"
},
{
"@type": "PropertyValue",
"propertyID": "_PARTNER_ID_",
"value": "exampletv-12345"
}
]
}
TelevisionChannel
A TelevisionChannel entity indicating that the "ExampleTV Channel" channel is available on channel 7 and is part of the cable TV services provided in New York by the fictional TV service provider "Example Cable TV Company"
{
"@context":"http://schema.org",
"@type":"TelevisionChannel",
"@id":"http://example.com/example_cable_tv_company_san_francisco/exampletv",
"broadcastChannelId":"7",
"broadcastServiceTier":"Standard",
"inBroadcastLineup":{
"@type":"CableOrSatelliteService",
"@id":"http://example.com/example_cable_tv_company_san_francisco_bay"
},
"providesBroadcastService":{
"@type":"BroadcastService",
"@id":"https://www.example.com/exampletv/broadcast/hd"
}
}
BroadcastEvent
A BroadcastEvent entity representing the broadcast of a movie on the "ExampleTV Channel" between 5 pm and 7 pm on July 12th, 2019.
{
"@context": ["http://schema.org", {"@language": "en"}],
"@type": "BroadcastEvent",
"@id": "http://example.com/live/movie/new_release",
"name": "My Favorite Movie",
"description": "John Doe spent years perfecting his survival skills in a tropical jungle.",
"startDate": "2019-07-12T17:00-08:00",
"endDate": "2019-07-12T19:00-08:00",
"videoFormat": "HD",
"isLiveBroadcast": "False",
"publishedOn": {
"@type": "BroadcastService",
"@id": "http://example.com/stations/example_tv"
},
"workPerformed": {
"@type": "Movie",
"@id": "http://www.example.com/my_favorite_movie"
}
}
SportsEvent
A SportsEvent entity representing a basketball game played between two teams
{
"@context": ["http://schema.org", {"@language": "en"}],
"@type":"SportsEvent",
"@id": "http://example.com/basketball/professional/final_game_6",
"name":"2019 Professional Basketball Finals, Game 6: Team A at Team B",
"sport":"https://en.wikipedia.org/wiki/Basketball",
"description": {
"@language": "en",
"@value": "Game 6 of the 2019 Professional Basketball Finals. Team A leads the series 3-2 against Team B."
},
"startDate": "2018-09-16T10:00-08:00",
"endDate": "2018-09-16T13:00-08:00",
"homeTeam":{
"@type":"SportsTeam",
"name":"Team B",
"sport":"https://en.wikipedia.org/wiki/Basketball",
"parentOrganization":{
"@type":"SportsOrganization",
"name":"Professional Basketball League",
"sameAs":"http://www.example.com/professional_basketball_league"
},
"athlete":[
{
"@type":"Person",
"name":"John doe"
}
]
},
"awayTeam":{
"@type":"SportsTeam",
"name":"Team A",
"sport":"https://en.wikipedia.org/wiki/Basketball",
"athlete":[
{
"@type":"Person",
"name":"Jane Doe"
}
]
},
"location":{
"@type":"Place",
"name":"Example Stadium",
"address":{
"@type":"PostalAddress",
"streetAddress":"1600 Amphitheatre Pkwy",
"addressLocality":"Mountain View",
"addressRegion":"CA",
"postalCode":"94043",
"addressCountry":"US"
}
},
"identifier": [
{
"@type": "PropertyValue",
"propertyID": "TMS_ID",
"value": "EP000194303282"
}
]
}
Deep link related examples
Providing non-universal deep links
An entity with an old style link for Android platform and a universal deep link for all other platforms
"potentialAction": {
"@type": "WatchAction",
"target": [
{
"@type": "EntryPoint",
"urlTemplate": "http://www.example.com/my_favorite_movie?autoplay=true",
"inLanguage": "en",
"actionPlatform": [
"http://schema.org/DesktopWebPlatform",
"http://schema.org/MobileWebPlatform",
"http://schema.org/IOSPlatform",
"http://schema.googleapis.com/GoogleVideoCast"
]
},
{
"@type": "EntryPoint",
"urlTemplate": "android-app://com.example/example-scheme/my_favorite_movie?autoplay=true",
"inLanguage": "en",
"actionPlatform": [
"http://schema.org/AndroidPlatform",
"http://schema.org/AndroidTVPlatform"
]
}
],
"actionAccessibilityRequirement": {
"@type": "ActionAccessSpecification",
"category": "subscription",
"availabilityStarts": "2018-07-21T10:35:29Z",
"availabilityEnds": "2019-10-21T10:35:29Z",
"requiresSubscription": {
"@type": "MediaSubscription",
"name": "Example Package",
"commonTier": true,
"@id": "http://www.example.com/example_package"
},
"eligibleRegion": [
{
"@type": "Country",
"name": "US"
},
{
"@type": "Country",
"name": "CA"
}
]
}
}
Providing time-bound accessibility requirements
An entity that changes its accessibility requirement over time: free for a limited time and subscription afterwards
"potentialAction": {
"@type": "WatchAction",
"target": {
"@type": "EntryPoint",
"urlTemplate": "http://www.example.com/my_favorite_movie?autoplay=true",
"inLanguage": "en",
"actionPlatform": [
"http://schema.org/DesktopWebPlatform",
"http://schema.org/MobileWebPlatform",
"http://schema.org/AndroidPlatform",
"http://schema.org/AndroidTVPlatform",
"http://schema.org/IOSPlatform",
"http://schema.googleapis.com/GoogleVideoCast"
]
},
"actionAccessibilityRequirement": [
{
"@type": "ActionAccessSpecification",
"category": "free",
"availabilityStarts": "2019-01-01T00:00Z",
"availabilityEnds": "2019-05-31T00:00Z",
"eligibleRegion": {
"@type": "Country",
"name": "US"
}
},
{
"@type": "ActionAccessSpecification",
"category": "subscription",
"availabilityStarts": "2019-06-01T10:35:29Z",
"availabilityEnds": "2020-06-01T10:35:29Z",
"requiresSubscription": {
"@type": "MediaSubscription",
"name": "Example Package",
"commonTier": true,
"@id": "http://www.example.com/example_package"
},
"eligibleRegion": [
{
"@type": "Country",
"name": "US"
},
{
"@type": "Country",
"name": "CA"
}
]
}
]
}
Providing multiple platform-based accessibility requirements
An entity with multiple accessibility requirements based on the platforms: free for Desktop and Mobile platforms and subscription for ChromeCast platform
"potentialAction": [
{
"@type": "WatchAction",
"target": {
"@type": "EntryPoint",
"urlTemplate": "http://www.example.com/my_favorite_movie?autoplay=true",
"inLanguage": "en",
"actionPlatform": [
"http://schema.org/DesktopWebPlatform",
"http://schema.org/MobileWebPlatform",
"http://schema.org/AndroidPlatform",
"http://schema.org/AndroidTVPlatform",
"http://schema.org/IOSPlatform"
]
},
"actionAccessibilityRequirement": {
"@type": "ActionAccessSpecification",
"category": "free",
"availabilityStarts": "2019-01-01T10:35:29Z",
"availabilityEnds": "2020-05-31T10:35:29Z",
"eligibleRegion": {
"@type": "Country",
"name": "US"
}
}
},
{
"@type": "WatchAction",
"target": {
"@type": "EntryPoint",
"urlTemplate": "http://www.example.com/my_favorite_movie?autoplay=true",
"inLanguage": "en",
"actionPlatform": "http://schema.googleapis.com/GoogleVideoCast",
},
"actionAccessibilityRequirement": {
"@type": "ActionAccessSpecification",
"category": "subscription",
"availabilityStarts": "2019-01-01T10:35:29Z",
"availabilityEnds": "2020-05-31T10:35:29Z",
"requiresSubscription": {
"@type": "MediaSubscription",
"name": "Example Package",
"commonTier": true,
"@id": "http://www.example.com/example_package"
},
"eligibleRegion": [
{
"@type": "Country",
"name": "US"
},
{
"@type": "Country",
"name": "CA"
}
]
}
}
]
Usage of the additionalProperty property
A Movie entity showcasing the usage of the additionalProperty property and its sub-properties to provide information about the content and subtitle language, the video format and the camera angle used.
{
"@context": ["http://schema.org", {"@language": "en"}],
"@type": "Movie",
"@id": "http://www.example.com/my_favorite_movie",
"url": "http://www.example.com/my_favorite_movie",
"name": "My Favorite Movie",
"potentialAction": [
{
"@type": "WatchAction",
"target": [
{
"@type":"EntryPoint",
"urlTemplate":"http://www.example.com/my_favorite_movie/multipleViews",
"actionPlatform": [
"http://schema.org/IOSPlatform",
"http://schema.org/AndroidPlatform",
"http://schema.org/AndroidTVPlatform",
"http://schema.googleapis.com/GoogleVideoCast"
],
"additionalProperty": [
{
"@type": "PropertyValue",
"name": "contentLanguage",
"value": [
"en"
]
},
{
"@type": "PropertyValue",
"name": "subtitleLanguage",
"value": [
"en",
"es"
]
},
{
"@type": "PropertyValue",
"name": "videoFormat",
"value": [
"HD",
"4K"
]
},
{
"@type": "PropertyValue",
"name": "cameraAngle",
"value": [
"Eye-Level",
"High-Angle"
]
}
]
}
],
"actionAccessibilityRequirement": {
"@type": "ActionAccessSpecification",
"category": "subscription",
"requiresSubscription": {
"@type": "MediaSubscription",
"name": "Example Package",
"commonTier": true,
"@id": "http://www.example.com/example_package"
},
"availabilityStarts": "2019-01-01T10:35:29Z",
"availabilityEnds": "2019-05-31T10:35:29Z",
"eligibleRegion": [
{
"@type": "Country",
"name": "US"
},
{
"@type": "Country",
"name": "CA"
}
]
}
}
]
}
Entity available in multiple regions and languages
{
"@context": ["http://schema.org", {"@language": "en"}],
"@type": "Movie",
"@id": "http://www.example.com/my_favorite_movie",
"url": "http://www.example.com/my_favorite_movie",
"name": [
{
"@language": "en-us",
"@value": "My Favorite Movie"
},
{
"@language": "en-gb",
"@value": "My Favourite Movie"
},
{
"@language": "es-mx",
"@value": "mi película favorita"
},
],
"description": [
{
"@language": "en-us",
"@value": "Jenny meets Paul."
},
{
"@language": "en-gb",
"@value": "Jenny meets Paul."
},
{
"@language": "es-mx",
"@value": "Jenny conoce a paul."
}
],
"potentialAction": [
{
"@type": "WatchAction",
"target": {
"@type": "EntryPoint",
"urlTemplate": "http://www.example.com/my_favorite_movie?autoplay=true",
"actionPlatform": [
"http://schema.org/DesktopWebPlatform",
"http://schema.org/MobileWebPlatform",
"http://schema.org/IOSPlatform",
"http://schema.org/AndroidPlatform",
"http://schema.org/AndroidTVPlatform"
],
}
"actionAccessibilityRequirement": {
"@type": "ActionAccessSpecification",
"category": "subscription",
"requiresSubscription": {
"@type": "MediaSubscription",
"name": "Example Package",
"commonTier": true,
"@id": "http://www.example.com/example_package"
},
"availabilityStarts": "2018-07-21T10:35:29Z",
"availabilityEnds": "2019-10-21T10:35:29Z",
"eligibleRegion": [
{
"@type": "Country",
"name": "US"
},
{
"@type": "Country",
"name": "GB"
},
{
"@type": "Country",
"name": "MX"
}
]
},
"additionalProperty": [
{
"@type": "PropertyValue",
"name": "contentLanguage",
"value": [
"en",
"es"
]
},
]
}
],
// Other properties...
}
Providing trailer information through the Movie entity
{
"@context": ["http://schema.org", {"@language": "en"}],
"@type": "Movie",
"@id": "http://www.example.com/my_favorite_movie",
"url": "http://www.example.com/my_favorite_movie",
"name": "My Favorite Movie",
"trailer":[
{
"@type":"VideoObject",
"description":"In a world where dreamers continue to dream...",
"inLanguage":"en-US",
"url":"https://www.youtube.com/watch?v=contentIDhere"
}
],
"potentialAction": {
"@type": "WatchAction",
"target": {
"@type": "EntryPoint",
"urlTemplate": "http://www.example.com/my_favorite_movie?autoplay=true",
"inLanguage": "en",
"actionPlatform": [
"http://schema.org/DesktopWebPlatform",
"http://schema.org/MobileWebPlatform",
"http://schema.org/AndroidPlatform"
]
},
"actionAccessibilityRequirement": {
"@type": "ActionAccessSpecification",
"category": "subscription",
"requiresSubscription": {
"@type": "MediaSubscription",
"name": "Example Package",
"commonTier": true,
"@id": "http://www.example.com/example_package"
},
"availabilityStarts": "2018-07-21T10:35:29Z",
"availabilityEnds": "2019-10-21T10:35:29Z",
"eligibleRegion": [
{
"@type": "Country",
"name": "US"
}
]
}
}
}
Depicting a tiered subscription package offering for your catalog
Movie
A Movie entity that is available through both "Premium Package" and "Basic Package" subscription tiers. Extend this example to capture subscription offerings that include multiple packages or tiers or has add-on support.
{
"@context": [
"http://schema.org",
{
"@language": "en"
}
],
"@type": "Movie",
"@id": "http://www.example.com/my_favorite_movie",
"url": "http://www.example.com/my_favorite_movie",
"name": "My Favorite Movie",
"potentialAction": {
"@type": "WatchAction",
"target": {
"@type": "EntryPoint",
"urlTemplate": "http://www.example.com/my_favorite_movie?autoplay=true",
"inLanguage": "en",
"actionPlatform": [
"http://schema.org/DesktopWebPlatform",
"http://schema.org/MobileWebPlatform",
"http://schema.org/AndroidPlatform"
]
},
"actionAccessibilityRequirement": {
"@type": "ActionAccessSpecification",
"category": "subscription",
"availabilityStarts": "2018-07-21T10:35:29Z",
"availabilityEnds": "2019-10-21T10:35:29Z",
"requiresSubscription": [
{
"@type": "MediaSubscription",
"name": "Basic Package",
"@id": "http://www.example.com/basic_package",
"commonTier": true
},
{
"@type": "MediaSubscription",
"name": "Premium Package",
"@id": "http://www.example.com/premium_package",
"commonTier": false,
"identifier": "example.com:premium_package"
}
],
"eligibleRegion": [
{
"@type": "Country",
"name": "US"
}
]
}
},
"sameAs": "https://en.wikipedia.org/wiki/my_favorite_movie",
"releasedEvent": {
"@type": "PublicationEvent",
"startDate": "2008-01-20",
"location": {
"@type": "Country",
"name": "US"
}
},
"description": "This is my favorite movie.",
"actor": [
{
"@type": "Person",
"name": "John Doe",
"sameAs": "https://en.wikipedia.org/wiki/John_Doe"
}
],
"identifier": [
{
"@type": "PropertyValue",
"propertyID": "IMDB_ID",
"value": "tt0123456"
}
]
}
TVSeries
A TVSeries entity that is available only through the "Premium Package" of the subscription.
{
"@context": [
"http://schema.org",
{
"@language": "en"
}
],
"@type": "TVSeries",
"@id": "http://www.example.com/my_favorite_tv_show/",
"url": "http://www.example.com/my_favorite_tv_show/",
"name": "My Favorite TV Show",
"potentialAction": {
"@type": "WatchAction",
"target": {
"@type": "EntryPoint",
"urlTemplate": "http://www.example.com/my_favorite_tv_show/watch?autoplay=true",
"inLanguage": "en",
"actionPlatform": [
"http://schema.org/DesktopWebPlatform",
"http://schema.org/MobileWebPlatform",
"http://schema.org/AndroidPlatform"
]
},
"actionAccessibilityRequirement": {
"@type": "ActionAccessSpecification",
"category": "subscription",
"availabilityStarts": "2017-07-21T10:35:29Z",
"availabilityEnds": "2018-10-21T10:35:29Z",
"requiresSubscription": {
"@type": "MediaSubscription",
"name": "Premium Package",
"@id": "http://www.example.com/premium_package",
"identifier": "example.com:premium",
"commonTier": false
},
"eligibleRegion": [
{
"@type": "Country",
"name": "US"
}
]
}
},
"sameAs": "https://en.wikipedia.org/wiki/my_favorite_tv_show",
"releasedEvent": {
"@type": "PublicationEvent",
"startDate": "2008-01-20",
"location": {
"@type": "Country",
"name": "US"
}
}
"description": "This is my favorite TV show.",
"actor": [
{
"@type": "Person",
"name": "John Doe",
"sameAs": "https://en.wikipedia.org/wiki/john_doe"
}
]
}
Providing different types of releasedEvents - PublicationEvent, FeaturedEvent, and ExclusiveEvents
Representing original but not exclusive content
The feed provider is featuring a movie worldwide for the month of April 2020. The movie was originally released in the US on Oct 1, 2018.
{
"@context": [ "http://schema.org", { "@language": "en" } ],
"@type": "Movie",
"@id": "http://www.example.com/my_favorite_movie",
"url": "http://www.example.com/my_favorite_movie",
"releasedEvent": [
{
"@type": "FeaturedEvent",
"location": "EARTH",
"startDate": "2020-04-01",
"endDate": "2020-04-30",
"publishedBy": {
"@type": "Organization",
"@id": "https://www.abcmedia.com/",
"sameAs": "https://en.wikipedia.org/wiki/ABCMedia",
"name": "ABC Media"
}
},
{
"@type": "PublicationEvent",
"location": {
"@type": "Country",
"name": "US"
},
"startDate": "2018-10-01T20:00",
"publishedBy": {
"@type": "Organization",
"@id": "https://www.abcmedia.com/",
"sameAs": "https://en.wikipedia.org/wiki/ABCMedia",
"name": "ABC Media"
}
}
]
}
Representing exclusive but not original content
The provider who supplies the feed has exclusive right to a movie across the world from Sep 2019 to Sep 2030.
{
"@context": [ "http://schema.org", { "@language": "en" } ],
"@type": "Movie",
"@id": "http://www.example.com/my_favorite_movie",
"url": "http://www.example.com/my_favorite_movie",
"releasedEvent": [ {
"@type": "ExclusiveEvent",
"location": "EARTH",
"startDate": "2019-09-01T00:00",
"endDate": "2030-09-27T00:00",
"publishedBy": {
"@type": "Organization",
"@id": "https://www.abcmedia.com/",
"sameAs": "https://en.wikipedia.org/wiki/ABCMedia",
"name": "ABC Media"
}, {
"@type": "PublicationEvent",
"location": "EARTH",
"startDate": "2018-10-01T20:00",
"publishedBy": {
"@type": "Organization",
"@id": "https://www.abcmedia.com/",
"sameAs": "https://en.wikipedia.org/wiki/ABCMedia",
"name": "ABC Media"
}
}
]
}
Representing exclusive and original content
The provider who supplies the feed has exclusive right to the content across the world from Sep 2019 to Sep 2030. The entity is featured in the US and Canada for the month of April 2020.
Note: Marking a TV series as exclusive or original implies that all episodes of the show are marked this way.
{
"@context": [ "http://schema.org", { "@language": "en" } ],
"@type": "TVSeries",
"@id": "http://www.example.com/my_favorite_tvshow",
"url": "http://www.example.com/my_favorite_tvshow",
"releasedEvent": [ {
"@type": "FeaturedEvent",
"location": [
{
"@type": "Country",
"name": "US"
},
{
"@type": "Country",
"name": "CA"
}
],
"startDate": "2020-04-01",
"endDate": "2020-04-30",
"publishedBy": {
"@type": "Organization",
"@id": "https://www.abcmedia.com/",
"sameAs": "https://en.wikipedia.org/wiki/ABCMedia",
"name": "ABC Media"
}
}, {
"@type": "ExclusiveEvent",
"location": "EARTH",
"startDate": "2019-09-01T00:00",
"endDate": "2030-09-27T00:00",
"publishedBy": {
"@type": "Organization",
"@id": "https://www.abcmedia.com/",
"sameAs": "https://en.wikipedia.org/wiki/ABCMedia",
"name": "ABC Media"
}, {
"@type": "PublicationEvent",
"location": "EARTH",
"startDate": "2018-10-01T20:00",
"publishedBy": {
"@type": "Organization",
"@id": "https://www.abcmedia.com/",
"sameAs": "https://en.wikipedia.org/wiki/ABCMedia",
"name": "ABC Media"
}
}
]
}
Identifier/EIDR Example
Main movie
A movie with an extended cut variant. Notice that this entity has a titleEIDR apart from an IMDB_ID identifier.
{
"@context": ["http://schema.org", {"@language": "en"}],
"@type": "Movie",
"@id": "http://www.example.com/my_favorite_movie",
"url": "http://www.example.com/my_favorite_movie",
"name": "My Favorite Movie",
"potentialAction": {
"@type": "WatchAction",
"target": {
"@type": "EntryPoint",
"urlTemplate": "http://www.example.com/my_favorite_movie?autoplay=true",
"inLanguage": "en",
"actionPlatform": [
"http://schema.org/DesktopWebPlatform",
"http://schema.org/MobileWebPlatform",
"http://schema.org/AndroidPlatform",
"http://schema.org/AndroidTVPlatform",
"http://schema.org/IOSPlatform",
"http://schema.googleapis.com/GoogleVideoCast"
]
},
"actionAccessibilityRequirement": {
"@type": "ActionAccessSpecification",
"category": "subscription",
"availabilityStarts": "2018-07-21T10:35:29Z",
"availabilityEnds": "2019-10-21T10:35:29Z",
"requiresSubscription": {
"@type": "MediaSubscription",
"name": "Example Package",
"commonTier": true,
"@id": "https://example.com/package/example"
},
"eligibleRegion": [
{
"@type": "Country",
"name": "US"
},
{
"@type": "Country",
"name": "CA"
}
]
}
},
"sameAs": "https://en.wikipedia.org/wiki/my_favorite_movie",
"contentRating": "RATING NOT KNOWN",
"releasedEvent": {
"@type": "PublicationEvent",
"startDate": "2008-01-20",
"location": {
"@type": "Country",
"name": "US"
}
},
"popularityScore": {
"@type": "PopularityScoreSpecification",
"value": 78,
"eligibleRegion": [
{
"@type": "Country",
"name": "US"
},
{
"@type": "Country",
"name": "CA"
}
]
},
"description": "This is my favorite movie.",
"actor": [
{
"@type": "Person",
"name": "John Doe",
"sameAs": "https://en.wikipedia.org/wiki/John_Doe"
},
{
"@type": "Person",
"name": "Jane Doe",
"sameAs": "https://en.wikipedia.org/wiki/Jane_Doe"
}
],
"titleEIDR" : "10.5240/7EC7-228A-510A-053E-CBB8-J",
"identifier": [
{
"@type": "PropertyValue",
"propertyID": "IMDB_ID",
"value": "tt0123456"
}
],
"workExample": {
"@type": "Movie",
"@id": "http://www.example.com/my_favorite_movie_extended_cut",
"name": "My Favorite Movie Extended Cut"
"category": "Extended Cut"
}
}
Extended cut variant
The extended cut version of the main movie. Notice that this variant entity has both titleEIDR and an editEIDR.
{
"@context": ["http://schema.org", {"@language": "en"}],
"@type": "Movie",
"@id": "http://www.example.com/my_favorite_movie_extended_cut",
"url": "http://www.example.com/my_favorite_movie_extended_cut",
"name": "My Favorite Movie Extended Cut",
"potentialAction": {
"@type": "WatchAction",
"target": {
"@type": "EntryPoint",
"urlTemplate": "http://www.example.com/my_favorite_movie_extended_cut?autoplay=true",
"inLanguage": "en",
"actionPlatform": [
"http://schema.org/DesktopWebPlatform",
"http://schema.org/MobileWebPlatform",
"http://schema.org/AndroidPlatform",
"http://schema.org/AndroidTVPlatform",
"http://schema.org/IOSPlatform",
"http://schema.googleapis.com/GoogleVideoCast"
]
},
"actionAccessibilityRequirement": {
"@type": "ActionAccessSpecification",
"category": "subscription",
"availabilityStarts": "2018-07-21T10:35:29Z",
"availabilityEnds": "2019-10-21T10:35:29Z",
"requiresSubscription": {
"@type": "MediaSubscription",
"name": "Example Package",
"commonTier": true,
"@id": "http://www.example.com/example_package",
"identifier": "example.com:example_package"
},
"eligibleRegion": [
{
"@type": "Country",
"name": "US"
},
{
"@type": "Country",
"name": "CA"
}
]
}
},
"sameAs": "https://en.wikipedia.org/wiki/my_favorite_movie_extended_cut",
"contentRating": {
"@type": "Rating",
"author": "MPAA",
"ratingValue": "R",
"advisoryCode": "FV"
},
"releasedEvent": {
"@type": "PublicationEvent",
"startDate": "2008-01-20",
"location": {
"@type": "Country",
"name": "US"
}
},
"description": "This is the extended cut of my favorite movie.",
"actor": [
{
"@type": "Person",
"name": "John Doe",
"sameAs": "https://en.wikipedia.org/wiki/John_Doe"
},
{
"@type": "Person",
"name": "Jane Doe",
"sameAs": "https://en.wikipedia.org/wiki/Jane_Doe"
}
],
"titleEIDR" : "10.5240/7EC7-228A-510A-053E-CBB8-J",
"editEIDR" : "10.5240/1F2A-E1C5-680A-14C6-E76B-I",
"exampleOfWork": {
"@id": "http://www.example.com/my_favorite_movie",
}
"category": "Extended Cut"
}