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

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

परिचय

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

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

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

इस पेज पर दिए गए सैंपल ऐप्लिकेशन में बताया गया है कि 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 फ़ाइल और ऐप्लिकेशन का पूरा सोर्स कोड देखें.