Appearance
ノートブック
ノートブックは、SQL・チャート・テキストなどをまとめて共同編集できるデータ分析のドキュメントです。
イベント一覧
| イベント | リソース | 説明 |
|---|---|---|
notebook.create | notebook | ノートブックが作成された |
notebook.duplicate | notebook | ノートブックが複製された |
notebook.restore | notebook | ノートブックが過去のバージョンから復元された |
notebook.rename | notebook | ノートブック名が変更された |
notebook.edit | notebook | ノートブックが編集された |
notebook.move | notebook | ノートブックが移動された |
notebook.open | notebook | ノートブックが開かれた |
notebook.add_share_permission | notebook | ノートブックの追加権限が付与された |
notebook.change_share_permission | notebook | ノートブックの追加権限のロールが変更された |
notebook.remove_share_permission | notebook | ノートブックの追加権限が削除された |
notebook.delete | notebook | ノートブックが削除された |
イベント詳細
notebook.create プレビュー
記録期間: 2026-09-15 〜
ノートブックの作成を記録します。
| フィールド | 値 |
|---|---|
event.code | notebook.create |
scope.type | workspace |
resource.type | notebook |
references | (なし) |
query | (なし) |
outbound | (なし) |
change | notebook_folder_path |
grant | (なし) |
extra | (なし) |
change
| 名前 | モード | 型 | 必須 | 説明 |
|---|---|---|---|---|
notebook_folder_path | 値 | Reference[] | 任意 | 配置先の親フォルダ階層です。 並びは notebook_folder_path を参照してください。 |
サンプル
json
{
"event": {
"code": "notebook.create",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI",
"path": "notebook/63e1be654aa70ad689601bf3",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
}
],
...
},
"change": {
"fields": [
{
"name": "notebook_folder_path",
"new": [
{
"type": "notebook_folder",
"uid": "WORKSPACE",
"name": "Workspace"
},
{
"type": "notebook_folder",
"uid": "63e1be654aa70ad689601bf2",
"name": "Quarterly Reports"
}
]
}
]
},
...
}notebook.duplicate プレビュー
記録期間: 2026-09-15 〜
ノートブックの複製を記録します。過去のバージョンから新しいノートブックを作成した場合も、このイベントになります。
| フィールド | 値 |
|---|---|
event.code | notebook.duplicate |
scope.type | workspace |
resource.type | notebook |
references | 複製元のノートブック |
query | (なし) |
outbound | (なし) |
change | notebook_folder_path |
grant | (なし) |
extra | (なし) |
references
複製元のノートブックの識別子と表示名が入ります。 過去のバージョンから新しいノートブックを作成したときは、使ったバージョンも入ります。
relation | type | 必須 | 説明 |
|---|---|---|---|
source | notebook | 必須 | ノートブック |
source | notebook_version | 任意 | ノートブックのバージョン |
change
| 名前 | モード | 型 | 必須 | 説明 |
|---|---|---|---|---|
notebook_folder_path | 値 | Reference[] | 任意 | 配置先の親フォルダ階層です。 並びは notebook_folder_path を参照してください。 |
サンプル
ノートブックを複製する
json
{
"event": {
"code": "notebook.duplicate",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "notebook",
"uid": "63e1be654aa70ad689601bf9",
"name": "Sales KPI (copy)",
"path": "notebook/63e1be654aa70ad689601bf9",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf9",
"name": "Sales KPI (copy)"
}
],
...
},
"references": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI",
"relation": "source"
}
],
"change": {
"fields": [
{
"name": "notebook_folder_path",
"new": [
{
"type": "notebook_folder",
"uid": "WORKSPACE",
"name": "Workspace"
},
{
"type": "notebook_folder",
"uid": "63e1be654aa70ad689601bf2",
"name": "Quarterly Reports"
}
]
}
]
},
...
}過去のバージョンから新しいノートブックを作成する
json
{
"event": {
"code": "notebook.duplicate",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "notebook",
"uid": "63e1be654aa70ad689601bf9",
"name": "Sales KPI restored",
"path": "notebook/63e1be654aa70ad689601bf9",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf9",
"name": "Sales KPI restored"
}
],
...
},
"references": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI",
"relation": "source"
},
{
"type": "notebook_version",
"uid": "63e1be654aa70ad689601bf4",
"name": "v1",
"relation": "source"
}
],
"change": {
"fields": [
{
"name": "notebook_folder_path",
"new": [
{
"type": "notebook_folder",
"uid": "WORKSPACE",
"name": "Workspace"
},
{
"type": "notebook_folder",
"uid": "63e1be654aa70ad689601bf2",
"name": "Quarterly Reports"
}
]
}
]
},
...
}notebook.restore プレビュー
記録期間: 2026-09-15 〜
ノートブックの過去のバージョンからの復元を記録します。
| フィールド | 値 |
|---|---|
event.code | notebook.restore |
scope.type | workspace |
resource.type | notebook |
references | 復元元のノートブックのバージョン |
query | (なし) |
outbound | (なし) |
change | (なし) |
grant | (なし) |
extra | (なし) |
references
復元に使ったノートブックバージョンが入ります。
relation | type | 必須 | 説明 |
|---|---|---|---|
source | notebook_version | 必須 | ノートブックのバージョン |
サンプル
json
{
"event": {
"code": "notebook.restore",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI",
"path": "notebook/63e1be654aa70ad689601bf3",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
}
],
...
},
"references": [
{
"type": "notebook_version",
"uid": "63e1be654aa70ad689601bf4",
"name": "v1",
"relation": "source"
}
],
...
}notebook.rename プレビュー
記録期間: 2026-09-15 〜
ノートブックの表示名の変更を記録します。
| フィールド | 値 |
|---|---|
event.code | notebook.rename |
scope.type | workspace |
resource.type | notebook |
references | (なし) |
query | (なし) |
outbound | (なし) |
change | name |
grant | (なし) |
extra | (なし) |
change
| 名前 | モード | 型 | 必須 | 説明 |
|---|---|---|---|---|
name | 値 | string | 必須 | 変更前後の表示名 sensitivity: pii |
サンプル
json
{
"event": {
"code": "notebook.rename",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI",
"path": "notebook/63e1be654aa70ad689601bf3",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
}
],
...
},
"change": {
"fields": [
{
"name": "name",
"old": "Old",
"new": "Sales KPI"
}
]
},
...
}notebook.edit プレビュー
記録期間: 2026-09-15 〜
ノートブックの編集を記録します。
| フィールド | 値 |
|---|---|
event.code | notebook.edit |
scope.type | workspace |
resource.type | notebook |
references | (なし) |
query | (なし) |
outbound | (なし) |
change | (なし) |
grant | (なし) |
extra | (なし) |
サンプル
json
{
"event": {
"code": "notebook.edit",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI",
"path": "notebook/63e1be654aa70ad689601bf3",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
}
],
...
},
...
}notebook.move プレビュー
記録期間: 2026-09-15 〜
ノートブックの移動を記録します。
| フィールド | 値 |
|---|---|
event.code | notebook.move |
scope.type | workspace |
resource.type | notebook |
references | (なし) |
query | (なし) |
outbound | (なし) |
change | notebook_folder_path |
grant | (なし) |
extra | (なし) |
change
| 名前 | モード | 型 | 必須 | 説明 |
|---|---|---|---|---|
notebook_folder_path | 値 | Reference[] | 任意 | 配置先の親フォルダ階層です。 並びは notebook_folder_path を参照してください。 |
サンプル
json
{
"event": {
"code": "notebook.move",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI",
"path": "notebook/63e1be654aa70ad689601bf3",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
}
],
...
},
"change": {
"fields": [
{
"name": "notebook_folder_path",
"old": [
{
"type": "notebook_folder",
"uid": "WORKSPACE",
"name": "Workspace"
},
{
"type": "notebook_folder",
"uid": "63e1be654aa70ad689601bfc",
"name": "Sales"
},
{
"type": "notebook_folder",
"uid": "63e1be654aa70ad689601bfa",
"name": "Reports"
}
],
"new": [
{
"type": "notebook_folder",
"uid": "WORKSPACE",
"name": "Workspace"
},
{
"type": "notebook_folder",
"uid": "63e1be654aa70ad689601bfb",
"name": "Archive"
}
]
}
]
},
...
}notebook.open プレビュー
記録期間: 2026-09-15 〜
ノートブックが開かれたことを記録します。
| フィールド | 値 |
|---|---|
event.code | notebook.open |
scope.type | workspace |
resource.type | notebook |
references | (なし) |
query | (なし) |
outbound | (なし) |
change | (なし) |
grant | (なし) |
extra | (なし) |
サンプル
json
{
"event": {
"code": "notebook.open",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI",
"path": "notebook/63e1be654aa70ad689601bf3",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
}
],
...
},
...
}notebook.add_share_permission プレビュー
記録期間: 2026-09-15 〜
ノートブックの追加権限の付与を記録します。
| フィールド | 値 |
|---|---|
event.code | notebook.add_share_permission |
scope.type | workspace |
resource.type | notebook |
references | (なし) |
query | (なし) |
outbound | (なし) |
change | (なし) |
grant | 付与先と付与権限 |
extra | (なし) |
grant
追加権限が付与されたユーザーまたはグループと付与された権限が入ります。
サンプル
json
{
"event": {
"code": "notebook.add_share_permission",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI",
"path": "notebook/63e1be654aa70ad689601bf3",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
}
],
...
},
"grant": {
"target": {
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
},
"grantee": {
"type": "user",
"uid": "63e1be654aa70ad689601bec",
"email_addr": "taro@example.com"
},
"role": {
"new": "notebook.editor"
}
},
...
}notebook.change_share_permission プレビュー
記録期間: 2026-09-15 〜
ノートブックの追加権限のロールの変更を記録します。
| フィールド | 値 |
|---|---|
event.code | notebook.change_share_permission |
scope.type | workspace |
resource.type | notebook |
references | (なし) |
query | (なし) |
outbound | (なし) |
change | (なし) |
grant | 変更前後のロール |
extra | (なし) |
grant
追加権限のロールが変更されたユーザーまたはグループと変更前後のロールが入ります。
サンプル
json
{
"event": {
"code": "notebook.change_share_permission",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI",
"path": "notebook/63e1be654aa70ad689601bf3",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
}
],
...
},
"grant": {
"target": {
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
},
"grantee": {
"type": "user",
"uid": "63e1be654aa70ad689601bec",
"email_addr": "taro@example.com"
},
"role": {
"old": "notebook.viewer",
"new": "notebook.editor"
}
},
...
}notebook.remove_share_permission プレビュー
記録期間: 2026-09-15 〜
ノートブックの追加権限の削除を記録します。
| フィールド | 値 |
|---|---|
event.code | notebook.remove_share_permission |
scope.type | workspace |
resource.type | notebook |
references | (なし) |
query | (なし) |
outbound | (なし) |
change | (なし) |
grant | 削除された追加権限 |
extra | (なし) |
grant
追加権限が削除されたユーザーまたはグループと削除された権限が入ります。
サンプル
json
{
"event": {
"code": "notebook.remove_share_permission",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI",
"path": "notebook/63e1be654aa70ad689601bf3",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
}
],
...
},
"grant": {
"target": {
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
},
"grantee": {
"type": "group",
"uid": "63e1be654aa70ad689601bed",
"name": "Data Engineers"
},
"role": {
"old": "notebook.viewer"
}
},
...
}notebook.delete プレビュー
記録期間: 2026-09-15 〜
ノートブックの削除を記録します。
| フィールド | 値 |
|---|---|
event.code | notebook.delete |
scope.type | workspace |
resource.type | notebook |
references | (なし) |
query | (なし) |
outbound | (なし) |
change | notebook_folder_path |
grant | (なし) |
extra | (なし) |
change
| 名前 | モード | 型 | 必須 | 説明 |
|---|---|---|---|---|
notebook_folder_path | 値 | Reference[] | 任意 | 配置先の親フォルダ階層です。 並びは notebook_folder_path を参照してください。 |
サンプル
json
{
"event": {
"code": "notebook.delete",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI",
"path": "notebook/63e1be654aa70ad689601bf3",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
}
],
...
},
"change": {
"fields": [
{
"name": "notebook_folder_path",
"old": [
{
"type": "notebook_folder",
"uid": "WORKSPACE",
"name": "Workspace"
},
{
"type": "notebook_folder",
"uid": "63e1be654aa70ad689601bf2",
"name": "Quarterly Reports"
}
]
}
]
},
...
}