Class AuthorizationInfo

AuthorizationInfo

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

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

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

メソッド

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

詳細なドキュメント

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 - スクリプトの認証に使用できる 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[] - 承認済みスコープのリスト。