Enum AuthMode
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
AuthMode
قائمة تحدّد فئات الخدمات المعتمَدة التي يمكن لخدمة Apps Script
تنفيذها من خلال دالة يتم تنشيطها. يتم عرض هذه القيم في الدوالّ التي يتم تنشيطها على أنّها السمة authMode
لمَعلمة الحدث، e
. لمزيد من المعلومات، يُرجى الاطّلاع على دليل دورة حياة
التفويض في الإضافات.
لاستدعاء قائمة أرقام صحيحة، عليك استدعاء الصف الرئيسي والاسم والخاصية. مثلاً:
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 | وضع يسمح بالوصول إلى مجموعة فرعية محدودة من الخدمات لاستخدامها في وظائف جدول البيانات المخصّصة
تتطلّب بعض هذه الخدمات، بما في ذلك الوصول للقراءة فقط إلى خدمة "جداول بيانات Google"، عادةً الحصول على إذن، ولكن يُسمح باستخدامها بدون إذن عند استخدامها في دالة
مخصّصة. بما أنّ الدوالّ المخصّصة لا تتضمّن مَعلمة حدث، لا يتم أبدًا
عرض هذه القيمة، ويتم توثيقها فقط لإثبات أنّ الدوالّ المخصّصة يتم تنفيذها في
وضع التفويض الخاص بها. |
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 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\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`. |"]]