34. Replacing template placeholders
Module 7 · 20 minutes · Lesson 33; earlier service and JavaScript fundamentals
Open Interactive LessonDiscover
How can you use replacing template placeholders without changing the wrong data?
- Explain replacing template placeholders in your own words
- Trace the actual docs state change from the source
- Repair the supplied failing operation and verify the result
Predict
Which values or resources will change, and which should stay unchanged? Write your prediction before execution.
Understand
replaceText interprets its search string as a regular expression, not arbitrary literal text. Escape regex metacharacters in placeholder patterns. Copy the template before replacing so the original remains reusable. Google matches patterns within text blocks and uses RE2; the local subset uses JavaScript RegExp and is not a complete compatibility model.
Example 1: Working automation
Only the copy changes. The escaped braces identify the literal NAME placeholder.
function main() {
const copy = DriveApp.getFileById("template").makeCopy("Letter for Alex");
const body = DocumentApp.openById(copy.getId()).getTabs()[0].asDocumentTab().getBody();
body.replaceText("\\{\\{NAME\\}\\}", "Alex");
console.log(body.getText());
}Important line explanations
- Line 1: function main() {
- Define a named block of instructions. Run Script calls main; helpers run only when called.
- Line 2: const copy = DriveApp.getFileById("template").makeCopy("Letter for Alex");
- Call the named Workspace service. Locally this invokes a documented adapter; in Google it may require authorization and create persistent changes.
- Line 3: const body = DocumentApp.openById(copy.getId()).getTabs()[0].asDocumentTab().getBody();
- Call the named Workspace service. Locally this invokes a documented adapter; in Google it may require authorization and create persistent changes.
- Line 4: body.replaceText("\\{\\{NAME\\}\\}", "Alex");
- Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
- Line 5: console.log(body.getText());
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 6: }
- Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
"logs": [
"Dear Alex,\nYour project {{PROJECT}} is scheduled for completion on {{DATE}}."
],
"error": null,
"resource": "docs",
"value": {
"template": {
"name": "Letter template",
"paragraphs": [
"Dear {{NAME}},",
"Your project {{PROJECT}} is scheduled for completion on {{DATE}}."
]
},
"file-1": {
"name": "Letter for Alex",
"paragraphs": [
"Dear Alex,",
"Your project {{PROJECT}} is scheduled for completion on {{DATE}}."
]
}
}
}Example 2: Investigate a reproducible failure
Predict the effect of "Jordan"); and identify the first mismatch. This example is intentionally faulty.
function main() {
const copy = DriveApp.getFileById("template").makeCopy("Letter for Alex");
const body = DocumentApp.openById(copy.getId()).getTabs()[0].asDocumentTab().getBody();
body.replaceText("\\{\\{NAME\\}\\}", "Jordan");
console.log(body.getText());
}Important line explanations
- Line 1: function main() {
- Define a named block of instructions. Run Script calls main; helpers run only when called.
- Line 2: const copy = DriveApp.getFileById("template").makeCopy("Letter for Alex");
- Call the named Workspace service. Locally this invokes a documented adapter; in Google it may require authorization and create persistent changes.
- Line 3: const body = DocumentApp.openById(copy.getId()).getTabs()[0].asDocumentTab().getBody();
- Call the named Workspace service. Locally this invokes a documented adapter; in Google it may require authorization and create persistent changes.
- Line 4: body.replaceText("\\{\\{NAME\\}\\}", "Jordan");
- Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
- Line 5: console.log(body.getText());
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 6: }
- Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
"logs": [
"Dear Jordan,\nYour project {{PROJECT}} is scheduled for completion on {{DATE}}."
],
"error": null,
"resource": "docs",
"value": {
"template": {
"name": "Letter template",
"paragraphs": [
"Dear {{NAME}},",
"Your project {{PROJECT}} is scheduled for completion on {{DATE}}."
]
},
"file-1": {
"name": "Letter for Alex",
"paragraphs": [
"Dear Jordan,",
"Your project {{PROJECT}} is scheduled for completion on {{DATE}}."
]
}
}
}Example 3: Separate setup from execution and inspect repeat behavior
Call the same named operation twice. Compare outputs and resource counts to learn whether this operation is idempotent. Repeated creation is deliberately visible; real exports require a rerun policy.
function lessonAction() {
const copy = DriveApp.getFileById("template").makeCopy("Letter for Alex");
const body = DocumentApp.openById(copy.getId()).getTabs()[0].asDocumentTab().getBody();
body.replaceText("\\{\\{NAME\\}\\}", "Alex");
console.log(body.getText());
}
function main() {
lessonAction();
lessonAction();
}Important line explanations
- Line 1: function lessonAction() {
- Define a named block of instructions. Run Script calls main; helpers run only when called.
- Line 2: const copy = DriveApp.getFileById("template").makeCopy("Letter for Alex");
- Call the named Workspace service. Locally this invokes a documented adapter; in Google it may require authorization and create persistent changes.
- Line 3: const body = DocumentApp.openById(copy.getId()).getTabs()[0].asDocumentTab().getBody();
- Call the named Workspace service. Locally this invokes a documented adapter; in Google it may require authorization and create persistent changes.
- Line 4: body.replaceText("\\{\\{NAME\\}\\}", "Alex");
- Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
- Line 5: console.log(body.getText());
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 6: }
- Close the current block. Indentation makes scope and the function boundary visible.
- Line 7: function main() {
- Define a named block of instructions. Run Script calls main; helpers run only when called.
- Line 8: lessonAction();
- Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
- Line 9: lessonAction();
- Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
- Line 10: }
- Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
"logs": [
"Dear Alex,\nYour project {{PROJECT}} is scheduled for completion on {{DATE}}.",
"Dear Alex,\nYour project {{PROJECT}} is scheduled for completion on {{DATE}}."
],
"error": null,
"resource": "docs",
"value": {
"template": {
"name": "Letter template",
"paragraphs": [
"Dear {{NAME}},",
"Your project {{PROJECT}} is scheduled for completion on {{DATE}}."
]
},
"file-1": {
"name": "Letter for Alex",
"paragraphs": [
"Dear Alex,",
"Your project {{PROJECT}} is scheduled for completion on {{DATE}}."
]
},
"file-2": {
"name": "Letter for Alex",
"paragraphs": [
"Dear Alex,",
"Your project {{PROJECT}} is scheduled for completion on {{DATE}}."
]
}
}
}Example 4: Add a diagnostic boundary around the operation
Observe start, successful completion or a rethrown failure. This optional professional pattern adds error context without swallowing the error or rolling back changes.
function lessonAction() {
const copy = DriveApp.getFileById("template").makeCopy("Letter for Alex");
const body = DocumentApp.openById(copy.getId()).getTabs()[0].asDocumentTab().getBody();
body.replaceText("\\{\\{NAME\\}\\}", "Alex");
console.log(body.getText());
}
function main() {
console.log("Start: Replacing template placeholders");
try { lessonAction(); console.log("Completed operation"); }
catch(error) { console.error("Failed operation: " + error.message); throw error; }
}Important line explanations
- Line 1: function lessonAction() {
- Define a named block of instructions. Run Script calls main; helpers run only when called.
- Line 2: const copy = DriveApp.getFileById("template").makeCopy("Letter for Alex");
- Call the named Workspace service. Locally this invokes a documented adapter; in Google it may require authorization and create persistent changes.
- Line 3: const body = DocumentApp.openById(copy.getId()).getTabs()[0].asDocumentTab().getBody();
- Call the named Workspace service. Locally this invokes a documented adapter; in Google it may require authorization and create persistent changes.
- Line 4: body.replaceText("\\{\\{NAME\\}\\}", "Alex");
- Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
- Line 5: console.log(body.getText());
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 6: }
- Close the current block. Indentation makes scope and the function boundary visible.
- Line 7: function main() {
- Define a named block of instructions. Run Script calls main; helpers run only when called.
- Line 8: console.log("Start: Replacing template placeholders");
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 9: try { lessonAction(); console.log("Completed operation"); }
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 10: catch(error) { console.error("Failed operation: " + error.message); throw error; }
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 11: }
- Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
"logs": [
"Start: Replacing template placeholders",
"Dear Alex,\nYour project {{PROJECT}} is scheduled for completion on {{DATE}}.",
"Completed operation"
],
"error": null,
"resource": "docs",
"value": {
"template": {
"name": "Letter template",
"paragraphs": [
"Dear {{NAME}},",
"Your project {{PROJECT}} is scheduled for completion on {{DATE}}."
]
},
"file-1": {
"name": "Letter for Alex",
"paragraphs": [
"Dear Alex,",
"Your project {{PROJECT}} is scheduled for completion on {{DATE}}."
]
}
}
}Build and test
Repair the supplied script so that: Only the copy changes. The escaped braces identify the literal NAME placeholder. Preserve other source data. Checks compare observable output and the named resource, not exact source text.
function main() {
const copy = DriveApp.getFileById("template").makeCopy("Letter for Alex");
const body = DocumentApp.openById(copy.getId()).getTabs()[0].asDocumentTab().getBody();
body.replaceText("\\{\\{NAME\\}\\}", "Jordan");
console.log(body.getText());
}Graduated hints
Hint 1
Inspect the operation containing "Jordan");. Compare it with the stated rule and the first mismatch.
Hint 2
The repair concerns "Alex");. Change only the relevant argument, operator or method; rerun with fresh input.
Hint 3
The reference uses "Alex"); where the broken source uses "Jordan");. Explain why before applying it.
Reference solution
function main() {
const copy = DriveApp.getFileById("template").makeCopy("Letter for Alex");
const body = DocumentApp.openById(copy.getId()).getTabs()[0].asDocumentTab().getBody();
body.replaceText("\\{\\{NAME\\}\\}", "Alex");
console.log(body.getText());
}Explain and reflect
Which operation proves the intended result in replacing template placeholders? Which wrong input would expose a weakness, and what would remain unchanged?
Adapt the input records and docs output to a second realistic case. Write its expected result before running. Demonstrate one invalid case and explain whether the side effects should be rolled back or retried.
Troubleshooting
If the console is empty, inspect the docs preview: this script may work through state changes. If the function is missing, select main. For a service error inspect the first failed timeline entry and its arguments. Use Manual unless investigating a trigger. Changing input data also changes the expected result; restore sample data before the authored checks.
Knowledge check
Explain the key method or operator. Give an exact output for a second input, plus one invalid case. Verify the result in the interactive lesson; written explanations need self or educator review.
Optional AI practice
Explain this concept using the source above. Help implement one small extension and define its tests. Review/debug the source using its actual expected output; cite real method references and never claim execution.