Extender 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 menús, cuadros de diálogo y barras laterales nuevos.

Conceptos básicos

Apps Script puede interactuar con Documentos de Google de dos maneras amplias: cualquier secuencia de comandos puede crear o modificar un documento si el usuario de la secuencia de comandos tiene los permisos adecuados, y una secuencia de comandos también se puede vincular a un documento, lo que le da capacidades especiales para modificar 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 fácil 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 y, luego, inserta un párrafo que contiene el mismo texto que el nombre del documento, le aplica un estilo a ese párrafo como encabezado y agrega una tabla en función de los valores de un array bidimensional. La secuencia de comandos podría realizar estos cambios con la misma facilidad en un documento existente 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 se estructura de manera muy similar a un documento HTML, es decir, un documento de Google está compuesto por elementos (como Paragraph o Table) que suelen contener 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 Footnotes.

Sin embargo, existen reglas sobre los tipos de elementos que 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 muestra qué elementos puede contener un tipo determinado de elemento.

Los elementos que se muestran en negrita se pueden insertar; los que no están en negrita solo se pueden manipular en su lugar.

Cómo reemplazar texto

A menudo, Apps Script se usa para reemplazar texto en Documentos de Google. Supongamos que tienes una hoja de cálculo llena de información del cliente y deseas generar un documento de Google personalizado para cada uno de ellos. Este tipo de operación suele denominarse combinación de correo electrónico.

Existen muchas formas de reemplazar texto, pero la más simple es el método replaceText() que se muestra en el siguiente ejemplo. replaceText es compatible con la mayoría de las funciones de expresión regular de JavaScript. La primera función que se muestra 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 tú mismo. 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 dentro de 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.

Consulta cómo agregar menús y diálogos personalizados a tus Documentos de Google. Si quieres obtener más información sobre cómo crear interfaces personalizadas para un diálogo o una barra lateral, consulta la guía del servicio HTML. Si quieres 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 dentro de 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 deseas compartirla con el mundo, Apps Script te permite publicar tu secuencia de comandos como un complemento para que otros usuarios puedan instalarla desde la tienda de complementos.

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

Activadores

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

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