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

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

הגדרת OAuth 2.0 להרשאה

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

היקפי גישה של Docs API

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

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

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

Docs API תומך בהיקפים הבאים:

קוד ההיקף תיאור שימוש
https://www.googleapis.com/auth/documents הצגה, עריכה, יצירה ומחיקה של כל המסמכים שלכם ב-Google Docs. רגישות
https://www.googleapis.com/auth/documents.readonly הצגת כל המסמכים שלכם ב-Google Docs. רגישות
https://www.googleapis.com/auth/drive.file הצגה, עריכה, יצירה ומחיקה רק של הקבצים הספציפיים ב-Google Drive שבהם נעשה שימוש באפליקציה הזו. מומלץ
לא רגיש
https://www.googleapis.com/auth/drive הצגה, עריכה, יצירה ומחיקה של כל הקבצים שלכם ב-Google Drive. מוצר שהצפייה בו הוגבלה
https://www.googleapis.com/auth/drive.readonly הצגה והורדה של כל הקבצים שלכם ב-Google Drive. מוצר שהצפייה בו הוגבלה

בעמודה Usage בטבלה מצוין רמת הרגישות של כל היקף, בהתאם להגדרות הבאות:

  • לא רגיש: היקפי הגישה האלה מספקים את היקף הרשאת הגישה הקטן ביותר, ונדרש רק אימות בסיסי של האפליקציה. מידע נוסף על הדרישה הזו זמין במאמר שליחת האפליקציה לאימות.

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

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

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

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