המסמך הזה מכיל הרשאה ספציפית ל-Gmail API וגם פרטי אימות. לפני קריאת המסמך הזה, חשוב לקרוא המידע הכללי על אימות והרשאה ב-Google Workspace בכתובת מידע נוסף על אימות והרשאה
הגדרת OAuth 2.0 להרשאה
הגדרת מסך ההסכמה של OAuth ובחירת היקפים כדי להגדיר איזה מידע יוצג למשתמשים ולבודקי אפליקציות, ולרשום את האפליקציה כדי שאפשר יהיה לפרסם אותה מאוחר יותר.
היקפי ההרשאות של ממשק ה-API של Gmail
כדי להגדיר את רמת הגישה שמוענקת לאפליקציה שלך, עליך לזהות להצהיר על היקפי ההרשאות. היקף ההרשאה הוא מחרוזת OAuth 2.0 URI שכולל את השם של אפליקציית Google Workspace, את סוג הנתונים שאליהם היא ניגשת ואת רמת הגישה. היקפי הרשאות הם הבקשות של האפליקציה לעבוד עם נתוני Google Workspace, כולל משתמשים הנתונים בחשבון Google.
כשהאפליקציה שלך מותקנת, המשתמש מתבקש לאמת את היקפי ההרשאות ששימשו על ידי האפליקציה. באופן כללי, עדיף לבחור את ההיקף הצר ביותר אפשרית ולהימנע משליחת בקשות להיקפים שלא נדרשים באפליקציה שלכם. משתמשים נוספים מעניקים גישה בקלות להיקפים מוגבלים שמתוארים בבירור.
ממשק ה-API של Gmail תומך בהיקפים הבאים:
| קוד היקף ההרשאות | תיאור | שימוש |
|---|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
ניהול טיוטות ושליחת אימיילים במהלך אינטראקציה עם | לא רגיש |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
להציג את הודעות האימייל שלך בזמן אינטראקציה עם | לא רגיש |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
הצגת מטא-נתונים של הודעות אימייל כשהתוסף פועלת. | רגישות |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
הצגת הודעות האימייל כשהתוסף ריצה. | רגישות |
https://www.googleapis.com/auth/gmail.labels |
ליצור, לקרוא, לעדכן ולמחוק תוויות בלבד. | לא רגיש |
https://www.googleapis.com/auth/gmail.send |
שליחת הודעות בלבד. אין הרשאות קריאה או שינוי בתיבת הדואר. | רגישות |
https://www.googleapis.com/auth/gmail.readonly |
קריאת כל המשאבים ואת המטא-נתונים שלהם, ללא פעולות כתיבה. | מוצר שהצפייה בו הוגבלה |
https://www.googleapis.com/auth/gmail.compose |
ליצור, לקרוא, לעדכן ולמחוק טיוטות. לשלוח הודעות וטיוטות. | מוצר שהצפייה בו הוגבלה |
https://www.googleapis.com/auth/gmail.insert |
הוספה וייבוא של הודעות בלבד. | מוצר שהצפייה בו הוגבלה |
https://www.googleapis.com/auth/gmail.modify |
כל פעולות הקריאה/כתיבה מלבד מחיקה מיידית וסופית של שרשורים והודעות, שעוקפים את האשפה. | מוצר שהצפייה בו הוגבלה |
https://www.googleapis.com/auth/gmail.metadata |
קריאת מטא-נתונים של משאבים, כולל תוויות, רשומות היסטוריה ואימיילים את כותרות ההודעה, אבל לא את גוף ההודעה או את הקבצים המצורפים אליה. | מוצר שהצפייה בו הוגבלה |
https://www.googleapis.com/auth/gmail.settings.basic |
ניהול הגדרות אימייל בסיסיות. | מוצר שהצפייה בו הוגבלה |
https://www.googleapis.com/auth/gmail.settings.sharing |
לנהל הגדרות אימייל רגישות, כולל כללי העברה וכינויים.
הערה: הפעולות שמוגנות באמצעות ההיקף הזה מוגבלות ל: לשימוש מנהלי בלבד. הן זמינות רק ללקוחות Google Workspace באמצעות חשבון שירות עם הענקת גישה ברמת הדומיין. |
מוצר שהצפייה בו הוגבלה |
https://mail.google.com/ |
גישה מלאה לתיבות הדואר של החשבון, כולל מחיקה סופית של שרשורים והודעות – יש לבקש את ההיקף הזה רק אם האפליקציה צריך למחוק שרשורים והודעות באופן מיידי ולתמיד, תוך עקיפה של אשפה; את כל הפעולות האחרות אפשר לבצע עם היקפים פחות פחות תלויים. | מוצר שהצפייה בו הוגבלה |
העמודה Usage (שימוש) בטבלה שלמעלה מציינת את הרגישות של כל היקף, בהתאם להגדרות הבאות:
לא רגיש – ההיקפים האלה מספקים את הטווח הקטן ביותר גישה להרשאה ולחייב רק אימות בסיסי של האפליקציה. למידע על הדרישה הזו: השלבים כהכנה לאימות.
רגיש – ההיקפים האלה מאפשרים גישה לנתוני המשתמשים ב-Google ומחייבים תהליך אימות של היקף רגיש. מידע נוסף על הדרישה הזו זמין במאמר שירותי Google API: מדיניות בנושא נתוני משתמשים. ההיקפים האלה לא מחייבים בדיקת אבטחה.
מוגבלת – ההיקפים האלה מספקים גישה רחבה לנתוני המשתמשים ב-Google וגם יידרשו לעבור תהליך אימות בהיקף מוגבל. עבור מידע על הדרישה הזו: שירותי Google API: המדיניות בנושא נתוני משתמשים וגם דרישות נוספות להיקפי API ספציפיים. אם אתם מאחסנים נתונים בהיקף מוגבל בשרתים (או משדרים), צריך: לעבור הערכת אבטחה.
מידע נוסף שחל על השימוש שלך בממשקי ה-API של Gmail ועל הגישה שלך אליהם כאשר בקשה לגישה לנתוני משתמשים נמצאת נתוני משתמשים והמדיניות למפתחים בשירותי API של Gmail.
אם לאפליקציה נדרשת גישה לממשקי Google API אחרים, אפשר להוסיף גם את ההיקפים האלה. למידע נוסף על היקפים ב-Google API: לראות שימוש ב-OAuth 2.0 כדי לגשת ל-Google APIs.
אימות OAuth
שימוש בהיקפים רגישים מסוימים של OAuth עשוי לחייב את האפליקציה לעבור תהליך אימות OAuth של Google. לקריאת שאלות נפוצות בנושא אימות OAuth כדי לקבוע מתי האפליקציה צריכה לעבור אימות, ואיזה סוג של נדרש אימות. כדאי לעיין גם ב שירותי Google API: מדיניות בנושא נתוני משתמשים.