2026 年 4 月 10 日より、Dataplex Universal Catalog は Knowledge Catalog と呼ばれるようになりました。API、クライアントライブラリ、CLI、IAM の名前は変更されません。詳細については、Google Cloud Knowledge Catalog の概要をご覧ください。

Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

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

Knowledge Catalog（旧称 Dataplex Universal Catalog）のビジネス用語集を使用すると、組織全体のデータアセットの標準化された用語集を確立できます。カテゴリと用語を作成して管理することで、曖昧さを減らし、データ検出とガバナンスを改善できます。ビジネス用語集を初めて作成する場合は、ビジネス用語集を作成して使用するのクイックスタートをご覧ください。

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

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

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

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

ビジネス用語集の要素

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

用語集

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

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

用語

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

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

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

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

類義語

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

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

制限事項

ビジネス用語集はプロジェクトおよびロケーション内に保存されます。用語集には、プロジェクトとロケーションの制限が適用されます。
BigQuery データエージェントでビジネス用語集を使用する場合、データエージェントはテーブルごとに最大 10 個の用語集の用語をインポートできます。テーブルに 10 個を超える用語をアタッチすると、データエージェントは追加の用語を無視します。データエージェントのパフォーマンスを最適化するには、テーブルにテーブルレベルと列レベルの包括的な説明も指定してください。

必要なロール

用語集の作成と管理に必要な権限を取得するには、プロジェクトに対する次の 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 （不明）
- プロジェクト内で類義語の用語間リンクを作成、検索、削除する

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

詳細については、ナレッジカタログの IAM ロールをご覧ください。

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

以降のセクションでは、ビジネス用語集の作成、表示、編集、削除について説明します。ビジネス用語集、カテゴリ、用語を作成するときは、それらの ID が Knowledge Catalog リソースの命名ガイドラインに準拠していることを確認してください。

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

コンソール

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

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

C#

このサンプルを試す前に、クライアントライブラリを使用した Knowledge Catalog のクイックスタートにある C# の設定手順を完了してください。詳細については、Knowledge Catalog C# API のリファレンスドキュメントをご覧ください。

Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。

using Google.Api.Gax.ResourceNames;
using Google.Cloud.Dataplex.V1;
using Google.LongRunning;

public sealed partial class GeneratedBusinessGlossaryServiceClientSnippets
{
    /// <summary>Snippet for CreateGlossary</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void CreateGlossaryRequestObject()
    {
        // Create client
        BusinessGlossaryServiceClient businessGlossaryServiceClient = BusinessGlossaryServiceClient.Create();
        // Initialize request argument(s)
        CreateGlossaryRequest request = new CreateGlossaryRequest
        {
            ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
            GlossaryId = "",
            Glossary = new Glossary(),
            ValidateOnly = false,
        };
        // Make the request
        Operation<Glossary, OperationMetadata> response = businessGlossaryServiceClient.CreateGlossary(request);

        // Poll until the returned long-running operation is complete
        Operation<Glossary, OperationMetadata> completedResponse = response.PollUntilCompleted();
        // Retrieve the operation result
        Glossary result = completedResponse.Result;

        // Or get the name of the operation
        string operationName = response.Name;
        // This name can be stored, then the long-running operation retrieved later by name
        Operation<Glossary, OperationMetadata> retrievedResponse = businessGlossaryServiceClient.PollOnceCreateGlossary(operationName);
        // Check if the retrieved long-running operation has completed
        if (retrievedResponse.IsCompleted)
        {
            // If it has completed, then access the result
            Glossary retrievedResult = retrievedResponse.Result;
        }
    }
}

Go

このサンプルを試す前に、クライアントライブラリを使用した Knowledge Catalog のクイックスタートにある Go の設定手順を完了してください。詳細については、Knowledge Catalog Go API のリファレンスドキュメントをご覧ください。


