Alexa Smart Properties in Senior Livingのイベントスキーマ

Note: Sign in to the developer console to build or publish your skill.

注：この機能は、Alexa Smart Properties for Healthcare、Alexa Smart Properties in Senior Living、Alexa Smart Properties Coreでのみ利用できます。

Alexa Smart Propertiesを使用すると、Alexaイベントに関する通知を受信できます。イベントはAmazon Simple Notification Service（SNS）にパブリッシュされます。

イベントのセットアップ方法の詳細については、Alexa Smart Properties in Senior Livingのイベントを受信するを参照してください。

イベントのタイプ

次の表に、通知を受信するためのサブスクリプションを行うことのできるAlexa Smart Propertiesイベントを示します。

イベント名	説明	スキーマ
`Alexa.Automation.Execution.Completion`	オートメーションシーケンスの実行が完了しました。すべてのアクションが正常に呼び出されて実行されたか、エラーが発生しました。	オートメーション実行完了イベント
`Alexa.Skill.Interaction.Failure`	スキルがタイムアウトしたか、スキルが無効な応答を返しました。	スキル対話エラーイベント
`Alexa.Enterprise.Subscription.Activation`	ユニットのエンタープライズサブスクリプションが有効化されました。	エンタープライズサブスクリプション有効化

オートメーション実行完了イベント

以下の例は、オートメーション実行完了イベントです。

{
   "header":{
      "version":"2.0",
      "eventId":{
         "id":"12345-6789-1011-abcd-example"
      },
      "eventType":{
         "namespace":"Alexa.Automation.Execution",
         "name":"Completion"
      },
      "eventTime":{
         "timestamp":"2017-09-20T12:04:03Z"
      },
      "entities": {
         "unit":{
            "type":"Unit",
            "id":"amzn1.alexa.unit.did.12345"
         }
      }
   },
   "payload":{
      "automation":{
         "id":"amzn1.alexa.automation.12345"
      },
      "result": {
        "status": "FAILURE",
      	"errors":[
         {
            "type":"ENDPOINT_NOT_FOUND",
            "message":"Endpoint used in the automation was not found",
            "id":"amzn1.alexa.endpoint.12345"
         }
       ]
     }
   }
}

Headerパラメーター

パラメーター	説明	型	必須
`header.version`	スキーマバージョン。`2.0`です。	文字列	◯
`header.eventId`	イベントIDが指定されたオブジェクト。	オブジェクト	◯
`header.eventId.id`	イベントを表す一意のID。	文字列	◯
`header.eventType`	イベントの名前と名前空間が指定されたオブジェクト。	オブジェクト	◯
`header.eventType.namespace`	イベントが属するカテゴリー。オートメーション関連のイベントはすべて同じ名前空間を使用します。例： `Alexa.Automation.Execution`	文字列	◯
`header.eventType.name`	名前空間内のイベント名。例： `Completion`	文字列	◯
`eventTime`	イベントの時刻が指定されたオブジェクト。	オブジェクト	◯
`eventTime.timestamp`	イベント作成時刻。"YYYY-MM-DDThh:mm:ssZ"形式（ISO 8601のRFC 3339プロファイル）です。	DateTime	◯
`entities`	エンティティのリスト。詳細については、ユニットエンティティを参照してください。	配列	◯

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

パラメーター	説明	型	必須
`payload.automation`	イベントの生成元であるオートメーションの詳細。	オブジェクト	◯
`payload.automation.id`	イベントの生成元であるオートメーションインスタンスの一意のID。	文字列	◯
`payload.result`	オートメーションの結果に関する詳細。	オブジェクト	◯
`payload.result.status`	オートメーションの実行開始または完了のステータス。有効な値は次のとおりです。 • `SUCCESS`：オートメーションがトリガーされ、正常に完了しました。 • `FAILURE`：オートメーションのトリガーまたは完了に失敗しました。	列挙型文字列	◯
`payload.result.errors`	オートメーションの開始または完了で発生したエラー。	配列	✕
`payload.result.errors[*].type`	エラータイプ。有効な値は次のとおりです。 • `ENDPOINT_NOT_FOUND`：オートメーションで使用されるエンドポイントが見つかりませんでした。 • `INTERNAL_SERVER_ERROR`：内部サーバーエラーです。	文字列	✕
`payload.result.errors[*].message`	エラーを記述するメッセージ。	文字列	✕
`payload.result.errors[*].id`	エンドポイントID。例：`amzn1.alexa.endpoint.12345`	文字列	✕

スキル対話エラーイベント

以下の例は、スキルからの無効な応答またはスキルエンドポイントのタイムアウトが原因のスキルエラーイベントを報告するスキル対話イベントです。

