Kintone

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

准备工作

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

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

      如需了解如何启用服务，请参阅启用服务。

    如果之前没有为您的项目启用这些服务或权限，则在您配置连接器时，系统会提示您启用。

配置连接器

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

  1. 在 Cloud 控制台 中，进入 Integration Connectors > 连接页面，然后选择或创建一个 Google Cloud 项目。

    转到“连接”页面

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

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

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

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

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头，以字母或数字结尾。
      • 连接名称不能超过 63 个字符。
    4. （可选）输入连接实例的说明。
    5. 服务账号：选择具有所需角色的服务账号。
    6. （可选）配置连接节点设置：

      • 节点数下限：输入连接节点数下限。
      • 节点数上限：输入连接节点数上限。

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

    7. 允许特殊字符：确定是否允许特殊字符。如果为 true，则不会替换特殊字符。
    8. 检查子表来源：要从中检索子表的 Kintone 应用的逗号分隔列表。
    9. 访客空间 ID：将查询结果限制为访客空间。
    10. 数字映射为双精度型：确定是否将数字字段的数据类型从十进制更改为双精度。
    11. 子表分隔符：用于分隔表与子表的字符，格式为 tablename + char + subtable。
    12. 对字段名称使用代码：确定对字段名称是使用标签还是使用代码。
    13. 用户光标：用于确定是否应使用光标检索记录的布尔值。
    14. 用户定义的视图：指向包含自定义视图的 JSON 配置文件的文件路径。
    15. 使用代理：选中此复选框可为连接配置代理服务器并配置以下值：
      • 代理身份验证方案：选择要通过代理服务器进行身份验证的身份验证类型。支持以下身份验证类型：
        • 基本：基本 HTTP 身份验证。
        • 摘要：摘要 HTTP 身份验证。
      • 代理用户：用于向代理服务器进行身份验证的用户名。
      • 代理密码：用户密码的 Secret Manager 密文。
      • 代理 SSL 类型：连接到代理服务器时使用的 SSL 类型。支持以下身份验证类型：
        • 自动：默认设置。如果网址是 HTTPS 网址，则使用“隧道”选项。如果网址是 HTTP 网址，则使用“永不”选项。
        • 始终：连接始终启用 SSL。
        • 永不：连接未启用 SSL。
        • 隧道：连接通过隧道代理建立。代理服务器会打开与远程主机的连接，并且流量会流经该代理。
      • 在代理服务器部分中，输入代理服务器的详细信息。
        1. 点击+ 添加目标。
        2. 选择目标类型。
          • 主机地址：指定目标的主机名或 IP 地址。

            如果要与后端系统建立专用连接，请执行以下操作：

    16. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
    17. 点击下一步。
  5. 在目标部分中，输入要连接到的远程主机（后端系统）的详细信息。
    1. 目的地类型：选择目的地类型。
      • 从列表中选择主机地址，以指定目的地的主机名或 IP 地址。
      • 如果要与后端系统建立专用连接，请从列表中选择端点连接，然后从端点连接列表中选择所需的端点连接。

      如果要与后端系统建立公共连接以提高安全性，您可以考虑为连接配置静态出站 IP 地址，然后将防火墙规则配置为仅将特定静态 IP 地址列入许可名单。

      要输入其他目标，请点击 + 添加目标。

    2. 点击下一步。
  6. 在 Authentication（身份验证）部分中，输入身份验证详细信息。
    1. 选择身份验证类型，然后输入相关详细信息。

      Kintone 连接支持以下身份验证类型：

      • 用户名和密码
      • 匿名

      2. 如需了解如何配置这些身份验证类型，请参阅配置身份验证。

    2. 点击下一步。
  7. 查看：查看您的连接和身份验证详细信息。
  8. 点击创建。

配置身份验证

根据您要使用的身份验证输入详细信息。

  • 用户名和密码
    • 用户名：连接器的用户名
    • 密码：包含与连接器关联的密码的 Secret Manager Secret。
    • 基本身份验证密码：使用基本身份验证的网域所需的其他密码。
    • 基本身份验证用户：使用基本身份验证的网域所需的其他用户名。
  • 匿名

    如果您要使用匿名登录，请选择不可用。

    • API 令牌：包含用于身份验证的 API 令牌的 Secret Manager Secret。
    • 应用 ID：与用于身份验证的 APIToken 结合使用的 AppId。

实体、操作和动作

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

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

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

  • 操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：

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

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

系统限制

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

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

操作

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

AppsDeployStatus 操作

