Extiende Documentos de Google

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

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 su usuario tiene los permisos adecuados para el documento, y una secuencia de comandos también se puede vincular a un documento, lo que le brinda la capacidad especial de 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 ambos casos, 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, inserta un párrafo que contiene el mismo texto que el nombre del documento, diseña ese párrafo como un encabezado y agrega una tabla en función de los valores en un arreglo de dos dimensiones. La secuencia de comandos puede realizar estos cambios con facilidad en un documento existente si reemplaza la llamada a DocumentApp.create() por DocumentApp.openById() o openByUrl(). Para 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 HeaderSection, FooterSection y cualquier 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 muestran los elementos que puede contener un tipo de elemento determinado.

Se pueden insertar los elementos que aparecen en negrita; los elementos que no lo son 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 quieres generar un documento de Google Docs personalizado para cada cliente. (este tipo de operación suele llamarse combinación de correo electrónico).

Hay muchas formas de reemplazar el texto, pero el 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 a continuación agrega varias líneas de texto de marcador de posición a un documento 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().

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

Para personalizar Documentos de Google, agrega 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 la secuencia de comandos está vinculada al documento.

Consulta cómo agregar menús personalizados y diálogos a tus Documentos de Google. A fin de 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 HTML. Si planeas publicar la interfaz personalizada como parte de un complemento, sigue la guía de estilo a fin de mantener la coherencia con el estilo y la organización 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 la secuencia de comandos como un complemento a fin de que otros usuarios puedan instalarla desde la tienda de complementos.

Si deseas ver cómo puedes crear un complemento para Documentos de Google, consulta la guía de inicio rápido a fin de 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 que tiene 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.