Base Service

Base

Ce service permet d'accéder aux informations utilisateur, comme les adresses e-mail et les noms d'utilisateur. Il contrôle également les journaux de script et les boîtes de dialogue dans les applications Google Workspace.

Classes

NomBrève description
BlobObjet d'échange de données pour les services Apps Script.
BlobSourceInterface pour les objets qui peuvent exporter leurs données en tant que Blob.
BrowserCette classe permet d'accéder aux boîtes de dialogue spécifiques à Google Sheets.
ButtonÉnumération représentant les boutons de boîte de dialogue prédéterminés et localisés renvoyés par un alert ou un PromptResponse.getSelectedButton() pour indiquer le bouton sur lequel l'utilisateur a cliqué dans une boîte de dialogue.
ButtonSetÉnumération représentant des ensembles prédéterminés et localisés d'un ou plusieurs boutons de boîte de dialogue pouvant être ajoutés à un alert ou un prompt.
ColorTypeTypes de couleurs
LoggerCette classe permet au développeur d'écrire dans le journal d'exécution et dans Google Cloud Logging si le script est associé à un projet Cloud standard.
MenuMenu personnalisé dans une instance de l'interface utilisateur d'une application Google.
MimeTypeÉnumération qui permet d'accéder aux déclarations de type MIME sans saisir explicitement les chaînes.
MonthÉnumération représentant les mois de l'année.
PromptResponseRéponse à une boîte de dialogue prompt affichée dans l'environnement de l'interface utilisateur pour une application Google.
RgbColorCouleur définie par les canaux de couleur rouge, vert et bleu.
SessionLa classe Session permet d'accéder aux informations de session, telles que l'adresse e-mail de l'utilisateur (dans certaines circonstances) et le paramètre de langue.
UiInstance de l'environnement d'interface utilisateur pour une application Google qui permet au script d'ajouter des fonctionnalités telles que des menus, des boîtes de dialogue et des barres latérales.
UserReprésentation d'un utilisateur, adaptée au scripting.
WeekdayÉnumération représentant les jours de la semaine.
consoleCette classe permet au développeur d'écrire dans le journal d'exécution et dans Google Cloud Logging si le script est associé à un projet Cloud standard.

Blob

Méthodes

MéthodeType renvoyéBrève description
copyBlob()BlobRenvoie une copie de cet objet blob.
getAs(contentType)BlobRenvoie les données de cet objet sous forme de blob converti au type de contenu spécifié.
getBytes()Byte[]Récupère les données stockées dans ce blob.
getContentType()StringObtient le type de contenu des octets de ce blob.
getDataAsString()StringRécupère les données de ce blob sous forme de chaîne avec encodage UTF-8.
getDataAsString(charset)StringRécupère les données de ce blob sous forme de chaîne avec l'encodage spécifié.
getName()StringRécupère le nom de ce blob.
isGoogleType()BooleanIndique si ce blob est un fichier Google Workspace (Sheets, Docs, etc.).
setBytes(data)BlobDéfinit les données stockées dans ce blob.
setContentType(contentType)BlobDéfinit le type de contenu des octets de ce blob.
setContentTypeFromExtension()BlobDéfinit le type de contenu des octets de ce blob en fonction de l'extension du fichier.
setDataFromString(string)BlobDéfinit les données de ce blob à partir d'une chaîne avec encodage UTF-8.
setDataFromString(string, charset)BlobDéfinit les données de ce blob à partir d'une chaîne avec l'encodage spécifié.
setName(name)BlobDéfinit le nom de ce blob.

BlobSource

Méthodes

MéthodeType renvoyéBrève description
getAs(contentType)BlobRenvoie les données de cet objet sous forme de blob converti au type de contenu spécifié.
getBlob()BlobRenvoie les données de cet objet sous forme de blob.

Browser

Propriétés

PropriétéTypeDescription
ButtonsButtonSet

Méthodes

