Google スプレッドシートからエントリのリンクをインポートする

このドキュメントでは、エントリリンク インポート ユーティリティを使用して、Google スプレッドシートから Knowledge Catalog（以前の Dataplex Universal Catalog）にエントリリンク（用語集の用語とデータアセット間の関係。definition、related、synonym エントリリンク タイプなど）を一括インポートする方法について説明します。

始める前に

エントリリンクを Knowledge Catalog にインポートする前に、次の前提条件を満たしていることを確認してください。

サービス アカウントを設定する

Google スプレッドシートを使用してインポート ユーティリティを実行するには、Google Sheets API にアクセスしてユーザー認証情報を借用するために必要な権限を持つサービス アカウントを設定する必要があります。

  1. サービス アカウントを特定または作成します。

    インポート ユーティリティを実行するプロジェクトで、既存のサービス アカウントを選択するか、新しいサービス アカウントを作成します。詳細については、 サービス アカウントの作成をご覧ください。 サービス アカウントのメールアドレス （例: SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com）をメモします。

  2. サービス アカウントの権限借用を構成します。

    インポート ユーティリティ スクリプトをローカルで実行するには、ユーザー アカウントにサービス アカウントの権限を借用する権限が必要です。ユーザー アカウントにサービス アカウントのサービス アカウント トークン作成者 ロール（roles/iam.serviceAccountTokenCreator）を付与します。

    詳細については、 サービス アカウントに対するアクセス権の管理をご覧ください。

  3. サービス アカウントに Google スプレッドシートへの Editor アクセス権を付与します。

    インポート プロセスで使用する Google スプレッドシートを開き、[共有] をクリックして、サービス アカウントのメールアドレスを Editor として追加します。この権限により、サービス アカウントはシートからデータを読み取ったり、シートにデータを書き込んだりできます。

Cloud Storage バケットを作成する

インポート ファイルのステージング領域として機能する Cloud Storage バケットを作成します。

必要なロール

Google スプレッドシートからエントリリンクをインポートするために必要な権限がサービス アカウントに付与されるように、次の IAM ロールをサービス アカウントに付与するよう管理者に依頼してください。

ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

管理者は、カスタムロールや他の事前定義ロールを使用して、必要な権限をサービス アカウントに付与することもできます。

API を有効にする

エントリリンクをインポートするには、プロジェクトで次の API を有効にします。

API を有効にするために必要なロール

API を有効にするには、serviceusage.services.enable 権限を含む Service Usage 管理者 IAM ロール（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/import

依存関係のインストール

必要な Python 依存関係をインストールします。

pip3 install -r requirements.txt
cd dataplex-glossary

パッケージのインストールで問題が発生した場合は、 新しい 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 init
gcloud auth login
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 Cloud

  • プロジェクト間の IAM 権限を構成する: インポート スクリプトを実行するサービス アカウントには、すべてのターゲット プロジェクトで十分な権限が必要です。

  • エントリの存在を確認する: インポートを実行する前に、ターゲット エントリがそれぞれの Knowledge Catalog プロジェクトに存在している必要があります。

  • Cloud Storage バケットへのアクセス権を Knowledge Catalog サービス エージェントに付与する: 各ターゲット プロジェクトの Knowledge Catalog サービス アカウントには、Cloud Storage バケットへのアクセス権が必要です。

インポート用の Google スプレッドシートを作成して構造化する

一括インポートを正常に実行するには、インポート ユーティリティがメタデータ フィールドを正常に解析して検証できるように、正確な列スキーマを使用して新しい Google スプレッドシートを作成する必要があります。サービス アカウントに Google スプレッドシートへの Editor アクセス権が付与されていることを確認してください。

シートの最初の行には、次の大文字と小文字が区別されるスキーマ ヘッダーが含まれている必要があります。

列見出し 必須または省略可 説明
entry_link_type 必須 値は definition、related、synonym のいずれかである必要があります。
source_entry 必須 ソース エントリの完全なリソースパス（形式:
projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRYGROUP_NAME/entries/ENTRY_NAME）
target_entry 必須 ターゲット エントリの完全なリソースパス（形式:
projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRYGROUP_NAME/entries/ENTRY_NAME）
source_path 省略可 定義リンクの列またはフィールド パス（ Schema.column_name など）。

環境変数を設定する

次の環境変数を設定します。

# Set your Google Sheet URL
export SPREADSHEET_URL="GOOGLE_SHEET_URL"

# Set your bucket name
export BUCKETS="COMMA_SEPARATED_LIST_OF_BUCKETS"

# Set the project ID
export USER_PROJECT="USER_PROJECT"

Google スプレッドシートからエントリリンクをインポートする

Google スプレッドシートから Knowledge Catalog にエントリリンクをインポートするには、entrylinks-import.py スクリプトを実行します。

cd import
python3 entrylinks-import.py \
  --spreadsheet-url="$SPREADSHEET_URL" \
  --buckets="$BUCKETS" \
  --user-project="$USER_PROJECT"

複数のインポート ジョブを並行して実行するには、--buckets パラメータで複数の Cloud Storage バケットを指定します。このスクリプトは、メタデータを小さなバッチに分割し、バケット間で同時に処理することで、取り込み時間の合計を短縮します。

bucket-1,bucket-2,bucket-3

実行ログは、ローカル実行パスの logs/ ディレクトリで確認できます。これらのログは、転送プロセスを監査し、スキップされたエントリやフォーマットに関する警告を特定するのに役立ちます。

次のステップ