E-Mail-Zusammenführung

In diesem Leitfaden wird erläutert, wie Sie mit der Google Docs API eine Zusammenstellung von E-Mail-Inhalten durchführen.

Einleitung

Bei einer Zusammenstellung von E-Mail-Inhalten werden Werte aus den Zeilen einer Tabelle oder einer anderen Datenquelle in eine Vorlage eingefügt. Auf diese Weise können Sie ein einzelnes primäres Dokument (die Vorlage) erstellen, aus dem Sie viele ähnliche Dokumente generieren können, die jeweils mit den zusammengeführten Daten angepasst wurden. Das Ergebnis wird nicht unbedingt für Post- oder Formularbriefe verwendet, sondern für jeden beliebigen Zweck, z. B. das Erstellen eines Batches von Kundenrechnungen.

Die Zusammenstellung von E-Mail-Inhalten gibt es schon so lange, wie es Tabellenkalkulationen und Textverarbeitungsprogramme gibt, und ist heute Teil vieler geschäftlicher Workflows. Die Konvention besteht darin, die Daten als einen Datensatz pro Zeile zu organisieren, wobei die Spalten Felder in den Daten darstellen, wie in der folgenden Tabelle dargestellt:

Name Adresse Zone
1 UrbanPq Musterstraße 123 West
2 Logo: Pawxana Musterstraße 456 Süd

Die Beispielanwendung auf dieser Seite zeigt, wie Sie die APIs von Google Docs, Tabellen und Drive verwenden können, um die Details der Zusammenstellung von E-Mail-Inhalten abstrahieren und Nutzer vor Implementierungsproblemen zu schützen. Weitere Informationen zu diesem Python-Beispiel finden Sie im GitHub-Repository des Beispiels.

Beispielanwendung

Diese Beispielanwendung kopiert Ihre primäre Vorlage und führt dann Variablen aus der angegebenen Datenquelle mit den einzelnen Kopien zusammen. Um diese Beispiel-App auszuprobieren, richten Sie zuerst Ihre Vorlage ein:

  1. Erstellen Sie eine Google Docs-Datei. Wählen Sie die Vorlage aus, die Sie verwenden möchten.
  2. Notieren Sie sich die Dokument-ID der neuen Datei. Weitere Informationen finden Sie unter Dokument-ID.
  3. Legen Sie die Variable DOCS_FILE_ID auf die Dokument-ID fest.
  4. Ersetzen Sie die Kontaktdaten durch Platzhaltervariablen, die von der Anwendung mit den ausgewählten Daten zusammengeführt werden.

Hier finden Sie eine Beispielbriefvorlage mit Platzhaltern, die mit echten Daten aus einer Quelle wie Nur-Text oder Tabellen zusammengeführt werden können. So sieht diese Vorlage aus:

Wählen Sie dann mithilfe der Variablen SOURCE entweder Nur Text oder Google Tabellen als Datenquelle aus. Für das Beispiel wird standardmäßig nur Text verwendet, d. h. für die Beispieldaten wird die Variable TEXT_SOURCE_DATA verwendet. Wenn Sie Daten aus Google Tabellen beziehen möchten, aktualisieren Sie die Variable SOURCE in 'sheets' und verweisen Sie auf unsere Beispieltabelle (oder Ihre eigene), indem Sie die Variable SHEETS_FILE_ID festlegen.

Das Tabellenblatt sieht so aus, damit Sie das Format sehen können:

Testen Sie die App mit unseren Beispieldaten und passen Sie sie dann an Ihre Daten und Ihren Anwendungsfall an. Die Befehlszeilenanwendung funktioniert so:

  • Einrichtung
  • Daten aus der Datenquelle abrufen
  • Jede Datenzeile mit einer Schleife durchlaufen
    • Kopie der Vorlage erstellen
    • Kopie mit den Daten zusammenführen
    • Ausgabelink zum neu zusammengeführten Dokument

Alle neu zusammengeführten Buchstaben werden auch unter „Meine Ablage“ des Nutzers angezeigt. Ein Beispiel für einen zusammengeführten Buchstaben sieht in etwa so aus:

Quellcode

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))
    )

Weitere Informationen finden Sie in der Datei README und im vollständigen Anwendungsquellcode im GitHub-Repository der Beispielanwendung.