Base Service

Basis

Dieser Dienst bietet Zugriff auf Nutzerinformationen wie E-Mail-Adressen und Nutzernamen. Außerdem werden Skriptprotokolle und Dialogfelder in Google Workspace-Anwendungen gesteuert.

Kurse

NameKurzbeschreibung
BlobEin Datenaustauschobjekt für Apps Script-Dienste.
BlobSourceSchnittstelle für Objekte, deren Daten als Blob exportiert werden können.
BrowserDiese Klasse bietet Zugriff auf Dialogfelder speziell für Google Tabellen.
ButtonEin Enum, das vordefinierte, lokalisierte Dialogfeldschaltflächen darstellt, die von alert oder PromptResponse.getSelectedButton() zurückgegeben und angegeben werden, auf welche Schaltfläche in einem Dialogfeld der Nutzer geklickt hat.
ButtonSetEin Enum, das vordefinierte, lokalisierte Sätze einer oder mehrerer Dialogfeldschaltflächen darstellt, die einem alert oder prompt hinzugefügt werden können.
ColorTypeDie Farbarten
LoggerMit dieser Klasse kann der Entwickler Text in die Fehlerbehebungsprotokolle schreiben.
MenuEin benutzerdefiniertes Menü in einer Instanz der Benutzeroberfläche für eine Google-App.
MimeTypeEine Aufzählung, die Zugriff auf MIME-Typ-Deklarationen ermöglicht, ohne die Strings explizit eingeben zu müssen.
MonthEin Enum-Wert, der die Monate des Jahres darstellt.
PromptResponseEine Antwort auf ein prompt-Dialogfeld, das in der Benutzeroberfläche einer Google-Anwendung angezeigt wird.
RgbColorEine Farbe, die durch rote, grüne und blaue Farbkanäle definiert wird.
SessionDie Session-Klasse bietet Zugriff auf Sitzungsinformationen wie die E-Mail-Adresse des Nutzers (unter Umständen) und die Spracheinstellung.
UiEine Instanz der Benutzeroberflächenumgebung für eine Google-Anwendung, mit der das Skript Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzufügen kann.
UserDarstellung eines Nutzers, geeignet für Skripterstellung
WeekdayEin Enum-Wert, der die Wochentage darstellt.
consoleDiese Klasse ermöglicht es dem Entwickler, Logs in den Stackdriver Logging-Dienst der Google Cloud Platform zu schreiben.

Blob

Methoden

MethodeRückgabetypKurzbeschreibung
copyBlob()BlobGibt eine Kopie dieses Blobs zurück.
getAs(contentType)BlobGibt die Daten in diesem Objekt als Blob zurück, das in den angegebenen Inhaltstyp konvertiert wurde.
getBytes()Byte[]Ruft die in diesem Blob gespeicherten Daten ab.
getContentType()StringRuft den Inhaltstyp der Byte in diesem Blob ab.
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 zurück, ob dieses Blob eine Google Workspace-Datei (Google Tabellen, Google Docs usw.) ist.
setBytes(data)BlobLegt die in diesem Blob gespeicherten Daten fest.
setContentType(contentType)BlobLegt den Inhaltstyp der Byte in diesem Blob fest.
setContentTypeFromExtension()BlobLegt den Inhaltstyp der Byte in diesem Blob basierend auf der Dateiendung fest.
setDataFromString(string)BlobLegt die Daten dieses Blobs aus einem String mit UTF-8-Codierung fest.
setDataFromString(string, charset)BlobLegt die Daten dieses Blobs aus einem String mit der angegebenen Codierung fest.
setName(name)BlobLegt den Namen dieses Blobs fest.

BlobSource

Methoden

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

Browser

Attribute

PropertyTypBeschreibung
ButtonsButtonSet

Methoden

