Resource

Envelope の resource は、そのイベントが「何に対して」行われたのかを表します。種類・識別子・イベント発生時点の表示名に加えて、親リソースを含む階層を持つため、「このノートブック配下で起きたイベント」のような絞り込みに使えます。

操作対象は必ず1つです。複数のリソースを一括で操作した場合は、対象ごとに1件ずつイベントが記録されます。

操作対象そのものではないリソース（複製元、権限を与えた相手など）は resource ではなく references や grant に入り、階層を持たない Reference で表します。

種類ごとの実例は Examples にあります。

Objects

`Resource`

操作対象そのものと、その親リソースをまとめて表します。たとえばレポートの場合、レポート自身と、公開元のノートブックの両方が含まれます。

階層の正本は parts で、末尾の要素が操作対象です。 type / uid / name は parts の末尾要素と同じ値、path は parts を連結した文字列で、検索や一覧表示をしやすくするために、同じ値を重複して持たせています。

uid と name は、次の場合は null になります。

ワークスペース内に1つしか存在しない種類のリソース（個別の識別子を持たないため）
新規作成が拒否され、リソースが作られなかった場合

名前	型	必須	説明
`type`	`ResourceType`	必須	操作対象のリソースの種類
`uid`	`string`	任意	操作対象のリソースの識別子。多くは内部で払い出した ID ですが、種類によってはテーブル識別子やストレージパスなどの自然キーが入ります。自然キーは `name` を除いても個人情報が残ることがあります。詳細は `ResourceType` を参照してください。
`name`	`string`	任意	イベント発生時点の表示名。以後リネームされても、この値は変わりません。 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`	任意	イベント発生時点の表示名。以後リネームされても、この値は変わりません。 sensitivity: `pii`

Enums

`ResourceType`

操作対象になりうるリソースの種類です。

各値の実例は Examples を参照してください。

値	説明
`workspace`	ワークスペース
`workspace_member`	ワークスペースメンバーシップ
`billing`	課金
`notebook`	ノートブック
`connection`	コネクション
`workflow`	ワークフロー
`notebook_media`	ノートブックメディア
`group`	グループ
`teamspace`	チームスペース
`api_key`	APIキー
`api_key_secret`	APIキーのシークレット
`personal_access_token`	PAT
`notebook_theme`	ノートブックテーマ
`tag`	タグ
`notebook_folder`	ノートブックフォルダ
`notebook_version`	ノートブックのバージョン
`report`	レポート
`signed_embed`	署名付き埋め込み
`signed_embed_param`	署名付き埋め込みのサーバーサイドパラメータ
`public_link`	パブリックリンク
`table`	テーブル
`query_job`	クエリジョブ
`workflow_job`	ワークフロージョブ

Examples

`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
    }
  ]
}

`billing`（課金）

ワークスペース内に1つしか存在しないため、uid と name は常に null です

json

{
  "type": "billing",
  "uid": null,
  "name": null,
  "path": "billing",
  "parts": [
    {
      "type": "billing",
      "uid": null,
      "name": null
    }
  ]
}

`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"
    }
  ]
}

`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_media`（ノートブックメディア）

uid と name に、操作対象の識別子と表示名が入ります
uid にストレージ上のパスが入ります。table と同じく、内部的な識別子ではなく自然キーです
uid が / を含むため、path は notebook_media/media/img.png のようになります
uid は自然キーのため sensitivity: pii です。name を除いても個人情報は残ることがあります

json

{
  "type": "notebook_media",
  "uid": "media/img.png",
  "name": "img.png",
  "path": "notebook_media/media/img.png",
  "parts": [
    {
      "type": "notebook_media",
      "uid": "media/img.png",
      "name": "img.png"
    }
  ]
}

`notebook_theme`（ノートブックテーマ）

uid と name に、操作対象の識別子と表示名が入ります

json

{
  "type": "notebook_theme",
  "uid": "63e1be654aa70ad689601bf0",
  "name": "notebook_theme",
  "path": "notebook_theme/63e1be654aa70ad689601bf0",
  "parts": [
    {
      "type": "notebook_theme",
      "uid": "63e1be654aa70ad689601bf0",
      "name": "notebook_theme"
    }
  ]
}

`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"
    }
  ]
}

`signed_embed`（署名付き埋め込み）

uid と name に、操作対象の識別子と表示名が入ります
ノートブック（notebook）の下位リソースです。parts は親のノートブックから順に並びます

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
    }
  ]
}

`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"
    }
  ]
}

`tag`（タグ）

uid と name に、操作対象の識別子と表示名が入ります

json

{
  "type": "tag",
  "uid": "63e1be654aa70ad689601be8",
  "name": "finance",
  "path": "tag/63e1be654aa70ad689601be8",
  "parts": [
    {
      "type": "tag",
      "uid": "63e1be654aa70ad689601be8",
      "name": "finance"
    }
  ]
}

`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"
    }
  ]
}

`workspace_member`（ワークスペースメンバーシップ）

ワークスペース内に1つしか存在しないため、uid と name は常に null です

json

{
  "type": "workspace_member",
  "uid": null,
  "name": null,
  "path": "workspace_member",
  "parts": [
    {
      "type": "workspace_member",
      "uid": null,
      "name": null
    }
  ]
}

Resource ​

Objects ​

Resource ​

ResourcePart ​

Enums ​

ResourceType ​

Examples ​

api_key（APIキー） ​

api_key_secret（APIキーのシークレット） ​

billing（課金） ​

connection（コネクション） ​

group（グループ） ​

notebook（ノートブック） ​

notebook_folder（ノートブックフォルダ） ​

notebook_media（ノートブックメディア） ​

notebook_theme（ノートブックテーマ） ​

notebook_version（ノートブックのバージョン） ​

personal_access_token（PAT） ​

public_link（パブリックリンク） ​

query_job（クエリジョブ） ​

report（レポート） ​

signed_embed（署名付き埋め込み） ​

signed_embed_param（署名付き埋め込みのサーバーサイドパラメータ） ​

table（テーブル） ​

tag（タグ） ​

teamspace（チームスペース） ​

workflow（ワークフロー） ​

workflow_job（ワークフロージョブ） ​

workspace（ワークスペース） ​

workspace_member（ワークスペースメンバーシップ） ​

Resource

Objects

`Resource`

`ResourcePart`

Enums

`ResourceType`

Examples

`api_key`（APIキー）

`api_key_secret`（APIキーのシークレット）

`billing`（課金）

`connection`（コネクション）

`group`（グループ）

`notebook`（ノートブック）

`notebook_folder`（ノートブックフォルダ）

`notebook_media`（ノートブックメディア）

`notebook_theme`（ノートブックテーマ）

`notebook_version`（ノートブックのバージョン）

`personal_access_token`（PAT）

`public_link`（パブリックリンク）

`query_job`（クエリジョブ）

`report`（レポート）

`signed_embed`（署名付き埋め込み）

`signed_embed_param`（署名付き埋め込みのサーバーサイドパラメータ）

`table`（テーブル）

`tag`（タグ）

`teamspace`（チームスペース）

`workflow`（ワークフロー）

`workflow_job`（ワークフロージョブ）

`workspace`（ワークスペース）

`workspace_member`（ワークスペースメンバーシップ）