ビジネス用語集を管理する

このドキュメントでは、Dataplex Universal Catalog で Dataplex Universal Catalog ビジネス用語集を作成して管理する方法について説明します。ビジネス用語集を使用して、データアセットの標準化された用語集を確立します。これにより、曖昧さが軽減され、組織全体のデータ検出とガバナンスが向上します。

Dataplex Universal Catalog のビジネス用語集のユースケース

Dataplex Universal Catalog のビジネス用語集を使用してデータに共通言語を作成すると、次のことが可能になります。

ビジネスカテゴリと用語の明確な階層を定義します。
類義語を使用してコンセプトをリンクし、用語間の関係を表示します。
技術名だけでなく、ビジネスコンセプトに基づいてデータリソースを検索します。

Dataplex Universal Catalog のビジネス用語集は、データ検出を効率化して曖昧さを軽減し、ガバナンスの強化、分析の精度向上、分析情報の迅速な取得を実現します。

ビジネス用語集の要素

このセクションでは、ビジネス用語集の構造化に使用できる主な要素について説明します。

用語集

用語集には次のプロパティがあります。

概要。ビジネス用語集の目的と内容を入力します。画像、リンク、表を追加できます。HTML 形式はサポートされていませんが、コードとして書式設定された HTML コードを含めることや、HTML ページへのリンクを追加することはできます。太字、斜体、下線、箇条書き、段落、見出し、コードブロックなどのリッチテキスト形式のオプションも使用できます。対応サイズは最大 120 KB です。
説明。用語集についての説明を入力します。ここに入力した内容は検索用のインデックスに登録されます。対応サイズは最大 1 KB です。
リージョン。用語集を配置するリージョンを指定します。

用語

用語（「用語集の用語」の略）は、会社内の特定の事業分野で使われる概念を表すものです。たとえば、企業のマーケティング部門であれば「クリック単価」を表す用語を作成するといった具合です。用語はビジネス用語集内で定義されています（用語集で直接、または用語集のカテゴリ内で定義）。

用語には、カテゴリのプロパティに加えて、以下のプロパティがあります。

類義語。同じ意味を持つ用語間のリンクを指定します。類義語を参照してください。
関連する用語。概念的には関連しているものの、意味が異なる用語間のリンクを指定します。関連する用語を参照してください。
関連エントリ。用語とデータアセット間、または用語とデータアセット内の列間のリンクを指定します。
連絡先。その用語の管理を担当する人物を指定します。カテゴリで定義した連絡先は用語に継承されません。

用語のリージョンは、その用語が含まれる用語集のリージョンと同じです。

類義語

類義語とは、2つの異なる用語が同じような意味を持つことを示す関係です。同じ意味を持つ 2 つの用語が複数のチームによって別々の用語集に定義されている場合に、類義語を使用します。たとえば、類義語を作成して「利益」と「収益」という用語をリンクできます。

関連する用語とは、2つの用語に互いに関係はあるが、意味は異なることを示す関係です。たとえば、関連する用語を作成して「収益」と「利益」という用語同士をリンクすることができます。

制限事項

Dataplex Universal Catalog のビジネス用語集は、Assured Workloadss のプロジェクトではサポートされていません。
ビジネス用語集はプロジェクトおよびロケーション内に保存されます。用語集には、プロジェクトとロケーションの制限が適用されます。

必要なロール

用語集の作成と管理に必要な権限を取得するには、プロジェクトに対する次の IAM ロールの付与を管理者に依頼してください。

データ管理者には、用語集、カテゴリ、用語、類義語、関連する用語に対する完全なアクセス権と、IAM ポリシーの設定権が付与されます。 Dataplex Catalog 管理者（roles/dataplex.catalogAdmin）
データスチュワードまたはデータオーナーは、用語集、カテゴリ、用語、用語間のリンク、用語とデータアセット間のリンクの作成、編集、削除、さらに検索を行うことができます。 Dataplex Catalog 編集者（roles/dataplex.catalogEditor）
データアナリストまたはデータ利用者は、用語集、カテゴリ、用語、用語間および用語とデータアセット間のリンク、検索に読み取り専用アクセス権を取得します。 Dataplex Catalog 閲覧者（roles/dataplex.catalogViewer）

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

