E-Mail-Zusammenführung

Einführung

Bei einer E-Mail-Zusammenführung werden Werte aus Zeilen einer Tabelle oder einer anderen Datenquelle in ein Vorlagendokument eingefügt. Dies ermöglicht Ihnen, ein einzelnes „Master“-Dokument (die Vorlage) zu erstellen, aus dem Sie viele ähnliche Dokumente generieren können, die jeweils mit den zusammengeführten Daten angepasst werden. Das Ergebnis wird nicht unbedingt für Post- oder Formularschreiben verwendet, kann aber für jeden Zweck, z. B. das Generieren von Batches von Kundenrechnungen, verwendet werden.

Bei der Zusammenstellung von E-Mail-Inhalten gibt es seit Langem Tabellen und Textverarbeitung. Das gehört jetzt zu vielen geschäftlichen Workflows. Gemäß der Konvention werden die Daten als ein Datensatz pro Zeile organisiert, wobei die Spalten Felder in den Daten darstellen, wie in der folgenden Tabelle dargestellt:

A B C
1 Name Adresse Zone
2 UrbanPq Musterstraße 123 Westen
3 Pawxana 456 2nd St. Süden
4 usw...

Die Beispielanwendung auf dieser Seite zeigt, wie Sie mit den APIs von Google Docs und Google Tabellen (und Drive) die Details zur Ausführung von Zusammenstellungen von E-Mail-Inhalten abstrahieren können, um Nutzer vor Bedenken bei der Implementierung zu schützen. Weitere Informationen zu diesem Beispiel finden Sie im Open-Source-Repository des Beispiels.

Beispielanwendung

In dieser Beispielanwendung wird Ihre Mastervorlage kopiert und dann werden Variablen aus der angegebenen Datenquelle mit den einzelnen Kopien zusammengeführt. Um die Beispielanwendung auszuprobieren, richten Sie zuerst Ihre Vorlage ein:

  • Erstellen Sie eine neue Google Docs-Datei. Wählen Sie die gewünschte Vorlage aus. In unserer Beispielvorlage wird Letter/Spearmint verwendet.
  • Beachten Sie die Dokument-ID. Das ist der String nach document/d/ (siehe DOCUMENT_ID) in der URL: https://docs.google.com/document/d/DOCUMENT_ID/edit
  • Legen Sie die DOCS_FILE_ID-Variable im Code auf diese Dokument-ID fest.
  • Ersetzen Sie die Kontaktdaten im Dokument durch Vorlagenplatzhaltervariablen, die die Anwendung mit den gewünschten Daten zusammengeführt.

Hier sehen Sie unsere Beispielvorlage mit Platzhaltern, die mit echten Daten aus einer Quelle wie Google Tabellen oder Nur-Text zusammengeführt werden. Hier ein Beispiel für eine Vorlage:

Legen Sie als Nächstes entweder die Nur-Text-Datei oder Google Tabellen als Datenquelle fest. Legen Sie dazu die Variable SOURCE fest. Der Standardwert ist reiner Text, also die Beispieldaten in der Variablen TEXT_SOURCE_DATA. Wenn Sie die Daten aus einer Google-Tabelle beziehen möchten, ändern Sie die Variable SOURCE in 'sheets' und verweisen Sie auf unser Beispiel (oder Ihre Variable). Legen Sie dazu die Variable SHEETS_FILE_ID fest. Hier ist unsere Tabelle, mit der du dir einen Eindruck vom Format verschaffen kannst:

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

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

Alle neuen zusammengeführten Buchstaben werden auch im Google Drive-Konto des Nutzers angezeigt. Hier ein Beispiel für einen zusammengeführten Buchstaben:

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 README-Datei sowie im vollständigen Anwendungsquellcode im Open-Source-Repository dieser Beispielanwendung.