Base Service

Base

Ce service permet d'accéder aux informations utilisateur telles que 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

Nom	Brève description
Blob	Objet d'échange de données pour les services Apps Script.
BlobSource	Interface pour les objets pouvant exporter leurs données en tant que Blob.
Browser	Cette classe permet d'accéder aux boîtes de dialogue spécifiques à Google Sheets.
Button	Enumération représentant des boutons de boîte de dialogue localisés et prédéterminés renvoyés par un alert ou un PromptResponse.getSelectedButton() pour indiquer sur quel bouton de la boîte de dialogue l'utilisateur a cliqué.
ButtonSet	Enumération représentant des ensembles localisés prédéterminés d'un ou plusieurs boutons de boîte de dialogue pouvant être ajoutés à un alert ou à un prompt.
ColorType	Types de couleurs
Logger	Cette 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.
Menu	Menu 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.
PromptResponse	Réponse à une boîte de dialogue prompt affichée dans l'environnement d'interface utilisateur d'une application Google.
RgbColor	Couleur définie par les canaux rouge, vert et bleu.
Session	La classe Session permet d'accéder aux informations de session, telles que l'adresse e-mail de l'utilisateur (dans certains cas) et le paramètre de langue.
Ui	Instance de l'environnement d'interface utilisateur d'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.
User	Représentation d'un utilisateur, adaptée aux scripts.
Weekday	Énumération représentant les jours de la semaine.
console	Cette 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éthode	Type renvoyé	Brève description
copyBlob()	Blob	Renvoie une copie de ce blob.
getAs(contentType)	Blob	Renvoie 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()	String	Récupère le type de contenu des octets de ce blob.
getDataAsString()	String	Récupère les données de ce blob sous la forme d'une chaîne encodée en UTF-8.
getDataAsString(charset)	String	Récupère les données de ce blob sous la forme d'une chaîne avec l'encodage spécifié.
getName()	String	Récupère le nom de ce blob.
isGoogleType()	Boolean	Indique si ce blob est un fichier Google Workspace (Sheets, Docs, etc.).
setBytes(data)	Blob	Définit les données stockées dans ce blob.
setContentType(contentType)	Blob	Définit le type de contenu des octets de ce blob.
setContentTypeFromExtension()	Blob	Définit le type de contenu des octets de ce blob en fonction de l'extension du fichier.
setDataFromString(string)	Blob	Définit les données de ce blob à partir d'une chaîne encodée en UTF-8.
setDataFromString(string, charset)	Blob	Définit les données de ce blob à partir d'une chaîne avec l'encodage spécifié.
setName(name)	Blob	Définit le nom de ce blob.

BlobSource

Méthodes

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

Browser

Propriétés

Propriété	Type	Description
Buttons	ButtonSet

Méthodes

Méthode	Type renvoyé	Brève description
inputBox(prompt)	String	Affiche une boîte de dialogue avec une zone de saisie de texte dans le navigateur de l'utilisateur.
inputBox(prompt, buttons)	String	Affiche une boîte de dialogue avec une zone de saisie de texte dans le navigateur de l'utilisateur.
inputBox(title, prompt, buttons)	String	Affiche une boîte de dialogue avec une zone de saisie de texte dans le navigateur de l'utilisateur.
msgBox(prompt)	String	Affiche une boîte de dialogue contenant le message donné et un bouton "OK" dans le navigateur de l'utilisateur.
msgBox(prompt, buttons)	String	Affiche 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	Affiche 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é	Type	Description
CLOSE	Enum	Bouton de fermeture standard affiché dans la barre de titre de chaque boîte de dialogue.
OK	Enum	Un bouton "OK", indiquant qu'une opération doit être effectuée.
CANCEL	Enum	Un bouton "Annuler", indiquant qu'une opération ne doit pas être effectuée.
YES	Enum	Bouton "Oui", indiquant une réponse positive à une question.
NO	Enum	Bouton "Non", indiquant une réponse négative à une question.

ButtonSet

Propriétés

Propriété	Type	Description
OK	Enum	Un seul bouton "OK", indiquant un message d'information qui ne peut être ignoré que
OK_CANCEL	Enum	Un bouton "OK" et un bouton "Annuler", qui permettent à l'utilisateur de poursuivre ou d'arrêter une opération.
YES_NO	Enum	Un bouton "Oui" et un bouton "Non", qui permettent à l'utilisateur de répondre à une question de type "oui/non".
YES_NO_CANCEL	Enum	Un bouton "Oui", un bouton "Non" et un bouton "Annuler", qui permettent à l'utilisateur de répondre à une question "oui/non" ou d'arrêter une opération.

ColorType

Propriétés

Propriété	Type	Description
UNSUPPORTED	Enum	Type de couleur non accepté.
RGB	Enum	Couleur définie par les canaux rouge, vert et bleu.
THEME	Enum	Couleur qui fait référence à une entrée dans le jeu de couleurs du thème.

Logger

Méthodes

