Home > Alexa > Alexa Skills Kit

Entity Types for Video Content

intro

The entities object consists of a list of objects, each of which contains a type and a value along with other possible data such as external ids. Possible values for type are:

MediaType

MediaType represents the media type category of a particular piece of content; for example, “Manchester by the Sea” would be MediaType MOVIE.

Field Description Type Example
value The media type; possible values - MOVIE, VIDEO, TV_SHOW Enum MOVIE

Actor

Actor represents an actor credited in video media content; for example, Gaby Hoffman might contain the following:

Field Description Type Example
externalIds A map of external identifiers for this entity, key is the provider, value is the Id Object    
gracenote The external gracenote identifier String ST0000000666661
value The name of the actor String Gaby Hoffman

Event

An event is a reference to a type of event; examples would include sports, music, or other types of events. For example, searching for “Football games” would search for a ‘game’ event entity and a ‘football’ sport entity.

Field Description Type Example
externalIds A map of external identifiers for this entity, key is the provider, value is the id Object  
gracenote The external gracenote identifier String 100
value The name of the event type String Games

Franchise

A franchise is a video entity which can represent a number of video entities, like movies or TV shows. For example, take the fictional franchise “Intergalactic Wars” which represents a collection of movie trilogies, as well as animated and live action TV shows. This entity type was introduced to account for requests by customers such as “Find Intergalactic Wars movies”, which would search for all ‘Intergalactic Wars’ programs of the MOVIE MediaType, rather than attempting to match to a single title.

Field Description Type Example
value The name of the franchise String Intergalactic Wars

Genre

Genre represents the genre of video media content such as action, drama or comedy. For example, the Action genre might contain the following:

Field Description Type Example
externalIds A map of external identifiers for this entity, key is the provider, value is the id Object  
gracenote The external gracenote identifier String 101
value The name of the genre String Action

League

League represents the categorical information for a sporting league; for example, “NCAA” is a league that might contain the following:

Field Description Type Example
externalIds A map of external identifiers for this entity, key is the provider, value is the id Object  
gracenote The external gracenote identifier String L0000000666661
value The name of the league String NCAA

Season and Episode

Season and Episode represents the season and episode numbers for serial content like TV Shows; for example, the eighth episode in season two of “Transparent” would have season number 2, episode number 8.

Field Description Type Example
value The season number Integer 2
value The episode number Integer 8

Sport

Sport represents the categorical information of a sport; for example, football is a sport that might contain the following:

Field Description Type Example
externalIds A map of external identifiers for this entity, key is the provider, value is the id Object  
gracenote The external gracenote identifier String SP0000000666661
value The name of the sport String Football

SportsTeam

SportsTeam represents the categorical information of a professional sports team; for example, “UW Huskies” is a sports team that might contain the following:

Field Description Type Example
externalIds A map of external identifiers for this entity, key is the provider, value is the id Object  
gracenote The external gracenote identifier String 100
value The name of the sports team String UW Huskies

Video

Video represents the identifying data for the piece of video content; for example, “Manchester by the Sea” might contain the following:

Field Description Type Example
externalIds A map of external identifiers for this entity, key is the provider, value is the id Object  
asin The external ASIN of this Video String B01M3X9T06
gracenote The external gracenote identifier String MV0000000666661
value The name of the video String Manchester by the Sea

Example: SearchAndPlay with Entities Specified

{
  "directive": {
    "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "some-access-token"
      },
      "endpointId": "appliance-001",
      "cookie": {}
    },
    "header": {
      "messageId": "5f2477e6-8f57-4606-af18-6990b8646794",
      "name": "SearchAndPlay",
      "namespace": "Alexa.RemoteVideoPlayer",
      "payloadVersion": "3"
    },
    "payload": {
      "entities": [{
        "externalIds": {
          "gracenote": "MV000000099001"
        },
        "name": "Manchester by the Sea",
        "type": "Video"
      }],
      "timeWindow": {
        "end": "2016-09-07T23:59:00+00:00",
        "start": "2016-09-01T00:00:00+00:00"
      }
    }
  }
}