Hợp nhất thư

Giới thiệu

Tính năng hợp nhất thư lấy giá trị từ các hàng của bảng tính hoặc nguồn dữ liệu khác và chèn các giá trị đó vào tài liệu mẫu. Điều này cho phép bạn tạo một tài liệu "chính" (mẫu) để có thể tạo nhiều tài liệu tương tự, mỗi tài liệu được tuỳ chỉnh theo dữ liệu đang được hợp nhất. Kết quả này không nhất thiết phải được sử dụng cho thư hoặc biểu mẫu, nhưng có thể dành cho mọi mục đích, chẳng hạn như tạo một lô hóa đơn của khách hàng.

Hợp nhất thư đã có mặt chừng nào còn có bảng tính và trình xử lý văn bản và là một phần của nhiều quy trình công việc cho doanh nghiệp ngày nay. Quy ước là sắp xếp dữ liệu thành một bản ghi cho mỗi hàng, với các cột đại diện cho các trường trong dữ liệu, như được hiển thị trong bảng sau:

A B C
1 Tên Address (Địa chỉ) Vùng
2 UrbanPq 123 đường 1 Miền Tây
3 pawxana 456 Đường 2 Nam
4 v.v...

Ứng dụng mẫu trên trang này cho biết cách bạn có thể sử dụng API của Google Tài liệu và Trang tính (và Drive) để tóm tắt thông tin chi tiết về cách thực hiện hợp nhất thư, bảo vệ người dùng khỏi mối lo ngại về việc triển khai. Bạn có thể xem thêm thông tin về mẫu này tại kho lưu trữ nguồn mở của mẫu.

Ứng dụng mẫu

Ứng dụng mẫu này sao chép mẫu chính của bạn, sau đó hợp nhất các biến từ nguồn dữ liệu đã chỉ định vào mỗi bản sao. Để dùng thử ứng dụng mẫu, trước tiên, hãy thiết lập mẫu của bạn:

  • Tạo tệp Google Tài liệu mới. Chọn bất kỳ mẫu nào bạn muốn sử dụng. (Mẫu mẫu của chúng tôi sử dụng Letter/Spearmint.)
  • Lưu ý mã tài liệu, là chuỗi đứng sau document/d/ (xem DOCUMENT_ID) trong URL: https://docs.google.com/document/d/DOCUMENT_ID/edit
  • Đặt biến DOCS_FILE_ID trong mã thành mã tài liệu đó.
  • Thay thế thông tin liên hệ trong Tài liệu bằng các biến giữ chỗ mẫu mà ứng dụng sẽ hợp nhất với dữ liệu mong muốn.

Sau đây là mẫu thư mẫu của chúng tôi với các phần giữ chỗ cần hợp nhất với dữ liệu thực từ một nguồn như Google Trang tính hoặc văn bản thuần tuý. Mẫu sẽ có dạng như sau:

Tiếp theo, hãy chọn văn bản thuần túy hoặc Google Trang tính làm nguồn dữ liệu bằng cách đặt biến SOURCE. Giá trị này mặc định là văn bản thuần tuý, nghĩa là dữ liệu mẫu trong biến TEXT_SOURCE_DATA. Để lấy nguồn dữ liệu từ Google Trang tính, hãy cập nhật biến SOURCE thành 'sheets' rồi trỏ biến đó vào mẫu của chúng tôi (hoặc của bạn) bằng cách đặt biến SHEETS_FILE_ID. Đây là Trang tính của chúng tôi để bạn tìm hiểu về định dạng này:

Hãy thử ứng dụng với dữ liệu mẫu của chúng tôi, sau đó điều chỉnh cho phù hợp với dữ liệu và trường hợp sử dụng của bạn. Ứng dụng dòng lệnh hoạt động như sau:

  • Thiết lập
  • Tìm nạp dữ liệu từ nguồn dữ liệu
  • Lặp lại từng hàng dữ liệu
    • Tạo bản sao của mẫu
    • Hợp nhất bản sao với dữ liệu
    • Liên kết đầu ra đến tài liệu mới được hợp nhất

Tất cả các chữ cái mới được hợp nhất cũng hiển thị trong Google Drive của người dùng. Ví dụ về một chữ cái đã hợp nhất trông như sau:

Mã nguồn

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

Để biết thêm thông tin, hãy xem phần README cũng như mã nguồn ứng dụng đầy đủ tại kho lưu trữ nguồn mở của ứng dụng mẫu này.