Méthode	Type renvoyé	Brève description
clear()	void	Efface le journal.
getLog()	String	Renvoie 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.

Menu

Méthodes

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

MimeType

Propriétés

Propriété	Type	Description
GOOGLE_APPS_SCRIPT	Enum	Représentation du type MIME pour un projet Google Apps Script.
GOOGLE_DRAWINGS	Enum	Représentation du type MIME pour un fichier Google Drawings.
GOOGLE_DOCS	Enum	Représentation du type MIME d'un fichier Google Docs.
GOOGLE_FORMS	Enum	Représentation du type MIME d'un fichier Google Forms.
GOOGLE_SHEETS	Enum	Représentation du type MIME d'un fichier Google Sheets.
GOOGLE_SITES	Enum	Représentation du type MIME pour un fichier Google Sites.
GOOGLE_SLIDES	Enum	Représentation du type MIME d'un fichier Google Slides.
FOLDER	Enum	Représentation du type MIME d'un dossier Google Drive.
SHORTCUT	Enum	Représentation du type MIME pour un raccourci Google Drive.
BMP	Enum	Représentation du type MIME pour un fichier image BMP (généralement .bmp).
GIF	Enum	Représentation du type MIME pour un fichier image GIF (généralement .gif).
JPEG	Enum	Représentation du type MIME pour un fichier image JPEG (généralement au format .jpg).
PNG	Enum	Représentation du type MIME pour un fichier image PNG (généralement .png).
SVG	Enum	Représentation du type MIME pour un fichier image SVG (généralement au format .svg).
PDF	Enum	Représentation du type MIME pour un fichier PDF (généralement .pdf).
CSS	Enum	Représentation du type MIME pour un fichier texte CSS (généralement .css).
CSV	Enum	Représentation du type MIME pour un fichier texte CSV (généralement .csv).
HTML	Enum	Représentation du type MIME pour un fichier texte HTML (généralement .html).
JAVASCRIPT	Enum	Représentation du type MIME pour un fichier texte JavaScript (généralement .js).
PLAIN_TEXT	Enum	Représentation du type MIME pour un fichier texte brut (généralement .txt).
RTF	Enum	Représentation du type MIME pour un fichier de texte enrichi (généralement au format .rtf).
OPENDOCUMENT_GRAPHICS	Enum	Représentation du type MIME pour un fichier graphique OpenDocument (généralement .odg).
OPENDOCUMENT_PRESENTATION	Enum	Représentation du type MIME pour un fichier de présentation OpenDocument (généralement .odp).
OPENDOCUMENT_SPREADSHEET	Enum	Représentation du type MIME pour un fichier de feuille de calcul OpenDocument (généralement .ods).
OPENDOCUMENT_TEXT	Enum	Représentation du type MIME pour un fichier de traitement de texte OpenDocument (généralement au format .odt).
MICROSOFT_EXCEL	Enum	Représentation du type MIME d'un fichier de feuille de calcul Microsoft Excel (généralement au format .xlsx).
MICROSOFT_EXCEL_LEGACY	Enum	Représentation du type MIME pour un ancien fichier Microsoft Excel (généralement au format .xls).
MICROSOFT_POWERPOINT	Enum	Représentation du type MIME pour un fichier de présentation Microsoft PowerPoint (généralement au format .pptx).
MICROSOFT_POWERPOINT_LEGACY	Enum	Représentation du type MIME pour un ancien fichier Microsoft PowerPoint (généralement au format .ppt).
MICROSOFT_WORD	Enum	Représentation du type MIME d'un fichier de document Microsoft Word (généralement au format .docx).
MICROSOFT_WORD_LEGACY	Enum	Représentation du type MIME pour un ancien fichier Microsoft Word (généralement au format .doc).
ZIP	Enum	Représentation du type MIME pour un fichier d'archive ZIP (généralement .zip).

Month

Propriétés

Propriété	Type	Description
JANUARY	Enum	Janvier (mois 1).
FEBRUARY	Enum	Février (2e mois).
MARCH	Enum	Mars (3e mois)
APRIL	Enum	Avril (4e mois).
MAY	Enum	Mai (5e mois).
JUNE	Enum	Juin (6e mois).
JULY	Enum	Juillet (7e mois).
AUGUST	Enum	Août (8e mois).
SEPTEMBER	Enum	Septembre (9e mois).
OCTOBER	Enum	Octobre (10e mois).
NOVEMBER	Enum	Novembre (11e mois).
DECEMBER	Enum	Décembre (12e mois).

PromptResponse

Méthodes

Méthode	Type renvoyé	Brève description
getResponseText()	String	Récupère le texte saisi par l'utilisateur dans le champ de saisie de la boîte de dialogue.
getSelectedButton()	Button	Récupère le bouton sur lequel l'utilisateur a cliqué pour fermer la boîte de dialogue.

RgbColor

Méthodes

