המסמך הזה מכיל מידע ספציפי על הרשאות ואימות ב-Google Workspace Events API. לפני שאתם קוראים את המאמר הזה, חשוב לקרוא את המידע הכללי על אימות והרשאה ב-Google Workspace במאמר מידע על אימות והרשאה.
הגדרת OAuth 2.0 להרשאה
מגדירים את מסך ההסכמה של OAuth ובוחרים היקפים כדי לקבוע איזה מידע יוצג למשתמשים ולבודקי האפליקציות, ורושמים את האפליקציה כדי שתוכלו לפרסם אותה בהמשך.
היקפי ההרשאות של Google Workspace Events API
כדי להגדיר את רמת הגישה שניתנת לאפליקציה, צריך לזהות ולהצהיר על היקפי ההרשאות. היקף הרשאה הוא מחרוזת URI של OAuth 2.0 שמכילה את שם האפליקציה ב-Google Workspace, את סוג הנתונים שהיא ניגשת אליהם ואת רמת הגישה. היקפי הרשאות הם הבקשות של האפליקציה לעבוד עם נתונים של Google Workspace, כולל הנתונים בחשבון Google של המשתמשים.
כשמתקינים את האפליקציה, המשתמש מתבקש לאמת את היקפי ההרשאות שהאפליקציה משתמשת בהם. באופן כללי, מומלץ לבחור בהיקף ההרשאות המצומצם ביותר האפשרי, ולהימנע מבקשת הרשאות שהאפליקציה לא זקוקה להן. המשתמשים נוטים יותר להעניק גישה להיקפים מוגבלים שמתוארים בבירור.
Google Workspace Events API משתמש בהיקפי הרשאות מאפליקציות של Google Workspace שתומכות במינויים. אם האפליקציה כבר משתמשת בהיקפי ההרשאות שנדרשים למינוי, לא צריך להוסיף היקפי הרשאות כדי להשתמש ב-Google Workspace Events API. אם אתם מוסיפים היקפי הרשאות, בחרו את היקף ההרשאות הכי פחות רגיש שעדיין מאפשר לאפליקציה לפעול. למידע נוסף על קטגוריות של היקפים, ראו קטגוריות של היקפים.
בטבלה הבאה מפורטים ההיקפים הנתמכים של Google Workspace Events API:
| קוד היקף | תיאור | שימוש | ||
|---|---|---|---|---|
| Google Chat | ||||
https://www.googleapis.com/auth/chat.bot |
מאפשרת לאפליקציות ל-Chat לראות צ'אטים ולשלוח הודעות. נותן גישה לכל התכונות שזמינות לאפליקציות ל-Chat. | לא רגיש | ||
https://www.googleapis.com/auth/chat.memberships |
לראות, להוסיף ולהסיר משתתפים בשיחות ב-Chat. | רגיש |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
לראות את המשתתפים בשיחות ב-Chat. | רגיש |
||
https://www.googleapis.com/auth/chat.app.memberships |
לראות, להוסיף, לעדכן ולהסיר חברים בשיחות ובמרחבים ב-Chat בתור אפליקציה ל-Chat. נדרש אישור אדמין. ההיקף הזה תומך רק באימות אפליקציה עם חשבונות שירות. אי אפשר לאמת באמצעות פרטי כניסה של משתמשים או באמצעות הענקת גישה ברמת הדומיין באמצעות ההיקף הזה. |
רגיש |
||
https://www.googleapis.com/auth/chat.app.memberships.readonly |
לראות את המשתתפים בשיחות ובמרחבים ב-Google Chat כאפליקציה ל-Chat. נדרש אישור אדמין. ההיקף הזה תומך רק באימות אפליקציה עם חשבונות שירות. אי אפשר לאמת באמצעות פרטי כניסה של משתמשים או באמצעות הענקת גישה ברמת הדומיין באמצעות ההיקף הזה. |
רגיש |
||
https://www.googleapis.com/auth/chat.spaces |
ליצור שיחות ומרחבים משותפים, ולראות או לעדכן מטא-נתונים (כולל הגדרות ההיסטוריה) ב-Chat. | רגיש | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
לראות את הצ'אט ואת המרחבים המשותפים ב-Chat. | רגיש |
||
https://www.googleapis.com/auth/chat.app.spaces |
יצירת שיחות ומרחבים משותפים, והצגה או עדכון של מטא-נתונים (כולל הגדרות ההיסטוריה) ב-Chat כאפליקציה ל-Chat. נדרש אישור אדמין. ההיקף הזה תומך רק באימות אפליקציה עם חשבונות שירות. אי אפשר לאמת באמצעות פרטי כניסה של משתמשים או באמצעות הענקת גישה ברמת הדומיין באמצעות ההיקף הזה. |
רגיש |
||
https://www.googleapis.com/auth/chat.app.spaces.readonly |
לראות מטא-נתונים (כולל הגדרות ההיסטוריה) ב-Google Chat כאפליקציה ל-Chat. נדרש אישור אדמין. ההיקף הזה תומך רק באימות אפליקציה עם חשבונות שירות. אי אפשר לאמת באמצעות פרטי כניסה של משתמשים או באמצעות הענקת גישה ברמת הדומיין באמצעות ההיקף הזה. |
רגיש |
||
https://www.googleapis.com/auth/chat.messages.reactions |
לראות, להוסיף ולמחוק תגובות להודעות ב-Chat. | רגיש |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
לראות את התגובות להודעה ב-Chat. | רגיש |
||
https://www.googleapis.com/auth/chat.messages |
גישה להודעות, כתיבה, שליחה, ועדכון ומחיקה שלהן, וגם גישה לתגובות להודעות והוספה ומחיקה שלהן. | הצפייה מוגבלת | ||
https://www.googleapis.com/auth/chat.messages.readonly |
לראות את ההודעות והתגובות ב-Chat. | מוגבלת |
||
https://www.googleapis.com/auth/chat.app.messages.readonly |
לראות את ההודעות והתגובות ב-Chat בתור אפליקציה ל-Chat. נדרש אישור אדמין. ההיקף הזה תומך רק באימות אפליקציה עם חשבונות שירות. אי אפשר לאמת באמצעות פרטי כניסה של משתמשים או באמצעות הענקת גישה ברמת הדומיין באמצעות ההיקף הזה. |
מוגבלת |
||
https://www.googleapis.com/auth/chat.users.readstate |
לראות ולעדכן את סטטוס הקריאה של המשתמשים ב-Chat. | רגיש |
||
https://www.googleapis.com/auth/chat.users.readstate.readonly |
לראות את סטטוס הקריאה של המשתמשים ב-Chat. | רגיש |
||
https://www.googleapis.com/auth/chat.users.availability |
לראות ולשנות את סטטוס הזמינות ב-Chat. | רגיש |
||
https://www.googleapis.com/auth/chat.users.availability.readonly |
לראות את סטטוס הזמינות ב-Chat. | רגיש |
||
https://www.googleapis.com/auth/chat.app.all.spaces.readonly |
לראות את המטא-נתונים של כל המרחבים והשיחות ב-Google Chat בארגון שלך ב-Google Workspace, גם אם אפליקציית Chat לא מצורפת אליהם. ההיקף הזה נתמך רק במינויים של לקוחות. נדרש אישור אדמין. ההיקף הזה תומך רק באימות אפליקציה עם חשבונות שירות. אי אפשר לאמת באמצעות פרטי כניסה של משתמשים או באמצעות הענקת גישה ברמת הדומיין באמצעות ההיקף הזה. |
הצפייה מוגבלת | ||
https://www.googleapis.com/auth/chat.app.all.memberships.readonly |
לראות את כל המשתתפים במרחבים ובשיחות ב-Google Chat בארגון שלך ב-Google Workspace, גם אם אפליקציית Chat לא מצורפת אליהם. ההיקף הזה נתמך רק במינויים של לקוחות. נדרש אישור אדמין. ההיקף הזה תומך רק באימות אפליקציה עם חשבונות שירות. אי אפשר לאמת באמצעות פרטי כניסה של משתמשים או באמצעות הענקת גישה ברמת הדומיין באמצעות ההיקף הזה. |
הצפייה מוגבלת | ||
https://www.googleapis.com/auth/chat.app.all.messages.readonly |
לראות את כל ההודעות והתגובות באמוג'י בארגון שלכם ב-Google Workspace, גם אם האפליקציה ל-Chat לא מצורפת למרחב או לשיחה. ההיקף הזה נתמך רק במינויים של לקוחות. נדרש אישור אדמין. ההיקף הזה תומך רק באימות אפליקציה עם חשבונות שירות. אי אפשר לאמת באמצעות פרטי כניסה של משתמשים או באמצעות הענקת גישה ברמת הדומיין באמצעות ההיקף הזה. |
הצפייה מוגבלת | ||
https://www.googleapis.com/auth/chat.app.all.users.readstate.readonly |
לראות את זמן הקריאה האחרון של כל המשתמשים בכל המרחבים והשיחות בארגון שלך ב-Google Workspace, גם אם האפליקציה ל-Chat לא מצורפת אליהם. ההיקף הזה נתמך רק במינויים של לקוחות. נדרש אישור אדמין. ההיקף הזה תומך רק באימות אפליקציה עם חשבונות שירות. אי אפשר לאמת באמצעות פרטי כניסה של משתמשים או באמצעות הענקת גישה ברמת הדומיין באמצעות ההיקף הזה. |
הצפייה מוגבלת | ||
| Google Drive | ||||
https://www.googleapis.com/auth/drive.file |
ליצור קבצים חדשים ב-Drive או לשנות קבצים קיימים שפתחתם באמצעות אפליקציה, או שהמשתמש שיתף עם אפליקציה בזמן השימוש ב-Google Picker API או בכלי לבחירת קבצים של האפליקציה. | לא רגיש | ||
https://www.googleapis.com/auth/drive |
לראות ולנהל את כל הקבצים ב-Drive. | הצפייה מוגבלת | ||
https://www.googleapis.com/auth/drive.readonly |
לראות ולהוריד את כל הקבצים שלכם ב-Drive. | הצפייה מוגבלת | ||
https://www.googleapis.com/auth/drive.metadata |
הצגה וניהול של מטא נתונים של קבצים ב-Drive. | הצפייה מוגבלת | ||
https://www.googleapis.com/auth/drive.metadata.readonly |
לראות מטא-נתונים של קבצים ב-Drive. | הצפייה מוגבלת | ||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
האפליקציות יכולות ליצור, לשנות ולקרוא מטא-נתונים על מרחבי פגישות שנוצרו על ידי האפליקציה. | רגיש |
||
https://www.googleapis.com/auth/meetings.space.readonly |
האפליקציות יכולות לקרוא מטא-נתונים של כל מרחב פגישה שלמשתמש יש גישה אליו. | רגיש |
||
העמודה "שימוש" בטבלה שלמעלה מציינת את הרגישות של כל היקף הרשאות:
לא רגישים: היקפי ההרשאות האלה מספקים את היקף הגישה הקטן ביותר ודורשים רק אימות אפליקציות בסיסי. למידע נוסף על הדרישה הזו, קראו את המאמר דרישות אימות.
רגיש: ההיקפים האלה מספקים גישה לנתוני משתמשים ספציפיים ב-Google, שהמשתמש אישר לאפליקציה שלכם. כדי להשתמש בהם, צריך לעבור תהליך אימות נוסף של האפליקציה. למידע נוסף על הדרישה הזו, קראו את המאמר דרישות לגבי היקפים רגישים ומוגבלים.
מוגבלים: ההיקפים האלה מספקים גישה רחבה לנתוני המשתמשים ב-Google, וצריך לעבור תהליך אימות של היקפים מוגבלים. מידע נוסף על הדרישה הזו זמין במאמרים שירותי Google API: מדיניות בנושא נתוני משתמשים ודרישות נוספות להיקפי הרשאות ספציפיים של API. אם אתם שומרים (או מעבירים) נתונים בהיקף מוגבל בשרתים, אתם צריכים לעבור הערכת אבטחה.
אם האפליקציה שלכם דורשת גישה לממשקי Google API אחרים, אתם יכולים להוסיף גם את היקפי ההרשאות האלה. מידע נוסף על היקפי ההרשאות של Google API זמין במאמר שימוש ב-OAuth 2.0 כדי לגשת אל Google APIs.
למידע נוסף על היקפי הרשאות ספציפיים של OAuth 2.0, קראו את המאמר היקפי הרשאות של OAuth 2.0 ל-Google APIs.
אימות OAuth
כדי להשתמש בהיקפי הרשאות מסוימים של OAuth, יכול להיות שתצטרכו לעבור את תהליך אימות האפליקציות ב-OAuth. כדי לדעת מתי האפליקציה צריכה לעבור אימות ואיזה סוג של אימות נדרש, קראו את השאלות הנפוצות בנושא אפליקציות OAuth. מידע נוסף זמין בתנאים ובהגבלות של Drive.
סוגי האימות הנדרשים
בקטע הזה מוסבר אילו סוגי אימות נדרשים או נתמכים, ומפורטים היקפי ההרשאות הנתמכים לכל שיטה של Google Workspace Events API.
במינויים לאירועים ב-Chat, אפשר להשתמש ב-Google Workspace Events API כדי להפעיל חלק מהשיטות באמצעות אימות של משתמשים או של אפליקציות. אם שיטת API תומכת בשני סוגי פרטי הכניסה, סוג פרטי הכניסה שבהם משתמשים בקריאה משפיע על התוצאה שמוחזרת. לדוגמה, אם קוראים ל-method subscriptions.list עם אימות משתמש, ה-API מחזיר רשימה של מינויים שהמשתמש המאומת יכול לגשת אליהם. אם משתמשים באימות של אפליקציה, ה-API מחזיר רשימה של מינויים שלאפליקציה יש גישה אליהם. למידע נוסף על סוגי האימות ב-Chat, קראו את המאמר אימות והרשאה של אפליקציות צ'אט ובקשות מ-Google Chat API.
בטבלה הבאה מוצגים היקפי ההרשאות וסוגי האימות שנדרשים או נתמכים בכל שיטה של Google Workspace Events API:
| שיטה | נדרש או נתמך אימות משתמשים | תמיכה באימות אפליקציות (אפליקציות ל-Chat בלבד) | היקפי הרשאות נתמכים | |
|---|---|---|---|---|
| יצירת מינוי | — |
עם אימות משתמש, נדרש היקף נתמך לכל סוג אירוע:
עם אימות אפליקציה ואישור אדמין (אפליקציות ל-Google Chat בלבד), נדרש היקף הרשאות נתמך לכל סוג אירוע:
|
||
| איך נרשמים למינוי |
כשמשתמשים באימות משתמש, השיטה הזו דורשת היקף הרשאות שתומך בסוג אירוע אחד לפחות במינוי.
עם אימות של האפליקציה (אפליקציות ל-Chat בלבד):
|
|||
| הצגת רשימה של מינויים |
כשמשתמשים באימות משתמש, השיטה הזו דורשת היקף הרשאות שתומך בסוג אירוע אחד לפחות במינוי.
עם אימות של האפליקציה (אפליקציות ל-Chat בלבד):
|
|||
| עדכון מינוי | — |
עם אימות משתמש, נדרש היקף נתמך לכל סוג אירוע:
עם אימות אפליקציה ואישור אדמין (אפליקציות ל-Google Chat בלבד), נדרש היקף נתמך לכל סוג אירוע:
|
||
| הפעלה מחדש של מינוי | — |
עם אימות משתמש, נדרש היקף נתמך לכל סוג אירוע:
אימות של האפליקציה ואישור של האדמין (רק באפליקציות ל-Chat), צריך היקף הרשאות נתמך לכל סוג אירוע:
|
||
| מחיקת מינוי |
כשמשתמשים באימות משתמש, השיטה הזו דורשת היקף הרשאות שתומך בסוג אירוע אחד לפחות במינוי.
עם אימות של האפליקציה (אפליקציות ל-Chat בלבד):
|
|||
היקפים לפי סוג אירוע
כשאתם קוראים ל-Google Workspace Events API באמצעות אימות משתמש, אתם צריכים לציין היקף הרשאות אחד או יותר שתואם לסוגי האירועים של המינוי.
בטבלה הבאה מפורטים היקפי ההרשאות שנתמכים בכל סוג אירוע:
| אירועים | סוגי אירועים | היקפי הרשאות נתמכים | ||||||
|---|---|---|---|---|---|---|---|---|
| צ'אט | ||||||||
| הודעה פורסמה או עודכנה. |
|
עם אימות משתמש:
|
||||||
| תגובה באמוג'י נוספה או נמחקה, או שבוצעו שינויים בכמה תגובות באמוג'י. |
|
עם אימות משתמש:
|
||||||
| חברות נוצרת, מתעדכנת או מוסרת, או כשמספר חברויות משתנות. |
|
עם אימות משתמש:
|
||||||
| מרחב משותף עודכן או נמחק. |
|
עם אימות משתמש:
|
||||||
| סטטוס הקריאה של המשתמש במרחב המשותף או בשרשור עודכן. |
|
עם אימות משתמש:
|
||||||
| הזמינות מתעדכנת. |
|
עם אימות משתמש:
|
||||||
| Drive | ||||||||
| קובץ נוצר, השתנה, הועבר, נמחק, השם שלו שונה, הוא הועבר לאשפה או הוסר מהאשפה. |
|
|
||||||
| נוצרה או טופלה הצעה לגישה לקובץ. |
|
|
||||||
| אישור בוטל, הושלם, נוצר, אופס, הגורמים המאשרים השתנו או הגורמים המאשרים הגיבו על קובץ. |
|
|
||||||
| תגובה נוצרה, נמחקה, נערכה, נפתחה מחדש או טופלה בקובץ. |
|
|
||||||
| תגובה נוצרה, נמחקה או נערכה בקובץ. |
|
|
||||||
| הרשאה נוצרת, נמחקת או נערכת בקובץ. |
|
|
||||||
| Meet | ||||||||
| שיחת ועידה מתחילה או מסתיימת. |
|
|
||||||
| משתתף מצטרף לשיחת ועידה או עוזב אותה. |
|
|
||||||
| נוצרה הקלטה. |
|
|
||||||
| נוצר תמליל. |
|
|
||||||