Mala direta com a API Docs

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 outra fonte de dados e os insere em um modelo de documento. Isso permite criar um único documento principal (o modelo) com base no 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 correspondências ou cartas modelo, mas pode ser para qualquer finalidade, como gerar um lote de faturas de clientes.

A mala direta existe há tanto tempo quanto as planilhas e os processadores de texto, e faz parte de muitos fluxos de trabalho comerciais 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 Rua 1º de Maio, 123 Oeste
2 Pawxana 456 2nd St. Sul

O app de exemplo nesta página mostra como usar as APIs do Google Docs, Planilhas e Drive para abstrair os detalhes de como as mala diretas são realizadas, protegendo os usuários de problemas de implementação. Para mais informações sobre essa amostra em Python, acesse o repositório do GitHub.

Exemplo de aplicativo

Esse app de exemplo copia seu modelo principal e mescla variáveis da fonte de dados designada em cada uma das cópias. Para testar esse app de exemplo, primeiro configure seu modelo:

  1. Crie um arquivo do Documentos. Escolha o modelo que você quer usar.
  2. Anote o ID do documento do novo arquivo. Para mais informações, consulte ID do documento.
  3. Defina a variável DOCS_FILE_ID como o ID do documento.
  4. 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 o Google Sheets. Veja como fica o modelo:

Em seguida, escolha texto simples ou Google Sheets como sua origem de dados usando a variável SOURCE. O exemplo usa texto simples por padrão, ou seja, os dados de amostra usam a variável TEXT_SOURCE_DATA. Para extrair dados das Planilhas Google, atualize a variável SOURCE para 'sheets' e aponte para nossa planilha de exemplo (ou a sua) definindo a variável SHEETS_FILE_ID.

Confira como a planilha aparece para entender o formato:

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 da seguinte maneira:

  • Configuração
  • Buscar os dados da fonte
  • Faça 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 carta mesclada é assim:

Código-fonte

Python

docs/mail-merge/docs_mail_merge.py
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.