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

NameKurzbeschreibung
BlobEin Datenaustauschobjekt für Apps Script-Dienste.
BlobSourceBenutzeroberfläche für Objekte, deren Daten als Blob exportiert werden können.
BrowserDiese Klasse bietet Zugriff auf Dialogfelder, die speziell für Google Tabellen gelten.
ButtonEin 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.
ButtonSetEin Enum, das vordefinierte, lokalisierte Sätze von einer oder mehreren Dialogfeldschaltflächen darstellt, die einem alert oder prompt hinzugefügt werden können.
ColorTypeDie Farbtypen
LoggerMit 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.
MenuEin benutzerdefiniertes Menü in einer Instanz der Benutzeroberfläche einer Google-App.
MimeTypeEine Aufzählung, die Zugriff auf MIME-Typdeklarationen bietet, ohne die Strings explizit eingeben zu müssen.
MonthEin Enum, das die Monate des Jahres darstellt.
PromptResponseEine Antwort auf ein prompt-Dialogfeld, das in der Benutzeroberfläche einer Google-App angezeigt wird.
RgbColorEine Farbe, die durch die Farbkanäle Rot, Grün und Blau definiert ist.
SessionDie Session-Klasse bietet Zugriff auf Sitzungsinformationen wie die E-Mail-Adresse des Nutzers (unter bestimmten Umständen) und die Spracheinstellung.
UiEine Instanz der Benutzeroberfläche einer Google-App, mit der dem Script Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzugefügt werden können.
UserDarstellung eines Nutzers, geeignet für Scripting.
WeekdayEin Enum, das die Wochentage darstellt.
consoleMit 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

MethodeRückgabetypKurzbeschreibung
copyBlob()BlobGibt eine Kopie dieses Blobs zurück.
getAs(contentType)BlobGibt 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()StringDer Inhaltstyp der Bytes in diesem Blob.
getDataAsString()StringRuft die Daten dieses Blobs als String mit UTF-8-Codierung ab.
getDataAsString(charset)StringRuft die Daten dieses Blobs als String mit der angegebenen Codierung ab.
getName()StringRuft den Namen dieses Blobs ab.
isGoogleType()BooleanGibt an, ob es sich bei diesem Blob um eine Google Workspace-Datei (z. B. Google Tabellen oder Google Docs) handelt.
setBytes(data)BlobLegt die in diesem Blob gespeicherten Daten fest.
setContentType(contentType)BlobLegt den Inhaltstyp der Bytes in diesem Blob fest.
setContentTypeFromExtension()BlobLegt den Inhaltstyp der Bytes in diesem Blob basierend auf der Dateiendung fest.
setDataFromString(string)BlobDie Daten dieses Blobs werden aus einem String mit UTF-8-Codierung festgelegt.
setDataFromString(string, charset)BlobDie Daten dieses Blobs werden aus einem String mit der angegebenen Codierung festgelegt.
setName(name)BlobLegt den Namen dieses Blobs fest.

BlobSource

Methoden

MethodeRückgabetypKurzbeschreibung
getAs(contentType)BlobGibt die Daten in diesem Objekt als Blob zurück, der in den angegebenen Inhaltstyp konvertiert wurde.
getBlob()BlobGibt die Daten in diesem Objekt als Blob zurück.

Browser

Attribute

AttributTypBeschreibung
ButtonsButtonSet

Methoden

MethodeRückgabetypKurzbeschreibung
inputBox(prompt)StringIm Browser des Nutzers wird ein Dialogfeld mit einem Textfeld angezeigt.
inputBox(prompt, buttons)StringIm Browser des Nutzers wird ein Dialogfeld mit einem Textfeld angezeigt.
inputBox(title, prompt, buttons)StringIm Browser des Nutzers wird ein Dialogfeld mit einem Textfeld angezeigt.
msgBox(prompt)StringIm Browser des Nutzers wird ein Dialogfeld mit der angegebenen Nachricht und einer Schaltfläche „OK“ angezeigt.
msgBox(prompt, buttons)StringIm Browser des Nutzers wird ein Dialogfeld mit der angegebenen Nachricht und den angegebenen Schaltflächen angezeigt.
msgBox(title, prompt, buttons)StringIm Browser des Nutzers wird ein Dialogfeld mit dem angegebenen Titel, der Nachricht und den angegebenen Schaltflächen angezeigt.

Button

Attribute

AttributTypBeschreibung
CLOSEEnumDie standardmäßige Schaltfläche zum Schließen, die in der Titelleiste jedes Dialogfelds angezeigt wird.
OKEnumEine Schaltfläche „OK“, die angibt, dass ein Vorgang fortgesetzt werden soll.
CANCELEnumEine Schaltfläche „Abbrechen“, die angibt, dass ein Vorgang nicht fortgesetzt werden soll.
YESEnumEine Schaltfläche „Ja“, die eine positive Antwort auf eine Frage angibt.
NOEnumEine Schaltfläche „Nein“, die eine negative Antwort auf eine Frage angibt.

