מיזוג אימיילים עם Docs API

במדריך הזה מוסבר איך להשתמש ב-Google Docs API כדי לבצע מיזוג מידע.

מבוא

מיזוג דואר לוקח ערכים משורות של גיליון אלקטרוני או ממקור נתונים אחר, ומכניס אותם לתבנית של מסמך. כך תוכלו ליצור מסמך ראשי יחיד (התבנית) שממנו תוכלו ליצור מסמכים דומים רבים, שכל אחד מהם מותאם אישית לנתונים שמשולבים בו. התוצאה לא בהכרח משמשת ליצירת מכתבים או טפסים, אלא לכל מטרה, כמו יצירת קבוצה של חשבוניות ללקוחות.

מיזוג דואר קיים מאז שהומצאו גיליונות אלקטרוניים ומעבדי תמלילים, והוא חלק מתהליכי עבודה רבים בעסקים כיום. המוסכמה היא לארגן את הנתונים כרשומה אחת בכל שורה, כשהעמודות מייצגות שדות בנתונים, כמו שמוצג בטבלה הבאה:

שם כתובת תחום (zone)
1 UrbanPq 123 1st St. מערב
2 Pawxana ‪456 2nd St. דרום

באפליקציה לדוגמה שמוצגת בדף הזה אפשר לראות איך משתמשים בממשקי Google Docs,‏ Sheets ו-Drive API כדי להסתיר את הפרטים של אופן ביצוע מיזוג הדואר, וכך להגן על המשתמשים מפני בעיות שקשורות להטמעה. מידע נוסף על הדוגמה הזו של Python זמין במאגר GitHub של הדוגמה.

אפליקציה לדוגמה

אפליקציית הדוגמה הזו מעתיקה את התבנית הראשית ואז ממזגת משתנים ממקור הנתונים שצוין לכל אחד מהעותקים. כדי לנסות את האפליקציה לדוגמה הזו, קודם צריך להגדיר את התבנית:

  1. יוצרים קובץ Docs. בוחרים את התבנית שבה רוצים להשתמש.
  2. רושמים את מזהה המסמך של הקובץ החדש. מידע נוסף זמין במאמר בנושא מזהה מסמך.
  3. מגדירים את המשתנה DOCS_FILE_ID למזהה המסמך.
  4. מחליפים את פרטי הקשר במשתני placeholder של התבנית שהאפליקציה תמזג עם הנתונים שנבחרו.

הנה תבנית לדוגמה של מכתב עם placeholder שאפשר למזג עם נתונים אמיתיים ממקור כמו טקסט פשוט או Sheets. כך נראית התבנית:

לאחר מכן, בוחרים בטקסט פשוט או ב-Sheets כמקור הנתונים באמצעות המשתנה SOURCE. ברירת המחדל של הדוגמה היא טקסט רגיל, כלומר נתוני הדוגמה משתמשים במשתנה TEXT_SOURCE_DATA. כדי להשתמש בנתונים מ-Sheets, צריך לעדכן את המשתנה SOURCE ל-'sheets' ולהפנות אותו אל גיליון לדוגמה (או אל גיליון משלכם) על ידי הגדרת המשתנה SHEETS_FILE_ID.

כך נראה הגיליון, כדי שתוכלו לראות את הפורמט:

אפשר לנסות את האפליקציה עם נתוני הדוגמה שלנו, ואז להתאים אותה לנתונים ולתרחיש לדוגמה שלכם. כך פועלת אפליקציית שורת הפקודה:

  • הגדרה
  • אחזור הנתונים ממקור הנתונים
  • לולאה בכל שורת נתונים
    • יצירת עותק של התבנית
    • מיזוג העותק עם הנתונים
    • קישור פלט למסמך חדש שמוזג

כל המכתבים החדשים שמוזגו מופיעים גם בתיקייה 'האחסון שלי' של המשתמש. דוגמה למכתב שמוזג:

קוד מקור

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

מידע נוסף זמין בקובץ README ובקוד המקור המלא של האפליקציה במאגר GitHub של האפליקציה לדוגמה.