Class AuthorizationInfo

AuthorizationInfo

スクリプトの必要なスコープに対する承認をユーザーが付与しているかどうかを確認するオブジェクト。このオブジェクトには、ユーザーがこれらの権限を付与するための認可 URL も含まれています。

スクリプトで使用されるすべての必須スコープに対するユーザーの同意なしに、一部のスクリプト実行を開始できます。このオブジェクトの情報を使用すると、特定のスコープを必要とするコードのセクションへのアクセスを制御し、後続の実行のためにそれらのスコープの承認をリクエストできます。

このオブジェクトは ScriptApp.getAuthorizationInfo(authMode) によって返されます。他の認証モードではユーザーが認証を付与する必要がないため、ほとんどの場合、スクリプトは ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL) を呼び出す必要があります。

メソッド

メソッド戻り値の型概要
getAuthorizationStatus()AuthorizationStatusユーザーが 1 つ以上のサービス（ScriptApp.AuthorizationStatus.REQUIRED など）を使用するためにこのスクリプトを承認する必要があるかどうかを示す値を取得します。
getAuthorizationUrl()String|nullスクリプトへのアクセス権の付与に使用できる認証 URL を取得します。
getAuthorizedScopes()String[]|nullスクリプトの承認済みスコープのリストを取得します。

詳細なドキュメント

getAuthorizationStatus()

ユーザーが 1 つ以上のサービス（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 - 承認済みスコープのリスト。