Method: projects.locations.notebooks.share

Membagikan notebook ke akun lain.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
name

string

Wajib. Nama resource lengkap Notebook, seperti projects/{project}/locations/{location}/notebooks/{notebookId}.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "accountAndRoles": [
    {
      object (AccountAndRole)
    }
  ],
  "notifyViaEmail": boolean
}
Kolom
accountAndRoles[]

object (AccountAndRole)

Wajib. Daftar akun dan peran yang dapat diajak berbagi notebook.

notifyViaEmail

boolean

Wajib. Apakah pengguna yang diajak berbagi akan diberi tahu melalui email.

Isi respons

Jika berhasil, isi respons akan kosong.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource name:

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

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

AccountAndRole

Informasi akun dan peran.

Representasi JSON
{
  "email": string,
  "role": enum (ProjectRole)
}
Kolom
email

string

Wajib. Alamat email yang terkait dengan akun.

role

enum (ProjectRole)

Wajib. Peran dalam notebook.

ProjectRole

Peran project.

Enum
PROJECT_ROLE_UNKNOWN Peran tidak diketahui.
PROJECT_ROLE_OWNER Pengguna memiliki project.
PROJECT_ROLE_WRITER Pengguna memiliki izin penulis di project.
PROJECT_ROLE_READER Pengguna memiliki izin pembaca di project.
PROJECT_ROLE_NOT_SHARED Pengguna tidak memiliki akses ke project.