Base Service

Basis

Dieser Dienst bietet Zugriff auf Nutzerinformationen wie E-Mail-Adressen und Nutzernamen. Außerdem steuert es Script-Logs und Dialogfelder in Google Workspace-Anwendungen.

Klassen

Name	Kurzbeschreibung
Blob	Ein Datenaustauschobjekt für Apps Script-Dienste.
BlobSource	Benutzeroberfläche für Objekte, deren Daten als Blob exportiert werden können.
Browser	Diese Klasse bietet Zugriff auf Dialogfelder, die speziell für Google Tabellen gelten.
Button	Ein Enum, das vordefinierte, lokalisierte Dialogfeldschaltflächen darstellt, die von alert oder PromptResponse.getSelectedButton() zurückgegeben werden, um anzugeben, auf welche Schaltfläche im Dialogfeld der Nutzer geklickt hat.
ButtonSet	Ein Enum, das vordefinierte, lokalisierte Sätze von einer oder mehreren Dialogfeldschaltflächen darstellt, die einem alert oder prompt hinzugefügt werden können.
ColorType	Die Farbtypen
Logger	Mit dieser Klasse kann der Entwickler in das Ausführungsprotokoll und in Google Cloud Logging schreiben, wenn das Script mit einem Standard-Cloud-Projekt verknüpft ist.
Menu	Ein benutzerdefiniertes Menü in einer Instanz der Benutzeroberfläche einer Google-App.
MimeType	Eine Aufzählung, die Zugriff auf MIME-Typdeklarationen bietet, ohne die Strings explizit eingeben zu müssen.
Month	Ein Enum, das die Monate des Jahres darstellt.
PromptResponse	Eine Antwort auf ein prompt-Dialogfeld, das in der Benutzeroberfläche einer Google-App angezeigt wird.
RgbColor	Eine Farbe, die durch die Farbkanäle Rot, Grün und Blau definiert ist.
Session	Die Session-Klasse bietet Zugriff auf Sitzungsinformationen wie die E-Mail-Adresse des Nutzers (unter bestimmten Umständen) und die Spracheinstellung.
Ui	Eine Instanz der Benutzeroberfläche einer Google-App, mit der dem Script Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzugefügt werden können.
User	Darstellung eines Nutzers, geeignet für Scripting.
Weekday	Ein Enum, das die Wochentage darstellt.
console	Mit dieser Klasse kann der Entwickler in das Ausführungsprotokoll und in Google Cloud Logging schreiben, wenn das Script mit einem Standard-Cloud-Projekt verknüpft ist.

Blob

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
copyBlob()	Blob	Gibt eine Kopie dieses Blobs zurück.
getAs(contentType)	Blob	Gibt die Daten in diesem Objekt als Blob zurück, der in den angegebenen Inhaltstyp konvertiert wurde.
getBytes()	Byte[]	Ruft die in diesem Blob gespeicherten Daten ab.
getContentType()	String	Der Inhaltstyp der Bytes in diesem Blob.
getDataAsString()	String	Ruft die Daten dieses Blobs als String mit UTF-8-Codierung ab.
getDataAsString(charset)	String	Ruft die Daten dieses Blobs als String mit der angegebenen Codierung ab.
getName()	String	Ruft den Namen dieses Blobs ab.
isGoogleType()	Boolean	Gibt an, ob es sich bei diesem Blob um eine Google Workspace-Datei (z. B. Google Tabellen oder Google Docs) handelt.
setBytes(data)	Blob	Legt die in diesem Blob gespeicherten Daten fest.
setContentType(contentType)	Blob	Legt den Inhaltstyp der Bytes in diesem Blob fest.
setContentTypeFromExtension()	Blob	Legt den Inhaltstyp der Bytes in diesem Blob basierend auf der Dateiendung fest.
setDataFromString(string)	Blob	Die Daten dieses Blobs werden aus einem String mit UTF-8-Codierung festgelegt.
setDataFromString(string, charset)	Blob	Die Daten dieses Blobs werden aus einem String mit der angegebenen Codierung festgelegt.
setName(name)	Blob	Legt den Namen dieses Blobs fest.

BlobSource

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
getAs(contentType)	Blob	Gibt die Daten in diesem Objekt als Blob zurück, der in den angegebenen Inhaltstyp konvertiert wurde.
getBlob()	Blob	Gibt die Daten in diesem Objekt als Blob zurück.

Browser

Attribute

