Docs API की मदद से, मेल मर्ज की सुविधा

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

परिचय

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

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

नाम पता ज़ोन
1 UrbanPq 123 फ़र्स्ट स्ट्रीट. पश्चिम
2 Pawxana 456 सेकंड स्ट्रीट दक्षिण

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

सैंपल ऐप्लिकेशन

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

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

यहां एक सैंपल लेटर दिया गया है टेंप्लेट प्लेसहोल्डर के साथ जिन्हें किसी सोर्स के असल डेटा के साथ मर्ज किया जा सकता है, जैसे कि सादा टेक्स्ट या शीट के तौर पर सेव कर सकते हैं. यहां बताया गया है कि वह टेंप्लेट कैसा दिखता है:

इसके बाद, अपने डेटा सोर्स के तौर पर सादा टेक्स्ट या 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 पर रेपो के नाम से सबमिट किया जाता है.