Uma mesclagem de e-mails pega os valores das linhas de uma planilha ou de outra fonte de dados e os insere em um documento de modelo. Isso permite criar um único documento "mestre" (o modelo) a partir do qual você pode gerar muitos documentos semelhantes, cada um personalizado com os dados que estão sendo mesclados. O resultado não é necessariamente usado para
e-mail ou letras de formulário, mas pode ser para qualquer finalidade, como gerar um
lote de faturas de cliente.
A mesclagem de e-mails existe desde que houve planilhas e processadores de texto e faz parte de muitos fluxos de trabalho empresariais atualmente. A convenção é organizar os dados como um registro por linha, com as colunas representando os campos nos dados, conforme mostrado na tabela a seguir:
R
B
C
1
Nome
Address
Zona
2
Pq urbano
123 1st St.
Oeste
3
Pawxnay
456 2nd St.
Sul
4
etc...
O aplicativo de amostra desta página mostra como usar as APIs Google Docs e Sheets (e Drive) para abstrair os detalhes de como as malas diretas são executadas, protegendo os usuários de preocupações de implementação. Veja mais informações sobre esta amostra no repositório de código aberto dela.
Exemplo de aplicativo
Esse aplicativo de amostra copia o modelo mestre e mescla variáveis da fonte de dados designada em cada uma das cópias. Para testar o app de amostra, primeiro configure seu modelo:
Observe o ID do documento, que é a string depois de document/d/ (consulte DOCUMENT_ID) no URL: https://docs.google.com/document/d/DOCUMENT_ID/edit
Defina a variável DOCS_FILE_ID no código para esse ID do documento.
Substitua os dados de contato no Documento por variáveis de marcador de modelo que o app combinará com os dados desejados.
Veja nosso modelo de carta de amostra com marcadores para serem mesclados com dados reais de uma fonte como uma Planilha Google ou um texto simples. O modelo ficará assim:
Em seguida, escolha texto simples ou Planilhas Google como sua fonte de dados definindo a variável SOURCE. O padrão é texto simples, o que significa os dados de amostra na variável TEXT_SOURCE_DATA. Para fonte de dados de uma Planilha Google, atualize a variável SOURCE para 'sheets' e aponte-a para nossa amostra (ou a sua) definindo a variável SHEETS_FILE_ID. Esta é nossa planilha para você ter uma ideia do formato:
Teste o app com nossos dados de amostra e adapte-os aos seus dados e caso de uso. O aplicativo de linha de comando funciona assim:
Configuração
Buscar os dados da fonte de dados
Repetir cada linha de dados
Criar uma cópia do modelo
Mesclar a cópia com os dados
Link de saída para o documento recém-mesclado
Todas as novas letras mescladas também aparecem no Google Drive do usuário. Um exemplo de letra mesclada tem esta aparência:
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 mais informações, consulte o README e o código-fonte completo do aplicativo no repositório de código aberto (link em inglês) deste app de amostra.