//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewBusinessGlossaryClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.CreateGlossaryRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateGlossaryRequest.
	}
	op, err := c.CreateGlossary(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

このサンプルを試す前に、クライアントライブラリを使用した Knowledge Catalog のクイックスタートにある Java の設定手順を完了してください。詳細については、Knowledge Catalog Java API のリファレンスドキュメントをご覧ください。

import com.google.cloud.dataplex.v1.BusinessGlossaryServiceClient;
import com.google.cloud.dataplex.v1.CreateGlossaryRequest;
import com.google.cloud.dataplex.v1.Glossary;
import com.google.cloud.dataplex.v1.LocationName;

public class SyncCreateGlossary {

  public static void main(String[] args) throws Exception {
    syncCreateGlossary();
  }

  public static void syncCreateGlossary() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (BusinessGlossaryServiceClient businessGlossaryServiceClient =
        BusinessGlossaryServiceClient.create()) {
      CreateGlossaryRequest request =
          CreateGlossaryRequest.newBuilder()
              .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
              .setGlossaryId("glossaryId1849967577")
              .setGlossary(Glossary.newBuilder().build())
              .setValidateOnly(true)
              .build();
      Glossary response = businessGlossaryServiceClient.createGlossaryAsync(request).get();
    }
  }
}

Node.js

このサンプルを試す前に、クライアントライブラリを使用した Knowledge Catalog のクイックスタートにある Node.js の設定手順を完了してください。詳細については、Knowledge Catalog Node.js API のリファレンスドキュメントをご覧ください。

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The parent resource where this Glossary will be created.
 *  Format: projects/{project_id_or_number}/locations/{location_id}
 *  where `location_id` refers to a Google Cloud region.
 */
// const parent = 'abc123'
/**
 *  Required. Glossary ID: Glossary identifier.
 */
// const glossaryId = 'abc123'
/**
 *  Required. The Glossary to create.
 */
// const glossary = {}
/**
 *  Optional. Validates the request without actually creating the Glossary.
 *  Default: false.
 */
// const validateOnly = true

// Imports the Dataplex library
const {BusinessGlossaryServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new BusinessGlossaryServiceClient();

async function callCreateGlossary() {
  // Construct request
  const request = {
    parent,
    glossaryId,
    glossary,
  };

  // Run request
  const [operation] = await dataplexClient.createGlossary(request);
  const [response] = await operation.promise();
  console.log(response);
}

callCreateGlossary();

Python

このサンプルを試す前に、クライアントライブラリを使用した Knowledge Catalog のクイックスタートにある Python の設定手順を完了してください。詳細については、Knowledge Catalog Python API のリファレンスドキュメントをご覧ください。

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_create_glossary():
    # Create a client
    client = dataplex_v1.BusinessGlossaryServiceClient()

    # Initialize request argument(s)
    request = dataplex_v1.CreateGlossaryRequest(
        parent="parent_value",
        glossary_id="glossary_id_value",
    )

    # Make the request
    operation = client.create_glossary(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Ruby

このサンプルを試す前に、クライアントライブラリを使用した Knowledge Catalog のクイックスタートにある Ruby の設定手順を完了してください。詳細については、Knowledge Catalog Ruby API のリファレンスドキュメントをご覧ください。

require "google/cloud/dataplex/v1"

##
# Snippet for the create_glossary call in the BusinessGlossaryService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::BusinessGlossaryService::Client#create_glossary.
#
def create_glossary
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::BusinessGlossaryService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::CreateGlossaryRequest.new

  # Call the create_glossary method.
  result = client.create_glossary request

  # The returned object is of type Gapic::Operation. You can use it to
  # check the status of an operation, cancel it, or wait for results.
  # Here is how to wait for a response.
  result.wait_until_done! timeout: 60
  if result.response?
    p result.response
  else
    puts "No response received."
  end
end

REST

用語集を作成すると、Knowledge 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 コンソールで、Knowledge Catalog の [用語集] ページに移動します。

[用語集] に移動

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

C#

using Google.Api.Gax;
using Google.Api.Gax.ResourceNames;
using Google.Cloud.Dataplex.V1;
using System;

public sealed partial class GeneratedBusinessGlossaryServiceClientSnippets
{
    /// <summary>Snippet for ListGlossaries</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void ListGlossariesRequestObject()
    {
        // Create client
        BusinessGlossaryServiceClient businessGlossaryServiceClient = BusinessGlossaryServiceClient.Create();
        // Initialize request argument(s)
        ListGlossariesRequest request = new ListGlossariesRequest
        {
            ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
            Filter = "",
            OrderBy = "",
        };
        // Make the request
        PagedEnumerable<ListGlossariesResponse, Glossary> response = businessGlossaryServiceClient.ListGlossaries(request);

        // Iterate over all response items, lazily performing RPCs as required
        foreach (Glossary item in response)
        {
            // Do something with each item
            Console.WriteLine(item);
        }

        // Or iterate over pages (of server-defined size), performing one RPC per page
        foreach (ListGlossariesResponse page in response.AsRawResponses())
        {
            // Do something with each page of items
            Console.WriteLine("A page of results:");
            foreach (Glossary item in page)
            {
                // Do something with each item
                Console.WriteLine(item);
            }
        }

        // Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
        int pageSize = 10;
        Page<Glossary> singlePage = response.ReadPage(pageSize);
        // Do something with the page of items
        Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
        foreach (Glossary item in singlePage)
        {
            // Do something with each item
            Console.WriteLine(item);
        }
        // Store the pageToken, for when the next page is required.
        string nextPageToken = singlePage.NextPageToken;
    }
}

Go


//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
	"google.golang.org/api/iterator"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewBusinessGlossaryClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.ListGlossariesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListGlossariesRequest.
	}
	it := c.ListGlossaries(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp

		// If you need to access the underlying RPC response,
		// you can do so by casting the `Response` as below.
		// Otherwise, remove this line. Only populated after
		// first call to Next(). Not safe for concurrent access.
		_ = it.Response.(*dataplexpb.ListGlossariesResponse)
	}
}

