המסמך הזה מכיל מידע ספציפי לגבי הרשאה ואימות של 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.spaces |
יצירת שיחות ומרחבים משותפים, והצגה או עדכון של מטא-נתונים (כולל הגדרות ההיסטוריה) ב-Google Chat. | רגישות | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
הצגת הצ'אט והמרחבים המשותפים ב-Google 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. | מוגבל |
||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
מתן הרשאה לאפליקציות ליצור, לשנות ולקרוא מטא-נתונים על מרחבי שיתוף שנוצרו על ידי האפליקציה. | רגיש |
||
https://www.googleapis.com/auth/meetings.space.readonly |
מתן הרשאה לאפליקציות לקרוא מטא-נתונים על כל מרחב שיתוף פעולה שיש למשתמש גישה אליו. | רגיש |
||
בעמודה Usage בטבלה שלמעלה מצוין רמת הרגישות של כל היקף, בהתאם להגדרות הבאות:
לא רגיש – היקפי הגישה האלה מספקים את היקף הרשאת הגישה הקטן ביותר, והם דורשים רק אימות בסיסי של האפליקציה. מידע נוסף על הדרישה הזו זמין במאמר שלבים להכנה לאימות.
רגיש – היקפים אלה מספקים גישה לנתוני משתמשים ספציפיים ב-Google שהמשתמש העניק לאפליקציה הרשאה לגשת אליהם. כדי לקבל הרשאות כאלה, צריך לעבור אימות נוסף של האפליקציה. מידע נוסף על הדרישה הזו זמין במאמר שלבים לאפליקציות שמבקשות הרשאות גישה למידע אישי רגיש
מוגבלת – היקפי הגישה האלה מספקים גישה רחבה לנתוני המשתמשים ב-Google, וצריך לעבור תהליך אימות של היקף גישה מוגבל. למידע נוסף על הדרישה הזו, אפשר לעיין במאמרים Google API Services: User Data Policy וAdditional Requirements for Specific API Scopes. אם אתם מאחסנים נתונים בהיקף מוגבל בשרתים (או מעבירים אותם), עליכם לעבור הערכת אבטחה.
אם האפליקציה שלכם זקוקה לגישה לממשקי Google API אחרים, תוכלו להוסיף גם את ההיקפים האלה. למידע נוסף על היקפי ההרשאות של Google API, תוכלו לקרוא את המאמר שימוש ב-OAuth 2.0 כדי לגשת ל-Google APIs.
מידע נוסף על היקפי OAuth 2.0 ספציפיים זמין במאמר היקפי OAuth 2.0 ל-Google APIs.
אימות OAuth
כדי להשתמש בהיקפי OAuth מסוימים, יכול להיות שהאפליקציה תצטרך לעבור את תהליך האימות של Google ל-OAuth. כדאי לקרוא את השאלות הנפוצות בנושא אימות OAuth API כדי לקבוע מתי האפליקציה צריכה לעבור אימות ואיזה סוג אימות נדרש. אפשר לעיין גם בתנאים והגבלות נוספים של Google Drive.
סוגי האימות הנדרשים
בקטע הזה מוסבר אילו סוגי אימות נדרשים או נתמכים, ומפורטים ההיקפים הנתמכים לכל method של Google Workspace Events API.
כדי להירשם לאירועים ב-Google Chat, Google Workspace Events API תומך באימות של משתמשים ושל אפליקציות כדי לקרוא לחלק מהשיטות שלו. אם שיטת API תומכת בשני סוגי פרטי הכניסה, סוג פרטי הכניסה שבהם נעשה שימוש בקריאה משפיע על התוצאה שמוחזרת. לדוגמה, אם קוראים ל-method subscriptions.list() עם אימות משתמש, ה-API מחזיר רשימה של מינויים שהמשתמש המאומת יכול לגשת אליהם. אם משתמשים באימות של האפליקציה, ה-API מחזיר רשימה של מינויים שהאפליקציה יכולה לגשת אליהם. למידע נוסף על סוגי האימות ב-Chat, ראו אימות והרשאה של אפליקציות Chat ובקשות ל-Google Chat API.
בטבלה הבאה מפורטים ההיקפים והסוגים של האימות הנדרשים או הנתמכים לכל שיטה של Google Workspace Events API:
| שיטה | אימות משתמשים נדרש או נתמך | תמיכה באימות באפליקציות (אפליקציות Google Chat בלבד) | היקפי ההרשאות הנתמכים | |
|---|---|---|---|---|
| יצירת מינוי | — |
נדרשת היקף נתמך לכל סוג אירוע:
|
||
| רכישת מינוי |
כשמשתמשים באימות משתמשים, השיטה הזו דורשת היקף שמאפשר לפחות סוג אירוע אחד במינוי.
באימות באפליקציה (אפליקציות של Google Chat בלבד):
|
|||
| הצגת רשימה של מינויים |
כשמשתמשים באימות משתמשים, השיטה הזו דורשת היקף שמאפשר לפחות סוג אירוע אחד במינוי.
באמצעות אימות באפליקציה (אפליקציות של Google Chat בלבד):
|
|||
| עדכון מינוי | — |
נדרשת היקף נתמך לכל סוג אירוע:
|
||
| הפעלה מחדש של מינוי | — |
נדרשת היקף נתמך לכל סוג אירוע:
|
||
| מחיקת מינוי |
כשמשתמשים באימות משתמשים, השיטה הזו דורשת היקף שמאפשר לפחות סוג אירוע אחד במינוי.
באמצעות אימות באפליקציה (אפליקציות של Google Chat בלבד):
|
|||
היקפי הרשאות לפי סוג אירוע
כשאתם קוראים ל-Google Workspace Events API באמצעות אימות משתמש, עליכם לציין היקף אחד או יותר שתואם לסוגים של האירועים במינוי.
בטבלה הבאה מפורטים היקפי ההרשאה שנתמכים לכל סוג אירוע:
| אירועים | סוגי אירועים | היקפי ההרשאות הנתמכים | ||||||
|---|---|---|---|---|---|---|---|---|
| Google Chat | ||||||||
| הודעה פורסמת או מתעדכנת. |
|
|
||||||
| נוספה או נמחקה תגובה, או שהשתנו כמה תגובות. |
|
|
||||||
| נוצר, מתעדכן או מוסר מועדון חברים, או שמתבצע שינוי במספר מועדוני חברים. |
|
|
||||||
| מרחב משותף מתעדכן או נמחק. |
|
|
||||||
| Google Meet | ||||||||
| ועידה מתחילה או מסתיימת. |
|
|
||||||
| משתתף מצטרף או יוצא משיחה קבוצתית. |
|
|
||||||
| נוצרה הקלטה. |
|
|
||||||
| נוצר תמליל. |
|
|
||||||