MéthodeType renvoyéBrève description
inputBox(prompt)String|nullAffiche une boîte de dialogue avec une zone de saisie de texte dans le navigateur de l'utilisateur.
inputBox(prompt, buttons)String|nullAffiche une boîte de dialogue avec une zone de saisie de texte dans le navigateur de l'utilisateur.
inputBox(title, prompt, buttons)String|nullAffiche une boîte de dialogue avec une zone de saisie de texte dans le navigateur de l'utilisateur.
msgBox(prompt)String|nullAffiche une boîte de dialogue avec le message donné et un bouton "OK" dans le navigateur de l'utilisateur.
msgBox(prompt, buttons)String|nullAffiche une boîte de dialogue avec le message donné et les boutons spécifiés dans le navigateur de l'utilisateur.
msgBox(title, prompt, buttons)String|nullAffiche une boîte de dialogue avec le titre, le message et les boutons spécifiés dans le navigateur de l'utilisateur.

Button

Propriétés

PropriétéTypeDescription
CLOSEEnumBouton de fermeture standard affiché dans la barre de titre de chaque boîte de dialogue.
OKEnumBouton "OK" indiquant qu'une opération doit se poursuivre.
CANCELEnumBouton "Annuler" indiquant qu'une opération ne doit pas être effectuée.
YESEnumBouton "Oui" indiquant une réponse positive à une question.
NOEnumBouton "Non", indiquant une réponse négative à une question.

ButtonSet

Propriétés

PropriétéTypeDescription
OKEnumUn seul bouton "OK", indiquant un message informatif qui ne peut être que fermé.
OK_CANCELEnumUn bouton "OK" et un bouton "Annuler" permettant à l'utilisateur de poursuivre ou d'interrompre une opération.
YES_NOEnumBoutons "Oui" et "Non" permettant à l'utilisateur de répondre à une question de type "oui/non".
YES_NO_CANCELEnumUn bouton "Oui", un bouton "Non" et un bouton "Annuler" permettant à l'utilisateur de répondre à une question par "Oui" ou "Non" ou d'interrompre une opération.

ColorType

Propriétés

PropriétéTypeDescription
UNSUPPORTEDEnumType de couleur non accepté.
RGBEnumCouleur définie par les canaux de couleur rouge, vert et bleu.
THEMEEnumCouleur qui fait référence à une entrée du jeu de couleurs du thème.

Logger

Méthodes

MéthodeType renvoyéBrève description
clear()voidEfface le journal.
getLog()StringRenvoie la liste complète des messages du journal actuel.
log(data)LoggerÉcrit les données dans le journal.
log(format, values)LoggerÉcrit une chaîne formatée dans la console de journalisation, en utilisant le format et les valeurs fournis.

Méthodes

MéthodeType renvoyéBrève description
addItem(caption, functionName)MenuAjoute un élément au menu.
addSeparator()MenuAjoute un séparateur visuel au menu.
addSubMenu(menu)MenuAjoute un sous-menu au menu.
addToUi()voidInsère le menu dans l'instance de l'interface utilisateur de l'éditeur.

MimeType

Propriétés

