รวบรวมเนื้อหาจากเอกสารหลายรายการ

ระดับการเขียนโค้ด: ผู้เริ่มต้น
ระยะเวลา: 15 นาที
ประเภทโปรเจ็กต์: การทำงานอัตโนมัติด้วยเมนูที่กำหนดเอง

วัตถุประสงค์

  • ทำความเข้าใจสิ่งที่โซลูชันทำ
  • ทำความเข้าใจสิ่งที่บริการ Apps Script ทำได้ภายในโซลูชัน
  • ตั้งค่าสคริปต์
  • เรียกใช้สคริปต์

เกี่ยวกับโซลูชันนี้

คุณสามารถนำเข้าเนื้อหาจากเอกสารหลายฉบับไปยังเอกสารหลักใน Google เอกสารได้โดยอัตโนมัติ เพื่อประหยัดเวลาและลดข้อผิดพลาดจากการคัดลอกและวางด้วยตนเอง โซลูชันนี้มุ่งเน้นที่การรวบรวมรายงานสถานะโปรเจ็กต์ แต่คุณสามารถแก้ไขให้เหมาะกับความต้องการได้

ตัวอย่างรายงานสถานะโปรเจ็กต์แบบรวมภายในเอกสารใน Google เอกสาร

วิธีการทำงาน

สคริปต์จะสร้างโฟลเดอร์เพื่อจัดเก็บเอกสารที่คุณต้องการนำเข้า เนื้อหาและเอกสารเทมเพลตเพื่อเริ่มนำเข้า นอกจากนี้ สคริปต์ยังมีฟังก์ชันที่สร้างเอกสารตัวอย่างเพื่อสาธิตโซลูชันนี้ด้วย

เมื่อผู้ใช้เลือกนำเข้าข้อมูลสรุปจากเมนูที่กำหนดเอง สคริปต์จะรับ ไฟล์เอกสารทั้งหมดในโฟลเดอร์และวนซ้ำแต่ละไฟล์ สคริปต์จะค้นหาสตริงและประเภทส่วนหัวที่เฉพาะเจาะจงเพื่อระบุข้อความสรุป ที่ต้องคัดลอก หลังจากคัดลอกข้อความแล้ว สคริปต์จะเปลี่ยนสีข้อความของสตริงตัวระบุเพื่อลดการทำซ้ำ สคริปต์จะวางข้อมูลสรุป ลงในเอกสารหลัก โดยแต่ละรายการจะอยู่ในตารางแบบเซลล์เดียวของตัวเอง

บริการ Apps Script

โซลูชันนี้ใช้บริการต่อไปนี้

  • บริการเอกสาร: สร้างเทมเพลตและเอกสารต้นฉบับตัวอย่าง วนซ้ำในเอกสารต้นฉบับแต่ละฉบับเพื่อค้นหาสรุปโปรเจ็กต์ใหม่ที่จะนำเข้า นำเข้าข้อมูลสรุปไปยังเอกสารหลัก อัปเดตเอกสารต้นฉบับเพื่อป้องกันไม่ให้นำเข้าข้อมูลสรุปมากกว่า 1 ครั้ง
  • บริการ Google ไดรฟ์: สร้างโฟลเดอร์เพื่อ จัดเก็บเอกสารต้นฉบับ เพิ่มเอกสารเทมเพลตและเอกสารต้นฉบับตัวอย่าง ลงในโฟลเดอร์
  • บริการยูทิลิตี: จัดรูปแบบวันที่ที่สคริปต์เพิ่มลงในเอกสารหลักทุกครั้งที่สคริปต์นำเข้าข้อมูลสรุปจากเอกสารต้นฉบับ
  • บริการพื้นฐาน: ใช้คลาส Session เพื่อรับเขตเวลาของสคริปต์ สคริปต์จะใช้เขตเวลาเมื่อเพิ่มวันที่นำเข้าลงในเอกสารหลัก

ข้อกำหนดเบื้องต้น

หากต้องการใช้ตัวอย่างนี้ คุณต้องมีข้อกำหนดเบื้องต้นต่อไปนี้

หากต้องการใช้ตัวอย่างนี้ คุณต้องมีข้อกำหนดเบื้องต้นต่อไปนี้

  • บัญชี Google (บัญชี Google Workspace อาจต้อง ได้รับการอนุมัติจากผู้ดูแลระบบ)
  • เว็บเบราว์เซอร์ที่มีสิทธิ์เข้าถึงอินเทอร์เน็ต

ตั้งค่าสคริปต์

คลิกปุ่มต่อไปนี้เพื่อทำสำเนาเอกสารเนื้อหาที่รวบรวม

