Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Panduan ini menjelaskan cara menggunakan Google Docs API untuk melakukan pembuatan email massal.
Pengantar
Penggabungan email mengambil nilai dari baris spreadsheet atau sumber data lainnya
dan memasukkannya ke dalam dokumen template. Hal ini memungkinkan Anda
membuat satu instance
dokumen (template) yang digunakan untuk menghasilkan banyak dokumen serupa, masing-masing
disesuaikan dengan data yang digabungkan. Hasilnya belum tentu digunakan untuk
surat atau formulir, tetapi bisa untuk tujuan apa pun, seperti membuat batch
faktur pelanggan.
Pembuatan email massal sudah ada sejak ada perkembangan penggunaan {i>spreadsheet<i} dan
pemroses data, dan merupakan bagian dari banyak alur kerja bisnis saat ini. Konvensinya adalah
mengatur data sebagai satu {i>record<i} per baris, dengan kolom yang mewakili {i>field<i} di
data, seperti yang ditunjukkan dalam tabel berikut:
Nama
Alamat
Zona
1
UrbanPq
123 St.
Barat
2
Pawxana
456 2nd St.
Selatan
Aplikasi contoh di halaman ini menunjukkan cara menggunakan Google Dokumen,
Sheets, dan Drive API untuk memisahkan
detail tentang cara penggabungan email dilakukan, melindungi pengguna dari penerapan
kekhawatiran Anda. Informasi selengkapnya tentang contoh Python ini dapat ditemukan di
GitHub
repo Anda.
Contoh aplikasi
Aplikasi contoh ini menyalin template utama Anda, lalu menggabungkan variabel dari
sumber data yang ditentukan
ke setiap salinan. Untuk mencoba aplikasi contoh ini, pertama
menyiapkan template:
Catat ID dokumen file baru. Untuk informasi selengkapnya, lihat Dokumen
ID.
Tetapkan variabel DOCS_FILE_ID ke ID dokumen.
Ganti informasi kontak dengan variabel placeholder template yang
akan bergabung dengan data yang dipilih.
Berikut ini contoh surat
template
dengan {i>placeholder<i} yang dapat digabungkan dengan data aktual dari sumber seperti {i>spreadsheet<i}
teks atau Spreadsheet. Tampilan {i>template<i} tersebut akan terlihat seperti berikut:
Berikutnya, pilih teks biasa atau Spreadsheet sebagai sumber data Anda
menggunakan variabel SOURCE. Contoh secara {i>default<i} adalah teks polos, artinya
data contoh menggunakan variabel TEXT_SOURCE_DATA. Untuk mengambil data dari
Spreadsheet, perbarui variabel SOURCE ke 'sheets' lalu arahkan
ke sampel kami
spreadsheet
(atau Anda sendiri) dengan menetapkan variabel SHEETS_FILE_ID.
Tampilan sheet akan terlihat seperti berikut sehingga Anda dapat melihat formatnya:
Coba aplikasi dengan data sampel kami, lalu sesuaikan dengan data dan kasus penggunaan Anda. Tujuan
aplikasi command line akan berfungsi seperti ini:
Penyiapan
Mengambil data dari sumber data
Melakukan loop pada setiap baris data
Membuat salinan template
Gabungkan salinan dengan data
Link output ke dokumen yang baru digabungkan
Semua huruf yang baru digabungkan juga akan muncul di Drive Saya pengguna. Channel
contoh huruf yang digabungkan terlihat seperti ini:
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))
)