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