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

Dataplex Universal Catalog のビジネス用語集では、組織全体でビジネス関連の用語と定義を一元管理できます。

複数のチームで共有プロジェクトに取り組んでいる場合や、多くの部署がある大企業においては、企業の各部署が、扱うさまざまなデータリソースを記述する独自の用語を作成することがよくあります。これにより、誤解や、これらのリソースの認識に違いが生じたりする可能性があります。また、概念によっては技術的あるいは専門的な知識が必要になることもあり、そのような概念は他のドメインのビジネス ユーザーにとって理解しにくくなる可能性があります。

Dataplex Universal Catalog のビジネス用語集を使用すると、データリソースの一元的、標準的な用語集を作成できます。ビジネス用語集は次のように活用できます。

  • 「用語」と呼ばれる、事業の種類や概念の階層構造を定義する。
  • 同義語や関連用語を定義することで、概念同士のつながりを作成する。
  • データリソースを用語集内の用語に関連付けることで、事業の概念に基づいてデータリソースを検索する。

ビジネス用語集を活用することで、データ探索を効率的に行って曖昧さを減らすことができ、より正確な分析、優れたガバナンス、迅速なインサイト獲得につながります。

ビジネス用語集の要素

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

用語集

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

  • 概要。ビジネス用語集の目的と内容を入力します。用語集には、画像、リンク、表、書式設定されたテキストを追加できます。対応サイズは最大 120 KB です。
  • 説明。用語集についての説明を入力します。ここに入力した内容は検索用のインデックスに登録されます。対応サイズは最大 1 KB です。
  • リージョン。用語集を配置するリージョンを指定します。

カテゴリ

カテゴリを使用すると、さまざまなカテゴリと用語を整理して構造化できます。カテゴリはビジネス用語集内で定義します。カテゴリは 3 階層までネストできます。

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

  • 連絡先。カテゴリの管理を担当する人物を指定します。このプロパティは説明的なものであり、カテゴリの権限には影響しません。
  • 。現在のカテゴリの親を確立するために使う関係を指定します。最大 3 つまでネストできます。

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

用語

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

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

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

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

類義語

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

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

制限事項

必要なロール

用語集の作成と管理に必要な権限を取得するには、プロジェクトに対する次の 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

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

詳細については、Data Catalog の事前定義ロールをご覧ください。

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

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

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

コンソール

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

    [用語集] に移動

  2. [ビジネス用語集を作成] をクリックします。

  3. [ビジネス用語集を作成] ページで、ビジネス用語集の名前とロケーションを指定します。用語集を作成した後に、ロケーションを変更することはできません。

  4. [作成] をクリックします。用語集が現在のプロジェクトの配下に作成されます。

  5. 省略可: [説明] に簡単な説明(最大 1,024 文字)を追加するか、[概要] に詳細な説明(最大 120 KB)を追加します。

REST

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

  1. 用語集を作成します。

    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 文字)
  2. 省略可: 用語集に概要を追加します。

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

      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 は、用語集が作成されているプロジェクトの数に置き換えます。

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

      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

用語集を編集する

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

コンソール

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

    [用語集] に移動

  2. 編集する用語集をクリックします。

  3. 名前、説明、概要の横にある [編集] をクリックして、変更を加えます。

  4. [保存] をクリックします。

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

用語集を削除する

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

コンソール

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

    [用語集] に移動

  2. 削除する用語集をクリックします。

  3. [削除] をクリックし、プロンプトが表示されたら確定します。

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 個までです。

コンソール

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

    [用語集] に移動

  2. カテゴリを作成する用語集を選択し、[カテゴリを作成] をクリックします。

  3. カテゴリの名前を入力します。

  4. [作成] をクリックします。

  5. 省略可: [説明] に簡単な説明(最大 1,024 文字)を追加するか、[概要] に詳細な説明(最大 120 KB)を追加します。

REST

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

  1. カテゴリを作成します。

    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: カテゴリの説明
  2. 省略可: カテゴリに概要を追加します。

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

      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
    2. カテゴリに概要を追加します。

      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 に置き換えます。

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

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

      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
    2. カテゴリのエントリを連絡先で更新します。

      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 つまで設定できます。

