Zoho 图书

借助 Zoho Books 连接器，您可以在 Zoho Books 系统上执行 SQL 操作。

支持的版本

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

准备工作

在使用 Zoho Books 连接器之前，请执行以下任务：

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

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

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

配置连接器

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

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

   转到“连接”页面

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

      连接器支持的区域包括：

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

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

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

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

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

   注意：只有随用随付客户才能自定义连接节点值。
   7. Accounts Server（帐号服务器）：完整的帐号服务器网址。
   8. Organization Id（组织 ID）：与特定 Zoho Books 组织相关联的 ID。
   9. 详细程度：连接的详细程度，从 1 到 5 不等。如果详细程度越高，系统会记录所有通信详细信息（请求、响应和 SSL 证书）。
   10. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
   11. 点击下一步。
5. 在身份验证部分中，输入身份验证详细信息。
   1. 选择身份验证类型，然后输入相关详细信息。

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

      • OAuth 2.0 授权代码授权

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

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

配置身份验证

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

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

实体、操作和动作

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

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

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

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

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

  从可用列表中选择一个实体，系统会生成该实体可用的操作列表。如需了解操作的详细说明，请参阅连接器任务的实体操作。但是，如果连接器不支持任何实体操作，则此类不受支持的操作不会列在 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. （可选）在连接器任务的任务输入部分，您可以通过指定 filter 子句来过滤结果集。您还可以使用逻辑运算符指定多个过滤条件。

示例 - 获取销售订单

此示例从 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，然后在默认值字段中输入 1470449000000038005。

如果集成成功，连接器任务的 connectorOutputPayload 字段的值将如下所示：

{
"CustomerContactId": "1470449000000038005"
}

示例 - 删除账单记录

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

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

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

在集成中使用 Zoho Books 连接

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

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

向 Google Cloud 社区寻求帮助

您可以在 Cloud 论坛的 Google Cloud 社区发布您的问题并讨论此连接器。

后续步骤

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