Class Document

เพิ่ม Bookmark ที่ Position ที่ระบุไปยังแท็บแรก หรือสำหรับสคริปต์ที่ เชื่อมโยงกับเอกสาร แท็บที่ใช้งานอยู่ หากต้องการเพิ่ม บุ๊กมาร์กไปยังแท็บใดก็ได้ ให้ใช้เมธอด DocumentTab.addBookmark(position)

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the active or first tab's body and adds a paragraph.
const paragraph = doc.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = doc.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = doc.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

}

พารามิเตอร์

รีเทิร์น

Bookmark — บุ๊กมาร์กใหม่

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

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

พารามิเตอร์

รีเทิร์น

Document — Document นี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

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

พารามิเตอร์

รีเทิร์น

Document — Document นี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

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

พารามิเตอร์

รีเทิร์น

Document — Document นี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

เพิ่มส่วนท้าย (หากยังไม่มี) ลงในแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร ให้เลือกแท็บที่ใช้งานอยู่ วิธีเพิ่มส่วนท้าย แท็บใดก็ได้ ให้ใช้เมธอด DocumentTab.addFooter()

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Adds a footer to the document's active or first tab.
const footer = doc.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

รีเทิร์น

FooterSection — ส่วนท้ายของแท็บ

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

เพิ่มส่วนหัว (ถ้าไม่มี) ลงในแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร ให้เลือกแท็บที่ใช้งานอยู่ วิธีเพิ่มส่วนหัว แท็บใดก็ได้ ให้ใช้เมธอด DocumentTab.addHeader()

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Adds a header to the document's active or first tab.
const header = doc.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

รีเทิร์น

HeaderSection — ส่วนหัวของแท็บ

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

เพิ่ม NamedRange ซึ่งเป็น Range ที่มีชื่อและรหัสที่จะใช้ ดึงข้อมูลในภายหลังในแท็บแรก หรือแท็บที่ใช้งานอยู่สำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร หากต้องการเพิ่ม NamedRange ลงในแท็บใดก็ตาม ให้ใช้เมธอด DocumentTab.addNamedRange(name, range) ชื่อไม่เท่ากัน ต้องไม่ซ้ำกัน ช่วงต่างๆ ที่อยู่ในเอกสารเดียวกัน สามารถใช้ชื่อเดียวกันได้ เช่น ชั้นเรียนใน HTML ในทางตรงกันข้าม รหัสจะไม่ซ้ำกันภายในเอกสาร เช่น รหัสใน HTML หลังจากเพิ่ม NamedRange ในเอกสารแล้ว คุณจะแก้ไขไม่ได้ ทำได้เพียงนำออกเท่านั้น

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

// Creates a named range that includes every table in the active tab.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
// Adds the named range to the document's active tab.
doc.addNamedRange('Document tables', rangeBuilder.build());

พารามิเตอร์

รีเทิร์น

NamedRange — NamedRange

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

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

พารามิเตอร์

รีเทิร์น

Document — Document นี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

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

พารามิเตอร์

รีเทิร์น

Document — Document นี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

เพิ่มอาร์เรย์ของผู้ใช้ที่ระบุลงในรายการผู้มีสิทธิ์อ่านสำหรับ Document หากมี ผู้ใช้อยู่ในรายชื่อผู้แก้ไขอยู่แล้ว วิธีนี้ไม่มีผลต่อผู้ใช้

พารามิเตอร์

รีเทิร์น

Document — Document นี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

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

// Display a dialog box that shows the title of the tab that the
// user is currently viewing.
const tab = DocumentApp.getActiveDocument().getActiveTab();
DocumentApp.getUi().alert('ID of selected tab: ' + tab.getTitle());

รีเทิร์น

Tab — Tab ของผู้ใช้ที่ใช้งานอยู่ในปัจจุบัน หรือ null หากสคริปต์ไม่ได้เชื่อมโยงกับ เอกสาร

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

เรียกเนื้อหา Document ปัจจุบันเป็น BLOB ของประเภทที่ระบุ

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the document as a PDF.
const pdf = doc.getAs('application/pdf');

// Logs the name of the PDF to the console.
console.log(pdf.getName());

พารามิเตอร์

รีเทิร์น

