Cette page a été traduite par l'API Cloud Translation.

Base Service

Ce service fournit un accès 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 qui peuvent exporter leurs données sous forme de `Blob`.
`Browser`	Cette classe permet d'accéder à des boîtes de dialogue spécifiques à Google Sheets.
`Button`	Énumération représentant des boutons de boîte de dialogue localisés prédéterminés, renvoyés par un élément `alert` ou `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 de plusieurs boutons de boîte de dialogue qui peuvent être ajoutés à une `alert` ou à une `prompt`.
`ColorType`	Types de couleurs
`Logger`	Cette classe permet au développeur d'écrire du texte dans les journaux de débogage.
`Menu`	Menu personnalisé dans une instance de l'interface utilisateur d'une application Google
`MimeType`	Énumération qui donne accès aux déclarations de type MIME sans avoir à les saisir explicitement.
`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 de couleur 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 certaines circonstances) et le paramètre linguistique.
`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 à l'écriture de script.
`Weekday`	Énumération représentant les jours de la semaine.
`console`	Cette classe permet au développeur d'écrire des journaux dans le service Stackdriver Logging de Google Cloud Platform.

`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 contenues dans cet objet sous forme d'objet blob converti dans le type de contenu spécifié.
`getBytes()`	`Byte[]`	Récupère les données stockées dans cet objet blob.
`getContentType()`	`String`	Récupère le type de contenu des octets de cet objet blob.
`getDataAsString()`	`String`	Récupère les données de ce blob sous forme de chaîne avec un encodage UTF-8.
`getDataAsString(charset)`	`String`	Récupère les données de cet objet blob sous forme de 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 cet objet blob.
`setContentType(contentType)`	`Blob`	Définit le type de contenu des octets dans cet objet blob.
`setContentTypeFromExtension()`	`Blob`	Définit le type de contenu des octets de cet blob en fonction de l'extension de fichier.
`setDataFromString(string)`	`Blob`	Définit les données de cet objet blob à partir d'une chaîne encodée en UTF-8.
`setDataFromString(string, charset)`	`Blob`	Définit les données de cet objet 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 contenues dans cet objet sous forme d'objet blob converti dans le type de contenu spécifié.
`getBlob()`	`Blob`	Renvoyez les données contenues dans cet objet sous forme d'objet blob.

`Browser`

Propriétés

Propriété	Type	Description
`Buttons`	`ButtonSet`

Méthodes

Méthode	Type renvoyé	Brève description
`inputBox(prompt)`	`String`	Une boîte de dialogue contenant une zone de saisie de texte s'affiche dans le navigateur de l'utilisateur.
`inputBox(prompt, buttons)`	`String`	Une boîte de dialogue contenant une zone de saisie de texte s'affiche dans le navigateur de l'utilisateur.
`inputBox(title, prompt, buttons)`	`String`	Une boîte de dialogue contenant une zone de saisie de texte s'affiche dans le navigateur de l'utilisateur.
`msgBox(prompt)`	`String`	Affiche une boîte de dialogue avec 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 donné, 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 se poursuivre.
`CANCEL`	`Enum`	Un bouton "Annuler" indiquant qu'une opération ne doit pas s'effectuer
`YES`	`Enum`	Un bouton « Oui », indiquant une réponse positive à une question.
`NO`	`Enum`	Un bouton « Non », indiquant une réponse négative à une question.

`ButtonSet`

Propriétés

Propriété	Type	Description
`OK`	`Enum`	Un bouton "OK" unique, indiquant un message d'information qui peut uniquement être ignoré.
`OK_CANCEL`	`Enum`	Les boutons "OK" et "Annuler" permettent à l'utilisateur de poursuivre ou d'arrêter une opération.
`YES_NO`	`Enum`	Un bouton « Oui » et un bouton « Non », permettant à l'utilisateur de répondre à une question oui/non.
`YES_NO_CANCEL`	`Enum`	Un bouton "Oui", un bouton "Non" et un bouton "Annuler" permettant à l'utilisateur de répondre à une question oui/non ou d'interrompre une opération.

`ColorType`

Propriétés