ButtonSet

Attribute

AttributTypBeschreibung
OKEnumEine einzelne Schaltfläche „OK“, die auf eine Informationsmeldung hinweist, die nur geschlossen werden kann.
OK_CANCELEnumEine Schaltfläche „OK“ und eine Schaltfläche „Abbrechen“, mit denen der Nutzer eine Aktion fortsetzen oder abbrechen kann.
YES_NOEnumEine Schaltfläche „Ja“ und eine Schaltfläche „Nein“, mit denen Nutzer eine Ja-/Nein-Frage beantworten können.
YES_NO_CANCELEnumEine 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

AttributTypBeschreibung
UNSUPPORTEDEnumEin nicht unterstützter Farbtyp.
RGBEnumEine Farbe, die durch die Farbkanäle Rot, Grün und Blau definiert ist.
THEMEEnumEine Farbe, die sich auf einen Eintrag im Farbschema des Designs bezieht.

Logger

Methoden

MethodeRückgabetypKurzbeschreibung
clear()voidDas Protokoll wird gelöscht.
getLog()StringGibt eine vollständige Liste der Nachrichten im aktuellen Protokoll zurück.
log(data)LoggerSchreibt die Daten in das Protokoll.
log(format, values)LoggerSchreibt einen formatierten String mit dem angegebenen Format und den angegebenen Werten in die Protokollkonsole.

Methoden

MethodeRückgabetypKurzbeschreibung
addItem(caption, functionName)MenuFügt dem Menü ein Element hinzu.
addSeparator()MenuDem Menü wird ein visueller Trennstrich hinzugefügt.
addSubMenu(menu)MenuFügt dem Menü ein Untermenü hinzu.
addToUi()voidDas Menü wird in die Instanz der Benutzeroberfläche des Editors eingefügt.

MimeType

Attribute

AttributTypBeschreibung
GOOGLE_APPS_SCRIPTEnumDarstellung des MIME-Typs für ein Google Apps Script-Projekt.
GOOGLE_DRAWINGSEnumDarstellung des MIME-Typs für eine Google Drawings-Datei.
GOOGLE_DOCSEnumDarstellung des MIME-Typs für eine Google Docs-Datei.
GOOGLE_FORMSEnumDarstellung des MIME-Typs für eine Google Forms-Datei.
GOOGLE_SHEETSEnumDarstellung des MIME-Typs für eine Google Tabellen-Datei.
GOOGLE_SITESEnumDarstellung des MIME-Typs für eine Google Sites-Datei.
GOOGLE_SLIDESEnumDarstellung des MIME-Typs für eine Google Präsentationen-Datei.
FOLDEREnumDarstellung des MIME-Typs für einen Google Drive-Ordner.
SHORTCUTEnumDarstellung des MIME-Typs für eine Google Drive-Verknüpfung.
BMPEnumDarstellung des MIME-Typs für eine BMP-Bilddatei (in der Regel .bmp).
GIFEnumDarstellung des MIME-Typs für eine GIF-Bilddatei (in der Regel .gif).
JPEGEnumDarstellung des MIME-Typs für eine JPEG-Bilddatei (in der Regel .jpg).
PNGEnumDarstellung des MIME-Typs für eine PNG-Bilddatei (in der Regel .png).
SVGEnumDarstellung des MIME-Typs für eine SVG-Bilddatei (in der Regel .svg).
PDFEnumDarstellung des MIME-Typs für eine PDF-Datei (in der Regel .pdf).
CSSEnumDarstellung des MIME-Typs für eine CSS-Textdatei (in der Regel .css).
CSVEnumDarstellung des MIME-Typs für eine CSV-Textdatei (in der Regel .csv).
HTMLEnumDarstellung des MIME-Typs für eine HTML-Textdatei (in der Regel .html).
JAVASCRIPTEnumDarstellung des MIME-Typs für eine JavaScript-Textdatei (in der Regel .js).
PLAIN_TEXTEnumDarstellung des MIME-Typs für eine reine Textdatei (in der Regel .txt).
RTFEnumDarstellung des MIME-Typs für eine Rich-Text-Datei (in der Regel .rtf).
OPENDOCUMENT_GRAPHICSEnumDarstellung des MIME-Typs für eine OpenDocument-Grafikdatei (in der Regel .odg).
OPENDOCUMENT_PRESENTATIONEnumDarstellung des MIME-Typs für eine OpenDocument-Präsentationsdatei (in der Regel .odp).
OPENDOCUMENT_SPREADSHEETEnumDarstellung des MIME-Typs für eine OpenDocument-Tabellendatei (in der Regel .ods).
OPENDOCUMENT_TEXTEnumDarstellung des MIME-Typs für eine OpenDocument-Textverarbeitungsdatei (in der Regel .odt).
MICROSOFT_EXCELEnumDarstellung des MIME-Typs für eine Microsoft Excel-Tabellendatei (in der Regel .xlsx).
MICROSOFT_EXCEL_LEGACYEnumDarstellung des MIME-Typs für eine alte Microsoft Excel-Datei (in der Regel .xls).
MICROSOFT_POWERPOINTEnumDarstellung des MIME-Typs für eine Microsoft PowerPoint-Präsentationsdatei (in der Regel .pptx).
MICROSOFT_POWERPOINT_LEGACYEnumDarstellung des MIME-Typs für eine ältere Microsoft PowerPoint-Datei (in der Regel .ppt).
MICROSOFT_WORDEnumDarstellung des MIME-Typs für eine Microsoft Word-Dokumentdatei (in der Regel .docx).
MICROSOFT_WORD_LEGACYEnumDarstellung des MIME-Typs für eine alte Microsoft Word-Datei (in der Regel .doc).
ZIPEnumDarstellung des MIME-Typs für eine ZIP-Archivdatei (normalerweise .zip).

