メインコンテンツまでスキップ

Zapier 連携(ReportFlow Integration)

ReportFlow の Zapier Integration は、Zapier App DirectoryBeta 公開中です。Zapier から Re:port Flow のデザインを選び、スプレッドシート・フォーム・CRM などのデータを使って PDF 帳票を自動生成できます。

事前に用意するもの

  1. Re:port Flow のワークスペースre-port-flow.com で作成)
  2. PDF のもとになるデザイン。まだ無い場合はテンプレートギャラリーから複製できます
  3. Zapier アカウント

Zapier との接続には OAuth 2.0 Authorization Code + PKCE を使います。アプリケーションキーやパスワードを Zap の入力欄へ貼り付ける必要はありません。接続画面で Re:port Flow にログインし、利用するワークスペースを選んで認可してください。

提供中のトリガーとアクション

種類Zapier 上の名前用途
TriggerNew PDF GeneratedPDF の生成完了時に Zap を開始します。非同期生成の passthrough を使って、開始元のレコードと生成結果を対応付けられます
ActionGenerate PDF (Sync)軽量な帳票を同期生成し、後続ステップへ PDF ファイルを渡します
ActionGenerate PDF (Async)重い帳票の生成を開始し、待たずに requestId を返します。完了後の処理には New PDF Generated を使います
ActionDownload PDFrequestId と、必要に応じて fileId を指定し、生成済み PDF を後続ステップで使えるファイルとして取得します

同期生成と非同期生成の選び方

  • 1 回のアクションで PDF を受け取りたい軽量な帳票は Generate PDF (Sync)
  • 生成に時間がかかる帳票や、生成後に別の Zap で保存・通知したい場合は Generate PDF (Async)

非同期アクションの成功は「生成を受け付けた」という意味で、PDF の完成ではありません。完了を待つ処理は、別の Zap で New PDF Generated をトリガーにして組みます。同期生成でも完了イベントは発生するため、必要に応じて Filter by Zapier で requestIdpassthrough を絞り込んでください。

passthrough には注文 ID など、開始元と結果を対応付けるための値を JSON オブジェクトで設定できます。この値は PDF のメタデータや帳票検索にも使われるため、パスワード・トークン・個人情報などの機微情報は入れないでください。

Google Sheets テンプレートを使う

公開中の Create ReportFlow reports from new Google Sheets rows は、次の 2 ステップをあらかじめ組み合わせた Zap テンプレートです。

  1. Google Sheets — New Spreadsheet Row: スプレッドシートの末尾に新しい行が追加されたら開始
  2. ReportFlow — Generate PDF (Async): その行の値を使って PDF の非同期生成を開始

設定手順

  1. テンプレートページで Try it を選ぶ
  2. 対象の Google Sheets アカウント、スプレッドシート、ワークシートを接続する
  3. ReportFlow へ接続し、利用するワークスペースを認可する
  4. DesignVersion を選ぶ
  5. File Name とデザインの各パラメータへ、Google Sheets の列を割り当てる
  6. 両ステップをテストし、期待した値で生成が開始されることを確認してから Zap を公開する

Zap テンプレートには接続先アカウントやフィールドの実値は含まれません。利用者自身が接続し、Google Sheets の列とデザインパラメータを割り当てます。列名を変更した場合やデザインのパラメータを追加・変更した場合は、Zap の割り当ても更新してください。

生成後にメール送信やストレージ保存まで自動化する場合は、別の Zap を作成し、New PDF Generated が返す PDF File を Gmail / Google Drive などへ渡します。最初の Zap で一意な行 ID を passthrough に入れておくと、完了イベントを元の行へ安全に対応付けられます。別の経路から requestId / fileId だけを受け取った場合は Download PDF でファイルを取得します。

よくある問題

ReportFlow に接続できない

Zapier の My apps で ReportFlow の接続を開き、再接続してください。認可時には利用するワークスペースを選びます。権限スコープが更新された接続は再認可が必要になる場合があります。

デザインや入力欄が表示されない

接続したワークスペースにデザインがあることを確認し、Zap エディタでフィールドを再読み込みしてください。デザインのバージョンを変更すると、パラメータ入力欄も更新されます。

Async アクションの直後に PDF が無い

非同期アクションは生成完了を待ちません。New PDF Generated トリガーで完了と PDF File を受け取ってください。requestId / fileId から後で取り直す場合は Download PDF を使います。

運用・保守者向け:公開情報を更新する

ReportFlow Integration の実装は reportflow-zapier リポジトリで管理しています。公開中のバージョンへ直接変更を重ねず、次の順で新バージョンを検証します。

  1. zapier-platform versions で公開中バージョンの State と Zap Users を確認する
  2. 変更内容に合わせて package.json のバージョンを上げる(互換修正 = PATCH、後方互換の機能追加 = MINOR、破壊的変更 = MAJOR)
  3. npm testzapier-platform validate を実行する
  4. zapier-platform push で private バージョンとして送信し、対象バージョンへテストユーザーを招待して Zap エディタで確認する
  5. 公開版の切り替えは、影響を確認した人間の管理者が zapier-platform promote <version> を実行する
  6. promote 後に App Directory の表示、OAuth 接続、4 つの trigger/action、公開テンプレートからの Zap 作成を再確認する

詳細は Zapier 公式のバージョン管理バージョンの Promoteを参照してください。Trigger / Action の非表示化、key の変更、入出力 field key の削除・変更は破壊的変更です。破壊的変更がある場合、既存テンプレートは新しい公開バージョンへ自動更新されません。

Zap テンプレートを追加・更新する

  1. Zap templates dashboard で Draft を作成する
  2. 公開済みの ReportFlow バージョンを選び、Trigger / Action とフィールド割り当てを設定する
  3. タイトルと説明を英語で記載し、Save Draft 後に Create Zap から実際の Zap を作ってテストする
  4. Submit for Review で Zapier の審査へ提出する
  5. 承認後、App Directory と公開 URL の両方で表示と動作を確認し、本ページのリンク・説明も更新する

公開済み Zap テンプレートはダッシュボードから直接編集できません。修正が必要な場合は、公開 URL に含まれる Template ID を添えて Zapier Developer Support に Draft へ戻すよう依頼し、修正・再審査を行います。詳細は Zapier 公式のZap templatesを参照してください。

次のステップ