Enum AuthMode
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
AuthMode
ספירה שמזהה את הקטגוריות של השירותים המורשים ש-Apps Script יכול להריץ באמצעות פונקציה מופעלת. הערכים האלה גלויים בפונקציות מופעלות בתור המאפיין authMode
של פרמטר האירוע, e
. למידע נוסף, עיינו במדריך למחזור החיים של הרשאות עבור תוספים.
כדי לקרוא למאפיין enum, צריך לקרוא לכיתה ההורה, לשם ולנכס שלו. לדוגמה,
ScriptApp.AuthMode.CUSTOM_FUNCTION
.
function onOpen(e) {
const menu = SpreadsheetApp.getUi().createAddonMenu();
if (e && e.authMode === ScriptApp.AuthMode.NONE) {
// Add a normal menu item (works in all authorization modes).
menu.addItem('Start workflow', 'startWorkflow');
} else {
// Add a menu item based on properties (doesn't work in AuthMode.NONE).
const properties = PropertiesService.getDocumentProperties();
const workflowStarted = properties.getProperty('workflowStarted');
if (workflowStarted) {
menu.addItem('Check workflow status', 'checkWorkflow');
} else {
menu.addItem('Start workflow', 'startWorkflow');
}
// Record analytics.
UrlFetchApp.fetch('http://www.example.com/analytics?event=open');
}
menu.addToUi();
}
מאפיינים
נכס | סוג | תיאור |
NONE | Enum | מצב שבו אין גישה לשירותים שדורשים הרשאה. המצב הזה מתרחש כשתוסף מפעיל טריגר פשוט של onOpen(e) , והמשתמש התקין תוסף במסמך אחר אבל לא השתמש בתוסף במסמך הנוכחי. |
CUSTOM_FUNCTION | Enum | מצב שמאפשר גישה לקבוצת משנה מוגבלת של שירותים לשימוש בפונקציות בהתאמה אישית של גיליונות אלקטרוניים. בדרך כלל, כדי להשתמש בחלק מהשירותים האלה – כולל גישה לקריאה בלבד לשירות של גיליון אלקטרוני – נדרשת הרשאה, אבל אפשר להשתמש בהם ללא הרשאה כשמשתמשים בהם בפונקציה מותאמת אישית. מאחר שפונקציות בהתאמה אישית לא כוללות פרמטר אירוע, הערך הזה אף פעם לא מוחזר. הוא מתועד רק כדי להראות שפונקציות בהתאמה אישית פועלות במצב הרשאה משלהם. |
LIMITED | Enum | מצב שמאפשר גישה לקבוצת משנה מוגבלת של שירותים. המצב הזה מתרחש כשתוסף או סקריפט המקושר למסמך מפעילים טריגר פשוט של onOpen(e) או onEdit(e) , מלבד במקרה שמתואר לגבי NONE . |
FULL | Enum | מצב שמאפשר גישה לכל השירותים שדורשים הרשאה. המצב הזה מתרחש כשתוסף או סקריפט מופעל כתוצאה מטריגר כלשהו, מלבד המקרים המתוארים עבור LIMITED או NONE . |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-26 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-26 (שעון UTC)."],[[["\u003cp\u003eAuthMode defines the level of access Apps Script has to authorized services when a triggered function is executed.\u003c/p\u003e\n"],["\u003cp\u003eIt's crucial for understanding how add-ons and scripts interact with Google services, especially concerning user authorization.\u003c/p\u003e\n"],["\u003cp\u003eDifferent AuthModes like NONE, LIMITED, and FULL, dictate the scope of service access, impacting functionalities within triggered functions.\u003c/p\u003e\n"],["\u003cp\u003eCustom functions operate under a specific authorization mode that allows restricted access to certain services without explicit user authorization.\u003c/p\u003e\n"]]],[],null,["# Enum AuthMode\n\nAuthMode\n\nAn enumeration that identifies which categories of authorized services Apps Script is able to\nexecute through a triggered function. These values are exposed in [triggered functions](/apps-script/understanding_triggers) as the `auth``Mode`\nproperty of the [event parameter](/apps-script/understanding_events), `e`. For\nmore information, see the [guide to the\nauthorization lifecycle for add-ons](/gsuite/add-ons/concepts/addon-authorization#authorization_modes).\n\nTo call an enum, you call its parent class, name, and property. For example, `\nScriptApp.AuthMode.CUSTOM_FUNCTION`.\n\n```javascript\nfunction onOpen(e) {\n const menu = SpreadsheetApp.getUi().createAddonMenu();\n if (e && e.authMode === ScriptApp.AuthMode.NONE) {\n // Add a normal menu item (works in all authorization modes).\n menu.addItem('Start workflow', 'startWorkflow');\n } else {\n // Add a menu item based on properties (doesn't work in AuthMode.NONE).\n const properties = PropertiesService.getDocumentProperties();\n const workflowStarted = properties.getProperty('workflowStarted');\n if (workflowStarted) {\n menu.addItem('Check workflow status', 'checkWorkflow');\n } else {\n menu.addItem('Start workflow', 'startWorkflow');\n }\n // Record analytics.\n UrlFetchApp.fetch('http://www.example.com/analytics?event=open');\n }\n menu.addToUi();\n}\n``` \n\n### Properties\n\n| Property | Type | Description |\n|-------------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `NONE` | `Enum` | A mode that does not allow access to any services that require authorization. This mode occurs when an add-on executes an `on``Open(e)` simple trigger, and the user has installed an add-on in a different document but the add-on has not been used in the current document. |\n| `CUSTOM_FUNCTION` | `Enum` | A mode that allows access to a limited subset of services for use in custom spreadsheet functions. Some of these services --- including read-only access to Spreadsheet service --- normally require authorization, but are permitted without authorization when used in a custom function. Because custom functions do not include an event parameter, this value is never returned; it is documented only to demonstrate that custom functions run in their own authorization mode. |\n| `LIMITED` | `Enum` | A mode that allows access to a limited subset of services. This mode occurs when an add-on or a script [bound](/apps-script/scripts_containers) to a document executes an `on``Open(e)` or `on``Edit(e)` simple trigger, except in the case described for `NONE`. |\n| `FULL` | `Enum` | A mode that allows access to all services that require authorization. This mode occurs when an add-on or a script executes as the result of any trigger other than the cases described for `LIMITED` or `NONE`. |"]]