これらの事前定義ロールには、用語集の作成と管理に必要な権限が含まれています。必要とされる正確な権限については、「必要な権限」セクションを開いてご確認ください。

必要な権限

用語集の作成と管理には、次の権限が必要です。

プロジェクトでビジネス用語集、カテゴリ、用語を作成、読み取り、更新、削除します。
- dataplex.glossaries.list
- dataplex.glossaries.create
- dataplex.glossaries.get
- dataplex.glossaries.update
- dataplex.glossaries.delete
- dataplex.glossaryCategories.create
- dataplex.glossaryCategories.list
- dataplex.glossaryCategories.get
- dataplex.glossaryCategories.update
- dataplex.glossaryCategories.delete
- dataplex.glossaryTerms.create
- dataplex.glossaryTerms.list
- dataplex.glossaryTerms.get
- dataplex.glossaryTerms.update
- dataplex.glossaryTerms.delete
プロジェクト内で類義語の用語間リンクを作成、削除する:
- いずれかの用語が含まれているプロジェクトの Dataplex Universal Catalog エントリグループに対する dataplex.entryLinks.create。リンクは、権限が付与されているエントリグループに作成されます。
- いずれかの用語が含まれているプロジェクトの Dataplex Universal Catalog エントリグループに対する dataplex.entryGroups.useSynonymEntryLink。リンクは、権限が付与されているエントリグループに作成されます。
- 用語を関連付ける必要がある用語集に対する dataplex.glossaryTerms.use。
- リンクが存在するプロジェクトの Dataplex Universal Catalog エントリグループに対する dataplex.entryLinks.delete。
プロジェクト内で関連する用語間のリンクを作成、削除する:
- いずれかの用語が含まれているプロジェクトの Dataplex Universal Catalog エントリグループに対する dataplex.entryLinks.create。リンクは、権限が付与されているエントリグループに作成されます。
- いずれかの用語が含まれているプロジェクトの Dataplex Universal Catalog エントリグループに対する dataplex.entryGroups.useRelatedEntryLink。リンクは、権限が付与されているエントリグループに作成されます。
- 用語集の用語に対応するエントリが存在するプロジェクトの Dataplex Universal Catalog エントリグループに対する dataplex.entries.link。
- リンクが存在するプロジェクトの Dataplex Universal Catalog エントリグループに対する dataplex.entryLinks.delete。
プロジェクト内の用語とデータアセットまたは列の間にリンクを作成します。
- プロジェクト内のデータアセットまたは列に対応するシステムエントリグループに対する dataplex.entryLinks.create。リンクは、権限が付与されているプロジェクトに作成されます。
- プロジェクト内のデータアセットまたは列に対応するシステムエントリグループに対する dataplex.entryGroups.useDefinitionEntryLink。リンクは、権限が付与されているプロジェクトに作成されます。
- プロジェクト内のデータアセットまたは列に対応するシステムエントリグループに対する dataplex.entries.link。リンクは、権限が付与されているプロジェクトに作成されます。
- 用語を関連付ける必要がある用語集に対する dataplex.glossaryTerms.use 。
- リンクが存在するシステムエントリグループに対する dataplex.entryLinks.delete。

カスタムロールや他の事前定義ロールを使用して、これらの権限を取得することもできます。

詳細については、Dataplex Universal Catalog IAM ロールをご覧ください。

ビジネス用語集を作成して管理する

以降のセクションでは、ビジネス用語集の作成、表示、編集、削除について説明します。

ビジネス用語集を作成する

コンソール

Google Cloud コンソールで、Dataplex Universal Catalog の [用語集] ページに移動します。

[用語集] に移動
[ビジネス用語集を作成] をクリックします。
[ビジネス用語集を作成] ページで、ビジネス用語集の名前とロケーションを指定します。用語集を作成した後に、ロケーションを変更することはできません。
[作成] をクリックします。用語集が現在のプロジェクトの配下に作成されます。
省略可: [説明] に簡単な説明（最大 1,024 文字）を追加するか、[概要] に詳細な説明（最大 120 KB）を追加します。

