המסמך הזה מכיל מידע ספציפי לגבי הרשאות ואימות ב-Google Drive API. לפני קריאת המסמך הזה, חשוב לקרוא את המידע הכללי על אימות והרשאה ב-Google Workspace במאמר מידע על אימות והרשאה.
הגדרת OAuth 2.0 להרשאה
מגדירים את מסך ההסכמה של OAuth ובוחרים היקפי הרשאה כדי לקבוע איזה מידע יוצג למשתמשים ולבודקים של האפליקציה, ומרשמים את האפליקציה כדי שתוכלו לפרסם אותה בהמשך.
היקפי הרשאה של Drive API
כדי להגדיר את רמת הגישה שמוענקת לאפליקציה, צריך לזהות ולדווח על היקפי הרשאה. היקף הרשאה הוא מחרוזת URI של OAuth 2.0 שמכילה את שם האפליקציה ב-Google Workspace, את סוג הנתונים שהיא ניגשת אליהם ואת רמת הגישה. היקפים הם הבקשות של האפליקציה לעבוד עם נתוני Google Workspace, כולל נתונים מחשבון Google של המשתמשים.
כשהאפליקציה מותקנת, המשתמש מתבקש לאמת את ההיקפים שבהם האפליקציה משתמשת. באופן כללי, כדאי לבחור את ההיקף המצומצם ביותר האפשרי ולהימנע מבקשות להיקפים שלא נדרשים לאפליקציה. משתמשים נותנים גישה בקלות רבה יותר להיקפים מוגבלים ומתוארים בבירור.
כשהדבר אפשרי, מומלץ להשתמש בהיקפי גישה לא רגישים, כי הם מעניקים היקף גישה לכל קובץ ומצמצמים את הגישה לתכונות ספציפיות שנחוצות לאפליקציה.
ה-API של Drive תומך בהיקפי הגישה הבאים:
קוד ההיקף | תיאור | שימוש |
---|---|---|
https://www.googleapis.com/auth/drive.appdata |
הצגה וניהול של נתוני התצורה של האפליקציה ב-Google Drive. | מומלץ לא רגיש |
https://www.googleapis.com/auth/drive.install |
לאפשר לאפליקציות להופיע כאפשרות בתפריט 'פתיחה באמצעות' או בתפריט 'חדש'. | מומלץ לא רגיש |
https://www.googleapis.com/auth/drive.file |
ליצור קבצים חדשים ב-Drive או לשנות קבצים קיימים שפותחים באפליקציה או שהמשתמש משתף עם אפליקציה באמצעות Google Picker API או בורר הקבצים של האפליקציה. | מומלץ לא רגיש |
https://www.googleapis.com/auth/drive.apps.readonly |
הצגת האפליקציות שיש להן הרשאת גישה ל-Drive. | רגישות |
https://www.googleapis.com/auth/drive |
הצגה וניהול של כל הקבצים ב-Drive. | מוצר שהצפייה בו הוגבלה |
https://www.googleapis.com/auth/drive.readonly |
הצגה והורדה של כל הקבצים ב-Drive. | מוצר שהצפייה בו הוגבלה |
https://www.googleapis.com/auth/drive.activity |
הצגת רשומות הפעילות של הקבצים ב-Drive והוספת פעילויות. | מוצר שהצפייה בו הוגבלה |
https://www.googleapis.com/auth/drive.activity.readonly |
הצגת רשומות הפעילות של הקבצים ב-Drive. | מוצר שהצפייה בו הוגבלה |
https://www.googleapis.com/auth/drive.meet.readonly |
צפייה בקבצים ב-Drive שנוצרו או נערכו ב-Google Meet. | מוצר שהצפייה בו הוגבלה |
https://www.googleapis.com/auth/drive.metadata |
הצגה וניהול של מטא נתונים של קבצים ב-Drive. | מוצר שהצפייה בו הוגבלה |
https://www.googleapis.com/auth/drive.metadata.readonly |
הצגת מטא-נתונים של קבצים ב-Drive. | מוצר שהצפייה בו הוגבלה |
https://www.googleapis.com/auth/drive.scripts |
שינוי ההתנהגות של הסקריפטים של Google Apps Script. | מוצר שהצפייה בו הוגבלה |
העמודה 'שימוש' בטבלה שלמעלה מציינת את רמת הרגישות של כל היקף, בהתאם להגדרות הבאות:
מומלץ / לא רגיש: ההיקפים האלה מספקים את ההיקף הקטן ביותר של גישה להרשאה, ונדרש רק אימות בסיסי של האפליקציה. מידע נוסף על הדרישה הזו זמין במאמר דרישות האימות.
מומלץ / רגיש: היקפי ההרשאות האלה מספקים גישה לנתוני משתמשים ספציפיים ב-Google, שהמשתמש העניק לאפליקציה הרשאה לגשת אליהם. כדי להשתמש בהיקפי הרשאות כאלה, צריך לעבור תהליך אימות נוסף של האפליקציה. מידע נוסף על הדרישה הזו זמין בקטע דרישות לגבי היקפים רגישים ומוגבלים.
מוגבלת: היקפי הגישה האלה מספקים גישה רחבה לנתוני המשתמשים ב-Google, וצריך לעבור תהליך אימות של היקף גישה מוגבל. מידע נוסף על הדרישה הזו זמין במאמרים המדיניות בנושא נתוני משתמשים בשירותי API של Google ודרישות נוספות להיקפי API ספציפיים. אם אתם מאחסנים נתונים בהיקף מוגבל בשרתים (או מעבירים אותם), עליכם לעבור הערכת אבטחה.
אם האפליקציה שלכם זקוקה לגישה לממשקי Google API אחרים, תוכלו להוסיף גם את ההיקפים האלה. למידע נוסף על היקפי ההרשאות של Google API, תוכלו לקרוא את המאמר שימוש ב-OAuth 2.0 כדי לגשת ל-Google APIs.
מידע נוסף על היקפי OAuth 2.0 ספציפיים זמין במאמר היקפי OAuth 2.0 ל-Google APIs.
אימות OAuth
כדי להשתמש בהיקפי OAuth מסוימים, יכול להיות שהאפליקציה תצטרך לעבור את מרכז העזרה לאימות אפליקציות ב-OAuth. כדאי לקרוא את השאלות הנפוצות בנושא אפליקציות OAuth כדי לקבוע מתי צריך לאמת את האפליקציה ואיזה סוג אימות נדרש. מידע נוסף זמין בהתנאים וההגבלות של Google Drive.
מתי כדאי להשתמש בהיקף מוגבל
ב-Drive, רק סוגי האפליקציות הבאים יכולים לגשת להיקפי הרשאות מוגבלים:
- אפליקציות אינטרנט ואפליקציות ספציפיות לפלטפורמה שמספקות סנכרון מקומי או גיבוי אוטומטי של קבצים ב-Drive של המשתמשים.
- אפליקציות פרודוקטיביות ואפליקציות חינוכיות שממשק המשתמש שלהן עשוי לכלול אינטראקציה עם קבצים ב-Drive (או עם המטא-נתונים או ההרשאות שלהם). אפליקציות לפרודוקטיביות כוללות אפליקציות לניהול משימות, לכתיבה של הערות, לתקשורת עם קבוצות עבודה ואפליקציות לשיתוף פעולה בכיתה.
- אפליקציות דיווח ואבטחה שמספקות למשתמשים או ללקוחות תובנות לגבי האופן שבו הקבצים משותפים או ניגשים אליהם.
כדי להמשיך להשתמש בהיקפי גישה מוגבלים, עליכם להכין את האפליקציה לאימות בהיקף מוגבל.
העברת אפליקציה קיימת מתחומים מוגבלים
אם פיתחתם אפליקציה ל-Drive באמצעות אחד מההיקפים המוגבלים, מומלץ להעביר את האפליקציה להיקף גישה לא רגיש, כי הוא מעניק היקף גישה לכל קובץ ומצמצם את הגישה לתכונות ספציפיות שנדרשות לאפליקציה. אפליקציות רבות פועלות עם היקף גישה לכל קובץ בלי שצריך לבצע שינויים. אם אתם משתמשים בבורר קבצים משלכם, מומלץ לעבור ל-Google Picker API שתומך במלואו בהיקפים שונים.
היתרונות של היקף הרשאות OAuth drive.file
שימוש בהיקף ההרשאות drive.file
של OAuth וב-Google Picker API מאפשר לכם לשפר את חוויית המשתמש ואת הבטיחות באפליקציה.
היקף הרשאות ה-OAuth drive.file
מאפשר למשתמשים לבחור אילו קבצים הם רוצים לשתף עם האפליקציה. כך הם יכולים לשלוט טוב יותר בקבצים שלהם, ולהרגיש בטוחים יותר שהגישה של האפליקציה לקבצים שלהם מוגבלת ומאובטחת יותר. לעומת זאת, אם תדרשו גישה רחבה לכל הקבצים ב-Drive, יכול להיות שהמשתמשים יפסיקו להשתמש באפליקציה. ריכזנו כאן כמה סיבות לשימוש בהיקף drive.file
:
נוחות השימוש: ההיקף
drive.file
פועל עם כל משאבי ה-REST של Drive API, כלומר אפשר להשתמש בו באותו אופן שבו משתמשים בהיקפי OAuth רחבים יותר.תכונות: Google Picker API מספק ממשק דומה לממשק המשתמש של Drive. התכונה הזו כוללת כמה תצוגות שמציגות תצוגות מקדימות ותמונות ממוזערות של קבצים ב-Drive, וחלון מודאלי בתוך הדף כדי שהמשתמשים לא יצטרכו לצאת מהאפליקציה הראשית.
נוחות: אפליקציות יכולות להחיל מסננים על סוגים מסוימים של קבצים ב-Drive (כמו Google Docs, Sheets ותמונות) באמצעות מסנן על קבצים ב-Google Picker.
בנוסף, מכיוון ש-drive.file
הוא לא רגיש, הוא מאפשר תהליך אימות יעיל יותר.
שמירת אסימוני רענון
שומרים את אסימוני הרענון באחסון מאובטח לטווח ארוך וממשיכים להשתמש בהם כל עוד הם בתוקף.