ทำสำเนา

เรียกใช้สคริปต์

ทำตามขั้นตอนต่อไปนี้เพื่อเรียกใช้สคริปต์และดูวิธีการทำงาน

เรียกใช้การสาธิตด้วยเอกสารตัวอย่าง

  1. คลิกนำเข้าข้อมูลสรุป > กำหนดค่า > เรียกใช้การตั้งค่าเดโมด้วยเอกสารตัวอย่าง คุณอาจต้องรีเฟรชหน้าเว็บเพื่อให้เมนูที่กำหนดเองนี้ปรากฏขึ้น
  2. ให้สิทธิ์สคริปต์เมื่อได้รับข้อความแจ้ง <<../_snippets/oauth.md>>
  3. คลิกนำเข้าข้อมูลสรุป > กำหนดค่า > เรียกใช้การตั้งค่าเดโมด้วยเอกสารตัวอย่าง อีกครั้ง
  4. เมื่อได้รับข้อความแจ้ง ให้คัดลอก URL ของโฟลเดอร์ไดรฟ์เพื่อใช้ใน ขั้นตอนถัดไป
  5. คลิกตกลง
  6. คลิกนำเข้าข้อมูลสรุป > นำเข้า ข้อมูลสรุป
  7. เมื่อมีข้อความแจ้ง ให้คลิกตกลง
  8. ตรวจสอบข้อมูลสรุปโปรเจ็กต์ที่นำเข้าจากเอกสารตัวอย่าง

เพิ่มและนำเข้าข้อมูลสรุป

  1. ในแท็บเบราว์เซอร์ใหม่ ให้วาง URL ของโฟลเดอร์เพื่อเปิดโฟลเดอร์สถานะโปรเจ็กต์
  2. เปิดไฟล์โปรเจ็กต์ ABC
  3. สร้างข้อมูลสรุปใหม่เพื่อนำเข้าโดยเพิ่มเนื้อหาต่อไปนี้ที่ส่วนท้ายของ เอกสาร
    1. พิมพ์ Summary แล้วตั้งค่ารูปแบบข้อความเป็นหัวเรื่อง 3
    2. แทรกตารางขนาด 1x1 ใต้ Summary โดยตรง ตรวจสอบว่าไม่มี บรรทัดว่างระหว่าง Summary กับตาราง
    3. พิมพ์ Hello world! ในตาราง
  4. เปลี่ยนกลับไปที่เอกสารหลัก แล้วคลิกนำเข้าข้อมูลสรุป > นำเข้าข้อมูลสรุป
  5. เมื่อมีข้อความแจ้ง ให้คลิกตกลง
  6. ดูการนำเข้าล่าสุดที่ส่วนท้ายของเอกสาร

ตรวจสอบโค้ด

หากต้องการตรวจสอบโค้ด Apps Script สำหรับโซลูชันนี้ ให้คลิกดูซอร์สโค้ด

ดูซอร์สโค้ด

Code.gs

solutions/automations/aggregate-document-content/Code.js
// To learn how to use this script, refer to the documentation:
// https://developers.google.com/apps-script/samples/automations/aggregate-document-content

/*
Copyright 2022 Google LLC

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

/**
 * This file containts the main application functions that import data from
 * summary documents into the body of the main document.
 */

// Application constants
const APP_TITLE = "Document summary importer"; // Application name
const PROJECT_FOLDER_NAME = "Project statuses"; // Drive folder for the source files.

// Below are the parameters used to identify which content to import from the source documents
// and which content has already been imported.
const FIND_TEXT_KEYWORDS = "Summary"; // String that must be found in the heading above the table (case insensitive).
const APP_STYLE = DocumentApp.ParagraphHeading.HEADING3; // Style that must be applied to heading above the table.
const TEXT_COLOR = "#2e7d32"; // Color applied to heading after import to avoid duplication.

/**
 * Updates the main document, importing content from the source files.
 * Uses the above parameters to locate content to be imported.
 *
 * Called from menu option.
 */
