Watch Actions feed examples

The following examples demonstrate some of the common scenarios for Watch Actions. To simplify, these examples omit the details of some properties.

Base case

An entity with one deep link and one accessibility requirement:

{
  "@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/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",
        "@id": "http://www.example.com/premium_subscription",
        "name": "Example Premium",
        "sameAs": "http://www.example.com/premium_subscription"
      },
      "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"
    }
  ]
}

An entity with an old style link for Android and a deep link for all other platforms:

{
  "@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/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"
        ]
      }
    ],
    "actionAccessibilityRequirement": {
      "@type": "ActionAccessSpecification",
      "category": "subscription",
      "availabilityStarts": "2018-07-21T10:35:29Z",
      "availabilityEnds": "2019-10-21T10:35:29Z",
      "requiresSubscription": {
        "@type": "MediaSubscription",
        "@id": "http://www.example.com/premium_subscription",
        "name": "Example Premium",
        "sameAs": "http://www.example.com/premium_subscription"
      },
      "eligibleRegion": [
        {
          "@type": "Country",
          "name": "US"
        },
        {
          "@type": "Country",
          "name": "CA"
        }
      ]
    }
  },
  // Other properties...
}

Time-bound accessibility requirement

An entity that changes its accesibility requirement over time - free for a limited time and subscription afterwards:

{
  "@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/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",
          "@id": "http://www.example.com/premium_subscription",
          "name": "Example Premium",
          "sameAs": "http://www.example.com/premium_subscription"
        },
        "eligibleRegion": [
          {
            "@type": "Country",
            "name": "US"
          },
          {
            "@type": "Country",
            "name": "CA"
          }
        ]
      }
    ]
  },
  // Other properties...
}

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:

{
  "@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/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",
          "@id": "http://www.example.com/premium_subscription",
          "name": "Example Premium",
          "sameAs": "http://www.example.com/premium_subscription"
        },
        "eligibleRegion": [
          {
            "@type": "Country",
            "name": "US"
          },
          {
            "@type": "Country",
            "name": "CA"
          }
        ]
      }
    }
  ]
  // Other properties...
}

TV episode, TV series, and TV season

A feed that contains the following entities for a TV show:

  • Two TVEpisode - My Favorite TV Show, Season 7, Episode 14 and 15
  • A TVSeries - My Favorite TV Show
  • A TVSeason - My Favorite TV Show, Season 7
{
  "@context": ["http://schema.org", {"@language": "en"}],
  "@type": "DataFeed",
  "dateModified": "2019-03-20T00:44:51Z",
  "dataFeedElement": [
    {
      "@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,
      "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",
      },
      // Other properties...
    },
    {
      "@context": ["http://schema.org", {"@language": "en"}],
      "@type": "TVEpisode",
      "@id": "http://www.example.com/my_favorite_tv_show/s7/e15",
      "url": "http://www.example.com/my_favorite_tv_show/s7/e15",
      "name": "Jane Doe returns the horse.",
      "episodeNumber": 15,
      "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",
      },
      // Other properties...
    },
    {
      "@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",
      // Other properties...
    },
    {
      "@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",
      },
      // Other properties...
    }
  ]
}

additionalProperty

An entity with a set of additionalProperty:

{
  "@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/IOSPlatform"
       ]
      },
      "actionAccessibilityRequirement": {
        "@type": "ActionAccessSpecification",
        "category": "free",
        "availabilityStarts": "2019-01-01T10:35:29Z",
        "availabilityEnds": "2019-05-31T10:35:29Z",
        "eligibleRegion": {
          "@type": "Country",
          "name": "US"
        }
      }
    },
    {
      "@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.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",
        "availabilityStarts": "2019-01-01T10:35:29Z",
        "availabilityEnds": "2019-05-31T10:35:29Z",
        "requiresSubscription": {
          "@type": "MediaSubscription",
          "@id": "http://www.example.com/premium_subscription",
          "name": "Example Premium",
        },
        "eligibleRegion": [
          {
            "@type": "Country",
            "name": "US"
          },
          {
            "@type": "Country",
            "name": "CA"
          }
        ]
      }
    }
  ]
  // Other properties...
}

Multiple regions and languages

An entity is 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",
        "availabilityStarts": "2018-07-21T10:35:29Z",
        "availabilityEnds": "2019-10-21T10:35:29Z",
        "requiresSubscription": {
          "@type": "MediaSubscription",
          "@id": "http://www.example.com/premium_subscription",
          "name": "Example Premium",
        },
        "eligibleRegion": [
          {
            "@type": "Country",
            "name": "US"
          },
          {
            "@type": "Country",
            "name": "GB"
          },
          {
            "@type": "Country",
            "name": "MX"
          }
        ]
      },
      "additionalProperty": [
        {
          "@type": "PropertyValue",
          "name": "contentLanguage",
          "value": [
            "en",
            "es"
          ]
        },
      ]
    }
  ],
  // Other properties...
}

Trailer

An entity with a trailer:

{
  "@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",
        "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",
        "@id": "http://www.example.com/premium_subscription",
        "name": "Example Premium",
        "sameAs": "http://www.example.com/premium_subscription"
      },
      "eligibleRegion": [
        {
          "@type": "Country",
          "name": "US"
        },
        {
          "@type": "Country",
          "name": "CA"
        }
      ]
    }
  },
  // Other properties...
}