名前付きのタイマーとリマインダーを有効化する方法

• 概要
• 名前付きのタイマーとリマインダーを準備する方法
• リマインダーを有効にする方法
• Interaction Model
• リマインダーの例
• SetAlertディレクティブ
• リソース

概要

SetAlertディレクティブは、名前付きのタイマーとリマインダーをサポートするよう拡張されたものです。この変更により、Alexaがオーディオファイルと読み上げテキスト（TTS）を連続再生する指示とともに、クライアントにパラメーターを送信することができるようになります。

アセットは、順不同のセット（assets）としてディレクティブのペイロード内でクライアントに配信されます。各アセットには、assetIdとurlが含まれます。これらのアセットはダウンロードされ、ユーザーに対してscheduledTimeに配信できるようキャッシュされる必要があります。ペイロードには再生順序（assetPlayOrder）、アセットのシーケンスを再生する回数（loopCount）、ループ間の一時停止時間（loopPauseInMilliSeconds）に関する指示が含まれます。

クライアントは、該当する場合（たとえばリマインダーがローカルでセットされているときはSetAlertSucceeded、ユーザーが鳴っているリマインダーを停止したときはAlertStoppedなど）に、すべてのライフサイクルイベントを送信することが想定されています。完全な仕様については、Alertsインターフェースを参照してください。

クライアントコードをアップデートした後に、ユーザーが名前付きのタイマーやリマインダーをセットする方法の例はこちらです。

• 「Alexa, set a cooking timer for 10 minutes.」
• 「Alexa, set a reminder to call mom at 2 P.M. on Saturday.」
• 「Alexa, remind me to take out the trash on Tuesday at 8 A.M.」

名前付きのタイマーとリマインダーを準備する方法

1. 以下の新しいペイロードのパラメーターをサポートするようにクライアントコードをアップデートします。
   • assets
     • assetId
     • url
   • assetPlayOrder
   • backgroundAlertAsset
   • loopCount
   • loopPauseInMilliSeconds
2. typeのREMINDERの値をサポートするようにクライアントコードをアップデートします。
3. クライアントがAVSから送信されたアセットをダウンロードしてキャッシュし、ユーザーに対してscheduledTimeに配信できるようにしてください。
4. 製品がアラートについてに記載されているベストプラクティスに従っていることを確認します。

リマインダーを有効にする方法

リマインダーの受信を開始するには、AVS開発者コンソールでデバイスの機能を有効にする必要があります。

1. ここをクリックしてログインします。
2. 新しい製品を作成するか、既存製品を編集します。
3. 「Device Capabilities」をクリックして「Named Timers and Reminders」を選択します。

Interaction Model

このアップデートは、AVS対話モデルには影響しませんが、ユーザーにアセットをいつ、どのように配信すべきかを理解することが重要です。

• Dialogチャネルがアクティブで、assetsオブジェクトを含むSetAlertディレクティブを受信した場合、クライアントはDialogチャネルがアクティブな間、ローカルに保存されたオーディオファイルを短いアラートモードで再生する必要があります。

• Dialogチャネルが非アクティブで、assetsオブジェクトを含むSetAlertディレクティブを受信した場合、クライアントはassetPlayOrderのるassetsを再生する必要があります。

リマインダーの例

この例は、リマインダーをサポートするようにSetAlertディレクティブが拡張された方法を示しています。

クリックして拡大 +

{
    "directive": {
        "header": {
            "namespace": "Alerts",
            "name": "SetAlert",
            "messageId": "alpha-num3ric-str1ng-h3r3",
            "dialogRequestId": "str1n6-h3r3"
        },
        "payload": {
            "token": "375ffbb1-d746-36ed-83d6-da71b17c4355",
            // Provides the alert type, in this case a REMINDER.
            "type": "REMINDER",
            "scheduledTime": "2017-04-18T20:00:00.000-07:00",
            // An unordered set of assets your client is expected to play
            // at the scheduledTime.
            "assets": [
                {
                    // Text-to-speech
                    "assetId": "d4bc19e8-7e26-3f33-b921-57bed8c77478",
                    "url": "https://example.com/resource_1.mp3"
                },
                {
                    // Audio cue
                    "assetId": "c4bc19e8-7e26-3f33-b921-57bed8c77891",
                    "url": "https://example.com/resource_2.mp3"
                },
                {
                    // backgroundAlertAsset
                    "assetId": "ffcc7012-dec2-312d-b02c-a8c39b2cdc2a",
                    "url": "https://example.com/resource_3.mp3"
                },
            ],
            // The order that the assets included in the assets object
            // must be played. Notice, in this example, the second object
            // which is the audio cue, is played first, followed by the
            // TTS.
            "assetPlayOrder": ["c4bc19e8-7e26-3f33-b921-57bed8c77891", "d4bc19e8-7e26-3f33-b921-57bed8c77478"],
            // The asset your product must use when the Alerts channel is
            // in the background.
            "backgroundAlertAsset": "ffcc7012-dec2-312d-b02c-a8c39b2cdc2a",
            // Instructs the client to loop through the assetPlayOrder 2 times.
            "loopCount": 2,
            // Instructs the client to wait 6000 ms between loops.
            "loopPauseInMilliSeconds": 6000
        }
    }
}

SetAlertディレクティブ

このディレクティブはクライアントに、特定の時間または時刻のタイマー、アラーム、リマインダーをセットするよう指示します。クライアントは、アラートをセットする音声リクエストの結果として、またはAmazon Alexaアプリを使用して以前にセットされていたアラートが再度有効化されたときに、SetAlertディレクティブを受信することがあります。

{
    "directive": {
        "header": {
            "namespace": "Alerts",
            "name": "SetAlert",
            "messageId": "{{STRING}}",
            "dialogRequestId": "{{STRING}}"
        },
        "payload": {
            "token": "{{STRING}}",
            "type": "{{STRING}}",
            "scheduledTime": "{{STRING}}",
            "assets": [
                {
                    "assetId": "{{ASSET_ID}}",
                    "url": "{{STRING}}"
                },
                {
                    "assetId": "{{STRING}}",
                    "url": "{{STRING}}"
                }
            ],
            "assetPlayOrder": ["{{STRING}}", "{{STRING}}", ... ],
            "backgroundAlertAsset": "{{STRING}}",
            "loopCount": {{LONG}},
            "loopPauseInMilliSeconds": {{LONG}}
       }
    }
}

ヘッダーのパラメーター

ペイロードのパラメーター

リソース

• 機能設計ガイド
• AVS APIの概要
• フォーラムとナレッジベース