Blob — เอกสารปัจจุบันที่เป็น BLOB

เรียกเนื้อหา Document ปัจจุบันเป็น BLOB

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Retrieves the current document's contents as a blob and logs it to the console.
console.log(doc.getBlob().getContentType());

รีเทิร์น

Blob — เอกสารปัจจุบันที่เป็น BLOB

เรียก Body ของแท็บแรก หรือสำหรับสคริปต์ที่ เชื่อมโยง กับเอกสารคือ DocumentBodySection ของแท็บที่มีการใช้งาน หากต้องการรับ DocumentBodySection ของแท็บใดก็ตาม ให้ใช้เมธอด DocumentTab.getBody()

แท็บอาจมีส่วนประเภทต่างๆ (เช่น HeaderSection, FooterSection) ส่วนที่ใช้งานอยู่ของแท็บคือ Body

เมธอดองค์ประกอบใน Document จะมอบสิทธิ์ให้กับ Body ที่ใช้งานอยู่

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the active or first tab's body.
const body = doc.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

รีเทิร์น

Body — ส่วนเนื้อหาแท็บ

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

รับ Bookmark ที่มีรหัสที่ระบุในแท็บแรก หรือรับแท็บที่ใช้งานอยู่สำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร หากต้องการ บุ๊กมาร์กในแท็บใดก็ได้ ให้ใช้เมธอด DocumentTab.getBookmark(id) เมธอดนี้จะแสดง null หากไม่มี Bookmark ดังกล่าวภายในแท็บ

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the bookmark by its ID in the document's active or first tab.
const bookmark = doc.getBookmark('id.xyz654321');

// If the bookmark exists, logs the character offset of its position to the console.
// otherwise, logs 'No bookmark exists with the given ID.' to the console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

พารามิเตอร์

รีเทิร์น

Bookmark — Bookmark ที่มีรหัสที่ระบุ หรือ null หากไม่มี Bookmark ดังกล่าว อยู่ภายในแท็บนั้น

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

รับออบเจ็กต์ Bookmark ทั้งหมดในแท็บแรก หรือรับแท็บที่ใช้งานอยู่สำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร เพื่อรับทั้งหมด บุ๊กมาร์กในแท็บใดก็ได้ ให้ใช้เมธอด DocumentTab.getBookmarks()

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets all of the bookmarks in the document's active or first tab.
const bookmarks = doc.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

รีเทิร์น

Bookmark[] — อาร์เรย์ของออบเจ็กต์ Bookmark ในแท็บ

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

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

// Insert some text at the cursor position and make it bold.
var cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns null, the cursor's
  // containing element doesn't allow insertions, so show the user an error message.
  var element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

รีเทิร์น

Position — การนำเสนอเคอร์เซอร์ของผู้ใช้ หรือ null หากผู้ใช้ไม่มี วางเคอร์เซอร์ไว้ในแท็บ หรือหากสคริปต์ไม่ได้เชื่อมโยงกับเอกสาร

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

รับรายชื่อเอดิเตอร์ของ Document นี้

รีเทิร์น

User[] — อาร์เรย์ของผู้ใช้ที่มีสิทธิ์แก้ไข

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

เรียกดูส่วนท้ายของแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร ส่วนท้ายของแท็บที่ใช้งานอยู่ หากต้องการดูส่วนท้ายของแท็บ ให้ใช้เมธอด DocumentTab.getFooter()

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the text of the active or first tab's footer and logs it to the console.
console.log(doc.getFooter().getText());

รีเทิร์น

FooterSection — ส่วนท้ายของแท็บ

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

เรียกองค์ประกอบ Footnote ทั้งหมดในเนื้อหาของแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร จะใช้เนื้อความของแท็บที่ใช้งานอยู่ โดยวิธีการมีดังนี้ เชิงอรรถทั้งหมดในแท็บใดก็ตาม ให้ใช้เมธอด DocumentTab.getFootnotes()

การเรียก getFootnotes จะทำให้องค์ประกอบของแท็บซ้ำกัน สำหรับแท็บขนาดใหญ่ หลีกเลี่ยงการเรียกวิธีนี้ที่ไม่จำเป็น

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the first footnote in the active or first tab's body.
const footnote = doc.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

