Script Service

Script

Dieser Dienst bietet Zugriff auf Script-Trigger und Script-Veröffentlichungen.

Classes

NameKurzbeschreibung
AuthModeEine Aufzählung, die angibt, welche Kategorien von autorisierten Diensten in Apps Script über eine ausgelöste Funktion ausgeführt werden können.
AuthorizationInfoEin Objekt, mit dem ermittelt wird, ob der Nutzer dieses Script für die Verwendung eines oder mehrerer Dienste autorisieren muss, und mit dem die URL für ein Autorisierungsdialogfeld angegeben wird.
AuthorizationStatusEine Aufzählung, die den Autorisierungsstatus eines Scripts angibt.
CalendarTriggerBuilderBuilder für Kalendertrigger.
ClockTriggerBuilderEin Builder für Uhrzeitauslö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 Script als Add-on für den aktuellen Nutzer installiert wurde.
ScriptAppAuf Script-Veröffentlichungen und Trigger zugreifen und sie bearbeiten.
ServiceAuf die Script-Veröffentlichung zugreifen und diese bearbeiten.
SpreadsheetTriggerBuilderTool zum Erstellen von Tabellentriggern
StateTokenBuilderErmöglicht es Scripts, Status-Token zu erstellen, die in Callback-APIs (z. B. OAuth-Abläufe) verwendet werden können.
TriggerSkript-Trigger
TriggerBuilderEin generischer Builder für Scripttrigger.
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 Anzahl von Diensten für die Verwendung in benutzerdefinierten Tabellenfunktionen ermöglicht.
LIMITEDEnumEin Modus, der den Zugriff auf eine begrenzte Anzahl von Diensten ermöglicht.
FULLEnumEin Modus, der Zugriff auf alle Dienste gewährt, für die eine Autorisierung erforderlich ist.

AuthorizationInfo

Methoden

MethodeRückgabetypKurzbeschreibung
getAuthorizationStatus()AuthorizationStatusGibt einen Wert zurück, der angibt, ob der Nutzer dieses Script für die Verwendung eines oder mehrerer Dienste autorisieren muss (z. B. ScriptApp.AuthorizationStatus.REQUIRED).
getAuthorizationUrl()StringRuft die Autorisierungs-URL ab, mit der Zugriff auf das Script gewährt werden kann.

AuthorizationStatus

Attribute

AttributTypBeschreibung
REQUIREDEnumDer Nutzer muss dieses Script autorisieren, einen oder mehrere Dienste zu verwenden.
NOT_REQUIREDEnumDer Nutzer hat diesem Script 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 an, nach der der Trigger nach der aktuellen Zeit 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)ClockTriggerBuilderHiermit wird angegeben, 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 Datumsangaben/Uhrzeiten 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 und gibt den neuen Trigger 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 eine bestimmte Zeit erreicht.
ON_OPENEnumDer Trigger wird ausgelöst, sobald der Nutzer die Google Docs-, Google Sheets- oder Google Formulare-Datei öffnet.
ON_EDITEnumDer Trigger wird ausgelöst, sobald der Nutzer die Google Tabellen-Datei bearbeitet, z. B. indem er einen neuen Wert in eine Zelle eingibt. Dies wird als Bearbeitung und nicht als Änderung gezählt.
ON_FORM_SUBMITEnumDer Trigger wird ausgelöst, wenn der Nutzer ein Google-Formular ausfüllt.
ON_CHANGEEnumDer Trigger wird ausgelöst, sobald der Nutzer die Google Tabellen-Datei ändert, z. B. durch das Hinzufügen einer Zeile, was als Änderung und nicht als Bearbeitung zählt.
ON_EVENT_UPDATEDEnumDer Trigger wird ausgelöst, wenn ein Termin im angegebenen Google-Kalender erstellt, aktualisiert oder gelöscht wird.

FormTriggerBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
create()TriggerErstellt und gibt den neuen Trigger zurück.
onFormSubmit()FormTriggerBuilderGibt einen Trigger an, der ausgelöst wird, wenn eine Antwort im 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 Script wird nicht als Add-on ausgeführt.
WEB_STORE_ADD_ONEnumDas Add-on wurde vom Nutzer aus dem Chrome Web Store installiert.

ScriptApp

Attribute