MethodeRückgabetypKurzbeschreibung
inputBox(prompt)StringÖffnet ein Dialogfeld mit einem Texteingabefeld im Browser des Nutzers.
inputBox(prompt, buttons)StringÖffnet ein Dialogfeld mit einem Texteingabefeld im Browser des Nutzers.
inputBox(title, prompt, buttons)StringÖffnet ein Dialogfeld mit einem Texteingabefeld im Browser des Nutzers.
msgBox(prompt)StringÖffnet ein Dialogfeld mit der angegebenen Meldung und einer OK-Schaltfläche im Browser des Nutzers.
msgBox(prompt, buttons)StringÖffnet ein Dialogfeld mit der angegebenen Nachricht und angegebenen Schaltflächen im Browser des Nutzers.
msgBox(title, prompt, buttons)StringÖffnet ein Dialogfeld mit dem angegebenen Titel, der Nachricht und den angegebenen Schaltflächen im Browser des Nutzers.

Button

Attribute

PropertyTypBeschreibung
CLOSEEnumDie standardmäßige Schließen-Schaltfläche, die in der Titelleiste jedes Dialogfelds angezeigt wird.
OKEnumSchaltfläche „OK“, die angibt, dass ein Vorgang fortgesetzt werden soll.
CANCELEnumSchaltfläche „Abbrechen“ mit dem Hinweis, dass der Vorgang nicht fortgesetzt werden soll.
YESEnumEine „Ja“-Schaltfläche für eine positive Antwort auf eine Frage.
NOEnumEine „Nein“-Schaltfläche für eine negative Antwort auf eine Frage.

ButtonSet

Attribute

PropertyTypBeschreibung
OKEnumEine einzelne „OK“-Schaltfläche für eine Informationsmeldung, die nur geschlossen werden kann.
OK_CANCELEnumEine Schaltfläche „OK“ und eine Schaltfläche „Abbrechen“, über die der Nutzer einen Vorgang entweder fortsetzen oder anhalten kann.
YES_NOEnumEine „Ja“- und eine „Nein“-Schaltfläche, über die der Nutzer eine Ja/Nein-Frage beantworten kann.
YES_NO_CANCELEnumEine „Ja“-, eine „Nein“- und eine „Abbrechen“-Schaltfläche, mit denen der Nutzer entweder eine Ja/Nein-Frage beantworten oder einen Vorgang anhalten kann.

ColorType

Attribute

PropertyTypBeschreibung
UNSUPPORTEDEnumEin Farbtyp, der nicht unterstützt wird.
RGBEnumEine Farbe, die durch rote, grüne und blaue Farbkanäle definiert wird.
THEMEEnumEine Farbe, die sich auf einen Eintrag im Farbschema des Designs bezieht.

Logger

Methoden

MethodeRückgabetypKurzbeschreibung
clear()voidLöscht das Protokoll.
getLog()StringGibt eine vollständige Liste der Nachrichten im aktuellen Log zurück.
log(data)LoggerSchreibt den String in die Logging-Konsole.
log(format, values)LoggerSchreibt einen formatierten String in die Logging-Konsole. Dabei werden das angegebene Format und die angegebenen Werte verwendet.

Methoden

MethodeRückgabetypKurzbeschreibung
addItem(caption, functionName)MenuFügt dem Menü ein Element hinzu.
addSeparator()MenuFügt dem Menü ein visuelles Trennzeichen hinzu.
addSubMenu(menu)MenuFügt dem Menü ein Untermenü hinzu.
addToUi()voidFügt das Menü in die Instanz der Benutzeroberfläche des Editors ein.

MimeType

Attribute

