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」>「Connections」頁面，然後選取或建立 Google Cloud 專案。

    前往「連線」頁面

  2. 按一下「+ 建立新連線」，開啟「建立連線」頁面。
  3. 在「位置」部分中，選擇連線的位置。
    1. 區域：從下拉式清單中選取位置。

      如需所有支援區域的清單，請參閱「地點」一文。

    2. 點按「下一步」。
  4. 在「連線詳細資料」部分，完成下列步驟：
    1. 連接器：從可用連接器的下拉式清單中選取「DocuSign」。
    2. 連接器版本：從可用版本的下拉式清單中選取連接器版本。
    3. 在「連線名稱」欄位中，輸入連線執行個體的名稱。

      連線名稱必須符合下列條件：

      • 連線名稱可使用英文字母、數字或連字號。
      • 字母必須為小寫。
      • 連線名稱開頭須為英文字母，結尾則須為英文字母或數字。
      • 連結名稱不得超過 49 個半形字元。
    4. 視需要輸入連線執行個體的「Description」(說明)。
    5. 或者，可啟用 Cloud Logging，然後選取記錄層級。記錄層級預設為 Error。
    6. 服務帳戶：選取具備必要角色的服務帳戶。
    7. 如果您使用 DocuSign 沙箱帳戶，可以選取「UseSandbox」UseSandbox。
    8. 視需要設定「連線節點設定」：

      • 節點數下限：輸入連線節點的數量下限。
      • 節點數上限：輸入連線節點數上限。

      節點是用來處理交易的連線單位 (或備用資源)。如要處理更多連線交易，就需要更多節點；反之，如要處理較少的交易，則需要較少的節點。如要瞭解節點對連線器價格的影響，請參閱「 連線節點的定價」。如未輸入任何值，系統預設會將節點下限設為 2 (提高可用性)，節點上限則設為 50。

    9. (選用) 按一下「+ 新增標籤」，以鍵/值組合的形式為連線新增標籤。
    10. 點按「下一步」。
  5. 在「Authentication」(驗證) 部分，輸入驗證詳細資料。
    1. 選取「驗證類型」，然後輸入相關詳細資料。

      DocuSign 連線支援下列驗證類型：

      • OAUTH 2.0 - 授權碼
      • OAuth 2.0 - JWT 持有者

      2. 如要瞭解如何設定這些驗證類型，請參閱「設定驗證」。

    2. 點按「下一步」。
  6. 檢查：檢查連結和驗證詳細資料。
  7. 點選「建立」。

設定驗證機制

根據要使用的驗證方式輸入詳細資料。

  • OAUTH 2.0 - 授權碼
    • 用戶端 ID：用於要求存取權杖的用戶端 ID。
    • 範圍：以半形逗號分隔的所需範圍清單。
    • 用戶端密鑰：Secret Manager 密鑰，內含您建立的已連結應用程式用戶端密鑰。
    • 授權網址：輸入授權網址，例如正式版帳戶的 https://account.docusign.com/oauth/auth 或沙箱帳戶的 https://account-d.docusign.com/oauth/auth。
  • OAuth 2.0 - JWT 持有者
    • 連結應用程式的用戶端金鑰：為您建立的連結應用程式提供的用戶端金鑰。
    • 使用者名稱：與您建立的連結應用程式相關聯的使用者名稱。
    • 私密金鑰：Secret Manager 密鑰，內含私密金鑰檔案的內容。私密金鑰應與提供給連線器的公開金鑰/憑證相符。

連線設定範例

本節列出您在建立連線時設定的各個欄位範例值。

OAUTH 2.0 - 授權碼連線類型

欄位名稱 詳細資料
位置 us-central1
連接器 DocuSign
連接器版本 1
連線名稱 gcp-docusign-new-auth
啟用 Cloud Logging 否
UseSandbox 是
服務帳戶 123456789012-compute@developer.gserviceaccount.com
驗證 OAuth 2.0 - 授權碼
用戶端 ID 67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
範圍 簽名
用戶端密鑰 CLIENT_SECRET
Secret 版本 1
授權網址 https://account-d.docusign.com/oauth/auth

OAuth 2.0 - JWT 不記名憑證連線類型

欄位名稱 詳細資料
位置 us-central1
連接器 DocuSign
連接器版本 1
連線名稱 gcp-docusign-token
啟用 Cloud Logging 否
UseSandbox 是
服務帳戶 123456789012-compute@developer.gserviceaccount.com
驗證 OAuth 2.0 - JWT 持有者
連結的應用程式消費者金鑰 67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
使用者名稱 USER_NAME
私密金鑰 PRIVATE_KEY
Secret 版本 1

實體、作業和動作

