המסמך הזה מכיל פרטי אימות והרשאה ספציפיים ל-API של Gmail. לפני שתקראו את המסמך הזה, כדאי לקרוא את המידע הכללי בנושא אימות והרשאה של Google Workspace במאמר מידע על אימות והרשאה.
הגדרת OAuth 2.0 להרשאה
צריך להגדיר את מסך ההסכמה ל-OAuth ולבחור היקפים כדי להגדיר איזה מידע יוצג למשתמשים ולבודקים של האפליקציות, ולרשום את האפליקציה כדי שתוכלו לפרסם אותה מאוחר יותר.
היקפי ההרשאות של ממשק ה-API של Gmail
כדי להגדיר את רמת הגישה שהוענקה לאפליקציה, עליכם לזהות היקפי הרשאות ולהצהיר עליהם. היקף הרשאה הוא מחרוזת URI של OAuth 2.0 שכוללת את השם של אפליקציית Google Workspace, סוגי הנתונים שאליהם האפליקציה ניגשת ורמת הגישה. היקפים הם הבקשות של האפליקציה לעבוד עם נתוני Google Workspace, כולל נתונים של חשבונות Google של משתמשים.
כשמתקינים את האפליקציה, המשתמשים מתבקשים לאמת את ההיקפים שבהם האפליקציה משתמשת. באופן כללי, כדאי לבחור את ההיקף הצר ביותר שאפשר, ולהימנע מבקשות להיקפים שלא נדרשים לאפליקציה. המשתמשים מעניקים גישה להיקפים מוגבלים ומתוארים בצורה ברורה יותר.
ממשק ה-API של Gmail תומך בהיקפים הבאים:
| קוד ההיקף | תיאור | Usage |
|---|---|---|
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 ועל הגישה שלכם לממשקי Gmail כאשר אתם מבקשים גישה לנתוני משתמשים, זמין במדיניות למפתחים בנושא נתוני משתמש ושירותי ממשק ה-API של Gmail.
אם לאפליקציה נדרשת גישה לממשקי Google API אחרים, אפשר להוסיף גם את ההיקפים האלה. למידע נוסף על ההיקפים של Google API, תוכלו לקרוא את המאמר שימוש ב-OAuth 2.0 לגישה ל-Google APIs.
אימות OAuth
ייתכן שהשימוש בהיקפים רגישים של OAuth ידרוש שהאפליקציה תעבור את תהליך אימות ה-OAuth של Google. מומלץ לקרוא את השאלות הנפוצות בנושא אימות OAuth, כדי להבין מתי האפליקציה צריכה לעבור אימות ואיזה סוג אימות נדרש. למידע נוסף, ראו שירותי Google API: המדיניות בנושא נתוני משתמשים.