Zoho WriterでDelugeを使って接続を作成する方法

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

概要

Zoho Writer の Deluge 外部連携を利用すると、認証プロトコルを通じて外部サービスと安全に連携できます。これらの外部連携はカスタム関数で活用でき、プラットフォーム間でデータの取得や送信を行い、強力な自動化やワークフローのカスタマイズを実現します。

初期設定サービスでもカスタムサービスでも、Zoho Writer は外部アプリケーションからのデータ統合を通じて、シームレスなドキュメント編集やリアルタイム共同作業をサポートします。

外部連携を利用すると、次のことが可能です：

Fetch外部サービスからリアルタイムデータを、Writer ドキュメントに直接取り込むことができます。
PushWriter のドキュメントやデータをサードパーティプラットフォームへ送信できます。例：マージ済みドキュメントを自動的に Google Drive へアップロード。

前提条件

Zoho Writer で連携を作成する前に、以下をご確認ください：

Zoho Writer へのアクセス権をお持ちであること。
自動化テンプレート（Merge、Fillable、または Sign）のいずれかを使用していることを確認してください。
OAuth2 カスタムサービスの場合：

クライアントID、クライアントシークレット、API URL（認証、アクセストークン、トークン更新）をサードパーティサービスから取得してください。
必要なスコープおよび対応する認可グラント種類（Authorization コードまたは Client Credentials）を把握しておくこと。
サードパーティアプリで正しい Zoho のコールバックURLを登録していることを確認してください。

Zoho Writer で連携を作成する手順

A. 初期設定サービスの場合

Zoho WriterでDelugeエディタへアクセスする方法:

ドキュメントを開きます。
メニューから自動化 > Delugeエディタへ進みます（Fillable、Merge、Signテンプレートで利用可能）。
画面右上の外部連携をクリックします。

Connectionを作成する:

「外部連携に移動する > Connection作成」をクリックします。
「初期設定サービス」タブで:

希望するサービスを選択します。
「Connection作成」をクリックします。

Connection詳細の入力:

Connection 名前: 参照時に表示される名前です。
外部連携のリンク名: Delugeスクリプト内で使用される一意の識別子です。

先頭は必ず小文字で始めてください。
使用できるのは小文字、数字、アンダースコア（_）のみです。
最大50文字まで設定できます。

Scope(OAuth2の場合)：サービスのAPIドキュメントに従い指定してください。

「作成して接続」をクリック：

サービスの認証を行います。
接続済みの外部連携はMy 外部連携に表示されます。

B. カスタムサービスの場合（OAuth2認証）

外部連携ページを開く：

Deluge Editor > 外部連携 > 外部連携に移動します。

カスタムサービスを作成します：

カスタムサービス > 新規作成サービスへ移動します。
以下を入力します：

サービス名前：表示名（最大50文字）
サービスリンク名前：一意の識別子（小文字、英数字、アンダースコアのみ）

Authentication種類を選択します：

OAuth2 を選択します。

OAuth2 詳細を入力します：

Grant 種類: 次のいずれかを選択します Authorization コードまたはClient Credentials。
クライアントID & シークレット: サービスより提供されます。
認証 URL、Access Token URL、更新する Token URL: API 文書に従って設定してください。
パラメーターの種類: パラメーターの渡し方（クエリ文字列／ヘッダー）。
Scope Delimiter: 初期設定はカンマですが、スペースまたはプラスもサポートされています。

Zoho コールバック URL をサードパーティアプリに登録してください:

［作成サービス］をクリックします:

カスタムサービスが保存されます。

Connection 詳細を入力します:

初期設定サービスの手順と同様です:

Connection 名前
外部連携のリンク名
Scopes（必要な場合）

［作成 and 接続］をクリックします:

認証を行い、Connectionの設定を完了します。

Connectionが「My 外部連携」に表示されます。

トラブルシューティング

1. エラー／症状:Deluge EditorがWriter ドキュメントに表示されない
考えられる原因:サポートされているテンプレート（Merge、Fillable、またはSign）を使用していません。
推奨される解決策:Zoho Writerのサポートされている自動化テンプレート内で作業していることを確認してください。

2. エラー/症状：OAuth2接続設定が失敗する、またはエラーが発生する
考えられる原因：クライアントID、クライアントシークレットが誤っている、またはcallback URLが未設定もしくは無効です。
推奨される解決策：認証情報を再度確認し、callback URLが第三者サービスの開発者コンソールで正しく登録されているかご確認ください。

3. エラー/症状：スコープに関連する認証エラー
考えられる原因：必須スコープが不足している、または書式が誤っています。
推奨される解決策：第三者APIのドキュメントを参照し、正確なスコープと正しい区切り文字（カンマ、スペース、プラス記号など）を使用してください。

4. エラー/症状：接続作成時に「リンク名前 already 既存」エラーが発生
考えられる原因：指定された外部連携のリンク名が一意ではありません。
推奨される解決策：新規で一意のリンク名（小文字、英数字、アンダースコア、最大50文字）を命名規則に従って設定してください。

5. エラー/症状：「マイ外部連携」に接続が表示されているが、関数内でデータ取得が失敗する

考えられる原因:接続が正しく認証済みでない、またはスコープが不十分です。

推奨される解決方法:正しいスコープと認証が成功していることを確認し、接続を再作成してください。

よくある質問

Q1: 同じ接続を複数のカスタム関数で使用することはできますか？
はい、一度接続が作成されると、ドキュメントや関数間で再利用できます。

Q2: スコープを忘れた場合はどうなりますか？
スコープが必須で未指定の場合、認証は失敗します。必ずサービスのAPIドキュメントを参照してください。

Q3: スコープの区切り文字は何を使用すればよいですか？
初期設定ではカンマ（,）が使用中です。APIで別の形式（スペースやプラス）が必要な場合は、Scope Delimiter項目で指定してください。

Q4: 作成後に接続を編集できますか？

既存の接続は変更できません。パラメータを変更する場合は、新しい外部連携を作成してください。