دمج البريد

يشرح هذا الدليل كيفية استخدام Google Docs API لإجراء عملية دمج بريد.

مقدمة

تأخذ ميزة دمج البريد القيم من صفوف جدول بيانات أو مصدر بيانات آخر وتدرجها في مستند نموذج. يتيح لك هذا إنشاء مستند أساسي واحد (القالب) يمكنك منه إنشاء العديد من المستندات المتشابهة، وكل منها مخصص بالبيانات التي يتم دمجها. لا يتم استخدام النتيجة بالضرورة للبريد الإلكتروني أو لخطابات النماذج، ولكن يمكن استخدامها لأي غرض، مثل إنشاء دفعة من فواتير العملاء.

ميزة "دمج البريد" متاحة طالما توفّرت جداول البيانات ومعالجات الكلمات، وهي جزء من العديد من مهام سير العمل في الوقت الحالي. الاصطلاح هو تنظيم البيانات كسجل واحد لكل صف، حيث تمثل الأعمدة الحقول في البيانات، كما هو موضح في الجدول التالي:

الاسم العنوان المنطقة
1 UrbanPq 123 1st St. الغرب
2 باوكسانا 456 2nd St. الجنوب

يوضح نموذج التطبيق الموجود في هذه الصفحة كيف يمكنك استخدام واجهات برمجة تطبيقات "مستندات Google" و"جداول بيانات Google" وDrive لاستخلاص تفاصيل كيفية تنفيذ عمليات دمج البريد، ما يحمي المستخدمين من مشاكل التنفيذ. يمكن العثور على مزيد من المعلومات حول نموذج Python هذا في مستودع GitHub الخاص بالعيّنة.

نموذج تطبيق

ينسخ هذا التطبيق النموذجي الأساسي ثم يدمج المتغيرات من مصدر البيانات المحدّد في كل نسخة من النسخ. لتجربة نموذج التطبيق هذا، أولاً إعداد القالب الخاص بك:

  1. أنشئ ملف "مستندات Google". اختَر النموذج الذي تريد استخدامه.
  2. سجِّل رقم تعريف المستند للملف الجديد. لمزيد من المعلومات، راجع رقم تعريف المستند.
  3. اضبط المتغيّر DOCS_FILE_ID على رقم تعريف المستند.
  4. استبدل معلومات الاتصال بمتغيرات العنصر النائب للنموذج التي سيدمجها التطبيق مع البيانات المحددة.

وفي ما يلي نموذج لحرف أبجدي يحتوي على عناصر نائبة يمكن دمجها مع بيانات حقيقية من مصدر مثل نص عادي أو "جداول بيانات Google". إليك ما سيبدو عليه هذا القالب:

بعد ذلك، اختَر نصًا عاديًا أو "جداول بيانات Google" كمصدر للبيانات باستخدام المتغيّر SOURCE. يتم ضبط النموذج تلقائيًا على النص العادي، ما يعني أن نموذج البيانات يستخدم المتغير TEXT_SOURCE_DATA. للحصول على البيانات من "جداول بيانات Google"، عدِّل المتغيّر 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للتطبيق.