DocuSign

DocuSign コネクタを使用して、DocuSign で読み取りオペレーションを実行します。

始める前に

DocuSign コネクタを使用する前に、次の作業を行います。

  • Google Cloud プロジェクトで次の操作を行います。
    • ネットワーク接続が設定されていることを確認します。ネットワーク パターンの詳細については、ネットワーク接続をご覧ください。
    • コネクタを構成するユーザーに roles/connectors.admin IAM ロールを付与します。
    • コネクタに使用するサービス アカウントに、次の IAM ロールを付与します。
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      サービス アカウントは特別なタイプの Google アカウントで、Google API のデータにアクセスするのに認証を受ける必要がある人間以外のユーザーを表します。サービス アカウントがない場合は、サービス アカウントを作成する必要があります。詳細については、サービス アカウントを作成するをご覧ください。

    • 次のサービスを有効にします。
      • secretmanager.googleapis.com（Secret Manager API）
      • connectors.googleapis.com（Connectors API）

      サービスを有効にする方法については、サービスを有効にするをご覧ください。

    以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。

コネクタを構成する

コネクタを構成するには、データソース（バックエンド システム）への接続を作成する必要があります。接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。

  1. Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。

    [接続] ページに移動

  2. [+ 新規作成] をクリックして [接続の作成] ページを開きます。
  3. [ロケーション] セクションで、接続のロケーションを選択します。
    1. リージョン: プルダウン リストからロケーションを選択します

      サポートされているすべてのリージョンのリストについては、ロケーションをご覧ください。

    2. [NEXT] をクリックします。
  4. [接続の詳細] セクションで、次の操作を行います。
    1. コネクタ: 使用可能なコネクタのプルダウン リストから [DocuSign] を選択します。
    2. コネクタのバージョン: 使用可能なバージョンのプルダウン リストからコネクタのバージョンを選択します。
    3. [接続名] フィールドに、接続インスタンスの名前を入力します。

      接続名は次の条件を満たす必要があります。

      • 接続名には英字、数字、ハイフンを使用できます。
      • 文字は小文字のみを使用できます。
      • 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
      • 接続名は 49 文字以内で指定してください。
    4. 必要に応じて、接続インスタンスの [説明] を入力します。
    5. 必要に応じて、Cloud Logging を有効にして、ログレベルを選択します。デフォルトのログレベルは Error に設定されています。
    6. サービス アカウント: 必要なロールを持つサービス アカウントを選択します。
    7. DocuSign サンドボックス アカウントを使用している場合は、必要に応じて [UseSandbox] を選択します。
    8. 必要に応じて、接続ノードの設定を構成します。

      • ノードの最小数: 接続ノードの最小数を入力します。
      • ノードの最大数: 接続ノードの最大数を入力します。

      ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。

    9. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
    10. [NEXT] をクリックします。
  5. [認証] セクションで、認証の詳細を入力します。
    1. [認証タイプ] を選択し、関連する詳細を入力します。

      DocuSign 接続でサポートされる認証タイプは次のとおりです。

      • OAUTH 2.0 - 認証コード
      • OAuth 2.0 - JWT Bearer

      2. これらの認証タイプの構成方法については、認証を構成するをご覧ください。

    2. [NEXT] をクリックします。
  6. Review: 接続と認証の詳細を確認します。
  7. [作成] をクリックします。

認証を構成する

使用する認証に基づいて詳細を入力します。

  • OAUTH 2.0 - 認証コード
    • クライアント ID: アクセス トークンのリクエストに使用されるクライアント ID。
    • スコープ: 必要なスコープのカンマ区切りのリスト。
    • クライアント シークレット: 作成した接続されているアプリのクライアント シークレットを含む Secret Manager のシークレットです。
  • OAuth 2.0 - JWT Bearer
    • 接続されているアプリ コンシューマ キー:作成した接続されているアプリに提供されたコンシューマ キー。
    • ユーザー名作成した接続 App に関連付けられているユーザー名。
    • 秘密鍵: 秘密鍵ファイルの内容を格納する Secret Manager のシークレット。秘密鍵は、コネクタに提供された公開鍵 / 証明書と一致する必要があります。

接続構成のサンプル

このセクションでは、接続の作成時に構成するさまざまなフィールドのサンプル値を示します。

OAuth 2.0 - 認証コードの接続タイプ