Méthode	Type renvoyé	Brève description
asHexString()	String	Renvoie la couleur sous forme de chaîne hexadécimale de 7 caractères de style CSS (#rrggbb) ou de 9 caractères (#aarrggbb).
getBlue()	Integer	Canal bleu de cette couleur, sous la forme d'un nombre compris entre 0 et 255.
getColorType()	ColorType	Obtenez le type de cette couleur.
getGreen()	Integer	Canal vert de cette couleur, sous la forme d'un nombre compris entre 0 et 255.
getRed()	Integer	Canal rouge de cette couleur, sous la forme d'un nombre compris entre 0 et 255.

Session

Méthodes

Méthode	Type renvoyé	Brève description
getActiveUser()	User	Récupère des informations sur l'utilisateur actuel.
getActiveUserLocale()	String	Récupère le paramètre linguistique de l'utilisateur actuel sous forme de chaîne (par exemple, en pour l'anglais).
getEffectiveUser()	User	Récupère des informations sur l'utilisateur sous l'autorité duquel le script s'exécute.
getScriptTimeZone()	String	Récupère le fuseau horaire du script.
getTemporaryActiveUserKey()	String	Récupère une clé temporaire propre à l'utilisateur actif, mais qui ne révèle pas son identité.

Ui

Propriétés

Propriété	Type	Description
Button	Button	Enumération représentant les boutons de boîte de dialogue localisés et prédéterminés renvoyés par une alerte ou PromptResponse.getSelectedButton() pour indiquer sur quel bouton de la boîte de dialogue l'utilisateur a cliqué.
ButtonSet	ButtonSet	Enumération représentant des ensembles localisés prédéterminés d'un ou plusieurs boutons de boîte de dialogue pouvant être ajoutés à une alerte ou à une invite.

Méthodes

Méthode	Type renvoyé	Brève description
alert(prompt)	Button	Ouvre une boîte de dialogue dans l'éditeur de l'utilisateur avec le message donné et un bouton "OK".
alert(prompt, buttons)	Button	Ouvre 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)	Button	Ouvre une boîte de dialogue dans l'éditeur de l'utilisateur avec le titre, le message et l'ensemble de boutons donnés.
createAddonMenu()	Menu	Crée un outil de création permettant d'insérer un sous-menu dans le menu "Extensions" de l'éditeur.
createMenu(caption)	Menu	Crée un compilateur permettant d'ajouter un menu à l'interface utilisateur de l'éditeur.
prompt(prompt)	PromptResponse	Ouvre une boîte de dialogue de saisie dans l'éditeur de l'utilisateur avec le message donné et un bouton "OK".
prompt(prompt, buttons)	PromptResponse	Ouvre une boîte de dialogue de saisie dans l'éditeur de l'utilisateur avec le message et l'ensemble de boutons donnés.
prompt(title, prompt, buttons)	PromptResponse	Ouvre une boîte de dialogue de saisie dans l'éditeur de l'utilisateur avec le titre, le message et l'ensemble de boutons donnés.
showModalDialog(userInterface, title)	void	Ouvre une boîte de dialogue modale dans l'éditeur de l'utilisateur avec du contenu côté client personnalisé.
showModelessDialog(userInterface, title)	void	Ouvre une boîte de dialogue sans mode dans l'éditeur de l'utilisateur avec du contenu côté client personnalisé.
showSidebar(userInterface)	void	Ouvre une barre latérale dans l'éditeur de l'utilisateur avec du contenu côté client personnalisé.

User

Méthodes

Méthode	Type renvoyé	Brève description
getEmail()	String	Récupère l'adresse e-mail de l'utilisateur, le cas échéant.

Weekday

Propriétés

Propriété	Type	Description
SUNDAY	Enum	Dimanche.
MONDAY	Enum	Lundi.
TUESDAY	Enum	Mardi.
WEDNESDAY	Enum	Mercredi.
THURSDAY	Enum	Jeudi.
FRIDAY	Enum	Vendredi.
SATURDAY	Enum	samedi).

console

Méthodes

Méthode	Type renvoyé	Brève description
error()	void	Affiche un message vide de niveau ERROR dans Stackdriver Logging.
error(formatOrObject, values)	void	Affiche un message de niveau ERROR dans Stackdriver Logging.
info()	void	Affiche un message vide de niveau INFO dans Stackdriver Logging.
info(formatOrObject, values)	void	Affiche un message de niveau INFO dans Stackdriver Logging.
log()	void	Affiche un message vide de niveau DEBUG dans Stackdriver Logging.
log(formatOrObject, values)	void	Affiche un message de niveau DEBUG dans Stackdriver Logging.
time(label)	void	Démarre un minuteur que vous pouvez utiliser pour suivre la durée d'une opération.
timeEnd(label)	void	Arrête un minuteur précédemment démarré en appelant console.time().
warn()	void	Affiche un message vide de niveau AVERTISSEMENT dans Stackdriver Logging.
warn(formatOrObject, values)	void	Affiche un message de niveau AVERTISSEMENT dans Stackdriver Logging.