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)

חובה. רשימת החשבונות והתפקידים שאיתם רוצים לשתף את ה-notebook.
notifyViaEmail

boolean

חובה. האם לשלוח הודעה באימייל למשתמשים ששותפו איתם את הקובץ.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יהיה ריק.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשות הרשאות IAM הבאות במשאב name:

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

מידע נוסף מופיע במאמרי העזרה בנושא IAM.

AccountAndRole

פרטי החשבון והתפקיד.

ייצוג ב-JSON 
{
  "email": string,
  "role": enum (ProjectRole)
}
שדות
email

string

חובה. כתובת האימייל שמשויכת לחשבון.
role

enum (ProjectRole)

חובה. התפקיד ב-Notebook.

ProjectRole

התפקיד בפרויקט.

טיפוסים בני מנייה (enum)
PROJECT_ROLE_UNKNOWN תפקיד לא ידוע.
PROJECT_ROLE_OWNER המשתמש הוא הבעלים של הפרויקט.
PROJECT_ROLE_WRITER למשתמש יש הרשאות כתיבה בפרויקט.
PROJECT_ROLE_READER למשתמש יש הרשאות קריאה בפרויקט.
PROJECT_ROLE_NOT_SHARED למשתמש אין גישה לפרויקט.