コーディング レベル: 初級
所要時間: 10 分
プロジェクトの種類: カスタム メニューを使用した自動化
目標
- ソリューションの機能を理解する
- コンテナ内で Apps Script サービスが
説明します。
- スクリプトを設定します。
- スクリプトを実行します。
このソリューションについて
Google スプレッドシートのデータをメール テンプレートに自動的に入力します。「
メールが Gmail アカウントから送信され、
受信者の返信
重要: このメールへの差し込みのサンプルには、記載されたメールの制限が適用されます。
Google サービスの割り当てをご覧ください。
仕組み
プレースホルダを含む Gmail の下書きテンプレートを作成し、
データに対応します各列見出し
プレースホルダタグを表しますこのスクリプトは、
スプレッドシートから、対応する
プレースホルダ タグを使用します。
Apps Script サービス
このソリューションでは、次のサービスを使用します。
前提条件
このサンプルを使用するには、次の前提条件を満たす必要があります。
- Google アカウント（Google Workspace アカウントは
管理者の承認が必要です）。
- インターネットにアクセスできるウェブブラウザ。
スクリプトを設定する
Apps Script プロジェクトを作成する
- 次のボタンをクリックすると、
Gmail/Google スプレッドシートの Mail Merge（メールへの差し込み）サンプル スプレッドシート。
これに対応する Apps Script プロジェクトでは、
スプレッドシートに添付されます。
コピーを作成
- コピーしたスプレッドシートの Recipients 列をメールアドレスで更新します。
入力します。
- （省略可）列を追加、編集、または削除して、使用するデータをカスタマイズします。
メールテンプレートに追加します
受信者またはメールの名前を変更した場合
列が送信済みの場合、対応するコードを
Apps Script プロジェクト。Apps Script を開いて
プロジェクトを作成できます。
[拡張機能] > をクリックします。
Apps Script。
メール テンプレートを作成する
- Gmail アカウントでメールの下書きを作成します。データを含めるため
取得
使用する場合は、列名に対応するプレースホルダを使用します。
中かっこで囲まれている（
{{First name}} など）。
- メールのテキストの書式を設定する場合は、プレースホルダの書式も指定する必要があります。
角かっこで囲みます。
- プレースホルダは大文字と小文字が区別され、列ヘッダーと完全に一致する必要があります。
- メールの下書きの件名をコピーします。
スクリプトを実行する
- スプレッドシートで [メールへの差し込み] > をクリックします。
メールを送信する。このカスタム メニューを使用するには、ページの更新が必要になる場合があります
表示されます。
プロンプトが表示されたら、スクリプトを承認します。
OAuth 同意画面に [このアプリは確認されていません] という警告が表示された場合は、
[詳細設定] > を選択して続行します
{プロジェクト名}（安全でない）に移動します。
[メールへの差し込み] > [メールを送信] をクリックします。
もう一度クリックします。
メール テンプレートの件名を貼り付けて、[OK] をクリックします。
スプレッドシートにフィルタを適用しても、スクリプトはフィルタされた宛先にメールを送信します。
タイムスタンプは追加されません。
コードを確認する
このソリューションの Apps Script コードを確認するには、
以下のソースコードを表示します。
ソースコードを表示
コード.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');
};
}
修正
メールへの差し込みの自動化は、ニーズに合わせて自由に編集できます。
以下に、ソースコードに加えることができるオプションの変更をいくつか示します。
Bcc、Cc、ReplyTo、From のメール パラメータを追加する
サンプルコードには、いくつかの追加パラメータが含まれており、現在、
コメントアウトして、メールの送信先となるアカウントの名前を制御できる
Bcc や Cc に送るメール アドレスだけでなく、
スラッシュを削除して、追加するパラメータを有効にします
それぞれの前に //。
次のサンプルは、sendEmails からの抜粋を示しています。
関数です。ほとんどのメール パラメータを有効化します。
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)
上記のサンプルでは、noReply パラメータはまだコメントアウトされています。
replyTo パラメータが設定されているためです。
メールに Unicode 文字を含める
メールに絵文字などの Unicode 文字を含める場合は、
Gmail サービスの代わりにメールサービスを使用するようにコードを更新する必要があります。
サンプルコードの次の行を更新します。
GmailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
この行を次のコードに置き換えます。
MailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
寄稿者
このサンプルは、
Edinburgh Futures Institute、ブロガー、Google Developer Expert。
このサンプルは、Google Developer Experts のサポートのもと、Google によって管理されています。
次のステップ
