המסמך הזה מכיל מידע על הרשאות ואימות ספציפיות ל-Google Drive API. לפני שקוראים את המסמך הזה, חשוב לקרוא את המידע הכללי בנושא אימות והרשאות ב-Google Workspace, במאמר מידע על אימות והרשאה.
הגדרת OAuth 2.0 להרשאה
מגדירים את מסך ההסכמה של OAuth ובוחרים היקפים כדי להגדיר איזה מידע יוצג למשתמשים ולבודקי האפליקציות, ולרשום את האפליקציה כדי שתוכלו לפרסם אותה מאוחר יותר.
היקפי ההרשאות של Drive API
כדי להגדיר את רמת הגישה שהוענקה לאפליקציה, צריך לזהות היקפי הרשאות ולהצהיר עליהם. היקף הרשאה הוא מחרוזת URI של OAuth 2.0 שכוללת את שם האפליקציה ב-Google Workspace, סוגי הנתונים שאליהם היא ניגשת ורמת הגישה. היקפים הם הבקשות של האפליקציה לעבוד עם נתוני Google Workspace, כולל נתוני חשבונות Google של משתמשים.
כשהאפליקציה מותקנת, המשתמשים מתבקשים לאמת את היקפי ההרשאות שהאפליקציה משתמשת בהם. באופן כללי, כדאי לבחור את ההיקף הצר ביותר שאפשר, ולהימנע מבקשות להיקפים שלא צריכים את האפליקציה. המשתמשים מעניקים גישה להיקפי הרשאות מוגבלים שמתוארים בצורה ברורה יותר.
כשאפשר, מומלץ להשתמש בהיקפים לא רגישים, כי הם נותנים היקף גישה לכל קובץ ומצמצמים את הגישה לתכונות ספציפיות שנדרשות לאפליקציה.
ממשק ה-API של Drive תומך בהיקפים הבאים:
| קוד ההיקף | תיאור | Usage |
|---|---|---|
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/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.metadata |
הצגה וניהול של מטא-נתונים של קבצים ב-Drive שלך. | מוצר שהצפייה בו הוגבלה |
https://www.googleapis.com/auth/drive.metadata.readonly |
הצגת מטא-נתונים של קבצים ב-Drive. | מוצר שהצפייה בו הוגבלה |
https://www.googleapis.com/auth/drive.scripts |
שינוי התנהגות הסקריפטים של Google Apps Script. | מוצר שהצפייה בו הוגבלה |
העמודה 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 של Google. כדאי לקרוא את השאלות הנפוצות בנושא אימות OAuth API כדי להבין מתי צריך לעבור אימות של האפליקציה ואיזה סוג של אימות נדרש. ראו גם תנאים והגבלות של Google Drive.
מתי כדאי להשתמש בהיקף מוגבל
ב-Drive, רק אפליקציות מהסוגים הבאים יכולות לגשת להיקפים מוגבלים:
- אפליקציות אינטרנט ואפליקציות ספציפיות לפלטפורמה, שמספקות סנכרון מקומי או גיבוי אוטומטי של קובצי Drive של המשתמשים.
- אפליקציות לפרודוקטיביות וחינוך, שממשק המשתמש שלהן עשוי לכלול אינטראקציה עם קובצי Drive (או עם המטא-נתונים או ההרשאות שלהם). אפליקציות לפרודוקטיביות כוללות ניהול משימות, כתיבת הערות, תקשורת בקבוצות עבודה ואפליקציות לשיתוף פעולה בכיתה.
- אפליקציות דיווח ואבטחה שמספקות תובנות לגבי המשתמשים או הלקוחות לגבי שיתוף הקבצים או הגישה אליהם.
כדי להמשיך להשתמש בהיקפים מוגבלים, עליכם להכין את האפליקציה לאימות בהיקף המוגבל.
העברת אפליקציה קיימת מהיקפים מוגבלים
אם פיתחתם אפליקציית Drive באמצעות אחד מההיקפים המוגבלים, מומלץ להעביר את האפליקציה להיקף לא רגיש, כי היא מעניקה היקף גישה לכל קובץ ומצמצמת את הגישה לתכונות ספציפיות שנדרשות לאפליקציה. הרבה אפליקציות פועלות עם גישה לכל קובץ ללא שינוי. אם אתם משתמשים בכלי לבחירת קבצים, מומלץ לעבור ל-Google Picker API שתומך באופן מלא בהיקפים שונים.
היתרונות של היקף הרשאות ה-OAuth drive.file
השימוש בהיקף OAuth של drive.file וב-Google Picker API משפרים את חוויית המשתמש ואת הבטיחות באפליקציה.
היקף הרשאות ה-OAuth של drive.file מאפשר למשתמשים לבחור אילו קבצים לשתף עם האפליקציה, וכך הם יכולים לקבל יותר שליטה ויותר ביטחון שהגישה של האפליקציה לקבצים שלהם מוגבלת ומאובטחת יותר. לעומת זאת, דרישה לגישה רחבה לכל הקבצים ב-Drive עשויה לגרום לכך שמשתמשים לא יוכלו ליצור אינטראקציה עם האפליקציה. הסיבות לכך הן כמה סיבות לשימוש בהיקף drive.file:
נוחות השימוש: ההיקף
drive.fileפועל עם כל משאבי ה-REST של Drive API, כך שאפשר להשתמש בו באותו אופן שבו משתמשים בהיקפים רחבים יותר של OAuth.תכונות: Google Picker API מספק ממשק דומה לממשק המשתמש של Drive. זה כולל מספר תצוגות שמציגות תצוגות מקדימות ותמונות ממוזערות של קבצים ב-Drive, וחלון מודולרי מוטבע שמאפשר למשתמשים אף פעם לא לצאת מהאפליקציה הראשית.
נוחות: אפליקציות יכולות להחיל מסננים על סוגי קבצים מסוימים ב-Drive (כמו Google Docs, Sheets ו-Photos) כשמשתמשים במסנן בקבצים ב-Google Picker.
כמו כן, מכיוון שהשדה drive.file לא רגיש, הוא מאפשר תהליך אימות יעיל יותר.
שמירת אסימוני רענון
אפשר לשמור אסימוני רענון באחסון מאובטח לטווח ארוך ולהמשיך להשתמש בהם כל עוד הם בתוקף.