בחירת היקפים של Google Drive API

במסמך הזה מפורט מידע על הרשאות ואימות שספציפיים ל-Google Drive API. לפני שקוראים את המסמך הזה, חשוב לקרוא את המידע הכללי על אימות והרשאה ב-Google Workspace במאמר מידע על אימות והרשאה.

הגדרת OAuth 2.0 למתן הרשאות

מגדירים את מסך ההסכמה של OAuth ובוחרים היקפי הרשאה כדי להגדיר איזה מידע יוצג למשתמשים ולבודקי האפליקציה, ורושמים את האפליקציה כדי שתוכלו לפרסם אותה בהמשך.

היקפי ההרשאות של Drive API

כדי להגדיר את רמת הגישה שניתנת לאפליקציה, צריך לזהות ולהצהיר על היקפי הרשאות. היקף הרשאות הוא מחרוזת URI של OAuth 2.0 שמכילה את שם אפליקציית Google Workspace, את סוג הנתונים שהיא ניגשת אליהם ואת רמת הגישה. ההיקפים הם הבקשות של האפליקציה לעבוד עם נתוני Google Workspace, כולל נתוני חשבון Google של המשתמשים.

כשמתקינים את האפליקציה, המשתמש מתבקש לאמת את היקפי ההרשאות שבהם נעשה שימוש באפליקציה. בדרך כלל, כדאי לבחור את היקף ההרשאות הממוקד ביותר שאפשר, ולהימנע מבקשת היקפי הרשאות שהאפליקציה לא צריכה. המשתמשים נוטים יותר להעניק גישה להיקפים מוגבלים שמתוארים בצורה ברורה.

כשאפשר, מומלץ להשתמש בהיקפי גישה לא רגישים, כי הם מאפשרים גישה לכל קובץ ומצמצמים את הגישה לתכונות ספציפיות שנדרשות לאפליקציה.

‫Drive API תומך בהיקפי הגישה הבאים:

קוד היקף תיאור שימוש
https://www.googleapis.com/auth/drive.appdata
https://www.googleapis.com/auth/drive.appfolder		 הצגה וניהול של נתוני התצורה של האפליקציה ב-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 API אחרים, תוכלו להוסיף גם את היקפי ההרשאות האלה. למידע נוסף על היקפי הרשאות של Google API, אפשר לעיין במאמר שימוש ב-OAuth 2.0 כדי לגשת ל-Google APIs.

מידע נוסף על היקפי הרשאות ספציפיים של OAuth 2.0 מופיע במאמר היקפי הרשאות של OAuth 2.0 ל-Google APIs.

אימות OAuth

שימוש בהיקפי OAuth מסוימים עשוי לחייב את האפליקציה לעבור את התהליך שמתואר במרכז העזרה לאימות אפליקציות ב-OAuth. כדאי לקרוא את השאלות הנפוצות בנושא אפליקציות OAuth כדי להבין מתי האפליקציה שלכם צריכה לעבור אימות ואיזה סוג אימות נדרש. מידע נוסף זמין בתנאים ובהגבלות של Google Drive.

מתי כדאי להשתמש בהיקף מוגבל

ב-Drive, רק לסוגי האפליקציות הבאים יש גישה להיקפי הרשאות מוגבלים:

  1. אפליקציות אינטרנט ספציפיות לפלטפורמה שמספקות סנכרון מקומי או גיבוי אוטומטי של קבצים ב-Drive של המשתמשים.
  2. אפליקציות פרודוקטיביות ואפליקציות חינוכיות שהממשק שלהן עשוי לכלול אינטראקציה עם קבצים ב-Drive (או עם המטא-נתונים או ההרשאות שלהם). אפליקציות לפרודוקטיביות כוללות אפליקציות לניהול משימות, לסיכום פגישות, לתקשורת בין קבוצות עבודה ולשיתוף פעולה בכיתה.
  3. אפליקציות דיווח ואבטחה שמספקות למשתמשים או ללקוחות תובנות לגבי האופן שבו קבצים משותפים או מתבצעת אליהם גישה.

כדי להמשיך להשתמש בהיקפי גישה מוגבלים, צריך להכין את האפליקציה לאימות של היקפי גישה מוגבלים.

העברת אפליקציה קיימת מהיקפי הרשאות מוגבלים

אם פיתחתם אפליקציה ל-Drive באמצעות אחת מההרשאות המוגבלות, מומלץ להעביר את האפליקציה לשימוש בהרשאה לא רגישה, כי היא מעניקה הרשאת גישה לכל קובץ ומצמצמת את הגישה לתכונות ספציפיות שנדרשות לאפליקציה. הרבה אפליקציות פועלות עם הרשאת גישה לכל קובץ ללא שינויים. אם אתם משתמשים בכלי לבחירת קבצים משלכם, מומלץ לעבור ל-Google Picker API, שתומך באופן מלא בהיקפים שונים.

היתרונות של היקף ההרשאות drive.file OAuth

שימוש בהיקף ההרשאות של drive.file OAuth וב-Google Picker API משפר את חוויית המשתמש ואת הבטיחות של האפליקציה.

drive.file היקף ההרשאות של OAuth מאפשר למשתמשים לבחור אילו קבצים הם רוצים לשתף עם האפליקציה שלכם. כך הם מקבלים יותר שליטה וביטחון שהגישה של האפליקציה לקבצים שלהם מוגבלת ומאובטחת יותר. לעומת זאת, אם תדרשו גישה רחבה לכל הקבצים ב-Drive, יכול להיות שהמשתמשים לא ירצו להשתמש באפליקציה שלכם. הנה כמה סיבות לשימוש בהיקף drive.file:

  • שימושיות: היקף ההרשאות drive.file פועל עם כל משאבי REST של Drive API, כך שאפשר להשתמש בו באותו אופן שבו משתמשים בהיקפי הרשאות רחבים יותר של OAuth.

  • תכונות: Google Picker API מספק ממשק דומה לממשק המשתמש של Drive. התכונה כוללת כמה תצוגות שבהן מוצגות תצוגות מקדימות ותמונות ממוזערות של קבצים ב-Drive, וחלון מודאלי מוטבע כדי שהמשתמשים לא יצטרכו לצאת מהאפליקציה הראשית.

  • נוחות: אפליקציות יכולות להחיל מסננים על סוגים מסוימים של קבצים ב-Drive (כמו Google Docs,‏ Sheets ותמונות) כשמשתמשים במסנן בקבצים של Google Picker.

בנוסף, מכיוון ש-drive.file לא רגיש, תהליך האימות פשוט יותר.

שמירת אסימוני רענון

שומרים את אסימוני הרענון באחסון מאובטח לטווח ארוך וממשיכים להשתמש בהם כל עוד הם תקפים.