Script Service

Script

Dieser Dienst bietet Zugriff auf Skriptauslöser und Skriptveröffentlichung.

Kurse

NameKurzbeschreibung
AuthModeEine Aufzählung, die angibt, welche Kategorien autorisierter Dienste Apps Script über eine ausgelöste Funktion ausführen kann.
AuthorizationInfoEin Objekt, mit dem bestimmt wird, ob der Nutzer dieses Skript autorisieren muss, einen oder mehrere Dienste zu verwenden, und die URL für ein Autorisierungsdialogfeld bereitstellen.
AuthorizationStatusEine Aufzählung, die den Autorisierungsstatus eines Skripts angibt.
CalendarTriggerBuilderBuilder für Kalendertrigger
ClockTriggerBuilderEin Builder für Uhrauslöser.
DocumentTriggerBuilderEin Builder für Dokumenttrigger.
EventTypeEine Aufzählung, die den Typ des ausgelösten Ereignisses angibt.
FormTriggerBuilderEin Builder für Formulartrigger.
InstallationSourceEine Aufzählung, die angibt, wie das Skript als Add-on für den aktuellen Nutzer installiert wurde.
ScriptAppSkriptveröffentlichung und Trigger aufrufen und bearbeiten
ServiceAuf die Skriptveröffentlichung zugreifen und sie bearbeiten
SpreadsheetTriggerBuilderBuilder für Tabellentrigger
StateTokenBuilderErmöglicht Skripts das Erstellen von Statustokens, die in Callback-APIs (z. B. OAuth-Abläufen) verwendet werden können.
TriggerEin Skript-Trigger.
TriggerBuilderEin allgemeiner Builder für Skript-Trigger.
TriggerSourceEine Aufzählung, die die Quelle des Ereignisses angibt, das den Trigger auslöst.

AuthMode

Attribute

PropertyTypBeschreibung
NONEEnumEin Modus, der keinen Zugriff auf Dienste zulässt, für die eine Autorisierung erforderlich ist.
CUSTOM_FUNCTIONEnumEin Modus, der den Zugriff auf eine begrenzte Teilmenge von Diensten zur Verwendung in benutzerdefinierten Tabellenfunktionen ermöglicht.
LIMITEDEnumEin Modus, der 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()StringRuft die Autorisierungs-URL ab, mit der Zugriff auf das Skript gewährt werden kann.

AuthorizationStatus

Attribute

PropertyTypBeschreibung
REQUIREDEnumDer Nutzer muss dieses Skript autorisieren, einen oder mehrere Dienste zu verwenden.
NOT_REQUIREDEnumDer Nutzer hat diesem Skript alle derzeit erforderlichen Autorisierungen gewährt.

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, zu 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 wird.
everyWeeks(n)ClockTriggerBuilderGibt an, dass der Trigger alle n Wochen ausgeführt werden soll.
inTimezone(timezone)ClockTriggerBuilderGibt die Zeitzone für das angegebene Datum und die angegebene Uhrzeit an, wenn der Trigger ausgeführt wird.
nearMinute(minute)ClockTriggerBuilderGibt die Minute an, in 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 beim Öffnen des Dokuments ausgelöst wird.

EventType

Attribute

PropertyTypBeschreibung
CLOCKEnumDer Trigger wird ausgelöst, sobald das zeitgesteuerte Ereignis eine bestimmte Zeit erreicht.
ON_OPENEnumDer Trigger wird ausgelöst, sobald der Nutzer die Datei in Google Docs, Google Tabellen oder Google Formulare öffnet.
ON_EDITEnumDer Trigger wird ausgelöst, sobald der Nutzer die Google Tabellen-Datei bearbeitet, indem er z. B. einen neuen Wert in eine Zelle eingibt, der als Bearbeitung und nicht als Änderung gezählt wird.
ON_FORM_SUBMITEnumDer Trigger wird ausgelöst, sobald der Nutzer auf ein Google-Formular geantwortet hat.
ON_CHANGEEnumDer Trigger wird ausgelöst, sobald der Nutzer die Google Tabellen-Datei ändert, z. B. durch das Hinzufügen einer Zeile. Dies zählt als Änderung und nicht als Änderung.
ON_EVENT_UPDATEDEnumDer Trigger wird ausgelöst, wenn im angegebenen Google-Kalender ein Termin 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 auf das Formular gesendet wird.
onOpen()FormTriggerBuilderGibt einen Trigger an, der ausgelöst wird, wenn die Bearbeitungsansicht des Formulars geöffnet wird.

InstallationSource

Attribute

PropertyTypBeschreibung
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 aus dem Chrome Web Store installiert.

ScriptApp

Attribute

