Combinación de correo electrónico con la API de Documentos

En esta guía, se explica cómo usar la API de Documentos de Google para realizar una combinación de correspondencia.

Nota: Si quieres realizar una combinación de correo electrónico con la IU web de Gmail, consulta Cómo enviar correos electrónicos personalizados con la combinación de correo electrónico.

Introducción

Una fusión de correspondencia toma valores de las filas de una hoja de cálculo o de otra fuente de datos y los inserta en un documento de plantilla. Esto te permite crear un solo documento primario (la plantilla) a partir del cual puedes generar muchos documentos similares, cada uno personalizado con los datos que se combinan. El resultado no se usa necesariamente para correos electrónicos ni cartas de formularios, sino que puede usarse para cualquier propósito, como generar un lote de facturas de clientes.

La combinación de correspondencia existe desde que existen las hojas de cálculo y los procesadores de texto, y hoy forma parte de muchos flujos de trabajo empresariales. La convención es organizar los datos como un registro por fila, con las columnas que representan campos en los datos, como se muestra en la siguiente tabla:

	Nombre	Dirección	Zona
1	UrbanPq	Calle 123 1ª	Oeste
2	Pawxana	456 2nd St.	Sur

En la app de ejemplo de esta página, se muestra cómo puedes usar las APIs de Google Docs, Sheets y Drive para abstraer los detalles de cómo se realizan las fusiones de correspondencia, lo que protege a los usuarios de las preocupaciones de implementación. Puedes encontrar más información sobre este ejemplo de Python en el repositorio de GitHub del ejemplo.

Nota: Debes tener configurado un proyecto de Google Cloud para tener credenciales que te permitan hacer que esto funcione. Obtén más información en la Guía de inicio rápido de Python. Asegúrate de tener las APIs de Google Drive, Docs y Sheets habilitadas en tu proyecto y de que tu archivo JSON de credenciales se haya descargado como credentials.json.

Aplicación de ejemplo

Esta app de ejemplo copia tu plantilla principal y, luego, combina las variables de tu fuente de datos designada en cada una de las copias. Para probar esta app de ejemplo, primero configura tu plantilla:

1. Crea un archivo de Documentos. Elige la plantilla que quieras usar.
2. Anota el ID del documento del archivo nuevo. Para obtener más información, consulta ID de documento.
3. Establece la variable DOCS_FILE_ID como el ID del documento.
4. Reemplaza la información de contacto por variables de marcador de posición de plantilla que la app combinará con los datos seleccionados.

Esta es una plantilla de carta de muestra con marcadores de posición que se pueden combinar con datos reales de una fuente, como texto sin formato o Hojas de cálculo. Esta es la apariencia de esa plantilla:

La estructura de las variables de la plantilla es arbitraria. En el ejemplo, se usan valores encerrados entre llaves dobles {{VALUE}} porque es muy poco probable que un texto como este aparezca en el contenido del documento. Este estilo de nombres de marcadores de posición de variables es similar al que encontrarás en la mayoría de las bibliotecas de plantillas.

A continuación, elige texto sin formato o Hojas de cálculo como fuente de datos con la variable SOURCE. El valor predeterminado de la muestra es texto sin formato, lo que significa que los datos de muestra usan la variable TEXT_SOURCE_DATA. Para obtener datos de Hojas de cálculo, actualiza la variable SOURCE a 'sheets' y configúrala para que apunte a nuestra hoja de cálculo de muestra (o la tuya propia) configurando la variable SHEETS_FILE_ID.

Así se ve la hoja para que puedas ver el formato:

Prueba la app con nuestros datos de muestra y, luego, ajústala a tus datos y caso de uso. La aplicación de línea de comandos funciona de la siguiente manera:

• Configuración
• Recupera los datos de la fuente de datos
• Realiza un bucle en cada fila de datos
  • Crea una copia de la plantilla
  • Combina la copia con los datos
  • Vínculo de salida al documento recién fusionado

Todas las letras combinadas recientemente también aparecen en Mi unidad del usuario. Un ejemplo de una carta combinada se ve de la siguiente manera:

Nota: En el caso de los documentos con varias pestañas, ReplaceAllTextRequest se aplica de forma predeterminada a todas las pestañas. Consulta la documentación de la solicitud para obtener más información sobre cómo trabajar con pestañas.

Código fuente

Python

docs/mail-merge/docs_mail_merge.py

Ver en GitHub

import time

import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError

# Fill-in IDs of your Docs template & any Sheets data source
DOCS_FILE_ID = "195j9eDD3ccgjQRttHhJPymLJUCOUjs-jmwTrekvdjFE"
SHEETS_FILE_ID = "11pPEzi1vCMNbdpqaQx4N43rKmxvZlgEHE9GqpYoEsWw"

# authorization constants

SCOPES = (  # iterable or space-delimited string
    "https://www.googleapis.com/auth/drive",
    "https://www.googleapis.com/auth/documents",
    "https://www.googleapis.com/auth/spreadsheets.readonly",
)

