Fusion des e-mails

Introduction

Un fusion des e-mails extrait les valeurs des lignes d'une feuille de calcul ou d'une autre source de données et les insère dans un modèle de document. Vous pouvez ainsi créer un document "maître" unique (le modèle) à partir duquel vous pouvez générer de nombreux documents similaires, chacun personnalisé avec les données fusionnées. Le résultat n'est pas nécessairement utilisé pour les e-mails ou les lettres de formulaire, mais peut être utilisé à n'importe quelle fin, par exemple pour générer un lot de factures client.

La fusion des e-mails existent depuis qu'il existe des feuilles de calcul et des logiciels de traitement de texte, et qu'elle fait partie de nombreux workflows métier aujourd'hui. La convention consiste à organiser les données sous la forme d'un enregistrement par ligne, les colonnes représentant des champs de données, comme indiqué dans le tableau suivant:

A B C
1 Nom Adresse Zone
2 Ville 123 1st St. Ouest
3 Pawxana 456 2nd St. Sud
4 Et ainsi de suite.

L'exemple d'application de cette page vous montre comment utiliser les API Google Docs et Sheets (et Drive) pour éliminer le détail des fusions d'e-mails et protéger ainsi les utilisateurs contre les problèmes d'implémentation. Pour en savoir plus, consultez le dépôt Open Source de l'exemple.

Exemple d'application

Cette application exemple copie votre modèle maître, puis fusionne les variables de votre source de données désignée dans chacune des copies. Pour tester l'application exemple, commencez par configurer votre modèle:

  • Créez un fichier Google Docs. Choisissez le modèle que vous souhaitez utiliser. (Notre exemple de modèle utilise Letter/Spearmint.)
  • Notez l'ID du document, qui correspond à la chaîne qui suit document/d/ (voir DOCUMENT_ID) dans l'URL: https://docs.google.com/document/d/DOCUMENT_ID/edit
  • Dans le code, définissez la variable DOCS_FILE_ID sur cet ID de document.
  • Remplacez les coordonnées dans le document par des variables d'espace réservé de modèle que l'application fusionnera avec les données souhaitées.

Voici notre modèle de lettre d'exemple avec des espaces réservés à fusionner avec des données réelles provenant d'une source telle qu'une feuille de calcul Google Sheets ou du texte brut. Le modèle se présente comme suit:

Ensuite, choisissez du texte brut ou Google Sheets comme source de données en définissant la variable SOURCE. La valeur par défaut est en texte brut, ce qui correspond aux exemples de données de la variable TEXT_SOURCE_DATA. Pour obtenir les données à partir d'une feuille de calcul Google Sheets, définissez la variable SOURCE sur 'sheets' et faites-la pointer vers notre exemple (ou le vôtre) en définissant la variable SHEETS_FILE_ID. Voici notre feuille de calcul pour vous donner une idée du format:

Testez l'application avec nos exemples de données, puis adaptez-les à vos données et à votre cas d'utilisation. L'application de ligne de commande fonctionne comme suit:

  • Configuration
  • Extraire les données de la source de données
  • Parcourir chaque ligne de données
    • Créer une copie du modèle
    • Fusionner la copie avec les données
    • Lien de sortie vers le document fusionné

Toutes les nouvelles lettres fusionnées apparaissent également dans le Google Drive de l'utilisateur. Voici un exemple de lettre fusionnée:

Code source

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

Pour en savoir plus, consultez le fichier README et le code source complet de l'application dans le dépôt Open Source de cette application exemple.