コンソール

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

    [用語集] に移動

  2. カテゴリを作成する用語集を開きます。

  3. 別のカテゴリを作成する親カテゴリを選択し、[カテゴリを作成] をクリックします。

  4. カテゴリの名前を入力します。

  5. [作成] をクリックします。

  6. 省略可: [説明] に簡単な説明(最大 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 に置き換えます。

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

コンソール

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

    [用語集] に移動

  2. 用語集のカテゴリを表示するには、その用語集を開きます。

  3. カテゴリ内のネストされたカテゴリを表示するには、カテゴリを開きます。

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

カテゴリを編集する

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

コンソール

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

    [用語集] に移動

  2. 用語集を開いて、編集するカテゴリをクリックします。

  3. 名前、説明、概要の横にある 編集アイコンをクリックして、変更を加えます。

  4. [保存] をクリックします。

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

カテゴリを削除する

コンソール

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

    [用語集] に移動

  2. 用語集を開き、削除するカテゴリをクリックします。

  3. [削除] をクリックし、プロンプトが表示されたら確定します。

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/categories/CATEGORY_ID

用語の作成と管理

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

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

ビジネス用語集に登録できる用語は最大 5,000 個です。

コンソール

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

    [用語集] に移動

  2. 用語集レベルで用語を作成するには、用語を作成する用語集を選択し、[用語を作成] をクリックします。

  3. 用語の名前を入力します。

  4. [作成] をクリックします。

  5. 省略可: [説明] に簡単な説明(最大 1,024 文字)を追加するか、[概要] に詳細な説明(最大 120 KB)を追加します。

  6. 省略可: 連絡先を追加するには、[編集] をクリックし、データ スチュワード、データオーナー、データドメイン オーナーのメールアドレスのリストを指定します。[保存] をクリックします。

REST

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

  1. 用語を作成します。

    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/terms?term_id=TERM_ID --data @- << EOF
    {
    "displayName": "TERM_DISPLAY_NAME",
    "description": "TERM_DESCRIPTION",
    "parent": "projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID"
    }
    EOF

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

    • TERM_ID: 作成する用語の ID
    • TERM_DISPLAY_NAME: 作成する用語の表示名
    • TERM_DESCRIPTION: 作成する用語の説明
  2. 省略可: 用語の概要を追加します。

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

      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/terms/TERM_ID
      \
      \&view=ALL
    2. 用語に概要を追加します。

      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/terms/TERM_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 に置き換えます。

  3. 省略可: 連絡先を追加します。

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

      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/terms/TERM_ID
      \
      \&view=ALL
    2. 連絡先を含む期間のエントリを更新します。

      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/terms/TERM_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

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

コンソール

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

    [用語集] に移動

  2. カテゴリに用語を作成するには、用語を作成するカテゴリを選択し、[キーワードを追加] をクリックします。

  3. 用語の名前を入力します。

  4. [作成] をクリックします。

  5. 省略可: [説明] に簡単な説明(最大 1,024 文字)を追加するか、[概要] に詳細な説明(最大 120 KB)を追加します。

  6. 省略可: 連絡先を追加するには、[編集] をクリックし、データ スチュワード、データオーナー、データドメイン オーナーのメールアドレスのリストを指定します。[保存] をクリックします。

REST

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

  1. 用語を作成する

    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/terms?term_id=TERM_ID --data @- << EOF
    {
    "displayName": "TERM_DISPLAY_NAME",
    "description": "TERM_DESCRIPTION",
    "parent": "projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/PARENT_CATEGORY_ID"
    }
    EOF

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

    • TERM_ID: 作成する用語の ID
    • TERM_DISPLAY_NAME: 作成する用語の表示名
    • TERM_DESCRIPTION: 作成する用語の説明
  2. 省略可: 用語の概要を追加します。

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

      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/terms/TERM_ID
      \
      \&view=ALL
    2. 用語に概要を追加します。

      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/terms/TERM_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 に置き換えます。

  3. 省略可: 連絡先を追加します。

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

      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/terms/TERM_ID
      \
      \&view=ALL
    2. 連絡先を含む期間のエントリを更新します。

      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/terms/TERM_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

用語集またはカテゴリ内の用語を表示する

コンソール

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

    [用語集] に移動

  2. 用語集にある用語を表示するには、その用語集を開きます。この用語集内のカテゴリにある用語を表示するには、カテゴリを開きます。ネストされたカテゴリ内の用語を表示するには、ネストされたカテゴリを開きます。

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/terms

用語の詳細を表示する

コンソール

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

    [用語集] に移動

  2. 用語集にある用語のリストを表示するには、用語集を開きます。

  3. 用語をクリックします。[用語の詳細] ページには、用語名、説明、関連する用語、類義語、関連エントリが表示されます。

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/terms/TERM_ID

用語を編集する

用語の名前、説明、概要、連絡先、親を編集できます。

コンソール

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

    [用語集] に移動

  2. 用語集を開き、編集する用語をクリックします。

  3. [編集] をクリックします。

  4. フィールドを編集して [保存] をクリックします。

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/terms/TERM_ID?update_mask=displayName,description --data @- << EOF
{
  "displayName": "TERM_DISPLAY_NAME",
  "description": "TERM_DESCRIPTION"
}
EOF

用語を削除する

コンソール

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

    [用語集] に移動

  2. 用語集を開き、削除する用語をクリックします。

  3. [削除] をクリックし、プロンプトが表示されたら確定します。

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/terms/TERM_ID

用語を類義語または関連する用語としてリンクすることで、用語間の関係を追加できます。

用語の関係は双方向です。たとえば、earnings の類義語として profit を選択すると、earningsprofit の類義語にもなります。

コンソール

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

    [用語集] に移動

  2. 用語集を開き、リンクを作成する用語をクリックします。

  3. [類義語] の横にある [編集] をクリックします。

  4. リンク先の用語を検索して選択します。

    用語は選択するとすぐにリンクされます。

  5. [閉じる] をクリックします。

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/TERM1_PROJECT_ID/locations/TERM1_LOCATION_ID/entryGroups/@dataplex/entryLinks?entry_link_id=ENTRY_LINK_ID -d "$(cat<<EOF
{
  "entry_link_type": "projects/dataplex-types/locations/global/entryLinkTypes/synonym",
"entry_references": [{
     "name": "projects/TERM1_PROJECT_NUMBER/locations/TERM1_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM1_PROJECT_NUMBER/locations/TERM1_LOCATION_ID/glossaries/TERM1_GLOSSARY_ID/terms/TERM1_ID",
     "type": "UNSPECIFIED"
  }, {
     "name": "projects/TERM2_PROJECT_NUMBER/locations/TERM2_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM2_PROJECT_NUMBER/locations/TERM2_LOCATION_ID/glossaries/TERM2_GLOSSARY_ID/terms/TERM2_ID",
     "type": "UNSPECIFIED"
  }
  ]

}
EOF
)"

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

  • TERM1_PROJECT_NUMBER: リンクする最初の用語のプロジェクト番号。
  • TERM1_LOCATION_ID: 最初の用語を含む用語集のロケーション ID。
  • TERM1_GLOSSARY_ID: 最初の用語を含む用語集の ID。
  • TERM1_ID: 最初の用語の ID。
  • TERM2_PROJECT_NUMBER: 類義語としてリンクする 2 つ目の用語のプロジェクト番号。両方の用語が同じプロジェクトにある場合、この値は最初の用語のプロジェクト番号と同じです。
  • TERM2_LOCATION_ID: 2 つ目の用語を含む用語集のロケーション ID。両方の用語が同じロケーションにある場合、この値は最初の用語のロケーション ID と同じです。
  • TERM2_GLOSSARY_ID: 2 番目の用語を含む用語集の ID。両方の用語が同じ用語集にある場合、この値は最初の用語の用語集 ID と同じです。
  • TERM2_ID: 2 番目の用語の ID。
  • ENTRY_LINK_ID: 2 つの用語間のリンクの ID。各用語は Dataplex Universal Catalog のエントリとして表されます。エントリリンクは、類義語の用語間の関係です。

