定型アクショントリガーのサービスプロバイダーインターフェース

定型アクショントリガーのサービスプロバイダーインターフェース

UNICAST配信では、トリガーパラメーターに一意の受信者を指定します。トリガー定義に配信タイプとしてUNICASTを指定した場合、ユーザーからの定型アクション作成/削除リクエストを処理するために、Alexaスキルに定型アクショントリガーのサービスプロバイダーインターフェース（SPI）を実装する必要があります。ユーザーがカスタムトリガーを使用して定型アクションを設定すると、Alexaはスキルにコールバックリクエストを送信し、スキルはここれに応答する必要があります。

リクエストと応答

次の表は、定型アクショントリガーのSPIで実行できる操作の一覧です。

操作 説明

Routines.Trigger.Create

ユーザーがカスタムトリガーを使用して定型アクションを設定すると、 AlexaはRoutines.Trigger.Createイベントをスキルに送信します。

Routines.Trigger.Delete

ユーザーがカスタムトリガーを含む定型アクションを削除すると、AlexaはRoutines.Trigger.Deleteイベントをスキルに送信します。

トリガーリクエスト

ユーザーがカスタムトリガーを使用して定型アクションを作成するか、定型アクションギャラリーからカスタムトリガーを含む定型アクションを選択して有効にすると、Alexaは次のJSONペイロードを含むイベントをAlexaスキルに送信します。

カスタムトリガーを使用した定型アクションをユーザーが削除、または定型アクションギャラリーから無効にすると、Alexaは次のJSONペイロードを含むイベントをスキルに送信します。

リクエストのパラメーター

以下の表はリクエストのパラメーターの一覧です。

プロパティ 説明 型 必須

request

ユーザーからのトリガーリクエストの詳細。

オブジェクト

◯

timestamp

Alexaがリクエストを送信した日時。ISO 8601形式（YYYY-MM-DDThh:mm:ssZ）。

文字列

◯

requestId

特定のリクエストの一意のIDです。

文字列

◯

type

定型アクションリクエストのタイプ。指定できる値は、 Routines.Trigger.CreateまたはRoutines.Trigger.Deleteです。

文字列

◯

trigger

ユーザーが作成または削除したトリガーの情報。

オブジェクト

◯

trigger.name

トリガー定義に定義されているトリガー名。

文字列

◯

trigger.parameters

トリガーの設定中に受け取った入力。トリガーの登録時に定義されたトリガーパラメーターです。Alexaはトリガーの詳細ページからユーザーのトリガー設定を収集し、パラメーターとしてスキルに渡します。トリガー登録の詳細については、「定型アクションのカスタムトリガーを作成する手順」のステップ2.3 スキルを開発環境にデプロイし、トリガー定義を送信して登録するを参照してください。

オブジェクト

◯

recipient

トリガーを設定した受信者の情報。

オブジェクト

◯

recipient.type

イベント受信者の値のタイプ。本リリースで指定可能な値はUSERです。つまり、受信者はユーザーで、ユニットや他のエンティティではありません。

文字列

◯

recipient.value

イベントの受信者を表すオブジェクト。タイプがUSER の場合、受信者のIDを表すオブジェクトを指定します。

オブジェクト

◯

recipient.value.id

スキルを有効にしているAmazonアカウントを一意に識別する文字列。形式はamzn1.ask.account.<unique-ID>です。

文字列

◯

recipient.scope

このパラメーターは、ユーザーがAlexaスキルにリンクされたアカウントを保有している場合に使用し、アクセストークンなどのユーザーのアカウントリンク情報を指定します。アカウントリンクの詳細については、Alexaスキルにアカウントリンクを追加するを参照してください。

オブジェクト

◯

recipients.scope.type

提供されたトークンのタイプ。本リリースでサポートされている値はBearerTokenです。

文字列

◯

recipients.scope.token

ユーザーのアカウント情報にアクセスするためのトークンの値。

文字列

◯

トリガーの応答

正常に完了すると、HTTPステータス200 Okayが返されます。エラーの場合、該当するHTTPステータスコードが返されます。詳細については、HTTPステータスコードを参照してください。

応答のパラメーター

以下の表は応答パラメーターの一覧です。

プロパティ 説明 型 必須

requestId

requestIdは、AlexaがRoutines.Trigger.CreateリクエストまたはRoutines.Trigger.Deleteリクエストで送信する一意のリクエストIDです。

文字列

◯

HTTPステータスコード

HTTPステータスコード 型 説明

202

OK

操作は成功しました。

400

InvalidRequest

リクエストペイロードに無効なパラメーターがあります。

401

InvalidAccessToken

アクセストークンが無効です。

403

InsufficientPermission

リクエスターにトリガータイプにアクセスする権限がありません。

404

ResourceNotFound

リクエストリソースが見つかりません。

429

Throttled

サーバーが大量のリクエストを受信しました。

500

InternalError

リクエストの処理中に内部エラーが発生しました。

503

ServiceUnavailable

サーバーはリクエストを受け付けることができません。

このページは役に立ちましたか？

最終更新日: 2025 年 11 月 10 日