Vous pouvez combiner du code Apps Script et du code HTML pour créer des pages dynamiques avec un minimum d'efforts. Si vous avez utilisé un langage de création de modèles qui combine du code et du HTML, par exemple PHP, ASP ou JSON, la syntaxe devrait vous sembler familière.
Scriptlets
Les modèles Apps Script peuvent contenir trois balises spéciales, appelées scriptlets. Dans un scriptlet, vous pouvez écrire n'importe quel code qui fonctionnerait dans un fichier Apps Script normal. Il peut appeler des fonctions définies dans d'autres fichiers de code, référencer des variables globales ou utiliser n'importe quelle API Apps Script. Vous pouvez même définir des fonctions et des variables dans les scriptlets, mais sachez qu'elles ne peuvent pas être appelées par des fonctions définies dans des fichiers de code ou d'autres modèles.
Si vous collez l'exemple ci-dessous dans l'éditeur de script, le contenu de la balise <?= ... ?> (un scriptlet d'impression) apparaît en italique. Ce code en italique s'exécute sur le serveur avant que la page ne soit présentée à l'utilisateur. Étant donné que le code scriptlet s'exécute avant que la page ne soit diffusée, il ne peut s'exécuter qu'une seule fois par page. Contrairement aux fonctions JavaScript ou Apps Script côté client que vous appelez via google.script.run, les scriptslets ne peuvent pas s'exécuter à nouveau une fois la page chargée.
Code.gs
function doGet() {
return HtmlService
.createTemplateFromFile('Index')
.evaluate();
}
Index.html
<!DOCTYPE html>
<html>
<head>
<base target="_top">
</head>
<body>
Hello, World! The time is <?= new Date() ?>.
</body>
</html>
Notez que la fonction doGet() pour le code HTML modélisé est différente des exemples permettant de créer et diffuser du code HTML de base. La fonction présentée ici génère un objet HtmlTemplate à partir du fichier HTML, puis appelle sa méthode evaluate() pour exécuter les scriptlets et convertir le modèle en un objet HtmlOutput que le script peut diffuser à l'utilisateur.
Scriptlets standards
Les scriptlets standards, qui utilisent la syntaxe <? ... ?>, exécutent du code sans afficher explicitement le contenu sur la page. Toutefois, comme le montre cet exemple, le résultat du code dans un scriptlet peut toujours affecter le contenu HTML en dehors du scriptlet:
Code.gs
function doGet() {
return HtmlService
.createTemplateFromFile('Index')
.evaluate();
}
Index.html
<!DOCTYPE html>
<html>
<head>
<base target="_top">
</head>
<body>
<? if (true) { ?>
<p>This will always be served!</p>
<? } else { ?>
<p>This will never be served.</p>
<? } ?>
</body>
</html>
Imprimer des scriptslets
Les scriptslets imprimés, qui utilisent la syntaxe <?= ... ?>, génèrent les résultats de leur code sur la page à l'aide de l'échappement contextuel.
L'échappement contextuel signifie qu'Apps Script effectue le suivi du contexte de sortie sur la page (à l'intérieur d'un attribut HTML, d'une balise script côté client ou à tout autre emplacement) et ajoute automatiquement des caractères d'échappement pour se protéger contre les attaques de type script intersites (XSS).
Dans cet exemple, le premier scriptlet d'impression génère directement une chaîne. Il est suivi d'un scriptlet standard qui configure un tableau et une boucle, puis un autre scriptlet d'impression pour générer le contenu du tableau.
Code.gs
function doGet() {
return HtmlService
.createTemplateFromFile('Index')
.evaluate();
}
Index.html
<!DOCTYPE html>
<html>
<head>
<base target="_top">
</head>
<body>
<?= 'My favorite Google products:' ?>
<? var data = ['Gmail', 'Docs', 'Android'];
for (var i = 0; i < data.length; i++) { ?>
<b><?= data[i] ?></b>
<? } ?>
</body>
</html>
Notez qu'un scriptlet d'impression ne génère que la valeur de sa première instruction. Toutes les autres instructions se comportent comme si elles étaient contenues dans un scriptlet standard. Ainsi, par exemple, le scriptlet <?= 'Hello, world!'; 'abc' ?> n'affiche que "Hello, world!"
Forcer l'impression des scriptlets
L'impression forcée des scriptlets, qui utilisent la syntaxe <?!= ... ?>, sont semblables à l'impression des scriptlets, sauf qu'ils évitent un échappement contextuel.
L'échappement contextuel est important si votre script autorise des entrées utilisateur non fiables. En revanche, vous devrez forcer l'impression si la sortie de votre scriptlet contient intentionnellement du code HTML ou des scripts que vous souhaitez insérer exactement comme spécifié.
En règle générale, utilisez des scriptslets pour imprimer des scriptlets plutôt que d'en forcer l'impression, sauf si vous savez que vous devez imprimer le code HTML ou JavaScript tel quel.
Code Apps Script dans les scriptslets
Les scriptslets ne sont pas limités à l'exécution de code JavaScript normal. Vous pouvez également utiliser l'une des trois techniques suivantes pour permettre à vos modèles d'accéder aux données Apps Script.
Toutefois, n'oubliez pas que, comme le code du modèle s'exécute avant que la page ne soit présentée à l'utilisateur, ces techniques ne permettent d'alimenter que le contenu initial de la page. Pour accéder aux données Apps Script à partir d'une page de manière interactive, utilisez plutôt l'API google.script.run.
Appeler des fonctions Apps Script à partir d'un modèle
Les scriptslets peuvent appeler n'importe quelle fonction définie dans un fichier de code ou une bibliothèque Apps Script. Cet exemple présente une façon d'extraire les données d'une feuille de calcul dans un modèle, puis de construire une table HTML à partir des données.
Code.gs
function doGet() {
return HtmlService
.createTemplateFromFile('Index')
.evaluate();
}
function getData() {
return SpreadsheetApp
.openById('1234567890abcdefghijklmnopqrstuvwxyz')
.getActiveSheet()
.getDataRange()
.getValues();
}
Index.html
<!DOCTYPE html>
<html>
<head>
<base target="_top">
</head>
<body>
<? var data = getData(); ?>
<table>
<? for (var i = 0; i < data.length; i++) { ?>
<tr>
<? for (var j = 0; j < data[i].length; j++) { ?>
<td><?= data[i][j] ?></td>
<? } ?>
</tr>
<? } ?>
</table>
</body>
</html>
Appeler directement des API Apps Script
Vous pouvez également utiliser le code Apps Script directement dans les scriptlets. Cet exemple produit le même résultat que l'exemple précédent en chargeant les données dans le modèle lui-même plutôt que via une fonction distincte.
Code.gs
function doGet() {
return HtmlService
.createTemplateFromFile('Index')
.evaluate();
}
Index.html
<!DOCTYPE html>
<html>
<head>
<base target="_top">
</head>
<body>
<? var data = SpreadsheetApp
.openById('1234567890abcdefghijklmnopqrstuvwxyz')
.getActiveSheet()
.getDataRange()
.getValues(); ?>
<table>
<? for (var i = 0; i < data.length; i++) { ?>
<tr>
<? for (var j = 0; j < data[i].length; j++) { ?>
<td><?= data[i][j] ?></td>
<? } ?>
</tr>
<? } ?>
</table>
</body>
</html>
Transférer des variables vers des modèles
Enfin, vous pouvez transférer des variables dans un modèle en les attribuant en tant que propriétés de l'objet HtmlTemplate. Une fois encore, cet exemple produit le même résultat que les exemples précédents.
Code.gs
function doGet() {
var t = HtmlService.createTemplateFromFile('Index');
t.data = SpreadsheetApp
.openById('1234567890abcdefghijklmnopqrstuvwxyz')
.getActiveSheet()
.getDataRange()
.getValues();
return t.evaluate();
}
Index.html
<!DOCTYPE html>
<html>
<head>
<base target="_top">
</head>
<body>
<table>
<? for (var i = 0; i < data.length; i++) { ?>
<tr>
<? for (var j = 0; j < data[i].length; j++) { ?>
<td><?= data[i][j] ?></td>
<? } ?>
</tr>
<? } ?>
</table>
</body>
</html>
Modèles de débogage
Les modèles peuvent être difficiles à déboguer, car le code que vous écrivez n'est pas exécuté directement. Le serveur transforme votre modèle en code, puis exécute le code obtenu.
Si la manière dont le modèle interprète vos scriptlets n'est pas claire, deux méthodes de débogage de la classe HtmlTemplate peuvent vous aider à mieux comprendre le problème.
getCode()
getCode() renvoie une chaîne contenant le code que le serveur crée à partir du modèle. Si vous enregistrez le code, puis que vous le collez dans l'éditeur de script, vous pouvez l'exécuter et le déboguer comme un code Apps Script normal.
Voici le modèle simple qui affiche à nouveau la liste des produits Google, suivi du résultat de getCode():
Code.gs
function myFunction() {
Logger.log(HtmlService
.createTemplateFromFile('Index')
.getCode());
}
Index.html
<!DOCTYPE html>
<html>
<head>
<base target="_top">
</head>
<body>
<?= 'My favorite Google products:' ?>
<? var data = ['Gmail', 'Docs', 'Android'];
for (var i = 0; i < data.length; i++) { ?>
<b><?= data[i] ?></b>
<? } ?>
</body>
</html>
JOURNAL (ÉVALUATION)
(function() { var output = HtmlService.initTemplate(); output._ = '<!DOCTYPE html>\n';
output._ = '<html>\n' +
' <head>\n' +
' <base target=\"_top\">\n' +
' </head>\n' +
' <body>\n' +
' '; output._$ = 'My favorite Google products:' ;
output._ = ' '; var data = ['Gmail', 'Docs', 'Android'];
for (var i = 0; i < data.length; i++) { ;
output._ = ' <b>'; output._$ = data[i] ; output._ = '</b>\n';
output._ = ' '; } ;
output._ = ' </body>\n';
output._ = '</html>';
/* End of user code */
return output.$out.append('');
})();
getCodeWithComments()
getCodeWithComments() est semblable à getCode(), mais renvoie le code évalué sous forme de commentaires qui apparaissent côte à côte avec le modèle d'origine.
Parcourir le code évalué
La première chose que vous remarquerez dans ces exemples de code évalué est l'objet output implicite créé par la méthode HtmlService.initTemplate(). Cette méthode n'est pas documentée, car seuls les modèles doivent l'utiliser. output est un objet HtmlOutput spécial avec deux propriétés au nom inhabituel, _ et _$, qui sont des raccourcis pour appeler append() et appendUntrusted().
output possède une autre propriété spéciale, $out, qui fait référence à un objet HtmlOutput standard qui ne possède pas ces propriétés spéciales. Le modèle renvoie cet objet normal à la fin du code.
Maintenant que vous comprenez cette syntaxe, le reste du code devrait être assez facile à suivre. Le contenu HTML en dehors des scriptlets (comme la balise b) est ajouté à l'aide de output._ = (sans échappement contextuel), tandis que les scriptlets sont ajoutés en tant que JavaScript (avec ou sans échappement contextuel, selon le type de scriptlet).
Notez que le code évalué conserve les numéros de ligne du modèle. Si vous obtenez une erreur lors de l'exécution du code évalué, la ligne correspond au contenu équivalent dans le modèle.
Hiérarchie des commentaires
Étant donné que le code évalué conserve les numéros de ligne, il est possible que les commentaires figurant dans les scriptlets mettent en commentaire d'autres scriptlets, voire du code HTML. Ces exemples montrent quelques effets surprenants des commentaires:
<? var x; // a comment ?> This sentence won't print because a comment begins inside a scriptlet on the same line.
<? var y; // ?> <?= "This sentence won't print because a comment begins inside a scriptlet on the same line.";
output.append("This sentence will print because it's on the next line, even though it's in the same scriptlet.”) ?>
<? doSomething(); /* ?>
This entire block is commented out,
even if you add a */ in the HTML
or in a <script> */ </script> tag,
<? until you end the comment inside a scriptlet. */ ?>