function performImport() {
  // Gets the folder in Drive associated with this application.
  const folder = getFolderByName_(PROJECT_FOLDER_NAME);
  // Gets the Google Docs files found in the folder.
  const files = getFiles(folder);

  // Warns the user if the folder is empty.
  const ui = DocumentApp.getUi();
  if (files.length === 0) {
    const msg = `No files found in the folder '${PROJECT_FOLDER_NAME}'.
      Run '${MENU.SETUP}' | '${MENU.SAMPLES}' from the menu
      if you'd like to create samples files.`;
    ui.alert(APP_TITLE, msg, ui.ButtonSet.OK);
    return;
  }

  /** Processes main document */
  // Gets the active document and body section.
  const docTarget = DocumentApp.getActiveDocument();
  const docTargetBody = docTarget.getBody();

  // Appends import summary section to the end of the target document.
  // Adds a horizontal line and a header with today's date and a title string.
  docTargetBody.appendHorizontalRule();
  const dateString = Utilities.formatDate(
    new Date(),
    Session.getScriptTimeZone(),
    "MMMM dd, yyyy",
  );
  const headingText = `Imported: ${dateString}`;
  docTargetBody.appendParagraph(headingText).setHeading(APP_STYLE);
  // Appends a blank paragraph for spacing.
  docTargetBody.appendParagraph(" ");

  /** Process source documents */
  // Iterates through each source document in the folder.
  // Copies and pastes new updates to the main document.
  const noContentList = [];
  let numUpdates = 0;
  for (const id of files) {
    // Opens source document; get info and body.
    const docOpen = DocumentApp.openById(id);
    const docName = docOpen.getName();
    const docHtml = docOpen.getUrl();
    const docBody = docOpen.getBody();

    // Gets summary content from document and returns as object {content:content}
    const content = getContent(docBody);

    // Logs if document doesn't contain content to be imported.
    if (!content) {
      noContentList.push(docName);
      continue;
    }
    numUpdates++;
    // Inserts content into the main document.
    // Appends a title/url reference link back to source document.
    docTargetBody
      .appendParagraph("")
      .appendText(`${docName}`)
      .setLinkUrl(docHtml);
    // Appends a single-cell table and pastes the content.
    docTargetBody.appendTable(content);
    docOpen.saveAndClose();
  }
  /** Provides an import summary */
  docTarget.saveAndClose();
  let msg = `Number of documents updated: ${numUpdates}`;
  if (noContentList.length !== 0) {
    msg += "\n\nThe following documents had no updates:";
    for (const file of noContentList) {
      msg += `\n ${file}`;
    }
  }
  ui.alert(APP_TITLE, msg, ui.ButtonSet.OK);
}

/**
 * Updates the main document drawing content from source files.
 * Uses the parameters at the top of this file to locate content to import.
 *
 * Called from performImport().
 */
function getContent(body) {
  // Finds the heading paragraph with matching style, keywords and !color.
  let parValidHeading;
  const searchType = DocumentApp.ElementType.PARAGRAPH;
  const searchHeading = APP_STYLE;
  let searchResult = null;

  // Gets and loops through all paragraphs that match the style of APP_STYLE.
  while (true) {
    searchResult = body.findElement(searchType, searchResult);
    if (!searchResult) {
      break;
    }

    const par = searchResult.getElement().asParagraph();
    if (par.getHeading() === searchHeading) {
      // If heading style matches, searches for text string (case insensitive).
      const findPos = par.findText(`(?i)${FIND_TEXT_KEYWORDS}`);
      if (findPos !== null) {
        // If text color is green, then the paragraph isn't a new summary to copy.
        if (par.editAsText().getForegroundColor() !== TEXT_COLOR) {
          parValidHeading = par;
        }
      }
    }
  }

  if (!parValidHeading) {
    return;
  }
  // Updates the heading color to indicate that the summary has been imported.
  const style = {};
  style[DocumentApp.Attribute.FOREGROUND_COLOR] = TEXT_COLOR;
  parValidHeading.setAttributes(style);
  parValidHeading.appendText(" [Exported]");

  // Gets the content from the table following the valid heading.
  const elemObj = parValidHeading.getNextSibling().asTable();
  const content = elemObj.copy();

  return content;
}

/**
 * Gets the IDs of the Docs files within the folder that contains source files.
 *
 * Called from function performImport().
 */
function getFiles(folder) {
  // Only gets Docs files.
  const files = folder.getFilesByType(MimeType.GOOGLE_DOCS);
  const docIDs = [];
  while (files.hasNext()) {
    const file = files.next();
    docIDs.push(file.getId());
  }
  return docIDs;
}
 
</section>
<section>
  <h3>Menu.gs</h3>
solutions/automations/aggregate-document-content/Menu.js
/**
 * Copyright 2022 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * This file contains the functions that build the custom menu.
 */
// Menu constants for easy access to update.
const MENU = {
  NAME: "Import summaries",
  IMPORT: "Import summaries",
  SETUP: "Configure",
  NEW_INSTANCE: "Setup new instance",
  TEMPLATE: "Create starter template",
  SAMPLES: "Run demo setup with sample documents",
};

