מיזוג אימיילים

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

מבוא

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

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

שם כתובת תחום (zone)
1 UrbanPq רחוב בן יהודה 15 מערב
2 פוקסנה 456 2nd St. דרום

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

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

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

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

כאן תוכלו למצוא תבנית של אותיות לדוגמה עם placeholders שאפשר למזג עם נתונים אמיתיים ממקור, כמו טקסט פשוט או 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 של האפליקציה לדוגמה.