รีเทิร์น

Footnote[] — เชิงอรรถของแท็บ

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

เรียกข้อมูลส่วนหัวของแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร จะเรียกส่วนหัวของแท็บที่ใช้งานอยู่ หากต้องการดูส่วนหัวของแท็บใดก็ตาม ให้ใช้เมธอด DocumentTab.getHeader()

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the text of the active or first tab's header and logs it to the console.
console.log(doc.getHeader().getText());

รีเทิร์น

HeaderSection — ส่วนหัวของแท็บ

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

เรียกข้อมูลตัวระบุที่ไม่ซ้ำกันของเอกสาร รหัสเอกสารจะใช้กับ DocumentApp.openById() เพื่อเปิดอินสแตนซ์เอกสารที่ต้องการ

รีเทิร์น

String — รหัสของเอกสาร

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

รับรหัสภาษาของเอกสาร ซึ่งเป็นภาษาที่แสดงในไฟล์ของเครื่องมือแก้ไขเอกสาร ภาษา ซึ่งอาจไม่ใช่ภาษาจริงของเอกสาร

รีเทิร์น

String — ภาษาของเอกสาร หรือ null หากไม่ได้กำหนดไว้

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

เรียกข้อมูลชื่อเอกสาร

รีเทิร์น

String — ชื่อเอกสาร

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

รับ NamedRange ที่มีรหัสที่ระบุในแท็บแรก หรือรับแท็บที่ใช้งานอยู่สำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร หากต้องการดาวน์โหลด NamedRange ที่มีรหัสที่ระบุในแท็บใดก็ได้ ให้ใช้ DocumentTab.getNamedRangeById(id) เมธอดนี้จะแสดง null หากไม่มี NamedRange ดังกล่าวในแท็บ ชื่อ ไม่จำเป็นต้องไม่ซ้ำกัน แม้จะแสดงในแท็บต่างๆ ช่วงต่างๆ หลายช่วงในแท็บเดียวกันอาจ ใช้ชื่อเดียวกัน คล้ายกับชั้นเรียนใน HTML ในทางตรงกันข้าม รหัสจะไม่ซ้ำกันภายในแท็บนั้น เช่น รหัสใน HTML

พารามิเตอร์

รีเทิร์น

NamedRange — NamedRange ที่มีรหัสที่ระบุ หรือ null หากไม่มีช่วงดังกล่าวอยู่ใน แท็บ

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

รับออบเจ็กต์ NamedRange ทั้งหมดในแท็บแรก หรือรับแท็บที่ใช้งานอยู่สำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร เพื่อรับทั้งหมด NamedRange ออบเจ็กต์ในแท็บใดก็ได้ ให้ใช้เมธอด DocumentTab.getNamedRanges()

สคริปต์ที่เข้าถึงแท็บจะเข้าถึง NamedRange ได้ วิธีหลีกเลี่ยง ความขัดแย้งที่ไม่ได้ตั้งใจระหว่างสคริปต์ ให้ลองเพิ่มคำนำหน้าชื่อช่วงด้วยสตริงที่ไม่ซ้ำกัน

รีเทิร์น

NamedRange[] — อาร์เรย์ของออบเจ็กต์ NamedRange ในแท็บ ซึ่งอาจรวมถึงหลายรายการ ช่วงที่มีชื่อเดียวกัน

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

รับออบเจ็กต์ NamedRange ทั้งหมดที่มีชื่อที่ระบุในแท็บแรก หรือสำหรับสคริปต์ที่ จะเชื่อมโยงกับเอกสาร แท็บที่ใช้งานอยู่ โดยวิธีการมีดังนี้ ออบเจ็กต์ NamedRange ทั้งหมดในแท็บใดก็ได้ ให้ใช้เมธอด DocumentTab.getNamedRanges(name) ชื่อไม่จำเป็นต้องไม่ซ้ำกัน แม้จะอยู่ในแท็บต่างๆ ในช่วงต่างๆ ใน แท็บเดียวกันอาจใช้ชื่อเดียวกัน เหมือนชั้นเรียนใน HTML ในทางตรงกันข้าม รหัสจะไม่ซ้ำกัน ภายในแท็บ เช่น รหัสใน HTML

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

พารามิเตอร์