PropriétéTypeDescription
GOOGLE_APPS_SCRIPTEnumReprésentation du type MIME pour un projet Google Apps Script.
GOOGLE_DRAWINGSEnumReprésentation du type MIME pour un fichier Google Dessin.
GOOGLE_DOCSEnumReprésentation du type MIME pour un fichier Google Docs.
GOOGLE_FORMSEnumReprésentation du type MIME pour un fichier Google Forms.
GOOGLE_SHEETSEnumReprésentation du type MIME pour un fichier Google Sheets.
GOOGLE_SITESEnumReprésentation du type MIME pour un fichier Google Sites.
GOOGLE_SLIDESEnumReprésentation du type MIME pour un fichier Google Slides.
FOLDEREnumReprésentation du type MIME pour un dossier Google Drive.
SHORTCUTEnumReprésentation du type MIME pour un raccourci Google Drive.
BMPEnumReprésentation du type MIME pour un fichier image BMP (généralement .bmp).
GIFEnumReprésentation du type MIME pour un fichier image GIF (généralement .gif).
JPEGEnumReprésentation du type MIME pour un fichier image JPEG (généralement .jpg).
PNGEnumReprésentation du type MIME pour un fichier image PNG (généralement .png).
SVGEnumReprésentation du type MIME pour un fichier image SVG (généralement .svg).
PDFEnumReprésentation du type MIME pour un fichier PDF (généralement .pdf).
CSSEnumReprésentation du type MIME pour un fichier texte CSS (généralement .css).
CSVEnumReprésentation du type MIME pour un fichier texte CSV (généralement .csv).
HTMLEnumReprésentation du type MIME pour un fichier texte HTML (généralement .html).
JAVASCRIPTEnumReprésentation du type MIME pour un fichier texte JavaScript (généralement .js).
PLAIN_TEXTEnumReprésentation du type MIME pour un fichier en texte brut (généralement .txt).
RTFEnumReprésentation du type MIME pour un fichier au format Rich Text (généralement .rtf).
OPENDOCUMENT_GRAPHICSEnumReprésentation du type MIME pour un fichier graphique OpenDocument (généralement .odg).
OPENDOCUMENT_PRESENTATIONEnumReprésentation du type MIME pour un fichier de présentation OpenDocument (généralement .odp).
OPENDOCUMENT_SPREADSHEETEnumReprésentation du type MIME pour un fichier de feuille de calcul OpenDocument (généralement .ods).
OPENDOCUMENT_TEXTEnumReprésentation du type MIME pour un fichier de traitement de texte OpenDocument (généralement .odt).
MICROSOFT_EXCELEnumReprésentation du type MIME pour un fichier de feuille de calcul Microsoft Excel (généralement .xlsx).
MICROSOFT_EXCEL_LEGACYEnumReprésentation du type MIME pour un ancien fichier Microsoft Excel (généralement .xls).
MICROSOFT_POWERPOINTEnumReprésentation du type MIME pour un fichier de présentation Microsoft PowerPoint (généralement .pptx).
MICROSOFT_POWERPOINT_LEGACYEnumReprésentation du type MIME pour un ancien fichier Microsoft PowerPoint (généralement .ppt).
MICROSOFT_WORDEnumReprésentation du type MIME pour un fichier de document Microsoft Word (généralement .docx).
MICROSOFT_WORD_LEGACYEnumReprésentation du type MIME pour un ancien fichier Microsoft Word (généralement .doc).
ZIPEnumReprésentation du type MIME pour un fichier d'archive ZIP (généralement .zip).

Month

Propriétés

PropriétéTypeDescription
JANUARYEnumJanvier (mois 1).
FEBRUARYEnumFévrier (mois 2).
MARCHEnumMars (mois 3)
APRILEnumAvril (mois 4).
MAYEnumMai (mois 5).
JUNEEnumJuin (mois 6).
JULYEnumJuillet (mois 7).
AUGUSTEnumAoût (mois 8).
SEPTEMBEREnumSeptembre (mois 9).
OCTOBEREnumOctobre (mois 10).
NOVEMBEREnumNovembre (mois 11).
DECEMBEREnumDécembre (mois 12).

PromptResponse

Méthodes

MéthodeType renvoyéBrève description
getResponseText()StringRécupère le texte que l'utilisateur a saisi dans le champ de saisie de la boîte de dialogue.
getSelectedButton()ButtonRécupère le bouton sur lequel l'utilisateur a cliqué pour fermer la boîte de dialogue.

RgbColor

Méthodes

MéthodeType renvoyéBrève description
asHexString()StringRenvoie la couleur sous forme de chaîne hexadécimale de sept caractères (#rrggbb) ou de neuf caractères (#aarrggbb) de style CSS.
getBlue()IntegerCanal bleu de cette couleur, sous forme de nombre compris entre 0 et 255.
getColorType()ColorTypeObtenez le type de cette couleur.
getGreen()IntegerCanal vert de cette couleur, sous la forme d'un nombre compris entre 0 et 255.
getRed()IntegerCanal rouge de cette couleur, sous forme de nombre compris entre 0 et 255.

Session

Méthodes

MéthodeType renvoyéBrève description
getActiveUser()UserObtient des informations sur l'utilisateur actuel.
getActiveUserLocale()StringRécupère le paramètre de langue de l'utilisateur actuel sous forme de chaîne (par exemple, en pour l'anglais).
getEffectiveUser()UserObtient des informations sur l'utilisateur sous l'autorité duquel le script est exécuté.
getScriptTimeZone()StringRécupère le fuseau horaire du script.
getTemporaryActiveUserKey()StringObtient une clé temporaire unique à l'utilisateur actif, mais ne révèle pas son identité.

