ノートブックを管理する

注: BigQuery Studio ノートブックは、一般提供となる 2024 年 4 月 11 日以降、課金の対象となります。請求書には、BigQuery Studio ノートブックの使用量に基づく請求が表示されるようになります。

このドキュメントでは、BigQuery で Colab Enterprise ノートブックを管理する方法について説明します。ノートブックは、Dataform が提供する BigQuery Studio コードアセットです。

ノートブックを使用するには、まずアセット管理に関する BigQuery Studio を有効にする必要があります。

重要: 2024 年 3 月、BigQuery Studio 機能をサポートする API が、既存のすべての BigQuery プロジェクトで自動的に有効になりました。新しい BigQuery プロジェクトでは、これらの API がデフォルトで有効になっています。詳細については、BigQuery Studio API の自動有効化をご覧ください。

必要な権限

ノートブックを共有するには、次の Identity and Access Management（IAM）ロールが必要です。

• BigQuery ジョブユーザー（roles/bigquery.jobUser）
• BigQuery 読み取りセッション ユーザー（roles/bigquery.readSessionUser）
• リソースレベルのコードオーナー（roles/dataform.codeOwner）

ノートブックの保存と削除を行うには、次の IAM ロールが必要です。

• BigQuery ジョブユーザー（roles/bigquery.jobUser）
• BigQuery 読み取りセッション ユーザー（roles/bigquery.readSessionUser）
• コードオーナー（roles/dataform.codeOwner）またはコード編集者（roles/dataform.codeEditor）

ノートブックのリビジョンを操作するには、次の IAM ロールが必要です。

• BigQuery ジョブユーザー（roles/bigquery.jobUser）
• BigQuery 読み取りセッション ユーザー（roles/bigquery.readSessionUser）

• 次のいずれかのロール:

  • コードオーナー（roles/dataform.codeOwner）
  • コードエディタ（roles/dataform.codeEditor）
  • コード閲覧者（roles/dataform.codeViewer）

BigQuery IAM の詳細については、IAM でのアクセス制御をご覧ください。

ノートブックへのアクセス権を付与する

他のユーザーにノートブックへのアクセス権を付与するには、そのユーザーを適切な IAM ロールに追加します。

重要: ノートブックにアクセスできるユーザーは、ノートブック内のコードによって生成されたすべての出力を表示できます。自分がアクセスできないテーブルのデータが含まれた出力でも表示できます。保存した出力が共有されないようにするには、ノートブックの出力保存を無効にします。

1. Google Cloud コンソールで [BigQuery] ページに移動します。

   [BigQuery] に移動

2. [エクスプローラ] ペインで、プロジェクトと [ノートブック] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。アクセス権を付与するノートブックを見つけます。

3. ノートブックの横にある （アクションを表示）をクリックし、[共有] > [権限の管理] をクリックします。

4. [権限を管理] ペインで、[ユーザー / グループの追加] をクリックします。

5. [新しいプリンシパル] フィールドに、プリンシパルを入力します。

6. [ロール] リストで、次のいずれかのロールを選択します。

   • コードオーナー: ノートブックの削除や共有など、ノートブックに対するあらゆるアクションを実行できます。
   • コードエディタ: ノートブックを編集できます。
   • コード閲覧者: ノートブックを表示できます。
   注: また、ノートブックを実行するには、プリンシパルにノートブック ランタイム ユーザー（roles/aiplatform.notebookRuntimeUser）と BigQuery ユーザー（roles/bigquery.user）のロールが必要です。

7. 省略可: ロールと詳細な共有設定の完全なリストを表示するには、[詳細な共有] をクリックします。

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

9. ノートブック情報ページに戻るには、[閉じる] をクリックします。

ノートブックを共有する

ノートブックを他のユーザーと共有するには、ノートブックへのリンクを生成して共有します。共有したノートブックを他のユーザーに表示するには、最初にノートブックへのアクセス権を付与する必要があります。

ノートブックを実行するには、ノートブックがアクセスするデータにユーザーがアクセスできる必要があります。詳細については、データセットへのアクセス権を付与するをご覧ください。

重要: ノートブックにアクセスできるユーザーは、ノートブック内のコードによって生成されたすべての出力を表示できます。自分がアクセスできないテーブルのデータが含まれた出力でも表示できます。保存した出力が共有されないようにするには、ノートブックの出力保存を無効にします。

1. Google Cloud コンソールで [BigQuery] ページに移動します。

   [BigQuery] に移動

2. [エクスプローラ] ペインで、プロジェクトと [ノートブック] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。共有するノートブックを見つけます。

3. ノートブックの横にある （アクションを表示）をクリックし、[共有] > [リンクをコピー] をクリックします。

4. リンクを他のユーザーと共有します。

すべてのノートブックを表示する

プロジェクト内のすべてのノートブックのリストを表示するには、次の手順を行います。

1. Google Cloud コンソールで [BigQuery] ページに移動します。

   [BigQuery] に移動

