Alexa.Launcherインターフェース



Alexa.Launcherインターフェース

Alexa.Launcherインターフェースは、起動のためのディレクティブを提供します。

ターゲットを起動するディレクティブには、あらかじめ定義された起動ターゲットのリストにある名前とIDが含まれます。起動ターゲットのリストを見直して、スキルの機能をサポートする項目を、スキルが正しく解決できることを確認してください。

Launcherインターフェースでサポートされているロケールについては、機能インターフェースの一覧を参照してください。

ディレクティブ

LaunchTarget

指定したアプリケーションまたはショートカットを起動するリクエストです。ユーザーが指定したアプリケーションまたはショートカットが、あらかじめ定義された起動ターゲットのリストにあるIDと照合されます。名前とIDはリクエスト内で送信されます。

ユーザー: アレクサ、Amazon Videoを起動して

例: Amazon Videoの起動

{
    "directive": {
        "endpoint": {
              "scope": {
                "type": "BearerToken",
                "token": "some-access-token"
              },
              "endpointId": "endpoint-001",
              "cookie": {}
            },
        },
        "header": {
            "correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/jCc8pt90jSqg==",
            "messageId": "abc-123-def-456",
            "name": "LaunchTarget",
            "namespace": "Alexa.Launcher",
            "payloadVersion": "3"
        },
        "payload": {
            "identifier": "amzn1.alexa-ask-target.app.72095",
            "name": "Amazon Video"
        }
    }
}

ペイロードの詳細

プロパティ 説明 タイプ 必須
identifier 起動する項目のIDです。アプリケーションIDにはapp、ショートカットIDにはshortcutが含まれます。すべてのIDのリストについては、起動ターゲットのリファレンスを参照してください。 文字列
name IDに関連付けられた名前です。 文字列

イベントとプロパティ

出力可能なプロパティ

プロパティ名 タイプ 説明
target ターゲット 起動されるアプリまたはショートカットです。

応答

正常にLaunchTargetディレクティブが処理されると、応答を送信します。

応答の例

以下は、応答メッセージの例です。メッセージの内容にtargetプロパティの値を出力します。

{
    "context": {
        "properties": [
            {
                "name": "target",
                "namespace": "Alexa.Launcher",
                "timeOfSample": "2017-5-6T16:20:50.52Z",
                "uncertaintyInMilliseconds": 0,
                "value": {
                    "identifier": "amzn1.alexa-ask-target.app.72095",
                    "name": "Amazon Video"
                }
            }
        ]
    },
    "event": {
        "header": {
            "correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/jCc8pt90jSqg==",
            "messageId": "abc-123-def-456",
            "name": "Response",
            "namespace": "Alexa",
            "payloadVersion": "3"
        },
        "payload": {}
    }
}

ErrorResponse

何らかの理由によりユーザーのリクエストを完了できない場合、エラー応答を返す必要があります。

  • ビデオ固有のエラーについては、Video.ErrorResponseを参照してください。
  • 認証や接続の問題など、一般的なエラーについては、Error.Responseを参照してください。