GetDisplayableItemsディレクティブ


GetDisplayableItemsディレクティブ

コンテンツを検索したり、コンテンツプロバイダーのランディングページにアクセスしたりするための発話をユーザーが行うと、VideoContentProvider APIからLambdaにGetDisplayableItemsディレクティブが送信されます。

次の図は、Alexaディレクティブとそれに対するLambdaのレスポンスを示しています。

GetDisplayableItemsディレクティブとLambdaのGetDisplayableItemsResponse

GetDisplayableItemsの発話

ユーザーが以下の発話を行うと、AlexaからLambdaにGetDisplayableItemsディレクティブが送信されます。

機能 サンプル発話 想定される結果
<タイトル>を検索

Search for Breaking Bad

Find The Big Bang Theory

Suche nach <title>

Nach <title> suchen

<Breaking Bad>

Cherche Breaking Bad

Trouve Breaking Bad

Trouve-moi Breaking Bad

Cherche/trouve breaking bad

cerca breaking bad

<House, The Office, Sneaky Pete>

busca breaking bad

busca breaking bad

búscame breaking bad

búsca me breaking bad

{title} を探して

{title} を検索して

タイトルに一致する検索結果のリストがユーザーに表示されます。

メディアタイプで検索

Search movies

Suche nach <type>

<filme, videos, film>

Cherche des films

Trouve des films

Trouve-moi des films

Cherche/trouve des films

cerca dei film

busca películas

busca películas

busca pelís

búscame películas

búscame pelís

búsca me películas

búsca me pelís

{media type} を探して

{media type} を検索して

指定したメディアタイプに一致する検索結果のリストがユーザーに表示されます。

俳優で検索

Search for sean connery

Search for movies with Tom Hanks.

Suche nach <actor>

<Ann Blyth, Axel Deller, John Oliver>

Cherche Sean Connery

Cherche/trouve sean connery

cerca sean connery

<Gianni Franco, Sonia Scotti, Stefano Sani>

busca sean connery

busca sean connery

busca a sean connery

búscale a sean connery

búsca le a sean connery

{actor} を探して

{actor} を検索して

{actor}の{media type} を探して

{actor}の{media type} を検索して

{actor}が出てる{media type} を探して

{actor}が出てる{media type} を検索して

*{media type}:映画/ドラマ/やつ/もの/の

俳優が出演している検索結果のリストがユーザーに表示されます。

シーズン番号で<タイトル>を検索

Search breaking bad season two

Suche nach <title> Staffel <number>

Suche nach der <number>. Staffel von <title> <Breaking Bad>

Cherche la saison 2 de Breaking Bad

Cherche la deuxième saison de Breaking Bad

Trouve la saison 2 de Breaking Bad

Trouve la deuxième saison de Breaking Bad

Trouve-moi la saison 2 de Breaking Bad

Trouve-moi la deuxième saison de Breaking Bad

Cherche/trouve la deuxième saison/saison 2 de breaking bad

cerca la seconda stagione di breaking bad

cerca la stagione due di breaking bad

<House, The Office, Sneaky Pete>

busca la temporada 2 de breaking bad

busca la segunda temporada de breaking bad

busca la temporada 2 de breaking bad

busca la segunda temporada de breaking bad

búscame la temporada 2 de breaking bad

búscame la segunda temporada de breaking bad

búsca me la temporada 2 de breaking bad

búsca me la segunda temporada de breaking bad

{title} シーズン{season number} を探して

{title} シーズン{season number} を探して

{title} シーズン{season number} を検索して

一致するシーズンのすべてのエピソードがユーザーに表示されます。

エピソード番号で<タイトル>を検索

Search for breaking bad episode five

Suche nach <title> Folge <number>

Suche nach <title> Episode <number>

Suche nach der <number>. Folge von <title>

Suche nach der <Number>. Episode von <title>

<Breaking Bad>

Cherche l'épisode 5 de Breaking Bad

Cherche le cinquième épisode de Breaking Bad

Cherche/trouve le/la cinquième épisode/épisode 5 de breaking bad