所有整合連接器都會為所連應用程式的物件提供抽象層。您只能透過這個抽象化存取應用程式的物件。抽象化會以實體、作業和動作的形式呈現。

  • 實體： 實體可以視為已連結應用程式或服務中的物件，或是屬性集合。實體的定義與連接器對連接器不同。舉例來說，在資料庫連接器中，資料表是實體；在檔案伺服器連接器中，資料夾是實體；在訊息系統連接器中，佇列是實體。

    不過，連接器可能不支援或沒有任何實體，在這種情況下，Entities 清單會是空白。

  • 作業： 作業是指您可以在實體上執行的活動。您可以對實體執行下列任一操作：

    從可用清單中選取實體，系統會產生該實體可用的作業清單。如需作業的詳細說明，請參閱連線器工作中的實體作業。 不過，如果連接器不支援任何實體作業，Operations 清單就不會列出這類不支援的作業。

  • 動作： 動作是透過連接器介面提供給整合的第一類函式。動作可讓您變更一或多個實體，且因連接器而異。一般來說，動作會有一些輸入參數和輸出參數。不過，連接器可能不支援任何動作，此時 Actions 清單會是空白。

系統限制

DocuSign 連接器每秒可處理 3 筆交易，每個節點每秒可處理 3 筆交易，並節流任何超出此限制的交易。根據預設，Integration Connectors 會為連線分配 2 個節點 (提高可用性)。

如要瞭解 Integration Connectors 適用的限制，請參閱「限制」一文。

動作

本節列出 DocuSign 連線支援的所有動作。

CreateAndSendEnvelope 動作

建立及傳送信封，或建立信封草稿。

CreateAndSendEnvelope 動作的輸入參數

參數名稱 資料類型 必填 說明
FileName 字串 是 文件名稱。
DocumentId 字串 是 文件的 ID。
EmailSubject 字串 是 電子郵件主旨行。
內容 字串 是 檔案內容。
SignersEmail 字串 否 文件簽署者的電子郵件 ID。
SignersRecipientId 字串 否 簽署者的收件者 ID。
CcRecipientId 字串 否 電子郵件中副本收件者的收件者 ID。
CcEmail 字串 否 電子郵件副本收件者的電子郵件 ID。
狀態 字串 否 信封的狀態。將狀態設為「已傳送」，即可將信封傳送給收件者。
CustomFieldAggregate 字串 否 您可以使用下列欄位：CustomFieldName、CustomFieldId、CustomFieldShow、CustomFieldRequired、CustomFieldValue、CustomFieldConfiguration 和 CustomFieldListItems。
SignersName 字串 否 文件簽署者的姓名。
CcName 字串 否 副本收件者的名稱。

如要瞭解如何設定 CreateAndSendEnvelope 動作，請參閱「範例」。

動作範例

本節說明如何在這個連接器中執行部分動作。

範例 - CreateAndSendEnvelope

這項動作會建立並傳送郵件，或建立郵件草稿。

  1. 在 Configure connector task 對話方塊中，按一下 Actions。
  2. 選取「CreateAndSendEnvelope」動作，然後按一下「完成」。
  3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：
    {
"EmailSubject": "Please Sign this Document",
"FileName": "test.txt\ntest.pdf",
"SignersEmail": "cloudysanfrancisco@gmail.com",
"SignersRecipientId": "53386460",
"CcRecipientId": "67173451",
"CcEmail": "baklavainthebalkans@gmail.com",
"DocumentId": "1",
"Status": "sent",
"CustomFieldAggregate": "CustomFieldName",
"ContentBytes": "abcd***",
"HasBytes": true,
"SignersName": "\"test\"",
"CcName": "\"test\"",
"Content": "test content in file"
}
    4. 如果動作成功，連接器工作 connectorOutputPayload 回應參數的值會類似於下列內容：

     [{
"Success":"true",
"envelopeid":"542a77ff-b533-4b39-9d82-e397ef5a70c9",
"uri":"/envelopes/542a77ff-b533-4b39-9d82-e397ef5a70c9",
"statusdatetime":"2025-04-09T12:33:47.1130000Z",
"status":"sent",
"customfieldaggregate": "CustomFieldName"
}]

實體作業範例

本節說明如何在這個連接器中執行部分實體作業。

實體 ID 的值應直接傳遞，例如 16ab549b-95d7-47cb-b557-c2476ef62d9d。ID 16ab549b-95d7-47cb-b557-c2476ef62d9d 是必須傳遞的唯一主鍵值。

範例 - 實體「帳戶」的 LIST 作業

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取「帳戶」。
  3. 選取 LIST 作業，然後按一下「完成」。
  4. 在「連結器」工作的「工作輸入」部分，您可以根據需求設定 filterClause。

範例 - 實體「文件」的 LIST 作業

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取「文件」。
  3. 選取 LIST 作業，然後按一下「完成」。
  4. 在「連結器」工作的「工作輸入」部分，您可以根據需求設定 filterClause。

