Posta birleştirme

Bu kılavuzda, posta birleştirme işlemi için Google Dokümanlar API'sının nasıl kullanılacağı açıklanmaktadır.

Giriş

Posta birleştirme, bir e-tablonun satırlarından veya başka bir veri kaynağındaki değerleri alır ve bunları bir şablon dokümanına ekler. Bu işlem, her biri birleştirilmekte olan verilerle özelleştirilmiş birçok benzer belge oluşturabileceğiniz tek bir birincil doküman (şablon) oluşturmanıza olanak tanır. Sonuç, posta veya form mektupları için kullanılmayabilir, ancak toplu müşteri faturası oluşturma gibi herhangi bir amaçla olabilir.

Posta birleştirme, e-tablolar ve kelime işlemciler işlendiğinden beri kullanılmaktadır ve günümüzde birçok iş akışının bir parçasıdır. Kural, verileri aşağıdaki tabloda gösterildiği gibi, verilerdeki alanları temsil edecek şekilde satır başına bir kayıt şeklinde düzenlemektir:

Ad Adres Alt Bölge
1 UrbanPq Cumhuriyet Caddesi No: 123 Batı
2 Pawxana Atatürk Caddesi Güney

Bu sayfadaki örnek uygulama, posta birleştirme işlemlerinin nasıl yapıldığına ilişkin ayrıntıları soyutlayarak kullanıcıları uygulama endişelerine karşı korumak için Google Dokümanlar, E-Tablolar ve Drive API'lerini nasıl kullanabileceğinizi göstermektedir. Bu Python örneğiyle ilgili daha fazla bilgiyi örneğin GitHub deposunda bulabilirsiniz.

Örnek uygulama

Bu örnek uygulama, birincil şablonunuzu kopyalar ve ardından atanmış veri kaynağınızdaki değişkenleri kopyaların her birinde 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 Belge Kimliği bölümüne bakın.
  3. DOCS_FILE_ID değişkenini doküman kimliğine ayarlayın.
  4. İletişim bilgilerini, uygulamanın seçilen verilerle birleştireceği şablon yer tutucu değişkenleriyle değiştirin.

Burada, düz metin veya E-Tablolar gibi bir kaynaktan alınan gerçek verilerle birleştirilebilecek yer tutucuların bulunduğu bir örnek mektup şablonunu görebilirsiniz. Şablon şu şekilde görünür:

Ardından, SOURCE değişkenini kullanarak veri kaynağınız olarak düz metni veya E-Tablolar'ı seçin. Örnek varsayılan olarak düz metindir. Diğer bir deyişle, örnek veriler TEXT_SOURCE_DATA değişkenini kullanır. E-Tablolar'dan veri almak için SOURCE değişkenini 'sheets' olarak güncelleyin ve SHEETS_FILE_ID değişkenini ayarlayarak örnek sayfamıza (veya kendi örneğinize) yönlendirin.

Sayfanın, biçimini görebilmeniz için şu şekilde görünür:

Uygulamayı örnek verilerimizle deneyin, ardından verilerinize ve kullanım alanına göre uyarlayın. Komut satırı uygulaması şu şekilde çalışır:

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

Yeni birleştirilmiş harfler kullanıcının Drive'ım bölümünde de görünür. Birleştirilmiş mektup şu şekilde görünür:

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 örnek uygulamanın GitHub deposundaki README dosyasına ve uygulama kaynak kodunun tamamına bakın.