コンソール

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

    [用語集] に移動

  2. 用語集を開き、リンクを作成する用語をクリックします。

  3. [関連する用語] の横にある [編集] をクリックします。

  4. リンク先の用語を検索して選択します。

    用語は選択するとすぐにリンクされます。

  5. [閉じる] をクリックします。

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/TERM1_PROJECT_ID/locations/TERM1_LOCATION_ID/entryGroups/@dataplex/entryLinks?entry_link_id=ENTRY_LINK_ID -d "$(cat<<EOF
{
  "entry_link_type": "projects/dataplex-types/locations/global/entryLinkTypes/related",
"entry_references": [{
     "name": "projects/TERM1_PROJECT_NUMBER/locations/TERM1_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM1_PROJECT_NUMBER/locations/TERM1_LOCATION_ID/glossaries/TERM1_GLOSSARY_ID/terms/TERM1_ID",
     "type": "UNSPECIFIED"
  }, {
     "name": "projects/TERM2_PROJECT_NUMBER/locations/TERM2_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM2_PROJECT_NUMBER/locations/TERM2_LOCATION_ID/glossaries/TERM2_GLOSSARY_ID/terms/TERM2_ID",
     "type": "UNSPECIFIED"
  }
  ]

}
EOF
)"

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

  • TERM1_PROJECT_NUMBER: リンクする最初の用語のプロジェクト番号。
  • TERM1_LOCATION_ID: 最初の用語を含む用語集のロケーション ID。
  • TERM1_GLOSSARY_ID: 最初の用語を含む用語集の ID。
  • TERM1_ID: 最初の用語の ID。
  • TERM2_PROJECT_NUMBER: 関連する用語としてリンクする 2 つ目の用語のプロジェクト番号。両方の用語が同じプロジェクトにある場合、この値は最初の用語のプロジェクト番号と同じです。
  • TERM2_LOCATION_ID: 2 つ目の用語を含む用語集のロケーション ID。両方の用語が同じロケーションにある場合、この値は最初の用語のロケーション ID と同じです。
  • TERM2_GLOSSARY_ID: 2 番目の用語を含む用語集の ID。両方の用語が同じ用語集にある場合、この値は最初の用語の用語集 ID と同じです。
  • TERM2_ID: 2 番目の用語の ID。
  • ENTRY_LINK_ID: 2 つの用語間のリンクの ID。各用語は Dataplex Universal Catalog のエントリとして表されます。エントリリンクは、関連する用語間の関係です。

