Printgraph Docs

テンプレート

テンプレートの管理方法

概要

テンプレート一覧画面では、PDF 生成に使用するテンプレートの作成・管理を行うことができます。テンプレートには変数を設定でき、PDF 生成時に値を差し込むことが可能です。

機能一覧

テンプレートの新規作成

  1. 画面右上の 「テンプレート新規作成」 ボタンをクリック
  2. テンプレート作成画面に遷移

テンプレート一覧の確認

画面にはテンプレートの一覧がテーブル形式で表示されます。各テンプレートについて以下の情報を確認できます。

項目説明
テンプレート名前テンプレートの識別名
テンプレートIDAPI から PDF を生成する際に使用する一意の識別子
更新日テンプレートが最後に更新された日時
作成日テンプレートが作成された日時

テンプレートIDのコピー

API から PDF を生成する際にテンプレートIDが必要な場合、簡単にコピーできます。

  1. テンプレート一覧で対象のテンプレートを探す
  2. 「テンプレートID」列の コピーアイコン をクリック
  3. クリップボードにテンプレートIDがコピーされ、成功メッセージが表示される

PDF生成

テンプレートを使用して PDF を生成します。

  1. テンプレート一覧で対象のテンプレートを探す
  2. 「PDF生成」 ボタンをクリック
    • モバイル画面では ︙(メニューボタン) から「PDF生成」を選択
  3. PDF 生成画面に遷移

テンプレートの編集

既存のテンプレートを編集します。

  1. テンプレート一覧で対象のテンプレートを探す
  2. 右端の ︙(メニューボタン) をクリック
  3. 「編集」 を選択
  4. テンプレート編集画面に遷移

テンプレートの削除

不要になったテンプレートを削除します。

  1. テンプレート一覧で対象のテンプレートを探す
  2. 右端の ︙(メニューボタン) をクリック
  3. 「削除」 を選択
  4. 確認ダイアログが表示される
  5. 削除を実行する場合は確認ボタンをクリック

削除は取り消せません

削除したテンプレートは復元できません。削除する前に、そのテンプレートが使用されていないことを確認してください。

ページネーション

テンプレートが多い場合は、ページ切り替えで表示を切り替えることができます。1ページあたり10件のテンプレートが表示されます。

TIPS

テンプレートIDの活用

テンプレートIDは API から PDF を生成する際に必要です。外部システムとの連携を行う場合は、テンプレートIDをコピーして API リクエストに含めてください。