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 tiene los permisos adecuados para el documento, y una secuencia de comandos también puede estar vinculada a un documento, lo que le da la capacidad especial de modificar la interfaz del 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 ambos casos, 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, diseña los párrafos como un encabezado y agrega una tabla basada en los valores de un arreglo bidimensional. La secuencia de comandos podría realizar estos cambios en un documento existente con la misma facilidad, ya que reemplaza la llamada a DocumentApp.create() por DocumentApp.openById() o openByUrl(). Para las secuencias de comandos creadas dentro de un documento (vinculadas a contenedores), usa DocumentApp.getActiveDocument().

Estructura de un documento

Desde la perspectiva de Apps Script, un documento de Google se estructura de manera similar a un documento HTML, es decir, un documento de Google consta de 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 , FooterSection y cualquier Footnotes.HeaderSection

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 muestran los elementos que puede contener un determinado tipo de elemento.

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

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 documentos de Google personalizados para cada cliente. (este tipo de operación a menudo se denomina combinación de correo electrónico).

Existen muchas formas de reemplazar el texto, pero la más simple es 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 marcador 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. La segunda función reemplaza los marcadores de posición por las 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().

Cómo agregar 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 para la instancia actual de un documento abierto y solo si la secuencia está vinculada al documento.

Consulta cómo agregar menús personalizados y diálogos a Documentos de Google. Si deseas obtener más información sobre la creación de interfaces personalizadas para un diálogo o una barra lateral, consulta la Guía de servicio de 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 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 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 deseas ver cómo puedes crear un complemento de Documentos de Google, consulta la guía de inicio rápido para compilar 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 del documento onOpen, que se produce cada vez que un usuario con acceso de edición del 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.