Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Este guia explica como usar a API Google Docs para realizar uma mesclagem de e-mails.
Introdução
Uma fusão de correspondências usa valores de linhas de uma planilha ou de outra fonte de dados
e os insere em um documento de modelo. Assim, você pode criar um único documento
principal (o modelo) para gerar muitos documentos semelhantes, cada
um personalizado com os dados que estão sendo mesclados. O resultado não é necessariamente usado para
e-mails ou cartas de formulário, mas pode ser usado para qualquer finalidade, como gerar um lote de
faturas do cliente.
A mesclagem de correspondências existe desde que as planilhas e os processadores de texto
foram criados e faz parte de muitos fluxos de trabalho de negócios hoje. A convenção é
organizar os dados como um registro por linha, com as colunas representando campos nos
dados, conforme mostrado na tabela a seguir:
Nome
Endereço
Zona
1
UrbanPq
123 1st St.
Oeste
2
Pawxana
456 2nd St.
Sul
O app de exemplo nesta página mostra como usar as APIs Google Docs,
Sheets e Drive para abstrair os
detalhes de como as mesclagens de e-mails são realizadas, protegendo os usuários de problemas de
implementação. Para mais informações sobre esse exemplo em Python, acesse o
repositório
do GitHub.
Exemplo de aplicativo
Esse app de exemplo copia o modelo principal e mescla as variáveis da
fonte de dados designada em cada uma das cópias. Para testar este app de exemplo, primeiro
configure o modelo:
Anote o ID do novo arquivo. Para mais informações, consulte ID do
documento.
Defina a variável DOCS_FILE_ID como o ID do documento.
Substitua as informações de contato por variáveis de marcador de posição do modelo que o
app vai mesclar com os dados selecionados.
Confira um modelo de carta
de exemplo
com marcadores de posição que podem ser mesclados com dados reais de uma fonte, como texto
simples ou Planilhas. Confira como esse modelo fica:
Em seguida, escolha texto simples ou Planilhas como origem de dados
usando a variável SOURCE. O padrão é o texto simples, o que significa que os
dados de amostra usam a variável TEXT_SOURCE_DATA. Para extrair dados de
Planilhas, atualize a variável SOURCE para 'sheets' e aponte-a
para nossa planilha de amostra
(ou a sua própria) definindo a variável SHEETS_FILE_ID.
Confira como a planilha fica:
Teste o app com nossos dados de amostra e adapte-o aos seus dados e caso de uso. O
aplicativo de linha de comando funciona assim:
Configuração
Buscar os dados da fonte de dados
Fazer um loop em 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 cartas recém-mescladas também aparecem no Meu Drive do usuário. Um
exemplo de uma carta mesclada é mais ou menos assim:
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 arquivo README e o código-fonte completo do aplicativo
no repositório
do GitHub do app de exemplo.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Não contém as informações de que eu preciso","missingTheInformationINeed","thumb-down"],["Muito complicado / etapas demais","tooComplicatedTooManySteps","thumb-down"],["Desatualizado","outOfDate","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Problema com as amostras / o código","samplesCodeIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2024-11-23 UTC."],[[["This guide demonstrates how to utilize the Google Docs API to execute a mail merge, automating the process of generating personalized documents from a template and data source."],["Users can choose between plain text or a Google Sheet as their data source, with the sample app providing examples for both options."],["The application copies a template document, merges variables from the data source, and outputs a link to the newly-merged document, accessible in Google Drive."],["Placeholder variables within the template document are replaced with data from the designated source, allowing for customization of individual documents."],["Refer to the GitHub repository for the complete source code, setup instructions, and further information on using the sample application."]]],[]]