Attribut	Typ	Beschreibung
Buttons	ButtonSet

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
inputBox(prompt)	String	Im Browser des Nutzers wird ein Dialogfeld mit einem Textfeld angezeigt.
inputBox(prompt, buttons)	String	Im Browser des Nutzers wird ein Dialogfeld mit einem Textfeld angezeigt.
inputBox(title, prompt, buttons)	String	Im Browser des Nutzers wird ein Dialogfeld mit einem Textfeld angezeigt.
msgBox(prompt)	String	Im Browser des Nutzers wird ein Dialogfeld mit der angegebenen Nachricht und einer Schaltfläche „OK“ angezeigt.
msgBox(prompt, buttons)	String	Im Browser des Nutzers wird ein Dialogfeld mit der angegebenen Nachricht und den angegebenen Schaltflächen angezeigt.
msgBox(title, prompt, buttons)	String	Im Browser des Nutzers wird ein Dialogfeld mit dem angegebenen Titel, der Nachricht und den angegebenen Schaltflächen angezeigt.

Button

Attribute

Attribut	Typ	Beschreibung
CLOSE	Enum	Die standardmäßige Schaltfläche zum Schließen, die in der Titelleiste jedes Dialogfelds angezeigt wird.
OK	Enum	Eine Schaltfläche „OK“, die angibt, dass ein Vorgang fortgesetzt werden soll.
CANCEL	Enum	Eine Schaltfläche „Abbrechen“, die angibt, dass ein Vorgang nicht fortgesetzt werden soll.
YES	Enum	Eine Schaltfläche „Ja“, die eine positive Antwort auf eine Frage angibt.
NO	Enum	Eine Schaltfläche „Nein“, die eine negative Antwort auf eine Frage angibt.

ButtonSet

Attribute

Attribut	Typ	Beschreibung
OK	Enum	Eine einzelne Schaltfläche „OK“, die auf eine Informationsmeldung hinweist, die nur geschlossen werden kann.
OK_CANCEL	Enum	Eine Schaltfläche „OK“ und eine Schaltfläche „Abbrechen“, mit denen der Nutzer eine Aktion fortsetzen oder abbrechen kann.
YES_NO	Enum	Eine Schaltfläche „Ja“ und eine Schaltfläche „Nein“, mit denen Nutzer eine Ja-/Nein-Frage beantworten können.
YES_NO_CANCEL	Enum	Eine Schaltfläche „Ja“, eine Schaltfläche „Nein“ und eine Schaltfläche „Abbrechen“, mit denen Nutzer entweder eine Ja/Nein-Frage beantworten oder einen Vorgang beenden können.

ColorType

Attribute

Attribut	Typ	Beschreibung
UNSUPPORTED	Enum	Ein nicht unterstützter Farbtyp.
RGB	Enum	Eine Farbe, die durch die Farbkanäle Rot, Grün und Blau definiert ist.
THEME	Enum	Eine Farbe, die sich auf einen Eintrag im Farbschema des Designs bezieht.

Logger

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
clear()	void	Das Protokoll wird gelöscht.
getLog()	String	Gibt eine vollständige Liste der Nachrichten im aktuellen Protokoll zurück.
log(data)	Logger	Schreibt die Daten in das Protokoll.
log(format, values)	Logger	Schreibt einen formatierten String mit dem angegebenen Format und den angegebenen Werten in die Protokollkonsole.

Menu

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
addItem(caption, functionName)	Menu	Fügt dem Menü ein Element hinzu.
addSeparator()	Menu	Dem Menü wird ein visueller Trennstrich hinzugefügt.
addSubMenu(menu)	Menu	Fügt dem Menü ein Untermenü hinzu.
addToUi()	void	Das Menü wird in die Instanz der Benutzeroberfläche des Editors eingefügt.

MimeType

Attribute

