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)
  如需了解如何启用服务，请参阅启用服务。
如果之前没有为您的项目启用这些服务或权限，则在您配置连接器时，系统会提示您启用。

配置连接器

配置连接器时，您需要创建与数据源（即后端系统）的连接。一个连接需专用于一个数据源。这意味着，如果您有许多数据源，则必须为每个数据源创建单独的连接。如需创建连接，请执行以下步骤：

在 Cloud 控制台中，进入 Integration Connectors > 连接页面，然后选择或创建一个 Google Cloud 项目。
转到“连接”页面
点击 + 新建以打开创建连接页面。
在位置部分中，选择连接的位置。
1. 区域：从下拉列表中选择一个位置。
  如需查看所有受支持区域的列表，请参阅位置。
2. 点击下一步。
在连接详情部分中，完成以下操作：
1. 连接器：从可用连接器的下拉列表中选择 SendGrid。
2. 连接器版本：从可用版本的下拉列表中选择一个连接器版本。
3. 在连接名称字段中，输入连接实例的名称。
  连接名称必须符合以下条件：
  - 连接名称可以使用字母、数字或连字符。
  - 字母必须小写。
  - 连接名称必须以字母开头，以字母或数字结尾。
  - 连接名称不能超过 63 个字符。
4. （可选）输入连接实例的说明。
5. 服务账号：选择具有所需角色的服务账号。
6. （可选）配置连接节点设置：
  - 节点数下限：输入连接节点数下限。
  - 节点数上限：输入连接节点数上限。
  节点是处理事务的连接单元（或副本）。连接处理越多事务就需要越多节点，相反，处理越少事务需要越少节点。如需了解节点如何影响连接器价格，请参阅连接节点的价格。如果未输入任何值，则默认情况下，节点数下限设置为 2（以便提高可用性），节点数上限设置为 50。
7. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
8. 点击下一步。
在身份验证部分中，输入身份验证详细信息。
1. SendGrid 连接不需要任何身份验证。
2. 点击下一步。
查看：查看您的连接和身份验证详细信息。
点击创建。

实体、操作和动作

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

实体：实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如，在数据库连接器中，表是实体；在文件服务器连接器中，文件夹是实体；在消息传递系统连接器中，队列是实体。
不过，可能连接器不支持或不支持任何实体，在这种情况下，Entities 列表将为空。
操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：
- List（列出）
- 获取
- 创建
- 更新
- 删除
从可用列表中选择一个实体，系统会生成该实体可用的操作列表。如需了解操作的详细说明，请参阅连接器任务的实体操作。但是，如果连接器不支持任何实体操作，则此类不受支持的操作不会列在 Operations 列表中。
动作：动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改，并且动作因连接器而异。但可能的情况是，连接器不支持任何动作，在这种情况下，Actions 列表将为空。

系统限制

SendGrid 连接器每秒可以为每个节点处理 8 个事务，并限制任何超出此限制的事务。默认情况下，Integration Connectors 会为连接分配 2 个节点（以提高可用性）。

如需了解适用于 Integration Connectors 的限制，请参阅限制。

操作

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

注意：运行集成后，所有操作的结果都将以 JSON 响应的形式反映在 Connectors 任务的 connectorOutputPayload 响应参数中。

SendMail 操作

此操作会发送带有附件的邮件。

SendMail 操作的输入参数

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

SendMail 操作的输出参数

无论是否成功通过 SendMail 发送邮件，此操作都会返回确认邮件。

操作示例

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

示例 - 发送电子邮件

在 Configure connector task 对话框中，点击 Actions。
选择 SendMail 操作，然后点击完成。

在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

{
"Personalizations": "[{"subject": "Test Subject2",
"send_at": 1698659820,
"from": {"name": "hi","email": "testmail@test.com"},
"to": [{"email": "xyz@test.com","name": "test"}]
}]",
"FromName": "SampleName",
"FromEmail": "testmail@test.com",
"Subject": "SubjectAdded",
"Content": "[{"value": "abc@test1.com","type": "text/plain"}]', Attachments='[{"filename": "Test2.txt","content": "VGVzdCBBdHRhY2htZW50"}]"
}

此操作会返回 SendMail 的确认消息。如果操作成功，任务的 connectorOutputPayload 响应参数的值将如下所示：

[{
"Status": "True"
}]

实体操作示例

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

示例 - 列出所有联系人

以下示例列出了 NMCContacts 实体中的所有联系人。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择 NMCContacts。
选择 List 操作，然后点击完成。
（可选）在连接器任务的任务输入部分，您可以通过指定 filter 子句来过滤结果集。例如 City='Bangalore'。您还可以使用逻辑运算符指定多个过滤条件。例如 City='Bangalore' and region='asia-south2'。

示例 - 获取记录

此示例从 NMCSegments 实体获取具有指定 ID 的记录。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择 NMCSegments。
选择 Get 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 EntityId，然后在默认值字段中输入 0d44bb3f-d28e-4bcf-aba2-c77be831ad46。
此处，0d44bb3f-d28e-4bcf-aba2-c77be831ad46 是 NMCSegments 实体中的主键值。

示例 - 创建记录

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

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择 NMCSenders。
选择 Create 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 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 实体中创建一条记录。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择 NMCLists。
选择 Create 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
"Name": "TEST_CON_LIST1699262238224",
"ContactCount": 3.0}
```
如果集成成功，连接器任务的 connectorOutputPayload 字段的值将如下所示：
```
{
"Id": "d927f128-b718-447a-affe-417f1a8b3abd"}
```

示例 - 更新记录

此示例将更新 NMCSenders 实体中的一条记录。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择 NMCSenders。
选择 Update 操作，然后点击完成。

在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

{
"Nickname": "Test",
"FromEmail": "test2@examplepetstore.com",
"FromName": "testuser",
"ReplytoEmail": "test2@examplepetstore.com",
"Address": "NA",
"City": "NA",
"Country": "India"}

点击 entityId，然后在 Default Value 字段中输入 5360940.0。
如果集成成功，连接器任务的 connectorOutputPayload 字段的值将如下所示：
```
{
"Id":"5360940.0"
}
```

示例 - 删除记录

此示例将删除 NMCSegments 实体中指定 ID 的记录。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择 NMCSegments。
选择 Delete 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 entityId，然后在默认值字段中输入 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 社区发布您的问题并讨论此连接器。

后续步骤

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