フィールド名 詳細
場所 us-central1
コネクタ DocuSign
コネクタのバージョン 1
接続名 gcp-docusign-new-auth
Cloud Logging を有効にする ×
UseSandbox ○
サービス アカウント SERVICE_ACCOUNT_NAME@developer.gserviceaccount.com
認証 OAuth 2.0 - 認証コード
クライアント ID 67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
スコープ signature
クライアント シークレット CLIENT_SECRET
シークレット バージョン 1

OAuth 2.0 - JWT Bearer 接続タイプ

フィールド名 詳細
場所 us-central1
コネクタ DocuSign
コネクタのバージョン 1
接続名 gcp-docusign-token
Cloud Logging を有効にする ×
UseSandbox ○
サービス アカウント SERVICE_ACCOUNT_NAME@developer.gserviceaccount.com
認証 OAuth 2.0 - JWT Bearer
接続されているアプリのコンシューマ キー 67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
ユーザー名 USER_NAME
秘密鍵 PRIVATE_KEY
シークレット バージョン 1

エンティティ、オペレーション、アクション

すべての Integration Connectors が、接続されたアプリケーションのオブジェクトを抽象化するレイヤを提供します。アプリケーションのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化は、エンティティ、オペレーション、アクションとして公開されます。

  • エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベース コネクタでは、テーブルがエンティティであり、ファイル サーバー コネクタでは、フォルダがエンティティです。また、メッセージング システム コネクタでは、キューがエンティティです。

    ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、Entities リストは空になります。

  • オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。

    使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティ オペレーションをご覧ください。ただし、コネクタがいずれかのエンティティ オペレーションをサポートしていない場合、サポートされていないオペレーションは Operations リストに含まれません。

  • アクション: コネクタ インターフェースを介して統合で使用できる主要な関数の一つです。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。通常、アクションには入力パラメータと出力パラメータがあります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。

システムの上限

DocuSign コネクタは、ノードごとに 1 秒あたり 3 件のトランザクションを処理することができ、この上限を超えるトランザクションはすべてスロットルされます。デフォルトでは、Integration Connectors は、接続に 2 つのノードを割り当てます（可用性を高めるため）。

Integration Connectors に適用される上限の詳細については、上限をご覧ください。

エンティティ オペレーションの例

このセクションでは、このコネクタでエンティティ オペレーションの一部を実行する方法について説明します。

エンティティ ID の値は直接渡す必要があります（16ab549b-95d7-47cb-b557-c2476ef62d9d など）。ID 16ab549b-95d7-47cb-b557-c2476ef62d9d は、渡す必要がある一意の主キー値です。

例 - エンティティ「Accounts」の LIST オペレーション

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから [Accounts] を選択します。
  3. [LIST] オペレーションを選択してから、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、要件に応じて filterClause を設定できます。

例 - エンティティ「Documents」の LIST オペレーション

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから [Documents] を選択します。
  3. [LIST] オペレーションを選択してから、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、要件に応じて filterClause を設定できます。

例 - エンティティ「Envelopes」の LIST オペレーション

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから [Envelopes] を選択します。
  3. [LIST] オペレーションを選択してから、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、要件に応じて filterClause を設定できます。

例 - エンティティ「Folders」の LIST オペレーション

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから Folders を選択します。
  3. [LIST] オペレーションを選択してから、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、要件に応じて filterClause を設定できます。

例 - エンティティ「Groups」の LIST オペレーション

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから [Groups] を選択します。
  3. [LIST] オペレーションを選択してから、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、要件に応じて filterClause を設定できます。

例 - エンティティ「Users」の LIST オペレーション

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから [Users] を選択します。
  3. [LIST] オペレーションを選択してから、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、要件に応じて filterClause を設定できます。

LIST オペレーションは、次のエンティティに対しても実行できます。

  • UserInfo
  • UserSignatures
  • ワークスペース
  • 受信者
  • AccountBrands
  • AccountCustomFields
  • EnvelopeTemplates
  • EnvelopeAttachments
  • EnvelopeConsumerDisclosures
  • CloudStorageProviders
  • CustomTabs
  • ロック
  • GroupBrands
  • GroupUsers
  • PowerForms
  • RecipientTabs
  • SigningGroups
  • SigningGroupUsers
  • テンプレート