{
   "header":{
      "version":"2.0",     
      "eventId":{
         "id":"12345-6789-1011-abcd-example"
      },
      "eventType":{
         "namespace":"Alexa.Skill.Interaction",
         "name":"Failure"
      },
      "eventTime":{
         "timestamp":"2017-09-20T12:04:03Z"
      },
      "entities": {
         "unit":{
            "type":"Unit",
            "id":"amzn1.alexa.unit.did.12345"
         },
         "skill":{
            "type":"Skill",
            "id":"amzn1.ask.skill.12345"
         }         
      }
   },
   "payload":{
      "interaction":{
         "type":"IntentRequest",
         "locale":"en-US",
         "intent":{
            "name":"intentName"
         },
      },
      "skill":{
         "id":"amzn1.ask.skill.12345",
         "stage":"live"
      },
      "unit":{
         "id":"amzn1.alexa.unit.did.12345"
      },
      "session":{
         "id":"amzn1.echo-api.session.12345"
      },
      "requestId":"amzn1.echo-api.request.12345",
      "error":{
         "type":"INVALID_RESPONSE",
         "message":"Details about the error"
      }
   }
}

Headerパラメーター

パラメーター	説明	型	必須
`header.version`	スキーマバージョン。`2.0`です。	文字列	◯
`header.eventId`	イベントIDが指定されたオブジェクト。	オブジェクト	◯
`header.eventId.id`	イベントを表す一意のID。	文字列	◯
`header.eventType`	イベントの名前と名前空間が指定されたオブジェクト。	オブジェクト	◯
`header.eventType.namespace`	イベントが属するカテゴリー。スキル対話関連のイベントはすべて同じ名前空間を使用します。例： `Alexa.Skill.Interaction`	文字列	◯
`header.eventType.name`	名前空間内のイベント名。例： `Failure`	文字列	◯
`eventTime`	イベントの時刻が指定されたオブジェクト。	オブジェクト	◯
`eventTime.timestamp`	イベント作成時刻。"YYYY-MM-DDThh:mm:ssZ"形式（ISO 8601のRFC 3339プロファイル）です。	DateTime	◯
`entities`	エンティティのリスト。詳細については、ユニットエンティティとスキルエンティティを参照してください。	配列	◯

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

パラメーター	説明	型	必須
`payload.interaction`	エラーが見られたスキル対話のタイプを記述するオブジェクト。	オブジェクト	◯
`payload.interaction.type`	エラーが見られたスキル対話のタイプ。有効な値： `IntentRequest`	列挙型文字列	◯
`payload.interaction.locale`	ユーザーのロケール。例：`en-US`	文字列	◯
`payload.interaction.intent`	ユーザーの音声によるリクエストを満たすアクションを示すオブジェクト。	オブジェクト	✕
`payload.interaction.intent.name`	ユーザーがリクエストしたアクションに対応するインテントの名前。例： `AMAZON.CancelIntent`	文字列	✕
`payload.skill`	イベントに関連するスキルを表すオブジェクト。	オブジェクト	◯
`payload.skill.id`	スキルの一意のID。例：`amzn1.ask.skill.12345`	文字列	◯
`payload.skill.stage`	スキルのステージ。有効な値：`development`、`live`、`certification`	文字列	◯
`payload.unit`	ユーザーIDが指定されたオブジェクト。	オブジェクト	◯
`payload.unit.id`	ユニットを一意に指定するユニットID。	文字列	◯
`payload.session`	スキルセッションを一意に特定するIDが指定されたオブジェクト。	オブジェクト	◯
`payload.session.id`	スキルセッションを一意に指定するID。例：`amzn1.echo-api.session.12345`。この値は、スキルへの最初のリクエストがスキルに達しなかった場合などに、それまで見られたことのないセッションIDであることがあります。	文字列	◯
`payload.requestId`	Alexaユーザーリクエストとそのリクエストへの応答を一意に特定するID。例：`amzn1.echo-api.request.12345-678910-abcdefg`	文字列	◯
`payload.error`	ユーザーによるスキルへのリクエストの結果に関する追加情報が指定されたオブジェクト。	オブジェクト	◯
`payload.error.type`	エラーのタイプ。有効な値は次のとおりです。 • `INVALID_RESPONSE`： Alexaがスキル応答を理解できなかった場合（スキル応答のSSML形式が無効など）、またはAlexaが何らかの理由でエンドポイントを呼び出せない場合（エンドポイントの設定が間違っている、必要な権限がAlexaにないなど）に発生します。 • `ENDPOINT_TIMEOUT`： Alexaが応答を時間内に取得しませんでした。	列挙型文字列	◯
`payload.error.message`	エラーの説明。エラーのタイプを使用し、エラーに関するメッセージに依存しないようにしてください。メッセージはログ記録を目的としてのみ使用されます。	文字列	◯

