Combinar texto en un documento

Una aplicación útil de la API de Documentos de Google es combinar información de una o más fuentes de datos en un documento.

En esta página, se describe cómo puedes tomar datos de una fuente externa y, luego, insertarlos en un documento de plantilla existente.

Una plantilla es un tipo especial de documento que contiene el mismo texto fijo en todos los documentos creados a partir de ella, junto con marcadores de posición designados en los que se puede colocar otro texto dinámico. Por ejemplo, una plantilla de contrato podría tener contenido fijo, junto con espacios para el nombre, la dirección y otros detalles del destinatario. Luego, tu app puede fusionar datos específicos del cliente en la plantilla para crear documentos terminados.

Existen varias razones por las cuales este enfoque resulta útil:

• Los diseñadores pueden ajustar el diseño de un documento con facilidad con el editor de Documentos de Google. Esto es mucho más fácil que ajustar parámetros en tu app para establecer el diseño renderizado.

• Separar el contenido de la presentación es un principio de diseño conocido que tiene muchos beneficios.

Una receta básica

Este es un ejemplo de cómo puedes usar la API de Documentos para combinar datos en un documento:

1. Crea tu documento con contenido de marcador de posición como ayuda para el diseño y el formato. El formato de texto que quieras reemplazar se conserva.

2. Para cada elemento que insertarás, reemplaza el contenido del marcador de posición por una etiqueta. Asegúrate de usar cadenas que tienen pocas probabilidades de ocurrir normalmente. Por ejemplo, {{account-holder-name}} podría ser una buena etiqueta.

3. En tu código, usa la API de Google Drive para crear una copia del documento.

4. En tu código, usa el método batchUpdate() de la API de Documentos con el nombre del documento y, luego, incluye una ReplaceAllTextRequest.

Los IDs de documento hacen referencia a un documento y pueden derivar de la URL

https://docs.google.com/document/d/documentId/edit

Ejemplo

Considera el siguiente ejemplo, en el que se reemplazan 2 campos en una plantilla por valores reales para generar un documento terminado.

Para realizar esta combinación, puedes usar el siguiente código.

        String customerName = "Alice";
        DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy/MM/dd");
        String date = formatter.format(LocalDate.now());

        List<Request> requests = new ArrayList<>();
        requests.add(new Request()
                .setReplaceAllText(new ReplaceAllTextRequest()
                        .setContainsText(new SubstringMatchCriteria()
                                .setText("{{customer-name}}")
                                .setMatchCase(true))
                        .setReplaceText(customerName)));
        requests.add(new Request()
                .setReplaceAllText(new ReplaceAllTextRequest()
                        .setContainsText(new SubstringMatchCriteria()
                                .setText("{{date}}")
                                .setMatchCase(true))
                        .setReplaceText(date)));

        BatchUpdateDocumentRequest body = new BatchUpdateDocumentRequest();
        service.documents().batchUpdate(documentId, body.setRequests(requests)).execute();

  let customerName = 'Alice';
  let date = yyyymmdd()
  let requests = [
    {
      replaceAllText: {
        containsText: {
          text: '{{customer-name}}',
          matchCase: true,
        },
        replaceText: customerName,
      },
    },
    {
      replaceAllText: {
        containsText: {
          text: '{{date}}',
          matchCase: true,
        },
        replaceText: date,
      },
    },
  ];

  google.options({auth: auth});
  google
      .discoverAPI(
          'https://docs.googleapis.com/$discovery/rest?version=v1&key={YOUR_API_KEY}')
      .then(function(docs) {
        docs.documents.batchUpdate(
            {
              documentId: '1yBx6HSnu_gbV2sk1nChJOFo_g3AizBhr-PpkyKAwcTg',
              resource: {
                requests,
              },
            },
            (err, {data}) => {
              if (err) return console.log('The API returned an error: ' + err);
              console.log(data);
            });
      });

    customer_name = 'Alice'
    date = datetime.datetime.now().strftime("%y/%m/%d")

    requests = [
         {
            'replaceAllText': {
                'containsText': {
                    'text': '{{customer-name}}',
                    'matchCase':  'true'
                },
                'replaceText': customer_name,
            }}, {
            'replaceAllText': {
                'containsText': {
                    'text': '{{date}}',
                    'matchCase':  'true'
                },
                'replaceText': str(date),
            }
        }
    ]

    result = service.documents().batchUpdate(
        documentId=document_id, body={'requests': requests}).execute()

Administrar plantillas

Para los documentos de plantilla que la aplicación define y posee, crea la plantilla usando una cuenta dedicada que represente a la aplicación. Las cuentas de servicio son una buena opción y evitan complicaciones con las políticas de Google Workspace que restringen el uso compartido.

Cuando crees instancias de documentos a partir de plantillas, usa siempre credenciales de usuario final. Esto brinda a los usuarios control total sobre el documento resultante y evita problemas de escalamiento relacionados con límites por usuario en Drive.

Para crear una plantilla con una cuenta de servicio, realiza los siguientes pasos con las credenciales de la aplicación:

1. Crea un documento con documents.create en la API de Documentos.
2. Actualiza los permisos para permitir que los destinatarios del documento lo lean con permissions.create en la API de Drive.
3. Actualiza los permisos para permitir que los autores de plantillas escriban en ella con permissions.create en la API de Drive.
4. Edita la plantilla según sea necesario.

Para crear una instancia del documento, realiza los siguientes pasos con las credenciales de usuario:

1. Crea una copia de la plantilla con files.copy en la API de Drive.
2. Reemplaza valores con documents.batchUpdate en la API de Documentos.