Penggabungan email

Pengantar

Penggabungan email mengambil nilai dari baris spreadsheet atau sumber data lainnya dan menyisipkannya ke dalam dokumen template. Tindakan ini memungkinkan Anda membuat satu dokumen "master" (template) yang dapat digunakan untuk membuat banyak dokumen serupa, masing-masing disesuaikan dengan data yang digabungkan. Hasilnya tidak harus digunakan untuk email atau surat formulir, tetapi dapat digunakan untuk tujuan apa pun, seperti membuat batch invoice pelanggan.

Penggabungan email sudah ada selama beberapa spreadsheet dan pemroses kata merupakan bagian dari banyak alur kerja bisnis saat ini. Konvensinya adalah untuk mengatur data sebagai satu catatan per baris, dengan kolom yang mewakili kolom dalam data, seperti yang ditunjukkan pada tabel berikut:

A B C
1 Nama Alamat Zona
2 FAQ Perkotaan Jl. Sudirman 123 Barat
3 Musik Pawxana Jl. Sudirman 55 Selatan
4 dll...

Aplikasi contoh di halaman ini menunjukkan cara menggunakan API Google Dokumen dan Spreadsheet (dan Drive) untuk memisahkan detail tentang cara penggabungan email dilakukan, sehingga melindungi pengguna dari masalah penerapan. Informasi selengkapnya tentang contoh ini dapat ditemukan di repo open source contoh.

Contoh aplikasi

Aplikasi contoh ini akan menyalin template master Anda, lalu menggabungkan variabel dari sumber data yang Anda tetapkan ke setiap salinan. Untuk mencoba aplikasi contoh, pertama-tama siapkan template Anda:

  • Membuat file Google Dokumen baru. Pilih template apa pun yang ingin Anda gunakan. (Contoh template kami menggunakan Letter/Spearmint.)
  • Catat ID dokumen, yang merupakan string yang mengikuti document/d/ (lihat DOCUMENT_ID) di URL: https://docs.google.com/document/d/DOCUMENT_ID/edit
  • Tetapkan variabel DOCS_FILE_ID dalam kode ke ID dokumen tersebut.
  • Ganti informasi kontak di Dokumen dengan variabel placeholder template yang akan digabungkan aplikasi dengan data yang diinginkan.

Berikut adalah contoh template huruf dengan placeholder untuk digabungkan dengan data sebenarnya dari sumber seperti Google Spreadsheet atau teks biasa. Berikut adalah tampilan template tersebut:

Selanjutnya, pilih teks biasa atau Google Spreadsheet sebagai sumber data dengan menetapkan variabel SOURCE. Setelan defaultnya adalah teks biasa, yang berarti data sampel dalam variabel TEXT_SOURCE_DATA. Untuk mendapatkan data dari Spreadsheet Google, update variabel SOURCE ke 'sheets' dan arahkan ke contoh kami (atau milik Anda) dengan menetapkan variabel SHEETS_FILE_ID. Berikut adalah Spreadsheet kami untuk mengetahui formatnya:

Coba aplikasi ini dengan data contoh kami, lalu sesuaikan dengan data dan kasus penggunaan Anda. Aplikasi command line berfungsi seperti ini:

  • Penyiapan
  • Mengambil data dari sumber data
  • Melakukan loop pada setiap baris data
    • Buat salinan template
    • Gabungkan salinan dengan data
    • Link output ke dokumen yang baru digabungkan

Semua huruf baru yang digabungkan juga akan muncul di Google Drive pengguna. Contoh huruf gabungan terlihat seperti ini:

Kode sumber

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))
    )

Untuk mengetahui informasi selengkapnya, lihat README dan kode sumber aplikasi lengkap di repo open source aplikasi contoh ini.