Script Service

Script

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

Classes

Name	Kurzbeschreibung
AuthMode	Eine Aufzählung, die angibt, welche Kategorien von autorisierten Diensten in Apps Script über eine ausgelöste Funktion ausgeführt werden können.
AuthorizationInfo	Ein 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.
AuthorizationStatus	Eine Aufzählung, die den Autorisierungsstatus eines Scripts angibt.
CalendarTriggerBuilder	Builder für Kalendertrigger.
ClockTriggerBuilder	Ein Builder für Uhrzeitauslöser.
DocumentTriggerBuilder	Ein Builder für Dokumenttrigger.
EventType	Eine Aufzählung, die den Typ des ausgelösten Ereignisses angibt.
FormTriggerBuilder	Ein Builder für Formulartrigger.
InstallationSource	Eine Aufzählung, die angibt, wie das Script als Add-on für den aktuellen Nutzer installiert wurde.
ScriptApp	Auf Script-Veröffentlichungen und Trigger zugreifen und sie bearbeiten.
Service	Auf die Script-Veröffentlichung zugreifen und diese bearbeiten.
SpreadsheetTriggerBuilder	Tool zum Erstellen von Tabellentriggern
StateTokenBuilder	Ermöglicht es Scripts, Status-Token zu erstellen, die in Callback-APIs (z. B. OAuth-Abläufe) verwendet werden können.
Trigger	Skript-Trigger
TriggerBuilder	Ein generischer Builder für Scripttrigger.
TriggerSource	Eine Aufzählung, die die Quelle des Ereignisses angibt, das den Trigger auslöst.

AuthMode

Attribute

Attribut	Typ	Beschreibung
NONE	Enum	Ein Modus, der den Zugriff auf Dienste, für die eine Autorisierung erforderlich ist, nicht zulässt.
CUSTOM_FUNCTION	Enum	Ein Modus, der den Zugriff auf eine begrenzte Anzahl von Diensten für die Verwendung in benutzerdefinierten Tabellenfunktionen ermöglicht.
LIMITED	Enum	Ein Modus, der den Zugriff auf eine begrenzte Anzahl von Diensten ermöglicht.
FULL	Enum	Ein Modus, der Zugriff auf alle Dienste gewährt, für die eine Autorisierung erforderlich ist.

AuthorizationInfo

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
getAuthorizationStatus()	AuthorizationStatus	Gibt 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()	String	Ruft die Autorisierungs-URL ab, mit der Zugriff auf das Script gewährt werden kann.

AuthorizationStatus

Attribute

Attribut	Typ	Beschreibung
REQUIRED	Enum	Der Nutzer muss dieses Script autorisieren, einen oder mehrere Dienste zu verwenden.
NOT_REQUIRED	Enum	Der Nutzer hat diesem Script alle derzeit erforderlichen Autorisierungen gewährt.

CalendarTriggerBuilder

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
create()	Trigger	Erstellt den Trigger und gibt ihn zurück.
onEventUpdated()	CalendarTriggerBuilder	Gibt einen Trigger an, der ausgelöst wird, wenn ein Kalendereintrag erstellt, aktualisiert oder gelöscht wird.

ClockTriggerBuilder

Methoden

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

DocumentTriggerBuilder

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
create()	Trigger	Erstellt und gibt den neuen Trigger zurück.
onOpen()	DocumentTriggerBuilder	Gibt einen Trigger an, der ausgelöst wird, wenn das Dokument geöffnet wird.

EventType

Attribute

Attribut	Typ	Beschreibung
CLOCK	Enum	Der Trigger wird ausgelöst, sobald das zeitgesteuerte Ereignis eine bestimmte Zeit erreicht.
ON_OPEN	Enum	Der Trigger wird ausgelöst, sobald der Nutzer die Google Docs-, Google Sheets- oder Google Formulare-Datei öffnet.
ON_EDIT	Enum	Der 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_SUBMIT	Enum	Der Trigger wird ausgelöst, wenn der Nutzer ein Google-Formular ausfüllt.
ON_CHANGE	Enum	Der 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_UPDATED	Enum	Der Trigger wird ausgelöst, wenn ein Termin im angegebenen Google-Kalender erstellt, aktualisiert oder gelöscht wird.

FormTriggerBuilder

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
create()	Trigger	Erstellt und gibt den neuen Trigger zurück.
onFormSubmit()	FormTriggerBuilder	Gibt einen Trigger an, der ausgelöst wird, wenn eine Antwort im Formular gesendet wird.
onOpen()	FormTriggerBuilder	Gibt einen Trigger an, der ausgelöst wird, wenn die Bearbeitungsansicht des Formulars geöffnet wird.

InstallationSource

Attribute

Attribut	Typ	Beschreibung
APPS_MARKETPLACE_DOMAIN_ADD_ON	Enum	Das Add-on wurde vom Administrator für die Domain des Nutzers installiert.
NONE	Enum	Das Script wird nicht als Add-on ausgeführt.
WEB_STORE_ADD_ON	Enum	Das Add-on wurde vom Nutzer aus dem Chrome Web Store installiert.

ScriptApp

Attribute

