Merge and Store V1からV2への移行

Merge and Store V1からV2への移行

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

差し込みして保存V2 APIに移行する理由   

差し込みして保存V1 APIでは、差し込み操作が完全に完了した後にのみレスポンスが返されます。一方、Delugeスクリプトで許可される最大タイムアウト時間は40秒です。差し込みにそれ以上の時間がかかるとタイムアウトが発生し、DRE処理フローが失敗します。
この制限を解消するため、差し込みして保存V2 APIが導入されました。V2では、次のように処理されます。
  • レスポンスは、差し込みが完了する前でもすぐに、仮想RID付きで返されます。
  • 差し込み操作はバックエンドでスケジュールされ、差し込み文書は仮想RIDを使用して保存されます。
  • ユーザーは、仮想RIDを使用して処理フローを続けることができます。最終的な差し込みが完了するまで、一時的なコンテンツを利用できます。
差し込みのステータスを確認するには、次のいずれかのレスポンス項目を使用できます。
  • merge_report_data_url
  • merge_report_url
パラメーターとスコープは、差し込みして保存V1と同じです。また、V2では、差し込み文書の保存先を指定するために、merge_toという新しい任意のキーが「output_settings」パラメーター内に追加されました。

差し込みして保存V1からV2への移行方法？

差し込みして保存V1からV2に移行するには、次の主な変更を行います。
  • エンドポイントの更新：APIエンドポイントを次のURLに更新します。https://{zohoapis_domain}/writer/api/v2/documents/{{document_id}}/merge/store
  • HTTPメソッド：POST
  • ペイロードの書式：差し込みデータと設定をJSON形式の要求本文に含めます。
  • レスポンスの処理：各差し込み文書の詳細なステータスを含む、構造化されたJSON形式のレスポンスが提供されます。
APIの詳細については、次のドキュメントを参照してください。差し込みして保存V2 API