/**
 * Creates custom menu when the document is opened.
 */
function onOpen() {
  const ui = DocumentApp.getUi();
  ui.createMenu(MENU.NAME)
    .addItem(MENU.IMPORT, "performImport")
    .addSeparator()
    .addSubMenu(
      ui
        .createMenu(MENU.SETUP)
        .addItem(MENU.NEW_INSTANCE, "setupConfig")
        .addItem(MENU.TEMPLATE, "createSampleFile")
        .addSeparator()
        .addItem(MENU.SAMPLES, "setupWithSamples"),
    )
    .addItem("About", "aboutApp")
    .addToUi();
}

/**
 * About box for context and contact.
 * TODO: Personalize
 */
function aboutApp() {
  const msg = `
  ${APP_TITLE}
  Version: 1.0
  Contact: <Developer Email goes here>`;

  const ui = DocumentApp.getUi();
  ui.alert("About this application", msg, ui.ButtonSet.OK);
}
 
</section>
<section>
  <h3>Setup.gs</h3>
solutions/automations/aggregate-document-content/Setup.js
/**
 * Copyright 2022 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * This file contains functions that create the template and sample documents.
 */

/**
 * Runs full setup configuration, with option to include samples.
 *
 * Called from menu & setupWithSamples()
 *
 * @param {boolean} includeSamples - Optional, if true creates samples files. *
 */
function setupConfig(includeSamples) {
  // Gets folder to store documents in.
  const folder = getFolderByName_(PROJECT_FOLDER_NAME);

  let msg = `\nDrive Folder for Documents: '${PROJECT_FOLDER_NAME}'
   \nURL: \n${folder.getUrl()}`;

  // Creates sample documents for testing.
  // Remove sample document creation and add your own process as needed.
  if (includeSamples) {
    let filesCreated = 0;
    for (const doc of samples.documents) {
      filesCreated += createGoogleDoc(doc, folder, true);
    }
    msg += `\n\nFiles Created: ${filesCreated}`;
  }
  const ui = DocumentApp.getUi();
  ui.alert(`${APP_TITLE} [Setup]`, msg, ui.ButtonSet.OK);
}

/**
 * Creates a single document instance in the application folder.
 * Includes import settings already created [Heading | Keywords | Table]
 *
 * Called from menu.
 */
function createSampleFile() {
  // Creates a new Google Docs document.
  const templateName = `[Template] ${APP_TITLE}`;
  const doc = DocumentApp.create(templateName);
  const docId = doc.getId();

  const msg = `\nDocument created: '${templateName}'
  \nURL: \n${doc.getUrl()}`;

  // Adds template content to the body.
  const body = doc.getBody();

  body.setText(templateName);
  body.getParagraphs()[0].setHeading(DocumentApp.ParagraphHeading.TITLE);
  body
    .appendParagraph("Description")
    .setHeading(DocumentApp.ParagraphHeading.HEADING1);
  body.appendParagraph("");

  const dateString = Utilities.formatDate(
    new Date(),
    Session.getScriptTimeZone(),
    "MMMM dd, yyyy",
  );
  body
    .appendParagraph(`${FIND_TEXT_KEYWORDS} - ${dateString}`)
    .setHeading(APP_STYLE);
  body.appendTable().appendTableRow().appendTableCell("TL;DR");
  body.appendParagraph("");

  // Gets folder to store documents in.
  const folder = getFolderByName_(PROJECT_FOLDER_NAME);

  // Moves document to application folder.
  DriveApp.getFileById(docId).moveTo(folder);

  const ui = DocumentApp.getUi();
  ui.alert(`${APP_TITLE} [Template]`, msg, ui.ButtonSet.OK);
}

/**
 * Configures application for demonstration by setting it up with sample documents.
 *
 * Called from menu | Calls setupConfig with option set to true.
 */
function setupWithSamples() {
  setupConfig(true);
}

/**
 * Sample document names and demo content.
 * {object} samples[]
 */