Propriété	Type	Description
`UNSUPPORTED`	`Enum`	Type de couleur non compatible.
`RGB`	`Enum`	Couleur définie par les canaux de couleur rouge, vert et bleu.
`THEME`	`Enum`	Couleur faisant référence à une entrée du 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 la chaîne dans la console de journalisation.
`log(format, values)`	`Logger`	Écrit une chaîne mise en forme 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 pour un fichier Google Docs.
`GOOGLE_FORMS`	`Enum`	Représentation du type MIME pour un fichier Google Forms.
`GOOGLE_SHEETS`	`Enum`	Représentation du type MIME pour 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 pour un fichier Google Slides.
`FOLDER`	`Enum`	Représentation du type MIME pour 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 .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 .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 en texte brut (généralement .txt).
`RTF`	`Enum`	Représentation du type MIME pour un fichier de texte enrichi (généralement .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 .odt).
`MICROSOFT_EXCEL`	`Enum`	Représentation du type MIME pour une feuille de calcul Microsoft Excel (généralement .xlsx).
`MICROSOFT_EXCEL_LEGACY`	`Enum`	Représentation du type MIME pour un ancien fichier Microsoft Excel (généralement .xls).
`MICROSOFT_POWERPOINT`	`Enum`	Représentation du type MIME pour un fichier de présentation Microsoft PowerPoint (généralement .pptx).
`MICROSOFT_POWERPOINT_LEGACY`	`Enum`	Représentation du type MIME pour un ancien fichier Microsoft PowerPoint (généralement .ppt).
`MICROSOFT_WORD`	`Enum`	Représentation du type MIME pour un fichier de document Microsoft Word (généralement .docx).
`MICROSOFT_WORD_LEGACY`	`Enum`	Représentation du type MIME pour un ancien fichier Microsoft Word (généralement .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 (mois 2).
`MARCH`	`Enum`	Mars (mois 3).
`APRIL`	`Enum`	Avril (mois 4).
`MAY`	`Enum`	Mai (mois 5).
`JUNE`	`Enum`	Juin (mois 6).
`JULY`	`Enum`	Juillet (mois 7).
`AUGUST`	`Enum`	Août (mois 8).
`SEPTEMBER`	`Enum`	Septembre (mois 9).
`OCTOBER`	`Enum`	Octobre (mois 10).
`NOVEMBER`	`Enum`	Novembre (mois 11).
`DECEMBER`	`Enum`	Décembre (mois 12).

`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 la forme d'une chaîne hexadécimale de 7 caractères de style CSS (#rrggbb) ou d'une chaîne hexadécimale 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`	Permet d'obtenir 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 de langue 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 est exécuté.
`getScriptTimeZone()`	`String`	Récupère le fuseau horaire du script.
`getTemporaryActiveUserKey()`	`String`	Permet d'obtenir 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`	Énumération représentant des boutons de boîte de dialogue localisés prédéterminés renvoyés par alert ou `PromptResponse.getSelectedButton()` pour indiquer le bouton sur lequel l'utilisateur a cliqué dans une boîte de dialogue.
`ButtonSet`	`ButtonSet`	Énumération représentant des ensembles prédéterminés et localisés d'un ou plusieurs boutons de boîte de dialogue qui peuvent ê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 indiqué et un bouton "OK".
`alert(prompt, buttons)`	`Button`	Ouvre une boîte de dialogue contenant le message et l'ensemble de boutons indiqués dans l'éditeur de l'utilisateur.
`alert(title, prompt, buttons)`	`Button`	Ouvre une boîte de dialogue dans l'éditeur de l'utilisateur avec le titre, le message et les boutons indiqués.
`createAddonMenu()`	`Menu`	Crée un compilateur qui peut être utilisé pour insérer un sous-menu dans le menu "Extensions" de l'éditeur.
`createMenu(caption)`	`Menu`	Crée un compilateur qui peut être utilisé pour 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 indiqué et un bouton "OK".
`prompt(prompt, buttons)`	`PromptResponse`	Ouvre une boîte de dialogue de saisie contenant le message et l'ensemble de boutons indiqués dans l'éditeur de l'utilisateur.
`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 indiqués.
`showModalDialog(userInterface, title)`	`void`	Ouvre une boîte de dialogue modale avec un contenu personnalisé côté client dans l'éditeur de l'utilisateur.
`showModelessDialog(userInterface, title)`	`void`	Ouvre une boîte de dialogue non modale dans l'éditeur de l'utilisateur avec un contenu personnalisé côté client.
`showSidebar(userInterface)`	`void`	Ouvre une barre latérale dans l'éditeur de l'utilisateur avec un contenu personnalisé côté client.

`User`

Méthodes

Méthode	Type renvoyé	Brève description
`getEmail()`	`String`	Récupère l'adresse e-mail de l'utilisateur, si disponible.

`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`	Génère un message vide de niveau ERREUR dans Stackdriver Logging.
`error(formatOrObject, values)`	`void`	Génère un message de niveau "ERROR" dans Stackdriver Logging.
`info()`	`void`	Génère un message vide de niveau INFO dans Stackdriver Logging.
`info(formatOrObject, values)`	`void`	Génère un message de niveau INFO dans Stackdriver Logging.
`log()`	`void`	Génère un message vide de niveau DEBUG dans Stackdriver Logging.
`log(formatOrObject, values)`	`void`	Génère 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 déjà démarré en appelant `console.time()`.
`warn()`	`void`	Génère un message vide de niveau AVERTISSEMENT dans Stackdriver Logging.
`warn(formatOrObject, values)`	`void`	Génère un message de niveau AVERTISSEMENT dans Stackdriver Logging.