รีเทิร์น

NamedRange[] — อาร์เรย์ของออบเจ็กต์ NamedRange ในแท็บที่มีชื่อตัว

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

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

// Display a dialog box that tells the user how many elements are included in the selection.
var selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  var elements = selection.getRangeElements();
  DocumentApp.getUi().alert('Number of selected elements: ' + elements.length);
} else {
  DocumentApp.getUi().alert('Nothing is selected.');
}

รีเทิร์น

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

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

รับรหัสภาษาทั้งหมดที่รองรับในไฟล์ Google เอกสาร

รีเทิร์น

String[] — อาร์เรย์ของรหัสภาษา

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

รับ Tab ที่มีรหัสที่ระบุ เมธอดนี้จะแสดง null หากไม่มี Tab ดังกล่าวอยู่ เข้าถึงแท็บในระดับที่ซ้อนได้ทุกระดับ

พารามิเตอร์

รีเทิร์น

Tab — Tab ที่มีรหัสที่ระบุ หรือ null หากไม่มี Tab ดังกล่าวอยู่

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

รับ Tab ที่ไม่ได้ซ้อนทั้งหมดซึ่งเป็นส่วนหนึ่งของเอกสาร

แท็บสามารถมีแท็บย่อย ซึ่งเป็นแท็บที่ฝังอยู่ภายในแท็บอื่น เข้าถึงแท็บย่อยได้ ด้วย Tab.getChildTabs()

รีเทิร์น

Tab[] — รายการของ Tab ทั้งหมดที่เป็นส่วนหนึ่งของเอกสาร

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

เรียกข้อมูล URL เพื่อเข้าถึงเอกสารปัจจุบัน

var doc = DocumentApp.getActiveDocument();

// Send out the link to open the document.
MailApp.sendEmail("<email-address>", doc.getName(), doc.getUrl());

รีเทิร์น

String — URL เพื่อเข้าถึงเอกสารปัจจุบัน

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

ดูรายชื่อผู้มีสิทธิ์อ่านและผู้แสดงความคิดเห็นสำหรับ Document นี้

รีเทิร์น

User[] — อาร์เรย์ของผู้ใช้ที่มีสิทธิ์ดูหรือแสดงความคิดเห็น

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

สร้าง Position ใหม่ ซึ่งเป็นการอ้างอิงไปยังตำแหน่งในแท็บที่สัมพันธ์กับ องค์ประกอบที่เฉพาะเจาะจงในแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร จะใช้แท็บที่ใช้งานอยู่ วิธีสร้าง Position ที่เกี่ยวข้องกับตำแหน่งในแท็บใดก็ได้ ให้ใช้ DocumentTab.newPosition(element, offset) เคอร์เซอร์ของผู้ใช้จะแสดงเป็น Position นอกเหนือจากการใช้งานในลักษณะอื่นๆ

// Append a paragraph to the active tab, then place the user's cursor after the first word of
// the new paragraph.
var doc = DocumentApp.getActiveDocument();
var paragraph = doc.getBody().appendParagraph('My new paragraph.');
var position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

พารามิเตอร์

รีเทิร์น

Position — Position ใหม่

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

สร้างเครื่องมือสร้างที่ใช้สร้างออบเจ็กต์ Range จากองค์ประกอบแท็บใน แท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับ เอกสาร แท็บที่ใช้งานอยู่ วิธีสร้างเครื่องมือสร้างที่ใช้ในการสร้างออบเจ็กต์ DocumentRange จากองค์ประกอบแท็บในแท็บใดก็ตาม ให้ใช้เมธอด DocumentTab.newRange()

// Change the user's selection to a range that includes every table in the active tab.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

รีเทิร์น

RangeBuilder — เครื่องมือสร้างใหม่

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

นำผู้ใช้ที่ระบุออกจากรายชื่อเอดิเตอร์ของ Document วิธีนี้ไม่ บล็อกไม่ให้ผู้ใช้เข้าถึง Document หากผู้ใช้อยู่ในกลุ่มผู้ใช้ที่มี สิทธิ์การเข้าถึงทั่วไป เช่น หากแชร์ Document กับทั้งหมดของผู้ใช้ หรือหาก Document อยู่ในไดรฟ์ที่แชร์ที่ผู้ใช้เข้าถึงได้

