Appearance
Resource
Envelope の resource は、そのイベントが「何に対して」行われたのかを表します。 種類・識別子に加えて、親リソースを含む階層を持つため、 「このノートブック配下で起きたイベント」のような絞り込みに使えます。
操作対象は必ず1つです。複数のリソースを一括で操作した場合は、 対象ごとに1件ずつイベントが記録されます。
操作対象そのものではないリソース(複製元、権限を与えた相手など)は resource ではなく references や grant に入り、 階層を持たない Reference で表します。
種類ごとの実例は Examples にあります。
Objects
Resource
操作対象そのものと、その親リソースをまとめて表します。 たとえばレポートの場合、レポート自身と、公開元のノートブックの両方が含まれます。
階層の正本は parts で、末尾の要素が操作対象です。 type / uid / name / email_addr は parts の末尾要素と同じ値、path は parts を連結した文字列で、 検索や一覧表示をしやすくするために、同じ値を重複して持たせています。
リソースの新規作成が拒否された場合、uid は null になります。 表示名を持たない種類では、name は常に null です。 invitation では name は入らず、email_addr を使います。
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
type | ResourceType | 必須 | 操作対象のリソースの種類 |
uid | string | 任意 | 操作対象のリソースの識別子。 多くは内部で払い出した ID ですが、種類によってはテーブル識別子などの自然キーが入ります。 自然キーは name を除いても個人情報が残ることがあります。詳細は ResourceType を参照してください。 |
name | string | 任意 | イベント発生時点の表示名。以後リネームされても、この値は変わりません。invitation では入りません。sensitivity: pii |
email_addr | string | 任意 | 招待先のメールアドレス。type が invitation のときに使います。マスクせずそのまま記録します。sensitivity: pii |
path | string | 必須 | parts の各要素の type と uid を / でつないだ文字列。前方一致で階層をまとめて絞り込むためのもので、分解して階層を復元する用途には使えません ( uid が / を含む場合や、uid が null の場合があるため)。階層を辿るときは parts を使ってください。 |
parts | ResourcePart[] | 必須 | 最上位の親から操作対象までの階層。末尾の要素が操作対象です。 |
ResourcePart
parts の1要素。階層に含まれるリソース1つ分を表します。
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
type | ResourceType | 必須 | このリソースの種類 |
uid | string | 任意 | このリソースの識別子。 値の性質は Resource の uid と同じです。 |
name | string | 任意 | イベント発生時点の表示名。以後リネームされても、この値は変わりません。invitation では入りません。sensitivity: pii |
email_addr | string | 任意 | 招待先のメールアドレス。type が invitation のときに使います。マスクせずそのまま記録します。sensitivity: pii |
Enums
ResourceType
操作対象になりうるリソースの種類です。
各値の実例は Examples を参照してください。
| 値 | 説明 |
|---|---|
agent_connector | エージェントコネクタ |
agent_session | AIエージェントセッション |
agent_turn | AIエージェントのターン |
ai_profile | AIプロファイル |
api_key | APIキー |
api_key_secret | APIキーのシークレット |
canvas | キャンバス |
connection | コネクション |
group | グループ |
invitation | ワークスペース招待 |
mcp_oauth_session | MCP接続 |
notebook | ノートブック |
notebook_folder | ノートブックフォルダ |
notebook_version | ノートブックのバージョン |
personal_access_token | PAT |
public_link | パブリックリンク |
query_job | クエリジョブ |
report | レポート |
saved_query | 保存済クエリ |
signed_embed | 署名付き埋め込み |
signed_embed_param | 署名付き埋め込みのサーバーサイドパラメータ |
slack_connection | Slack ワークスペース接続 |
slack_user_link | Slack ユーザーの連携 |
table | テーブル |
teamspace | チームスペース |
workflow | ワークフロー |
workflow_job | ワークフロージョブ |
workspace | ワークスペース |
Examples
agent_connector(エージェントコネクタ)
uidとnameに、操作対象の識別子と表示名が入ります
json
{
"type": "agent_connector",
"uid": "63e1be654aa70ad689601c30",
"name": "Example CRM",
"path": "agent_connector/63e1be654aa70ad689601c30",
"parts": [
{
"type": "agent_connector",
"uid": "63e1be654aa70ad689601c30",
"name": "Example CRM"
}
]
}agent_session(AIエージェントセッション)
uidとnameに、操作対象の識別子と表示名が入ります
json
{
"type": "agent_session",
"uid": "63e1be654aa70ad689601c01",
"name": "Weekly sales analysis",
"path": "agent_session/63e1be654aa70ad689601c01",
"parts": [
{
"type": "agent_session",
"uid": "63e1be654aa70ad689601c01",
"name": "Weekly sales analysis"
}
]
}agent_turn(AIエージェントのターン)
uidに識別子が入ります。表示名を持たない種類のため、nameは常にnullです- AIエージェントセッション(
agent_session)の下位リソースです。partsは親のAIエージェントセッションから順に並びます
json
{
"type": "agent_turn",
"uid": "turn_0193fa2c",
"name": null,
"path": "agent_session/63e1be654aa70ad689601c01/agent_turn/turn_0193fa2c",
"parts": [
{
"type": "agent_session",
"uid": "63e1be654aa70ad689601c01",
"name": "Weekly sales analysis"
},
{
"type": "agent_turn",
"uid": "turn_0193fa2c",
"name": null
}
]
}ai_profile(AIプロファイル)
uidとnameに、操作対象の識別子と表示名が入ります
json
{
"type": "ai_profile",
"uid": "63e1be654aa70ad689601c10",
"name": "Default",
"path": "ai_profile/63e1be654aa70ad689601c10",
"parts": [
{
"type": "ai_profile",
"uid": "63e1be654aa70ad689601c10",
"name": "Default"
}
]
}api_key(APIキー)
uidとnameに、操作対象の識別子と表示名が入ります
json
{
"type": "api_key",
"uid": "63e1be654aa70ad689601be5",
"name": "Embed Key",
"path": "api_key/63e1be654aa70ad689601be5",
"parts": [
{
"type": "api_key",
"uid": "63e1be654aa70ad689601be5",
"name": "Embed Key"
}
]
}api_key_secret(APIキーのシークレット)
uidに識別子が入ります。表示名を持たない種類のため、nameは常にnullです- APIキー(
api_key)の下位リソースです。partsは親のAPIキーから順に並びます
json
{
"type": "api_key_secret",
"uid": "1",
"name": null,
"path": "api_key/63e1be654aa70ad689601be5/api_key_secret/1",
"parts": [
{
"type": "api_key",
"uid": "63e1be654aa70ad689601be5",
"name": "Embed Key"
},
{
"type": "api_key_secret",
"uid": "1",
"name": null
}
]
}canvas(キャンバス)
uidとnameに、操作対象の識別子と表示名が入ります
json
{
"type": "canvas",
"uid": "63e1be654aa70ad689601c20",
"name": "Q1 Revenue Breakdown",
"path": "canvas/63e1be654aa70ad689601c20",
"parts": [
{
"type": "canvas",
"uid": "63e1be654aa70ad689601c20",
"name": "Q1 Revenue Breakdown"
}
]
}connection(コネクション)
uidとnameに、操作対象の識別子と表示名が入ります
json
{
"type": "connection",
"uid": "63e1be654aa70ad689601bef",
"name": "BigQuery Prod",
"path": "connection/63e1be654aa70ad689601bef",
"parts": [
{
"type": "connection",
"uid": "63e1be654aa70ad689601bef",
"name": "BigQuery Prod"
}
]
}group(グループ)
uidとnameに、操作対象の識別子と表示名が入ります
json
{
"type": "group",
"uid": "63e1be654aa70ad689601be3",
"name": "Data Engineers",
"path": "group/63e1be654aa70ad689601be3",
"parts": [
{
"type": "group",
"uid": "63e1be654aa70ad689601be3",
"name": "Data Engineers"
}
]
}invitation(ワークスペース招待)
uidに識別子が入ります。表示にはemail_addr(招待先メールアドレス)を使います。nameは入りません
json
{
"type": "invitation",
"uid": "63e1be654aa70ad689601bf4",
"email_addr": "taro@example.com",
"path": "invitation/63e1be654aa70ad689601bf4",
"parts": [
{
"type": "invitation",
"uid": "63e1be654aa70ad689601bf4",
"email_addr": "taro@example.com"
}
]
}mcp_oauth_session(MCP接続)
uidに識別子が入ります。表示名を持たない種類のため、nameは常にnullです
json
{
"type": "mcp_oauth_session",
"uid": "oauth_sess_01",
"name": null,
"path": "mcp_oauth_session/oauth_sess_01",
"parts": [
{
"type": "mcp_oauth_session",
"uid": "oauth_sess_01",
"name": null
}
]
}notebook(ノートブック)
uidとnameに、操作対象の識別子と表示名が入ります
json
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI",
"path": "notebook/63e1be654aa70ad689601bf3",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
}
]
}notebook_folder(ノートブックフォルダ)
uidとnameに、操作対象の識別子と表示名が入ります
json
{
"type": "notebook_folder",
"uid": "63e1be654aa70ad689601be9",
"name": "Q1 Reports",
"path": "notebook_folder/63e1be654aa70ad689601be9",
"parts": [
{
"type": "notebook_folder",
"uid": "63e1be654aa70ad689601be9",
"name": "Q1 Reports"
}
]
}notebook_version(ノートブックのバージョン)
uidとnameに、操作対象の識別子と表示名が入ります- ノートブック(
notebook)の下位リソースです。partsは親のノートブックから順に並びます
json
{
"type": "notebook_version",
"uid": "63e1be654aa70ad689601bea",
"name": "v12",
"path": "notebook/63e1be654aa70ad689601bf3/notebook_version/63e1be654aa70ad689601bea",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
},
{
"type": "notebook_version",
"uid": "63e1be654aa70ad689601bea",
"name": "v12"
}
]
}personal_access_token(PAT)
uidとnameに、操作対象の識別子と表示名が入ります
json
{
"type": "personal_access_token",
"uid": "63e1be654aa70ad689601be6",
"name": "CI Token",
"path": "personal_access_token/63e1be654aa70ad689601be6",
"parts": [
{
"type": "personal_access_token",
"uid": "63e1be654aa70ad689601be6",
"name": "CI Token"
}
]
}public_link(パブリックリンク)
uidとnameに、操作対象の識別子と表示名が入ります- ノートブック(
notebook)の下位リソースです。partsは親のノートブックから順に並びます
json
{
"type": "public_link",
"uid": "63e1be654aa70ad689601bec",
"name": "Public Share",
"path": "notebook/63e1be654aa70ad689601bf3/public_link/63e1be654aa70ad689601bec",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
},
{
"type": "public_link",
"uid": "63e1be654aa70ad689601bec",
"name": "Public Share"
}
]
}query_job(クエリジョブ)
uidに識別子が入ります。表示名を持たない種類のため、nameは常にnullです- コネクション(
connection)の下位リソースです。partsは親のコネクションから順に並びます
json
{
"type": "query_job",
"uid": "job_0193fa2c",
"name": null,
"path": "connection/63e1be654aa70ad689601bef/query_job/job_0193fa2c",
"parts": [
{
"type": "connection",
"uid": "63e1be654aa70ad689601bef",
"name": "BigQuery Prod"
},
{
"type": "query_job",
"uid": "job_0193fa2c",
"name": null
}
]
}report(レポート)
uidとnameに、操作対象の識別子と表示名が入ります- ノートブック(
notebook)の下位リソースです。partsは親のノートブックから順に並びます
json
{
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard",
"path": "notebook/63e1be654aa70ad689601bf3/report/63e1be654aa70ad689601bf5",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
},
{
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard"
}
]
}saved_query(保存済クエリ)
uidとnameに、操作対象の識別子と表示名が入ります- コネクション(
connection)の下位リソースです。partsは親のコネクションから順に並びます
json
{
"type": "saved_query",
"uid": "63e1be654aa70ad689601c50",
"name": "Monthly Active Users",
"path": "connection/63e1be654aa70ad689601bef/saved_query/63e1be654aa70ad689601c50",
"parts": [
{
"type": "connection",
"uid": "63e1be654aa70ad689601bef",
"name": "BigQuery Prod"
},
{
"type": "saved_query",
"uid": "63e1be654aa70ad689601c50",
"name": "Monthly Active Users"
}
]
}signed_embed(署名付き埋め込み)
uidとnameに、操作対象の識別子と表示名が入ります- ノートブック(
notebook)の下位リソースです。partsは親のノートブックから順に並びます uidは、トークン発行 API のintegration_idと同じ値です
json
{
"type": "signed_embed",
"uid": "63e1be654aa70ad689601beb",
"name": "Partner Embed",
"path": "notebook/63e1be654aa70ad689601bf3/signed_embed/63e1be654aa70ad689601beb",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
},
{
"type": "signed_embed",
"uid": "63e1be654aa70ad689601beb",
"name": "Partner Embed"
}
]
}signed_embed_param(署名付き埋め込みのサーバーサイドパラメータ)
uidに識別子が入ります。表示名を持たない種類のため、nameは常にnullです- 署名付き埋め込み(
signed_embed)の下位リソースです。partsは親の署名付き埋め込みから順に並びます
json
{
"type": "signed_embed_param",
"uid": "wgt_1",
"name": null,
"path": "notebook/63e1be654aa70ad689601bf3/signed_embed/63e1be654aa70ad689601beb/signed_embed_param/wgt_1",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
},
{
"type": "signed_embed",
"uid": "63e1be654aa70ad689601beb",
"name": "Partner Embed"
},
{
"type": "signed_embed_param",
"uid": "wgt_1",
"name": null
}
]
}slack_connection(Slack ワークスペース接続)
uidとnameに、操作対象の識別子と表示名が入ります
json
{
"type": "slack_connection",
"uid": "63e1be654aa70ad689601c70",
"name": "Acme",
"path": "slack_connection/63e1be654aa70ad689601c70",
"parts": [
{
"type": "slack_connection",
"uid": "63e1be654aa70ad689601c70",
"name": "Acme"
}
]
}slack_user_link(Slack ユーザーの連携)
uidに識別子が入ります。表示名を持たない種類のため、nameは常にnullです
json
{
"type": "slack_user_link",
"uid": "63e1be654aa70ad689601c80",
"name": null,
"path": "slack_user_link/63e1be654aa70ad689601c80",
"parts": [
{
"type": "slack_user_link",
"uid": "63e1be654aa70ad689601c80",
"name": null
}
]
}table(テーブル)
uidとnameに、操作対象の識別子と表示名が入ります- コネクション(
connection)の下位リソースです。partsは親のコネクションから順に並びます uidは内部的な識別子ではなく、データソース上のテーブル識別子ですuidは自然キーのため sensitivity:piiです。nameを除いても個人情報は残ることがあります
json
{
"type": "table",
"uid": "project.dataset.orders",
"name": "orders",
"path": "connection/63e1be654aa70ad689601bef/table/project.dataset.orders",
"parts": [
{
"type": "connection",
"uid": "63e1be654aa70ad689601bef",
"name": "BigQuery Prod"
},
{
"type": "table",
"uid": "project.dataset.orders",
"name": "orders"
}
]
}teamspace(チームスペース)
uidとnameに、操作対象の識別子と表示名が入ります
json
{
"type": "teamspace",
"uid": "63e1be654aa70ad689601be4",
"name": "Marketing",
"path": "teamspace/63e1be654aa70ad689601be4",
"parts": [
{
"type": "teamspace",
"uid": "63e1be654aa70ad689601be4",
"name": "Marketing"
}
]
}workflow(ワークフロー)
uidとnameに、操作対象の識別子と表示名が入ります
json
{
"type": "workflow",
"uid": "63e1be654aa70ad689601be1",
"name": "Daily Sync",
"path": "workflow/63e1be654aa70ad689601be1",
"parts": [
{
"type": "workflow",
"uid": "63e1be654aa70ad689601be1",
"name": "Daily Sync"
}
]
}workflow_job(ワークフロージョブ)
uidに識別子が入ります。表示名を持たない種類のため、nameは常にnullです- ワークフロー(
workflow)の下位リソースです。partsは親のワークフローから順に並びます
json
{
"type": "workflow_job",
"uid": "wjob_01",
"name": null,
"path": "workflow/63e1be654aa70ad689601be1/workflow_job/wjob_01",
"parts": [
{
"type": "workflow",
"uid": "63e1be654aa70ad689601be1",
"name": "Daily Sync"
},
{
"type": "workflow_job",
"uid": "wjob_01",
"name": null
}
]
}workspace(ワークスペース)
uidとnameに、操作対象の識別子と表示名が入ります
json
{
"type": "workspace",
"uid": "63e1be654aa70ad689601be0",
"name": "Acme Analytics",
"path": "workspace/63e1be654aa70ad689601be0",
"parts": [
{
"type": "workspace",
"uid": "63e1be654aa70ad689601be0",
"name": "Acme Analytics"
}
]
}