2. [エクスプローラ] ペインで、[Notebooks] の横にある （アクションを表示）をクリックし、次のいずれかを行います。

• 現在のタブでリストを開くには、[すべて表示] をクリックします。
• リストを新しいタブで開くには、[すべてを表示] > [新しいタブ] をクリックします。
• 分割タブでリストを開くには、[すべてを表示] > [タブを分割] をクリックします。

ノートブックのメタデータを表示する

ノートブックのメタデータを表示する手順は次のとおりです。

1. Google Cloud コンソールで [BigQuery] ページに移動します。

   [BigQuery] に移動

2. [エクスプローラ] ペインで、プロジェクトと [Notebooks] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。メタデータを表示するノートブックの名前をクリックします。

3. [概要] ペインで、データに使用するリージョンや最終更新日など、ノートブックに関する情報を確認します。

ノートブックのバージョンを操作する

以降のセクションでは、ノートブックのバージョンを表示、比較、復元する方法について説明します。

ノートブックのバージョンを表示する

ノートブックのバージョンを表示する手順は次のとおりです。

1. Google Cloud コンソールで [BigQuery] ページに移動します。

   [BigQuery] に移動

2. [エクスプローラ] ペインで、プロジェクトと [Notebooks] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。アクティビティを表示するノートブックの名前をクリックします。

3. [アクティビティ] タブをクリックすると、ノートブックのバージョンが日付の降順で表示されます。

ノートブックのバージョンを比較する

ノートブックのバージョンを比較する手順は次のとおりです。

1. Google Cloud コンソールで [BigQuery] ページに移動します。

   [BigQuery] に移動

2. [エクスプローラ] ペインで、プロジェクトと [Notebooks] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。バージョン情報を比較するノートブックの名前をクリックします。

3. [アクティビティ] タブで、ノートブック バージョンの横にある （アクションを表示）をクリックし、[比較] をクリックします。

4. [変更履歴] ペインで、[バージョン] プルダウンを使用して、比較するバージョンを選択します。

5. 省略可: ノートブックのソースコードを比較するには、[元の形式のソース] チェックボックスをオンにします。

6. 省略可: 個別のペインではなく、インラインでバージョンを比較するには、[インラインで差分を表示] チェックボックスをオンにします。

7. 省略可: ノートブックのコマンド出力を非表示にするには、[出力を表示] チェックボックスをオフにします。

ノートブックのバージョンを復元する

ノートブックのバージョンを復元するには、次のいずれかのオプションを使用します。[変更履歴] ペインから復元すると、以前のバージョンの復元を選択する前に、ノートブックの現在のバージョンと以前のバージョンを比較できます。ノートブックを復元すると、現在のバージョンを上書きするのではなく、新しいバージョンのノートブックが作成されます。変更履歴が失われることはありません。

アクティビティ ペイン

1. Google Cloud コンソールで [BigQuery] ページに移動します。

   [BigQuery] に移動

2. [エクスプローラ] ペインで、プロジェクトと [Notebooks] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。以前のバージョンを復元するノートブックの名前をクリックします。

3. [アクティビティ] ペインを選択します。

4. 復元するノートブックのバージョンの横にある （アクションを表示）をクリックし、[復元] をクリックします。

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

変更履歴

1. Google Cloud コンソールで [BigQuery] ページに移動します。

   [BigQuery] に移動

2. [エクスプローラ] ペインで、プロジェクトと [Notebooks] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。以前のバージョンを復元するノートブックの名前をクリックします。

3. [アクティビティ] ペインを選択します。

4. ノートブック バージョンの横にある （アクションを表示）をクリックし、[比較] をクリックします。

5. [変更履歴] ペインで、[バージョン] プルダウンの横にある （アクションを表示）をクリックして、[以前のリビジョンを復元] をクリックします。

6. [Confirm] をクリックします。

ノートブックをダウンロードする

ノートブックをダウンロードする手順は次のとおりです。

1. Google Cloud コンソールで [BigQuery] ページに移動します。

   [BigQuery] に移動

2. [エクスプローラ] ペインで、プロジェクトと [Notebooks] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。ダウンロードするノートブックの名前をクリックします。

3. [ダウンロード] をクリックします。

ノートブックを削除する

ノートブックの削除方法は次のとおりです。

1. Google Cloud コンソールで [BigQuery] ページに移動します。

   [BigQuery] に移動

2. [エクスプローラ] ペインで、プロジェクトと [Notebooks] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。削除するノートブックを見つけます。

3. ノートブックの横にある （アクションを表示）をクリックし、[削除] をクリックします。

4. 削除を確定するには、ダイアログで「delete」と入力します。

5. [削除] をクリックします。

トラブルシューティング

詳細については、Colab Enterprise のトラブルシューティングをご覧ください。

次のステップ

• BigQuery での Colab Enterprise ノートブックの詳細を確認する。
• ノートブックの作成方法を学習する。