Method: projects.locations.notebooks.share

ノートブックを他のアカウントと共有します。

HTTP リクエスト

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/notebooks/*}:share

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。Notebook の完全なリソース名（projects/{project}/locations/{location}/notebooks/{notebookId} など）。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "accountAndRoles": [
    {
      object (AccountAndRole)
    }
  ],
  "notifyViaEmail": boolean
}
フィールド
accountAndRoles[]

object (AccountAndRole)

必須。ノートブックを共有するアカウントとロールのリスト。
notifyViaEmail

boolean

必須。共有ユーザーにメールで通知するかどうか。

レスポンスの本文

成功すると、レスポンスの本文は空になります。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • discoveryengine.notebooks.getIamPolicy
  • discoveryengine.notebooks.setIamPolicy

詳細については、IAM のドキュメントをご覧ください。

AccountAndRole

アカウントとロールの情報。

JSON 表現 
{
  "email": string,
  "role": enum (ProjectRole)
}
フィールド
email

string

必須。アカウントに関連付けられたメールアドレス。
role

enum (ProjectRole)

必須。ノートブック内のロール。

ProjectRole

プロジェクトのロール。

列挙型
PROJECT_ROLE_UNKNOWN 不明なロール。
PROJECT_ROLE_OWNER ユーザーがプロジェクトを所有しています。
PROJECT_ROLE_WRITER ユーザーがプロジェクトに対する書き込み権限を持っています。
PROJECT_ROLE_READER ユーザーがプロジェクトに対する閲覧者権限を持っています。
PROJECT_ROLE_NOT_SHARED ユーザーにプロジェクトへのアクセス権がありません。