Java

import com.google.cloud.dataplex.v1.BusinessGlossaryServiceClient;
import com.google.cloud.dataplex.v1.Glossary;
import com.google.cloud.dataplex.v1.ListGlossariesRequest;
import com.google.cloud.dataplex.v1.LocationName;

public class SyncListGlossaries {

  public static void main(String[] args) throws Exception {
    syncListGlossaries();
  }

  public static void syncListGlossaries() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (BusinessGlossaryServiceClient businessGlossaryServiceClient =
        BusinessGlossaryServiceClient.create()) {
      ListGlossariesRequest request =
          ListGlossariesRequest.newBuilder()
              .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
              .setPageSize(883849137)
              .setPageToken("pageToken873572522")
              .setFilter("filter-1274492040")
              .setOrderBy("orderBy-1207110587")
              .build();
      for (Glossary element : businessGlossaryServiceClient.listGlossaries(request).iterateAll()) {
        // doThingsWith(element);
      }
    }
  }
}

Node.js

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The parent, which has this collection of Glossaries.
 *  Format: projects/{project_id_or_number}/locations/{location_id}
 *  where `location_id` refers to a Google Cloud region.
 */
// const parent = 'abc123'
/**
 *  Optional. The maximum number of Glossaries to return. The service may
 *  return fewer than this value. If unspecified, at most 50 Glossaries will be
 *  returned. The maximum value is 1000; values above 1000 will be coerced to
 *  1000.
 */
// const pageSize = 1234
/**
 *  Optional. A page token, received from a previous `ListGlossaries` call.
 *  Provide this to retrieve the subsequent page.
 *  When paginating, all other parameters provided to `ListGlossaries` must
 *  match the call that provided the page token.
 */
// const pageToken = 'abc123'
/**
 *  Optional. Filter expression that filters Glossaries listed in the response.
 *  Filters on proto fields of Glossary are supported.
 *  Examples of using a filter are:
 *    - `display_name="my-glossary"`
 *    - `categoryCount=1`
 *    - `termCount=0`
 */
// const filter = 'abc123'
/**
 *  Optional. Order by expression that orders Glossaries listed in the
 *  response. Order by fields are: `name` or `create_time` for the result. If
 *  not specified, the ordering is undefined.
 */
// const orderBy = 'abc123'

