मेल मर्ज

इस गाइड में बताया गया है कि मेल मर्ज करने के लिए, Google Docs API का इस्तेमाल कैसे किया जाता है.

शुरुआती जानकारी

मेल मर्ज की सुविधा, स्प्रेडशीट या दूसरे डेटा सोर्स की पंक्तियों की वैल्यू लेकर उन्हें एक टेंप्लेट दस्तावेज़ में डाल देती है. इससे आपको एक ऐसा प्राइमरी दस्तावेज़ (टेंप्लेट) बनाने की सुविधा मिलती है जिससे मिलते-जुलते कई दस्तावेज़ जनरेट किए जा सकते हैं. हर दस्तावेज़ को मर्ज करने के बाद, उसे अपनी पसंद के मुताबिक बनाया जा सकता है. ज़रूरी नहीं है कि इस नतीजे का इस्तेमाल डाक या फ़ॉर्म लेटर के लिए किया जाए. हालांकि, इसका इस्तेमाल किसी भी मकसद के लिए किया जा सकता है, जैसे कि ग्राहकों के इनवॉइस का बैच जनरेट करना.

मेल मर्ज की सुविधा तब से काम कर रही है, जब तक स्प्रेडशीट और वर्ड प्रोसेसर रही हैं. साथ ही, आज यह कई कारोबारों के वर्कफ़्लो का हिस्सा है. आम तौर पर, डेटा को हर पंक्ति में एक रिकॉर्ड के तौर पर व्यवस्थित किया जाता है. साथ ही, डेटा में फ़ील्ड को दिखाने वाले कॉलम होते हैं, जैसा कि नीचे टेबल में दिखाया गया है:

नाम पता ज़ोन
1 UrbanPq 123 1st Street पश्चिम
2 पाव्क्साना 456 2nd स्ट्रीट दक्षिण

इस पेज पर दिया गया नमूना ऐप्लिकेशन दिखाता है कि मेल मर्ज की प्रोसेस से जुड़ी जानकारी को समझने के लिए Google Docs, Sheets, और Drive API का इस्तेमाल किस तरह किया जा सकता है. इससे, उपयोगकर्ताओं को मेल मर्ज करने से जुड़ी समस्याओं से बचाने में भी मदद मिलती है. Python सैंपल के बारे में ज़्यादा जानकारी, सैंपल के GitHub रेपो में मिल सकती है.

ऐप्लिकेशन का नमूना

ऐप्लिकेशन का यह नमूना आपके मुख्य टेंप्लेट को कॉपी करता है और फिर तय किए गए डेटा सोर्स के वैरिएबल को हर कॉपी में मर्ज करता है. इस सैंपल ऐप्लिकेशन को आज़माने के लिए, सबसे पहले अपना टेंप्लेट सेट अप करें:

  1. Docs फ़ाइल बनाएं. वह टेंप्लेट चुनें जिसका आपको इस्तेमाल करना है.
  2. नई फ़ाइल का दस्तावेज़ आईडी नोट करें. ज़्यादा जानकारी के लिए, दस्तावेज़ का आईडी देखें.
  3. DOCS_FILE_ID वैरिएबल को दस्तावेज़ के आईडी पर सेट करें.
  4. संपर्क जानकारी की जगह टेंप्लेट प्लेसहोल्डर वैरिएबल का इस्तेमाल करें. इस वैरिएबल को ऐप्लिकेशन, चुने गए डेटा के साथ मर्ज कर देगा.

यहां प्लेसहोल्डर के साथ एक सैंपल लेटर टेंप्लेट दिया गया है. इसे सादे टेक्स्ट या Sheets जैसे सोर्स के असली डेटा के साथ मर्ज किया जा सकता है. टेंप्लेट कुछ इस तरह दिखता है:

इसके बाद, SOURCE वैरिएबल का इस्तेमाल करके अपने डेटा सोर्स के तौर पर सादा टेक्स्ट या Sheets चुनें. सैंपल सामान्य टेक्स्ट में होता है. इसका मतलब है कि सैंपल डेटा, 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))
    )

ज़्यादा जानकारी के लिए, सैंपल ऐप्लिकेशन के GitHub रेपो पर, README फ़ाइल और ऐप्लिकेशन का पूरा सोर्स कोड देखें.