cerca il quinto episodio di breaking bad

cerca l'episodio cinque di breaking bad

<House, The Office, Sneaky Pete>

busca el episodio 5 de breaking bad

busca el capítulo 5 de breaking bad

busca el episodio 5 de breaking bad

busca el capítulo 5 de breaking bad

búscame el episodio 5 de breaking bad

búscame el capítulo 5 de breaking bad

búsca me el episodio 5 de breaking bad

búsca me el capítulo 5 de breaking bad

{title} エピソード{episode number} を探して

{title} エピソード{episode number} を探して

{title} エピソード{episode number} を検索して

ユーザーが最近視聴したシーズンの視聴可能なエピソードのリストが表示されます。たとえば、ユーザーがシーズン2を視聴中の場合、シーズン2のエピソードのリストが表示されます。

シーズン番号とエピソード番号で<タイトル>を検索

Search for breaking bad season two episode five

Find 'The Big Bang Theory' Season 1 episode 4.

Suche nach <title> Staffel <season number> Folge <episode number>

Suche nach <title> Staffel <season number> Episode <episode number>

Suche nach der <episode number>. Folge von <title> in Staffel <season number>

Suche nach der <episode number>. Episode von <title> in Staffel <season number>

<Breaking Bad>

Cherche l'épisode 5 de la saison 2 de Breaking Bad

Cheche l'épisode 5 de la deuxième saison de Breaking Bad

Cherche le cinquième épisode de la saison 2 de Breaking Bad

Cherche l'épisode 5 de la deuxième saison de Breaking Bad

Cherche/trouve le/la cinquième épisode/épisode 5 de la deuxième saison/saison 2 de breaking bad

cerca il quinto episodio della stagione due di breaking bad

cerca l'episodio cinque della stagione due di breaking bad

<House, The Office, Sneaky Pete>

busca el episodio 5 de la temporada 2 de breaking bad

busca el episodio 5 de la segunda temporada de breaking bad

busca el episodio 5 de la temporada 2 de breaking bad

busca el episodio 5 de la segunda temporada de breaking bad

búscame el episodio 5 de la temporada 2 de breaking bad

búscame el episodio 5 de la segunda temporada de breaking bad

búsca me el episodio 5 de la temporada 2 de breaking bad

búsca me el episodio 5 de la segunda temporada de breaking bad

{title} シーズン{season number} エピソード{episode number} を探して

{title} シーズン{season number} エピソード{episode number} を探して

{title} シーズン{season number} エピソード{episode number} を検索して

ユーザーがリクエストしたシーズンの視聴可能なエピソードのリストが表示されます。これには、ユーザーが具体的にリクエストしたエピソードも含まれます。

シリーズの<タイトル>で検索

Search for star trek

Suche nach <title>

Zeige mir <title>

<Star Wars, James Bond, Batman, Star Trek>

Cherche Star Trek

Trouve Star Trek

Cherche/trouve star treck

cerca star trek

<Superman, cars, Scream>

busca star trek

busca star trek

búscame star trek

búsca me star trek

{franchise} 探して

{franchise} を探して

{franchise} を検索して

シリーズに一致する検索結果のリストがユーザーに表示されます。

キャラクター名で検索

Search for james bond

Suche nach <actor>

Suche nach einem Film mit <actor>

<James Bond>

Cherche James Bond

Trouve James Bond

Cherche/trouve james bond

cerca james bond

<Superman>

busca james bond

busca james bond

busca a james bond

busca james bond

búscame james bond

búsca me james bond

{character} 探して

{character} を探して

{character} を検索して

{character}の{media type} を探して

{character}の{media type} を探して

{character}の{media type} を検索して

{character}が出てる{media type} を探して

{character}が出てる{media type} を探して

{character}が出てる{media type} を検索して

*{media type}:映画/ドラマ/やつ/もの/の

キャラクターが出演しているメディアの検索結果のリストがユーザーに表示されます。

監督名で検索

Search for quentin tarantino

Suche nach einem Film von <director>

Suche nach <director>

Cherche Quentin Tarantino

