あなたのAlexaコンソール
?
サポート

Settings インターフェース



概要

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

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。 string

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

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

受け入れ可能なキー/値のペア

受け入れ可能なキー 受け入れ可能な値
locale en-USen-GBen-IN, de-DE, ja-JP

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

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

リソース