範例 - 實體「信封」的 LIST 作業

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取「信封」。
  3. 選取 LIST 作業，然後按一下「完成」。
  4. 在「連結器」工作的「工作輸入」部分，您可以根據需求設定 filterClause。

範例 - 實體「Folders」的 LIST 作業

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取「資料夾」。
  3. 選取 LIST 作業，然後按一下「完成」。
  4. 在「連結器」工作的「工作輸入」部分，您可以根據需求設定 filterClause。

範例 - 實體「群組」的 LIST 作業

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取「群組」。
  3. 選取 LIST 作業，然後按一下「完成」。
  4. 在「連結器」工作的「工作輸入」部分，您可以根據需求設定 filterClause。

範例 - 實體「使用者」的 LIST 作業

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取「使用者」。
  3. 選取 LIST 作業，然後按一下「完成」。
  4. 在「連結器」工作的「工作輸入」部分，您可以根據需求設定 filterClause。

您也可以對下列實體執行 LIST 作業：

  • UserInfo
  • UserSignatures
  • 工作區
  • 收件者
  • AccountBrands
  • AccountCustomFields
  • EnvelopeTemplates
  • EnvelopeAttachments
  • EnvelopeConsumerDisclosures
  • CloudStorageProviders
  • CustomTabs
  • 門鎖
  • GroupBrands
  • GroupUsers
  • PowerForms
  • RecipientTabs
  • SigningGroups
  • SigningGroupUsers
  • 範本

範例 - 取得「帳戶」實體的單一記錄

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取「帳戶」。
  3. 選取 GET 作業，然後按一下「完成」。
  4. 如要設定實體 ID，請在「資料對應」的「資料對應器」部分，按一下「開啟資料對應編輯器」，然後在「輸入值」欄位中輸入 2.4578824E7，並選擇 EntityId 做為本機變數。

範例 - 取得「文件」實體的單一記錄

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取「文件」。
  3. 選取 LIST 作業，然後按一下「完成」。
  4. 如要設定篩選子句，請在「資料對應」的「資料對應器」專區中，按一下「開啟資料對應編輯器」，然後在「輸入值」欄位中輸入 Type='envelopes' AND Id='8e18be14-3254-4cbe-947d-f0d1cd62f5f8'，並選擇篩選子句做為本機變數。

範例 - 取得「信封」實體的單一記錄

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取「信封」。
  3. 選取 GET 作業，然後按一下「完成」。
  4. 如要設定實體 ID，請在「資料對應」的「資料對應器」部分，按一下「開啟資料對應編輯器」，然後在「輸入值」欄位中輸入 8e18be14-3254-4cbe-947d-f0d1cd62f5f87，並選擇 EntityId 做為本機變數。

範例 - 取得「資料夾」實體的單一記錄

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取「資料夾」。
  3. 選取 GET 作業，然後按一下「完成」。
  4. 如要設定實體 ID，請在「資料對應」的「資料對應器」部分，按一下「開啟資料對應編輯器」，然後在「輸入值」欄位中輸入 05f76d13-a513-492b-8c58-176702768db0，並選擇 EntityId 做為本機變數。

範例 - 取得「群組」實體的單一記錄

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取「群組」。
  3. 選取 GET 作業，然後按一下「完成」。
  4. 如要設定實體 ID，請在「資料對應」的「資料對應器」部分，按一下「開啟資料對應編輯器」，然後在「輸入值」欄位中輸入 1.4167231E7，並選擇 EntityId 做為本機變數。

範例 - 取得「使用者」實體的單一記錄

  1. 在 Configure connector task 對話方塊中，按一下 Entities。
  2. 從 Entity 清單中選取「使用者」。
  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 否 選取這個核取方塊，即可為連線設定 Proxy 伺服器。
proxy_auth_scheme ENUM 否 用來向 ProxyServer 代理伺服器驗證的驗證類型。支援的值包括：BASIC、DIGEST、NONE
proxy_user STRING 否 用於向 ProxyServer 代理程式驗證的使用者名稱。
proxy_password SECRET 否 用於向 ProxyServer Proxy 驗證身分的密碼。

在整合服務中使用 DocuSign 連線

建立連線後，Apigee Integration 和 Application Integration 都會提供該連線。您可以在整合中透過「連接器」工作使用連線。

  • 如要瞭解如何在 Apigee Integration 中建立及使用連接器工作，請參閱「連接器工作」。
  • 如要瞭解如何在 Application Integration 中建立及使用連接器工作，請參閱「連接器工作」。

向 Google Cloud 社群尋求協助

如要發布問題及討論這個連接器，請前往 Cloud 論壇的 Google Cloud 社群。

後續步驟