Trouve Quentin Tarantino

Cherche/trouve xavier dolan

cerca quentin tarantino

busca quentin tarantino

busca quentin tarantino

busca a quentin tarantino

búscame quentin tarantino

búscame a quentin tarantino

búsca me quentin tarantino

búsca me a quentin tarantino

{director name}監督の{media type}探して

{director name}監督の{media type}を探して

{director name}監督の{media type}を検索して

{director name}が監督してる{media type}探して

{director name}が監督してる{media type}を探して

{director name}が監督してる{media type}を検索して

リクエストされた監督が制作したメディアの検索結果のリストがユーザーに表示されます。

制作会社で検索

Search for disney

Suche nach Filmen von <name>

Suche nach einem Film von <name>

Cherche Disney

Trouve Disney

Cherche/trouve disney

cerca disney

busca disney

busca disney

búscame disney

búsca me disney

{company} 探して

{company} を探して

{company} を検索して

制作会社で制作されたメディアの検索結果のリストがユーザーに表示されます。

ジャンル名で検索

Search for comedy

Search comedy movies with Tom Hanks.

Suche nach <genre>

Suche eine <genre>

<Familie, Architektur, Landestypisch>

Cherche une comédie

Trouve une comédie

Cherche des comédies

Trouve des comédies

Cherche/trouve des comédies

cerca una commedia

<Commedia>

busca comedia

busca comedia

busca comedias

búscame comedias

búsca me comedias

{genre} 探して

{genre} を探して

{genre} を検索して

リクエストされたジャンルからメディアの検索結果のリストが(ユーザーへのおすすめメディアを選び出すアルゴリズムによってパーソナライズされて)ユーザーに表示されます。

スポーツのチームで検索

Search seahawks

Suche nach <sports team>

<Erster. FC Heidenheim, Erster FC Heidenheim, Erster FC Kaiserslautern>

Cherche les Bleus

Cherche/trouve le/les Canadiens

cerca juventus

<Aberdeen, ac milan>

busca el Madrid

busca el América

búscame el América

búsca me el América

{sports team} を探して

{sports team} を探して

{sports team} を検索して

スポーツのチームに一致する検索結果のリストがユーザーに表示されます。

スポーツの種類で検索

Search for soccer

Suche nach <sports type>

Cherche du foot/football

Trouve du foot/football

Cherche/trouve du hockey

cerca calcio

busca fútbol

busca fútbol

búscame fútbol

búscame el útbol

busca el fútbol

búsca me fútbol

búsca me el fútbol

{sports type} を探して

{sports type} を探して

{sports type} を検索して

スポーツの種類に一致する検索結果のリストが(ユーザーへのおすすめになるべく基づいて)ユーザーに表示されます。

スポーツのリーグで検索

Search for n. b. a. league

Suche nach <sports league>

<Erste Baseball Bundesliga, Zweite Baseball Bundesliga, Zweite Bundesliga>

Cherche la n.b.a.

Trouve la n.b.a.

Cherche/trouve la LNH/NHL/ligue nationale

cerca l'n.b.a.

cerca la n.b.a.

<America's Cup>

busca la n. b. a.

busca la n. b. a.

búscame la n. b. a.

búsca me la n. b. a.

{sports league} を探して

{sports league} を探して

{sports league} を検索して

スポーツのリーグに一致する検索結果のリストが(ユーザーへのおすすめになるべく基づいて)ユーザーに表示されます。

スポーツのイベントで検索

Search for soccer game

Suche nach <sports event>

Suche <sports event>

Cherche un match de foot/football

Trouve un match de foot/football

Cherche/trouve des matchs/parties/games de hockey

cerca una partita di calcio

cerca partite

<gli europei>

busca partidos de fútbol

busca partidos de fútbol

búscame partidos de fútbol

búsca me partidos de fútbol

{sports event} を探して

{sports event} を探して

{sports event} を検索して

スポーツのイベントに一致する検索結果のリストが(ユーザーへのおすすめになるべく基づいて)ユーザーに表示されます。

<パートナー>アプリを起動

