Zusammenstellung von E-Mail-Inhalten mit der Docs API
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
In diesem Leitfaden wird erläutert, wie Sie mit der Google Docs API eine Zusammenstellung von E-Mail-Inhalten durchführen.
Einführung
Bei einer Zusammenstellung von E-Mail-Inhalten werden Werte aus den Zeilen einer Tabelle oder einer anderen Datenquelle übernommen.
und fügt sie in eine Vorlage ein. So können Sie eine primäre
Dokument (die Vorlage), aus dem Sie viele ähnliche Dokumente generieren können,
mit den zusammengeführten Daten angepasst. Das Ergebnis wird nicht unbedingt
E-Mails oder Formularbriefen, können aber für jeden Zweck eingesetzt werden, z. B. zum Generieren eines Stapels von
Rechnungen von Kunden.
Die Zusammenstellung von E-Mail-Inhalten gibt es schon so lange,
Prozessoren und gehört heute zu vielen Geschäftsabläufen. Konventionell ist es,
die Daten als einen Datensatz pro Zeile organisieren, wobei die Spalten Felder in
wie in der folgenden Tabelle dargestellt:
Name
Adresse
Zone
1
UrbanPq
Musterstraße 123
West
2
Logo: Pawxana
Musterstraße 456
Süd
Die Beispiel-App auf dieser Seite zeigt, wie Sie Google Docs,
Tabellen- und Drive-APIs abstrahieren,
Details zur Zusammenstellung von E-Mail-Inhalten zum Schutz der Nutzer vor der Implementierung
Bedenken. Weitere Informationen zu diesem Python-Beispiel finden Sie in der
GitHub
Repository.
Beispielanwendung
Diese Beispiel-App kopiert Ihre primäre Vorlage und führt dann Variablen aus Ihrem
Datenquelle in jede der Kopien ein. Um diese Beispiel-App auszuprobieren,
Richten Sie Ihre Vorlage ein:
Notieren Sie sich die Dokument-ID der neuen Datei. Weitere Informationen finden Sie unter Document
ID angeben.
Legen Sie die Variable DOCS_FILE_ID auf die Dokument-ID fest.
Ersetzen Sie die Kontaktinformationen durch Vorlagen-Platzhaltervariablen, die die
App mit den ausgewählten Daten zusammengeführt.
Hier ist ein Beispielbrief
Vorlage
mit Platzhaltern, die mit echten Daten aus einer Quelle wie "einfach" zusammengeführt werden können
Text oder Tabellen. So sieht diese Vorlage aus:
Wählen Sie dann entweder „Nur Text“ oder „Tabellen“ als Datenquelle aus.
mit der Variablen SOURCE. Im Beispiel wird standardmäßig nur Text verwendet, d. h.
In den Beispieldaten wird die Variable TEXT_SOURCE_DATA verwendet. Um Daten zu beziehen von
Tabellen ändern, aktualisieren Sie die Variable SOURCE in 'sheets' und weisen Sie darauf zu.
zu unserer Probe
Tabelle
(oder Ihre eigenen), 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 als 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. Eine
Ein zusammengeführter Buchstabe sieht in etwa so aus:
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 Quellcode der Anwendung
im GitHub-Modul der Beispiel-App
Repository.