Attribut	Typ	Beschreibung
AuthMode	AuthMode	Eine Aufzählung, die angibt, welche Kategorien von autorisierten Diensten in Apps Script über eine ausgelöste Funktion ausgeführt werden können.
AuthorizationStatus	AuthorizationStatus	Eine Aufzählung, die den Autorisierungsstatus eines Scripts angibt.
EventType	EventType	Eine Aufzählung, die den Typ des ausgelösten Ereignisses angibt.
InstallationSource	InstallationSource	Eine Aufzählung, die angibt, wie das Script als Add-on für den Nutzer installiert wurde.
TriggerSource	TriggerSource	Eine Aufzählung, die die Quelle des Ereignisses angibt, das den Trigger auslöst.
WeekDay	Weekday	Eine Aufzählung, die die Wochentage darstellt.

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
deleteTrigger(trigger)	void	Der angegebene Trigger wird entfernt, sodass er nicht mehr ausgeführt wird.
getAuthorizationInfo(authMode)	AuthorizationInfo	Hiermit 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()	String	Ruft ein OpenID Connect-Identitätstoken für den effektiven Nutzer ab, wenn der Umfang openid gewährt wurde.
getInstallationSource()	InstallationSource	Gibt 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()	String	Ruft 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()	String	Ruft die eindeutige ID des Script-Projekts ab.
getService()	Service	Hiermit 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()	void	Macht die Autorisierung ungültig, die der effektive Nutzer zum Ausführen des aktuellen Scripts hat.
newStateToken()	StateTokenBuilder	Erstellt einen Builder für ein Statustoken, das in einer Callback-API (z. B. einem OAuth-Ablauf) verwendet werden kann.
newTrigger(functionName)	TriggerBuilder	Hiermit wird der Prozess zum Erstellen eines installierbaren Triggers gestartet, der beim Auslösen eine bestimmte Funktion aufruft.

Service

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
getUrl()	String	Gibt die URL der Webanwendung zurück, falls sie bereitgestellt wurde. Andernfalls wird null zurückgegeben.
isEnabled()	Boolean	Gibt true zurück, wenn das Script als Webanwendung zugänglich ist.

SpreadsheetTriggerBuilder

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
create()	Trigger	Erstellt den Trigger und gibt ihn zurück.
onChange()	SpreadsheetTriggerBuilder	Hier wird ein Trigger angegeben, der ausgelöst wird, wenn sich der Inhalt oder die Struktur der Tabelle ändert.
onEdit()	SpreadsheetTriggerBuilder	Gibt einen Trigger an, der ausgelöst wird, wenn die Tabelle bearbeitet wird.
onFormSubmit()	SpreadsheetTriggerBuilder	Hier wird ein Trigger angegeben, der ausgelöst wird, wenn über die Tabelle ein Formular gesendet wird.
onOpen()	SpreadsheetTriggerBuilder	Gibt einen Trigger an, der ausgelöst wird, wenn die Tabelle geöffnet wird.

StateTokenBuilder

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
createToken()	String	Erstellt eine verschlüsselte Stringdarstellung des Statustokens.
withArgument(name, value)	StateTokenBuilder	Fügt dem Token ein Argument hinzu.
withMethod(method)	StateTokenBuilder	Hier wird eine Rückruffunktion festgelegt.
withTimeout(seconds)	StateTokenBuilder	Legt die Dauer in Sekunden fest, für die das Token gültig ist.

Trigger

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
getEventType()	EventType	Gibt den Ereignistyp zurück, auf den der Trigger reagiert.
getHandlerFunction()	String	Gibt die Funktion zurück, die aufgerufen wird, wenn der Trigger ausgelöst wird.
getTriggerSource()	TriggerSource	Gibt die Quelle der Ereignisse zurück, die den Trigger auslösen.
getTriggerSourceId()	String	Gibt die spezifische ID der Quelle zurück.
getUniqueId()	String	Eine eindeutige Kennung, mit der sich Trigger voneinander unterscheiden lassen.

TriggerBuilder

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
forDocument(document)	DocumentTriggerBuilder	Erstellt und gibt einen DocumentTriggerBuilder zurück, der mit dem angegebenen Dokument verknüpft ist.
forDocument(key)	DocumentTriggerBuilder	Erstellt und gibt ein DocumentTriggerBuilder zurück, das mit dem Dokument mit der angegebenen ID verknüpft ist.
forForm(form)	FormTriggerBuilder	Erstellt und gibt einen FormTriggerBuilder zurück, der mit dem angegebenen Formular verknüpft ist.
forForm(key)	FormTriggerBuilder	Erstellt und gibt einen FormTriggerBuilder zurück, der mit dem Formular mit der angegebenen ID verknüpft ist.
forSpreadsheet(sheet)	SpreadsheetTriggerBuilder	Erstellt und gibt einen SpreadsheetTriggerBuilder zurück, der mit der angegebenen Tabelle verknüpft ist.
forSpreadsheet(key)	SpreadsheetTriggerBuilder	Erstellt und gibt ein SpreadsheetTriggerBuilder zurück, das mit der angegebenen ID mit der Tabelle verknüpft ist.
forUserCalendar(emailId)	CalendarTriggerBuilder	Gibt einen Builder zum Erstellen von Kalendertriggern zurück.
timeBased()	ClockTriggerBuilder	Erstellt und gibt eine ClockTriggerBuilder zum Erstellen zeitbasierter Trigger zurück.

TriggerSource

Attribute

Attribut	Typ	Beschreibung
SPREADSHEETS	Enum	Google Tabellen lösen den Trigger aus.
CLOCK	Enum	Ein zeitgesteuertes Ereignis löst den Trigger aus.
FORMS	Enum	Der Trigger wird durch Google Formulare ausgelöst.
DOCUMENTS	Enum	Google Docs löst den Trigger aus.
CALENDAR	Enum	Google Kalender löst den Trigger aus.