בחירת היקפים של 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. מוצר שהצפייה בו הוגבלה

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

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

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