Programmierstufe: Anfänger
Dauer: 10 Minuten
Projekttyp: Automatisierung mit einem benutzerdefinierten Menü
Zielsetzungen
- Verstehen Sie, was die Lösung leisten kann.
- Was die Apps Script-Dienste innerhalb der Lösung leisten
- Richten Sie das Skript ein.
- Führen Sie das Skript aus.
Informationen zu dieser Lösung
Daten aus Google Tabellen automatisch in eine E-Mail-Vorlage einfügen. Die E-Mails werden über Ihr Gmail-Konto gesendet, damit Sie auf die Antworten des Empfängers antworten können.
Wichtig: Dieses Beispiel für die Zusammenstellung von E‐Mail-Inhalten unterliegt den E‐Mail-Limits, die unter Kontingente für Google-Dienste beschrieben sind.
Funktionsweise
Sie erstellen eine Gmail-Entwurfsvorlage mit Platzhaltern, die den Daten in einer Google Tabellen-Tabelle entsprechen. Jede Spaltenüberschrift in einem Tabellenblatt
steht für ein Platzhalter-Tag. Das Skript sendet die Informationen für jeden Platzhalter aus der Tabelle an die Position des entsprechenden Platzhalter-Tags im E-Mail-Entwurf.
Apps Script-Dienste
Diese Lösung verwendet die folgenden Dienste:
- Gmail-Dienst: Ruft, liest und sendet den E-Mail-Entwurf, den Sie an die Empfänger senden möchten.
- Tabellendienst: füllt die E-Mail-Platzhalter mit personalisierten Informationen für jeden Empfänger aus.
Voraussetzungen
Sie benötigen die folgenden Voraussetzungen, um dieses Beispiel verwenden zu können:
- Ein Google-Konto (Google Workspace-Konten erfordern möglicherweise die Administratorgenehmigung).
- Ein Webbrowser mit Zugang zum Internet.
Skript einrichten
Apps Script-Projekt erstellen
- Klicken Sie auf die folgende Schaltfläche, um eine Kopie der Beispieltabelle für die Zusammenstellung von E-Mail-Inhalten in Gmail/Google Tabellen zu erstellen.
Das Apps Script-Projekt für diese Lösung ist an die Tabelle angehängt.
Kopie erstellen
- Geben Sie in der kopierten Tabelle in der Spalte Empfänger die E-Mail-Adressen ein, die für die Zusammenstellung von E-Mail-Inhalten verwendet werden sollen.
- (Optional) Sie können Spalten hinzufügen, bearbeiten oder entfernen, um die Daten anzupassen, die in die E-Mail-Vorlage aufgenommen werden sollen.
Wenn Sie den Namen der Spalte Empfänger oder E-Mail gesendet ändern, müssen Sie den entsprechenden Code im Apps Script-Projekt aktualisieren. Sie können das Apps Script-Projekt aus der Tabelle öffnen. Klicken Sie dazu auf Erweiterungen >
Apps Script.
E-Mail-Vorlagen erstellen
- Erstellen Sie in Ihrem Gmail-Konto einen E-Mail-Entwurf. Wenn Sie Daten aus der Tabelle in Ihre E-Mail aufnehmen möchten, verwenden Sie Platzhalter, die den Spaltennamen entsprechen, die in geschweiften Klammern stehen, z. B.
{{First name}}.
- Wenn Sie den Text in der E-Mail formatieren, müssen Sie auch die Platzhalter in Klammern formatieren.
- Bei Platzhaltern wird zwischen Groß- und Kleinschreibung unterschieden und sie müssen genau mit den Spaltenüberschriften übereinstimmen.
- Kopieren Sie die Betreffzeile Ihres E-Mail-Entwurfs.
Skript ausführen
- Klicken Sie in der Tabelle auf Zusammenstellung von E-Mail-Inhalten >
E-Mails senden. Möglicherweise müssen Sie die Seite aktualisieren, damit dieses benutzerdefinierte Menü angezeigt wird.
Autorisieren Sie das Skript, wenn Sie dazu aufgefordert werden.
Wenn auf dem OAuth-Zustimmungsbildschirm die Warnung Diese Anwendung wurde nicht überprüft angezeigt wird, wählen Sie Erweitert >
Zu {Projektname} (unsicher) aus.
Klicken Sie noch einmal auf Zusammenstellung von E-Mail-Inhalten > E-Mails senden.
Fügen Sie die Betreffzeile der E-Mail-Vorlage ein und klicken Sie auf OK.
Wenn Sie einen Filter auf das Tabellenblatt angewendet haben, sendet das Skript weiterhin eine E-Mail an die gefilterten Teilnehmer, fügt aber keinen Zeitstempel hinzu.
Code ansehen
Wenn Sie den Apps Script-Code für diese Lösung sehen möchten, klicken Sie unten auf Quellcode ansehen:
Quellcode ansehen
Code.gs
// To learn how to use this script, refer to the documentation:
// https://developers.google.com/apps-script/samples/automations/mail-merge
/*
Copyright 2022 Martin Hawksey
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @OnlyCurrentDoc
*/
/**
* Change these to match the column names you are using for email
* recipient addresses and email sent column.
*/
const RECIPIENT_COL = "Recipient";
const EMAIL_SENT_COL = "Email Sent";
/**
* Creates the menu item "Mail Merge" for user to run scripts on drop-down.
*/
function onOpen() {
const ui = SpreadsheetApp.getUi();
ui.createMenu('Mail Merge')
.addItem('Send Emails', 'sendEmails')
.addToUi();
}
/**
* Sends emails from sheet data.
* @param {string} subjectLine (optional) for the email draft message
* @param {Sheet} sheet to read data from
*/
function sendEmails(subjectLine, sheet=SpreadsheetApp.getActiveSheet()) {
// option to skip browser prompt if you want to use this code in other projects
if (!subjectLine){
subjectLine = Browser.inputBox("Mail Merge",
"Type or copy/paste the subject line of the Gmail " +
"draft message you would like to mail merge with:",
Browser.Buttons.OK_CANCEL);
if (subjectLine === "cancel" || subjectLine == ""){
// If no subject line, finishes up
return;
}
}
// Gets the draft Gmail message to use as a template
const emailTemplate = getGmailTemplateFromDrafts_(subjectLine);
// Gets the data from the passed sheet
const dataRange = sheet.getDataRange();
// Fetches displayed values for each row in the Range HT Andrew Roberts
// https://mashe.hawksey.info/2020/04/a-bulk-email-mail-merge-with-gmail-and-google-sheets-solution-evolution-using-v8/#comment-187490
// @see https://developers.google.com/apps-script/reference/spreadsheet/range#getdisplayvalues
const data = dataRange.getDisplayValues();
// Assumes row 1 contains our column headings
const heads = data.shift();
// Gets the index of the column named 'Email Status' (Assumes header names are unique)
// @see http://ramblings.mcpher.com/Home/excelquirks/gooscript/arrayfunctions
const emailSentColIdx = heads.indexOf(EMAIL_SENT_COL);
// Converts 2d array into an object array
// See https://stackoverflow.com/a/22917499/1027723
// For a pretty version, see https://mashe.hawksey.info/?p=17869/#comment-184945
const obj = data.map(r => (heads.reduce((o, k, i) => (o[k] = r[i] || '', o), {})));
// Creates an array to record sent emails
const out = [];
// Loops through all the rows of data
obj.forEach(function(row, rowIdx){
// Only sends emails if email_sent cell is blank and not hidden by a filter
if (row[EMAIL_SENT_COL] == ''){
try {
const msgObj = fillInTemplateFromObject_(emailTemplate.message, row);
// See https://developers.google.com/apps-script/reference/gmail/gmail-app#sendEmail(String,String,String,Object)
// If you need to send emails with unicode/emoji characters change GmailApp for MailApp
// Uncomment advanced parameters as needed (see docs for limitations)
GmailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
htmlBody: msgObj.html,
// bcc: 'a.bcc@email.com',
// cc: 'a.cc@email.com',
// from: 'an.alias@email.com',
// name: 'name of the sender',
// replyTo: 'a.reply@email.com',
// noReply: true, // if the email should be sent from a generic no-reply email address (not available to gmail.com users)
attachments: emailTemplate.attachments,
inlineImages: emailTemplate.inlineImages
});
// Edits cell to record email sent date
out.push([new Date()]);
} catch(e) {
// modify cell to record error
out.push([e.message]);
}
} else {
out.push([row[EMAIL_SENT_COL]]);
}
});
// Updates the sheet with new data
sheet.getRange(2, emailSentColIdx+1, out.length).setValues(out);
/**
* Get a Gmail draft message by matching the subject line.
* @param {string} subject_line to search for draft message
* @return {object} containing the subject, plain and html message body and attachments
*/
function getGmailTemplateFromDrafts_(subject_line){
try {
// get drafts
const drafts = GmailApp.getDrafts();
// filter the drafts that match subject line
const draft = drafts.filter(subjectFilter_(subject_line))[0];
// get the message object
const msg = draft.getMessage();
// Handles inline images and attachments so they can be included in the merge
// Based on https://stackoverflow.com/a/65813881/1027723
// Gets all attachments and inline image attachments
const allInlineImages = draft.getMessage().getAttachments({includeInlineImages: true,includeAttachments:false});
const attachments = draft.getMessage().getAttachments({includeInlineImages: false});
const htmlBody = msg.getBody();
// Creates an inline image object with the image name as key
// (can't rely on image index as array based on insert order)
const img_obj = allInlineImages.reduce((obj, i) => (obj[i.getName()] = i, obj) ,{});
//Regexp searches for all img string positions with cid
const imgexp = RegExp('<img.*?src="cid:(.*?)".*?alt="(.*?)"[^\>]+>', 'g');
const matches = [...htmlBody.matchAll(imgexp)];
//Initiates the allInlineImages object
const inlineImagesObj = {};
// built an inlineImagesObj from inline image matches
matches.forEach(match => inlineImagesObj[match[1]] = img_obj[match[2]]);
return {message: {subject: subject_line, text: msg.getPlainBody(), html:htmlBody},
attachments: attachments, inlineImages: inlineImagesObj };
} catch(e) {
throw new Error("Oops - can't find Gmail draft");
}
/**
* Filter draft objects with the matching subject linemessage by matching the subject line.
* @param {string} subject_line to search for draft message
* @return {object} GmailDraft object
*/
function subjectFilter_(subject_line){
return function(element) {
if (element.getMessage().getSubject() === subject_line) {
return element;
}
}
}
}
/**
* Fill template string with data object
* @see https://stackoverflow.com/a/378000/1027723
* @param {string} template string containing {{}} markers which are replaced with data
* @param {object} data object used to replace {{}} markers
* @return {object} message replaced with data
*/
function fillInTemplateFromObject_(template, data) {
// We have two templates one for plain text and the html body
// Stringifing the object means we can do a global replace
let template_string = JSON.stringify(template);
// Token replacement
template_string = template_string.replace(/{{[^{}]+}}/g, key => {
return escapeData_(data[key.replace(/[{}]+/g, "")] || "");
});
return JSON.parse(template_string);
}
/**
* Escape cell data to make JSON safe
* @see https://stackoverflow.com/a/9204218/1027723
* @param {string} str to escape JSON special characters from
* @return {string} escaped string
*/
function escapeData_(str) {
return str
.replace(/[\\]/g, '\\\\')
.replace(/[\"]/g, '\\\"')
.replace(/[\/]/g, '\\/')
.replace(/[\b]/g, '\\b')
.replace(/[\f]/g, '\\f')
.replace(/[\n]/g, '\\n')
.replace(/[\r]/g, '\\r')
.replace(/[\t]/g, '\\t');
};
}
Abwandlung
Sie können die Automatisierung der Zusammenstellung von E-Mail-Inhalten beliebig ändern.
Nachfolgend sind einige optionale Änderungen aufgeführt, die Sie am Quellcode vornehmen können.
E-Mail-Parameter für „Bcc“, „Cc“, „Antwort an“ oder „Von“ hinzufügen
Der Beispielcode enthält eine Reihe zusätzlicher Parameter, die derzeit auskommentiert sind. Damit können Sie den Namen des Kontos, über das die E-Mail gesendet wird, und die Antwort an E-Mail-Adressen sowie die Bcc- und Cc-E-Mail-Adressen steuern.
Aktivieren Sie die Parameter, die Sie hinzufügen möchten, indem Sie die Schrägstriche // vor jedem Parameter entfernen.
Das folgende Beispiel zeigt einen Auszug aus der Funktion sendEmails, mit der die meisten E-Mail-Parameter aktiviert werden:
GmailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
htmlBody: msgObj.html,
bcc: 'bcc@example.com',
cc: 'cc@example.com',
from: 'from.alias@example.com',
name: 'name of the sender',
replyTo: 'reply@example.com',
// noReply: true, // if the email should be sent from a generic no-reply email address (not available to gmail.com users)
Im Beispiel oben ist der Parameter noReply immer noch auskommentiert, da der Parameter replyTo festgelegt ist.
Unicode-Zeichen in E-Mails verwenden
Wenn Sie in Ihren E-Mails Unicode-Zeichen wie Emojis verwenden möchten, müssen Sie den Code aktualisieren, um den Mail-Dienst anstelle des Gmail-Dienstes zu verwenden.
Aktualisieren Sie im Beispielcode die folgende Zeile:
GmailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
Ersetzen Sie die Zeile durch den folgenden Code:
MailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
Beitragende
Das Muster wurde von Martin Hawksey, Learning Design and Technology Lead beim
Edinburgh Futures Institute, Blogger und Google Developer Expert erstellt.
Dieses Beispiel wird von Google mit Unterstützung von Google Developers-Experten verwaltet.
Nächste Schritte