PropertyTypBeschreibung
GOOGLE_APPS_SCRIPTEnumDarstellung des MIME-Typs für ein Google Apps Script-Projekt.
GOOGLE_DRAWINGSEnumDarstellung des MIME-Typs für eine Google Zeichnungen-Datei
GOOGLE_DOCSEnumDarstellung des MIME-Typs für eine Google Docs-Datei.
GOOGLE_FORMSEnumDarstellung des MIME-Typs für eine Google Formulare-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-Image-Datei (normalerweise .bmp)
GIFEnumDarstellung des MIME-Typs für eine GIF-Image-Datei (normalerweise .gif).
JPEGEnumDarstellung des MIME-Typs für eine JPEG-Bilddatei (normalerweise .jpg).
PNGEnumDarstellung des MIME-Typs für eine PNG-Bilddatei (normalerweise .png).
SVGEnumDarstellung des MIME-Typs für eine SVG-Bilddatei (normalerweise .svg)
PDFEnumDarstellung des MIME-Typs für eine PDF-Datei (normalerweise .pdf)
CSSEnumDarstellung des MIME-Typs für eine CSS-Textdatei (normalerweise .css)
CSVEnumDarstellung des MIME-Typs für eine CSV-Textdatei (normalerweise .csv).
HTMLEnumDarstellung des MIME-Typs für eine HTML-Textdatei (normalerweise .html).
JAVASCRIPTEnumDarstellung des MIME-Typs für eine JavaScript-Textdatei (normalerweise .js)
PLAIN_TEXTEnumDarstellung des MIME-Typs für eine Nur-Text-Datei (normalerweise .txt).
RTFEnumDarstellung des MIME-Typs für eine Rich-Text-Datei (normalerweise .rtf).
OPENDOCUMENT_GRAPHICSEnumDarstellung des MIME-Typs für eine OpenDocument-Grafikdatei (normalerweise .odg).
OPENDOCUMENT_PRESENTATIONEnumDarstellung des MIME-Typs für eine OpenDocument-Präsentationsdatei (normalerweise .odp).
OPENDOCUMENT_SPREADSHEETEnumDarstellung des MIME-Typs für eine OpenDocument-Tabellendatei (normalerweise .ods).
OPENDOCUMENT_TEXTEnumDarstellung des MIME-Typs für eine OpenDocument-Textverarbeitungsdatei (normalerweise .odt).
MICROSOFT_EXCELEnumDarstellung des MIME-Typs für eine Microsoft Excel-Tabellenkalkulationsdatei (normalerweise .xlsx)
MICROSOFT_EXCEL_LEGACYEnumDarstellung des MIME-Typs für eine alte Microsoft Excel-Datei (normalerweise XLS)
MICROSOFT_POWERPOINTEnumDarstellung des MIME-Typs für eine Microsoft PowerPoint-Präsentationsdatei (normalerweise PPTX).
MICROSOFT_POWERPOINT_LEGACYEnumDarstellung des MIME-Typs für eine alte Microsoft PowerPoint-Datei (normalerweise .ppt)
MICROSOFT_WORDEnumDarstellung des MIME-Typs für eine Microsoft Word-Dokumentdatei (normalerweise .docx).
MICROSOFT_WORD_LEGACYEnumDarstellung des MIME-Typs für eine alte Microsoft Word-Datei (normalerweise .doc).
ZIPEnumDarstellung des MIME-Typs für eine ZIP-Archivdatei (normalerweise .zip).

Month

Attribute

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

PromptResponse

Methoden

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

RgbColor

Methoden

