Este guia explica como usar a API Google Docs para fazer uma mala direta.
Introdução
Uma mala direta usa valores de linhas de uma planilha ou de outra fonte de dados
e insere em um documento modelo. Assim, você pode criar uma instância
documento (o modelo) a partir do qual é possível gerar muitos documentos semelhantes, cada
personalizado com os dados que estão sendo mesclados. O resultado não é necessariamente usado para
correspondência ou cartas de formulário, mas podem ser para qualquer finalidade, como gerar um lote de
faturas de clientes.
A mala direta existe desde que havia planilhas e palavras
processadores e faz parte de muitos
fluxos de trabalho empresariais hoje. A convenção é
organizar os dados como um registro por linha, com as colunas representando os campos em
os dados, conforme mostrado na tabela a seguir:
Nome
Endereço
Zona
1
UrbanPq
Avenida Brasil, 123
Oeste
2
Pawxana
Avenida Brasil, 123
Sul
O app de exemplo nesta página mostra como usar os recursos do Documentos Google,
Planilhas e Drive para abstrair
detalhes de como malas diretas são realizadas, protegendo usuários contra implementações
problemas. Mais informações sobre esse exemplo em Python podem ser encontradas no arquivo
GitHub
gcloud.
Exemplo de aplicativo
Este aplicativo de exemplo copia seu modelo principal e mescla as variáveis do seu
em cada uma das cópias. Para testar este app de exemplo, primeiro
configurar seu modelo:
Anote o ID do documento do novo arquivo. Para mais informações, consulte Documento
ID.
Defina a variável DOCS_FILE_ID como o ID do documento.
Substitua os dados de contato por variáveis de marcador de posição do modelo que o
com os dados selecionados.
Este é um exemplo de carta
modelo
com espaços reservados que podem ser mesclados com dados reais de uma fonte, como texto
texto ou Planilhas. Veja como é esse modelo:
Em seguida, escolha o texto simples ou as Planilhas como sua fonte de dados.
usando a variável SOURCE. A amostra usa texto simples como padrão, ou seja,
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
nossa amostra
página
(ou os seus) definindo a variável SHEETS_FILE_ID.
Para você conferir o formato da planilha, veja como ela é:
Teste o app com nossos dados de amostra e depois adapte-o aos seus dados e caso de uso. O
aplicativo de linha de comando funciona assim:
Configuração
buscar os dados na 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 letras mescladas recentemente também vão aparecer no Meu Drive do usuário. Um
exemplo de uma letra 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))
)