コンソール

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

    [用語集] に移動

  2. 用語集を開き、類義語または関連する用語を削除する用語をクリックします。

  3. 関連する用語間のリンクを削除するには、[関連する用語] の横にある [編集] をクリックします。関連する用語を削除し、[閉じる] をクリックします。

  4. 類義語間のリンクを削除するには、[類義語] の横にある [編集] をクリックします。類義語を削除し、[閉じる] をクリックします。

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/entryGroups/ENTRY_GROUP_ID/entryLinks/ENTRY_LINK_ID

用語は、データアセットまたはデータアセットの列にアタッチできます。たとえば、BigQuery データセットに用語を関連付けることができます。

コンソール

  1. Google Cloud コンソールで、Dataplex Universal Catalog の [検索] ページに移動します。

    [検索] に移動

  2. 用語をリンクするデータアセット(データセット、ファイル、テーブルなど)を検索してクリックします。

  3. データアセット ページで、次のどちらかを行います。

    • 用語をアセットにリンクするには、[詳細] タブの [用語集] セクションで [追加] をクリックします。用語を検索して選択し、[閉じる] をクリックします。
    • アセットにスキーマがある場合は、用語を列にリンクできます。[スキーマ] タブで、用語をリンクする列を選択し、[ビジネス用語を追加] をクリックします。用語を検索して選択し、[閉じる] をクリックします。

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_NUMBER/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entryLinks?entry_link_id=ENTRY_LINK_ID -d "$(cat<<EOF
{
  "entry_link_type": "projects/dataplex-types/locations/global/entryLinkTypes/definition",
  "entry_references": [{
     "name": "projects/PROJECT_NUMBER/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entries/ENTRY_ID",
     "type": "SOURCE"
  }, {
     "name": "projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/glossaries/TERM_GLOSSARY_ID/terms/TERM_ID",
     "type": "TARGET"
  }
  ]
}
EOF
)"

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

  • PROJECT_NUMBER: リンク先のデータアセットのプロジェクト番号
  • ENTRY_LOCATION_ID: リンク先のデータアセットのロケーション ID
  • ENTRY_GROUP_ID: リンク先のデータアセットのエントリ グループ
  • ENTRY_LINK_ID: 用語とデータアセットを表す Dataplex Universal Catalog エントリ間のリンクの ID。
  • TERM_PROJECT_NUMBER: リンクする用語のプロジェクト番号。