PropertyTypBeschreibung
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 für den Nutzer als Add-on 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 ermittelt wird, ob der Nutzer dieses Skript autorisieren muss, um einen oder mehrere Dienste zu verwenden, und die URL für ein Autorisierungsdialogfeld angeben.
getIdentityToken()StringRuft ein OpenID Connect-Identitätstoken für den aktiven Nutzer ab, wenn der Bereich openid gewährt wurde.
getInstallationSource()InstallationSourceGibt einen enum-Wert zurück, der angibt, wie das Skript als Add-on für den aktuellen Nutzer installiert wurde, z. B. ob der Nutzer es selbst über den Chrome Web Store installiert hat oder ob ein Domainadministrator es für alle Nutzer installiert hat.
getOAuthToken()StringRuft das OAuth 2.0-Zugriffstoken für den aktiven Nutzer ab.
getProjectTriggers()Trigger[]Ruft alle installierbaren Trigger ab, die mit dem aktuellen Projekt und dem aktuellen Nutzer verknüpft sind.
getScriptId()StringRuft die eindeutige ID des Skriptprojekts ab.
getService()ServiceRuft ein Objekt ab, über das die Veröffentlichung des Skripts als Webanwendung gesteuert wird.
getUserTriggers(document)Trigger[]Ruft alle installierbaren Trigger dieses Nutzers im angegebenen Dokument ab, nur für dieses Skript oder Add-on.
getUserTriggers(form)Trigger[]Ruft alle installierbaren Trigger dieses Nutzers in der angegebenen Form nur für dieses Skript oder Add-on ab.
getUserTriggers(spreadsheet)Trigger[]Ruft alle installierbaren Trigger dieses Nutzers in der angegebenen Tabelle ab, nur für dieses Skript oder Add-on.
invalidateAuth()voidUngültig macht die Autorisierung, die der aktive Nutzer zum Ausführen des aktuellen Skripts hat.
newStateToken()StateTokenBuilderErstellt einen Builder für ein Statustoken, das in einer Callback-API (z. B. einem OAuth-Ablauf) verwendet werden kann.
newTrigger(functionName)TriggerBuilderStartet den Prozess der Erstellung eines installierbaren Triggers, der beim Auslösen eine bestimmte Funktion aufruft.

Service

Methoden

MethodeRückgabetypKurzbeschreibung
getUrl()StringGibt die URL der Webanwendung zurück, falls sie bereitgestellt wurde. Andernfalls wird null zurückgegeben.
isEnabled()BooleanGibt true zurück, wenn auf das Skript als Webanwendung zugegriffen werden kann.

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 beim Bearbeiten der Tabelle ausgelöst wird.
onFormSubmit()SpreadsheetTriggerBuilderGibt einen Trigger an, der ausgelöst wird, wenn ein Formular an die Tabelle gesendet wird.
onOpen()SpreadsheetTriggerBuilderGibt einen Trigger an, der beim Öffnen der Tabelle ausgelöst wird.

StateTokenBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
createToken()StringErstellt eine verschlüsselte Stringdarstellung des Statustokens.
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 beim Auslösen des Triggers aufgerufen wird.
getTriggerSource()TriggerSourceGibt die Quelle der Ereignisse zurück, die den Trigger auslösen
getTriggerSourceId()StringGibt die für die Quelle spezifische ID zurück
getUniqueId()StringGibt eine eindeutige Kennung zurück, mit der Trigger voneinander unterschieden werden können.

TriggerBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
forDocument(document)DocumentTriggerBuilderErstellt und gibt eine DocumentTriggerBuilder zurück, die mit dem angegebenen Dokument verknüpft ist.
forDocument(key)DocumentTriggerBuilderErstellt und gibt ein DocumentTriggerBuilder zurück, das mit dem Dokument mit der angegebenen ID verknüpft ist.
forForm(form)FormTriggerBuilderErstellt und gibt ein FormTriggerBuilder zurück, das mit dem angegebenen Formular verknüpft ist.
forForm(key)FormTriggerBuilderErstellt und gibt ein FormTriggerBuilder zurück, das mit dem Formular mit der angegebenen ID verknüpft ist.
forSpreadsheet(sheet)SpreadsheetTriggerBuilderErstellt und gibt eine SpreadsheetTriggerBuilder für die angegebene Tabelle zurück.
forSpreadsheet(key)SpreadsheetTriggerBuilderErstellt und gibt eine SpreadsheetTriggerBuilder zurück, die mit der Tabelle mit der angegebenen ID verknüpft ist.
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

PropertyTypBeschreibung
SPREADSHEETSEnumIn Google Tabellen wird der Trigger ausgelöst.
CLOCKEnumEin zeitgesteuertes Ereignis löst den Trigger aus.
FORMSEnumGoogle Formulare führt dazu, dass der Trigger ausgelöst wird.
DOCUMENTSEnumGoogle Docs führt dazu, dass der Trigger ausgelöst wird.
CALENDAREnumIn Google Kalender wird der Trigger ausgelöst.