開発者コンソールでドキュメントを作成する
Alexa Presentation Language(APL)ドキュメントの作成、プレビュー、テストを行うには、開発者コンソールのツールを使用します。APLドキュメントとは、スキル応答のテンプレートを定義するJSON構造のことです。ドキュメントは視覚応答、オーディオ応答のどちらでも定義できます。
マルチモーダル応答ビルダーを使用する
マルチモーダル応答ビルダーでは、視覚応答を作成する手順をガイド付きで進めることができます。
- さまざまなデバイスで見栄えよく表示されるようにデザインされたテンプレートのセットから、使用するテンプレートを選択します。
- テンプレートに表示するコンテンツを指定して、応答をカスタマイズします。
- 開発者コンソールとデバイスの両方で応答をプレビューします。
応答のカスタマイズを完了すると、マルチモーダル応答ビルダーによってサンプルコードが生成されます。このコードをスキルのリクエストハンドラーにコピーして、応答を表示できます。スキルの対話モデルを再ビルドし、デバイスまたは開発者コンソールのシミュレーターでスキルをテストします。
まず、マルチモーダル応答ビルダーでドキュメントを作成します。その後、複雑なカスタマイズが必要な場合は、フル機能を備えたオーサリングツールでドキュメントを編集します。
マルチモーダル応答ビルダーを開くには
- 開発者コンソールで、ドキュメントを作成するスキルを開きます。
- サイドバーで、マルチモーダルをクリックします。
- 応答ビルダーで作成をクリックします。
- ページの指示に従って3つの手順を完了します。
- テンプレートを選択します。テンプレートのセットには、レスポンシブ対応テンプレートやその他の視覚デザインが含まれています。
- カスタマイズします。
- プレビューとテストを行います。
スキル内でオーサリングツールを使用する
オーサリングツールは、APL用の完全なオーサリング環境を提供します。最初から作成することも、既存のテンプレートから始めることもできます。LottieアニメーションやScalable Vector Graphics(SVG)をインポートすることもできます。
オーサリングツールでは、テンプレートの作成中にAPLのすべての機能にアクセスできます。オーサリングツールはマルチモーダル応答ビルダーよりも強力ですが、APLの動作に関する知識もより多く必要になります。
APLドキュメントの作成と編集の詳細については、APLドキュメントの作成と編集を参照してください。
APLの言語リファレンスについては、以下を参照してください。
- 視覚応答: 画面付きデバイス用APLリファレンス
- オーディオ応答: APL for Audioリファレンス
スキルなしでオーサリングツールを試す
オーサリングツールを直接開くと、スキルがなくてもAPLを試すことができます。サンプルテンプレートからドキュメントを作成し、ドキュメントに対してリントを実行したり、レンダリングのプレビューを表示したりできます。
作業内容を保存して以下の機能を使用するには、ドキュメントをスキルに関連付ける必要があります。
- デバイスでのプレビュー
ssmlToSpeechやaplAudioToSpeechなどのトランスフォーマーの実行
ドキュメントをスキルに保存するには
- 保存アイコンをクリックします。
- テンプレート名を入力します。
- スキルドロップダウンから既存のスキルを選択し、保存をクリックします。
Lottieアニメーションをインポートする
オーサリングツールにLottie形式のアニメーションをインポートして、APLドキュメントの作成に使用できます。LottieはJSONのアニメーション形式で、Adobe After Effectsから書き出すことができます。
LottieアニメーションをインポートしてAPLドキュメントで使用する方法の詳細については、Lottieアニメーションのインポートを参照してください。
Scalable Vector Graphics(SVG)をインポートする
Scalable Vector Graphics(SVG)ファイルをAPLドキュメントで使用するには、APLオーサリングツールを使用してAlexa Vector Graphics(AVG)オブジェクトに変換します。
SVG形式は、ベクターグラフィックスを表すためのXMLベースのマークアップ言語です。AVGは、SVGのパラメーター化されたサブセットです。AVGで定義されたグラフィックは、VectorGraphicコンポーネントを使ってドキュメントに表示できます。
SVGをインポートする方法の詳細については、Scalable Vector Graphics(SVG)のインポートを参照してください。
APLドキュメントをインポートおよびエクスポートする
APLドキュメントはJSON形式でエクスポートできます。エクスポートすると、ドキュメントとデータソースを含むJSONファイルが作成されます。エクスポートしたドキュメントをインポートして、新しいドキュメントを作成することもできます。
インポートとエクスポートの詳細については、APLドキュメントのインポートと書き出しを参照してください。
APLドキュメントをプレビューする
オーサリングツールを使用すると、ドキュメントがユーザーにどのようにレンダリングされるかをプレビューできます。
視覚応答の場合は、異なるサイズのデバイスでドキュメントがどのように表示されるかを確認できます。タップイベント、コマンド、ビデオなど、ドキュメントのさまざまな要素をプレビューできます。オーディオ応答の場合は、ドキュメントで生成されるオーディオクリップを聞くことができます。
オーサリングツールでドキュメントのプレビューとテストを行う方法については、APLドキュメントのプレビューを参照してください。
APLドキュメントをスキル応答に統合する
APLドキュメントをスキルで使用するには、スキルからAlexaに送信する応答にRenderDocumentディレクティブを含めます。視覚応答の場合、Alexaはドキュメントを画面に表示します。オーディオ応答の場合、Alexaはドキュメントから生成されたオーディオを再生します。
RenderDocumentディレクティブを送信するときは、表示または再生するドキュメントを提供する必要があります。以下のいずれかの方法でドキュメントを提供してください。
APLドキュメントにリンクする
オーサリングツールにAPLドキュメントを保存し、そのドキュメントへのリンクをRenderDocumentディレクティブに渡します。ドキュメントは開発者コンソール内のスキルに関連付けられたままになり、ツールで行った変更はスキルの応答に反映されます。
ドキュメントをRenderDocumentディレクティブで使用できるようにするには、開発者コンソールで対話モデルをビルドする必要があります。オーサリングツールでドキュメントを変更した場合は、対話モデルを再ビルドして、更新されたドキュメントをRenderDocumentで使用できるようにします。
RenderDocumentディレクティブとドキュメントへのリンクを含むコード例が生成されます。スキルと統合オプションは、開発者コンソールに保存されているすべてのAPLドキュメントで使用できます。詳細については、次のいずれかを参照してください。
- 視覚応答については、オーサリングツールに保存されたAPLドキュメントへのリンク(Alexa.Presentation.APL)を参照してください。
- オーディオ応答については、オーサリングツールに保存されたAPLAドキュメントへのリンク(Alexa.Presentation.APLA)を参照してください。
ドキュメントのJSONをスキルコードに埋め込む
ドキュメントのJSONをスキルコードにコピーし、ドキュメントのJSON全体をRenderDocumentディレクティブに渡します。ドキュメントに変更を加えた場合は、スキルコードを更新する必要があります。
ドキュメントのJSONをエクスポートする方法の詳細については、APLドキュメントのインポートと書き出しを参照してください。
Alexa Skills Kit(ASK)SDKを使用してRenderDocumentを送信する方法を示す例については、スキルコードにAPLサポートを追加するを参照してください。
APLドキュメントとスキルパッケージ
オーサリングツールにAPLドキュメントを保存し、スキルの対話モデルをビルドすると、開発者コンソールによってドキュメントがスキルのスキルパッケージに統合されます。スキルパッケージには、スキルマニフェスト、音声対話モデル、オーサリングツールに保存されたAPLドキュメントなど、スキルを記述するリソースが含まれています。
スキルのスキルパッケージは、オフラインで操作するためにダウンロードが可能で、ASKコマンドラインインターフェース(CLI)、Alexaスキル管理API(SMAPI)、Alexa Skills Toolkit for Visual Studio Code(VS Code)を使用してスキルを管理できます。これらのツールは、スキルのAPLドキュメントをskill-package/responseフォルダにダウンロードします。
スキルの編集に開発者コンソールとオフラインツールの両方を使用する場合は、オーサリングツールで作成したAPLドキュメントが失われるのを防ぐために、パッケージの同期を保つようにしてください。たとえば、次の状況では作業内容が失われる可能性があります。
- ASK CLIを使用して、スキルをローカルコンピューターにダウンロードします。
- 後からオーサリングツールでこのスキルのAPLドキュメントを作成して、APLの機能を試します。このドキュメントを
MyNewAPLDocumentという名前で保存します。 - ローカルバージョンのスキルに、上記とは関係のないほかの変更を加えます。たとえば、スキルマニフェストを編集します。
- 次のいずれかのコマンドを使用して、それらの変更をスキルにデプロイします。
ask deploy- セルフホストスキルをデプロイします。git push- Alexa-hostedスキルをデプロイします。
デプロイのステップでは、サーバーに保存されているスキルパッケージが、ローカルコンピューターに保存されているバージョンで上書きされます。ローカルバージョンにはMyNewAPLDocumentドキュメントが含まれていないため、この操作によってスキルからドキュメントが削除されます。
作業内容が失われるのを防ぐには、コンピューター上のスキルパッケージとAlexaサービスに保存されているスキルパッケージが一致するようにします。次のガイドラインを使用してください。
- オーサリングツールでAPLドキュメントを作成または更新したら、必ずスキルをビルドしてください。新しいドキュメントや更新されたドキュメントは、スキルをビルドするまでスキルパッケージに含められません。
- ASK CLIを使用してローカルでスキルを管理する場合は、
ask deployコマンドやgit pushコマンドでローカルの変更をデプロイする前に、スキルパッケージの最新バージョンをダウンロードしてください。まず既存のskill-packageフォルダをバックアップしてから、export-packageコマンドを使用してskill-packageフォルダの最新バージョンをダウンロードします。 - VS CodeでASK Toolkit拡張機能を使用する場合は、ローカルの変更をデプロイする前に、DeployページのSkill Package Remote Sync Statusセクションを確認してください。ローカルのスキルパッケージの内容がAlexaの最新バージョンではない可能性があることがツールによって示された場合は、Export skill packageリンクをクリックしてローカルのスキルパッケージをバックアップし、最新のスキルパッケージをダウンロードします。
export-packageコマンドとASK Toolkit for VS CodeのExport skill packageリンクでは、スキルパッケージに含まれているAPLドキュメントがダウンロードされますが、そのためにはスキルの再ビルドが必要です。オーサリングツールで新しいドキュメントを作成しても、まだスキルをビルドしていない場合、その新しいドキュメントはダウンロードに含まれず、ローカルの変更をデプロイすると削除される可能性があります。関連トピック
- スキルに視覚要素とオーディオを追加する
- APLドキュメント
- Alexa.Presentation.APLインターフェースのリファレンス
- Alexa.Presentation.APLAインターフェースのリファレンス
最終更新日: 2025 年 10 月 09 日