データ ドメインを使用する

プレビュー

このプロダクトまたは機能は、サービス固有規約の「一般サービス規約」セクションの「一般提供前のサービス規約」の対象となります。pre-GA のプロダクトと機能は「現状のまま」利用できますが、サポートが制限されることがあります。詳細については、リリース ステージの説明をご覧ください。

データ ドメインのユーザーは、データ ドメインを使用して検索結果を特定のビジネス コンテキストに絞り込み、BigQuery データセット、テーブル、データ プロダクトを検索し、特定のドメイン境界内のメタデータを検出できます。

始める前に

ドメインで検索する前に、必要なロールが付与され、必要な API が有効になっていることを確認してください。

API を有効にする

Dataplex API を有効にします。

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

API を有効にするには、serviceusage.services.enable 権限が必要です。プロジェクトを作成した場合は、オーナーロール（roles/owner）を介してこの権限がすでに付与されている可能性があります。それ以外の場合は、Service Usage 管理者ロール（roles/serviceusage.serviceUsageAdmin）を介してこの権限を取得できます。ロールを付与する方法をご覧ください。

API の有効化

必要なロール

データ ドメインを使用してメタデータを検索して検出するために必要な権限を取得するには、プロジェクトまたはデータ ドメインに対する次の IAM ロールを付与するよう管理者に依頼してください。

• 検出用のドメイン エントリのメタデータを表示する: Dataplex データドメイン エントリ リーダー （roles/dataplex.dataDomainEntryReader）
• ドメイン構成とバインディングを表示する: Dataplex データドメイン構成の閲覧者 （roles/dataplex.dataDomainViewer）

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

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

ドメイン階層を閲覧する

ドメイン階層を閲覧する方法の詳細については、ロケーション内のデータ ドメインとサブドメインを表示するをご覧ください。

データドメイン内のリソースを検索する

ドメインでリソースを検索する手順は次のとおりです。

コンソール

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

   [検索] に移動

2. [オーガニック検索を試す] をクリックして、オーガニック検索機能を有効にします。

3. [フィルタ] をクリックします。

4. [スコープ] フィールドで、リストから [ドメイン] を選択します。

5. [ドメインを選択] フィールドで、結果を絞り込むドメインを選択します。必要に応じて、他のフィルタを追加します。

また、[ドメイン内を検索] メニュー オプションを使用して、ドメイン内のリソースを検索することもできます。

1. Google Cloud コンソールで、[データ ドメイン] ページに移動します。

   [データ ドメイン] に移動

2. more_vert メニューから [ドメイン内を検索] を選択します。この操作を行うと、ドメイン フィルタが適用された検索ウィンドウが自動的に開きます。

3. 検索フィールドを使用して、ドメイン内のリソースを検索します。

REST

データ ドメインにスコープ設定されたエントリを検索するには、projects.locations.searchEntries メソッドを使用し、contexts パラメータでドメインパスを指定します。

注: searchEntries のパスの場所は、検索バックエンドの構成に応じて global（完全なファンアウトの場合）または特定のリージョンになります。

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_ID: 実際の Google Cloud プロジェクト ID。
• LOCATION_ID: 検索クエリのリージョン（または global）。
• QUERY: 検索クエリ文字列。
• DOMAIN_ID: 検索スコープのコンテキストを定義するデータドメインの固有識別子。

HTTP メソッドと URL:

POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID:searchEntries

リクエストの本文（JSON）:

{
  "query": "QUERY",
  "contexts": [ "projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID" ],
  "semantic_search": true,
  "page_size": 100
}

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID:searchEntries"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID:searchEntries" | Select-Object -Expand Content

成功したことを示すステータス コード（2xx）と空のレスポンスが返されます。

制限事項

ドメイン コンテキスト外でリソースを検索する場合（グローバル検索を使用する場合など）、ドメインの検出可能性権限は適用されません。基盤となるシステム（BigQuery など）でアクセス権があるリソースのみが表示されます。

BigQuery データセットがデータ ドメインに含まれているとします。ドメインの Dataplex Data Domain Entry Reader ロールはありますが、BigQuery でデータセットを表示する直接的な権限はありません。

• ドメイン内の検索: ドメイン権限が適用されるため、検索結果にデータセットが表示されます。
• ドメイン外の検索: 検索結果にデータセットが表示されません。一般的な検索では、ドメイン権限は適用されず、BigQuery に直接アクセスすることはできません。

次のステップ

• 詳しくは、データ ドメインをご覧ください。
• データ ドメインを作成する方法を学習する。
• データ ドメイン リソースを管理する方法を確認する。