開発者コンソール

ビデオコンテンツのエンティティタイプ


ビデオコンテンツのエンティティタイプ

entitiesオブジェクトは、オブジェクトのリストで構成されています。それぞれのオブジェクトには、タイプや値のほか、外部IDなどのその他のデータが含まれます。以降のセクションでは、有効な値について説明します。

Actor

Actorは、ビデオメディアコンテンツに出演している俳優を表します。たとえば、女優の「ギャビー・ホフマン」の場合は、以下のようなフィールドが含まれます。

フィールド 説明
externalIds このエンティティの外部識別子のマップです。キーはプロバイダー、値はIDです。 オブジェクト
ASIN このエンティティの外部ASINです。 文字列 B01M3X9T06
Gracenote 俳優のGracenote IDです。 文字列 ST0000000666661
uri 俳優/女優へのURIマッピングです。 URI entity://provider/actor/caseyaffleck
value 俳優の名前です。 文字列 ギャビー・ホフマン

App

Appは、ユーザーが発話で指定した明示的なアプリ名を表します。たとえば、Amazonプライム・ビデオの「マンチェスター・バイ・ザ・シー」の場合は、以下のようなフィールドが含まれます。

フィールド 説明
externalIds このエンティティの外部識別子のマップです。キーはプロバイダー、値はIDです。 オブジェクト
ENTITY_ID アプリのリストに含まれるアプリ識別子です。 文字列 amzn1.alexa-ask-target.app.72095
value アプリの名前です。 文字列 Amazonプライム・ビデオ

Channel

Channelは、テレビチャンネルの識別データを表します。たとえば、「PBS」には以下のようなフィールドが含まれます。

フィールド 説明
externalIds このエンティティの外部識別子のマップです。キーはプロバイダー、値はIDです。 オブジェクト
Gracenote 外部Gracenote IDです。 文字列 ST0000000666661
entityMetadata チャンネルに関連付けられたメタデータのマップです。 オブジェクト
channelNumber チャンネル番号です。 整数 1234
channelCallSign チャンネルのコールサインです。 文字列 KBTC
uri チャンネルのURIです。 URI entity://provider/channel/1234
value チャンネルの名前です。 文字列 PBS

Character

characterは、ビデオメディアコンテンツのキャラクターを表します。たとえば、「白雪姫」の場合は、以下のようなフィールドが含まれます。

フィールド 説明
externalIds このエンティティの外部識別子のマップです。キーはプロバイダー、値はIDです。 オブジェクト
ASIN このエンティティのASIN(Amazon Standard Identification Number)です。 文字列 B00DT55P3K
Gracenote キャラクターのGracenote IDです。 文字列 ST0000000123456
uri キャラクターへのURIマッピングです。 URI entity://provider/character/harrypotter
value キャラクターの名前です。 文字列 白雪姫

Director

Directorは、ビデオメディアコンテンツの監督名を表します。たとえば、「ケネス・ロナーガン」の場合は、以下のようなフィールドが含まれます。

フィールド 説明
externalIds このエンティティの外部識別子のマップです。キーはプロバイダー、値はIDです。 オブジェクト
Gracenote 外部Gracenote IDです。 文字列 MV0000000666661
uri 監督へのURIマッピングです。 URI entity://provider/director/kennethlonergan
value 監督の名前です。 文字列 ケネス・ロナーガン

Episode

Episodeは、TV番組などの連続コンテンツのエピソード番号を表します。たとえば、「トランスペアレント」第8話のエピソード番号は「8」になります。

フィールド 説明
value エピソード番号です。 整数 8

Event

Eventは、イベントタイプへの参照です。これには、スポーツ、音楽、その他のタイプのイベントが含まれます。たとえば、「フットボールの試合」を検索する場合、「試合」というイベントエンティティと「フットボール」というスポーツエンティティが検索されます。

