ウィジェットを作成して管理する

ウィジェットを作成して管理する

ウィジェットをスキルに追加するには、デバイスでウィジェットを管理するためのインターフェースを有効にします。続けてウィジェットのAlexa Presentation Language（APL）ドキュメントを作成し、APLパッケージを設定します。このパッケージには、デバイスのウィジェットギャラリーとウィジェットパネルにドキュメントを表示するためのマニフェストとその他のアセットが含まれています。

これらの作業はすべて開発者コンソールで行います。

ウィジェット用のインターフェースを有効にする

ウィジェットを使用するには、スキルが以下に対応する必要があります。

  • Alexa.DataStore.PackageManager（ALEXA_DATASTORE_PACKAGEMANAGER）– デバイスでパッケージを管理するためのリクエストを利用できます。
  • Alexa.DataStore（ALEXA_DATA_STORE）– デバイスでのデータストアの更新に関連するリクエストを利用できます。
  • APLデータストアExtension – APLドキュメントで、データストアのデータにアクセスするデータバインディング式を使用できるようにします。

必要なインターフェースをスキルに設定する

  1. 開発者コンソールにサインインして、設定するスキルの名前をクリックします。
  2. ビルド＞インターフェースページに移動します。
  3. データストアパッケージオプションを有効にします。
  4. データストアオプションを有効にします。
  5. Alexa Extensionsでデータストアが選択されていることを確認します。
  6. 保存、モデルをビルドの順にクリックして、対話モデルを再ビルドします。

オーサリングツールでウィジェットを作成または編集する

APLドキュメントは、表示するテンプレートを定義するJSONオブジェクトです。ウィジェットの場合、ドキュメントはデバイスがウィジェットパネルにウィジェットを表示する際に表示されるテンプレートを定義します。

ウィジェットのオーサリングツールを使用してウィジェットを編集し、デバイスでプレビューできます。ウィジェットのオーサリングツールは通常のAPLドキュメントのオーサリングツールと似ていますが、ウィジェット固有の機能がいくつか含まれています。

スキルを使用せずにウィジェットの開発を開始する

ウィジェットの開発を開始する際に、スキルから開始せずにオーサリングツールを直接開くことができます。ただし、作業内容を保存するにはウィジェットをスキルに関連付ける必要があります。

スキルを使用せずにウィジェットを開発するには、こちらのリンクhttps://developer.amazon.com/alexa/console/ask/displays/widget/にアクセスしてオーサリングツールを開きます。

以下の制限事項が適用されます。

  • ドキュメントで定義されているトランスフォーマーは動作しません。
  • テスト用にウィジェットをデバイスにインストールする場合、インストールオプションを使用できませんが、プレビューオプションは使用できます。完全なテストを実行するには、ウィジェットをスキルに関連付けてください。
  • 作業内容を保存するには、ウィジェットをスキルに関連付ける必要があります。
    1. 保存アイコンをクリックします。
    2. ウィジェット名を入力します。
    3. スキルドロップダウンから既存のスキルを選択します。

スキルのウィジェットを作成する

開発者コンソールでスキルのウィジェットの一覧にアクセスするには

  1. 開発者コンソールにサインインして、更新するスキルの名前をクリックします。
  2. 左側のナビゲーションでマルチモーダルをクリックします。
  3. このスキルのウィジェットの一覧を表示するには、ウィジェットをクリックします。

オーサリングツールには、ウィジェット作成の開始点として使用できる複数のテンプレートが用意されています。これらのテンプレートはウィジェットのレスポンシブ対応テンプレートに基づいています。

新しいウィジェットドキュメントを作成するには

  1. 開発者コンソールでスキルを開き、ウィジェットの一覧に移動します。
  2. ウィジェットを作成をクリックします。
  3. 以下のいずれかを実行します。
    • テンプレートから開始する場合は、利用可能なテンプレートのいずれかをクリックします。
    • 空白のドキュメントから開始する場合は、空のドキュメントをクリックします。
    • ファイルからAPLドキュメントをアップロードする場合は、アップロードをクリックしてプロンプトの指示に従います。
  4. 保存ボタンをクリックしてウィジェットドキュメントを保存します。ここで指定した名前が、パッケージのマニフェストとスキルコードでウィジェットを参照するときに使用するウィジェットIDとなります。

新しいウィジェットを開発したら、オーサリングツールを使用してドキュメントを作成します。ウィジェットはほとんどのAPL機能に対応しています。APLドキュメント構造のリファレンスについては、APLドキュメントを参照してください。ウィジェットで使用できるレスポンシブ対応コンポーネントとテンプレートの詳細については、レスポンシブ対応コンポーネントとテンプレートを参照してください。ウィジェットで対応していないAPL機能の一覧については、ウィジェットで対応していないAPL機能を参照してください。

時間の経過に伴って変化するコンテンツがウィジェットに表示される場合、データストアExtensionを使用してドキュメントを設定し、ドキュメントのプロパティをデータソースではなくデータストアにバインドします。データストアExtensionの詳細については、APLデータストアExtensionを参照してください。

オーサリングツールで既存のウィジェットを編集するには

  1. 開発者コンソールにサインインして、更新するスキルの名前をクリックします。
  2. 左側のナビゲーションでマルチモーダルをクリックします。
  3. このスキルのウィジェットの一覧を表示するには、ウィジェットをクリックします。
  4. 一覧でウィジェットを探し、編集をクリックします。

ウィジェットのAPLパッケージのマニフェストを更新する

ウィジェットには、ウィジェットに関する情報が指定されたマニフェストを含むAPLパッケージが必要です。オーサリングツールで新しいウィジェットドキュメントを作成して保存すると、このパッケージが自動的に作成されます。パッケージのマニフェストはオーサリングツールで直接編集できます。

パッケージのマニフェストを編集して、ユーザー向けのウィジェットの名前、説明、プレビューイメージアセットを指定します。

ウィジェットのパッケージのマニフェストを編集するには

  1. オーサリングツールでウィジェットの一覧を開きます。
  2. 更新するウィジェットを探し、編集をクリックします。

  3. ツールバーのManifestをクリックします。

    Manifestツールバーボタン

    マニフェストのセクションに、ウィジェットのAPLパッケージのマニフェストが表示されたJSONエディターが開きます。

  4. マニフェストのデータを編集します。
    • ウィジェットギャラリーに表示される名前と説明を更新する場合は、publishingInformationセクションのフィールドを更新します。
    • パッケージ構造とmanifest.jsonスキーマの全リファレンスについては、APLパッケージリファレンスを参照してください。

Alexa Skills Kitコマンドラインインターフェース（ASK CLI）を使用してAPLパッケージのダウンロードと更新を行うこともできます。詳細については、ASK CLIを使用してAPLパッケージのダウンロードと更新を行うを参照してください。

ウィジェットをプレビューする

開発時にウィジェットをプレビューし、テストします。開発時にオーサリングツールを使用してウィジェットのレイアウトをプレビューできますが、ウィジェット全体をテストするには画面付きのデバイスが必要です。詳細については、ウィジェットをテストするを参照してください。

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

最終更新日: 2023 年 09 月 11 日