המסמך הזה מכיל הרשאה ספציפית ל-Google Workspace Event API וגם פרטי אימות. לפני קריאת המסמך הזה, חשוב לקרוא המידע הכללי על אימות והרשאה ב-Google Workspace בכתובת מידע נוסף על אימות והרשאה
הגדרת OAuth 2.0 להרשאה
הגדרת מסך ההסכמה של OAuth ובחירת היקפים כדי להגדיר איזה מידע יוצג למשתמשים ולבודקי אפליקציות, ולרשום את האפליקציה כדי שאפשר יהיה לפרסם אותה מאוחר יותר.
היקפי ההרשאות של Google Workspace Event API
כדי להגדיר את רמת הגישה שמוענקת לאפליקציה שלך, עליך לזהות להצהיר על היקפי ההרשאות. היקף ההרשאה הוא מחרוזת OAuth 2.0 URI שכולל את השם של אפליקציית Google Workspace, את סוג הנתונים שאליהם היא ניגשת ואת רמת הגישה. היקפי הרשאות הם הבקשות של האפליקציה לעבוד עם נתוני Google Workspace, כולל משתמשים הנתונים בחשבון Google.
כשהאפליקציה שלך מותקנת, המשתמש מתבקש לאמת את היקפי ההרשאות ששימשו על ידי האפליקציה. באופן כללי, עדיף לבחור את ההיקף הצר ביותר אפשרית ולהימנע משליחת בקשות להיקפים שלא נדרשים באפליקציה שלכם. משתמשים נוספים מעניקים גישה בקלות להיקפים מוגבלים שמתוארים בבירור.
כשהדבר אפשרי, מומלץ להשתמש בהיקפים לא רגישים כי הם מעניקים הרשאות לכל קובץ היקף הגישה מצמצם את הגישה לפונקציונליות ספציפית שנדרשת על ידי האפליקציה.
ב-Google Workspace Event API נעשה שימוש בהיקפים מ-Google Workspace אפליקציות שתומכות במינויים. אם האפליקציה שלך כבר משתמשת בהיקפים שנדרשות עבור המינוי שלך, אין צורך להוסיף את היקפי ההרשאות לשימוש ב-Google Workspace Event API.
בטבלה הבאה מוצגים היקפי ההרשאות הנתמכים של Google Workspace Event 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: נתוני משתמש מדיניות ודרישות נוספות ל-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, ה-API של האירועים ב-Google Workspace
תומכת גם באימות של משתמשים וגם באימות של אפליקציות כדי להפעיל חלק מהשיטות שלו. אם ממשק API
ה-method תומך בשני פרטי הכניסה, סוג פרטי הכניסה שבו נעשה שימוש בשיחה
משפיעה על התוצאה שמוחזרת. לדוגמה, אם קוראים לפונקציה
subscriptions.list()
עם אימות משתמש, ה-API מחזיר רשימה של מינויים
למשתמש המאומת יש גישה. אם משתמשים באימות של אפליקציות, ה-API
מחזירה רשימה של מינויים שלאפליקציה יש גישה אליהם. מידע נוסף על
סוגי אימות של צ'אטים, ראו אימות ואישור
אפליקציות Chat ו-Google Chat API
בקשות.
בטבלה הבאה מוצגים ההיקפים והסוגים של צריך או שיש תמיכה באימות לכל אחד מה-Google Workspace Event API method:
| שיטה | נדרש או נתמך אימות משתמש | יש תמיכה באימות אפליקציות (רק אפליקציות של Google Chat) | היקפי ההרשאות הנתמכים | |
|---|---|---|---|---|
| יצירת מינוי | — |
נדרש היקף נתמך לכל סוג אירוע:
|
||
| רכישת מינוי |
כשמשתמשים באימות משתמשים, השיטה הזו מחייבת היקף שתומך לפחות בסוג אירוע אחד במינוי.
באמצעות אימות אפליקציות (רק באפליקציות של Google Chat):
|
|||
| הצגת רשימה של מינויים |
כשמשתמשים באימות משתמשים, השיטה הזו מחייבת היקף שתומך לפחות בסוג אירוע אחד במינוי.
באמצעות אימות אפליקציות (רק באפליקציות של Google Chat):
|
|||
| עדכון המינוי | — |
נדרש היקף נתמך לכל סוג אירוע:
|
||
| הפעלה מחדש של מינוי | — |
נדרש היקף נתמך לכל סוג אירוע:
|
||
| מחיקת מינוי |
כשמשתמשים באימות משתמשים, השיטה הזו מחייבת היקף שתומך לפחות בסוג אירוע אחד במינוי.
באמצעות אימות אפליקציות (רק באפליקציות של Google Chat):
|
|||
היקפי הרשאות לפי סוג האירוע
כשקוראים ל-Google Workspace Event API באמצעות אימות משתמשים, חייבים לציין היקף אחד או יותר שתואם לסוגי האירועים של במינוי.
בטבלה הבאה מפורטים היקפי ההרשאות שנתמכים בכל סוג סוג האירוע:
| אירועים | סוגי אירועים | היקפי ההרשאות הנתמכים | ||||||
|---|---|---|---|---|---|---|---|---|
| Google Chat | ||||||||
| הודעה פורסמה או עודכנה. |
|
|
||||||
| אם מוסיפים או מוחקים תגובה, או שיש שינויים בתגובות. |
|
|
||||||
| מועדון החברים נוצר, עודכן או הוסר, או שיש כמה מינויים השתנו. |
|
|
||||||
| מרחב משותף עודכן או נמחק. |
|
|
||||||
| Google Meet | ||||||||
| שיחת ועידה מתחילה או מסתיימת. |
|
|
||||||
| משתתף מצטרף לפגישה או עוזב אותה. |
|
|
||||||
| נוצרה הקלטה. |
|
|
||||||
| נוצר תמליל. |
|
|
||||||