Ui

Propriétés

PropriétéTypeDescription
ButtonButtonÉnumération représentant les boutons de boîte de dialogue prédéterminés et localisés renvoyés par une alerte ou PromptResponse.getSelectedButton() pour indiquer le bouton sur lequel l'utilisateur a cliqué dans une boîte de dialogue.
ButtonSetButtonSetÉnumération représentant des ensembles prédéterminés et localisés d'un ou plusieurs boutons de boîte de dialogue pouvant être ajoutés à une alerte ou à une invite.

Méthodes

MéthodeType renvoyéBrève description
alert(prompt)ButtonOuvre une boîte de dialogue dans l'éditeur de l'utilisateur avec le message donné et un bouton "OK".
alert(prompt, buttons)ButtonOuvre une boîte de dialogue dans l'éditeur de l'utilisateur avec le message et l'ensemble de boutons donnés.
alert(title, prompt, buttons)ButtonOuvre une boîte de dialogue dans l'éditeur de l'utilisateur avec le titre, le message et l'ensemble de boutons spécifiés.
createAddonMenu()MenuCrée un générateur qui peut être utilisé pour insérer un sous-menu dans le menu "Extensions" de l'éditeur.
createMenu(caption)MenuCrée un compilateur qui peut être utilisé pour ajouter un menu à l'interface utilisateur de l'éditeur.
prompt(prompt)PromptResponseOuvre une boîte de dialogue de saisie dans l'éditeur de l'utilisateur avec le message donné et un bouton "OK".
prompt(prompt, buttons)PromptResponseOuvre une boîte de dialogue de saisie dans l'éditeur de l'utilisateur avec le message et l'ensemble de boutons spécifiés.
prompt(title, prompt, buttons)PromptResponseOuvre une boîte de dialogue de saisie dans l'éditeur de l'utilisateur avec le titre, le message et l'ensemble de boutons spécifiés.
showModalDialog(userInterface, title)voidOuvre une boîte de dialogue modale dans l'éditeur de l'utilisateur avec du contenu personnalisé côté client.
showModelessDialog(userInterface, title)voidOuvre une boîte de dialogue non modale dans l'éditeur de l'utilisateur avec du contenu personnalisé côté client.
showSidebar(userInterface)voidOuvre une barre latérale dans l'éditeur de l'utilisateur avec du contenu personnalisé côté client.

User

Méthodes

MéthodeType renvoyéBrève description
getEmail()StringRécupère l'adresse e-mail de l'utilisateur, si elle est disponible.

Weekday

Propriétés

PropriétéTypeDescription
SUNDAYEnumDimanche
MONDAYEnumLundi.
TUESDAYEnumMardi.
WEDNESDAYEnumMercredi
THURSDAYEnumJeudi.
FRIDAYEnumVendredi.
SATURDAYEnumsamedi).

console

Méthodes

MéthodeType renvoyéBrève description
error()voidGénère un message de niveau ERROR vide dans Stackdriver Logging.
error(formatOrObject, values)voidGénère un message de niveau ERROR dans Stackdriver Logging.
info()voidGénère un message de niveau INFO vide dans Stackdriver Logging.
info(formatOrObject, values)voidGénère un message de niveau INFO dans Stackdriver Logging.
log()voidGénère un message de niveau DEBUG vide dans Stackdriver Logging.
log(formatOrObject, values)voidGénère un message de niveau DEBUG dans Stackdriver Logging.
time(label)voidDémarre un minuteur que vous pouvez utiliser pour suivre la durée d'une opération.
timeEnd(label)voidArrête un minuteur qui a été démarré précédemment en appelant console.time().
warn()voidGénère un message de niveau AVERTISSEMENT vide dans Stackdriver Logging.
warn(formatOrObject, values)voidGénère un message de niveau WARNING dans Stackdriver Logging.