במסמך הזה מפורט מידע על הרשאה ואימות שספציפיים ל-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 |
מאפשר לאפליקציות של Google Chat לצפות בצ'אטים ולשלוח הודעות. ההרשאה מעניקה גישה לכל התכונות שזמינות לאפליקציות של Chat. | לא רגיש | ||
https://www.googleapis.com/auth/chat.memberships |
הצגה, הוספה והסרה של משתתפים בשיחות ב-Google Chat. | רגיש |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
הצגת המשתתפים בשיחות ב-Google Chat. | רגיש |
||
https://www.googleapis.com/auth/chat.app.memberships |
קריאה, הוספה, עדכון והסרה של חברים בשיחות ובמרחבים ב-Google Chat כאפליקציית Chat. נדרש אישור של אדמין. היקף ההרשאות הזה תומך רק באימות אפליקציות באמצעות חשבונות שירות. אי אפשר לבצע אימות באמצעות פרטי כניסה של משתמשים או באמצעות מתן הרשאות גישה ברמת הדומיין באמצעות ההיקף הזה. |
רגיש |
||
https://www.googleapis.com/auth/chat.spaces |
יצירת שיחות ומרחבים משותפים, והצגה או עדכון של מטא-נתונים (כולל הגדרות ההיסטוריה) ב-Google Chat. | רגיש | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
הצגת הצ'אט והמרחבים ב-Google Chat. | רגיש |
||
https://www.googleapis.com/auth/chat.app.spaces |
יצירת שיחות ומרחבים משותפים, והצגה או עדכון של מטא-נתונים (כולל הגדרות ההיסטוריה) ב-Google Chat כאפליקציית Chat. נדרש אישור אדמין. היקף ההרשאות הזה תומך רק באימות אפליקציות באמצעות חשבונות שירות. אי אפשר לבצע אימות באמצעות פרטי כניסה של משתמשים או באמצעות מתן הרשאות גישה ברמת הדומיין באמצעות ההיקף הזה. |
רגיש |
||
https://www.googleapis.com/auth/chat.messages.reaction שניות |
ראיית תגובות להודעות ב-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 |
גישה להודעות ולתגובות ב-Google Chat | הגישה מוגבלת |
||
https://www.googleapis.com/auth/chat.app.messages.readonly |
הצגת ההודעות והתגובות ב-Google Chat כאפליקציית 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. מידע נוסף זמין בתנאים ובהגבלות של Google Drive.
סוגי האימות הנדרשים
בקטע הזה מוסבר אילו סוגי אימות נדרשים או נתמכים, ומוצגים ההיקפים הנתמכים לכל שיטה של Google Workspace Events API.
במינויים לאירועים ב-Google Chat, Google Workspace Events API תומך באימות של משתמשים ושל אפליקציות כדי להפעיל חלק מהשיטות שלו. אם שיטת API תומכת בשני סוגי פרטי הכניסה, סוג פרטי הכניסה שמשמשים בקריאה משפיע על התוצאה שמוחזרת. לדוגמה, אם קוראים ל-method subscriptions.list עם אימות משתמש, ה-API מחזיר רשימה של מינויים שלהמשתמש המאומת שאליהם יש לו גישה. אם משתמשים באימות אפליקציות, ה-API מחזיר רשימה של מינויים שהאפליקציה יכולה לגשת אליהם. מידע נוסף על סוגי האימות ב-Chat זמין במאמר אימות והרשאה של אפליקציות ל-Chat ובקשות מ-Google Chat API.
בטבלה הבאה מפורטים ההיקפים וסוגי האימות שנדרשים או נתמכים לכל method של Google Workspace Events API:
| שיטה | נדרש או נתמך אימות משתמשים | יש תמיכה באימות אפליקציות (אפליקציות Google Chat בלבד) | היקפי ההרשאות הנתמכים | |
|---|---|---|---|---|
| יצירת מינוי | — |
באימות משתמש, נדרש היקף נתמך לכל סוג אירוע:
גרסת Developer Preview: עם אימות אפליקציות ואישור אדמין (רק באפליקציות ל-Google Chat), נדרש היקף נתמך לכל סוג אירוע:
|
||
| איך נרשמים למינוי |
בשיטה הזו, כשמשתמש מאומת, צריך להגדיר היקף שתומך בסוג אירוע אחד לפחות עבור המינוי.
עם אימות אפליקציות (רק באפליקציות ל-Google Chat):
|
|||
| הצגת רשימה של מינויים |
בשיטה הזו, שכוללת אימות משתמשים, צריך להגדיר היקף שתומך בסוג אירוע אחד לפחות עבור המינוי.
עם אימות אפליקציות (רק באפליקציות ל-Google Chat):
|
|||
| עדכון מינוי | — |
באימות משתמש, נדרש היקף נתמך לכל סוג אירוע:
גרסת Developer Preview: עם אימות אפליקציות ואישור אדמין (רק באפליקציות ל-Google Chat), נדרש היקף נתמך לכל סוג אירוע:
|
||
| הפעלה מחדש של מינוי | — |
באימות משתמש, נדרש היקף נתמך לכל סוג אירוע:
גרסת Developer Preview: עם אימות אפליקציות ואישור אדמין (רק באפליקציות של Google Chat), נדרש היקף נתמך לכל סוג אירוע:
|
||
| מחיקת מינוי |
בשיטה הזו, שכוללת אימות משתמשים, צריך להגדיר היקף שתומך בסוג אירוע אחד לפחות עבור המינוי.
עם אימות אפליקציות (רק באפליקציות ל-Google Chat):
|
|||
היקפים לפי סוג אירוע
כשמתקשרים אל Google Workspace Events API באמצעות אימות משתמש, צריך לציין היקף אחד או יותר שמתאים לסוגי האירועים של המינוי.
בטבלה הבאה מוצגים היקפי ההרשאות שנתמכים לכל סוג אירוע:
| אירועים | סוגי אירועים | היקפי ההרשאות הנתמכים | ||||||
|---|---|---|---|---|---|---|---|---|
| Google Chat | ||||||||
| הודעה מתפרסמת או מתעדכנת. |
|
עם אימות משתמשים:
|
||||||
| נוספה או נמחקה תגובה באמוג'י, או שבוצעו שינויים בכמה תגובות. |
|
|
||||||
| חברות נוצרת, מעודכנת או מוסרת, או שמשתנות כמה חברויות. |
|
עם אימות משתמשים:
|
||||||
| מרחב עודכן או נמחק. |
|
עם אימות משתמשים:
|
||||||
| Google Drive | ||||||||
| קובץ נוצר, שונה, הועבר, נמחק, הועבר לאשפה או הוסר מהאשפה. |
|
|
||||||
| הצעת גישה נוצרת או נפתרת בקובץ. |
|
|
||||||
| Google Meet | ||||||||
| ועידה מתחילה או מסתיימת. |
|
|
||||||
| משתתף מצטרף לוועידה או עוזב אותה. |
|
|
||||||
| נוצרה הקלטה. |
|
|
||||||
| נוצר תמליל. |
|
|
||||||