# application constants
SOURCES = ("text", "sheets")
SOURCE = "text"  # Choose one of the data SOURCES
COLUMNS = ["to_name", "to_title", "to_company", "to_address"]
TEXT_SOURCE_DATA = (
    (
        "Ms. Lara Brown",
        "Googler",
        "Google NYC",
        "111 8th Ave\nNew York, NY  10011-5201",
    ),
    (
        "Mr. Jeff Erson",
        "Googler",
        "Google NYC",
        "76 9th Ave\nNew York, NY  10011-4962",
    ),
)

# fill-in your data to merge into document template variables
merge = {
    # sender data
    "my_name": "Ayme A. Coder",
    "my_address": "1600 Amphitheatre Pkwy\nMountain View, CA  94043-1351",
    "my_email": "http://google.com",
    "my_phone": "[phone]",
    # - - - - - - - - - - - - - - - - - - - - - - - - - -
    # recipient data (supplied by 'text' or 'sheets' data source)
    "to_name": None,
    "to_title": None,
    "to_company": None,
    "to_address": None,
    # - - - - - - - - - - - - - - - - - - - - - - - - - -
    "date": time.strftime("%Y %B %d"),
    # - - - - - - - - - - - - - - - - - - - - - - - - - -
    "body": (
        "Google, headquartered in Mountain View, unveiled the new "
        "Android phone at the Consumer Electronics Show. CEO Sundar "
        "Pichai said in his keynote that users love their new phones."
    ),
}

creds, _ = google.auth.default()
# pylint: disable=maybe-no-member

# service endpoints to Google APIs

DRIVE = build("drive", "v2", credentials=creds)
DOCS = build("docs", "v1", credentials=creds)
SHEETS = build("sheets", "v4", credentials=creds)


def get_data(source):
  """Gets mail merge data from chosen data source."""
  try:
    if source not in {"sheets", "text"}:
      raise ValueError(
          f"ERROR: unsupported source {source}; choose from {SOURCES}"
      )
    return SAFE_DISPATCH[source]()
  except HttpError as error:
    print(f"An error occurred: {error}")
    return error


def _get_text_data():
  """(private) Returns plain text data; can alter to read from CSV file."""
  return TEXT_SOURCE_DATA


def _get_sheets_data(service=SHEETS):
  """(private) Returns data from Google Sheets source. It gets all rows of
  'Sheet1' (the default Sheet in a new spreadsheet), but drops the first
  (header) row. Use any desired data range (in standard A1 notation).
  """
  return (
      service.spreadsheets()
      .values()
      .get(spreadsheetId=SHEETS_FILE_ID, range="Sheet1")
      .execute()
      .get("values")[1:]
  )
  # skip header row


# data source dispatch table [better alternative vs. eval()]
SAFE_DISPATCH = {k: globals().get(f"_get_{k}_data") for k in SOURCES}


def _copy_template(tmpl_id, source, service):
  """(private) Copies letter template document using Drive API then
  returns file ID of (new) copy.
  """
  try:
    body = {"name": f"Merged form letter ({source})"}
    return (
        service.files()
        .copy(body=body, fileId=tmpl_id, fields="id")
        .execute()
        .get("id")
    )
  except HttpError as error:
    print(f"An error occurred: {error}")
    return error


def merge_template(tmpl_id, source, service):
  """Copies template document and merges data into newly-minted copy then
  returns its file ID.
  """
  try:
    # copy template and set context data struct for merging template values
    copy_id = _copy_template(tmpl_id, source, service)
    context = merge.iteritems() if hasattr({}, "iteritems") else merge.items()

    # "search & replace" API requests for mail merge substitutions
    reqs = [
        {
            "replaceAllText": {
                "containsText": {
                    "text": "{{%s}}" % key.upper(),  # {{VARS}} are uppercase
                    "matchCase": True,
                },
                "replaceText": value,
            }
        }
        for key, value in context
    ]

    # send requests to Docs API to do actual merge
    DOCS.documents().batchUpdate(
        body={"requests": reqs}, documentId=copy_id, fields=""
    ).execute()
    return copy_id
  except HttpError as error:
    print(f"An error occurred: {error}")
    return error


if __name__ == "__main__":
  # get row data, then loop through & process each form letter
  data = get_data(SOURCE)  # get data from data source
  for i, row in enumerate(data):
    merge.update(dict(zip(COLUMNS, row)))
    print(
        "Merged letter %d: docs.google.com/document/d/%s/edit"
        % (i + 1, merge_template(DOCS_FILE_ID, SOURCE, DRIVE))
    )

Para obtener más información, consulta el archivo README y el código fuente completo de la aplicación en el repositorio de GitHub de la app de ejemplo.

Temas relacionados

• Envía mensajes personalizados con la combinación de correo electrónico
• Cómo crear una combinación de correo electrónico con Gmail y Hojas de cálculo de Google