オーサリングツールでAPLサンプルをテストする



オーサリングツールでAPLサンプルをテストする

Alexa Presentation Languageの技術資料には、APLドキュメントとデータソースを作成する方法を説明したJSONサンプルを含むトピックがあります。これらのサンプルをAPLオーサリングツールにコピーして動作を確認し、自分で変更を加えて試してみることができます。これらのサンプルのほとんどは、実際に動いているスキルなしでテスト可能です。

APLサンプルコードについて

APLドキュメント全体のサンプルには、APLドキュメントデータソースという2つの部分が含まれます。サンプルが実行されている様子を確認するには、これらの両方をオーサリングツールにコピーしてください。

長いサンプルはページ上で折りたたまれています。ボタンをクリックして、コードを展開してください。

たとえば、次のようなボタンが表示されている場合があります。ドキュメント全体を表示するには、サンプルドキュメント: AlexaHeadlineの例をクリックしてください。データソース全体を表示するには、データソース:headlineExampleDataを参照してください。

APLドキュメントには、ドキュメント全体のサンプルと小さなコードスニペットの両方が含まれています。サンプルがドキュメント全体かどうかを調べるには、typeプロパティがAPLに設定されているかどうかを確認してください。ドキュメント全体のサンプルには、必ずこのプロパティが含まれています。

ドキュメント全体とデータソース全体をオーサリングツールにコピーする

APLオーサリングツールを使用すると、APLドキュメントとそれに関連するデータソースを作成して、さまざまなViewportでの見え方をプレビューできます。開発者コンソールでスキルからオーサリングツールを開くと、スキルとともにAPLドキュメントを保存できるため、後でまた作業に戻ることができます。

ツールの使用方法の詳細については、オーサリングツールを使用したAPLドキュメントの作成を参照してください。

ドキュメント全体は、必ずtypeプロパティで始まり、このプロパティはAPLに設定されています。

ドキュメント全体をオーサリングツールにコピーする方法

  1. 技術資料の各ページで、必要に応じてサンプルコードを展開します。
  2. コードをコピーボタンをクリックします。

    APL JSONサンプルのコードをコピーボタン
    APL JSONサンプルのコードをコピーするボタン
  3. 別のブラウザーウィンドウで、開発者コンソールを開きます。
  4. 既存のスキルを開くか、新しいスキルを作成します。オーサリングツールを使用する場合、このスキルで動作するエンドポイントがなくてもかまいません。
  5. 左側のナビゲーションで、画面表示をクリックします。

    新しいウィンドウかタブでオーサリングツールが開き、このスキルで保存されている既存のドキュメントが表示されます。

  6. テンプレートを作成をクリックします。
  7. 最初から作成オプションをクリックします。これにより、新しい空のAPLドキュメントとデータソースが作成されます。
  8. 左側のナビゲーションで、APLボタン(APLアイコン)をクリックしてJSONエディターを開きます。
  9. 編集ペインから既存のJSONコードをすべて削除し、ステップ2でコピーしたコードを貼り付けます。

    データが存在しない場合は、プレビューペインに空白のドキュメントが表示されることがあります。

  10. 次で説明するように、データソースにコピーします。
ドキュメントのサンプルに貼り付けた後のオーサリングツール
ドキュメントのサンプルに貼り付けた後のオーサリングツール(データソースなしの場合)

通常、ドキュメントのデータソースは、そのトピックのドキュメントの後にあります。JSONは、1つ以上のキー/オブジェクトのペアを持つオブジェクトです。たとえば、これはheadlineExampleDataというデータソースです。

{
  "headlineExampleData": {
    "property": "value"
  }
}

データソースをオーサリングツールにコピーする方法

  1. 技術資料の各ページで、必要に応じてデータソースのサンプルを展開します。
  2. コードをコピーボタンをクリックします。
  3. オーサリングツールに戻り、前に作成したAPLドキュメントに戻ります。
  4. 左側のナビゲーションで、DATAボタン(DATAアイコン)をクリックします。
  5. 編集ペインから既存のコンテンツを削除し、ステップ2でコピーしたコードに貼り付けます。

この時点で、プレビューペインに完全なドキュメントが表示されます。コンポーネントとデータを変更して試し、サンプルの動作を確認します。

ドキュメントとデータソースの両方を貼り付けた後のオーサリングツール
ドキュメントとデータソースの両方を貼り付けた後のオーサリングツール