Les scripts liés à Google Docs, Sheets ou Forms peuvent afficher plusieurs types d'éléments d'interface utilisateur : des alertes et des invites prédéfinies, ainsi que des boîtes de dialogue et des barres latérales contenant des pages de services HTML personnalisées. En règle générale, ces éléments sont ouverts à partir des éléments de menu. Notez que dans Google Forms, les éléments de l'interface utilisateur ne sont visibles que par un éditeur qui ouvre le formulaire pour le modifier, et non par celui qui ouvre le formulaire pour y répondre.
Boîtes de dialogue d'alerte
Une alerte est une boîte de dialogue prédéfinie qui s'ouvre dans l'éditeur Google Docs, Sheets, Slides ou Forms. Elle affiche un message et un bouton "OK". Un titre et d'autres boutons sont facultatifs. Cette méthode s'apparente à l'appel de window.alert()
dans le code JavaScript côté client dans un navigateur Web.
Les alertes suspendent le script côté serveur lorsque la boîte de dialogue est ouverte. Le script reprend une fois que l'utilisateur a fermé la boîte de dialogue, mais les connexions JDBC ne persistent pas pendant la suspension.
Comme le montre l'exemple ci-dessous, Google Docs, Forms, Slides et Sheets utilisent tous la méthode Ui.alert()
, qui est disponible en trois variantes. Pour ignorer le bouton "OK" par défaut, transmettez une valeur de l'énumération Ui.ButtonSet
en tant qu'argument buttons
. Pour évaluer le bouton sur lequel l'utilisateur a cliqué, comparez la valeur renvoyée pour alert()
à l'énumération Ui.Button
.
function onOpen() {
SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
.createMenu('Custom Menu')
.addItem('Show alert', 'showAlert')
.addToUi();
}
function showAlert() {
var ui = SpreadsheetApp.getUi(); // Same variations.
var result = ui.alert(
'Please confirm',
'Are you sure you want to continue?',
ui.ButtonSet.YES_NO);
// Process the user's response.
if (result == ui.Button.YES) {
// User clicked "Yes".
ui.alert('Confirmation received.');
} else {
// User clicked "No" or X in the title bar.
ui.alert('Permission denied.');
}
}
Boîtes de dialogue d'invite
Une invite est une boîte de dialogue prédéfinie qui s'ouvre dans l'éditeur Google Docs, Sheets, Slides ou Forms. Elle affiche un message, un champ de saisie de texte et un bouton "OK". Un titre et d'autres boutons sont facultatifs. Cette méthode s'apparente à l'appel de window.prompt()
dans le code JavaScript côté client dans un navigateur Web.
Les invites suspendent le script côté serveur lorsque la boîte de dialogue est ouverte. Le script reprend une fois que l'utilisateur a fermé la boîte de dialogue, mais les connexions JDBC ne persistent pas pendant la suspension.
Comme illustré dans l'exemple ci-dessous, Google Docs Forms, Slides et Sheets utilisent la méthode Ui.prompt()
, qui est disponible en trois variantes. Pour ignorer le bouton "OK" par défaut, transmettez une valeur de l'énumération Ui.ButtonSet
en tant qu'argument buttons
. Pour évaluer la réponse de l'utilisateur, capturez la valeur renvoyée pour prompt()
, puis appelez PromptResponse.getResponseText()
pour récupérer l'entrée de l'utilisateur et comparez la valeur renvoyée pour PromptResponse.getSelectedButton()
à l'énumération Ui.Button
.
function onOpen() {
SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
.createMenu('Custom Menu')
.addItem('Show prompt', 'showPrompt')
.addToUi();
}
function showPrompt() {
var ui = SpreadsheetApp.getUi(); // Same variations.
var result = ui.prompt(
'Let\'s get to know each other!',
'Please enter your name:',
ui.ButtonSet.OK_CANCEL);
// Process the user's response.
var button = result.getSelectedButton();
var text = result.getResponseText();
if (button == ui.Button.OK) {
// User clicked "OK".
ui.alert('Your name is ' + text + '.');
} else if (button == ui.Button.CANCEL) {
// User clicked "Cancel".
ui.alert('I didn\'t get your name.');
} else if (button == ui.Button.CLOSE) {
// User clicked X in the title bar.
ui.alert('You closed the dialog.');
}
}
Boîtes de dialogue personnalisées
Une boîte de dialogue personnalisée peut afficher une interface utilisateur de service HTML dans un éditeur Google Docs, Sheets, Slides ou Forms.
Les boîtes de dialogue personnalisées ne suspendent pas le script côté serveur tant que la boîte de dialogue est ouverte.
Le composant côté client peut effectuer des appels asynchrones vers le script côté serveur à l'aide de l'API google.script
pour les interfaces de service HTML.
La boîte de dialogue peut se fermer en appelant google.script.host.close()
côté client d'une interface de service HTML. La boîte de dialogue ne peut pas être fermée par d'autres interfaces, uniquement par l'utilisateur ou par lui-même.
Comme le montre l'exemple ci-dessous, Google Docs, Forms, Slides et Sheets utilisent tous la méthode Ui.showModalDialog()
pour ouvrir la boîte de dialogue.
Code.gs
function onOpen() { SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp. .createMenu('Custom Menu') .addItem('Show dialog', 'showDialog') .addToUi(); } function showDialog() { var html = HtmlService.createHtmlOutputFromFile('Page') .setWidth(400) .setHeight(300); SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp. .showModalDialog(html, 'My custom dialog'); }
Page.html
Hello, world! <input type="button" value="Close" onclick="google.script.host.close()" />
Barres latérales personnalisées
Une barre latérale peut afficher une interface utilisateur de service HTML dans un éditeur Google Docs, Forms, Slides et Sheets.
Les barres latérales ne suspendent pas le script côté serveur lorsque la boîte de dialogue est ouverte. Le composant côté client peut effectuer des appels asynchrones vers le script côté serveur à l'aide de l'API google.script
pour les interfaces de service HTML.
La barre latérale peut se fermer en appelant google.script.host.close()
côté client d'une interface de service HTML. La barre latérale ne peut pas être fermée par d'autres interfaces, que par l'utilisateur ou par lui-même.
Comme le montre l'exemple ci-dessous, Google Docs, Forms, Slides et Sheets utilisent tous la méthode Ui.showSidebar()
pour ouvrir la barre latérale.
Code.gs
function onOpen() { SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp. .createMenu('Custom Menu') .addItem('Show sidebar', 'showSidebar') .addToUi(); } function showSidebar() { var html = HtmlService.createHtmlOutputFromFile('Page') .setTitle('My custom sidebar'); SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp. .showSidebar(html); }
Page.html
Hello, world! <input type="button" value="Close" onclick="google.script.host.close()" />
Boîtes de dialogue d'ouverture de fichier
L'outil de sélection Google est une boîte de dialogue qui s'ouvre sur des informations stockées sur les serveurs Google, y compris Google Drive, Google Recherche d'Images et Google Recherche de vidéos.
Comme indiqué dans l'exemple ci-dessous, l'API JavaScript côté client de "Picker" peut être utilisée dans un service HTML pour créer une boîte de dialogue personnalisée qui permet aux utilisateurs de sélectionner des fichiers existants ou d'en importer de nouveaux, puis de transmettre cette sélection à votre script pour une utilisation ultérieure.
Pour activer le sélecteur et obtenir une clé API, procédez comme suit:
- Vérifiez que votre projet de script utilise un projet GCP standard.
- Activez l'API Google Picker dans votre projet Google Cloud.
- Pendant que votre projet Google Cloud est toujours ouvert, sélectionnez API et services, puis cliquez sur Identifiants.
- Cliquez sur Créer des identifiants > Clé API. Cette action crée la clé, mais vous devez la modifier pour ajouter à la clé des restrictions d'application et une restriction d'API.
- Dans la boîte de dialogue de la clé API, cliquez sur Fermer.
- À côté de la clé API que vous avez créée, cliquez sur Plus
> Modifier la clé API.
Sous Restrictions liées aux applications, procédez comme suit:
- Sélectionnez URL de provenance HTTP (sites Web).
- Sous Restrictions liées aux sites Web, cliquez sur Ajouter un élément.
- Cliquez sur URL de provenance, puis saisissez
*.google.com
. - Ajoutez un autre élément et saisissez
*.googleusercontent.com
comme URL de provenance. - Cliquez sur OK.
Sous API restrictions (Restrictions liées à l'API), procédez comme suit:
- Sélectionnez Restreindre la clé.
Dans la section Sélectionner des API, sélectionnez API Google Picker, puis cliquez sur OK.
Remarque:L'API Google Picker ne s'affiche que si vous l'avez activée, car la liste n'affiche que les API activées pour le projet Cloud.
Sous API key (Clé API), cliquez sur Copier dans le presse-papiers
.
Au bas de la page, cliquez sur Enregistrer.