AttributTypBeschreibung
AuthModeAuthModeEine Aufzählung, die angibt, welche Kategorien von autorisierten Diensten in Apps Script über eine ausgelöste Funktion ausgeführt werden können.
AuthorizationStatusAuthorizationStatusEine Aufzählung, die den Autorisierungsstatus eines Scripts angibt.
EventTypeEventTypeEine Aufzählung, die den Typ des ausgelösten Ereignisses angibt.
InstallationSourceInstallationSourceEine Aufzählung, die angibt, wie das Script 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)voidDer angegebene Trigger wird entfernt, sodass er nicht mehr ausgeführt wird.
getAuthorizationInfo(authMode)AuthorizationInfoHiermit wird ein Objekt abgerufen, mit dem ermittelt wird, ob der Nutzer dieses Script für die Verwendung eines oder mehrerer Dienste autorisieren muss, und um die URL für ein Autorisierungsdialogfeld anzugeben.
getIdentityToken()StringRuft ein OpenID Connect-Identitätstoken für den effektiven Nutzer ab, wenn der Umfang openid gewährt wurde.
getInstallationSource()InstallationSourceGibt einen Enum-Wert zurück, der angibt, wie das Script 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 es von einem Domainadministrator für alle Nutzer installiert wurde.
getOAuthToken()StringRuft das OAuth 2.0-Zugriffstoken für den effektiven Nutzer ab.
getProjectTriggers()Trigger[]Alle installierbaren Trigger abrufen, die mit dem aktuellen Projekt und dem aktuellen Nutzer verknüpft sind
getScriptId()StringRuft die eindeutige ID des Script-Projekts ab.
getService()ServiceHiermit wird ein Objekt abgerufen, mit dem die Veröffentlichung des Scripts als Webanwendung gesteuert wird.
getUserTriggers(document)Trigger[]Hiermit werden alle installierbaren Trigger abgerufen, die diesem Nutzer im angegebenen Dokument gehören, und zwar nur für dieses Script oder Add-on.
getUserTriggers(form)Trigger[]Hiermit werden alle installierbaren Trigger abgerufen, die diesem Nutzer im angegebenen Formular gehören, und zwar nur für dieses Script oder Add-on.
getUserTriggers(spreadsheet)Trigger[]Hiermit werden alle installierbaren Trigger abgerufen, die diesem Nutzer in der angegebenen Tabelle gehören, und zwar nur für dieses Script oder Add-on.
invalidateAuth()voidMacht die Autorisierung ungültig, die der effektive Nutzer zum Ausführen des aktuellen Scripts hat.
newStateToken()StateTokenBuilderErstellt einen Builder für ein Statustoken, das in einer Callback-API (z. B. einem OAuth-Ablauf) verwendet werden kann.
newTrigger(functionName)TriggerBuilderHiermit wird der Prozess zum Erstellen eines installierbaren Triggers gestartet, 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 das Script als Webanwendung zugänglich ist.

SpreadsheetTriggerBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
create()TriggerErstellt den Trigger und gibt ihn zurück.
onChange()SpreadsheetTriggerBuilderHier wird ein Trigger angegeben, 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()SpreadsheetTriggerBuilderHier wird ein Trigger angegeben, der ausgelöst wird, wenn über die Tabelle ein Formular gesendet 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 Statustokens.
withArgument(name, value)StateTokenBuilderFügt dem Token ein Argument hinzu.
withMethod(method)StateTokenBuilderHier wird eine Rückruffunktion festgelegt.
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, auf den der Trigger reagiert.
getHandlerFunction()StringGibt die Funktion zurück, die aufgerufen wird, wenn der Trigger ausgelöst wird.
getTriggerSource()TriggerSourceGibt die Quelle der Ereignisse zurück, die den Trigger auslösen.
getTriggerSourceId()StringGibt die spezifische ID der Quelle zurück.
getUniqueId()StringEine eindeutige Kennung, mit der sich Trigger voneinander unterscheiden lassen.

TriggerBuilder

Methoden

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

TriggerSource

Attribute

AttributTypBeschreibung
SPREADSHEETSEnumGoogle Tabellen lösen den Trigger aus.
CLOCKEnumEin zeitgesteuertes Ereignis löst den Trigger aus.
FORMSEnumDer Trigger wird durch Google Formulare ausgelöst.
DOCUMENTSEnumGoogle Docs löst den Trigger aus.
CALENDAREnumGoogle Kalender löst den Trigger aus.