Script Service

Script

Dieser Dienst bietet Zugriff auf Skript-Trigger und die Veröffentlichung von Skripts.

Klassen

NameKurzbeschreibung
AuthModeEine Aufzählung, die angibt, welche Kategorien autorisierter Dienste Apps Script über eine ausgelöste Funktion ausführen kann.
AuthorizationInfoEin Objekt, das prüft, ob der Nutzer die Autorisierung für die erforderlichen Bereiche des Skripts erteilt hat.
AuthorizationStatusEine Aufzählung, die den Autorisierungsstatus eines Skripts angibt.
CalendarTriggerBuilderBuilder für Kalender-Trigger.
ClockTriggerBuilderEin Builder für Uhrzeittrigger.
DocumentTriggerBuilderEin Builder für Dokument-Trigger.
EventTypeEine Aufzählung, die den Typ des ausgelösten Ereignisses angibt.
FormTriggerBuilderEin Builder für Formular-Trigger.
InstallationSourceEine Enumeration, die angibt, wie das Skript als Add-on für den aktuellen Nutzer installiert wurde.
ScriptAppAuf Skriptveröffentlichungen und ‑trigger zugreifen und diese bearbeiten.
ServiceAuf die Skriptveröffentlichung zugreifen und sie bearbeiten.
SpreadsheetTriggerBuilderBuilder für Tabellen-Trigger.
StateTokenBuilderErmöglicht es Scripts, Status-Tokens zu erstellen, die in Callback-APIs (z. B. OAuth-Abläufen) verwendet werden können.
TriggerEin Skript-Trigger.
TriggerBuilderEin generischer Builder für Skript-Trigger.
TriggerSourceEine Aufzählung, die die Quelle des Ereignisses angibt, das den Trigger auslöst.

AuthMode

Attribute

AttributTypBeschreibung
NONEEnumEin Modus, der den Zugriff auf Dienste, für die eine Autorisierung erforderlich ist, nicht zulässt.
CUSTOM_FUNCTIONEnumEin Modus, der den Zugriff auf eine begrenzte Teilmenge von Diensten zur Verwendung in benutzerdefinierten Tabellenkalkulationsfunktionen ermöglicht.
LIMITEDEnumEin Modus, der den Zugriff auf eine begrenzte Teilmenge von Diensten ermöglicht.
FULLEnumEin Modus, der den Zugriff auf alle Dienste ermöglicht, für die eine Autorisierung erforderlich ist.

AuthorizationInfo

Methoden

MethodeRückgabetypKurzbeschreibung
getAuthorizationStatus()AuthorizationStatusRuft einen Wert ab, der angibt, ob der Nutzer dieses Skript autorisieren muss, um einen oder mehrere Dienste zu verwenden (z. B. ScriptApp.AuthorizationStatus.REQUIRED).
getAuthorizationUrl()String|nullRuft die Autorisierungs-URL ab, mit der Zugriff auf das Skript gewährt werden kann.
getAuthorizedScopes()String[]|nullRuft eine Liste der autorisierten Bereiche für das Skript ab.

AuthorizationStatus

Attribute

AttributTypBeschreibung
REQUIREDEnumDer Nutzer muss dieses Skript autorisieren, einen oder mehrere Dienste zu verwenden.
NOT_REQUIREDEnumDer Nutzer hat diesem Skript alle derzeit erforderlichen Autorisierungen erteilt.

CalendarTriggerBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
create()TriggerErstellt den Trigger und gibt ihn zurück.
onEventUpdated()CalendarTriggerBuilderGibt einen Trigger an, der ausgelöst wird, wenn ein Kalendereintrag erstellt, aktualisiert oder gelöscht wird.

ClockTriggerBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
after(durationMilliseconds)ClockTriggerBuilderGibt die Mindestdauer in Millisekunden nach der aktuellen Zeit an, nach der der Trigger ausgeführt wird.
at(date)ClockTriggerBuilderGibt an, wann der Trigger ausgeführt wird.
atDate(year, month, day)ClockTriggerBuilderGibt an, dass der Trigger am angegebenen Datum ausgelöst wird, standardmäßig gegen Mitternacht (+/- 15 Minuten).
atHour(hour)ClockTriggerBuilderGibt die Stunde an, zu der der Trigger ausgeführt wird.
create()TriggerErstellt den Trigger.
everyDays(n)ClockTriggerBuilderGibt an, dass der Trigger alle n Tage ausgeführt werden soll.
everyHours(n)ClockTriggerBuilderGibt an, dass der Trigger alle n Stunden ausgeführt werden soll.
everyMinutes(n)ClockTriggerBuilderGibt an, dass der Trigger alle n Minuten ausgeführt werden soll.
everyWeeks(n)ClockTriggerBuilderGibt an, dass der Trigger alle n Wochen ausgeführt werden soll.
inTimezone(timezone)ClockTriggerBuilderGibt die Zeitzone für die angegebenen Datums-/Uhrzeitangaben an, zu denen der Trigger ausgeführt wird.
nearMinute(minute)ClockTriggerBuilderGibt die Minute an, zu der der Trigger ausgeführt wird (plus oder minus 15 Minuten).
onMonthDay(day)ClockTriggerBuilderGibt das Datum im Monat an, an dem der Trigger ausgeführt wird.
onWeekDay(day)ClockTriggerBuilderGibt den Wochentag an, an dem der Trigger ausgeführt wird.

DocumentTriggerBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
create()TriggerErstellt den neuen Trigger und gibt ihn zurück.
onOpen()DocumentTriggerBuilderGibt einen Trigger an, der ausgelöst wird, wenn das Dokument geöffnet wird.

EventType

Attribute

AttributTypBeschreibung
CLOCKEnumDer Trigger wird ausgelöst, sobald das zeitgesteuerte Ereignis einen bestimmten Zeitpunkt erreicht.
ON_OPENEnumDer Trigger wird ausgelöst, sobald der Nutzer die Google Docs-, Google Sheets- oder Google Forms-Datei öffnet.
ON_EDITEnumDer Trigger wird ausgelöst, sobald der Nutzer die Google-Tabelle bearbeitet, z. B. indem er einen neuen Wert in eine Zelle eingibt. Das gilt als Bearbeitung und nicht als Änderung.
ON_FORM_SUBMITEnumDer Trigger wird ausgelöst, sobald der Nutzer auf ein Google-Formular antwortet.
ON_CHANGEEnumDer Trigger wird ausgelöst, sobald der Nutzer die Google-Tabelle ändert, z. B. durch Hinzufügen einer Zeile (was als Änderung und nicht als Bearbeitung gilt).
ON_EVENT_UPDATEDEnumDer Trigger wird ausgelöst, sobald ein Termin im angegebenen Google-Kalender erstellt, aktualisiert oder gelöscht wird.

FormTriggerBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
create()TriggerErstellt den neuen Trigger und gibt ihn zurück.
onFormSubmit()FormTriggerBuilderGibt einen Trigger an, der ausgelöst wird, wenn eine Antwort für das Formular gesendet wird.
onOpen()FormTriggerBuilderGibt einen Trigger an, der ausgelöst wird, wenn die Bearbeitungsansicht des Formulars geöffnet wird.

InstallationSource

Attribute

AttributTypBeschreibung
APPS_MARKETPLACE_DOMAIN_ADD_ONEnumDas Add‑on wurde vom Administrator für die Domain des Nutzers installiert.
NONEEnumDas Skript wird nicht als Add-on ausgeführt.
WEB_STORE_ADD_ONEnumDas Add-on wurde vom Nutzer über den Chrome Web Store installiert.

ScriptApp

Attribute

AttributTypBeschreibung
AuthModeAuthModeEine Aufzählung, die angibt, welche Kategorien autorisierter Dienste Apps Script über eine ausgelöste Funktion ausführen kann.
AuthorizationStatusAuthorizationStatusEine Aufzählung, die den Autorisierungsstatus eines Skripts angibt.
EventTypeEventTypeEine Aufzählung, die den Typ des ausgelösten Ereignisses angibt.
InstallationSourceInstallationSourceEine Aufzählung, die angibt, wie das Skript als Add-on für den Nutzer installiert wurde.
TriggerSourceTriggerSourceEine Aufzählung, die die Quelle des Ereignisses angibt, das den Trigger auslöst.
WeekDayWeekdayEine Aufzählung, die die Wochentage darstellt.

Methoden

MethodeRückgabetypKurzbeschreibung
deleteTrigger(trigger)voidEntfernt den angegebenen Trigger, sodass er nicht mehr ausgeführt wird.
getAuthorizationInfo(authMode)AuthorizationInfoRuft ein Objekt ab, mit dem geprüft wird, ob der Nutzer die Autorisierung für alle Skriptanforderungen erteilt hat.
getAuthorizationInfo(authMode, oAuthScopes)AuthorizationInfoRuft ein Objekt ab, das prüft, ob der Nutzer die Autorisierung für die angeforderten Bereiche erteilt hat.
getIdentityToken()String|nullRuft ein OpenID Connect-Identitätstoken für den effektiven Nutzer ab, wenn der Bereich openid gewährt wurde.
getInstallationSource()InstallationSourceGibt einen Enumerationswert zurück, der angibt, wie das Skript als Add-on für den aktuellen Nutzer installiert wurde. Das kann z. B. sein, dass der Nutzer es selbst über den Chrome Web Store installiert hat oder dass ein Domainadministrator es für alle Nutzer installiert hat.
getOAuthToken()StringRuft das OAuth 2.0-Zugriffstoken für den effektiven Nutzer ab.
getProjectTriggers()Trigger[]Ruft alle installierbaren Trigger ab, die dem aktuellen Projekt und dem aktuellen Nutzer zugeordnet sind.
getScriptId()StringRuft die eindeutige ID des Skriptprojekts ab.
getService()ServiceRuft ein Objekt ab, mit dem das Veröffentlichen des Skripts als Web-App gesteuert wird.
getUserTriggers(document)Trigger[]Ruft alle installierbaren Trigger ab, die diesem Nutzer im angegebenen Dokument gehören, nur für dieses Skript oder Add-on.
getUserTriggers(form)Trigger[]Ruft alle installierbaren Trigger ab, die diesem Nutzer im angegebenen Formular für dieses Skript oder Add-on gehören.
getUserTriggers(spreadsheet)Trigger[]Ruft alle installierbaren Trigger ab, die diesem Nutzer in der angegebenen Tabelle für dieses Skript oder Add-on gehören.
invalidateAuth()voidMacht die Autorisierung ungültig, die der effektive Nutzer zum Ausführen des aktuellen Skripts hat.
newStateToken()StateTokenBuilderErstellt einen Builder für ein Status-Token, das in einer Callback-API (z. B. einem OAuth-Ablauf) verwendet werden kann.
newTrigger(functionName)TriggerBuilderStartet den Prozess zum Erstellen eines installierbaren Triggers, der beim Auslösen eine bestimmte Funktion aufruft.
requireAllScopes(authMode)voidPrüft, ob der Nutzer die Einwilligung für alle vom Skript angeforderten Bereiche erteilt hat.
requireScopes(authMode, oAuthScopes)voidPrüft, ob der Nutzer die Einwilligung für die angeforderten Bereiche erteilt hat.