此操作可获取应用部署状态

AppsDeployStatus 操作的输入参数

参数名称 数据类型 必填 说明
AppIds 字符串 是 应用的 ID。这可以是以英文逗号分隔的 ID 列表。
GuestSpaceId 字符串 否 此参数适用于访客空间中的应用。如果连接字符串中指定了连接属性 GuestSpaceId，请勿添加此参数。

例如，关于如何配置 AppsDeployStatus 操作， 请参阅操作示例。

CreateApp 操作

此操作会创建应用。

CreateApp 操作的输入参数

参数名称 数据类型 必填 说明
名称 字符串 是 指定应用名称（长度不超过 64 个字符）。
空格 字符串 否 聊天室的 ID。如果在连接字符串中设置了连接属性 GuestSpaceId，请勿指定此值。
ThreadId 字符串 否 聊天室的 ID。如果在连接字符串中设置了连接属性 GuestSpaceId，请勿指定此值。
IsGuestSpace 布尔值 否 这是一个布尔值，指示聊天室参数是普通空间还是访客空间。对于访客聊天室，请将此值设为 true。 默认值为 false。

例如，关于如何配置 CreateApp 操作， 请参阅操作示例。

“DeleteGuests”操作

执行此操作后，用户可以删除邀请对象。

DeleteGuests 操作的输入参数

参数名称 数据类型 必填 说明
邀请对象 字符串 是 访客用户的电子邮件地址列表。最多可以删除 100 位邀请对象。

例如，关于如何配置 DeleteGuests 操作， 请参阅操作示例。

DeployApps 操作

通过此操作，您可以部署应用。

DeployApps 操作的输入参数

参数名称 数据类型 必填 说明
AppId 字符串 是 应用 ID。这可以是以英文逗号分隔的 ID 列表。
修订版本 字符串 否 指定设置可反映操作环境的修订版本。如果指定的修订版本不是最新的，则请求将失败。
还原 布尔值 否 如果您想取消对应用设置的更改，请将此参数设置为 true。 默认值为 false。
GuestSpaceId 字符串 否 此参数适用于访客空间中的应用。如果连接字符串中指定了连接属性 GuestSpaceid，请勿添加此参数。

例如，关于如何配置 DeployApps 操作， 请参阅操作示例。

DownloadFile 操作

通过此操作，用户可以从应用中的附件字段下载文件。

DownloadFile 操作的输入参数

参数名称 数据类型 必填 说明
FileKey 字符串 是 文件的 ID。
HasBytes 布尔值 否 是否以字节形式下载内容。有效值为 true 或 false。 如果设置为 true，则文件将以 Base64 编码的字符串形式下载。

默认情况下，HasBytes 字段设置为 false。

例如，关于如何配置 DownloadFile 操作， 请参阅操作示例。

UpdateAssignees 操作

执行此操作后，用户可以更新分配对象。

UpdateAssignees 操作的输入参数

参数名称 数据类型 必填 说明
AppId 字符串 是 应用 ID。
RecordId 字符串 是 RecordId
指派对象 字符串 是 分配对象的用户代码。如果留空，系统不会分配任何用户。分配对象人数上限为 100 人。
修订版本 字符串 否 更新分配对象之前的记录的修订号。如果指定的修订版本不是最新修订版本，则请求会导致错误。
GuestSpaceId 字符串 否 此参数适用于访客空间中的应用。如果连接字符串中指定了连接属性 GuestSpaceId，请勿添加此参数。

例如，关于如何配置 UpdateAssignees 操作， 请参阅操作示例。

“AddGuests”操作

执行此操作后，用户可以添加邀请对象。

AddGuests 操作的输入参数

参数名称 数据类型 必填 说明
名称 字符串 false 用户的显示名称。长度必须在 1 到 128 个字符之间。
代码 字符串 否 访客用户的电子邮件地址（登录名）。
密码 字符串 否 访客用户的登录密码。此值必须是字母数字。
时区 字符串 否 访客用户所在的时区。
语言区域 字符串 否 访客用户的语言设置。可用的值包括 auto、en、zh、ja。如果未提供，则“自动”将设置为默认值。
映像 字符串 否 访客用户的个人资料图片。指定所上传文件的 fileKey。
SurNameReading 字符串 否 访客用户的姓氏拼音设置。长度上限为 64 个字符。
GivenNameReading 字符串 否 访客用户的拼音设置。长度上限为 64 个字符。
公司 字符串 否 要在访客用户的个人资料中显示的公司名称。
部门 字符串 否 要在访客用户个人资料中显示的部门名称。
电话 字符串 否 要在访客用户个人资料中显示的电话号码。
CallTo 字符串 否 访客用户的 Skype 名称。
GuestsAggregate 字符串 否 来宾汇总。