MethodeRückgabetypKurzbeschreibung
asHexString()StringGibt die Farbe als Hexadezimalstring mit 7 Zeichen im CSS-Stil (#rrggbb) oder als Hexadezimalstring mit 9 Zeichen (#aarrggbb) zurück.
getBlue()IntegerDer Blaukanal dieser Farbe als Zahl von 0 bis 255.
getColorType()ColorTypeRuft den Typ dieser Farbe ab.
getGreen()IntegerDer grüne Kanal dieser Farbe als Zahl zwischen 0 und 255.
getRed()IntegerDer rote Kanal dieser Farbe als Zahl von 0 bis 255.

Session

Methoden

MethodeRückgabetypKurzbeschreibung
getActiveUser()UserRuft Informationen zum aktuellen Nutzer ab.
getActiveUserLocale()StringRuft die Spracheinstellung des aktuellen Nutzers als String ab, z. B. en für Englisch.
getEffectiveUser()UserRuft Informationen zu dem Nutzer ab, unter dessen Aufsicht das Skript ausgeführt wird.
getScriptTimeZone()StringZeitzone des Skripts abrufen.
getTemporaryActiveUserKey()StringRuft einen temporären Schlüssel ab, der für den aktiven Nutzer eindeutig ist, aber die Nutzeridentität nicht offengelegt.

Ui

Attribute

PropertyTypBeschreibung
ButtonButtonEine Aufzählung, die vordefinierte, lokalisierte Schaltflächen des Dialogfelds darstellt, die von einer Warnung oder einem PromptResponse.getSelectedButton() zurückgegeben werden, um anzugeben, auf welche Schaltfläche in einem Dialogfeld der Nutzer geklickt hat.
ButtonSetButtonSetEin Enum, das vordefinierte, lokalisierte Sätze einer oder mehrerer Dialogfeldschaltflächen darstellt, die einer Warnung oder einer Aufforderung hinzugefügt werden können.

Methoden

MethodeRückgabetypKurzbeschreibung
alert(prompt)ButtonÖffnet ein Dialogfeld mit der angegebenen Meldung und der Schaltfläche „OK“ im Editor des Nutzers.
alert(prompt, buttons)ButtonÖffnet ein Dialogfeld mit der angegebenen Meldung und einer Reihe von Schaltflächen im Editor des Nutzers.
alert(title, prompt, buttons)ButtonÖffnet im Nutzereditor ein Dialogfeld mit dem angegebenen Titel, der Nachricht und einer Reihe von Schaltflächen.
createAddonMenu()MenuErstellt einen Builder, mit dem ein Untermenü in das Menü „Erweiterungen“ des Editors eingefügt werden kann.
createMenu(caption)MenuErstellt einen Builder, mit dem ein Menü zur Benutzeroberfläche des Editors hinzugefügt werden kann.
prompt(prompt)PromptResponseÖffnet ein Dialogfeld zur Eingabe im Editor des Nutzers mit der angegebenen Meldung und der Schaltfläche „OK“.
prompt(prompt, buttons)PromptResponseÖffnet ein Dialogfeld zur Eingabe der Eingabe im Editor des Nutzers mit der angegebenen Meldung und einer Reihe von Schaltflächen.
prompt(title, prompt, buttons)PromptResponseÖffnet ein Dialogfeld zur Eingabe im Editor des Nutzers mit dem angegebenen Titel, der Nachricht und den Schaltflächen.
showModalDialog(userInterface, title)voidÖffnet ein modales Dialogfeld im Nutzereditor mit benutzerdefiniertem clientseitigem Inhalt.
showModelessDialog(userInterface, title)voidÖffnet im Nutzereditor ein Dialogfeld ohne Modus mit benutzerdefiniertem clientseitigem Inhalt.
showSidebar(userInterface)voidÖffnet im Editor des Nutzers eine Seitenleiste mit benutzerdefiniertem clientseitigem Inhalt.

User

Methoden

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

Weekday

Attribute

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

console

Methoden

MethodeRückgabetypKurzbeschreibung
error()voidGibt eine leere Meldung der Ebene FEHLER an Stackdriver Logging aus.
error(formatOrObject, values)voidGibt eine Meldung auf der Ebene FEHLER an Stackdriver Logging aus.
info()voidGibt eine leere Nachricht auf INFO-Ebene an Stackdriver Logging aus.
info(formatOrObject, values)voidGibt eine Nachricht auf INFO-Ebene an Stackdriver Logging aus.
log()voidGibt eine leere Nachricht auf FEHLERBEHEBUNG an Stackdriver Logging aus.
log(formatOrObject, values)voidGibt eine Nachricht auf Debug-Ebene an Stackdriver Logging aus.
time(label)voidStartet einen Timer, mit dem Sie die Dauer eines Vorgangs verfolgen können.
timeEnd(label)voidStoppt einen zuvor gestarteten Timer durch Aufrufen von console.time().
warn()voidGibt eine leere Meldung der Ebene WARNUNG an Stackdriver Logging aus.
warn(formatOrObject, values)voidGibt eine Nachricht der Ebene WARNUNG an Stackdriver Logging aus.