Class AuthorizationInfo

פרטי החיוב לצורך אימות

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

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

האובייקט הזה מוחזר על ידי ScriptApp.getAuthorizationInfo(authMode). ברוב המקרים, הסקריפטים צריכים לקרוא ל-ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL), כי אף מצב הרשאה אחר לא דורש מהמשתמשים לתת הרשאה.

Methods

שיטהסוג הערך שמוחזרתיאור קצר
getAuthorizationStatus()AuthorizationStatusמקבל ערך שמציין אם המשתמש צריך לאשר לסקריפט הזה להשתמש בשירות אחד או יותר (לדוגמה, ScriptApp.AuthorizationStatus.REQUIRED).
getAuthorizationUrl()String|nullמקבל את כתובת ה-URL לאישור שאפשר להשתמש בה כדי להעניק גישה לסקריפט.
getAuthorizedScopes()String[]|nullמקבל רשימה של היקפי הרשאות מורשים לסקריפט.

תיעוד מפורט

getAuthorizationStatus()

מקבל ערך שמציין אם המשתמש צריך לאשר לסקריפט הזה להשתמש בשירות אחד או יותר (לדוגמה, ScriptApp.AuthorizationStatus.REQUIRED). 

// Log the authorization status (REQUIRED or NOT_REQUIRED).
const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);
Logger.log(authInfo.getAuthorizationStatus());

חזרה

‫AuthorizationStatus – סטטוס ההרשאה.

getAuthorizationUrl()

מקבל את כתובת ה-URL לאישור שאפשר להשתמש בה כדי להעניק גישה לסקריפט. השיטה הזו מחזירה null אם לא נדרשת הרשאה. הדף בכתובת ה-URL נסגר אוטומטית אם ניגשים אליו והסקריפט לא דורש הרשאה כלשהי. 

// Log the URL used to grant access to the script.
const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);
Logger.log(authInfo.getAuthorizationUrl());

חזרה

‫String|null – כתובת URL שאפשר להשתמש בה כדי לאשר את הסקריפט.

getAuthorizedScopes()

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

// Logs which scopes in the specified list have been authorized for the script.
const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL, [
  'https: //www.googleapis.com/auth/documents',
  'https: //www.googleapis.com/auth/spreadsheets',
]);
Logger.log(authInfo.getAuthorizedScopes());

חזרה

‫String[]|null — רשימת היקפי ההרשאות המורשים.