Base Service

Basis

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

Klassen

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 Google Sheets-spezifische Dialogfelder.
ButtonEin Enum, das vordefinierte, lokalisierte Schaltflächen in Dialogfeldern darstellt, die von einem alert oder PromptResponse.getSelectedButton() zurückgegeben werden, um anzugeben, auf welche Schaltfläche in einem Dialogfeld der Nutzer geklickt hat.
ButtonSetEin Enum, das vordefinierte, lokalisierte Gruppen aus einem oder mehreren Schaltflächen darstellt, die einem alert oder einem prompt hinzugefügt werden können.
ColorTypeArten von Farben
LoggerMit dieser Klasse kann der Entwickler in das Ausführungsprotokoll und in Google Cloud Logging schreiben, wenn das Skript mit einem Standard-Cloud-Projekt verknüpft ist.
MenuEin benutzerdefiniertes Menü in einer Instanz der Benutzeroberfläche für eine Google-App.
MimeTypeEine Aufzählung, die Zugriff auf MIME-Typ-Deklarationen bietet, ohne dass die Strings explizit eingegeben werden 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 wird.
SessionDie Klasse „Session“ bietet Zugriff auf Sitzungsinformationen wie die E-Mail-Adresse des Nutzers (unter bestimmten Umständen) und die Spracheinstellung.
UiEine Instanz der Benutzeroberflächenumgebung für eine Google-App, mit der dem Skript Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzugefügt werden können.
UserDarstellung eines Nutzers, die sich für die Scripting-Verwendung eignet.
WeekdayEin Enum, das die Wochentage darstellt.
consoleMit dieser Klasse kann der Entwickler in das Ausführungsprotokoll und in Google Cloud Logging schreiben, wenn das Skript 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, 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 dieser Blob eine Google Workspace-Datei (Sheets, 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 Bytes 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

AttributTypBeschreibung
ButtonsButtonSet

Methoden

MethodeRückgabetypKurzbeschreibung
inputBox(prompt)String|nullEs wird ein Dialogfeld mit einem Texteingabefeld im Browser des Nutzers eingeblendet.
inputBox(prompt, buttons)String|nullEs wird ein Dialogfeld mit einem Texteingabefeld im Browser des Nutzers eingeblendet.
inputBox(title, prompt, buttons)String|nullEs wird ein Dialogfeld mit einem Texteingabefeld im Browser des Nutzers eingeblendet.
msgBox(prompt)String|nullEs wird ein Dialogfeld mit der angegebenen Nachricht und einer Schaltfläche „OK“ im Browser des Nutzers eingeblendet.
msgBox(prompt, buttons)String|nullEs wird ein Dialogfeld mit der angegebenen Nachricht und den angegebenen Schaltflächen im Browser des Nutzers eingeblendet.
msgBox(title, prompt, buttons)String|nullEs wird ein Dialogfeld mit dem angegebenen Titel, der Nachricht und den angegebenen Schaltflächen im Browser des Nutzers eingeblendet.

Button

Attribute

AttributTypBeschreibung
CLOSEEnumDie Standardschaltfläche zum Schließen, die in der Titelleiste jedes Dialogfelds angezeigt wird.
OKEnumEine „OK“-Schaltfläche, 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 „OK“-Schaltfläche und eine „Abbrechen“-Schaltfläche, über die der Nutzer einen Vorgang fortsetzen oder beenden kann.
YES_NOEnumEine „Ja“- und eine „Nein“-Schaltfläche, über die der Nutzer eine Ja-/Nein-Frage beantworten kann.
YES_NO_CANCELEnumEine Schaltfläche „Ja“, eine Schaltfläche „Nein“ und eine Schaltfläche „Abbrechen“, mit denen der Nutzer entweder eine Ja-/Nein-Frage beantworten oder einen Vorgang beenden kann.

ColorType

Attribute

AttributTypBeschreibung
UNSUPPORTEDEnumEin Farbtyp, der nicht unterstützt wird.
RGBEnumEine Farbe, die durch die Farbkanäle Rot, Grün und Blau 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 die Daten in das Log.
log(format, values)LoggerSchreibt einen formatierten String in die Logging-Konsole, wobei das angegebene Format und die angegebenen Werte verwendet werden.

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

AttributTypBeschreibung
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-Formular-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 Nur-Text-Datei (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 alte 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 (in der Regel .zip).

Month

Attribute

AttributTypBeschreibung
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()ButtonGibt die Schaltfläche zurück, auf die der Nutzer geklickt hat, um das Dialogfeld zu schließen.

RgbColor

Methoden

MethodeRückgabetypKurzbeschreibung
asHexString()StringGibt die Farbe als 7-stelligen hexadezimalen String im CSS-Stil (#rrggbb) oder als 9-stelligen hexadezimalen String (#aarrggbb) zurück.
getBlue()IntegerDer Blaukanal dieser Farbe als Zahl zwischen 0 und 255.
getColorType()ColorTypeGibt den Typ dieser Farbe zurück.
getGreen()IntegerDer Grünkanal dieser Farbe als Zahl zwischen 0 und 255.
getRed()IntegerDer Rotkanal dieser Farbe als Zahl zwischen 0 und 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 zum Nutzer ab, unter dessen Autorität das Script ausgeführt wird.
getScriptTimeZone()StringRuft die Zeitzone des Skripts ab.
getTemporaryActiveUserKey()StringRuft einen temporären Schlüssel ab, der für den aktiven Nutzer eindeutig ist, aber die Nutzeridentität nicht offenbart.

Ui

Attribute

AttributTypBeschreibung
ButtonButtonEin Enum, das vordefinierte, lokalisierte Dialogschaltflächen darstellt, die von einem alert oder PromptResponse.getSelectedButton() zurückgegeben werden, um anzugeben, auf welche Schaltfläche in einem Dialogfeld der Nutzer geklickt hat.
ButtonSetButtonSetEin Enum, das vordefinierte, lokalisierte Gruppen aus einem oder mehreren Dialogfeldschaltflächen darstellt, die einem Hinweis oder einer Aufforderung hinzugefügt werden können.

Methoden

MethodeRückgabetypKurzbeschreibung
alert(prompt)ButtonÖffnet im Editor des Nutzers ein Dialogfeld mit der angegebenen Nachricht und einer Schaltfläche „OK“.
alert(prompt, buttons)ButtonÖffnet ein Dialogfeld im Editor des Nutzers mit der angegebenen Nachricht und den angegebenen Schaltflächen.
alert(title, prompt, buttons)ButtonÖffnet im Editor des Nutzers ein Dialogfeld mit dem angegebenen Titel, der angegebenen Nachricht und den angegebenen 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 der Benutzeroberfläche des Editors ein Menü hinzugefügt werden kann.
prompt(prompt)PromptResponseÖffnet im Editor des Nutzers ein Eingabedialogfeld mit der angegebenen Meldung und einer Schaltfläche „OK“.
prompt(prompt, buttons)PromptResponseÖffnet ein Eingabedialogfeld im Editor des Nutzers mit der angegebenen Nachricht und den angegebenen Schaltflächen.
prompt(title, prompt, buttons)PromptResponseÖffnet im Editor des Nutzers ein Eingabedialogfeld mit dem angegebenen Titel, der angegebenen Nachricht und den angegebenen Schaltflächen.
showModalDialog(userInterface, title)voidÖffnet ein modales Dialogfeld im Editor des Nutzers mit benutzerdefinierten clientseitigen Inhalten.
showModelessDialog(userInterface, title)voidÖffnet ein nicht modales Dialogfeld im Editor des Nutzers mit benutzerdefinierten clientseitigen Inhalten.
showSidebar(userInterface)voidÖffnet eine Seitenleiste im Editor des Nutzers 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 Meldung auf ERROR-Ebene an Stackdriver Logging aus.
error(formatOrObject, values)voidGibt eine Meldung auf ERROR-Ebene an Stackdriver Logging aus.
info()voidGibt eine leere Meldung auf INFO-Ebene an Stackdriver Logging aus.
info(formatOrObject, values)voidGibt eine Meldung auf INFO-Ebene an Stackdriver Logging aus.
log()voidGibt eine leere Meldung auf DEBUG-Ebene an Stackdriver Logging aus.
log(formatOrObject, values)voidGibt eine Meldung auf DEBUG-Ebene in Stackdriver Logging aus.
time(label)voidStartet einen Timer, mit dem Sie die Dauer eines Vorgangs erfassen können.
timeEnd(label)voidBeendet einen Timer, der zuvor durch den Aufruf von console.time() gestartet wurde.
warn()voidGibt eine leere Meldung auf WARNUNG-Ebene an Stackdriver Logging aus.
warn(formatOrObject, values)voidGibt eine Meldung der WARNUNG-Ebene in Stackdriver Logging aus.