例如，关于如何配置 AddGuests 操作， 请参阅操作示例。

UploadFile 操作

通过此操作，您可以上传文件。

UploadFile 操作的输入参数

参数名称 数据类型 必填 说明
FileName 字符串 是 您想要为文档指定的名称。如果未指定，系统将使用“FullPath”输入中指定的文件名。
内容 字符串 否 未指定 FullPath 时要上传的 InputStream 内容。
ContentBytes 字符串 否 要作为文件上传的字节内容（作为 Base64 字符串）。使用此方法可上传二进制数据。
AppId 字符串 否 Kintone 应用 ID。当 AttachToApp 设置为 true 时，此字段为必需字段。
HasBytes 布尔值 否 是否以字节形式上传内容。有效值为 true 或 false。 如果设置为 true，则文件内容应为 Base64 编码的字符串。

默认情况下，HasBytes 字段设置为 false。

AddThreadComment 操作

此操作允许用户在消息串中添加评论

AddThreadComment 操作的输入参数

参数名称 数据类型 必填 说明
SpaceId 整数 是 聊天室的 ID。
ThreadId 整数 是 线程的 ID。
文本 字符串 否 评论内容。可以通过 LF 指定换行符。评论的字符数上限为 65535。如果未设置文件，则为必需项。
提及 字符串 否 包含提及的数组，用于通知其他 Kintone 用户。
文件 字符串 否 包含附件文件数据的数组。文件数量上限为 5 个。如果未设置文本，则为必填。

例如，关于如何配置 AddThreadComment 操作， 请参阅操作示例。

UpdateThread 操作

此操作可让你更新讨论帖

UpdateThread 操作的输入参数

参数名称 数据类型 必填 说明
ThreadId 整数 是 线程 ID。可在相应讨论帖的网址中找到其 ID。
名称 字符串 否 Thread 的新名称。长度必须在 1 到 128 个字符之间。如果忽略此参数，名称将不会更新。无法更新单消息串式聊天室的讨论帖名称。
正文 字符串 否 Thread 正文的内容。

例如，关于如何配置 UpdateThread 操作， 请参阅操作示例。

操作示例

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

示例 - 获取应用部署状态

此示例获取应用部署状态。

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

    4. 如果操作成功， AppsDeployStatus 任务的 connectorOutputPayload 响应 参数的值类似于以下内容：

    {
"AppId": "4",   "Status": "SUCCESS",   "success": "true"
}

示例 - 创建应用

本示例创建了一个新应用。

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

    4. 如果操作成功， CreateApp 任务的 connectorOutputPayload 响应 参数的值类似于以下内容：

    [{
"AppId": "20",   "Revision": "2",   "Success": "true"
}]

示例 - 部署应用

本示例将一个应用

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

    4. 如果操作成功， DeployApps 任务的 connectorOutputPayload 响应 参数的值类似于以下内容：

    [{
"Success": "true"
}]

示例 - 下载文件

此示例会下载应用中存在的文件。

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

    4. 如果操作成功， DownloadFile 任务的 connectorOutputPayload 响应 参数的值类似于以下内容：

    [{
"Success": "True",
"Content": "Record number, Number, Text\n49, 162, Hello"
}]

示例 - 更新分配对象

此示例更新了分配对象。

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

    4. 如果操作成功， UpdateAssignees 任务的 connectorOutputPayload 响应 参数的值类似于以下内容：

    [{
"Success": "True",
"Content": "Record number, Number, Text\n49, 162, Hello"
}]

示例 - 添加邀请对象

本示例添加了一位访客。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 AddGuests 操作，然后点击完成。
  3. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段： 
    {
"GuestsAggregate": "[{\"name\":\"Testuser\",\"code\":\"testuser1@test.com\",
\"password\":\"test@123\",\"timezone\":\"America/Los_Angeles\",
\"company\":\"Company Name\",\"division\": \"Sales\",
\"callto\":\"SkypeCallTo\",\"locale\":\"en\"}]"
}

    4. 如果操作成功， AddGuests 任务的 connectorOutputPayload 响应 参数的值类似于以下内容：

    [{
"Success": "true"
}]

示例 - 删除访客

