SendGrid

透過 SendGrid 連接器,您可以對 SendGrid 資料集執行插入、刪除、更新和讀取作業。

事前準備

使用 SendGrid 連接器前,請先完成下列工作:

  • 在 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)

      如要瞭解如何啟用服務,請參閱「啟用服務」。

    如果專案先前未啟用這些服務或權限,系統會在設定連結器時提示您啟用。

使用 API 金鑰設定驗證

  1. 前往「設定」,然後選取「API 金鑰」
  2. 按一下「建立 API 金鑰」
  3. 輸入 API 金鑰名稱
  4. 選取「完整存取權」、「有限的存取權」或「帳單存取權」選項
  5. 選取「受限制的存取權」或「帳單存取權」,然後為每個類別選取特定權限。
  6. 按一下「建立並查看」
  7. 複製 API 金鑰並加以儲存,以供日後使用。

設定連接器

連線專屬於資料來源。也就是說,如果您有多個資料來源,則必須為每個資料來源建立個別的連線。如要建立連線,請按照下列步驟操作:

  1. Cloud 控制台中,前往「Integration Connectors」>「Connections」頁面,然後選取或建立 Google Cloud 專案。

    前往「連線」頁面

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

      如需所有支援的地區清單,請參閱「位置」一文。

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

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

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

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

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

    8. 選用:按一下「+ 新增標籤」,以鍵/值組合的形式為連線新增標籤。
    9. 點按「下一步」
  5. 在「Authentication」(驗證) 部分中,輸入驗證詳細資料。 詳情請參閱「設定驗證」。|
  6. 點按「下一步」
  7. 檢查:檢查連線和驗證詳細資料。
  8. 點選「建立」