フィールド 説明
externalIds このエンティティの外部識別子のマップです。キーはプロバイダー、値はIDです。 オブジェクト
Gracenote イベントのGracenote IDです。 文字列 ST0000000666661
uri イベントへのURIマッピングです。 URI entity://amazon/events/games
value イベントタイプの名前です。 文字列 試合

Franchise

Franchiseは、映画やTV番組など、複数のビデオエンティティを表すビデオエンティティです。たとえば、「宇宙大戦争」というSFシリーズの場合、映画シリーズのほか、アニメと実写のTV番組もあります。このエンティティタイプを使用すると、ユーザーが「『宇宙大戦争』の映画を探して」などとリクエストする場合、1つのタイトルだけでなく、MediaTypeMOVIEである「宇宙大戦争」の全コンテンツを検索できます。

フィールド 説明
externalIds このエンティティの外部識別子のマップです。キーはプロバイダー、値はIDです。 オブジェクト
Gracenote 外部Gracenote IDです。 文字列 ST0000000666661
uri シリーズへのURIマッピングです。 イベントへのURIマッピングです。 entity://amazon/franchise/intergalacticwars
value ジャンルの名前です。 文字列 宇宙大戦争

Genre

Genreは、アクション、ドラマ、コメディといったビデオメディアコンテンツのジャンルを表します。たとえば、アクションのジャンルの場合は、以下のようなフィールドが含まれます。

フィールド 説明
externalIds このエンティティの外部識別子のマップです。キーはプロバイダー、値はIDです。 オブジェクト
Gracenote 外部Gracenote IDです。 文字列 ST0000000666661
uri ジャンルへのURIマッピングです。 URI entity://provider/genre/action
value ジャンルの名前です。 文字列 アクション

League

Leagueは、スポーツリーグのカテゴリー情報を表します。たとえば、NCAAというリーグの場合は、以下のようなフィールドが含まれます。

フィールド 説明
externalIds このエンティティの外部識別子のマップです。キーはプロバイダー、値はIDです。 オブジェクト
Gracenote リーグのGracenote IDです。 文字列 ST0000000666661
uri リーグへのURIマッピングです。 URI entity://amazon/league/ncaa
value リーグの名前です。 文字列 NCAA

MediaType

MediaTypeは、特定のコンテンツのメディアタイプカテゴリーを表します。たとえば、「マンチェスター・バイ・ザ・シー」という映画の場合、MediaTypeMOVIEになります。

フィールド 説明
value メディアタイプです。有効な値は、MOVIEVIDEOTV_SHOWです。 列挙型 MOVIE

ProductionCompany

ProductionCompanyは、ビデオメディアコンテンツの制作会社名を表します(例:Marvels、Disney)。

フィールド 説明
value 制作会社の名前です。 文字列 Marvel

Season

Seasonは、TV番組などの連続コンテンツのシーズン番号を表します。たとえば、「トランスペアレント」シーズン2のシーズン番号は「2」になります。

フィールド 説明
value シーズン番号です。 整数 2

Sport

Sportは、スポーツのカテゴリー情報を表します。たとえば、フットボールの場合は、以下のようなフィールドが含まれます。

フィールド 説明
externalIds このエンティティの外部識別子のマップです。キーはプロバイダー、値はIDです。 オブジェクト
Gracenote スポーツのGracenote IDです。 文字列 ST0000000666661
uri スポーツへのURIマッピングです。 URI entity://amazon/sport/football
value スポーツの名前です。 文字列 フットボール

SportsTeam

SportsTeamは、プロスポーツチームのカテゴリー情報を表します。たとえば、「ワシントン大学ハスキーズ」というスポーツチームの場合は、以下のようなフィールドが含まれます。

フィールド 説明
externalIds このエンティティの外部識別子のマップです。キーはプロバイダー、値はIDです。 オブジェクト
Gracenote このチームのGracenote IDです。 文字列 ST0000000666661
uri スポーツチームへのURIマッピングです。 URI entity://amazon/sportsteam/huskies
value スポーツチームの名前です。 文字列 ワシントン大学ハスキーズ