本示例将删除访客。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 DeleteGuests 操作，然后点击完成。
  3. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段： 
    {
"Guests": "[\"testuser1@test.com\"]"
}

    4. 如果操作成功， DeleteGuests 任务的 connectorOutputPayload 响应 参数的值类似于以下内容：

    [{
"Success": "true"
}]

示例 - 上传文件

以下示例展示了如何上传文件。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 UploadFile 操作，然后点击完成。
  3. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段： 
    {
"FileName": "GoogleCloud_Upload_File.txt",
"AppId": "9",
"Content": "Hello"
}

    4. 如果操作成功， UploadFile 任务的 connectorOutputPayload 响应 参数的值类似于以下内容：

    [{
"FileKey": "4e3b6ca9-0028-41c6-9662-53b151ef9b35",
"Success": "true",
"Id": null,
"Revision": null
}]

示例 - 添加会话评论

以下示例展示了如何添加会话评论。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 AddThreadComment 操作，然后点击完成。
  3. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段： 
    {
"SpaceId": 1.0,
"ThreadId": 1.0,
"Text": "Test Comment"
}

    4. 如果操作成功， AddThreadComment 任务的 connectorOutputPayload 响应 参数的值类似于以下内容：

    [{
"Id": "3",
"Success": "true"
}]

示例 - 更新讨论帖

以下示例展示了如何更新会话。

  1. 在 Configure connector task 对话框中，点击 Actions。
  2. 选择 UpdateThread 操作，然后点击完成。
  3. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段： 
    {
"ThreadId": 1.0,
"Name": "updated thread"
}

    4. 如果操作成功， UpdateThread 任务的 connectorOutputPayload 响应 参数的值类似于以下内容：

    [{
"Success": "true"
}]

实体操作示例

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

示例 - 列出所有应用

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Apps。
  3. 选择 List 操作，然后点击 完成。
  4. （可选）在连接器任务的任务输入部分，您可以执行以下操作： 通过指定过滤子句来过滤结果集。 始终使用英文单引号 (') 指定过滤条件子句值。

示例 - 获取应用

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

    其中，4 是 Apps 实体中的唯一记录 ID。

示例 - 删除记录

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

示例 - 创建记录

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

    运行此示例，在连接器中返回类似于以下内容的响应 任务的 connectorOutputPayload 输出变量：

    {
"RecordId": 29.0
}

示例 - 更新记录

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Record。
  3. 选择 Update 操作，然后点击完成。
  4. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段： 
    {
"Text_area": "updatedemo"
}
  5. 点击 entityId，然后在 Default Value 字段中输入 22。

    运行此示例，在连接器中返回类似于以下内容的响应 任务的 connectorOutputPayload 输出变量：

    {
"RecordId": "22"
}

使用 Terraform 创建连接

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

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

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

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

参数名称 数据类型 必需 说明
allow_special_characters BOOLEAN 错误 确定是否允许使用特殊字符。如果返回的是 true，则不会替换特殊字符。
check_for_subtables_in STRING True 要从中检索子表的 Kintone 应用的列表（以英文逗号分隔）。
guest_space_id STRING 错误 仅限访客聊天室查询结果。
number_map_to_double BOOLEAN 错误 决定是否将数字字段的数据类型从十进制数更改为双精度数。
subtable_separator_character STRING True 用于从子表格划分表格的字符，格式为“表格名称 + 字符 + 子表格”。
use_code_for_field_name BOOLEAN 错误 确定是否要为字段名称使用标签还是代码。
use_cursor BOOLEAN 错误 布尔值，用于确定是否应使用游标来检索记录。
user_defined_views STRING 错误 指向包含自定义视图的 JSON 配置文件的文件路径。
proxy_enabled BOOLEAN 错误 选中此复选框可为连接配置代理服务器。
proxy_auth_scheme ENUM 错误 用于向 ProxyServer 代理进行身份验证的身份验证类型。支持的值包括：BASIC、DIGEST、NONE
proxy_user STRING 错误 用于向 ProxyServer 代理进行身份验证的用户名。
proxy_password SECRET 错误 用于向 ProxyServer 代理进行身份验证的密码。
proxy_ssltype ENUM 错误 连接到 ProxyServer 代理时使用的 SSL 类型。支持的值包括：AUTO、ALWAYS、NEVER、TUNNEL

在集成中使用 Kintone 连接

创建连接后，它便可同时在 Apigee Integration 和 Application Integration。您可以使用连接 通过连接器任务在集成中进行集成。

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

向 Google Cloud 社区寻求帮助

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

后续步骤