Launch Netflix app

Open Amazon video

Starte <partner app>

<partner app> starten

Öffne <partner app>

<partner app> öffnen

<partner app> aufrufen

Ruf <partner app> auf

<youview, netflix, zattoo, hulu>

Lance Netflix

Ouvre Netflix

lance/ouvre/pars Netflix

lance/ouvre/pars l'appli/l'app/l'application (de) Netflix

apri (l'app di) Netflix

avvia Netflix

<Netflix>

abre (la app de) Netflix

abre (la app de) Netflix

{app} 開いて

{app} 見せて

{app} 起動

{app} 起動して

{app} に行って

{app} に戻って

リクエストされたアプリが起動し、再生可能なメディアのリストが表示されます。マルチモーダルデバイスには、異なるカテゴリーに分類される可能性のあるメディアが表示されるホームページテンプレートがあります。

特殊文字のタイトルを起動

Launch a. t. and t. u-verse app

Starte a, t, und t. u-verse

A. t. und t. u.verse starten

Lance a.t. et t. u-verse

Ouvre a.t. et t. u-verse

no translation yet

abre (la app de) Movistar + (plus)

no translation yet

no translation yet

翻訳はまだありません

リクエストされたアプリが起動し、再生可能なメディアのリストが表示されます。マルチモーダルデバイスには、異なるカテゴリーに分類される可能性のあるメディアが表示されるホームページテンプレートがあります。

アプリを起動

Launch app

App starten

Starte App

App öffnen

Öffne die App

Lance l'application

Ouvre l'application

Lance l'appli

Ouvre l'appli

lance/ouvre/pars l'appli/l'app/l'application

apri (l')app

avvia (l')app

abre (la) app

abre (la) app

アプリを開いて

アプリを起動して

リクエストされたアプリが起動し、再生可能なメディアのリストが表示されます。マルチモーダルデバイスには、異なるカテゴリーに分類される可能性のあるメディアが表示されるホームページテンプレートがあります。

GetDisplayableItemsディレクティブの処理

VideoNameActorNameGenreNameなどの条件を使用してユーザーがコンテンツを検索すると、表示するコンテンツを取得するためのGetDisplayableItemsディレクティブがAlexaから送信されます。

Lambdaのレスポンス(GetDisplayableItemsResponse)には、ユーザーの検索リクエストと一致するコンテンツの基本的な識別情報を含める必要があります。その他のメタデータ(画像など)はレスポンスに含めないでください。

Alexaは、「アレクサ、<ビデオプロバイダー>でコメディを探して」や「アレクサ、<ビデオプロバイダー>でフットボールを探して」など、タイトル以外のリクエストにも対応しています。 このようなリクエストを受け取った場合は、カタログ内で検索して、検索リクエストと一致するタイトルのリストを返す必要があります。パーソナライゼーションアルゴリズムを活用して、ユーザーの好みに合った結果を返すようにしてください。

ユーザーのリクエストと一致する結果が見つからず、レスポンスで返す結果が0件である場合は、2つ目のGetDisplayableItemsディレクティブがSortType = Recommendedに設定されて送信されます。これで、ユーザーへのおすすめビデオをレスポンスに含めて返すことができます。Alexaは、ユーザーに検索結果が0件であることを伝えると同時に、このおすすめコンテンツを提示します。

{
   "type": "SORTTYPE",
   "value": "RECOMMENDED"
}

これで、ユーザーへのおすすめビデオをレスポンスに含めて返すことができます。Alexaは、ユーザーに検索結果が0件であることを伝えると同時に、このおすすめコンテンツを提示します。

GetDisplayableItemsの例

GetDisplayableItemsディレクティブの例を次に示します。

{
    "directive": {
        "header": {
            "correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/jCc8ptlAKulUj90jSqg==",
            "messageId": "9f4803ec-4c94-4fdf-89c2-d502d5e52bb4",
            "name": "GetDisplayableItems",
            "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"
            }
        }
    }
}

GetDisplayableItemsの例(ランディングページ)

ユーザーがプロバイダーのランディングページを開くと、Alexaから2つのGetDisplayableItemsディレクティブが送信されます。

  • 1つ目のディレクティブは、ランディングページのカテゴリーを取得するためのものです。itemTypeプロパティはCATEGORYで、sortTypeRECOMMENDEDに設定されています。
  • 2つ目のディレクティブは、ランディングページの注目ビデオを取得するためのものです。1つ目のディレクティブとは異なり、itemTypeVIDEOに設定されています。

その後、カテゴリーIDとビデオIDを組み合わせたリストと共に、GetDisplayableItemsMetadata呼び出しがAlexaから1回送信されます。レスポンスには、カテゴリーとビデオに関するメタデータが含まれます。

ランディングページに使用されるGetDisplayableItemsディレクティブの例を次に示します。

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

            }
        },
       "payload": {
           "entities": [
                {
                   "type": "SORTTYPE",
                   "value": "RECOMMENDED"
                }
            ],
           "itemType" : "VIDEO",
           "locale": "ja-JP",
           "minResultLimit": 1,
           "maxResultLimit": 1
        }
    }
}

