Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Questa guida spiega come utilizzare l'API Documenti Google per eseguire un'unione dinamica.
Introduzione
Un merging prende i valori dalle righe di un foglio di lavoro o di un'altra origine dati e li inserisce in un documento modello. In questo modo puoi creare un singolo documento principale (il modello) da cui puoi generare molti documenti simili, ciascuno personalizzato con i dati da unire. Il risultato non viene necessariamente utilizzato per lettere o moduli, ma può essere utilizzato per qualsiasi scopo, ad esempio per generare un lotto di fatture dei clienti.
L'unione dinamica esiste da quando esistono fogli di lavoro e elaboratori di testi e oggi fa parte di molti flussi di lavoro aziendali. La convenzione è di
organizzare i dati come un record per riga, con le colonne che rappresentano i campi
nei dati, come mostrato nella tabella seguente:
Nome
Indirizzo
Zona
1
UrbanPq
123 1st St.
Occidentale
2
Pawxana
456 2nd St.
Meridionale
L'app di esempio in questa pagina mostra come utilizzare le API Documenti, Fogli e Drive di Google per astrarre i dettagli relativi all'esecuzione dell'unione dinamica, proteggendo gli utenti dai problemi di implementazione. Puoi trovare ulteriori informazioni su questo esempio Python nel
repo GitHub dell'esempio.
Applicazione di esempio
Questa app di esempio copia il modello principale e poi unisce le variabili dell'origine dati designata in ciascuna delle copie. Per provare questa app di esempio, imposta prima il modello:
Prendi nota dell'ID documento del nuovo file. Per ulteriori informazioni, consulta Document
ID.
Imposta la variabile DOCS_FILE_ID sull'ID documento.
Sostituisci i dati di contatto con le variabili segnaposto del modello che l'app unisce ai dati selezionati.
Ecco un modello di lettera
di esempio con segnaposto che possono essere uniti a dati reali di un'origine come testo normale o Fogli. Ecco come si presenta il modello:
Quindi, scegli il testo normale o Fogli come origine dati utilizzando la variabile SOURCE. Per impostazione predefinita, il sample è in testo normale, il che significa che i dati di esempio utilizzano la variabile TEXT_SOURCE_DATA. Per recuperare i dati da Sheets, aggiorna la variabile SOURCE in 'sheets' e impostala sul nostro foglio di lavoro di esempio (o sul tuo) impostando la variabile SHEETS_FILE_ID.
Ecco come appare il foglio per consentirti di vedere il formato:
Prova l'app con i nostri dati di esempio, quindi adattala ai tuoi dati e al tuo caso d'uso. L'applicazione a riga di comando funziona nel seguente modo:
Configurazione
Recupera i dati dall'origine dati
Esegui un ciclo per ogni riga di dati
Crea una copia del modello
Unisci la copia ai dati
Link all'output del documento appena unito
Tutte le lettere appena unite vengono visualizzate anche in Il mio Drive dell'utente. Ecco un example di lettera unita:
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))
)
Per ulteriori informazioni, consulta il file README e il codice sorgente completo dell'applicazione nel repo GitHub dell'app di esempio.
[[["Facile da capire","easyToUnderstand","thumb-up"],["Il problema è stato risolto","solvedMyProblem","thumb-up"],["Altra","otherUp","thumb-up"]],[["Mancano le informazioni di cui ho bisogno","missingTheInformationINeed","thumb-down"],["Troppo complicato/troppi passaggi","tooComplicatedTooManySteps","thumb-down"],["Obsoleti","outOfDate","thumb-down"],["Problema di traduzione","translationIssue","thumb-down"],["Problema relativo a esempi/codice","samplesCodeIssue","thumb-down"],["Altra","otherDown","thumb-down"]],["Ultimo aggiornamento 2024-11-23 UTC."],[[["This guide demonstrates how to utilize the Google Docs API to execute a mail merge, automating the process of generating personalized documents from a template and data source."],["Users can choose between plain text or a Google Sheet as their data source, with the sample app providing examples for both options."],["The application copies a template document, merges variables from the data source, and outputs a link to the newly-merged document, accessible in Google Drive."],["Placeholder variables within the template document are replaced with data from the designated source, allowing for customization of individual documents."],["Refer to the GitHub repository for the complete source code, setup instructions, and further information on using the sample application."]]],[]]