Zuora

通过 Zuora 连接器，您可以连接到 Zuora 实例并作为传统数据库访问 Zuora 数据。

支持的版本

此连接器利用 Zuora API 版本 v1 实现对 Zuora 的双向访问。

准备工作

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

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

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

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

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

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

    8. 租户：将此值设置为您的 Zuora 租户。默认情况下，我们使用“USProduction”租户。
    9. 网址：仅当您拥有美国正式版环境时，才需要提供此网址。如果提供了此属性，则 Tenant 属性的值在身份验证过程中无效。
    10. ZuoraService：指定要使用的执行服务或架构
    11. 使用客户端分页：CData ADO.NET Provider for SAP Cloud for Customer 是否应使用客户端分页。
    12. 使用自定义服务：指示是否应使用自定义 SAP Cloud for Customer OData 服务。
    13. 用户定义的视图：指向包含自定义视图的 JSON 配置文件的文件路径。
    14. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
    15. 点击下一步。
  5. 在身份验证部分中，输入身份验证详细信息。
    1. 选择身份验证类型，然后输入相关详细信息。

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

      • OAuth 2.0 客户端凭据

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

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

配置身份验证

如需启用 OAuth 2.0 客户端凭证身份验证，请按以下步骤操作：

  1. 在 Zuora 中创建客户端凭据，并获取客户端 ID 和客户端密钥。
  2. 在 Google Cloud中指定凭据。

在 Zuora 中创建客户端凭据

  1. 在 OneID 门户中，点击您的头像，然后点击设置。
  2. 点击管理 OAuth 2.0 客户端。
  3. 在管理 OAuth 2.0 客户端页面上，点击新建。
  4. 在新的 OAuth 2.0 客户端窗口中，指定以下字段：
    • 名称：输入客户端的名称。
    • 类型：从列表中选择客户端凭据。
  5. 点击保存。成功创建客户端后，系统会显示一个包含客户端 ID 和客户端密钥的窗口。

    保存客户端 ID 和客户端密钥以供日后使用。如需了解详情，请参阅管理 OAuth 2.0 客户端 。

在 Google Cloud中指定凭据

在 Integration Connectors 中创建连接时，您必须指定以下详细信息：

在身份验证部分中，输入以下详细信息：

  • 客户端 ID：您创建的应用的客户端 ID。
  • 客户端密钥：包含您创建的关联应用的客户端密钥的 Secret Manager 密文。

Web 连接类型

下表列出了 Zuora 网络连接类型的示例配置值：

字段名称 详细信息
位置 us-central1
连接器 Zuora
连接器版本 1
连接名称 zuora-con
服务账号 account@my-project.
租户 TENANT
节点数下限 2
节点数上限 4
客户端 ID CLIENT_ID
客户端密钥 CLIENT_SECRET
密钥版本 1

实体、操作和动作

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

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

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

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

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

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

实体操作示例

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

示例 - 列出“退款”中的所有记录

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

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Refunds。
  3. 选择 List 操作，然后点击完成。
  4. 或者，您可以在连接器任务的任务输入部分中，通过指定过滤条件子句来过滤结果集。

示例 - 获取借项凭证记录

此示例从 Debit_Memo 实体中获取 ID 为 45 的记录。

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

    在此示例中，45 是 Debit_Memo 实体的某个主键值。

示例 - 创建工单

此示例在 Ticket 实体中创建工单。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Tickets。
  3. 选择 Create 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值： 
    {
"Name": "Test735362767",
"Label": "Test735362767",
"Type": "String",
"FieldType": "Insert ticket1",
"GroupName": "ticketinformation",
"Description": "Test ticket"
}

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

    {
"Name": "Test1695971640609"
}

示例 - 更新交易条目

此示例会更新 Deals 实体中 ID 为 97 的记录。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 Deals。
  3. 选择 Update 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值： 
    {
"Description": "New description"
}
  5. 点击 entityId，然后在默认值字段中输入 97。

    或者，您也可以将 filterClause 设置为 97，而不是指定 entityId。

示例 - 删除表单

此示例会删除 Forms 实体中 ID 为 78 的记录。

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

使用 Terraform 创建连接

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

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

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

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

参数名称 数据类型 必需 说明
租户 ENUM 错误 将此项设置为您的 Zuora 租户。默认情况下，我们使用“USProduction”租户。支持的值包括：USProduction、USAPISandbox、USPerformanceTest、EUProduction、EUSandbox、EUCentralSandbox、USCloudProduction、USCloudAPISandbox、USCentralSandbox
网址 STRING 错误 仅当您拥有美国正式版副本环境时，此属性才是必需的。如果提供了此属性，则 Tenant 属性的值在身份验证过程中无效。
zuora_service ENUM 错误 指定要使用的执行服务或架构。支持的值包括：DataQuery、AQuADataExport
use_client_side_paging BOOLEAN 错误 CData ADO.NET Provider for SAP Cloud for Customer 是否应使用客户端分页。
use_custom_service BOOLEAN 错误 指示是否应使用自定义 SAP Cloud for Customer OData 服务。
user_defined_views STRING 错误 指向包含自定义视图的 JSON 配置文件的文件路径。

在集成中使用 Zuora 连接

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

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

向 Google Cloud 社区寻求帮助

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

后续步骤