itemTypeは、検索するアイテムのタイプを指定します。値は、VIDEOCATEGORYのいずれかになります。

ペイロードの説明

次の表は、GetDisplayableItemsディレクティブのpayloadフィールドを定義したものです。

ペイロードの説明
フィールド 説明 データ型
entities
(必須)

検索するエンティティオブジェクトのリスト。通常、異なるエンティティタイプ間の関係は、AND演算と解釈されます。たとえば、{genreName = "コメディ," actorName ="トム・ハンクス"}を含むリクエストの場合、検索結果にはトム・ハンクスが出演するコメディの映画またはテレビ番組が含まれる必要があるということになります。

一方、{videoName = "インターステラー," VideoName = "宇宙戦争"}など、同じタイプの複数のエンティティがリクエストに含まれる場合はOR演算と見なして、ディレクティブ内のすべてのエンティティを検索することができます。不確かな場合は、そのタイプ(このケースではvideoName)の先頭のエンティティを最も関連性が高いものと見なします。

さらに、{mediaType = "MOVIE', genreName = "コメディ," actorName ="トム・ハンクス," actorName = "トム・ハンクス}というリクエストを考えてみましょう。これは、トム・ハンクスという名前の俳優が複数存在すると考えられます。このような場合は、リクエスト内のすべての俳優を含む映画を検索したうえで、コメディのジャンルでフィルタリングして、すべての検索結果を返すことができます。

現時点では、一致するエンティティが複数ある場合にユーザーが何を再生したいかを知る方法がAlexaにはないため、エンティティのランク付けは行われません。

type: Channelを持つentitiesには、 テレビチャンネルの識別データが格納されます。以下に例を示します。

 {
  "type": "Channel",
  "value": "PBS",
  "externalIds": {
      "gracenote": "MV000000099001"
  },
  "entityMetadata": {
      "channelCallSign": "KBTC",
      "channelNumber": "123"
  }
} 

リスト
type

ビデオコンテンツのエンティティタイプ。ビデオコンテンツのエンティティタイプについては、[ビデオコンテンツのエンティティタイプ](../video-skills-fire-tv-apps/entity-types-for-video-content.html)を参照してください。このリストに加え、Alexa Skills Kitには、マルチモーダルデバイス用の新しいタイプ (LISTTYPESORTTYPE)が追加されています。

LISTTYPEは、ユーザーがウォッチリストやライブラリの閲覧を希望している場合に設定されます。たとえば、「ウォッチリストを見せて」や「ビデオライブラリを見せて」といった発話が挙げられます。 LISTTYPEには、次の列挙値を設定できます。

  • WATCHLIST: 「ウォッチリストを見せて」 - ユーザーのウォッチリストに追加されているビデオを表示する際に使用します。
  • LIBRARY: 「ビデオライブラリを見せて」 - ユーザーのライブラリに存在するビデオを表示する際に使用します。通常、これにはユーザーが購入したビデオが該当します。

