?
サポート

Notifications インターフェース



概要

Notificationsインターフェースを使用すると、AVSからユーザーに、Alexaドメインや有効化されたAlexaスキルで新しいコンテンツが利用可能であることを通知することができます。このインターフェースでは、具体的には、クライアントにユーザーに対してビジュアルおよびオーディオのインジケーターをレンダリングしたり、クリアしたりするよう指示する2つのディレクティブが提供されます。

このインターフェースは、通知の内容は提供しません。ユーザーに新しいコンテンツが利用可能であることを知らせるオーディオおよびビジュアルのインジケーターのみを提供します。たとえば、新しい通知が来ると、黄色いLEDを点滅させ、ユーザーが「Alexa、何か来てる?」または「Alexa、何かお知らせはある?」と尋ねた時、オーディオファイルを再生することができます。

フローと配信、おやすみモード設定、UXの考慮事項については、Notificationsの概要を参照してください。

SetIndicatorディレクティブ

このディレクティブは、通知を受け取ると、クライアントにビジュアルおよびオーディオのインジケーターをレンダリングするよう指示します。クライアントは短期間の間に、複数のSetIndicatorディレクティブを受信する場合があります。ディレクティブが重なった場合、以下のルールを考慮します。

  • 現在のディレクティブのassetIdが、受信中のディレクティブのassetId と一致する場合は、アセットを再生しないでください。
  • 現在のディレクティブのassetIdが、受信中のディレクティブのassetIdと一致しない場合は、現在のアセットの再生を完了したに受信中のディレクティブのアセットを再生してください。

サンプルメッセージ

{
    "directive": {
        "header": {
            "namespace": "Notifications",
            "name": "SetIndicator",
            "messageId": "{{STRING}}"
        },
        "payload": {
            "persistVisualIndicator": {{BOOLEAN}},
            "playAudioIndicator": {{BOOLEAN}},
            "asset": {
                "assetId": "{{STRING}}",
                "url": "{{STRING}}"
            }
        }
    }
}

ヘッダーのパラメーター

パラメーター 説明
messageId 特定のメッセージを表すのに使用される一意のID。 string

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

パラメーター 説明
persistVisualIndicator 通知が配信されたときに、製品が継続的にビジュアルインジケーター(該当する場合)を表示する必要があることを示します。例: persistVisualIndicatortrueの場合、製品は通知の配信後にインジケーターを継続的に表示する必要があります。ただし、persistVisualIndicatorfalseの場合、最初の通知が配信された後にビジュアルインジケーターを表示する必要はありません。 ブール値
playAudioIndicator 通知が配信されたときに、製品がオーディオインジケーターを再生する必要があることを示します。 ブール値
asset playAudioIndicatortrueの場合に再生する必要のあるオーディオアセットについての情報が含まれます。 object
asset.assetId アセットの一意の識別子です。 string
asset.url アセットのURLです。製品は、アセットをダウンロードしてキャッシュすると想定されます。製品がオフラインの場合、またはアセットを利用できない場合、製品はデフォルトの通知を再生する必要があります。 string

ClearIndicatorディレクティブ

このディレクティブは、クライアントにすべてのアクティブなビジュアルおよびオーディオのインジケーターをクリアするよう指示します。

  • このディレクティブを受信したときにオーディオインジケーターを再生中の場合、すぐに再生を停止する必要があります。
  • このディレクティブを受信したときにビジュアルインジケーターが設定されている場合、すぐにクリアする必要があります。

サンプルメッセージ

{
    "directive": {
        "header": {
            "namespace": "Notifications",
            "name": "ClearIndicator",
            "messageId": "{{STRING}}"
        },
        "payload": {
        }
    }
}

ヘッダーのパラメーター

パラメーター 説明
messageId 特定のメッセージを表すのに使用される一意のID。 string

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

このディレクティブのペイロードは空です。

その他のインターフェース

このドキュメントの最初に戻り、右側のサイドバーから、その他のインターフェースを参照してください。

リソース