エンタープライズサブスクリプション有効化イベント

以下の例は、エンタープライズサブスクリプション有効化イベントです。

{
   "header":{
      "version":"2.0",     
      "eventId":{
         "id":"12345-6789-1011-abcd-example"
      },
      "eventType":{
         "namespace":"Alexa.Enterprise.Subscription",
         "name":"Activation"
      },
      "eventTime":{
         "timestamp":"2017-09-20T12:04:03Z"
      },
      "entities": {
         "unit":{
            "type":"Unit",
            "id":"amzn1.alexa.unit.did.12345",
            "parent": {
               "type":"Unit",
               "id":"amzn1.alexa.unit.did.12345"
            }
         }
      }
   },
   "payload":{        
      "subscription": {
         "id": "amzn1.ask.skill.12345"
      },
      "result": {
         "status": "SUCCEEDED",
         "error": {
            "type": "INTERNAL_SERVER_ERROR",
            "message": "Details about the error"
         }
      }    
   }
}

Headerパラメーター

パラメーター	説明	型	必須
`header.version`	スキーマバージョン。`2.0`です。	文字列	◯
`header.eventId`	イベントIDが指定されたオブジェクト。	オブジェクト	◯
`header.eventId.id`	イベントを表す一意のID。	文字列	◯
`header.eventType`	イベントの名前と名前空間が指定されたオブジェクト。	オブジェクト	◯
`header.eventType.namespace`	イベントが属するカテゴリー。エンタープライズサブスクリプション関連のイベントはすべて同じ名前空間を使用します。例： `Alexa.Enterprise.Subscription`	文字列	◯
`header.eventType.name`	名前空間内のイベント名。例： `Activation`	文字列	◯
`eventTime`	イベントの時刻が指定されたオブジェクト。	オブジェクト	◯
`eventTime.timestamp`	イベント作成時刻。"YYYY-MM-DDThh:mm:ssZ"形式（ISO 8601のRFC 3339プロファイル）です。	DateTime	◯
`entities`	エンティティのリスト。詳細については、ユニットエンティティを参照してください。	配列	◯

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

パラメーター	説明	型	必須
`payload.subscription`	イベントが生成されたサブスクリプションの詳細。	オブジェクト	◯
`payload.subscription.id`	サブスクリプションのID。	列挙型文字列	◯
`payload.result`	サブスクリプション有効化の結果。	オブジェクト	◯
`payload.result.status`	サブスクリプション有効化のステータス。	列挙型文字列	◯
`payload.result.error`	サブスクリプション有効化で発生したエラー。有効化が成功した場合、このオブジェクトは存在しません。	オブジェクト	✕
`payload.error.type`	エラーのタイプ。有効な値は次のとおりです。 • `INTERNAL_SERVER_ERROR`：有効化ワークフローがタイムアウトしたか、実行に失敗しました。	列挙型文字列	◯
`payload.error.message`	エラーの説明。エラーのタイプを使用し、エラーに関するメッセージに依存しないようにしてください。メッセージはログ記録を目的としてのみ使用されます。	文字列	◯

エンティティ

イベントのヘッダーに含めることができるエンティティは以下のとおりです。

ユニットエンティティ

パラメーター	説明	型	必須
`unit`	ユニットの詳細を表すオブジェクト。	オブジェクト	◯
`unit.type`	ユニットのエンティティタイプ。有効な値： `Unit`	列挙型文字列	◯
`unit.id`	ユニットID。	文字列	◯
`unit.parent`	親ユニット。親IDを指定します。	オブジェクト	◯
`unit.parent.type`	親のエンティティタイプ。有効な値： `Unit`	列挙型文字列	◯
`unit.parent.id`	親のID。	文字列	◯

スキルエンティティ

パラメーター	説明	型	必須
`skill`	スキルの詳細を表すオブジェクト。	オブジェクト	◯
`skill.type`	スキルのエンティティタイプ。有効な値： `Skill`	列挙型文字列	◯
`skill.id`	スキルID。	文字列	◯

最終更新日: 2023 年 03 月 06 日

Alexa Smart Properties in Senior Livingのイベントスキーマ

イベントのタイプ

オートメーション実行完了イベント

Headerパラメーター

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

スキル対話エラーイベント

Headerパラメーター

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

エンタープライズサブスクリプション有効化イベント

Headerパラメーター

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

エンティティ

ユニットエンティティ

スキルエンティティ

関連トピック