エントリ スキーマの列に用語を適用する

コンソール

  1. Google Cloud コンソールで、Dataplex Universal Catalog の [検索] ページに移動します。

    [検索] に移動

  2. 用語をリンクする列が含まれるスキーマがあるデータアセット(データセット、ファイル、テーブルなど)を検索します。データアセットをクリックします。

  3. データアセット ページで、次のどちらかを行います。

    • 用語をデータアセットの列にリンクするには、[スキーマ] タブで、用語を適用する列を選択します。
    • [ビジネス用語を追加] をクリックします。適用する用語を検索し、その用語をクリックして適用します。

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_NUMBER/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entryLinks?entry_link_id=ENTRY_LINK_ID -d "$(cat<PROJECT_NUMBER/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entries/ENTRY_ID",
  "type": "SOURCE"
  "path": "Schema/COLUMN_NAME"
}, {
  "name": "projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/glossaries/TERM_GLOSSARY_ID/terms/TERM_ID",
  "type": "TARGET"
}
]
}
EOF
)"

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

  • PROJECT_NUMBER: リンク先のデータアセットのプロジェクト番号
  • ENTRY_LOCATION_ID: リンク先のデータアセットのロケーション ID
  • ENTRY_GROUP_ID: リンク先のデータアセットのエントリ グループ
  • ENTRY_LINK_ID: 用語とデータアセットを表す Dataplex Universal Catalog エントリ間のリンクの ID
  • TERM_PROJECT_NUMBER: リンクする用語のプロジェクト番号
  • COLUMN_NAME: 用語を適用する列

コンソール

  1. Google Cloud コンソールで、Dataplex Universal Catalog の [検索] ページに移動します。

    [検索] に移動

  2. 用語を削除するデータアセット(データセット、ファイル、テーブルなど)を検索してクリックします。

  3. データアセット ページで、次のどちらかを行います。

    • アセットから用語を削除するには、[詳細] タブの [用語集] セクションで、用語をクリックします。続いて、 をクリックします。
    • 列から用語を削除するには、[スキーマ] タブで、用語の横にある をクリックします。

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/ENTRY_PROJECT_ID/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entryLinks/ENTRY_LINK_ID

用語集、用語、リンクされたデータアセットを検索する

コンソール

ビジネス用語集のコンテンツ間を移動するには、[用語集] ページの用語集と用語ツリーを使用します。

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

    [用語集] に移動

  2. [用語集] ページで、フィルタバーを使用してカテゴリを探します。次のフィルタを使用できます。

    • 名前: 指定したテキストを含む名前の用語集、カテゴリ、用語を返します。
    • : 親用語集の名前または説明が指定されたテキストと一致する用語を返します。たとえば、parent:Finance は、名前または説明にフレーズ Finance を含む親用語集に関連付けられている用語を返します。
    • Synonym: 指定したテキストを含む名前または ID の類義語を持つ用語のリストを返します。たとえば、synonym:Profit は、名前または ID にフレーズ profit を含む類義語を含む用語を返します。
    • 連絡先: データ スチュワードが連絡先としてリストされている条件を返します。たとえば、contact:alex@example.com は、alex@example.com に一致するデータ スチュワードを持つ用語に関連付けられたエントリを返します。

REST

REST API を使用して用語集、用語、リンク済みデータアセットを検索するには、プレビュー版に登録する必要があります。

用語にリンクされたデータアセットを検索する

コンソール

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

    [用語集] に移動

  2. [用語集] ページで、フィルタバーを使用して自由形式のテキスト検索クエリを入力します。これにより、用語集、カテゴリ、用語名の対応する一致リストが返されます。

  3. 一致した用語をクリックします。

  4. [用語の詳細] ページで、この用語にリンクされている用語(類義語および関連する用語)とリンクされているエントリ(データアセット)を確認します。

  5. Dataplex Universal Catalog のエントリの詳細を表示するには、エントリをクリックします。