REST

用語集を作成すると、Dataplex Universal Catalog は用語集を表すエントリを作成します。

用語集を作成します。

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries?glossary_id=GLOSSARY_ID --data @- << EOF
{
"displayName": "DISPLAY_NAME",
"description": "DESCRIPTION"
}
EOF

次のように置き換えます。

PROJECT_ID: 用語集を作成するプロジェクトの ID
LOCATION_ID: 用語集を作成するロケーションの ID
GLOSSARY_ID: 用語集の ID
DISPLAY_NAME: 用語集の表示名
DESCRIPTION: 用語集の説明（最大 1,024 文字）

省略可: 用語集に概要を追加します。

用語集のエントリを検索します。

gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
:lookupEntry\
?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID
\
\&view=ALL

PROJECT_NUMBER は、用語集が作成されているプロジェクトの数に置き換えます。

用語集に概要を追加します。

gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID\
?update_mask=aspects\
\&deleteMissingAspects=false\
\&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/overview \
--data @- << EOF
{
"aspects": {
   "dataplex-types.global.overview": {
      "aspect_type": "projects/dataplex-types/locations/global/aspectTypes/overview",
      "data": {
      "content": "OVERVIEW",
      "links": []
      },
   }
}
}
EOF

OVERVIEW は、用語集のカテゴリまたは用語を記述するプレーンテキストまたは HTML に置き換えます。

利用可能な用語集を表示する

コンソール

Google Cloud コンソールで、Dataplex Universal Catalog の [用語集] ページに移動します。

[用語集] に移動

[マイ用語集] ペインには、表示する権限がある組織のすべての用語集と、その説明と最終更新日時が表示されます。

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries

用語集を編集する

用語集の名前と説明は編集できます。

コンソール

Google Cloud コンソールで、Dataplex Universal Catalog の [用語集] ページに移動します。

[用語集] に移動
編集する用語集をクリックします。
名前、説明、概要の横にある [編集] をクリックして、変更を加えます。
[保存] をクリックします。

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID?update_mask=displayName,description --data @- << EOF
{
"displayName": "DISPLAY_NAME",
"description": "DESCRIPTION"
}
EOF

用語集を削除する

用語集を削除する前に、まず用語集のすべてのカテゴリと用語を削除する必要があります。

コンソール

Google Cloud コンソールで、Dataplex Universal Catalog の [用語集] ページに移動します。

[用語集] に移動
削除する用語集をクリックします。
[削除] をクリックし、プロンプトが表示されたら確定します。

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X DELETE https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID

カテゴリの作成と管理

以降のセクションでは、カテゴリの作成、表示、更新、削除の方法について説明します。

用語集にカテゴリを作成する

ビジネス用語集に設定できるカテゴリは 200 個までです。

コンソール

Google Cloud コンソールで、Dataplex Universal Catalog の [用語集] ページに移動します。

[用語集] に移動
カテゴリを作成する用語集を選択し、[カテゴリを作成] をクリックします。
カテゴリの名前を入力します。
[作成] をクリックします。
省略可: [説明] に簡単な説明（最大 1,024 文字）を追加するか、[概要] に詳細な説明（最大 120 KB）を追加します。

REST

カテゴリを作成すると、Dataplex Universal Catalog はカテゴリを表すエントリを作成します。

カテゴリを作成します。

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories?category_id=CATEGORY_ID --data @- << EOF
{
"displayName": "CATEGORY_DISPLAY_NAME",
"description": "CATEGORY_DESCRIPTION",
"parent": "projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID"
}
EOF

次のように置き換えます。

CATEGORY_ID: カテゴリ ID
CATEGORY_DISPLAY_NAME: カテゴリの表示名
CATEGORY_DESCRIPTION: カテゴリの説明

省略可: カテゴリに概要を追加します。

