Exporta glosarios de la empresa a una hoja de cálculo de Google

La utilidad de exportación del glosario empresarial te permite extraer glosarios, categorías y términos de Knowledge Catalog (anteriormente, Dataplex Universal Catalog) a una hoja de cálculo de Google. Luego, puedes administrar tus metadatos de forma masiva y generar informes.

Antes de comenzar

Antes de exportar glosarios, completa los siguientes requisitos previos.

Configura la cuenta de servicio

Para ejecutar la utilidad de exportación, debes configurar una cuenta de servicio con los permisos necesarios para acceder a la API de Google Sheets y actuar en nombre de tus credenciales de usuario:

  1. Identifica o crea una cuenta de servicio.

    Selecciona una cuenta de servicio existente o crea una nueva en el proyecto en el que ejecutas la utilidad de importación. Para obtener más información, consulta Crea cuentas de servicio. Toma nota del correo electrónico de la cuenta de servicio (por ejemplo, SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com).

  2. Configura la identidad temporal como cuenta de servicio.

    Para ejecutar la secuencia de comandos de la utilidad de exportación de forma local, tu cuenta de usuario debe tener permiso para actuar como la cuenta de servicio. Otorga a tu cuenta de usuario el rol de Creador de tokens de cuenta de servicio (roles/iam.serviceAccountTokenCreator) en la cuenta de servicio.

    Para obtener más información, consulta Administra el acceso a las cuentas de servicio.

  3. Otorga a la cuenta de servicio Editor acceso a la hoja de cálculo de Google.

    Abre la hoja de cálculo de Google que deseas usar para el proceso de importación, haz clic en Compartir y agrega el correo electrónico de la cuenta de servicio como Editor. Este permiso permite que la cuenta de servicio lea o escriba datos en tu hoja.

Roles obligatorios

Para garantizar que la cuenta de servicio tenga los permisos necesarios para exportar glosarios a una hoja de cálculo de Google, pídele a tu administrador que otorgue los siguientes roles de IAM a la cuenta de servicio:

Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

Es posible que tu administrador también pueda otorgar a la cuenta de servicio los permisos necesarios a través de roles personalizados o de otros roles predefinidos.

Habilita las APIs

Para exportar glosarios, habilita las siguientes APIs en tu proyecto:

Roles necesarios para habilitar las APIs

Para habilitar las APIs, necesitas el permiso serviceusage.services.enable. Si creaste el proyecto, es probable que ya tengas este permiso a través del rol de propietario (roles/owner). De lo contrario, puedes obtenerlo a través del rol de administrador de Service Usage (roles/serviceusage.serviceUsageAdmin). Obtén información para otorgar roles.

Habilitar las API

Configura el repositorio de Git

Clona el repositorio 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

Instala dependencias

Instala las dependencias de Python necesarias:

pip3 install -r requirements.txt

Si tienes algún problema con la instalación del paquete, configura un entorno de desarrollo de Python nuevo.

Autentica y configura la identidad temporal como cuenta de servicio

Inicializa Google Cloud CLI y autentícate con las credenciales predeterminadas de la aplicación (ADC) con la identidad temporal como cuenta de servicio:

# 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"

Reemplaza SERVICE_ACCOUNT_EMAIL por el ID de correo electrónico de la cuenta de servicio. Por ejemplo:

SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com

Configura la Hoja de cálculo de Google de destino para la exportación

Crea una hoja de cálculo de Google vacía o usa una existente. La secuencia de comandos de exportación escribe en la primera hoja. Asegúrate de haber otorgado a la cuenta de servicio Editor acceso a la hoja de cálculo de Google.

Exporta el glosario a la hoja de cálculo de Google

Ejecuta la secuencia de comandos glossary-export.py. La utilidad te solicita la hoja de cálculo de Google de destino y el nombre del glosario específico que deseas exportar durante la ejecución:

python3 glossary-export.py

Puedes revisar los registros de ejecución en el directorio logs/ de tu ruta de acceso de ejecución local. Estos registros te ayudan a auditar el proceso de transferencia y a identificar las entradas omitidas o las advertencias de formato.

Verifica los datos del glosario exportado

La secuencia de comandos de exportación recupera los metadatos del glosario empresarial de Knowledge Catalog y propaga la hoja de cálculo de Google con un esquema estructurado, que incluye descripciones, administradores de datos y etiquetas. Verifica los datos exportados en las siguientes columnas:

Campo Descripción
id Es un identificador único para el término o la categoría dentro del glosario.
parent Es el ID de la categoría superior.
display_name Es el nombre visible del término o la categoría.
description Una breve descripción del término o la categoría.
overview Es una descripción en texto enriquecido del término o la categoría (admite etiquetas HTML).
type El tipo de fila: TERM o CATEGORY.
contact1_email Es la dirección de correo electrónico del administrador de datos principal del término o la categoría.
contact1_name Es el nombre del administrador de datos principal del término o la categoría.
contact2_email Es la dirección de correo electrónico del administrador de datos secundario para el término o la categoría.
contact2_name Es el nombre del administrador de datos secundario del término o la categoría.
label1_key Es la clave de la primera etiqueta asignada.
label1_value Es el valor de la primera etiqueta asignada.
label2_key Es la clave de la segunda etiqueta asignada.
label2_value Es el valor de la segunda etiqueta asignada.

¿Qué sigue?