Method: projects.locations.notebooks.share

将笔记本分享给其他账号。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
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 用户无权访问相应项目。