Script Service

Script

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

Kurse

Name	Kurzbeschreibung
AuthMode	Eine Aufzählung, die angibt, welche Kategorien autorisierter Dienste Apps Script über eine ausgelöste Funktion ausführen kann.
AuthorizationInfo	Ein 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.
AuthorizationStatus	Eine Aufzählung, die den Autorisierungsstatus eines Skripts angibt.
CalendarTriggerBuilder	Builder für Kalendertrigger
ClockTriggerBuilder	Ein Builder für Uhrauslö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 Skript als Add-on für den aktuellen Nutzer installiert wurde.
ScriptApp	Skriptveröffentlichung und Trigger aufrufen und bearbeiten
Service	Auf die Skriptveröffentlichung zugreifen und sie bearbeiten
SpreadsheetTriggerBuilder	Builder für Tabellentrigger
StateTokenBuilder	Ermöglicht Skripts das Erstellen von Statustokens, die in Callback-APIs (z. B. OAuth-Abläufen) verwendet werden können.
Trigger	Ein Skript-Trigger.
TriggerBuilder	Ein allgemeiner Builder für Skript-Trigger.
TriggerSource	Eine Aufzählung, die die Quelle des Ereignisses angibt, das den Trigger auslöst.

AuthMode

Attribute

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

AuthorizationInfo

Methoden

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

AuthorizationStatus

Attribute

Property	Typ	Beschreibung
REQUIRED	Enum	Der Nutzer muss dieses Skript autorisieren, einen oder mehrere Dienste zu verwenden.
NOT_REQUIRED	Enum	Der Nutzer hat diesem Skript 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) nach der aktuellen Zeit an, zu der der Trigger 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	Gibt an, dass der Trigger alle n Minuten ausgeführt wird.
everyWeeks(n)	ClockTriggerBuilder	Gibt an, dass der Trigger alle n Wochen ausgeführt werden soll.
inTimezone(timezone)	ClockTriggerBuilder	Gibt die Zeitzone für das angegebene Datum und die angegebene Uhrzeit an, wenn der Trigger ausgeführt wird.
nearMinute(minute)	ClockTriggerBuilder	Gibt die Minute an, in 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 den neuen Trigger und gibt ihn zurück.
onOpen()	DocumentTriggerBuilder	Gibt einen Trigger an, der beim Öffnen des Dokuments ausgelöst wird.

EventType

Attribute

Property	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 Datei in Google Docs, Google Tabellen oder Google Formulare öffnet.
ON_EDIT	Enum	Der 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_SUBMIT	Enum	Der Trigger wird ausgelöst, sobald der Nutzer auf ein Google-Formular geantwortet hat.
ON_CHANGE	Enum	Der 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_UPDATED	Enum	Der Trigger wird ausgelöst, wenn im angegebenen Google-Kalender ein Termin erstellt, aktualisiert oder gelöscht wird.

FormTriggerBuilder

Methoden

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

InstallationSource

Attribute

Property	Typ	Beschreibung
APPS_MARKETPLACE_DOMAIN_ADD_ON	Enum	Das Add-on wurde vom Administrator für die Domain des Nutzers installiert.
NONE	Enum	Das Skript 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

Property	Typ	Beschreibung
AuthMode	AuthMode	Eine Aufzählung, die angibt, welche Kategorien autorisierter Dienste Apps Script über eine ausgelöste Funktion ausführen kann.
AuthorizationStatus	AuthorizationStatus	Eine Aufzählung, die den Autorisierungsstatus eines Skripts angibt.
EventType	EventType	Eine Aufzählung, die den Typ des ausgelösten Ereignisses angibt.
InstallationSource	InstallationSource	Eine Aufzählung, die angibt, wie das Skript für den Nutzer als Add-on 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	Entfernt den angegebenen Trigger, sodass er nicht mehr ausgeführt wird.
getAuthorizationInfo(authMode)	AuthorizationInfo	Ruft 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()	String	Ruft ein OpenID Connect-Identitätstoken für den aktiven Nutzer ab, wenn der Bereich openid gewährt wurde.
getInstallationSource()	InstallationSource	Gibt 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()	String	Ruft 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()	String	Ruft die eindeutige ID des Skriptprojekts ab.
getService()	Service	Ruft 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()	void	Ungültig macht die Autorisierung, die der aktive Nutzer zum Ausführen des aktuellen Skripts 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	Startet den Prozess der Erstellung eines installierbaren Triggers, 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 auf das Skript als Webanwendung zugegriffen werden kann.

SpreadsheetTriggerBuilder

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
create()	Trigger	Erstellt den Trigger und gibt ihn zurück.
onChange()	SpreadsheetTriggerBuilder	Gibt einen Trigger an, der ausgelöst wird, wenn sich der Inhalt oder die Struktur der Tabelle ändert.
onEdit()	SpreadsheetTriggerBuilder	Gibt einen Trigger an, der beim Bearbeiten der Tabelle ausgelöst wird.
onFormSubmit()	SpreadsheetTriggerBuilder	Gibt einen Trigger an, der ausgelöst wird, wenn ein Formular an die Tabelle gesendet wird.
onOpen()	SpreadsheetTriggerBuilder	Gibt einen Trigger an, der beim Öffnen der Tabelle ausgelöst 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	Legt eine Callback-Funktion fest.
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, bei dem der Trigger ausgelöst wird.
getHandlerFunction()	String	Gibt die Funktion zurück, die beim Auslösen des Triggers aufgerufen wird.
getTriggerSource()	TriggerSource	Gibt die Quelle der Ereignisse zurück, die den Trigger auslösen
getTriggerSourceId()	String	Gibt die für die Quelle spezifische ID zurück
getUniqueId()	String	Gibt eine eindeutige Kennung zurück, mit der Trigger voneinander unterschieden werden können.

TriggerBuilder

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
forDocument(document)	DocumentTriggerBuilder	Erstellt und gibt eine DocumentTriggerBuilder zurück, die 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 ein FormTriggerBuilder zurück, das mit dem angegebenen Formular verknüpft ist.
forForm(key)	FormTriggerBuilder	Erstellt und gibt ein FormTriggerBuilder zurück, das mit dem Formular mit der angegebenen ID verknüpft ist.
forSpreadsheet(sheet)	SpreadsheetTriggerBuilder	Erstellt und gibt eine SpreadsheetTriggerBuilder für die angegebene Tabelle zurück.
forSpreadsheet(key)	SpreadsheetTriggerBuilder	Erstellt und gibt eine SpreadsheetTriggerBuilder zurück, die mit der Tabelle mit der angegebenen ID verknüpft ist.
forUserCalendar(emailId)	CalendarTriggerBuilder	Gibt einen Builder zum Erstellen von Kalendertriggern zurück.
timeBased()	ClockTriggerBuilder	Erstellt ein ClockTriggerBuilder zum Erstellen zeitbasierter Trigger und gibt es zurück.

TriggerSource

Attribute

Property	Typ	Beschreibung
SPREADSHEETS	Enum	In Google Tabellen wird der Trigger ausgelöst.
CLOCK	Enum	Ein zeitgesteuertes Ereignis löst den Trigger aus.
FORMS	Enum	Google Formulare führt dazu, dass der Trigger ausgelöst wird.
DOCUMENTS	Enum	Google Docs führt dazu, dass der Trigger ausgelöst wird.
CALENDAR	Enum	In Google Kalender wird der Trigger ausgelöst.