Video

Videoは、ビデオコンテンツの識別データを表します。たとえば、「マンチェスター・バイ・ザ・シー」という映画の場合は、以下のようなフィールドが含まれます。

フィールド 説明
externalIds このエンティティの外部識別子のマップです。キーはプロバイダー、値はIDです。 オブジェクト
ASIN このエンティティの外部ASINです。 文字列 B01M3X9T06
Gracenote Gracenote IDです。 文字列 MV0000000666661
userConfirmations アイテムのユーザー確認に関する情報を含むオブジェクトです。 オブジェクト
entitlementVoiceActivation 視聴期間または視聴権限の音声有効化に成功したかどうかをパートナーに通知するフラグです。有効な値 - CONFIRMED(省略可能)。 列挙型(デフォルトポリシー:認識されない値は無視) CONFIRMED
uri ビデオへのURIマッピングです。 URI entity://provider/movie/manchesterbythesea
value ビデオの名前です。 文字列 マンチェスター・バイ・ザ・シー

Popularity

Popularityは、ユーザーが人気コンテンツを求めているかどうかを示します。

フィールド 説明
value ユーザーが人気コンテンツを検索したことをプロバイダーに示します。 文字列 TRUE

このエンティティタイプには、externalIdsは含まれていません。レスポンスの例(関連する値のみ抜粋)を以下に示します。

"entities": [..{
                "value": "TRUE",
                "type": "Popularity"
              }
            ..],

Recency

Recencyの解決済みの値は、ユーザーが新しいコンテンツを求めているか、古いコンテンツを求めているかを示します。

フィールド 説明
value ユーザーが新しいコンテンツと古いコンテンツのどちらを検索するかを示します。有効な値は、NEWOLDのいずれかです。 列挙型 NEW

このエンティティタイプには、externalIdsは含まれていません。レスポンスの例(関連する値のみ抜粋)を以下に示します。

"entities": [..{
                "value": "NEW",
                "type": "Recency"
              }
            ..],

VideoResolution

VideoResolutionは、リクエストされたビデオ解像度を次のいずれかの規格で表します。

  • SD (480p)
  • HD (720p-1080p)
  • 4k (2160p)
  • 8k (4320p)
フィールド 説明
value ビデオ解像度です。有効な値は、SDHD4k8kです。 列挙型 HD

このエンティティタイプには、externalIdsは含まれていません。レスポンスの例(関連する値のみ抜粋)を以下に示します。

"entities": [..{
                "value": "4k",
                "type": "VideoResolution"
              }
            ..],

例: エンティティを指定したGetPlayableItems

以下に示すGetPlayableItemsディレクティブのペイロードでは、"type": "Video"が、payloadentities配列に含まれています。

{
    "directive": {
        "header": {
            "correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/jCc8ptlAKulUj90jSqg==",
            "messageId": "9f4803ec-4c94-4fdf-89c2-d502d5e52bb4",
            "name": "GetPlayableItems",
            "namespace": "Alexa.VideoContentProvider",
            "payloadVersion": "3"
        },
        "endpoint": {
            "scope": {
                "type": "BearerToken",
                "token": "access-token-from-skill"
            },
            "endpointId": "videoDevice-001",
            "cookie": {

            }
        },
        "payload": {
            "entities": [
                {
                    "type": "Video",
                    "value": "マンチェスター・バイ・ザ・シー",
                    "externalIds": {
                        "gracenote": "MV000000099001"
                    }
                }
            ],
            "contentType": "RECORDING",
            "locale": "ja-JP",
            "minResultLimit": 8,
            "maxResultLimit": 25,
            "timeWindow": {
                "end": "2016-09-07T23:59:00+00:00",
                "start": "2016-09-01T00:00:00+00:00"
            }
        }
    }
}