ZohoBooks

借助 ZohoBooks 连接器，您可以对 ZohoBooks 系统执行 SQL 操作。

支持的版本

该连接器利用 Zoho Books API V3 实现对 Zoho Books 数据的双向访问。

准备工作

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

• 在您的 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. 连接器：从可用连接器的下拉列表中选择 Zoho Books。
   2. 连接器版本：从可用版本的下拉列表中选择一个连接器版本。
   3. 在连接名称字段中，输入连接实例的名称。

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

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

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

   注意：仅当您是随用随付客户时，才能自定义连接节点值。
   8. 账号服务器：完整的账号服务器网址。
   9. 组织 ID：与特定 Zoho Books 组织关联的 ID。
   10. 详细程度级别：连接的详细程度级别，介于 1 到 5 之间。较高的详尽级别将记录所有通信详情（请求、响应和 SSL 证书）。
   11. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
   12. 点击下一步。
5. 在身份验证部分中，输入身份验证详细信息。
   1. 选择身份验证类型，然后输入相关详细信息。

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

      • OAuth 2.0 授权代码授权

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

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

配置身份验证

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

• OAuth 2.0 授权代码授权
  • 客户端 ID：连接器为您创建的应用提供的客户端 ID。
  • 客户端密钥：包含您创建的关联应用的客户端密钥的 Secret Manager 密文。
  • 访问令牌：包含为您创建的关联应用提供的 OAuth 访问令牌的 Secret Manager Secret。

配置 ZohoBooks 身份验证

以下部分介绍了如何配置 ZohoBooks 连接器。

设置 ZohoBooks 账号

如需详细了解如何设置 ZohoBooks 账号，请参阅账号创建。

设置开发者账号并创建客户端应用

如需了解 ZohoBooks 开发者账号和客户端应用创建，请参阅创建客户端应用。

设置身份验证

如需设置身份验证，请执行以下操作：

1. 前往 Cloud 控制台中的集成连接器页面。
2. 如需查看特定连接的详细信息，请点击现有连接表中的连接名称。
3. 在 Authentication（身份验证）部分中，点击 Authorize connection（授权连接）以开始授权过程。
4. 复制重定向 URI。
5. 前往 ZohoBooks 开发者控制台。
6. 在“基于服务的应用客户端已获授权的重定向 URI”部分中，添加重定向 URI。
7. 在 Integration Connectors（集成连接器）页面中，前往您复制重定向 URI 的 ZohoBooks 连接页面，然后点击授权。

系统会将您重定向到 ZohoBooks 网站以进行授权。

连接配置示例

本部分列出了您在创建 Zoho Books 连接时配置的各种字段的示例值。

网络连接类型

字段名称	详细信息
区域	us-east4
连接器	ZohoBooks
连接器版本	1
连接名称	zohobooks-google-cloud-conn
服务账号	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
账号服务器	https://books.zoho.in
组织 ID	ORGANIZATION_ID
详细程度	5
节点数下限	2
节点数上限	50
客户端 ID	CLIENT_ID
权限范围	ZohoBooks.fullaccess.all
客户端密钥	CLIENT_SECRET
Secret 版本	1

在集成中使用 ZohoBooks 连接

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

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

实体、操作和动作

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

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

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

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

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

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

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

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

操作

本部分列出了 Zoho Books 关联支持的一些操作。要了解如何配置 操作，请参阅操作示例。

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

ImportCreditCardStatement 操作

通过此操作，您可以导入赠金购物车对账单。

ImportCreditCardStatement 操作的输入参数

参数名称	数据类型	必需	说明
AccountId	字符串	否	银行/信用卡账户的 ID
TransactionsTransactionDebitOrCredit	字符串	否	指示交易是借记还是贷记。
TransactionsTransactionAmount	字符串	否	交易涉及的金额。
TransactionsTransactionDescription	字符串	否	交易说明。
TransactionsTransactionDate	字符串	否	交易日期。

如需了解如何配置 ImportCreditCardStatement 操作， 请参阅示例。

操作示例

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

示例 - 导入信用卡对账单

此示例会导入信用卡对账单。

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

   {
     "AccountId": "1470449000000023015",
     "TransactionsTransactionDebitOrCredit": "credit",
     "TransactionsTransactionAmount": "200",
     "TransactionsTransactionDescription": "Transaction done from Google account",
     "TransactionsTransactionDate": "2023-05-05"
   }

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

[{
"Status": "Your bank statement has been imported."
}]

实体操作示例

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

示例 - 列出所有估算

此示例列出了 Estimates 实体中的所有记录。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Estimates。
3. 选择 List 操作，然后点击 完成。
4. （可选）在连接器任务的任务输入部分，您可以执行以下操作： 通过指定过滤子句来过滤结果集。您还可以使用逻辑运算符指定多个过滤条件。

示例 - 获取销售订单

此示例从 SalesOrder 实体获取指定的销售订单。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 SalesOrder。
3. 选择 Get 操作，然后点击完成。
4. 在连接器任务的任务输入部分，点击 EntityId，然后在默认值字段中输入 1470449000000043003。

   其中，1470449000000043003 是 SalesOrder 实体中的主键值。

示例 - 创建银行交易

此示例在 BankTransactions 实体中创建了银行交易记录。

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

   {
   "TransactionType": "transfer_fund",
   "FromAccountId": "1470449000000000459",
   "ToAccountId": "1470449000000110001",
   "Amount": 45.0,
   "CurrencyId": "1470449000000000064"
   }

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

   {
   "TransactionId": "1470449000000231005"
   }

示例 - 更新客户的详细联系信息

此示例更新 CustomerContacts 实体中的指定客户记录。

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

   {
   "Department": "Development",
   "ContactId": "1470449000000038003"
   }

5. 在连接器任务的任务输入部分，点击 entityId 并 然后在 Default Value 字段中输入 1470449000000038005。

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

{
"CustomerContactId": "1470449000000038005"
}

示例 - 删除账单记录

此示例删除 InvoiceDetails 实体中的指定账单记录。

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

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

向 Google Cloud 社区寻求帮助

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

后续步骤

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