const samples = {
  documents: [
    {
      name: "Project GHI",
      description: "Google Workspace Add-on inventory review.",
      content:
        "Reviewed all of the currently in-use and proposed Google Workspace Add-ons. Will perform an assessment on how we can reduce overlap, reduce licensing costs, and limit security exposures. \n\nNext week's goal is to report findings back to the Corp Ops team.",
    },
    {
      name: "Project DEF",
      description: "Improve IT networks within the main corporate building.",
      content:
        "Primarily focused on 2nd thru 5th floors in the main corporate building evaluating the network infrastructure. Benchmarking tests were performed and results are being analyzed. \n\nWill submit all findings, analysis, and recommendations next week for committee review.",
    },
    {
      name: "Project ABC",
      description:
        "Assess existing Google Chromebook inventory and recommend upgrades where necessary.",
      content:
        "Concluded a pilot program with the Customer Service department to perform inventory and update inventory records with Chromebook hardware, Chrome OS versions, and installed apps. \n\nScheduling a work plan and seeking necessary go-forward approvals for next week.",
    },
  ],
  common:
    'This sample document is configured to work with the Import summaries custom menu. For the import to work, the source documents used must contain a specific keyword (currently set to "Summary"). The keyword must reside in a paragraph with a set style (currently set to "Heading 3") that is directly followed by a single-cell table. The table contains the contents to be imported into the primary document.\n\nWhile those rules might seem precise, it\'s how the application programmatically determines what content is meant to be imported and what can be ignored. Once a summary has been imported, the script updates the heading font to a new color (currently set to Green, hex \'#2e7d32\') to ensure the app ignores it in future imports. You can change these settings in the Apps Script code.',
};

/**
 * Creates a sample document in application folder.
 * Includes import settings already created [Heading | Keywords | Table].
 * Inserts demo data from samples[].
 *
 * Called from menu.
 */
function createGoogleDoc(document, folder, duplicate) {
  // Checks for duplicates.
  if (!duplicate) {
    // Doesn't create file of same name if one already exists.
    if (folder.getFilesByName(document.name).hasNext()) {
      return 0; // File not created.
    }
  }

  // Creates a new Google Docs document.
  const doc = DocumentApp.create(document.name).setName(document.name);
  const docId = doc.getId();

  // Adds boilerplate content to the body.
  const body = doc.getBody();

  body.setText(document.name);
  body.getParagraphs()[0].setHeading(DocumentApp.ParagraphHeading.TITLE);
  body
    .appendParagraph("Description")
    .setHeading(DocumentApp.ParagraphHeading.HEADING1);
  body.appendParagraph(document.description);
  body
    .appendParagraph("Usage Instructions")
    .setHeading(DocumentApp.ParagraphHeading.HEADING1);
  body.appendParagraph(samples.common);

  const dateString = Utilities.formatDate(
    new Date(),
    Session.getScriptTimeZone(),
    "MMMM dd, yyyy",
  );
  body
    .appendParagraph(`${FIND_TEXT_KEYWORDS} - ${dateString}`)
    .setHeading(APP_STYLE);
  body.appendTable().appendTableRow().appendTableCell(document.content);
  body.appendParagraph("");

  // Moves document to application folder.
  DriveApp.getFileById(docId).moveTo(folder);

  // Returns if successfully created.
  return 1;
}
 
</section>
<section>
  <h3>Utilities.gs</h3>
solutions/automations/aggregate-document-content/Utilities.js
/**
 * Copyright 2022 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * This file contains common utility functions.
 */

/**
 * Returns a Drive folder located in same folder that the application document is located.
 * Checks if the folder exists and returns that folder, or creates new one if not found.
 *
 * @param {string} folderName - Name of the Drive folder.
 * @return {object} Google Drive folder
 */
function getFolderByName_(folderName) {
  // Gets the Drive folder where the current document is located.
  const docId = DocumentApp.getActiveDocument().getId();
  const parentFolder = DriveApp.getFileById(docId).getParents().next();

  // Iterates subfolders to check if folder already exists.
  const subFolders = parentFolder.getFolders();
  while (subFolders.hasNext()) {
    const folder = subFolders.next();

    // Returns the existing folder if found.
    if (folder.getName() === folderName) {
      return folder;
    }
  }
  // Creates a new folder if one doesn't already exist.
  return parentFolder
    .createFolder(folderName)
    .setDescription(
      `Created by ${APP_TITLE} application to store documents to process`,
    );
}

/**
 * Test function to run getFolderByName_.
 * @logs details of created Google Drive folder.
 */
function test_getFolderByName() {
  // Gets the folder in Drive associated with this application.
  const folder = getFolderByName_(PROJECT_FOLDER_NAME);

  console.log(
    `Name: ${folder.getName()}\rID: ${folder.getId()}\rURL:${folder.getUrl()}\rDescription: ${folder.getDescription()}`,
  );
  // Uncomment the following to automatically delete the test folder.
  // folder.setTrashed(true);
}
 
</section>

ผู้ร่วมให้ข้อมูล

ตัวอย่างนี้ได้รับการดูแลโดย Google โดยได้รับความช่วยเหลือจาก Google Developer Experts

ขั้นตอนถัดไป