SORTTYPEは、検索時に使用するリクエストの追加情報や、結果のソート方法を指定する際に使用します。たとえば、「おすすめの映画を見せて」という発話の場合、Alexaはコンテンツプロバイダーからのおすすめコンテンツを取得する必要があります。SORTTYPEには、次の列挙値を設定できます。

  • RECOMMENDED: 「おすすめの映画を見せて」や「おすすめのアクション映画を見せて」といった発話の場合、この値が設定されます。

例: MEDIATYPEVIDEOACTORGENREFRANCHISESEASONEPISODE

文字列
value
(必須)

エンティティの値。チャンネルの場合は、チャンネル名。

例: インターステラーPBS

文字列
itemType

itemTypeは、検索するアイテムのタイプを指定します。itemTypeは、ランディングページテンプレートに関連したGetDisplayableItemsディレクティブに固有です。ユーザーが(「アレクサ、ACMEのビデオを開いて」と言うか、「ビデオホーム」と言った後でビデオスキルを選択することで)ランディングページを開くと、次の2つのGetDisplayableItemsディレクティブがAlexaから送信されます。

  • 1つ目のGetDisplayableItemsディレクティブは、ランディングページのカテゴリーを取得するためのものです。itemTypeプロパティはCATEGORYで、sortTypeRECOMMENDEDに設定されています。
  • 2つ目のGetDisplayableItemsディレクティブは、ランディングページの注目ビデオを取得するためのものです。1つ目のディレクティブとは異なり、このリクエストではitemTypeVIDEOに設定されています。

Alexaは両方のディレクティブに対するレスポンス(GetDisplayableItemsResponse)を受信したら、カテゴリーIDとビデオIDを組み合わせたリストと共に、GetDisplayableItemsMetadata呼び出しを1回送信します。レスポンスには、カテゴリーとビデオに関するメタデータが含まれます。

例: VIDEOCATEGORY

列挙型
externalIds

このエンティティの外部識別子のマップ。keyはプロバイダー、valueidです。

例:key = gracenote(またはgti)、value = SH000000012

オブジェクト
Gracenote

外部Gracenote ID。

例: ST0000000666661

文字列
contentType

ContentTypeは、検索結果で返されたビデオのコンテンツタイプを示します。録画された映画やテレビ番組を送信する場合、contentTypeRECORDINGに設定されます。ライブのテレビ番組に関する情報が結果に含まれる場合、contentTypeLIVEに設定されます。オンデマンドのコンテンツが結果に含まれる場合、contentTypeON_DEMANDに設定されます。

ContentTypeは、ユーザーにプロンプトを提供する際にも使用されます。たとえば、contentTypeLIVEの場合、「CBSで現在放送中のアカデミー賞はこちらです」などのプロンプトがAlexaから提供されます。 contentTypeRECORDINGの場合は、「アカデミー賞はこちらです」などのプロンプトが提供されます。

例: RECORDINGLIVEON_DEMAND

列挙型
locale
(必須)

ユーザーのロケール。検索結果に対応する表示可能な情報を取得するために必要となります。ロケールの形式は、Network Working Groupの「Best Current Practice 47(BCP-47)」(英語のみ)で規定されている言語の形式と同じです。認識されないロケールを受信した場合は、デフォルトでen-USになります。

例:en-USen-GBde-DE

文字列
minResultLimit
(必須)

この呼び出しで返す結果で、pageTokenの考慮が必要となる最小件数。(次の結果を取得するために使用する)pageTokenと共に返したアイテムの件数がminResultLimitフィールドよりも少ない場合、AlexaはpageTokenを考慮して新しいアイテムを取得するのではなく、受信したアイテムをそのまま表示します。

次の結果を取得するためにpageTokenが考慮されるのは、アイテムの件数がminResultLimitの値以上である場合のみです。ただし、アイテムの件数がminResultLimitを超える場合は、maxResultLimitが上限となります。アイテムの件数がmaxResultLimitを超えると、maxResultLimitを超えたアイテムはAlexaによって破棄されます。

例: 8

整数
maxResultLimit
(必須)

