Publipostage avec l'API Docs

Ce guide explique comment utiliser l'API Google Docs pour effectuer un publipostage.

Remarque :Si vous souhaitez effectuer un publipostage à l'aide de l'interface utilisateur Web de Gmail, consultez Envoyez des e-mails personnalisés avec la messagerie fusion.

Introduction

Le publipostage récupère des valeurs provenant 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. Cela vous permet de créer une seule instance document (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 des e-mails ou des lettres de formulaire, mais ils peuvent être utilisés à n'importe quelle fin, par exemple pour générer un lot factures client.

La fusion de courriers existe depuis l'apparition des feuilles de calcul et des traitements de texte, et fait partie de nombreux processus métier aujourd'hui. La convention est de organiser les données sous la forme d'un enregistrement par ligne, les colonnes représentant les champs dans les données, comme indiqué dans le tableau suivant:

	Nom	Adresse	Zone
1	UrbanPq	123 rue des Lilas	Ouest
2	Pawxana	456 2nd St.	Sud

L'application exemple présentée sur cette page vous montre comment utiliser Google Docs, Sheets et Drive pour éliminer des détails sur le fonctionnement des publipostages, empêchant ainsi les utilisateurs d'implémenter des problèmes. Pour en savoir plus sur cet exemple Python, consultez les GitHub repo.

Remarque :Vous devez avoir configuré un projet Google Cloud afin de disposer des identifiants pour pour que cela fonctionne. Vous trouverez plus d'informations dans Python guide de démarrage rapide. Assurez-vous que le API Drive, Docs et Sheets activé dans votre projet et le fichier JSON contenant vos identifiants est téléchargé sous forme de fichier credentials.json.

Exemple d'application

Cette application exemple copie votre modèle principal, puis fusionne les variables de votre source de données désignée dans chacune des copies. Pour essayer cette application exemple, commencez par Configurez votre modèle:

1. Créer un fichier Docs Choisissez le modèle que vous souhaitez utiliser.
2. Notez l'ID du document du nouveau fichier. Pour en savoir plus, consultez ID de document.
3. Définissez la variable DOCS_FILE_ID sur l'ID du document.
4. Remplacez les coordonnées par des variables d'espace réservé du modèle que les fusionne avec les données sélectionnées.

Voici un exemple de lettre modèle avec des espaces réservés pouvant être fusionnés avec des données réelles provenant d'une source texte ou Sheets. Voici à quoi ressemble ce modèle:

La structure des variables de modèle est arbitraire. L'exemple utilise des valeurs entre accolades doubles {{VALUE}} car il est très peu probable qu'un texte comme celui-ci apparaisse dans le contenu d'un document. Ce style de nommage des espaces réservés aux variables est similaire à celui que vous trouverez dans la plupart des bibliothèques de modèles.

Ensuite, choisissez le texte brut ou Sheets comme source de données à l'aide de la variable SOURCE. Par défaut, l'exemple est en texte brut, ce qui signifie que Les exemples de données utilisent la variable TEXT_SOURCE_DATA. Pour obtenir des données Sheets : remplacez la variable SOURCE par 'sheets' et faites-la pointer à notre échantillon feuille (ou la vôtre) en définissant la variable SHEETS_FILE_ID.

Voici à quoi ressemble la feuille, pour que vous puissiez voir le format:

Essayez l'application avec nos exemples de données, puis adaptez-la à 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 récemment fusionné

Toutes les lettres nouvellement fusionnées apparaissent également dans le dossier Mon Drive de l'utilisateur. Une exemple de lettre fusionnée ressemble à ceci:

Remarque : Pour les documents comportant plusieurs onglets, ReplaceAllTextRequest s'applique par défaut à tous les onglets. Pour en savoir plus, consultez les documents de demande des informations sur l'utilisation des onglets.

Code source

Python

docs/mail-merge/docs_mail_merge.py

Afficher sur GitHub

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": "[phone]",
    # - - - - - - - - - - - - - - - - - - - - - - - - - -
    # 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. sur la page GitHub de l'application exemple dépôt.

Articles associés

• Envoyer des e-mails personnalisés à l'aide du publipostage
• Créer un publipostage avec Gmail et Google Sheets