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 correo electrónico.
Introducción
Una combinación de correo electrónico 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 una única instancia
documento (la plantilla) a partir del cual puedes generar muchos documentos similares, cada uno
personalizar con los datos que se combinan. El resultado no se usa necesariamente para
cartas de formulario o correo electrónico, pero puede ser para cualquier propósito, como generar un lote de
las facturas de los clientes.
La combinación de correo electrónico existe desde hace tiempo que existen hojas de cálculo y
y 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 los campos en
los datos, como se muestra en la siguiente tabla:
Nombre
Dirección
Zona
1
UrbanPq
Calle 123
Oeste
2
Pawxana
San Martín 456
Sur
La app de ejemplo de esta página muestra cómo puedes usar la app de Documentos de Google,
las APIs de Hojas de cálculo y de Drive para abstraer
detallados sobre cómo se realizan las combinaciones de correo electrónico, lo que protege a los usuarios de la implementación
y preocupaciones de seguridad. Puedes encontrar más información sobre esta muestra de Python en
GitHub
repo.
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:
Anota el ID de documento del archivo nuevo. Para obtener más información, consulta Documento
de la aplicación.
Configura la variable DOCS_FILE_ID para el ID del documento.
Reemplaza la información de contacto con variables de marcador de posición de la plantilla
la app se combinará con los datos seleccionados.
Aquí hay una carta de ejemplo
plantilla
con marcadores de posición que pueden combinarse con datos reales de una fuente, como archivos
Hojas de cálculo o texto. Así se ve la plantilla:
A continuación, elige Hojas de cálculo o texto sin formato como fuente de datos.
con la variable SOURCE La muestra muestra texto sin formato de forma predeterminada, es decir,
datos de muestra usan la variable TEXT_SOURCE_DATA. Para obtener datos de
Hojas de cálculo, actualiza la variable SOURCE a 'sheets' y apúntala
para nuestra muestra
hoja
(o la tuya) 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 adáptala a tus datos y caso de uso. El
de línea de comandos funciona de la siguiente manera:
Configuración
Recupera los datos de la fuente de datos
Realizar un bucle a lo largo de cada fila de datos
Crea una copia de la plantilla.
Fusionar la copia con los datos
Vínculo de salida para el documento recién combinado
Todas las letras combinadas recientemente también aparecerán en la sección Mi unidad del usuario. Los
ejemplo de una letra combinada se ve así:
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": "+1-650-253-0000",
# - - - - - - - - - - - - - - - - - - - - - - - - - -
# 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 GitHub de la app de ejemplo
repo.