Servicio HTML: HTML basado en plantillas

Puedes combinar código de Apps Script y HTML para producir páginas dinámicas con un esfuerzo mínimo. Si usaste un lenguaje de plantillas que combina código y HTML, como PHP, ASP o JSP, la sintaxis debería resultarte familiar.

Guiones

Las plantillas de Apps Script pueden contener tres etiquetas especiales, denominadas scriptlets. Dentro de un scriptlet, puedes escribir cualquier código que funcione en un archivo normal de Apps Script: los scriptlets pueden llamar a funciones definidas en otros archivos de código, hacer referencia a variables globales o usar cualquiera de las APIs de Apps Script. Incluso puedes definir funciones y variables dentro de los scriptlets, con la salvedad de que no se pueden llamar por funciones definidas en los archivos de código u otras plantillas.

Si pegas el siguiente ejemplo en el editor de secuencia de comandos, el contenido de la etiqueta <?= ... ?> (un scriptlet de impresión) aparecerá en cursiva. Ese código en cursiva se ejecuta en el servidor antes de que se entregue la página al usuario. Debido a que el código de scriptlet se ejecuta antes de que se entregue la página, solo se puede ejecutar una vez por página. A diferencia de las funciones de JavaScript del cliente o Apps Script que llamas a través de google.script.run, los scriptlets no pueden ejecutarse de nuevo después de que se carga la página.

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>

Ten en cuenta que la función doGet() para HTML con plantilla difiere de los ejemplos a fin de crear y entregar HTML básico. La función que se muestra aquí genera un objeto HtmlTemplate a partir del archivo HTML y, luego, llama a su método evaluate() para ejecutar los scriptlets y convertir la plantilla en un objeto HtmlOutput que la secuencia de comandos puede entregar al usuario.

Secuencias de comandos estándar

Los secuencias de comandos estándar, que usan la sintaxis <? ... ?>, ejecutan el código sin enviar contenido a la página de forma explícita. Sin embargo, como se muestra en este ejemplo, el resultado del código dentro de un scriptlet puede afectar el contenido HTML fuera del 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>

Impresión de secuencias de comandos

Los scriptlets de impresión, que usan la sintaxis <?= ... ?>, muestran los resultados de su código en la página mediante el escape contextual.

El escape contextual significa que Apps Script hace un seguimiento del contexto de salida en la página, dentro de un atributo HTML, dentro de una etiqueta script del cliente o en cualquier otro lugar, y agrega automáticamente caracteres de escape para brindar protección contra ataques de secuencia de comandos entre sitios (XSS).

En este ejemplo, el primer scriptlet de impresión genera una string directamente; está seguido de un scriptlet estándar que configura un array y un bucle, y, luego, otro scriptlet de impresión para generar el contenido del array.

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>

Ten en cuenta que un scriptlet de impresión solo da como resultado el valor de su primera declaración; cualquier declaración restante se comporta como si estuviera contenida en un guion estándar. Por ejemplo, el scriptlet <?= 'Hello, world!'; 'abc' ?> solo imprime "Hello, world!"

Impresión forzada de secuencias de comandos

Los scriptlets de impresión forzada, que usan la sintaxis <?!= ... ?>, son como secuencias de comandos de impresión, excepto que evitan el escape contextual.

El escape contextual es importante si la secuencia de comandos permite entradas de usuarios que no son de confianza. Por el contrario, deberás forzar la impresión si el resultado de tu scriptlet contiene intencionalmente HTML o secuencias de comandos que deseas insertar exactamente como se especificó.

Como regla general, usa secuencias de comandos de impresión en lugar de forzar la impresión de secuencias de comandos, a menos que sepas que necesitas imprimir HTML o JavaScript sin cambios.

Código de Apps Script en scriptlets

Las secuencias de comandos no se limitan a la ejecución de JavaScript normal. También puedes usar cualquiera de las siguientes tres técnicas para otorgarles a tus plantillas acceso a los datos de Apps Script.

Sin embargo, recuerda que, debido a que el código de plantilla se ejecuta antes de que se entregue la página al usuario, estas técnicas solo pueden brindar contenido inicial a una página. Para acceder a los datos de Apps Script desde una página de manera interactiva, usa la API de google.script.run en su lugar.

Llama a funciones de Apps Script desde una plantilla

Los Scriptlets pueden llamar a cualquier función definida en un archivo de código o biblioteca de Apps Script. En este ejemplo, se muestra una manera de extraer datos de una hoja de cálculo en una plantilla y, luego, construir una tabla HTML a partir de los datos.

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>

Llama directamente a las APIs de Apps Script

También puedes usar el código de Apps Script directamente en los scriptlets. En este ejemplo, se obtiene el mismo resultado que en el ejemplo anterior cuando se cargan los datos en la plantilla en lugar de hacerlo a través de una función separada.

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>

Envía variables a plantillas

Por último, puedes enviar variables a una plantilla asignándolas como propiedades del objeto HtmlTemplate. Una vez más, este ejemplo logra el mismo resultado que los ejemplos anteriores.

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>

Plantillas de depuración

Puede ser difícil depurar las plantillas porque el código que escribes no se ejecuta directamente. En cambio, el servidor transforma la plantilla en código y, luego, ejecuta el código resultante.

Si no queda claro cómo interpreta la plantilla los scriptlets, hay dos métodos de depuración en la clase HtmlTemplate que pueden ayudarte a comprender mejor lo que sucede.

getCode()

getCode() muestra una cadena que contiene el código que crea el servidor a partir de la plantilla. Si registras el código y, luego, lo pegas en el editor de secuencias de comandos, puedes ejecutarlo y depurarlo como el código normal de Apps Script.

Esta es una plantilla simple que muestra de nuevo una lista de productos de Google, seguida del resultado 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>

REGISTRO (EVALUADO)

(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() es similar a getCode(), pero muestra el código evaluado como comentarios que aparecen al lado de la plantilla original.

Explicación del código evaluado

Lo primero que verás en cualquiera de las muestras de código evaluado es el objeto output implícito creado por el método HtmlService.initTemplate(). Este método no está documentado porque solo las plantillas necesitan usarlo. output es un objeto HtmlOutput especial con dos propiedades con nombres inusuales, _ y _$, que son la abreviatura de llamar a append() y appendUntrusted().

output tiene una propiedad especial más, $out, que hace referencia a un objeto HtmlOutput normal que no posee estas propiedades especiales. La plantilla muestra ese objeto normal al final del código.

Ahora que comprendes esta sintaxis, el resto del código debería ser bastante fácil de seguir. El contenido HTML fuera de los scriptlets (como la etiqueta b) se agrega con output._ = (sin elusión contextual), y los scriptlets se agregan como JavaScript (con o sin escape contextual, según el tipo de scriptlet).

Ten en cuenta que el código evaluado conserva los números de línea de la plantilla. Si recibes un error mientras ejecutas un código evaluado, la línea corresponderá al contenido equivalente en la plantilla.

Jerarquía de comentarios

Debido a que el código evaluado conserva los números de línea, es posible que los comentarios dentro de los scriptlets comenten otros secuencias de comandos, o incluso el código HTML. Estos ejemplos muestran algunos efectos sorprendentes de los comentarios:

<? 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. */ ?>