Tạo tính năng hợp nhất thư với Gmail và Google Trang tính

Cấp độ viết mã: Sơ cấp
Thời lượng: 10 phút
Loại dự án: Tự động hoá bằng trình đơn tuỳ chỉnh

Bạn thích học qua video?
Kênh Google Workspace Developers cung cấp các video về mẹo, thủ thuật và các tính năng mới nhất.

Mục tiêu

  • Tìm hiểu chức năng của giải pháp.
  • Tìm hiểu chức năng của các dịch vụ Apps Script trong giải pháp.
  • Thiết lập tập lệnh.
  • Chạy tập lệnh.

Giới thiệu về giải pháp này

Tự động điền dữ liệu từ Google Trang tính vào mẫu email. Email được gửi từ tài khoản Gmail của bạn để bạn có thể trả lời thư phản hồi của người nhận.

Quan trọng: Mẫu hợp nhất thư này phải tuân theo hạn mức email như mô tả trong phần Hạn mức cho các dịch vụ của Google.

ví dụ về tính năng hợp nhất thư

Cách hoạt động

Bạn tạo một mẫu email nháp trong Gmail có các phần giữ chỗ tương ứng với dữ liệu trong bảng tính trên Trang tính. Mỗi tiêu đề cột trong một trang tính đại diện cho một thẻ giữ chỗ. Tập lệnh sẽ gửi thông tin cho từng phần giữ chỗ trong bảng tính đến vị trí của thẻ phần giữ chỗ tương ứng trong bản nháp email.

Các dịch vụ của Apps Script

Giải pháp này sử dụng các dịch vụ sau:

Điều kiện tiên quyết

Để sử dụng mẫu này, bạn cần đáp ứng các điều kiện tiên quyết sau:

  • Một Tài khoản Google (tài khoản Google Workspace có thể yêu cầu quản trị viên phê duyệt).
  • Một trình duyệt web có quyền truy cập vào Internet.

Thiết lập tập lệnh

Tạo dự án Apps Script

  1. Nhấp vào nút sau để tạo bản sao của bảng tính mẫu Hợp nhất thư bằng Gmail/Trang tính. Dự án Apps Script cho giải pháp này được đính kèm vào bảng tính.
    Tạo bản sao
  2. Trong bảng tính bạn đã sao chép, hãy cập nhật cột Người nhận bằng địa chỉ email mà bạn muốn sử dụng trong tính năng hợp nhất thư.
  3. (Không bắt buộc) Thêm, chỉnh sửa hoặc xoá các cột để tuỳ chỉnh dữ liệu bạn muốn đưa vào mẫu email.

Nếu thay đổi tên của cột Người nhận hoặc Email đã gửi, bạn phải cập nhật mã tương ứng trong dự án Apps Script. Bạn có thể mở dự án Apps Script từ bảng tính bằng cách nhấp vào Tiện ích bổ sung > Apps Script.

Tạo mẫu email

  1. Trong tài khoản Gmail, hãy tạo một email nháp. Để đưa dữ liệu từ bảng tính vào email, hãy sử dụng các phần giữ chỗ tương ứng với tên cột được đặt trong dấu ngoặc nhọn, chẳng hạn như {{First name}}.
    • Nếu định dạng văn bản trong email, bạn cũng phải định dạng dấu ngoặc vuông của phần giữ chỗ.
    • Phần giữ chỗ có phân biệt chữ hoa chữ thường và phải khớp chính xác với tiêu đề cột.
  2. Sao chép dòng tiêu đề của email nháp.

Chạy tập lệnh

  1. Trong bảng tính, hãy nhấp vào Trộn thư > Gửi email. Bạn có thể cần làm mới trang để trình đơn tuỳ chỉnh này xuất hiện.

  2. Khi được nhắc, hãy cho phép tập lệnh chạy. Nếu màn hình đồng ý OAuth hiển thị cảnh báo Ứng dụng này chưa được xác minh, hãy tiếp tục bằng cách chọn Nâng cao > Chuyển đến {Tên dự án} (không an toàn).

  3. Nhấp vào Hợp nhất thư > Gửi email một lần nữa.

  4. Dán dòng tiêu đề của mẫu email rồi nhấp vào OK.

Nếu bạn áp dụng bộ lọc cho trang tính, tập lệnh vẫn gửi email cho những người tham gia đã được lọc, nhưng sẽ không thêm dấu thời gian.

Xem lại mã

Để xem lại mã Apps Script cho giải pháp này, hãy nhấp vào Xem mã nguồn bên dưới:

Xem mã nguồn

Code.gs

solutions/automations/mail-merge/Code.js
// 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');
  };
}

Sửa đổi

Bạn có thể chỉnh sửa tính năng tự động hoá việc hợp nhất thư theo ý muốn để phù hợp với nhu cầu của mình. Dưới đây là một số thay đổi không bắt buộc mà bạn có thể thực hiện đối với mã nguồn.

Thêm các thông số email Bcc, Cc, ReplyTo hoặc From

Mã mẫu bao gồm một số tham số bổ sung (hiện đang được nhận xét) cho phép bạn kiểm soát tên của tài khoản mà email được gửi từ đó, trả lời địa chỉ email, cũng như địa chỉ email Bcc và Cc.

Kích hoạt các tham số mà bạn muốn thêm bằng cách xoá dấu gạch chéo // ở trước mỗi tham số.

Mẫu sau đây cho thấy một đoạn trích từ hàm sendEmails kích hoạt hầu hết các tham số email: 

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)

Trong mẫu trên, tham số noReply vẫn được đánh dấu là nhận xét vì tham số replyTo được đặt.

Thêm các ký tự Unicode vào email

Nếu muốn thêm các ký tự unicode (chẳng hạn như biểu tượng cảm xúc) vào email, bạn phải cập nhật mã để sử dụng dịch vụ Thư thay vì dịch vụ Gmail.

Trong mã mẫu, hãy cập nhật dòng sau: 

GmailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {

Thay thế dòng này bằng đoạn mã sau: 

MailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {

Người đóng góp

Mẫu này do Martin Hawksey, Trưởng nhóm thiết kế và công nghệ học tập tại Viện Nghiên cứu tương lai Edinburgh, blogger và Chuyên gia phát triển của Google tạo ra.

Mẫu này do Google duy trì với sự trợ giúp của các Chuyên gia Google về phát triển.

Các bước tiếp theo