カテゴリのエントリを検索します。

gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
:lookupEntry\
?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID
\
\&view=ALL

カテゴリに概要を追加します。

gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID\
?update_mask=aspects\
\&deleteMissingAspects=false\
\&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/overview
\
--data @- << EOF
{
"aspects": {
"dataplex-types.global.overview": {
   "aspect_type":"projects/dataplex-types/locations/global/aspectTypes/overview
",
   "data": {
   "content": "OVERVIEW",
   "links": []
   },
}
}
}
EOF

OVERVIEW は、用語集のカテゴリまたは用語を記述するプレーンテキストまたは HTML に置き換えます。

省略可: 連絡先を追加する

カテゴリのエントリを検索します。

gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
:lookupEntry\
?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID
\
\&view=ALL

カテゴリのエントリを連絡先で更新します。

gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID\
?update_mask=aspects\
\&deleteMissingAspects=false\
\&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/contacts \
--data @- << EOF
{
"aspects": {
"dataplex-types.global.contacts": {
   "aspect_type": "projects/dataplex-types/locations/global/aspectTypes/contacts",
   "data": {
   "identities": [
      {
         "role": "steward",
         "name": "CONTACT_NAME",
         "id": "CONTACT_EMAIL"
      }
   ]
   },
}
}
}
EOF

ネストされたカテゴリを作成する

ビジネス用語集には、ルート用語集レベルを除き、ネストされたカテゴリレベルを 3 つまで設定できます。

コンソール

Google Cloud コンソールで、Dataplex Universal Catalog の [用語集] ページに移動します。

[用語集] に移動
カテゴリを作成する用語集を開きます。
別のカテゴリを作成する親カテゴリを選択し、[カテゴリを作成] をクリックします。
カテゴリの名前を入力します。
[作成] をクリックします。
省略可: [説明] に簡単な説明（最大 1,024 文字）を追加するか、[概要] に詳細な説明（最大 120 KB）を追加します。

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories?category_id=CATEGORY_ID --data @- << EOF
{
  "displayName": "CATEGORY_DISPLAY_NAME",
  "description": "CATEGORY_DESCRIPTION",
  "parent": "projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/PARENT_CATEGORY_ID"
}
EOF

PARENT_CATEGORY_ID は、親カテゴリの ID に置き換えます。

用語集に属するカテゴリを表示する

コンソール

Google Cloud コンソールで、Dataplex Universal Catalog の [用語集] ページに移動します。

[用語集] に移動
用語集のカテゴリを表示するには、その用語集を開きます。
カテゴリ内のネストされたカテゴリを表示するには、カテゴリを開きます。

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories

カテゴリを編集する

カテゴリの名前、説明、連絡先を編集できます。ネストされたカテゴリの場合は、親カテゴリを編集することもできます。

コンソール

Google Cloud コンソールで、Dataplex Universal Catalog の [用語集] ページに移動します。

[用語集] に移動
用語集を開いて、編集するカテゴリをクリックします。
名前、説明、概要の横にある編集アイコンをクリックして、変更を加えます。
[保存] をクリックします。

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID?update_mask=displayName,description --data @- << EOF
{
"displayName": "CATEGORY_DISPLAY_NAME",
"description": "DESCRIPTION"
}
EOF

ビジネス用語集を管理する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

Dataplex Universal Catalog のビジネス用語集のユースケース

ビジネス用語集の要素

用語集

カテゴリ

用語

類義語

関連する用語

制限事項

必要なロール

必要な権限

ビジネス用語集を作成して管理する

ビジネス用語集を作成する

コンソール

REST

利用可能な用語集を表示する

コンソール

REST

用語集を編集する

コンソール

REST

用語集を削除する

コンソール

REST

カテゴリの作成と管理

用語集にカテゴリを作成する

コンソール

REST

ネストされたカテゴリを作成する

コンソール

REST

用語集に属するカテゴリを表示する

コンソール

REST

カテゴリを編集する

コンソール

REST

カテゴリを削除する

ビジネス用語集を管理する