例 - エンティティ「Accounts」の単一レコードを取得する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから [Accounts] を選択します。
  3. [GET] オペレーションを選択してから、[完了] をクリックします。
  4. エンティティ ID を設定するには、[データ マッピング] の [データ マッパー] セクションで [データ マッピング エディタを開く] をクリックし、[入力値] フィールドに 2.4578824E7 を入力し、EntityId をローカル変数として選択します。

例 - エンティティ「Documents」の単一レコードを取得する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから [Documents] を選択します。
  3. [LIST] オペレーションを選択してから、[完了] をクリックします。
  4. フィルタ句を設定するには、[データ マッピング] の [データ マッパー] セクションで [データ マッピング エディタを開く] をクリックし、[入力値] フィールドに Type='envelopes' AND Id='8e18be14-3254-4cbe-947d-f0d1cd62f5f8' を入力し、フィルタ句をローカル変数として選択します。

例 - エンティティ「Envelopes」の単一レコードを取得する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから [Envelopes] を選択します。
  3. [GET] オペレーションを選択してから、[完了] をクリックします。
  4. エンティティ ID を設定するには、[データ マッピング] の [データ マッパー] セクションで [データ マッピング エディタを開く] をクリックし、[入力値] フィールドに 8e18be14-3254-4cbe-947d-f0d1cd62f5f87 を入力し、EntityId をローカル変数として選択します。

例 - エンティティ「Folders」の単一レコードを取得する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから Folders を選択します。
  3. [GET] オペレーションを選択してから、[完了] をクリックします。
  4. エンティティ ID を設定するには、[データ マッピング] の [データ マッパー] セクションで [データ マッピング エディタを開く] をクリックし、[入力値] フィールドに 05f76d13-a513-492b-8c58-176702768db0 を入力し、EntityId をローカル変数として選択します。

例 - エンティティ「Groups」の単一レコードを取得する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから [Groups] を選択します。
  3. [GET] オペレーションを選択してから、[完了] をクリックします。
  4. エンティティ ID を設定するには、[データ マッピング] の [データ マッパー] セクションで [データ マッピング エディタを開く] をクリックし、[入力値] フィールドに 1.4167231E7 を入力し、EntityId をローカル変数として選択します。

例 - エンティティ「Users」の単一レコードを取得する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから [Users] を選択します。
  3. [GET] オペレーションを選択してから、[完了] をクリックします。
  4. エンティティ ID を設定するには、[データ マッピング] の [データ マッパー] セクションで [データ マッピング エディタを開く] をクリックし、[入力値] フィールドに 16ab549b-95d7-47cb-b557-c2476ef62d9d を入力し、EntityId をローカル変数として選択します。

GET オペレーションは、次のエンティティに対しても実行できます。

  • UserInfo
  • UserSignatures
  • ワークスペース
  • 受信者
  • AccountBrands
  • AccountCustomFields
  • EnvelopeTemplates
  • EnvelopeAttachments
  • EnvelopeConsumerDisclosures
  • CloudStorageProviders
  • CustomTabs
  • ロック
  • GroupBrands
  • GroupUsers
  • RecipientTabs
  • SigningGroups
  • SigningGroupUsers
  • テンプレート

Terraform を使用して接続を作成する

Terraform リソースを使用して、新しい接続を作成できます。

Terraform 構成を適用または削除する方法については、基本的な Terraform コマンドをご覧ください。

接続作成用の Terraform テンプレートのサンプルを表示するには、サンプル テンプレートをご覧ください。

Terraform を使用してこの接続を作成する場合は、Terraform 構成ファイルで次の変数を設定する必要があります。

パラメータ名 データ型 必須 説明
proxy_enabled BOOLEAN False 接続用のプロキシ サーバーを構成するには、このチェックボックスをオンにします。
proxy_auth_scheme ENUM False ProxyServer プロキシへの認証に使用する認証タイプです。サポートされている値は、BASIC、DIGEST、NONE です。
proxy_user STRING False ProxyServer プロキシへの認証に使用されるユーザー名です。
proxy_password SECRET False ProxyServer プロキシの認証に使用されるパスワード。

統合で DocuSign 接続を使用する

接続を作成すると、Apigee Integration と Application Integration の両方で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。

  • Apigee Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
  • Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。

Google Cloud コミュニティの助けを借りる

Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。

次のステップ