Class AuthorizationInfo
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
AuthorizationInfo
Objek yang memeriksa apakah pengguna telah memberikan otorisasi untuk cakupan skrip yang diperlukan. Objek ini juga menyediakan URL otorisasi bagi pengguna untuk memberikan izin tersebut.
Beberapa eksekusi skrip dapat dimulai tanpa izin pengguna untuk semua cakupan yang diperlukan yang digunakan oleh skrip. Informasi dalam objek ini memungkinkan Anda mengontrol akses ke bagian kode yang memerlukan cakupan tertentu dan meminta otorisasi cakupan tersebut untuk eksekusi berikutnya.
Objek ini ditampilkan oleh ScriptApp.getAuthorizationInfo(authMode). Dalam hampir
semua kasus, skrip harus memanggil ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL),
karena tidak ada mode otorisasi lain yang mengharuskan pengguna memberikan otorisasi.
Metode
| Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
getAuthorizationStatus() | AuthorizationStatus | Mendapatkan nilai yang menunjukkan apakah pengguna perlu memberikan otorisasi pada skrip ini untuk menggunakan satu atau beberapa
layanan (misalnya, ScriptApp.AuthorizationStatus.REQUIRED). |
getAuthorizationUrl() | String | Mendapatkan URL otorisasi yang dapat digunakan untuk memberikan akses ke skrip. |
getAuthorizedScopes() | String[] | Mendapatkan daftar cakupan yang diotorisasi untuk skrip. |
Dokumentasi mendetail
getAuthorizationStatus()
Mendapatkan nilai yang menunjukkan apakah pengguna perlu memberikan otorisasi pada skrip ini untuk menggunakan satu atau beberapa
layanan (misalnya, ScriptApp.AuthorizationStatus.REQUIRED).
// Log the authorization status (REQUIRED or NOT_REQUIRED).
const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);
Logger.log(authInfo.getAuthorizationStatus());
Pulang pergi
AuthorizationStatus — status otorisasi
getAuthorizationUrl()
Mendapatkan URL otorisasi yang dapat digunakan untuk memberikan akses ke skrip. Metode ini menampilkan
null jika tidak ada otorisasi yang diperlukan. Halaman di URL akan otomatis ditutup jika
diakses dan skrip tidak memerlukan otorisasi apa pun.
// Log the URL used to grant access to the script.
const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);
Logger.log(authInfo.getAuthorizationUrl());
Pulang pergi
String — URL yang dapat digunakan untuk memberikan otorisasi pada skrip
getAuthorizedScopes()
Mendapatkan daftar cakupan yang diotorisasi untuk skrip. Jika informasi otorisasi diminta untuk
daftar cakupan yang ditentukan, tampilkan cakupan yang diotorisasi dari daftar yang ditentukan.
// 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());
Pulang pergi
String[] — Daftar cakupan yang diotorisasi.
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-26 UTC.
[null,null,["Terakhir diperbarui pada 2025-07-26 UTC."],[[["\u003cp\u003eAuthorizationInfo is an object used to determine if a user needs to authorize a script to use services and provides the authorization dialog URL.\u003c/p\u003e\n"],["\u003cp\u003eThis object is primarily used in add-ons with installable triggers to manage user access or prompt for authorization.\u003c/p\u003e\n"],["\u003cp\u003eIt offers two methods: \u003ccode\u003egetAuthorizationStatus()\u003c/code\u003e to check if authorization is required, and \u003ccode\u003egetAuthorizationUrl()\u003c/code\u003e to obtain the authorization URL.\u003c/p\u003e\n"],["\u003cp\u003eScripts should generally use \u003ccode\u003eScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL)\u003c/code\u003e for comprehensive authorization checks.\u003c/p\u003e\n"]]],[],null,["# Class AuthorizationInfo\n\nAuthorizationInfo\n\nAn object that checks if the user has granted authorization for the required scopes of the\nscript. The object also provides an authorization URL for users to grant those permissions.\n\nSome script executions can start without a user's consent to all required scopes used by the\nscript. The information in this object lets you control access to sections of code that require\ncertain scopes and request authorization of those scopes for subsequent executions.\n\nThis object is returned by [ScriptApp.getAuthorizationInfo(authMode)](/apps-script/reference/script/script-app#getAuthorizationInfo(AuthMode)). In almost\nall cases, scripts should call `Script``App.getAuthorizationInfo(ScriptApp.AuthMode.FULL)`,\nsince no other authorization mode requires that users grant authorization. \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------------|---------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [getAuthorizationStatus()](#getAuthorizationStatus()) | [AuthorizationStatus](/apps-script/reference/script/authorization-status) | Gets a value that indicates whether the user needs to authorize this script to use one or more services (for example, `Script``App.AuthorizationStatus.REQUIRED`). |\n| [getAuthorizationUrl()](#getAuthorizationUrl()) | `String` | Gets the authorization URL that can be used to grant access to the script. |\n| [getAuthorizedScopes()](#getAuthorizedScopes()) | `String[]` | Gets a list of authorized scopes for the script. |\n\nDetailed documentation\n----------------------\n\n### `get``Authorization``Status()`\n\nGets a value that indicates whether the user needs to authorize this script to use one or more\nservices (for example, `Script``App.AuthorizationStatus.REQUIRED`).\n\n```javascript\n// Log the authorization status (REQUIRED or NOT_REQUIRED).\nconst authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);\nLogger.log(authInfo.getAuthorizationStatus());\n```\n\n#### Return\n\n\n[AuthorizationStatus](/apps-script/reference/script/authorization-status) --- the authorization status\n\n*** ** * ** ***\n\n### `get``Authorization``Url()`\n\nGets the authorization URL that can be used to grant access to the script. This method returns\n`null` if no authorization is required. The page at the URL will close automatically if\nit is accessed and the script does not require any authorization.\n\n```javascript\n// Log the URL used to grant access to the script.\nconst authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);\nLogger.log(authInfo.getAuthorizationUrl());\n```\n\n#### Return\n\n\n`String` --- a URL that can be used to authorize the script\n\n*** ** * ** ***\n\n### `get``Authorized``Scopes()`\n\nGets a list of authorized scopes for the script. If authorization information is requested for\na specified list of scopes, returns the authorized scopes from the specified list.\n\n```javascript\n// Logs which scopes in the specified list have been authorized for the script.\nconst authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL, [\n 'https: //www.googleapis.com/auth/documents',\n 'https: //www.googleapis.com/auth/spreadsheets',\n]);\nLogger.log(authInfo.getAuthorizedScopes());\n```\n\n#### Return\n\n\n`String[]` --- The list of authorized scopes."]]
