Class Session

Sitzung

Die Klasse „Session“ bietet Zugriff auf Sitzungsinformationen wie die E-Mail-Adresse des Nutzers (unter bestimmten Umständen) und die Spracheinstellung.

Methoden

MethodeRückgabetypKurzbeschreibung
getActiveUser()UserRuft Informationen zum aktuellen Nutzer ab.
getActiveUserLocale()StringRuft die Spracheinstellung des aktuellen Nutzers als String ab, z. B. en für Englisch.
getEffectiveUser()UserRuft Informationen zum Nutzer ab, unter dessen Autorität das Script ausgeführt wird.
getScriptTimeZone()StringRuft die Zeitzone des Skripts ab.
getTemporaryActiveUserKey()StringRuft einen temporären Schlüssel ab, der für den aktiven Nutzer eindeutig ist, aber die Nutzeridentität nicht offenbart.

Detaillierte Dokumentation

getActiveUser()

Ruft Informationen zum aktuellen Nutzer ab. Wenn Sicherheitsrichtlinien den Zugriff auf die Identität des Nutzers nicht zulassen, gibt User.getEmail() einen leeren String zurück. Die Umstände, unter denen die E-Mail-Adresse verfügbar ist, variieren. Die E-Mail-Adresse des Nutzers ist beispielsweise in keinem Kontext verfügbar, in dem ein Skript ohne die Autorisierung des Nutzers ausgeführt werden kann, z. B. bei einem einfachen onOpen(e)- oder onEdit(e)-Trigger, einer benutzerdefinierten Funktion in Google Tabellen oder einer Web-App, die als „Ich“ ausgeführt wird (d. h. vom Entwickler anstelle des Nutzers autorisiert wird). Diese Einschränkungen gelten jedoch in der Regel nicht, wenn der Entwickler das Skript selbst ausführt oder zur selben Google Workspace-Domain wie der Nutzer gehört.

// Log the email address of the person running the script.
const email = Session.getActiveUser().getEmail();
Logger.log(email);

Rückflug

User – der aktuelle Nutzer

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/userinfo.email

getActiveUserLocale()

Ruft die Spracheinstellung des aktuellen Nutzers als String ab, z. B. en für Englisch.

// Log the language setting of the person running the script.
Logger.log(Session.getActiveUserLocale());

Rückflug

String: Ein String, der die Spracheinstellung des Nutzers darstellt.


getEffectiveUser()

Ruft Informationen zum Nutzer ab, unter dessen Autorität das Script ausgeführt wird. Wenn das Script eine Web-App ist, die auf „Als ich ausführen“ (der Entwickler) festgelegt ist, wird das Nutzerkonto des Entwicklers zurückgegeben. Wenn das Skript unter einem installierbaren Trigger ausgeführt wird, wird das Konto des Nutzers zurückgegeben, der den Trigger erstellt hat. In den meisten anderen Fällen wird dasselbe Konto wie bei getActiveUser() zurückgegeben.

// Log the email address of the user under whose authority the script is
// running.
const email = Session.getEffectiveUser().getEmail();
Logger.log(email);

Rückflug

User: Der Nutzer, unter dessen Autorität das Skript ausgeführt wird.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/userinfo.email

getScriptTimeZone()

Ruft die Zeitzone des Skripts ab. Die Zeitzone neuer Skripts ist standardmäßig die des Eigentümers. Sie kann jedoch im Skripteditor unter Datei > Projekteigenschaften geändert werden. Tabellen haben eine separate Zeitzone, die Sie in Google Sheets ändern können, indem Sie auf Datei > Tabelleneinstellungen klicken. Tabellenzeitzonen, die sich von der Skriptzeitzone unterscheiden, sind eine häufige Quelle für Skriptfehler.

// Log the time zone of the script.
const timeZone = Session.getScriptTimeZone();
Logger.log(timeZone);

Rückflug

String: Die Zeitzone des Skripts


getTemporaryActiveUserKey()

Ruft einen temporären Schlüssel ab, der für den aktiven Nutzer eindeutig ist, aber die Nutzeridentität nicht offenbart. Der temporäre Schlüssel wird alle 30 Tage rotiert und ist für das Script eindeutig.

// Log the temporary key of the person running the script.
Logger.log(Session.getTemporaryActiveUserKey());

Rückflug

String – der temporäre Schlüssel für aktive Nutzer

Eingestellte Methoden