トリガー定義

トリガー定義

カスタムトリガーを実装するには、定型アクションスキルパッケージにカスタムトリガーを表すトリガー定義ファイルを少なくとも1つ保存する必要があります。

定型アクションスキルパッケージでは、/skill-package/routines/triggers/ディレクトリを使用してトリガー定義ファイルを保存してください。トリガー定義を解釈できるのは、タイプがroutinesのAlexaスキルのみです。

次のスキルパッケージディレクトリは、2つのロケールをサポートするトリガーを含むスキルパッケージを示しています。(new)と記載された項目の対象は、routinesスキルタイプのみです。

トリガー定義はJSONファイルです。トリガータイプごとに/skill-package/routines/triggers/{some-trigger-name}/ディレクトリにトリガー定義ファイルを追加してください。トリガー定義のファイル名は、Alexaスキルでサポートされている4文字のロケールコードと一致する必要があります。たとえば、米国英語版のトリガー定義のファイル名はen-US.jsonとします。すべてのロケールファイルでnameフィールドには同じ値を使用してください。異なる値を使用できるのはdisplay.title、display.iconUrl、display.descriptionの各フィールドのみです。

次のJSONファイルはトリガー定義用テンプレートです。

次のJSONファイルはUNICASTのトリガー定義の例です。

次のJSONファイルはMULTICASTのトリガー定義の例です。

トリガー定義

次の表は、JSONファイルのトリガー定義の詳細です。

フィールド 説明 型 必須

name

スキルのカスタムトリガーを識別する名前。大文字と小文字が区別され、1 ～50文字の英数字を使用できます。

文字列

◯

display

トリガーの表示オブジェクト。詳細については、displayオブジェクトを参照してください。

オブジェクト

◯

parameters

トリガーのパラメーターを定義するオブジェクトのリスト。詳細については、permissionsオブジェクトを参照してください。

オブジェクトの配列

◯

delivery

トリガーのタイプ。指定できる値は、 UNICASTとMULTICASTです。UNICAST配信は各APIリクエストで1人のユーザーにのみトリガーイベントを送信し、MULTICAST 配信は各API リクエストで複数のユーザーに同じトリガーイベントを送信します。

文字列

◯

accountLinkingRequired

スキルにアカウントリンクが必要かどうかを指定します。指定できる値は、 REQUIREDまたはNOT_REQUIREDです。デフォルトはNOT_REQUIREDです。REQUIREDに設定する場合は、スキルにアカウントリンクが実装され、有効になっていることを確認してください。詳細については、Alexaスキルにアカウントリンクを追加するを参照してください。

文字列

×

displayCategories

トリガーのカテゴリー。有効な値は、 ASTROLOGY、BUSINESS_AND_FINANCE、CONNECTED_CAR、ENTERTAINMENT、HEALTH_AND_WELLNESS、NEWS、RESTAURANT、SHOPPING、SOCIAL_NETWORKING、SPORTS、TAXI_AND_RIDESHARING、WEATHERです。

文字列の配列

◯

keywords

ユーザーがトリガーの検索に使用できる検索用語のリスト。ロケールによって異なるキーワードを指定できます。

文字列の配列

◯

displayオブジェクト

displayオブジェクトには、Alexaアプリに表示するトリガーの詳細を指定します。displayオブジェクトはロケールごとに作成できます。

フィールド 説明 型 必須

title

Alexaアプリに表示するトリガーのタイトル。ロケールに合わせてローカライズできます。

文字列

◯

description

Alexaアプリに表示されるトリガーの説明。descriptionフィールドにはトリガーの詳細を、titleフィールドにはトリガーを簡潔に表すタイトルを指定します。ロケールに合わせてローカライズできます。

文字列

×

iconUrl

トリガーアイコンを取得するための公開Webアドレス。ロケールに合わせてローカライズできます。

文字列

×

parametersオブジェクト

parametersオブジェクトを使用して、トリガーのパラメーターを定義します。ユーザーは、トリガーを作成または更新するときにトリガーパラメーターを使用します。定型アクションは、トリガーの詳細ページを作成して有効なトリガーパラメーターを表示するために、定義されたパラメーターのリストを必要とします。パラメーターは、ここで定義した順序で詳細ページに表示されます。

フィールド 説明 型 必須

name

トリガー作成リクエストのdataオブジェクトに指定されたトリガーパラメーターの名前。

文字列

◯

schema

パラメータースキーマとそのタイプ。詳細については、schemaオブジェクトを参照してください。

オブジェクト

◯

display

カスタムトリガーのタイトル、説明、アイコンURLに関する情報。詳細については、displayオブジェクトを参照してください。

オブジェクト

◯

schemaオブジェクト

parametersオブジェクト内のschemaオブジェクトを使用して、スキーマの詳細を指定します。指定できる値はenumです。

フィールド 説明 型 必須

type

スキーマのタイプ。指定できる値はenumです。詳細については、列挙型スキーマオブジェクトを参照してください。

文字列

◯

列挙型スキーマオブジェクト

列挙型スキーマは、列挙値オブジェクトのリストを受け入れます。

フィールド 説明 型 必須

type

列挙型スキーマではenumに設定します。

文字列

◯

values

使用可能な列挙値とそのdisplayメタデータ。列挙値オブジェクトを参照してください

列挙値オブジェクトの配列

◯

列挙値オブジェクト

列挙値オブジェクトにはそれぞれ異なる値を列挙します。

フィールド 説明 型 必須

value

列挙セットのそれぞれ異なる列挙値。トリガー作成リクエストデータ内の列挙データの値です。

文字列

◯

display

トリガーの表示オブジェクト。詳細については、displayオブジェクトを参照してください。

オブジェクト

◯

トリガーのアイコン、説明、タイトルのベストプラクティス

  • アイコンの要件は次のとおりです。

    • ファイル形式：PNG
    • サイズ：512 x 512ピクセル
    • 透明な背景
    • ライトモード（#FFFFFF）とダークモード（#010B13）のどちらでも視認可能

  • アイコンはenumリストのすべてのオプションに使用するか、どのオプションにも使用しない必要があり、これは説明についても同様です。

  • nameフィールドとdisplay.titleは別のものです。display.titleはユーザーに表示されるため、display.titleにはトリガーの実際の機能を表すタイトルを指定する必要があります。

アイコンの例

透明な背景のアイコン

アイコンの例

明るい背景と暗い背景のどちらでもはっきりと視認できる

背景のあるアイコン

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

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