将业务术语表导出到 Google 表格

本文档介绍了如何使用业务术语库导出实用程序将 Knowledge Catalog（以前称为 Dataplex Universal Catalog）中的术语库、类别和术语提取到 Google 工作表中，以便进行批量管理和报告。

glossary_export 实用程序可从知识目录业务术语库中检索元数据，并使用结构化架构（包括说明、数据管家和标签）填充 Google 表格。

准备工作

在导出术语表之前，请先完成以下前提条件。

设置服务账号

如需运行导出实用程序，您必须设置一个服务账号，该账号具有访问 Google Sheets API 和模拟用户凭据的必要权限：

  1. 确定或创建服务账号。

    选择现有服务账号，或在运行导入实用程序的项目中创建新的服务账号。如需了解详情，请参阅创建服务账号。 记下服务账号电子邮件地址（例如 SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com）。

  2. 配置服务账号模拟。

    如需在本地运行导出实用程序脚本，您的用户账号必须具有模拟服务账号的权限。向服务账号授予用户账号的 Service Account Token Creator 角色 (roles/iam.serviceAccountTokenCreator)。

    如需了解详情，请参阅管理对服务账号的访问权限。

  3. 为服务账号 Editor 授予对 Google 表格的访问权限。

    打开要用于导入过程的 Google 表格，点击共享，然后添加服务账号电子邮件地址作为 Editor。此权限可让服务账号从您的工作表中读取数据或向其中写入数据。

所需的角色

如需确保服务账号具有将词汇表导出到 Google 表格所需的权限，请让管理员为服务账号授予以下 IAM 角色：

如需详细了解如何授予角色，请参阅管理对项目、文件夹和组织的访问权限。

您的管理员还可以通过自定义角色或其他预定义角色向服务账号授予所需的权限。

启用 API

如需导出词库，请在项目中启用以下 API：

启用 API 所需的角色

如需启用 API，您需要拥有 Service Usage Admin IAM 角色 (roles/serviceusage.serviceUsageAdmin)，该角色包含 serviceusage.services.enable 权限。了解如何授予角色。

启用 API

设置 Git 代码库

克隆 dataplex-labs 代码库：

git clone https://github.com/GoogleCloudPlatform/dataplex-labs.git
cd dataplex-labs/dataplex-quickstart-labs/00-resources/scripts/python/business-glossary-import/dataplex-glossary/export

安装依赖项

安装所需的 Python 依赖项：

pip3 install -r requirements.txt

如果您在安装软件包时遇到任何问题，请设置新的 Python 开发环境。

进行身份验证并配置服务账号模拟

初始化 Google Cloud CLI 并使用应用默认凭据 (ADC) 通过服务账号模拟进行身份验证：

# Set your service account email address
SA_EMAIL="SERVICE_ACCOUNT_EMAIL"

# Authenticate ADC using service account impersonation and required scopes
gcloud auth application-default login \
  --impersonate-service-account="${SA_EMAIL}" \
  --scopes="https://www.googleapis.com/auth/spreadsheets"

将 SERVICE_ACCOUNT_EMAIL 替换为服务账号电子邮件 ID。 例如：

SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com

设置导出目标 Google 表格

创建空白 Google 表格或使用现有 Google 表格。导出脚本会写入第一个工作表。确保您已向服务账号授予对 Google 表格的 Editor 访问权限。

将词汇表导出到 Google 表格

运行 glossary-export.py 脚本： 在执行过程中，该实用程序会提示您输入目标 Google 工作表和要导出的特定术语库名称：

python3 glossary-export.py

您可以在本地执行路径的 logs/ 目录中查看执行日志。这些日志可帮助您审核转移过程，并识别跳过的条目或格式设置警告。

验证导出的术语表数据

导出脚本会使用以下列填充 Google 表格。 验证导出的数据。

字段 说明
id 词汇表中术语或类别的唯一标识符。
parent 父类别的 ID。
display_name 术语或类别的显示名称。
description 相应术语或类别的简要说明。
overview 相应术语或类别的富文本说明（支持 HTML 标记）。
type 行类型：TERM 或 CATEGORY。
contact1_email 相应术语或类别的主要数据管家的电子邮件地址。
contact1_name 相应术语或类别的主要数据管理员的名称。
contact2_email 相应术语或类别的次要数据管家的电子邮件地址。
contact2_name 相应术语或类别的次要数据管理员的名称。
label1_key 第一个分配的标签的键。
label1_value 第一个分配的标签的值。
label2_key 第二个已分配标签的键。
label2_value 第二个分配的标签的值。

后续步骤