Слияние почты с помощью API Документов

В этом руководстве объясняется, как использовать API Документов Google для слияния почты.

Введение

Слияние почты берет значения из строк электронной таблицы или другого источника данных и вставляет их в документ-шаблон. Это позволяет создать единый первичный документ (шаблон), на основе которого можно создать множество похожих документов, каждый из которых настроен с учетом объединяемых данных. Результат не обязательно используется для почты или формальных писем, но может использоваться для любых целей, например для создания пакета счетов клиентов.

Слияние почты существует с тех пор, как появились электронные таблицы и текстовые процессоры, и сегодня оно является частью многих рабочих процессов в бизнесе. Согласно соглашению, данные должны быть организованы в виде одной записи в строке, где столбцы представляют поля данных, как показано в следующей таблице:

Имя Адрес Зона
1 УрбанПк 123 1-я ул. Запад
2 Павксана 456 2-я ул. Юг

В примере приложения на этой странице показано, как можно использовать API Google Docs, Sheets и Drive, чтобы абстрагироваться от деталей выполнения слияния почты, защищая пользователей от проблем с реализацией. Дополнительную информацию об этом образце Python можно найти в репозитории примера на GitHub .

Образец заявления

Этот пример приложения копирует ваш основной шаблон, а затем объединяет переменные из назначенного источника данных в каждую из копий. Чтобы попробовать этот пример приложения, сначала настройте шаблон:

  1. Создайте файл Документов . Выберите шаблон, который вы хотите использовать.
  2. Запишите идентификатор документа нового файла. Для получения дополнительной информации см. Идентификатор документа .
  3. Установите для переменной DOCS_FILE_ID идентификатор документа.
  4. Замените контактную информацию переменными-заполнителями шаблона, которые приложение объединит с выбранными данными.

Вот образец шаблона письма с заполнителями, которые можно объединить с реальными данными из источника, например обычного текста или таблиц. Вот как выглядит этот шаблон:

Затем выберите в качестве источника данных обычный текст или Таблицы, используя переменную SOURCE . По умолчанию в образце используется обычный текст, то есть в образце данных используется переменная TEXT_SOURCE_DATA . Чтобы получить данные из Таблиц, обновите переменную SOURCE до 'sheets' и укажите ее на наш образец листа (или свой собственный), установив переменную SHEETS_FILE_ID .

Вот как выглядит лист, чтобы вы могли видеть его формат:

Попробуйте приложение на нашем примере данных, а затем адаптируйте его к своим данным и варианту использования. Приложение командной строки работает следующим образом:

  • Настраивать
  • Получить данные из источника данных
  • Перебирать каждую строку данных
    • Создайте копию шаблона
    • Объединить копию с данными
    • Выходная ссылка на вновь объединенный документ

Все вновь объединенные буквы также отображаются в «Моем диске» пользователя. Пример объединенного письма выглядит примерно так:

Исходный код

Питон
документы/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 .