Attribut	Typ	Beschreibung
GOOGLE_APPS_SCRIPT	Enum	Darstellung des MIME-Typs für ein Google Apps Script-Projekt.
GOOGLE_DRAWINGS	Enum	Darstellung des MIME-Typs für eine Google Drawings-Datei.
GOOGLE_DOCS	Enum	Darstellung des MIME-Typs für eine Google Docs-Datei.
GOOGLE_FORMS	Enum	Darstellung des MIME-Typs für eine Google Forms-Datei.
GOOGLE_SHEETS	Enum	Darstellung des MIME-Typs für eine Google Tabellen-Datei.
GOOGLE_SITES	Enum	Darstellung des MIME-Typs für eine Google Sites-Datei.
GOOGLE_SLIDES	Enum	Darstellung des MIME-Typs für eine Google Präsentationen-Datei.
FOLDER	Enum	Darstellung des MIME-Typs für einen Google Drive-Ordner.
SHORTCUT	Enum	Darstellung des MIME-Typs für eine Google Drive-Verknüpfung.
BMP	Enum	Darstellung des MIME-Typs für eine BMP-Bilddatei (in der Regel .bmp).
GIF	Enum	Darstellung des MIME-Typs für eine GIF-Bilddatei (in der Regel .gif).
JPEG	Enum	Darstellung des MIME-Typs für eine JPEG-Bilddatei (in der Regel .jpg).
PNG	Enum	Darstellung des MIME-Typs für eine PNG-Bilddatei (in der Regel .png).
SVG	Enum	Darstellung des MIME-Typs für eine SVG-Bilddatei (in der Regel .svg).
PDF	Enum	Darstellung des MIME-Typs für eine PDF-Datei (in der Regel .pdf).
CSS	Enum	Darstellung des MIME-Typs für eine CSS-Textdatei (in der Regel .css).
CSV	Enum	Darstellung des MIME-Typs für eine CSV-Textdatei (in der Regel .csv).
HTML	Enum	Darstellung des MIME-Typs für eine HTML-Textdatei (in der Regel .html).
JAVASCRIPT	Enum	Darstellung des MIME-Typs für eine JavaScript-Textdatei (in der Regel .js).
PLAIN_TEXT	Enum	Darstellung des MIME-Typs für eine reine Textdatei (in der Regel .txt).
RTF	Enum	Darstellung des MIME-Typs für eine Rich-Text-Datei (in der Regel .rtf).
OPENDOCUMENT_GRAPHICS	Enum	Darstellung des MIME-Typs für eine OpenDocument-Grafikdatei (in der Regel .odg).
OPENDOCUMENT_PRESENTATION	Enum	Darstellung des MIME-Typs für eine OpenDocument-Präsentationsdatei (in der Regel .odp).
OPENDOCUMENT_SPREADSHEET	Enum	Darstellung des MIME-Typs für eine OpenDocument-Tabellendatei (in der Regel .ods).
OPENDOCUMENT_TEXT	Enum	Darstellung des MIME-Typs für eine OpenDocument-Textverarbeitungsdatei (in der Regel .odt).
MICROSOFT_EXCEL	Enum	Darstellung des MIME-Typs für eine Microsoft Excel-Tabellendatei (in der Regel .xlsx).
MICROSOFT_EXCEL_LEGACY	Enum	Darstellung des MIME-Typs für eine alte Microsoft Excel-Datei (in der Regel .xls).
MICROSOFT_POWERPOINT	Enum	Darstellung des MIME-Typs für eine Microsoft PowerPoint-Präsentationsdatei (in der Regel .pptx).
MICROSOFT_POWERPOINT_LEGACY	Enum	Darstellung des MIME-Typs für eine ältere Microsoft PowerPoint-Datei (in der Regel .ppt).
MICROSOFT_WORD	Enum	Darstellung des MIME-Typs für eine Microsoft Word-Dokumentdatei (in der Regel .docx).
MICROSOFT_WORD_LEGACY	Enum	Darstellung des MIME-Typs für eine alte Microsoft Word-Datei (in der Regel .doc).
ZIP	Enum	Darstellung des MIME-Typs für eine ZIP-Archivdatei (normalerweise .zip).

Month

Attribute

Attribut	Typ	Beschreibung
JANUARY	Enum	Januar (Monat 1).
FEBRUARY	Enum	Februar (Monat 2)
MARCH	Enum	März (3. Monat)
APRIL	Enum	April (Monat 4)
MAY	Enum	Mai (5. Monat)
JUNE	Enum	Juni (6. Monat)
JULY	Enum	Juli (7. Monat).
AUGUST	Enum	August (Monat 8).
SEPTEMBER	Enum	September (9. Monat)
OCTOBER	Enum	Oktober (10. Monat)
NOVEMBER	Enum	November (11. Monat)
DECEMBER	Enum	Dezember (12. Monat).

PromptResponse

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
getResponseText()	String	Der Text, den der Nutzer in das Eingabefeld des Dialogfelds eingegeben hat.
getSelectedButton()	Button	Die Schaltfläche, auf die der Nutzer geklickt hat, um das Dialogfeld zu schließen.

