ایمیل با Docs API ادغام شد

این راهنما نحوه استفاده از API گوگل داکس برای انجام ادغام پستی را توضیح می‌دهد.

مقدمه

ادغام پستی، مقادیر را از ردیف‌های یک صفحه گسترده یا منبع داده دیگر می‌گیرد و آنها را در یک سند الگو وارد می‌کند. این به شما امکان می‌دهد یک سند اصلی واحد (الگو) ایجاد کنید که از آن می‌توانید اسناد مشابه زیادی تولید کنید که هر کدام با داده‌های ادغام شده سفارشی‌سازی می‌شوند. نتیجه لزوماً برای نامه‌های پستی یا فرم‌ها استفاده نمی‌شود، بلکه می‌تواند برای هر هدفی، مانند تولید دسته‌ای از فاکتورهای مشتری، باشد.

ادغام ایمیل از زمانی که صفحات گسترده و پردازشگرهای متن وجود داشته‌اند، وجود داشته است و امروزه بخشی از بسیاری از گردش‌های کاری تجاری است. قرارداد این است که داده‌ها به صورت یک رکورد در هر ردیف سازماندهی شوند، و ستون‌ها نمایانگر فیلدهای موجود در داده‌ها باشند، همانطور که در جدول زیر نشان داده شده است:

نام آدرس منطقه
۱ UrbanPq خیابان اول، پلاک ۱۲۳ غرب
۲ پاوخانا خیابان دوم، پلاک ۴۵۶ جنوب

برنامه نمونه موجود در این صفحه نشان می‌دهد که چگونه می‌توانید از APIهای Google Docs، Sheets و Drive برای خلاصه‌سازی جزئیات نحوه ادغام ایمیل‌ها استفاده کنید و کاربران را از نگرانی‌های پیاده‌سازی محافظت کنید. اطلاعات بیشتر در مورد این نمونه پایتون را می‌توانید در مخزن GitHub نمونه پیدا کنید.

نمونه درخواست

این برنامه نمونه، الگوی اصلی شما را کپی می‌کند و سپس متغیرهای منبع داده تعیین‌شده شما را در هر یک از کپی‌ها ادغام می‌کند. برای امتحان کردن این برنامه نمونه، ابتدا الگوی خود را تنظیم کنید:

  1. یک فایل Docs ایجاد کنید . الگویی را که می‌خواهید استفاده کنید انتخاب کنید.
  2. به شناسه سند فایل جدید توجه کنید. برای اطلاعات بیشتر، به شناسه سند مراجعه کنید.
  3. متغیر DOCS_FILE_ID را روی شناسه سند تنظیم کنید.
  4. اطلاعات تماس را با متغیرهای جانگهدار الگو جایگزین کنید که برنامه با داده‌های انتخاب‌شده ادغام خواهد کرد.

در اینجا یک الگوی نامه نمونه با متغیرهایی وجود دارد که می‌توانند با داده‌های واقعی از منبعی مانند متن ساده یا Sheets ادغام شوند. این الگو به این شکل است:

سپس، با استفاده از متغیر SOURCE ، متن ساده یا Sheets را به عنوان منبع داده خود انتخاب کنید. نمونه به طور پیش‌فرض متن ساده است، به این معنی که داده‌های نمونه از متغیر TEXT_SOURCE_DATA استفاده می‌کنند. برای منبع‌دهی داده‌ها از Sheets، متغیر SOURCE را به 'sheets' به‌روزرسانی کنید و با تنظیم متغیر SHEETS_FILE_ID ، آن را به برگه نمونه ما (یا برگه خودتان) ارجاع دهید.

این برگه به ​​این شکل است تا بتوانید قالب آن را ببینید:

برنامه را با داده‌های نمونه ما امتحان کنید، سپس آن را با داده‌ها و مورد استفاده خود تطبیق دهید. برنامه خط فرمان به این صورت کار می‌کند:

  • راه‌اندازی
  • واکشی داده‌ها از منبع داده
  • حلقه زدن روی هر ردیف داده
    • یک کپی از الگو ایجاد کنید
    • کپی را با داده‌ها ادغام کنید
    • لینک خروجی به سند تازه ادغام شده

تمام حروف ادغام‌شده‌ی جدید در My Drive کاربر نیز نمایش داده می‌شوند. نمونه‌ای از یک حرف ادغام‌شده چیزی شبیه به این است:

کد منبع

پایتون

اسناد/ادغام پستی/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 برنامه نمونه مراجعه کنید.