返す結果の最大件数(上限)。詳細については、minResultLimitフィールドの説明を参照してください。

例: 25

整数
timeWindow

リクエストされた処理の開始時刻と終了時刻を指定します。これは通常、ライブTVや録画にのみ使用され、オンデマンドコンテンツには使用されません。一般的に、タイムウィンドウが指定されており、それを使用して結果をフィルタリングできる場合は、タイムウィンドウを使用する必要があります。

検索対象がオンデマンドコンテンツのみとなるプロバイダーの場合は、タイムウィンドウフィールドが通常nullに設定されているため、無視して構いません。

ライブTVや録画でユーザーがタイムウィンドウを指定する場合(「午後4時から5時のテレビ番組を検索して」や「先週録画したテレビ番組を探して」など)、開始時刻と終了時刻が指定されていれば、それらを使用して結果をフィルタリングする必要があります。

機能によって、startendの両方のフィールドが存在する場合と、どちらか一方のフィールドしか存在しない場合とがあります。たとえば、「午後4時から5時のテレビ番組を検索して」の場合は両方のフィールドが存在しますが、「午後5時に始まるテレビ番組を見せて」の場合、設定されるのはstartフィールドだけで、endフィールドはnullになります。

startendの時間を含むオブジェクト
end

タイムウィンドウの終了時刻です。

例: 2016-09-07T23:59:00+00:002018-01-24T02:30:00Z

ISO 8601形式の文字列
start

タイムウィンドウの開始時刻です。

例: 2016-09-07T23:59:00+00:002018-01-24T02:30:00Z

ISO 8601形式の文字列

レスポンスの例

GetDisplayableItemsディレクティブを受信したら、LambdaからGetDisplayableItemsResponseを送信する必要があります。レスポンスには、デバイスに表示するアイテムのid値のリストを含める必要があります。

LambdaからAlexaに返すGetDisplayableItemsResponseの例を次に示します。

{
"directive": {
        "header": {
            "correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/jCc8ptlAKulUj90jSqg==",
            "messageId": "5f0a0546-caad-416f-a617-80cf083a05cd",
            "name": "GetDisplayableItemsResponse",
            "namespace": "Alexa.VideoContentProvider",
            "payloadVersion": "3"
        },
        "payload": {
            "nextToken": "fvkjbr20dvjbkwOpqStr",
            "mediaItems": [{
                    "mediaIdentifier": {
                        "id": "tt1254207"
                    }
                },
                {
                    "mediaIdentifier": {
                        "id": "tt0807840"
                    }
                },
                {
                    "mediaIdentifier": {
                        "id": "tt7993892"
                    }
                },
                {
                    "mediaIdentifier": {
                        "id": "tt4957236"
                    }
                },
                {
                    "mediaIdentifier": {
                        "id": "tt2285752"
                    }
                }
            ]
        }
    }
};

ペイロードの説明

GetDisplayableItemsResponsepayloadフィールドについて、次の表で説明します。

ペイロードの説明
フィールド 説明 データ型
nextToken

次の結果セットを取得するためのトークン。プロバイダーから送信される不透明型の文字列であり、後続の検索リクエストで返されます。

文字列
mediaItems
(必須)

検索結果として画面に表示されるビデオのmediaIdentifiersのリスト。

リスト
mediaIdentifier
(必須)

mediaItemの識別子。

オブジェクト
id
(必須)

ビデオアイテムの識別子。後続のGetDisplayableItemsMetadataまたはGetPlayableItemsMetadataの呼び出しで、表示または再生に関連したメタデータ情報を取得する目的で使用されます。この識別子は、Alexaからは認識できず、メタデータ情報を照会する際にそのまま使用されます。

文字列

このインターフェイスの機能サポートの宣言

ビデオスキルがAlexa.RemoteVideoPlayerインターフェイスをサポートしていることを示すには、Alexa.Discoveryインターフェイスを介して送信されたDiscoverディレクティブへのレスポンスで、そのサポートを明示する必要があります。詳細については、Discoveryディレクティブを参照してください。