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

借助业务术语库导出实用程序，您可以将术语库、类别和术语从 Knowledge Catalog（以前称为 Dataplex Universal Catalog）提取到 Google 表格中。然后，您可以批量管理元数据并生成报告。

准备工作

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

设置服务帐号

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

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

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

  2. 配置服务帐号模拟。

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

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

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

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

所需角色

如需确保服务帐号具有将术语库导出到 Google 表格所需的 权限，请让您的管理员向服务帐号授予以下 IAM 角色：

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

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

启用 API

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

启用 API 所需的角色

如需启用 API，您需要拥有 serviceusage.services.enable 权限。如果您 创建了项目，则您可能已通过 Owner 角色 (roles/owner) 拥有此权限。否则，您可以通过 Service Usage Admin 角色 (roles/serviceusage.serviceUsageAdmin) 获得此权限。 了解如何授予角色。

启用 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 替换为服务帐号电子邮件地址。 例如：

SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com

设置用于导出的目标 Google 表格

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

将术语库导出到 Google 表格

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

python3 glossary-export.py

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

验证导出的术语库数据

导出脚本会从 Knowledge Catalog 业务术语库中检索元数据，并使用结构化架构（包括说明、数据监管和标签）填充 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 第二个分配的标签的值。

后续步骤