Merge and Store V1からV2への移行方法は?

Merge and Store V1からV2への移行方法は?

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

なぜMerge and Store V2 APIへ移行する必要があるのか?   

Merge and Store V1 APIでは、マージ処理が完全に完了した後にのみレスポンスが返品済みとなります。しかし、Delugeスクリプトでは最大許容タイムアウトが40秒です。マージにそれ以上の時間がかかる場合、タイムアウトが発生し、DREワークフローが失敗する原因となります。
この制限を解決するために、Merge and Store V2 APIが導入されました。V2では、
  • レスポンスが今すぐvirtual RIDとともに返品され、マージが完了する前でも取得可能です。
  • マージ処理はバックエンドでスケジューリングされ、マージ後のドキュメントはvirtual RIDを利用して保存されます。
  • ユーザーはvirtual RIDを使ってワークフローを継続できます。最終的なマージが完了するまで一時的なコンテンツが利用可能です。
マージのステータスを追跡するには、下記いずれかのレスポンス項目を使用できます。
  • merge_report_data_url
  • merge_report_url
パラメーターおよびスコープはMerge and Store V1と同じです。さらにV2では、「output_settings」パラメーター内に新たなオプションキーとしてmerge_toが追加されており、マージ後のドキュメント保存先を指定できます。

差出人 Merge and Store V1 から V2 への移行方法? 

差出人 Merge and Store V1 から V2 へ移行するには、以下のキーとなる変更を行ってください。
  • Endpoint を更新: API エンドポイントを以下に更新してください: https://{zohoapis_domain}/writer/api/v2/ドキュメント/{{document_id}}/merge/store
  • HTTP メソッド: POST
  • データ内容の形式: マージデータおよび設定情報を JSONリクエスト本文 に含めて送信します。
  • レスポンス処理: 各マージ済みドキュメントの詳細なステータスを含む構造化されたJSONレスポンスが返されます。
API の詳細は、以下のドキュメントをご参照ください: Merge and Store V2 API