Docs API ile posta birleştirme

Bu kılavuzda, posta birleştirme işlemi yapmak için Google Docs API'nin nasıl kullanılacağı açıklanmaktadır.

Giriş

Posta birleştirme, bir e-tablonun veya başka bir veri kaynağının satırlarından değer alır ve bunları bir şablon dokümanına ekler. Bu sayede tek bir birincil birincil birçok benzer doküman oluşturabileceğiniz bir doküman (şablon) özelleştirilmekte olan verilerle özelleştiriliyor. Sonuç, posta veya form mektupları için kullanılmak zorunda değildir. Müşteri faturaları oluşturmak gibi herhangi bir amaç için kullanılabilir.

Posta birleştirme, e-tabloların ve kelime öbeklerinin işleyen bir araç ve günümüzde birçok işletme iş akışının bir parçası. Kongre, verileri satır başına tek bir kayıt olacak şekilde düzenlemek aşağıdaki tabloda gösterildiği gibi):

Ad Adres Alt Bölge
1 UrbanPq Atatürk Caddesi Batı
2 Pawxana 456 2. Cadde Güney

Bu sayfadaki örnek uygulama Google Dokümanlar'ı, Google Dokümanlar'ı Google E-Tablolar ve Drive API'leri ile Posta birleştirme işlemlerinin nasıl gerçekleştirildiğine dair ayrıntılar (kullanıcıları uygulamadan koruyarak) emin olun. Bu Python örneği hakkında daha fazla bilgiyi örneğin GitHub depo.

Örnek uygulama

Bu örnek uygulama, birincil şablonunuzu kopyalar ve ardından, belirtilen veri kaynağınızdaki değişkenleri kopyaların her birine birleştirir. Bu örnek uygulamayı denemek için önce şablonunuzu oluşturun:

  1. Dokümanlar dosyası oluşturun. Kullanmak istediğiniz şablonu seçin.
  2. Yeni dosyanın doküman kimliğini not edin. Daha fazla bilgi için bkz. Doküman Kimlik bölümüne bakın.
  3. DOCS_FILE_ID değişkenini doküman kimliğine ayarlayın.
  4. İletişim bilgilerini, uygulamanız seçilen verilerle birleştirilir.

Örnek mektup şablon düz gibi bir kaynaktan elde edilen gerçek verilerle birleştirilebilecek yer tutucularla metin veya E-Tablolar kullanabilirsiniz. Şablon şu şekilde görünür:

Ardından, veri kaynağınız olarak düz metin veya E-Tablolar'ı seçin SOURCE değişkeni kullanılır. Örnekte varsayılan olarak düz metin kullanılır. Bu, örnek veriler TEXT_SOURCE_DATA değişkenini kullanır. Verilerin kaynağı E-Tablolar'da, SOURCE değişkenini 'sheets' olarak güncelleyip işaret edin örneğimize e-tablo (ya da kendinizin yapabilirsiniz) SHEETS_FILE_ID değişkenini ayarlayarak

Biçimi aşağıdaki gibi görüntüleyebilirsiniz:

Uygulamayı örnek verilerimizle deneyin, ardından kendi verilerinize ve kullanım alanınıza uyarlayın. İlgili içeriği oluşturmak için kullanılan komut satırı uygulaması şu şekilde çalışır:

  • Kurulum
  • Veri kaynağından verileri getirme
  • Her veri satırında döngü oluşturma
    • Şablonun bir kopyasını oluştur
    • Kopyayı verilerle birleştirin
    • Yeni birleştirilmiş dokümanın çıkış bağlantısı

Yeni birleştirilen tüm e-postalar kullanıcının Drive'ım bölümünde de gösterilir. aşağıdaki gibi birleştirilmiş bir mektup örneği görebilirsiniz:

Kaynak kodu

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))
    )

Daha fazla bilgi için README dosyasına ve tam uygulama kaynak koduna bakın şu örnek uygulamanın GitHub'ında: depo.