המסמך הזה מכיל מידע על הרשאות ואימות ספציפיות ל-Google Workspace Event API. לפני שקוראים את המסמך הזה, חשוב לקרוא את המידע הכללי בנושא אימות והרשאות ב-Google Workspace, במאמר מידע על אימות והרשאה.
הגדרת OAuth 2.0 להרשאה
מגדירים את מסך ההסכמה של OAuth ובוחרים היקפים כדי להגדיר איזה מידע יוצג למשתמשים ולבודקי האפליקציות, ולרשום את האפליקציה כדי שתוכלו לפרסם אותה מאוחר יותר.
היקפי ההרשאות של Google Workspace Event API
כדי להגדיר את רמת הגישה שהוענקה לאפליקציה, צריך לזהות היקפי הרשאות ולהצהיר עליהם. היקף הרשאה הוא מחרוזת URI של OAuth 2.0 שכוללת את שם האפליקציה ב-Google Workspace, סוגי הנתונים שאליהם היא ניגשת ורמת הגישה. היקפים הם הבקשות של האפליקציה לעבוד עם נתוני Google Workspace, כולל נתוני חשבונות Google של משתמשים.
כשהאפליקציה מותקנת, המשתמשים מתבקשים לאמת את היקפי ההרשאות שהאפליקציה משתמשת בהם. באופן כללי, כדאי לבחור את ההיקף הצר ביותר שאפשר, ולהימנע מבקשות להיקפים שלא צריכים את האפליקציה. המשתמשים מעניקים גישה להיקפי הרשאות מוגבלים שמתוארים בצורה ברורה יותר.
כשאפשר, מומלץ להשתמש בהיקפים לא רגישים, כי הם מעניקים היקף גישה לכל קובץ ומצמצמים את הגישה לפונקציונליות ספציפית שנדרשת לאפליקציה.
ב-Google Workspace Event API נעשה שימוש בהיקפים מתוך אפליקציות Google Workspace שתומכות במינויים. אם האפליקציה שלכם כבר משתמשת בהיקפים הנדרשים למינוי, לא צריך להוסיף עוד היקפים כדי להשתמש ב-Google Workspace Event API.
בטבלה הבאה מפורטים היקפי ההרשאות הנתמכים ב-Google Workspace Event API:
| קוד ההיקף | תיאור | Usage | ||
|---|---|---|---|---|
| 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 |
גישה להודעות, כתיבה, שליחה, ועדכון ומחיקה שלהן, וגם גישה לתגובות להודעות והוספה ומחיקה שלהן. | מוצר שהצפייה בו הוגבלה | ||
https://www.googleapis.com/auth/chat.messages.readonly |
לראות את ההודעות והתגובות ב-Google Chat. | מוגבל |
||
https://www.googleapis.com/auth/chat.messages.reaction ש' |
ראיית תגובות להודעות ב-Chat, הוספה ומחיקה שלהן. | מוגבל |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
הצגת התגובות להודעות ב-Chat. | מוגבל |
||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
ההגדרה הזו מאפשרת לאפליקציות ליצור, לשנות ולקרוא מטא-נתונים על מרחבים משותפים בפגישות שנוצרו על ידי האפליקציה. | רגיש |
||
https://www.googleapis.com/auth/meetings.space.readonly |
מתן הרשאה לאפליקציות לקרוא מטא-נתונים על כל מרחב משותף ב-Meet שאליו יש למשתמש גישה. | רגיש |
||
בעמודה Usage שבטבלה הקודמת מצוינת הרגישות של כל היקף, בהתאם להגדרות הבאות:
לא רגיש – היקפי ההרשאות האלה מספקים את ההיקף הקטן ביותר של הגישה להרשאות ודורשים רק אימות בסיסי של האפליקציה. מידע נוסף על הדרישה הזו זמין במאמר שלבים להכנה לאימות.
רגיש – היקפי ההרשאות האלה נותנים גישה לנתוני משתמש ספציפיים ב-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 API כדי להבין מתי צריך לעבור אימות של האפליקציה ואיזה סוג אימות נדרש. ראו גם תנאים והגבלות נוספים של Google Drive.
סוגי האימות הנדרש
בקטע הזה מוסבר אילו סוגי אימות נדרשים או נתמכים, ומפורטים היקפי ההרשאות הנתמכים לכל שיטה ב-Google Workspace Event API.
במינויים לאירועים ב-Google Chat, Google Workspace Event API תומך גם באימות משתמשים וגם באימות אפליקציות כדי להפעיל חלק מהשיטות שלו. אם שיטת API תומכת בשני פרטי הכניסה, סוג פרטי הכניסה שבהם נעשה שימוש בקריאה משפיע על התוצאה שתוחזר. לדוגמה, אם מפעילים קריאה ל-method subscriptions.list() עם אימות משתמשים, ה-API מחזיר רשימה של מינויים שיש למשתמש המאומת גישה אליהם. אם משתמשים באימות אפליקציות, ה-API מחזיר רשימה של מינויים שיש לאפליקציה גישה אליהם. למידע נוסף על סוגי האימות ב-Chat, תוכלו לקרוא את המאמר אימות ואישור של אפליקציות צ'אט ושל בקשות ל-Google Chat API.
בטבלה הבאה מפורטים ההיקפים וסוגי האימות הנדרשים בכל שיטה של Google Workspace Event API:
| שיטה | נדרש או נתמך אימות משתמש | תמיכה באימות אפליקציות (באפליקציות של Google Chat בלבד) | היקפי הרשאות נתמכים | |
|---|---|---|---|---|
| יצירת מינוי | — |
נדרש היקף נתמך לכל סוג אירוע:
|
||
| הרשמה למינוי |
לצורך אימות משתמשים, לשיטה הזו נדרש היקף שתומך לפחות בסוג אירוע אחד במינוי.
עם אימות אפליקציות (רק באפליקציות Google Chat):
|
|||
| רשימת המינויים |
לצורך אימות משתמשים, לשיטה הזו נדרש היקף שתומך לפחות בסוג אירוע אחד במינוי.
עם אימות אפליקציות (רק באפליקציות Google Chat):
|
|||
| עדכון מינוי | — |
נדרש היקף נתמך לכל סוג אירוע:
|
||
| הפעלה מחדש של מינוי | — |
נדרש היקף נתמך לכל סוג אירוע:
|
||
| מחיקת מינוי |
לצורך אימות משתמשים, לשיטה הזו נדרש היקף שתומך לפחות בסוג אירוע אחד במינוי.
עם אימות אפליקציות (רק באפליקציות Google Chat):
|
|||
היקפים לפי סוג האירוע
כשמבצעים קריאה ל-Google Workspace Event API באמצעות אימות משתמשים, צריך לציין היקף אחד או יותר שתואמים לסוגי האירועים של המינוי.
בטבלה הבאה מוצגים היקפי ההרשאות הנתמכים בכל סוג אירוע:
| אירועים | סוגי אירועים | היקפי הרשאות נתמכים | ||||||
|---|---|---|---|---|---|---|---|---|
| Google Chat | ||||||||
| הודעה פורסמה או עודכנה. |
|
|
||||||
| מתבצעת הוספה או מחיקה של תגובה, או שינוי של כמה תגובות. |
|
|
||||||
| המערכת יוצרת, מתעדכנת או מסירה את החברות או שהיא משתנה, או שעוברות מספר חברויות במועדון. |
|
|
||||||
| מרחב משותף מתעדכן או נמחק. |
|
|
||||||
| Google Meet | ||||||||
| התחלה או סיום של שיחת ועידה. |
|
|
||||||
| משתתף מצטרף לפגישה או עוזב אותה. |
|
|
||||||
| נוצרה הקלטה. |
|
|
||||||
| נוצר תמליל. |
|
|
||||||