REST

REST API を使用して用語集、用語、リンク済みデータアセットを検索するには、プレビュー版に登録する必要があります。

別のカタログツールから用語集とリンクをインポートする場合、または Dataplex ユニバーサル カタログで用語集を更新する場合は、REST API を使用して用語集、カテゴリ、用語、用語間のリンク、用語とデータアセット間のリンク、列を一括インポートできます。

  1. ターゲット用語集を作成します。

    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=GLOSSARY_ID -d "$(cat<<EOF
    
    {
     "displayName": "DISPLAY_NAME",
     "description": "DESCRIPTION"
    }
    EOF
    )"

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

    • PROJECT_ID: 用語集を作成するプロジェクト ID
    • LOCATION_ID: 用語集を作成するロケーション
    • GLOSSARY_ID: 用語集 ID
    • DISPLAY_NAME: 用語集の表示名
    • DESCRIPTION: 用語集の説明
  2. 作成したターゲット用語集のカテゴリ、用語、用語とデータアセット間のリンクをインポートするには、これらのファイルのそれぞれを Cloud Storage バケットにアップロードします。これらのファイルの形式は次のとおりです。

    • 用語集の用語とカテゴリの形式例

       {"entry":{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID","entryType":"projects/dataplex-types/locations/global/entryTypes/glossary-category","aspects":{"dataplex-types.global.glossary-category-aspect":{"data":{}},"dataplex-types.global.overview":{"data":{"content":"CONTENT"}},"dataplex-types.global.contacts":{"data":{"identities":[{role: "steward", name: "CONTACT_DISPLAY_NAME", id: "CONTACT_EMAIL"}]}}},"parentEntry":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID","entrySource":{"resource":"projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID","displayName":"CATEGORY_NAME","description":"CATEGORY_DESCRIPTION","ancestors":[{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID","type":"projects/dataplex-types/locations/global/entryTypes/glossary"}]}}}
       {"entry":{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM1_ID","entryType":"projects/dataplex-types/locations/global/entryTypes/glossary-term","aspects":{"dataplex-types.global.glossary-term-aspect":{"data":{}},"dataplex-types.global.overview":{"data":{"content":"TERM1_CONTENT"}},"dataplex-types.global.contacts":{"data":{"identities":[{role: "steward", name: "CONTACT_DISPLAY_NAME", id: "CONTACT_EMAIL"}]}}},"parentEntry":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID","entrySource":{"resource":"projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM1_ID","displayName":"TERM1_DISPLAY_NAME","description":"TERM1_DESCRIPTION","ancestors":[{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID","type":"projects/dataplex-types/locations/global/entryTypes/glossary"},{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID","type":"projects/dataplex-types/locations/global/entryTypes/glossary-category"}]}}}
       {"entry":{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM2_ID","entryType":"projects/dataplex-types/locations/global/entryTypes/glossary-term","aspects":{"dataplex-types.global.glossary-term-aspect":{"data":{}},"dataplex-types.global.overview":{"data":{"content":"TERM1_CONTENT"}},"dataplex-types.global.contacts":{"data":{"identities":[{role: "steward", name: "CONTACT_DISPLAY_NAME", id: "CONTACT_EMAIL"}]}}},"parentEntry":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID","entrySource":{"resource":"projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM2_ID","displayName":"TERM2_DISPLAY_NAME","description":"TERM2_DESCRIPTION","ancestors":[{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID","type":"projects/dataplex-types/locations/global/entryTypes/glossary"},{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID","type":"projects/dataplex-types/locations/global/entryTypes/glossary-category"}]}}}
       
    • 用語間のリンクの形式例

       {"entryLink":{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entryLinks/el-import-0606e3f2-8206-4f3a-aba9-32c6196f6048","entryLinkType":"projects/dataplex-types/locations/global/entryLinkTypes/synonym","entryReferences":[{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/global/glossaries/import-glossary/terms/term-1"},{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/global/glossaries/import-glossary/terms/term-2"}]}}
       {"entryLink":{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entryLinks/el-import-2f7408e3-af3d-405d-81bb-861cf9ec5146","entryLinkType":"projects/dataplex-types/locations/global/entryLinkTypes/related","entryReferences":[{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/global/glossaries/import-glossary/terms/term-1"},{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/global/glossaries/import-glossary/terms/term-2"}]}}
       
    • 用語とデータアセット間のリンクの形式例

       projects/PROJECT_NUMBER/locations/us-central1/entryGroups/entry-group-1/entries/entry-1 and term projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/global/glossaries/import-glossary/terms/term-1
       {"entryLink":{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entryLinks/el-import-0606e3f2-8206-4f3a-aba9-32c6196f6048","entryLinkType":"projects/dataplex-types/locations/global/entryLinkTypes/definition","entryReferences":[{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/global/glossaries/import-glossary/terms/term-1"},{"name":"projects/PROJECT_NUMBER/locations/us-central1/entryGroups/entry-group-1/entries/entry-1"}]}}
       
    # Set GCURL alias
    alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'
    
    gcurl https://DATAPLEX_API/metadataJobs?metadata_job_id=JOB_ID -d "$(cat<<EOF
    {
      "type":"IMPORT",
      "import_spec":{
         "log_level":"DEBUG",
         "source_storage_uri":"gs://STORAGE_BUCKET/",
         "entry_sync_mode":"FULL",
         "aspect_sync_mode":"INCREMENTAL",
         "scope":{
            "glossaries": "GLOSSARY_NAME"
         }
      }
    }
    EOF
    )"

    DATAPLEX_API は、dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID 形式の Dataplex Universal Catalog API エンドポイントに置き換えます。

  3. 省略可: オペレーションのステータスを取得します。

    gcurl https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/operations/operation-OPERATION_ID

    OPERATION_ID は、オペレーションの ID に置き換えます。

  4. 省略可: メタデータ ジョブのステータスを取得します。

    gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/metadataJobs/JOB_ID
  5. 用語間のリンクを類義語または関連する用語としてインポートします。

    gcurl https://DATAPLEX_API/metadataJobs?metadata_job_id=JOB_ID -d "$(cat<<EOF
    {
      "type":"IMPORT",
      "import_spec":{
         "log_level":"DEBUG",
         "source_storage_uri":"gs://STORAGE_BUCKET/",
         "entry_sync_mode":"FULL",
         "aspect_sync_mode":"INCREMENTAL",
         "scope":{
            "entry_groups":[  "projects/PROJECT_ID/locations/LOCATION_ID/entryGroups/@dataplex"
            ],
            "entry_link_types":[
               "projects/dataplex-types/locations/global/entryLinkTypes/synonym",
               "projects/dataplex-types/locations/global/entryLinkTypes/related"
            ],
            "referenced_entry_scopes":[
               "PROJECT_IDS"
            ]
         }
      }
    }
    EOF
    )"

    DATAPLEX_APIdataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID に置き換えます。

  6. 用語とデータアセットまたは列間のリンクをインポートします。

    用語集の用語とデータアセットの間にリンクを作成するには、データアセットのエントリが属するエントリ グループごとにインポート ジョブを実行します。定義エントリのリンクはすべて、このエントリ グループに作成されます。

    gcurl https://DATAPLEX_API/metadataJobs?metadata_job_id=JOB_ID -d "$(cat<<EOF
    {
    "type":"IMPORT",
    "import_spec":{
      "log_level":"DEBUG",
      "source_storage_uri":"gs://STORAGE_BUCKET/",
      "entry_sync_mode":"FULL",
      "aspect_sync_mode":"INCREMENTAL",
      "scope":{
         "entry_groups":[  "projects/PROJECT_ID/locations/ENTRY_GROUP_LOCATION_ID/entryGroups/@dataplex"
         ],
         "entry_link_types":[
            "projects/dataplex-types/locations/global/entryLinkTypes/definition"
         ],
         "referenced_entry_scopes":[
            "PROJECT_IDS"
         ]
      }
    }
    }
    EOF
    )"

    DATAPLEX_APIdataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID に置き換えます。

料金

2026 年 7 月より、Dataplex Universal Catalog のビジネス用語集は、メタデータ ストレージの料金と同じ料金で課金されます。Dataplex Universal Catalog のメタデータ ストレージの料金をご覧ください。

次のステップ