DelugeによるZoho Writerでの接続の作成

DelugeによるZoho Writerでの接続の作成

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

概要   

Zoho WriterのDeluge外部連携では、認証プロトコルを使用して外部サービスと安全に連携できます。これらの外部連携をカスタム関数で使用すると、プラットフォーム間でデータを取得、送信でき、高度な自動化や処理フローのカスタマイズが可能になります。

標準またはカスタムのサービスを使用して外部アプリケーションのデータを連携しながら、Zoho Writerで文書をシームレスに編集し、リアルタイムで共同編集できます。

これらの外部連携では、次の操作を実行できます。
  • 外部サービスのリアルタイムデータをWriterの文書に直接取得します。
  • Writerの文書やデータをサードパーティーのプラットフォームに送信します。たとえば、差し込み文書をGoogle ドライブに自動でアップロードできます。

前提条件   

Zoho Writerで外部連携を作成する前に、次の点を確認してください。
  • Zoho Writerへのアクセス権限が必要です。
  • いずれかの自動化テンプレート(差し込み、項目入力、署名)を使用していることを確認してください。
  • OAuth2のカスタムサービスを使用する場合は、次の点を確認してください。
    • サードパーティーサービスから、クライアントID、クライアントシークレット、APIのURL(認可、アクセストークン、更新トークン)を取得します。
    • 必要なスコープと、サポートされている付与形式(認証コードまたはクライアント認証情報)を確認します。
    • サードパーティーアプリに正しいZohoコールバックURLを登録してください。

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

 A. 標準サービスの場合   

  1. Zoho WriterでDeluge編集画面にアクセスします。
    • 対象の文書を開きます。
    • メニューから[自動化→Deluge編集画面]に移動します(項目入力、差し込み、署名の各テンプレートで利用できます)。
    • 画面右上の[外部連携]をクリックします。

  1. 外部連携の作成。
    • [外部連携に移動する]→[外部連携を作成]をクリックします
    • [初期設定のサービス]タブで、次の操作を行います。
      • 目的のサービスを選択します。
      • [外部連携を作成]をクリックします
  1. 外部連携の詳細の入力。
    • [外部連携名]:参照用の表示名です。
    • [外部連携のリンク名]:Delugeスクリプトで使用する一意の識別子です。
      • 先頭は小文字にする必要があります。
      • 使用できるのは、小文字、数字、アンダースコア(_)のみです。
      • 最大50文字です。
    • [スコープ](OAuth2の場合):サービスのAPIドキュメントに従って指定します。
  1. [作成して接続]をクリックします。
    • サービスを認証します。
    • 作成した外部連携が[自分の外部連携]に表示されます。

 B. カスタムサービスの場合(OAuth2認証)   

  1. 外部連携ページを開きます。
    • [Delugeエディター]→[外部連携]→[外部連携に移動する]に移動します
  1. カスタムサービスの作成。
    • [カスタムサービス]→[新規サービスを作成]に移動します
    • 次の情報を入力します。
      • [サービス名]:表示名です(最大50文字)。
      • [サービスのリンク名]:一意の識別子です(小文字の英字、数字、アンダースコアを使用できます)。
  1. 認証の種類の選択。
    • [OAuth2]を選択します
  1. OAuth2の詳細の入力。
    • [グラントタイプ][認可コード]または[クライアント認証情報]から選択します。
    • [クライアントIDとシークレット]:サービスから提供される情報です。
    • [認可URL、アクセストークンURL、リフレッシュトークンURL]:APIドキュメントに従って指定します。
    • [パラメーターの種類]:パラメーターの受け渡し方法です(クエリー文字列/ヘッダー)。
    • [スコープの区切り文字]:初期設定はコンマですが、スペースまたはプラス記号も使用できます。
  1. ZohoコールバックURLをサードパーティーアプリに登録します。
  1. US: https://dre.zoho.com/delugeauth/callback
  2. EU: https://dre.zoho.eu/delugeauth/callback
  3. CN: https://dre.zoho.com.cn/delugeauth/callback
  4. IN: https://dre.zoho.in/delugeauth/callback
  5. AU: https://dre.zoho.com.au/delugeauth/callback
  6. JP: https://dre.zoho.jp/delugeauth/callback
  7. SA: https://dre.zoho.sa/delugeauth/callback
  8. CA: https://dre.zohocloud.ca/delugeauth/callback
  1. [サービスを作成]をクリックします
    • カスタムサービスが保存されます。
  1. 外部連携の詳細を入力します。
    • 初期設定のサービスと同じ手順です。
      • [外部連携名]
      • [外部連携のリンク名]
      • [スコープ](必要な場合)
  1. [作成して接続]をクリックします
    • 外部連携を認証して、設定を完了します。
  1. 外部連携が[自分の外部連携]に表示されます。

トラブルシューティング   

1. エラー/症状:Writerの文書にDelugeエディターが表示されない
考えられる原因:対応しているテンプレート(差し込み、項目入力、署名)を使用していません。
推奨される対処方法:Zoho Writerで、対応しているいずれかの自動化テンプレートを使用していることを確認してください。

2. エラー/症状:OAuth2の外部連携の設定に失敗する、またはエラーが発生する
考えられる原因:クライアントIDまたはクライアントシークレットが正しくないか、コールバックURLが設定されていない、または無効です。
推奨される対処方法:認証情報を再確認し、外部サービスの開発者コンソールにコールバックURLが正しく登録されていることを確認してください。

3. エラー/症状:スコープに関連する認証の失敗
考えられる原因:必要なスコープが指定されていないか、書式が正しくありません。
推奨される対処方法:外部サービスのAPIドキュメントで正しいスコープを確認し、適切な区切り文字(コンマ、スペース、またはプラス記号)を使用してください。

4. エラー/症状:外部連携の作成時に「リンク名はすでに存在します」というエラーが発生する
考えられる原因:入力した外部連携のリンク名が一意ではありません。
推奨される対処方法:命名規則(小文字の英数字とアンダースコア、最大50文字)に従った、新規かつ一意のリンク名を使用してください。

5. エラー/症状:[自分の外部連携]に外部連携が表示されるが、関数でのデータ取得に失敗する
考えられる原因:外部連携が正しく認証されていないか、スコープが不足しています。
推奨される対処方法:正しいスコープを指定して認証が正常に完了することを確認し、外部連携を再作成してください。

よくある質問   

Q1:同じ外部連携を複数のカスタム関数で使用できますか?
はい。作成した外部連携は、複数の文書や関数で再利用できます。

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

Q3:スコープにはどの区切り文字を使用すればよいですか?
初期設定では、コンマ(,)が使用されます。APIで別の書式(スペースまたはプラス記号)が必要な場合は、[スコープの区切り文字]項目で指定してください。

Q4:作成後に外部連携を編集できますか?
既存の外部連携は変更できません。パラメーターを変更するには、新規の外部連携を作成する必要があります。