// Imports the Dataplex library
const {BusinessGlossaryServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new BusinessGlossaryServiceClient();

async function callListGlossaries() {
  // Construct request
  const request = {
    parent,
  };

  // Run request
  const iterable = dataplexClient.listGlossariesAsync(request);
  for await (const response of iterable) {
      console.log(response);
  }
}

callListGlossaries();

Python

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_list_glossaries():
    # Create a client
    client = dataplex_v1.BusinessGlossaryServiceClient()

    # Initialize request argument(s)
    request = dataplex_v1.ListGlossariesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_glossaries(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Ruby

require "google/cloud/dataplex/v1"

##
# Snippet for the list_glossaries call in the BusinessGlossaryService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::BusinessGlossaryService::Client#list_glossaries.
#
def list_glossaries
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::BusinessGlossaryService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::ListGlossariesRequest.new

  # Call the list_glossaries method.
  result = client.list_glossaries request

  # The returned object is of type Gapic::PagedEnumerable. You can iterate
  # over elements, and API calls will be issued to fetch pages as needed.
  result.each do |item|
    # Each element is of type ::Google::Cloud::Dataplex::V1::Glossary.
    p item
  end
end

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 コンソールで、Knowledge 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 コンソールで、Knowledge Catalog の [用語集] ページに移動します。

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

C#

using Google.Cloud.Dataplex.V1;
using Google.LongRunning;
using Google.Protobuf.WellKnownTypes;

public sealed partial class GeneratedBusinessGlossaryServiceClientSnippets
{
    /// <summary>Snippet for DeleteGlossary</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void DeleteGlossaryRequestObject()
    {
        // Create client
        BusinessGlossaryServiceClient businessGlossaryServiceClient = BusinessGlossaryServiceClient.Create();
        // Initialize request argument(s)
        DeleteGlossaryRequest request = new DeleteGlossaryRequest
        {
            GlossaryName = GlossaryName.FromProjectLocationGlossary("[PROJECT]", "[LOCATION]", "[GLOSSARY]"),
            Etag = "",
        };
        // Make the request
        Operation<Empty, OperationMetadata> response = businessGlossaryServiceClient.DeleteGlossary(request);

        // Poll until the returned long-running operation is complete
        Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
        // Retrieve the operation result
        Empty result = completedResponse.Result;

        // Or get the name of the operation
        string operationName = response.Name;
        // This name can be stored, then the long-running operation retrieved later by name
        Operation<Empty, OperationMetadata> retrievedResponse = businessGlossaryServiceClient.PollOnceDeleteGlossary(operationName);
        // Check if the retrieved long-running operation has completed
        if (retrievedResponse.IsCompleted)
        {
            // If it has completed, then access the result
            Empty retrievedResult = retrievedResponse.Result;
        }
    }
}

Go


//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewBusinessGlossaryClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.DeleteGlossaryRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#DeleteGlossaryRequest.
	}
	op, err := c.DeleteGlossary(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
}

Java

import com.google.cloud.dataplex.v1.BusinessGlossaryServiceClient;
import com.google.cloud.dataplex.v1.DeleteGlossaryRequest;
import com.google.cloud.dataplex.v1.GlossaryName;
import com.google.protobuf.Empty;

public class SyncDeleteGlossary {

  public static void main(String[] args) throws Exception {
    syncDeleteGlossary();
  }

  public static void syncDeleteGlossary() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (BusinessGlossaryServiceClient businessGlossaryServiceClient =
        BusinessGlossaryServiceClient.create()) {
      DeleteGlossaryRequest request =
          DeleteGlossaryRequest.newBuilder()
              .setName(GlossaryName.of("[PROJECT]", "[LOCATION]", "[GLOSSARY]").toString())
              .setEtag("etag3123477")
              .build();
      businessGlossaryServiceClient.deleteGlossaryAsync(request).get();
    }
  }
}

Node.js

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The name of the Glossary to delete.
 *  Format:
 *  projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
 */
// const name = 'abc123'
/**
 *  Optional. The etag of the Glossary.
 *  If this is provided, it must match the server's etag.
 *  If the etag is provided and does not match the server-computed etag,
 *  the request must fail with a ABORTED error code.
 */
// const etag = 'abc123'