สำหรับไฟล์ในไดรฟ์ การดำเนินการนี้จะนำผู้ใช้ออกจากรายการผู้ดูด้วย

พารามิเตอร์

รีเทิร์น

Document — Document นี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

นำผู้ใช้ที่ระบุออกจากรายชื่อเอดิเตอร์ของ Document วิธีนี้ไม่ บล็อกไม่ให้ผู้ใช้เข้าถึง Document หากผู้ใช้อยู่ในกลุ่มผู้ใช้ที่มี สิทธิ์การเข้าถึงทั่วไป เช่น หากแชร์ Document กับทั้งหมดของผู้ใช้ หรือหาก Document อยู่ในไดรฟ์ที่แชร์ที่ผู้ใช้เข้าถึงได้

สำหรับไฟล์ในไดรฟ์ การดำเนินการนี้จะนำผู้ใช้ออกจากรายการผู้ดูด้วย

พารามิเตอร์

รีเทิร์น

Document — Document นี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

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

สำหรับไฟล์ในไดรฟ์ การดำเนินการนี้จะนำผู้ใช้ออกจากรายการเครื่องมือแก้ไขด้วย

พารามิเตอร์

รีเทิร์น

Document — Document นี้สำหรับการทำสายโซ่

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

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

สำหรับไฟล์ในไดรฟ์ การดำเนินการนี้จะนำผู้ใช้ออกจากรายการเครื่องมือแก้ไขด้วย

พารามิเตอร์

รีเทิร์น

Document — Document นี้สำหรับการทำสายโซ่

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

บันทึก Document ปัจจุบัน ทำให้การอัปเดตที่รอดำเนินการถูกล้างและใช้

ระบบจะเรียกใช้เมธอด saveAndClose() โดยอัตโนมัติเมื่อสิ้นสุดการเรียกใช้สคริปต์ สำหรับแต่ละ Document ที่แก้ไขได้

ไม่สามารถแก้ไข Document ที่ปิดไปแล้วได้ ใช้ DocumentApp.openById() เพื่อเปิด เอกสารที่กำหนดให้แก้ไข

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

ตั้งค่า Tab ที่ผู้ใช้เลือกในเอกสารปัจจุบันเป็นแท็บที่มีรหัสที่ระบุ

const doc = DocumentApp.getActiveDocument()

// Sets the user's selected tab by its ID.
// TODO(developer): Replace the ID with your own.
const tab = doc.setActiveTab(TAB_ID);

พารามิเตอร์

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

ตั้งค่าเคอร์เซอร์ของผู้ใช้ตาม Position สคริปต์จะเข้าถึงได้เฉพาะเคอร์เซอร์ของ ผู้ใช้ที่เรียกใช้สคริปต์ และเฉพาะเมื่อสคริปต์มีการเชื่อมโยงกับเอกสาร

การระบุ Position จาก Tab ที่ไม่ได้ใช้งานจะเปลี่ยนแท็บที่ใช้งานอยู่ของผู้ใช้

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
var position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

พารามิเตอร์

รีเทิร์น

Document — Document นี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

ตั้งค่ารหัสภาษาของเอกสาร ซึ่งเป็นภาษาที่แสดงในไฟล์ของเครื่องมือแก้ไขเอกสาร ภาษา ซึ่งอาจไม่ใช่ภาษาจริงของเอกสาร ใช้ getSupportedLanguageCodes() เพื่อรับรหัสภาษาที่ถูกต้องทั้งหมด

พารามิเตอร์

รีเทิร์น

Document — Document นี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

ตั้งค่าชื่อเอกสาร

พารามิเตอร์

รีเทิร์น

Document — เอกสารปัจจุบัน

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

ตั้งค่าการเลือกของผู้ใช้ในแท็บที่ใช้งานอยู่ตาม Range สคริปต์เท่านั้น เข้าถึงการเลือกของผู้ใช้ที่เรียกใช้สคริปต์ และเฉพาะในกรณีที่สคริปต์เชื่อมโยงกับเอกสารเท่านั้น

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();

// Change the user's selection to a range that includes every table in the document.
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

พารามิเตอร์

รีเทิร์น

Document — Document นี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents