SendGrid

借助 SendGrid 连接器，您可以对 SendGrid 数据集执行插入、删除、更新和读取操作。

准备工作

在使用 SendGrid 连接器之前，请先完成以下任务：

• 在您的 Google Cloud 项目中：
  • 将 IAM 角色 roles/connectors.admin 授予该用户 配置连接器。
  • 将以下 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 > 连接页面，然后选择或创建一个 Google Cloud 项目。

   转到“连接”页面

2. 点击 + 新建以打开创建连接页面。
3. 在位置部分中，选择连接的位置。
   1. 区域：从下拉列表中选择一个位置。

      如需查看所有受支持区域的列表，请参阅位置。

   2. 点击下一步。
4. 在连接详情部分中，完成以下操作：
   1. 连接器：从可用连接器的下拉列表中选择 SendGrid。
   2. 连接器版本：从可用版本的下拉列表中选择一个连接器版本。
   3. 在连接名称字段中，输入连接实例的名称。

      连接名称必须符合以下条件：

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头，以字母或数字结尾。
      • 连接名称不能超过 49 个字符。
   4. （可选）输入连接实例的说明。
   5. 您可以选择启用 Cloud Logging，然后选择日志级别。默认情况下，日志级别设置为 Error。
   6. 服务账号：选择具有所需角色的服务账号。
   7. （可选）配置连接节点设置：
      • 节点数下限：输入连接节点数下限。
      • 节点数上限：输入连接节点数上限。

      节点是处理事务的连接单元（或副本）。 连接处理越多事务就需要越多节点，相反，处理越少事务需要越少节点。 如需了解节点如何影响连接器价格，请参阅连接节点的价格。如果未输入任何值，则默认情况下，节点数下限设置为 2（以便提高可用性），节点数上限设置为 50。

   注意：仅当您是随用随付客户时，才能自定义连接节点值。
   8. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
   9. 点击下一步。
5. 在身份验证部分中，输入身份验证详细信息。如需了解详情，请参阅配置身份验证。 |
6. 点击下一步。
7. 查看：查看您的连接和身份验证详细信息。
8. 点击创建。

配置身份验证

API 密钥身份验证

• API 密钥：选择 API 密钥的 Secret Manager Secret。
• Secret 版本：选择 Secret 版本。

连接配置示例

本部分列出了您在创建 SendGrid 关联时配置的各种字段的示例值。

网络连接类型

字段名称	详细信息
位置	us-central1
连接器	SendGrid
连接器版本	1
连接名称	sendgrid-google-cloud-conn
服务账号	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
节点数下限	2
节点数上限	50
API 密钥	API_KEY
密钥版本	1

实体、操作和动作

所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。

注意：您可以在连接器任务中查看连接器的实体、操作和动作。

• 实体：实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如，在数据库连接器中，表是实体；在文件服务器连接器中，文件夹是实体；在消息传递系统连接器中，队列是实体。

  但是，连接器可能不支持或不支持任何实体，在这种情况下， “Entities”列表将为空。

• 操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：
  • 列表
  • 获取
  • 创建
  • 更新
  • 删除

  从可用列表中选择一个实体，系统会生成该实体可用的操作列表。如需了解操作的详细说明，请参阅连接器任务的实体操作。但是，如果连接器不支持任何实体操作， 操作未在 Operations 列表中列出。

• 动作：动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改，并且动作因连接器而异。通常，操作有一些输入参数和一个输出 参数。但可能的情况是，连接器不支持任何动作，在这种情况下，Actions 列表将为空。

注意：所有实体和操作都具有与之关联的架构。例如，操作架构将包含以下参数详细信息：参数 及其对应的数据类型。实体和操作的架构（元数据）由连接在运行时从后端提取。如果架构有任何更新，此类更新将不会 会自动体现在您的现有连接中；您必须手动刷新架构如需刷新连接的架构，请打开连接的连接详情页面，然后点击刷新连接架构。

系统限制

SendGrid 连接器每秒可以处理 8 个事务， 每节点， 并throttles任何事务 。 默认情况下，集成连接器会为连接分配 2 个节点（以提高可用性）。

如需了解适用于集成连接器的限制，请参阅限制。

注意：集成连接器节点的数量将根据您的使用情况进行动态扩缩。但是，如果您想为大量存储卷预留容量， 等待自动扩缩，您可以调整连接的最小节点值。更多 节点处理更多连接事务。相反，如果连接处理的事务较少，则需要的节点就越少。如需配置节点值，请执行以下操作：

• 如果您是随用随付客户，请在“修改关联”页面中配置节点的最小值和最大值。
• 如果您是以订阅为主 请与支持团队联系。

节点可以处理的最大事务量取决于各种因素。因此，在调整节点数下限以提高吞吐量之前， 建议您检查后端系统是否设置得当，能够处理所需的流量。

操作

本部分列出了该连接器支持的一些操作。要了解如何配置 操作，请参阅操作示例。

注意：所有操作的结果都将以 Connectors 任务的 connectorOutputPayload 中的 JSON 响应 响应参数。

SendMail 操作

此操作会发送包含附件的邮件。

SendMail 操作的输入参数

参数名称	数据类型	必需	说明
主题	字符串	是	要发送的邮件的主题。
ContentValue	字符串	否	要发送的邮件的内容。
ContentType	字符串	否	要发送的内容类型。支持的值为 text/plain 和 text/html。
内容	字符串	是	Content 对象的汇总。
SendAt	字符串	否	您希望传送电子邮件的日期和时间。禁止提前超过 72 小时进行预约。
FromEmail	字符串	是	发件人的电子邮件地址。
FromName	字符串	否	发件人的姓名。
ToEmail	字符串	否	邮件发送到的电子邮件地址。
ToName	字符串	否	要将邮件发送到的电子邮件的各自名称。
收件人	字符串	否	“收件人”收件人的汇总信息。
ToCCEmail	字符串	否	将收到您电子邮件副本的收件人的电子邮件地址。
ToCCName	字符串	否	将收到电子邮件副本的收件人的姓名。
ToBCCName	字符串	否	将接收电子邮件密件抄送的收件人姓名。
ToBCC	字符串	否	抄送收件人的汇总数据。
ReplyToEmail	字符串	否	您回复的对象的电子邮件地址。
ReplyToName	字符串	否	您回复邮件的人的姓名。
AttachmentPaths	字符串	否	要附加到要发送的邮件的文件的路径。
TemplateId	字符串	是	您可能想要发送的模板的 ID。
DynamicTemplateData	字符串	否	动态模板的数据。
个性化	字符串	是	消息及其元数据的数组。个性化设置中的每个对象都可以视为一个信封，它定义了谁应该收到单个邮件以及如何处理该邮件。

SendMail 操作的输出参数

无论 SendMail 是否成功发送，此操作都会返回确认消息。

操作示例

本部分介绍如何在此连接器中执行一些操作。

示例 - 发送电子邮件

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 SendMail 操作，然后点击完成。
3. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段：

   {
       "FromName": "Name",
       "FromEmail": "[e-mail]",
       "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\": \"[e-mail]\",\"name\": \"test\"}\n ]}]",
       "Content": "[{\"value\": \"[e-mail]\",\"type\": \"text/plain\"}]"
   }

此操作会返回 SendMail 的确认消息。如果操作成功，任务的 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-c77be831ad46 是 NMCSegments 实体中的主键值。

示例 - 创建记录

此示例在 NMCSenders 实体中创建一条记录。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 NMCSenders。
3. 选择 Create 操作，然后点击完成。
4. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段：

   {
   "Nickname": "Test",
   "FromEmail": "[e-mail]",
   "FromName": "testuser",   
   "ReplytoEmail": "[e-mail]",  
   "Address": "NA", 
   "City": "NA", 
   "Country": "India"}

   如果集成成功，连接器任务的 connectorOutputPayload 字段将显示 值类似于以下内容：

   {
   "Id": 5360940.0
   }

示例 - 创建记录

此示例在 NMCLists 实体中创建一条记录。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 NMCLists。
3. 选择 Create 操作，然后点击完成。
4. 在连接器任务的任务输入部分，点击 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. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段：

   {
   "Nickname": "Test",
   "FromEmail": "[e-mail]",
   "FromName": "testuser",   
   "ReplytoEmail": "[e-mail]",  
   "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. 在连接器任务的任务输入部分，点击 entityId，然后在默认值字段中输入 c58b9151-7279-428a-bac2-12b4bf2b48b0。

注意 ：如果实体具有复合主键，您可以指定 过滤条件子句。

使用 Terraform 创建连接

您可以使用 Terraform 资源创建新的连接。

如需了解如何应用或移除 Terraform 配置，请参阅基本 Terraform 命令。

如需查看用于创建连接的 Terraform 模板示例，请参阅示例模板。

使用 Terraform 创建此连接时，您必须在 Terraform 配置文件中设置以下变量：

参数名称	数据类型	必需	说明

在集成中使用 SendGrid 连接

创建连接后，该连接将在 Apigee Integration 和 Application Integration 中可用。您可以通过连接器任务在集成中使用该连接。

• 如需了解如何在 Apigee Integration 中创建和使用连接器任务，请参阅连接器任务。
• 如需了解如何在应用集成中创建和使用连接器任务，请参阅连接器任务。

向 Google Cloud 社区寻求帮助

您可以在 Google Cloud 中发布问题和讨论此连接器 Cloud 论坛。

后续步骤

• 了解如何暂停和恢复连接。
• 了解如何监控连接器使用情况。
• 了解如何查看连接器日志。