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

Base Service

Ce service permet d'accéder à des informations sur les utilisateurs, telles que leur adresse e-mail et leur nom. 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 sous forme de `Blob`
`Browser`	Ce cours permet d'accéder à des boîtes de dialogue spécifiques à Google Sheets.
`Button`	Énumération représentant les boutons de dialogue prédéterminés et localisés renvoyés par un `alert` ou un `PromptResponse.getSelectedButton()` pour indiquer le bouton dans une boîte de dialogue sur lequel l'utilisateur a cliqué.
`ButtonSet`	Énumération représentant les ensembles prédéterminés et localisés d'un ou de plusieurs boutons de boîte de dialogue qui peuvent être ajoutés à un `alert` ou à un `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 pour une application Google.
`MimeType`	Énumération permettant 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 des canaux de couleur rouge, vert et bleu.
`Session`	La classe Session permet d'accéder aux informations sur la session, telles que l'adresse e-mail de l'utilisateur (dans certains cas) et le paramètre linguistique.
`Ui`	Instance de l'environnement d'interface utilisateur d'une application Google permettant 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 au 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 cet objet blob.
`getAs(contentType)`	`Blob`	Renvoyez les données de cet objet en tant qu'objet blob converti au 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 cet objet blob sous forme de chaîne avec l'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 cet objet blob.
`isGoogleType()`	`Boolean`	Indique si cet objet 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 objet blob en fonction de l'extension de fichier.
`setDataFromString(string)`	`Blob`	Définit les données de ce blob à partir d'une chaîne avec un encodage 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 cet objet blob.

`BlobSource`

Méthodes

Méthode	Type renvoyé	Brève description
`getAs(contentType)`	`Blob`	Renvoyez les données de cet objet en tant qu'objet blob converti au type de contenu spécifié.
`getBlob()`	`Blob`	Renvoyez les données de cet objet en tant que blob.

`Browser`

Properties

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

Méthodes

Méthode	Type renvoyé	Brève description
`inputBox(prompt)`	`String`	Ouvre une boîte de dialogue contenant une zone de saisie de texte dans le navigateur de l'utilisateur.
`inputBox(prompt, buttons)`	`String`	Ouvre une boîte de dialogue contenant une zone de saisie de texte dans le navigateur de l'utilisateur.
`inputBox(title, prompt, buttons)`	`String`	Ouvre une boîte de dialogue contenant une zone de saisie de texte dans le navigateur de l'utilisateur.
`msgBox(prompt)`	`String`	Ouvre une boîte de dialogue avec le message donné et un bouton "OK" dans le navigateur de l'utilisateur.
`msgBox(prompt, buttons)`	`String`	Ouvre 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`	Ouvre une boîte de dialogue contenant le titre, le message et les boutons spécifiés dans le navigateur de l'utilisateur.

`Button`

Properties

Propriété	Type	Description
`CLOSE`	`Enum`	Bouton de fermeture standard affiché dans la barre de titre de chaque boîte de dialogue.
`OK`	`Enum`	Bouton "OK" indiquant qu'une opération doit se poursuivre.
`CANCEL`	`Enum`	Bouton "Annuler" indiquant qu'une opération ne doit pas continuer.
`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`

Properties

Propriété	Type	Description
`OK`	`Enum`	Un bouton "OK" indique un message d'information qui ne peut être ignoré.
`OK_CANCEL`	`Enum`	Un bouton "OK" et un bouton "Annuler" permettant à l'utilisateur de poursuivre ou d'arrêter une opération.
`YES_NO`	`Enum`	Boutons "Oui" et "Non" permettant aux utilisateurs de répondre à une question dont la réponse est par oui ou par non.
`YES_NO_CANCEL`	`Enum`	Boutons "Oui", "Non" et "Annuler" et "Annuler", permettant à l'utilisateur de répondre à une question "Oui/Non" ou d'interrompre une opération.

`ColorType`

Properties

Propriété	Type	Description
`UNSUPPORTED`	`Enum`	Type de couleur non compatible.
`RGB`	`Enum`	Couleur définie par des 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 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`

Properties

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 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 une 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`

Properties

Propriété	Type	Description
`JANUARY`	`Enum`	Janvier 1.
`FEBRUARY`	`Enum`	février (mois 2).
`MARCH`	`Enum`	Mars (3 mois).
`APRIL`	`Enum`	Avril (4 mois).
`MAY`	`Enum`	Mai (5 mois).
`JUNE`	`Enum`	Juin (6 mois).
`JULY`	`Enum`	Juillet (7 mois).
`AUGUST`	`Enum`	Août (8 mois).
`SEPTEMBER`	`Enum`	Septembre (9 mois).
`OCTOBER`	`Enum`	Octobre (10 mois).
`NOVEMBER`	`Enum`	Novembre (11 mois).
`DECEMBER`	`Enum`	Décembre (12 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 (#rrggbb) ou de chaîne hexadécimale (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 la langue de l'utilisateur actuel sous forme de chaîne (par exemple, `en` pour l'anglais).
`getEffectiveUser()`	`User`	Récupère les informations concernant l'utilisateur dont l'autorité est exécutée par le script.
`getScriptTimeZone()`	`String`	Récupère le fuseau horaire du script.
`getTemporaryActiveUserKey()`	`String`	Récupère une clé temporaire propre à l'utilisateur actif, sans révéler son identité.

`Ui`

Properties

Propriété	Type	Description
`Button`	`Button`	Énumération représentant les boutons de boîte de dialogue prédéterminés et localisés affichés par une alerte ou `PromptResponse.getSelectedButton()` pour indiquer le bouton d'une boîte de dialogue sur lequel l'utilisateur a cliqué.
`ButtonSet`	`ButtonSet`	Énumération représentant les 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 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 les boutons indiqués.
`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 permet d'insérer un sous-menu dans le menu complémentaire de l'éditeur.
`createMenu(caption)`	`Menu`	Crée un compilateur qui permet 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 contenant le message et l'ensemble de boutons indiqué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 indiqués.
`showModalDialog(userInterface, title)`	`void`	Ouvre une boîte de dialogue modale dans l'éditeur de l'utilisateur, avec du contenu personnalisé côté client.
`showModelessDialog(userInterface, title)`	`void`	Ouvre une boîte de dialogue sans mode dans l'éditeur avec du contenu personnalisé côté client.
`showSidebar(userInterface)`	`void`	Ouvre une barre latérale dans l'éditeur de l'utilisateur avec du 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 elle est disponible.

`Weekday`

Properties

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`	Envoie un message d'erreur vide à Stackdriver Logging.
`error(formatOrObject, values)`	`void`	Génère un message de niveau d'erreur dans Stackdriver Logging.
`info()`	`void`	Un message de niveau INFO vide est envoyé à Stackdriver Logging.
`info(formatOrObject, values)`	`void`	Génère un message de niveau INFO à Stackdriver Logging.
`log()`	`void`	Génère un message de niveau DEBUG vide dans Stackdriver Logging.
`log(formatOrObject, values)`	`void`	Génère un message de niveau DEBUG à 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`	Un message d'avertissement vide s'affiche dans Stackdriver Logging.
`warn(formatOrObject, values)`	`void`	Génère un message de niveau d'avertissement à Stackdriver Logging.