Service

Methoden

MethodeRückgabetypKurzbeschreibung
getUrl()StringGibt die URL der Web-App zurück, wenn sie bereitgestellt wurde. Andernfalls wird null zurückgegeben.
isEnabled()BooleanGibt true zurück, wenn das Skript als Web-App zugänglich ist.

SpreadsheetTriggerBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
create()TriggerErstellt den Trigger und gibt ihn zurück.
onChange()SpreadsheetTriggerBuilderGibt einen Trigger an, der ausgelöst wird, wenn sich der Inhalt oder die Struktur der Tabelle ändert.
onEdit()SpreadsheetTriggerBuilderGibt einen Trigger an, der ausgelöst wird, wenn die Tabelle bearbeitet wird.
onFormSubmit()SpreadsheetTriggerBuilderGibt einen Trigger an, der ausgelöst wird, wenn ein Formular in der Tabelle eingereicht wird.
onOpen()SpreadsheetTriggerBuilderGibt einen Trigger an, der ausgelöst wird, wenn die Tabelle geöffnet wird.

StateTokenBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
createToken()StringErstellt eine verschlüsselte Stringdarstellung des Status-Tokens.
withArgument(name, value)StateTokenBuilderFügt dem Token ein Argument hinzu.
withMethod(method)StateTokenBuilderLegt eine Callback-Funktion fest.
withTimeout(seconds)StateTokenBuilderLegt die Dauer in Sekunden fest, für die das Token gültig ist.

Trigger

Methoden

MethodeRückgabetypKurzbeschreibung
getEventType()EventTypeGibt den Ereignistyp zurück, bei dem der Trigger ausgelöst wird.
getHandlerFunction()StringGibt die Funktion zurück, die aufgerufen wird, wenn der Trigger ausgelöst wird.
getTriggerSource()TriggerSourceGibt die Quelle der Ereignisse zurück, die das Auslösen des Triggers verursachen.
getTriggerSourceId()StringGibt die ID zurück, die für die Quelle spezifisch ist.
getUniqueId()StringGibt eine eindeutige Kennung zurück, mit der sich Trigger voneinander unterscheiden lassen.

TriggerBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
forDocument(document)DocumentTriggerBuilderErstellt ein DocumentTriggerBuilder, das mit dem angegebenen Dokument verknüpft ist, und gibt es zurück.
forDocument(key)DocumentTriggerBuilderErstellt ein DocumentTriggerBuilder, das mit dem Dokument mit der angegebenen ID verknüpft ist, und gibt es zurück.
forForm(form)FormTriggerBuilderErstellt ein FormTriggerBuilder, das mit dem angegebenen Formular verknüpft ist, und gibt es zurück.
forForm(key)FormTriggerBuilderErstellt ein FormTriggerBuilder, das mit dem Formular mit der angegebenen ID verknüpft ist, und gibt es zurück.
forSpreadsheet(sheet)SpreadsheetTriggerBuilderErstellt ein SpreadsheetTriggerBuilder, das mit der angegebenen Tabelle verknüpft ist, und gibt es zurück.
forSpreadsheet(key)SpreadsheetTriggerBuilderErstellt ein SpreadsheetTriggerBuilder, das mit der Tabelle mit der angegebenen ID verknüpft ist, und gibt es zurück.
forUserCalendar(emailId)CalendarTriggerBuilderGibt einen Builder zum Erstellen von Kalendertriggern zurück.
timeBased()ClockTriggerBuilderErstellt ein ClockTriggerBuilder zum Erstellen zeitbasierter Trigger und gibt es zurück.

TriggerSource

Attribute

AttributTypBeschreibung
SPREADSHEETSEnumGoogle Sheets löst den Trigger aus.
CLOCKEnumEin zeitgesteuertes Ereignis löst den Trigger aus.
FORMSEnumGoogle Formulare löst den Trigger aus.
DOCUMENTSEnumGoogle Docs löst den Trigger aus.
CALENDAREnumGoogle Kalender löst den Trigger aus.