Month

Attribute

AttributTypBeschreibung
JANUARYEnumJanuar (Monat 1).
FEBRUARYEnumFebruar (Monat 2)
MARCHEnumMärz (3. Monat)
APRILEnumApril (Monat 4)
MAYEnumMai (5. Monat)
JUNEEnumJuni (6. Monat)
JULYEnumJuli (7. Monat).
AUGUSTEnumAugust (Monat 8).
SEPTEMBEREnumSeptember (9. Monat)
OCTOBEREnumOktober (10. Monat)
NOVEMBEREnumNovember (11. Monat)
DECEMBEREnumDezember (12. Monat).

PromptResponse

Methoden

MethodeRückgabetypKurzbeschreibung
getResponseText()StringDer Text, den der Nutzer in das Eingabefeld des Dialogfelds eingegeben hat.
getSelectedButton()ButtonDie Schaltfläche, auf die der Nutzer geklickt hat, um das Dialogfeld zu schließen.

RgbColor

Methoden

MethodeRückgabetypKurzbeschreibung
asHexString()StringGibt die Farbe als 7- oder 9-stelliger Hexadezimal-String im CSS-Format (#rrggbb oder #aarrggbb) zurück.
getBlue()IntegerDer Blaukanal dieser Farbe als Zahl zwischen 0 und 255.
getColorType()ColorTypeDen Typ dieser Farbe abrufen.
getGreen()IntegerDer grüne Kanal dieser Farbe als Zahl zwischen 0 und 255.
getRed()IntegerDer rote Kanal dieser Farbe als Zahl zwischen 0 und 255.

Session

Methoden

MethodeRückgabetypKurzbeschreibung
getActiveUser()UserRuft Informationen zum aktuellen Nutzer ab.
getActiveUserLocale()StringDie Spracheinstellung des aktuellen Nutzers als String, z. B. en für Englisch.
getEffectiveUser()UserRuft Informationen zum Nutzer ab, in dessen Autorisierungsbereich das Script ausgeführt wird.
getScriptTimeZone()StringRuft die Zeitzone des Scripts ab.
getTemporaryActiveUserKey()StringEs 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

AttributTypBeschreibung
ButtonButtonEin 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.
ButtonSetButtonSetEin 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

MethodeRückgabetypKurzbeschreibung
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()MenuErstellt ein Tool, mit dem ein Untermenü in das Menü „Erweiterungen“ des Editors eingefügt werden kann.
createMenu(caption)MenuErstellt 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

MethodeRückgabetypKurzbeschreibung
getEmail()StringRuft die E-Mail-Adresse des Nutzers ab, sofern verfügbar.

Weekday

Attribute

AttributTypBeschreibung
SUNDAYEnumSonntag.
MONDAYEnumMontag.
TUESDAYEnumDienstag.
WEDNESDAYEnumMittwoch.
THURSDAYEnumDonnerstag.
FRIDAYEnumFreitag.
SATURDAYEnumSamstag.

console

Methoden

MethodeRückgabetypKurzbeschreibung
error()voidGibt eine leere Nachricht der ERROR-Ebene an Stackdriver Logging aus.
error(formatOrObject, values)voidGibt eine Nachricht der ERROR-Ebene an Stackdriver Logging aus.
info()voidGibt eine leere Nachricht der INFO-Ebene an Stackdriver Logging aus.
info(formatOrObject, values)voidGibt eine Nachricht der INFO-Ebene an Stackdriver Logging aus.
log()voidGibt eine leere DEBUG-Ebene an Stackdriver Logging aus.
log(formatOrObject, values)voidGibt eine DEBUG-Ebene-Nachricht an Stackdriver Logging aus.
time(label)voidStartet einen Timer, mit dem Sie die Dauer eines Vorgangs messen können.
timeEnd(label)voidBeendet einen Timer, der zuvor durch Aufrufen von console.time() gestartet wurde.
warn()voidErgibt eine leere Nachricht der WARNUNGSebene in Stackdriver Logging.
warn(formatOrObject, values)voidGibt eine Nachricht der WARNUNGS-Ebene an Stackdriver Logging aus.