ドキュメント（キャラクターディスプレイ）

APL-Tドキュメントは、構造が明確に定義されたJSONオブジェクトです。ドキュメントは、キャラクターディスプレイ付きデバイス（Echo Dot with clockなど）に表示するためのテンプレートを定義し、全体的な構造とレイアウトを制御します。ドキュメントをデバイスに送信するには、Alexa.Presentation.APLT.RenderDocumentディレクティブを使用します。

例
プロパティ

例

単純なAPL-Tドキュメントは、1つのコンポーネントのみをインフレートします。これは画面の左上隅に描画されます。

{
  "type": "APLT",
  "version": "1.0",
  "mainTemplate": {
    "items": [
      {
        "type": "Text",
        "text": "こんにちは。"
      }
    ]
  }
}

より複雑なAPL-Tドキュメントでは、複数のコンポーネントを入れ子にできます。

{
  "type": "APLT",
  "version": "1.0",
  "description": "これは少し複雑な例です。",
  "layouts": {},
  "resources": [],
  "mainTemplate": {
    "items": [
      {
        "id": "myPager",
        "type": "Pager",
        "items": [
          {
            "type": "Text",
            "text": "P9： 1"
          },
          {
            "type": "Text",
            "text": "P9： 2"
          }
        ]
      }
    ]
  },
  "onMount": {
    "type": "AutoPage",
    "componentId": "myPager",
    "delay": 500,
    "count": 2,
    "duration": 500
  },
  "settings": {
    "idleTimeout": 10000
  }
}

プロパティ

次の表は、APL-Tドキュメントオブジェクトに含まれるトップレベルのプロパティをまとめたものです。

プロパティ	型	必須	説明
description	文字列	×	（任意）このドキュメントの説明です。
layouts	マップ	×	カスタムレイアウトです（レイアウト）。
mainTemplate	コンポーネントの配列	◯	開始レイアウトです。
onMount	コマンドの配列	×	このドキュメントが最初に表示されたときに実行するコマンドです。
resources	リソースの配列	×	リソースの定義です（リソース）。
settings	マップ	×	ドキュメント全体の設定です。
type	"APLT"	◯	「APLT」に設定する必要があります。
version	"1.0"	◯	APL-T仕様のバージョンを表す文字列です。現在は「1.0」です。

mainTemplate

mainTemplateは、ドキュメントが最初に画面に表示されるときにインフレートされるレイアウトです。mainTemplateに定義されたパラメーターは、APL-Tドキュメントの表示を開始したRenderDocumentディレクティブによって提供されます。詳細については、APL-TインターフェースのRenderDocumentディレクティブを参照してください。

onMount

このドキュメントが画面に最初に表示されたときに実行するコマンドです。このコマンドは、コンポーネントのonMountコマンドが実行された後に実行されます。

ドキュメントが最初に画面に表示されると、次の一連のアクションが行われます。

コンポーネントのすべてのonMountコマンドを並列で実行します。
ドキュメントのonMountコマンドを実行します。

これらのコマンドは、実際には次のようなメタコマンドにまとめられます。

{
  "type": "Sequential",
  "commands": [
    {
      "type": "Parallel",
      "commands": "<COMPONENT_ON_MOUNT_COMMANDS>"
    }
  ],
  "finally": "<DOCUMENT_ON_MOUNT_COMMAND>"
}

settings

settingsプロパティは、ドキュメント全体のプロパティを定義するキーと値のペアのマップを保持します。次のプロパティが定義されています。

プロパティ	型	デフォルト	説明
idleTimeout	数値	<システム>	無操作状態が続いたためにドキュメントを閉じるまでの時間です。

たとえば、デフォルトのアイドルタイムアウトを2分に設定するには、次のように指定します。

{
  "type": "APLT",
  "version": "1.0",
  "settings": {
    "idleTimeout": 120000
  }
}

idleTimeout

無操作状態が続いたためにドキュメントを閉じる前に、ドキュメントを画面に表示したままにする推奨時間（ミリ秒単位）です。この値は推奨値であり、動作を保証するものではありません。デバイスによっては、アイドルタイムアウト値が無視されたり、制限されたりすることがあります。ドキュメントのライフサイクルに関する説明については、lifecycle_sectionを参照してください。

version

versionプロパティは、APL-Tドキュメントが使用するAPL-T仕様のバージョンを指定します。必要な機能を特定して正確にレンダリングするために、APL-Tレンダリングエンジンによって使用されます。versionプロパティが正しく設定されていることを確認するのは、APL-Tドキュメントの作成者の役割です。

APL-Tレンダリングエンジンがドキュメントのバージョン番号をサポートしていない場合、ドキュメントのレンダリングは拒否されます。APL-Tレンダリングエンジンは下位互換性を持つことが想定されているため、「1.1」をサポートするエンジンでは、「1.0」ドキュメントもサポートされる予定です。

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

フィードバックを送信

最終更新日: 2025 年 12 月 17 日