Ampliación de Documentos de Google

Google Apps Script te permite crear y modificar Documentos de Google de manera programática, así como personalizar la interfaz de usuario con nuevos menús, cuadros de diálogo y barras laterales.

Conceptos básicos

Apps Script puede interactuar con Documentos de Google de dos maneras generales: cualquier secuencia de comandos puede crear o modificar un documento si el usuario tiene los permisos adecuados para el documento, y una secuencia de comandos también se puede vincular a un documento, lo que le otorga a la secuencia de comandos capacidades especiales para alterar la interfaz de usuario o responder cuando se abre el documento. Para crear una secuencia de comandos vinculada a un contenedor desde Documentos de Google, haz clic en Extensiones > Apps Script.

En cualquier caso, es sencillo interactuar con un documento de Google a través del Servicio de documentos de Apps Script, como se muestra en el siguiente ejemplo.

function createDoc() {
  var doc = DocumentApp.create('Sample Document');
  var body = doc.getBody();
  var rowsData = [['Plants', 'Animals'], ['Ficus', 'Goat'], ['Basil', 'Cat'], ['Moss', 'Frog']];
  body.insertParagraph(0, doc.getName())
      .setHeading(DocumentApp.ParagraphHeading.HEADING1);
  table = body.appendTable(rowsData);
  table.getRow(0).editAsText().setBold(true);
}

La secuencia de comandos anterior crea un documento nuevo en la unidad de Google Drive del usuario, luego inserta un párrafo que contiene el mismo texto que el nombre del documento, aplica el estilo del párrafo como encabezado y agrega una tabla basada en los valores de un array bidimensional. La secuencia de comandos podría realizar estos cambios en un documento existente con la misma facilidad si reemplaza la llamada a DocumentApp.create() por DocumentApp.openById() o openByUrl(). Para las secuencias de comandos creadas dentro de un documento (vinculado al contenedor), usa DocumentApp.getActiveDocument().

Estructura de un documento

Desde la perspectiva de Apps Script, un documento de Google tiene una estructura muy similar a un documento HTML, es decir, un documento de Google está compuesto por elementos (como Paragraph o Table) que, a menudo, contienen otros elementos. La mayoría de las secuencias de comandos que modifican un documento de Google comienzan con una llamada a getBody(), ya que Body es un elemento principal que contiene todos los demás elementos, excepto HeaderSection, FooterSection y cualquier Footnotes.

Sin embargo, existen reglas sobre qué tipos de elementos pueden contener otros tipos. Además, el servicio de documentos de Apps Script solo puede insertar ciertos tipos de elementos. En el siguiente árbol, se muestran los elementos que pueden contener un determinado tipo de elemento.

Los elementos que aparecen en negrita se pueden insertar, mientras que los que no están en negrita solo se pueden manipular en el lugar.

Reemplazo de texto

Apps Script suele usarse para reemplazar texto en Documentos de Google. Digamos que tienes una hoja de cálculo llena de información del cliente y deseas generar un documento de Google personalizado para cada cliente. (Este tipo de operación suele llamarse combinación de correo electrónico).

Existen muchas formas de reemplazar texto, pero la más simple es usar el método replaceText() que se muestra en el siguiente ejemplo. replaceText admite la mayoría de las funciones de expresión regular de JavaScript. La primera función que aparece a continuación agrega varias líneas de texto de marcadores de posición a Documentos de Google. En el mundo real, es más probable que escribas los marcadores de posición en el documento por tu cuenta. La segunda función reemplaza los marcadores de posición por propiedades definidas en el objeto client.

Ten en cuenta que ambas funciones usan el método getActiveDocument(), que solo se aplica a las secuencias de comandos creadas en un documento de Google. En una secuencia de comandos independiente, usa DocumentApp.create(), openById() o openByUrl() en su lugar.

Agrega algunos marcadores de posición

function createPlaceholders() {
  var body = DocumentApp.getActiveDocument().getBody();
  body.appendParagraph('{name}');
  body.appendParagraph('{address}');
  body.appendParagraph('{city} {state} {zip}');
}

Reemplaza los marcadores de posición

function searchAndReplace() {
  var body = DocumentApp.getActiveDocument()
      .getBody();
  var client = {
    name: 'Joe Script-Guru',
    address: '100 Script Rd',
    city: 'Scriptville',
    state: 'GA',
    zip: 94043
  };

  body.replaceText('{name}', client.name);
  body.replaceText('{address}', client.address);
  body.replaceText('{city}', client.city);
  body.replaceText('{state}', client.state);
  body.replaceText('{zip}', client.zip);
}

Interfaces de usuario y menús personalizados

Puedes personalizar Documentos de Google si agregas menús, cuadros de diálogo y barras laterales. Sin embargo, ten en cuenta que una secuencia de comandos solo puede interactuar con la IU de la instancia actual de un documento abierto y solo si está vinculada al documento.

Descubre cómo agregar menús personalizados y diálogos a tus Documentos de Google. Si deseas obtener más información sobre cómo crear interfaces personalizadas para un diálogo o la barra lateral, consulta la guía del servicio HTML. Si planeas publicar tu interfaz personalizada como parte de un complemento, sigue la guía de estilo para mantener la coherencia con el estilo y el diseño del editor de Documentos de Google.

Complementos para Documentos de Google

Los complementos se ejecutan en Documentos de Google y se pueden instalar desde la tienda de complementos de Documentos de Google. Si desarrollaste una secuencia de comandos para Documentos de Google y quieres compartirla con el mundo, Apps Script te permite publish la secuencia de comandos como un complemento para que otros usuarios puedan instalarla desde la tienda de complementos.

Si quieres ver cómo crear un complemento para Documentos de Google, consulta la guía de inicio rápido sobre cómo compilar complementos de Documentos.

Activadores

Las secuencias de comandos vinculadas a un documento de Google pueden usar un activador simple para responder al evento onOpen del documento, que ocurre cada vez que un usuario con acceso de edición al documento lo abre en Documentos de Google.

Para configurar el activador, solo escribe una función llamada onOpen(). Para ver un ejemplo de este activador, consulta Menús personalizados en Google Workspace. Aunque el activador simple es útil para agregar menús, no puede usar ningún servicio de Apps Script que requiera autorización.