RgbColor

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
asHexString()	String	Gibt die Farbe als 7- oder 9-stelliger Hexadezimal-String im CSS-Format (#rrggbb oder #aarrggbb) zurück.
getBlue()	Integer	Der Blaukanal dieser Farbe als Zahl zwischen 0 und 255.
getColorType()	ColorType	Den Typ dieser Farbe abrufen.
getGreen()	Integer	Der grüne Kanal dieser Farbe als Zahl zwischen 0 und 255.
getRed()	Integer	Der rote Kanal dieser Farbe als Zahl zwischen 0 und 255.

Session

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
getActiveUser()	User	Ruft Informationen zum aktuellen Nutzer ab.
getActiveUserLocale()	String	Die Spracheinstellung des aktuellen Nutzers als String, z. B. en für Englisch.
getEffectiveUser()	User	Ruft Informationen zum Nutzer ab, in dessen Autorisierungsbereich das Script ausgeführt wird.
getScriptTimeZone()	String	Ruft die Zeitzone des Scripts ab.
getTemporaryActiveUserKey()	String	Es wird ein temporärer Schlüssel abgerufen, der für den aktiven Nutzer eindeutig ist, aber die Identität des Nutzers nicht preisgibt.

Ui

Attribute

Attribut	Typ	Beschreibung
Button	Button	Ein Enum, das vordefinierte, lokalisierte Dialogfeldschaltflächen darstellt, die von einer Benachrichtigung oder PromptResponse.getSelectedButton() zurückgegeben werden, um anzugeben, auf welche Schaltfläche im Dialogfeld der Nutzer geklickt hat.
ButtonSet	ButtonSet	Ein Enum, das vordefinierte, lokalisierte Sätze von einer oder mehreren Dialogfeldschaltflächen darstellt, die einer Benachrichtigung oder einem Prompt hinzugefügt werden können.

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
alert(prompt)	Button	Öffnet im Editor des Nutzers ein Dialogfeld mit der angegebenen Nachricht und der Schaltfläche „Ok“.
alert(prompt, buttons)	Button	Öffnet im Editor des Nutzers ein Dialogfeld mit der angegebenen Nachricht und einer Reihe von Schaltflächen.
alert(title, prompt, buttons)	Button	Öffnet im Editor des Nutzers ein Dialogfeld mit dem angegebenen Titel, der Nachricht und einer Reihe von Schaltflächen.
createAddonMenu()	Menu	Erstellt ein Tool, mit dem ein Untermenü in das Menü „Erweiterungen“ des Editors eingefügt werden kann.
createMenu(caption)	Menu	Erstellt einen Builder, mit dem der Benutzeroberfläche des Editors ein Menü hinzugefügt werden kann.
prompt(prompt)	PromptResponse	Öffnet im Editor des Nutzers ein Eingabedialogfeld mit der angegebenen Nachricht und der Schaltfläche „Ok“.
prompt(prompt, buttons)	PromptResponse	Öffnet im Editor des Nutzers ein Eingabedialogfeld mit der angegebenen Nachricht und einer Reihe von Schaltflächen.
prompt(title, prompt, buttons)	PromptResponse	Öffnet im Editor des Nutzers ein Eingabedialogfeld mit dem angegebenen Titel, der Nachricht und einer Reihe von Schaltflächen.
showModalDialog(userInterface, title)	void	Öffnet im Editor des Nutzers ein modales Dialogfeld mit benutzerdefinierten clientseitigen Inhalten.
showModelessDialog(userInterface, title)	void	Öffnet im Editor des Nutzers ein modales Dialogfeld mit benutzerdefinierten clientseitigen Inhalten.
showSidebar(userInterface)	void	Öffnet im Editor des Nutzers eine Seitenleiste mit benutzerdefinierten clientseitigen Inhalten.

User

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
getEmail()	String	Ruft die E-Mail-Adresse des Nutzers ab, sofern verfügbar.

Weekday

Attribute

Attribut	Typ	Beschreibung
SUNDAY	Enum	Sonntag.
MONDAY	Enum	Montag.
TUESDAY	Enum	Dienstag.
WEDNESDAY	Enum	Mittwoch.
THURSDAY	Enum	Donnerstag.
FRIDAY	Enum	Freitag.
SATURDAY	Enum	Samstag.

console

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
error()	void	Gibt eine leere Nachricht der ERROR-Ebene an Stackdriver Logging aus.
error(formatOrObject, values)	void	Gibt eine Nachricht der ERROR-Ebene an Stackdriver Logging aus.
info()	void	Gibt eine leere Nachricht der INFO-Ebene an Stackdriver Logging aus.
info(formatOrObject, values)	void	Gibt eine Nachricht der INFO-Ebene an Stackdriver Logging aus.
log()	void	Gibt eine leere DEBUG-Ebene an Stackdriver Logging aus.
log(formatOrObject, values)	void	Gibt eine DEBUG-Ebene-Nachricht an Stackdriver Logging aus.
time(label)	void	Startet einen Timer, mit dem Sie die Dauer eines Vorgangs messen können.
timeEnd(label)	void	Beendet einen Timer, der zuvor durch Aufrufen von console.time() gestartet wurde.
warn()	void	Ergibt eine leere Nachricht der WARNUNGSebene in Stackdriver Logging.
warn(formatOrObject, values)	void	Gibt eine Nachricht der WARNUNGS-Ebene an Stackdriver Logging aus.