// Imports the Dataplex library
const {BusinessGlossaryServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new BusinessGlossaryServiceClient();

async function callDeleteGlossary() {
  // Construct request
  const request = {
    name,
  };

  // Run request
  const [operation] = await dataplexClient.deleteGlossary(request);
  const [response] = await operation.promise();
  console.log(response);
}

callDeleteGlossary();

Python

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_delete_glossary():
    # Create a client
    client = dataplex_v1.BusinessGlossaryServiceClient()

    # Initialize request argument(s)
    request = dataplex_v1.DeleteGlossaryRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_glossary(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Ruby

require "google/cloud/dataplex/v1"

##
# Snippet for the delete_glossary call in the BusinessGlossaryService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::BusinessGlossaryService::Client#delete_glossary.
#
def delete_glossary
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::BusinessGlossaryService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::DeleteGlossaryRequest.new

  # Call the delete_glossary method.
  result = client.delete_glossary request

  # The returned object is of type Gapic::Operation. You can use it to
  # check the status of an operation, cancel it, or wait for results.
  # Here is how to wait for a response.
  result.wait_until_done! timeout: 60
  if result.response?
    p result.response
  else
    puts "No response received."
  end
end

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 コンソールで、Knowledge Catalog の [用語集] ページに移動します。

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

REST

カテゴリを作成すると、Knowledge 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 コンソールで、Knowledge 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 コンソールで、Knowledge 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 コンソールで、Knowledge 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

カテゴリを削除する

コンソール

Google Cloud コンソールで、Knowledge 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/categories/CATEGORY_ID

用語の作成と管理

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

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

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

コンソール

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

[用語集] に移動
用語集レベルで用語を作成するには、用語を作成する用語集を選択し、[用語を作成] をクリックします。
用語の名前を入力します。
[作成] をクリックします。
省略可: [説明] に簡単な説明（最大 1,024 文字）を追加するか、[概要] に詳細な説明（最大 120 KB）を追加します。
省略可: 連絡先を追加するには、[編集] をクリックし、データスチュワード、データオーナー、データドメインオーナーのメールアドレスのリストを指定します。[保存] をクリックします。

REST

用語を作成すると、Knowledge 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/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: 作成する用語の説明

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

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

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

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

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

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

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

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

連絡先を含む期間のエントリを更新します。

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

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

コンソール

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

[用語集] に移動
カテゴリに用語を作成するには、用語を作成するカテゴリを選択し、[キーワードを追加] をクリックします。
用語の名前を入力します。
[作成] をクリックします。
省略可: [説明] に簡単な説明（最大 1,024 文字）を追加するか、[概要] に詳細な説明（最大 120 KB）を追加します。
省略可: 連絡先を追加するには、[編集] をクリックし、データスチュワード、データオーナー、データドメインオーナーのメールアドレスのリストを指定します。[保存] をクリックします。

REST

用語を作成すると、Knowledge 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/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: 作成する用語の説明

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

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

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

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

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

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

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

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

連絡先を含む期間のエントリを更新します。

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

用語にアスペクトを追加する

用語にアスペクトを追加して、追加のコンテキストやメタデータを提供できます。

コンソール

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

[用語集] に移動
用語集を開き、アスペクトを追加する用語をクリックします。
[アスペクト] セクションで、[追加] をクリックします。
アスペクトを検索し、アスペクトの詳細を入力して、[保存] をクリックします。

REST

用語集の用語はエントリです。アスペクトをアタッチするには、エントリリソースをパッチ適用します。用語集のエントリグループは @dataplex です。

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_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID?update_mask=aspects\&aspect_keys=ASPECT_PROJECT_ID.ASPECT_LOCATION_ID.ASPECT_TYPE_ID --data @- << EOF
{
  "aspects": {
    "ASPECT_PROJECT_ID.ASPECT_LOCATION_ID.ASPECT_TYPE_ID": {
      "aspect_type": "projects/ASPECT_PROJECT_ID/locations/ASPECT_LOCATION_ID/aspectTypes/ASPECT_TYPE_ID",
      "data": {
        "sensitivity": "HIGH",
        "data_owner": "achalg@google.com"
      }
    }
  }
}
EOF

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

PROJECT_NUMBER: 用語集の用語を含むプロジェクトの番号。
LOCATION_ID: 用語集の用語のロケーション。
GLOSSARY_ID: 用語を含む用語集の ID。
TERM_ID: アスペクトを関連付ける用語の ID。
ASPECT_PROJECT_ID: アスペクトタイプを含むプロジェクトの ID。
ASPECT_LOCATION_ID: アスペクトタイプのロケーション。
ASPECT_TYPE_ID: アスペクトタイプの ID。

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

コンソール

Google Cloud コンソールで、Knowledge 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/terms

用語の詳細を表示する

コンソール

Google Cloud コンソールで、Knowledge 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/terms/TERM_ID

用語を編集する

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

コンソール

Google Cloud コンソールで、Knowledge 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/terms/TERM_ID?update_mask=displayName,description --data @- << EOF
{
   "displayName": "TERM_DISPLAY_NAME",
   "description": "TERM_DESCRIPTION"
}
EOF

用語を削除する

コンソール

Google Cloud コンソールで、Knowledge 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/terms/TERM_ID

類義語や関連する用語を管理する

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

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

用語間に類義語リンクを作成する

コンソール

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

[用語集] に移動
用語集を開き、リンクを作成する用語をクリックします。
[類義語] の横にある [編集] をクリックします。
リンク先の用語を検索して選択します。

用語は選択するとすぐにリンクされます。
[閉じる] をクリックします。

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。各用語は Knowledge Catalog のエントリとして表されます。エントリリンクは、類義語の用語間の関係です。

コンソール

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

[用語集] に移動
用語集を開き、リンクを作成する用語をクリックします。
[関連する用語] の横にある [編集] をクリックします。
リンク先の用語を検索して選択します。

用語は選択するとすぐにリンクされます。
[閉じる] をクリックします。

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。各用語は Knowledge Catalog のエントリとして表されます。エントリリンクは、関連する用語間の関係です。

用語の類義語リンクを検索する

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/TERM_PROJECT_ID/locations/SYNONYM_LINKS_LOCATION_ID:lookupEntryLinks?entry=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&entry_link_types=projects/dataplex-types/locations/global/entryLinkTypes/synonym&page_size=10

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

TERM_PROJECT_ID: 類義語リンクを検索する用語のプロジェクト ID。
TERM_PROJECT_NUMBER: 類義語リンクを検索する用語のプロジェクト番号。
SYNONYM_LINKS_LOCATION_ID: 類義語リンクを検索する地域 ID。
TERM_LOCATION_ID: 用語の地域 ID。
TERM_GLOSSARY_ID: 用語を含む用語集の ID。
TERM_ID: 用語の ID。

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/TERM_PROJECT_ID/locations/RELATED_LINKS_LOCATION_ID:lookupEntryLinks?entry=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&entry_link_types=projects/dataplex-types/locations/global/entryLinkTypes/related&page_size=10

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

TERM_PROJECT_ID: 関連リンクを検索する用語のプロジェクト ID。
TERM_PROJECT_NUMBER: 関連リンクを検索する用語のプロジェクト番号。
RELATED_LINKS_LOCATION_ID: 関連リンクを検索する地域 ID。
TERM_LOCATION_ID: 用語の地域 ID。
TERM_GLOSSARY_ID: 用語を含む用語集の ID。
TERM_ID: 用語の ID。

類義語と関連する用語間のリンクを削除する

コンソール

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

[用語集] に移動
用語集を開き、類義語または関連する用語を削除する用語をクリックします。
関連する用語間のリンクを削除するには、[関連する用語] の横にある [編集] をクリックします。関連する用語を削除し、[閉じる] をクリックします。
類義語間のリンクを削除するには、[類義語] の横にある [編集] をクリックします。類義語を削除し、[閉じる] をクリックします。

REST

エントリリンクを検索して、削除するリンクのエントリリンク ID を見つけます。詳細については、用語の類義語リンクを検索するまたは用語の関連リンクを検索するをご覧ください。

次の DELETE リクエストを送信して、リンクを削除します。

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 データセットと Iceberg REST Catalog テーブルに用語を関連付けることができます。

データアセットに用語を適用する

コンソール

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

[検索] に移動
用語をリンクするデータアセット（データセット、ファイル、テーブルなど）を検索してクリックします。
データアセットページで、次のどちらかを行います。
- 用語をアセットにリンクするには、[詳細] タブの [用語集] セクションで [追加] をクリックします。用語を検索して選択し、[閉じる] をクリックします。
- アセットにスキーマがある場合は、用語を列にリンクできます。[スキーマ] タブで、用語をリンクする列を選択し、[ビジネス用語を追加] をクリックします。用語を検索して選択し、[閉じる] をクリックします。

Python

from google.cloud import dataplex_v1

def attach_term_to_asset(
    project_id: str,
    location: str,
    entry_group_id: str,
    entry_link_id: str,
    source_entry_name: str,
    target_term_name: str,
) -> dataplex_v1.EntryLink:
    """Creates an entry link attaching a glossary term to a data asset."""
    client = dataplex_v1.CatalogServiceClient()
    parent_group = (
        f"projects/{project_id}/locations/{location}/"
        f"entryGroups/{entry_group_id}"
    )

    entry_link = dataplex_v1.EntryLink(
        entry_link_type=(
            "projects/dataplex-types/locations/global/"
            "entryLinkTypes/definition"
        ),
        entry_references=[
            dataplex_v1.EntryLink.EntryReference(
                name=source_entry_name, type_="SOURCE"
            ),
            dataplex_v1.EntryLink.EntryReference(
                name=target_term_name, type_="TARGET"
            ),
        ],
    )

    return client.create_entry_link(
        parent=parent_group,
        entry_link_id=entry_link_id,
        entry_link=entry_link,
    )

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: 用語とデータアセットを表す Knowledge Catalog エントリ間のリンクの ID。
TERM_PROJECT_NUMBER: リンクする用語のプロジェクト番号。

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

コンソール

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

[検索] に移動
用語をリンクする列が含まれるスキーマがあるデータアセット（データセット、ファイル、テーブルなど）を検索します。データアセットをクリックします。
データアセットページで、次のどちらかを行います。
- 用語をデータアセットの列にリンクするには、[スキーマ] タブで、用語を適用する列を選択します。
- [ビジネス用語を追加] をクリックします。適用する用語を検索し、その用語をクリックして適用します。

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",
      "path": "Schema.COLUMN_NAME",
      "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: 用語とデータアセットを表す Knowledge Catalog エントリ間のリンクの ID
TERM_PROJECT_NUMBER: リンクする用語のプロジェクト番号
COLUMN_NAME: 用語を適用する列

複数のデータアセットまたは列に用語を適用する

1 つの用語集の用語を複数のデータアセットまたは列に同時にアタッチできます。1 回のオペレーションで最大 20 個のリソースまたは列を選択できます。

コンソール

複数のリソースに用語を適用する手順は次のとおりです。

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

[用語集] に移動
[用語集] リストで、リンクする用語を含む用語集を開きます。
用語をクリックします。
[関連エントリ] セクションで、 [追加] をクリックします。
[関連エントリをアタッチする] ダイアログで、次の手順を行います。
1. リンクするリソースまたは列を見つけます。検索結果を絞り込むには、[フィルタ] を使用して、リソース名、リソースタイプ、列名で検索します。
  
  たとえば、ID が sample-project のプロジェクト内の sample-table という名前の BigQuery テーブルで sample-column という名前の列を検索するには、次のクエリを使用します。
```
project id:sample-project
Resource Name:sample-table
Column Name:sample-column
```
  部分文字列を入力して、一致するアセットを検索できます。
2. アタッチするデータアセットと列を選択します。
3. 追加する前に選択内容を確認するには、[選択したリソースを表示] をクリックします。
4. [追加] をクリックします。
新しくアタッチされたリソースと列を確認するには、用語の詳細ページの [関連エントリ] セクションに移動します。

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

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/TERM_PROJECT_ID/locations/DEFINITION_LINKS_LOCATION_ID:lookupEntryLinks?entry=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&entry_link_types=projects/dataplex-types/locations/global/entryLinkTypes/definition&entry_mode=TARGET&page_size=10

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

TERM_PROJECT_ID: 定義リンクを検索する用語のプロジェクト ID。
TERM_PROJECT_NUMBER: 定義リンクを検索する用語のプロジェクト番号。
DEFINITION_LINKS_LOCATION_ID: 定義リンクを検索する地域 ID。
TERM_LOCATION_ID: 用語の地域 ID。
TERM_GLOSSARY_ID: 用語を含む用語集の ID。
TERM_ID: 用語の ID。

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

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/DEFINITION_LINKS_LOCATION_ID:lookupEntryLinks?entry=projects/PROJECT_NUMBER/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entries/ENTRY_ID&entry_link_types=projects/dataplex-types/locations/global/entryLinkTypes/definition&entry_mode=SOURCE&page_size=10

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

PROJECT_ID: 定義リンクを検索するデータアセットのプロジェクト ID。
PROJECT_NUMBER: 定義リンクを検索するデータアセットのプロジェクト番号。
DEFINITION_LINKS_LOCATION_ID: 定義リンクを検索する地域 ID。
ENTRY_LOCATION_ID: データアセットの地域 ID。
ENTRY_GROUP_ID: データアセットのエントリグループの ID。
ENTRY_ID: データアセットの ID。

データアセットから用語を削除する

コンソール

Google Cloud コンソールで、Knowledge 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/ENTRY_PROJECT_ID/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entryLinks/ENTRY_LINK_ID

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

コンソール

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

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

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

REST

REST API を使用して用語集、用語、リンク済みデータアセットを検索するには、projects.locations.searchEntries をご覧ください。

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

コンソール

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

[用語集] に移動
[用語集] ページで、フィルタバーを使用して自由形式のテキスト検索クエリを入力します。これにより、用語集、カテゴリ、用語名の対応する一致リストが返されます。
一致した用語をクリックします。
[用語の詳細] ページで、この用語にリンクされている用語（類義語および関連する用語）とリンクされているエントリ（データアセット）を確認します。
Knowledge Catalog のエントリの詳細を表示するには、エントリをクリックします。

REST

REST API を使用して用語集、用語、リンク済みデータアセットを検索するには、projects.locations.searchEntries をご覧ください。

用語集と、用語同士またはデータアセットとのリンクをインポートする

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

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

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: 用語集の説明

作成したターゲット用語集のカテゴリ、用語、用語とデータアセット間のリンクをインポートするには、これらのファイルのそれぞれを 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 API エンドポイントに置き換えます。

省略可: オペレーションのステータスを取得します。
```
gcurl https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/operations/operation-OPERATION_ID
```
OPERATION_ID は、オペレーションの ID に置き換えます。

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

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

用語間のリンクを類義語または関連する用語としてインポートします。

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_API は dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID に置き換えます。

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

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

注: Cloud Storage バケットのインポートファイルに、1 つのエントリグループ内のリンクのファイルが含まれていることを確認します。別のエントリグループ内のデータアセットの用語とエントリの間にリンクを作成するには、Cloud Storage バケットに新しいファイルを指定します。
```
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_API は dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID に置き換えます。

料金

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

次のステップ

基本的なデータコンテキストを確立する方法を学習する。

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

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

ビジネス用語集の要素

用語集

カテゴリ

用語

類義語

関連する用語

制限事項

必要なロール

必要な権限

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

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

コンソール

C#

C#

Go

Go

Java

Java

Node.js

Node.js

Python

Python

Ruby

Ruby

REST

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

コンソール

C#

C#

Go

Go

Java

Java

Node.js

Node.js

Python

Python

Ruby

Ruby

REST

用語集を編集する

コンソール

REST

用語集を削除する

コンソール

C#

C#

Go

Go

Java

Java

Node.js

Node.js

Python

Python

Ruby

Ruby

REST

カテゴリの作成と管理

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

コンソール

REST

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

コンソール

REST

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

コンソール

REST

カテゴリを編集する

コンソール

REST

カテゴリを削除する

コンソール

REST

用語の作成と管理

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

コンソール

REST

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

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