Entity Types for Video Content

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
• Actor
• App
• Channel
• Character
• Event
• Franchise
• Genre
• League
• Popularity
• ProductionCompany
• ProgramHierarchy
• Recency
• Season and Episode
• Sport
• SportsTeam
• Video
• VideoResolution
• Example: SearchAndPlay with Entities Specified

MediaType

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

Actor

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

App

App represents an application; for example, Prime Video might contain the following:

Channel

Channel represents the identifying data for a television channel; for example, "PBS" might contain the following:

Character

A character represented in video media content; for example, Snow White might contain the following:

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.

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.

Genre

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

League

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

Popularity

Popularity indicates whether the user asks for popular content.

ProductionCompany

ProductionCompany represents the production company name for the video media content; for example, "Marvel" or "Disney."

ProgramHierarchy

ProgramHierarchy represents the level in the program information hierarchy for serial content like TV shows. For example, a request to display the seasons of "Bosch" would include a ProgramHierarchy value of "Seasons".

Recency

The resolved values for Recency indicate whether the user asks for new or old content.

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.

Sport

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

SportsTeam

SportsTeam represents the categorical information of a professional sports team; for example, "University of Washington Huskies" is a sports team that might contain the following:

Video

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

VideoResolution

VideoResolution represents the requested video resolution in one of the following standards:

• SD (480p)
• HD (720p-1080p)
• 4k (2160p)
• 8k (4320p)

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"
      }
    }
  }
}