Settingsインターフェース(v1.0)

Settingsインターフェースは、ロケールなど、製品上でAlexa設定を管理するために使用します。

機能API

Settingsインターフェースのバージョン1.0を使用するには、機能APIの呼び出し内で宣言する必要があります。詳細については、機能APIを参照してください。

{
    "type": "AlexaInterface",
    "interface": "Settings",
    "version": "1.0"
}

SettingsUpdatedイベント

Alexaの設定が製品のコントロールやコンパニオンアプリを使用して変更されると、SettingsUpdatedイベントが送信される必要があります。たとえば、ユーザーがコンパニオンアプリを使用して、ロケール設定を米国(en-US)からドイツ(de-DE)に変更したとします。設定が変更されると、クライアントは、SettingsUpdatedイベントによってAlexaに変更を通知する必要があります。

サンプルメッセージ

{
    "event": {
        "header": {
            "namespace": "Settings",
            "name": "SettingsUpdated",
            "messageId": "{{STRING}}"
        },
        "payload": {
            "settings": [
                {
                    "key": "{{STRING}}",
                    "value": "{{STRING}}"
                }
            ]
        }
    }
}

ヘッダーのパラメーター

パラメーター 説明
messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列

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

パラメーター 説明
settings 製品のAlexa設定のリスト。リストの各アイテムは、キー/値ペアのオブジェクトです。 リスト
key キーを識別します。後述の表を使用して、受け入れられるキーを指定します。 文字列
value キーの値を識別します。後述の表を使用して、各キーの受け入れられる値を指定します。 文字列

受け入れられるキー/値のペア

受け入れられるキー 受け入れられる値
locale en-AUen-CAen-GBen-INen-USde-DEja-JP