設定驗證機制

  • API 金鑰驗證
    • API 金鑰:選取 API 金鑰的 Secret Manager 密鑰。
    • 密鑰版本:選取密鑰版本。
  • 連線設定範例

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

    網路連線類型

    欄位名稱 詳細資料
    位置 us-central1
    連接器 Sendgrid
    連接器版本 1
    連線名稱 sendgrid-google-cloud-conn
    服務帳戶 SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
    節點數量下限 2
    節點數量上限 50
    API 金鑰 API_KEY
    Secret 版本 1

    實體、作業和動作

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

    • 實體: 實體可以視為已連結應用程式或服務中的物件,或是屬性集合。實體的定義因連接器而異。舉例來說,在資料庫連接器中,資料表是實體;在檔案伺服器連接器中,資料夾是實體;在訊息系統連接器中,佇列是實體。

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

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

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

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

    系統限制

    SendGrid 連接器每秒可處理 8 筆交易,每個節點皆是如此,且會節流任何超出此限制的交易。根據預設,Integration Connectors 會為連線分配 2 個節點 (以提高可用性)。

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

    動作

    本節列出連接器支援的部分動作。如要瞭解如何設定動作,請參閱「動作範例」。

    SendMail2 動作

    這項動作會傳送電子郵件和附件。

    「傳送電子郵件」動作的輸入參數

    參數名稱 資料類型 必填 說明
    主旨 字串 要傳送的電子郵件主旨。
    ContentValue 字串 要傳送的電子郵件內容。
    ContentType 字串 要傳送的內容類型。支援的值為 text/plain 和 text/html。
    內容 字串 Content 物件的匯總。
    SendAt 字串 您希望電子郵件送達的日期和時間。預約時間不得超過 72 小時。
    FromEmail 字串 寄件者的電子郵件地址。
    FromName 字串 寄件者名稱。
    ToEmail 字串 要傳送電子郵件的地址。
    ToName 字串 要傳送電子郵件的電子郵件地址名稱。
    收件者 字串 「收件者」的匯總資料。
    ToCCEmail 字串 接收電子郵件副本的收件者電子郵件地址。
    ToCCName 字串 將收到電子郵件副本的收件者名稱。
    ToBCCName 字串 會收到電子郵件密件副本的收件者名稱。
    ToBCC 字串 ToBCC 收件者的匯總。
    ReplyToEmail 字串 您要回覆的對象的電子郵件地址。
    ReplyToName 字串 你要回覆的對象名稱。
    AttachmentPaths 字串 要附加至待傳送電子郵件的檔案路徑。
    TemplateId 字串 您要傳送的範本 ID。
    DynamicTemplateData 字串 動態範本的資料。
    個人化設定 字串 訊息和中繼資料的陣列。個人化設定中的每個物件都可以視為信封,用於定義個別訊息的收件者,以及訊息的處理方式。

    傳送電子郵件動作的輸出參數

    無論郵件是否傳送成功,這項動作都會傳回確認訊息。

    動作範例

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

    範例 - 傳送電子郵件

    1. 在「Configure connector task」對話方塊中,按一下 Actions
    2. 選取 SendMail2 動作,然後按一下「完成」
    3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
      {
          "FromName": "Name",
          "FromEmail": "cloudysanfrancisco@gmail.com",
          "Subject": "[{\"value\": \"cymbalgroup.com\",\"type\": \"text/plain\"}]",
          "TemplateId": "d-c4bc730a0b094a3a9d9cabb7347b5edc",
          "Personalizations": "[{\"subject\": \"Test Subject3\",\"send_at\": 1698659820,\"from\": {\"name\": \"hi\",\"email\": \"email@gmail\"},\"to\":      
          [{\"email\": \"email@gmail.com\",\"name\": \"test\"}\n ]}]",
          "Content": "[{\"value\": \"abc@cdata.com\",\"type\": \"text/plain\"}]"
      }
    4. 這項操作會傳回確認訊息。如果動作成功,工作 connectorOutputPayload 回應參數的值會類似於下列內容:

      [{
      "Success": "True"
      }]

    實體作業範例

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

    範例 - 列出所有聯絡人

    這個範例會列出 NMCContacts 實體中的所有聯絡人。

    1. 在「Configure connector task」對話方塊中,按一下 Entities
    2. Entity 清單中選取 NMCContacts
    3. 選取「List」作業,然後按一下「完成」
    4. (選用) 在「連結器」工作的「工作輸入」部分,您可以指定篩選子句,篩選結果集。 例如:City='Bangalore'。您也可以使用邏輯運算子指定多個篩選條件。例如:City='Bangalore' and region='asia-south2'

    範例 - 取得記錄

    這個範例會從 NMCSegments 實體取得具有指定 ID 的記錄。

    1. 在「Configure connector task」對話方塊中,按一下 Entities
    2. Entity 清單中選取 NMCSegments
    3. 選取「Get」作業,然後按一下「完成」
    4. 在「連線器」工作的「工作輸入」部分,按一下「EntityId」,然後在「預設值」欄位中輸入 0d44bb3f-d28e-4bcf-aba2-c77be831ad46

      其中 0d44bb3f-d28e-4bcf-aba2-c77be831ad46NMCSegments 實體中的主鍵值。

    範例 - 建立記錄

    這個範例會在 NMCSenders 實體中建立記錄。

    1. 在「Configure connector task」對話方塊中,按一下 Entities
    2. Entity 清單中選取 NMCSenders
    3. 選取「Create」作業,然後按一下「完成」
    4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
      {
      "Nickname": "Test",
      "FromEmail": "test1@examplepetstore.com",
      "FromName": "testuser",   
      "ReplytoEmail": "test1@examplepetstore.com",  
      "Address": "NA", 
      "City": "NA", 
      "Country": "India"}

      如果整合成功,連接器工作的 connectorOutputPayload 欄位會包含類似下列內容的值:

      {
      "Id": 5360940.0
      }

    範例 - 建立記錄

    這個範例會在 NMCLists 實體中建立記錄。

    1. 在「Configure connector task」對話方塊中,按一下 Entities
    2. Entity 清單中選取 NMCLists
    3. 選取「Create」作業,然後按一下「完成」
    4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
      {
      "Name": "TEST_CON_LIST1699262238224",
      "ContactCount": 3.0}

      如果整合成功,連接器工作的 connectorOutputPayload 欄位會包含類似下列內容的值:

      {
      "Id": "d927f128-b718-447a-affe-417f1a8b3abd"}

    範例 - 更新記錄

    這個範例會更新 NMCSenders 實體中的記錄。

    1. 在「Configure connector task」對話方塊中,按一下 Entities
    2. Entity 清單中選取 NMCSenders
    3. 選取「Update」作業,然後按一下「完成」
    4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似下列的值:
      {
      "Nickname": "Test",
      "FromEmail": "test2@examplepetstore.com",
      "FromName": "testuser",   
      "ReplytoEmail": "test2@examplepetstore.com",  
      "Address": "NA", 
      "City": "NA", 
      "Country": "India"}
    5. 按一下「entityId」,然後在「Default Value」欄位中輸入 5360940.0

      如果整合成功,連接器工作的 connectorOutputPayload 欄位會包含類似下列內容的值:

      {
      "Id":"5360940.0"
      }

    範例 - 刪除記錄

    這個範例會刪除 NMCSegments 實體中具有指定 ID 的記錄。

    1. 在「Configure connector task」對話方塊中,按一下 Entities
    2. Entity 清單中選取 NMCSegments
    3. 選取「Delete」作業,然後按一下「完成」
    4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中,按一下「entityId」,然後在「Default Value」(預設值) 欄位中輸入 c58b9151-7279-428a-bac2-12b4bf2b48b0

    使用 Terraform 建立連線

    您可以使用 Terraform 資源建立新連線。

    如要瞭解如何套用或移除 Terraform 設定,請參閱「基本 Terraform 指令」。

    如要查看用於建立連線的 Terraform 範本範例,請參閱範本範例

    使用 Terraform 建立這項連線時,您必須在 Terraform 設定檔中設定下列變數:

    參數名稱 資料類型 必填 說明

    在整合服務中使用 SendGrid 連線

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

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

    向 Google Cloud 社群尋求協助

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

    後續步驟