Class Document

เอกสาร

เอกสารที่มีออบเจ็กต์ Tab อย่างน้อย 1 รายการ โดยแต่ละรายการมีข้อความริชมีเดียและองค์ประกอบต่างๆ เช่น ตารางและรายการ

คุณเปิดหรือสร้างเอกสารได้โดยใช้ DocumentApp 

// Open a document by ID.
let doc = DocumentApp.openById('<my-id>');

// Create and open a document.
doc = DocumentApp.create('Document Title');

เมธอดในคลาส Document ที่เข้าถึงและแก้ไขเนื้อหาข้อความโดยตรงจะทำงานในแท็บที่ใช้งานอยู่ (ในสคริปต์ที่เชื่อมโยงกับเอกสารหนึ่งๆ) หรือแท็บแรก (หากไม่มีแท็บที่ใช้งานอยู่) สคริปต์ที่ใช้วิธีการเหล่านี้ (เช่น getBody()) สามารถย้ายข้อมูลเพื่อรองรับแท็บได้โดยใช้ getTabs() ตามด้วย Tab.asDocumentTab()

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
addBookmark(position)Bookmarkเพิ่ม Bookmark ที่ Position ที่กำหนดลงในแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร ให้เพิ่มลงในแท็บที่ใช้งานอยู่
addEditor(emailAddress)Documentเพิ่มผู้ใช้ที่ระบุลงในรายชื่อผู้แก้ไขของ Document
addEditor(user)Documentเพิ่มผู้ใช้ที่ระบุลงในรายชื่อผู้แก้ไขของ Document
addEditors(emailAddresses)Documentเพิ่มอาร์เรย์ของผู้ใช้ที่ระบุลงในรายชื่อผู้แก้ไขของ Document
addFooter()FooterSectionเพิ่มส่วนท้าย (หากไม่มี) ลงในแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร ให้เพิ่มลงในแท็บที่ใช้งานอยู่
addHeader()HeaderSectionเพิ่มส่วนส่วนหัว (หากไม่มี) ลงในแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร ให้เพิ่มลงในแท็บที่ใช้งานอยู่
addNamedRange(name, range)NamedRangeเพิ่ม NamedRange ซึ่งเป็น Range ที่มีชื่อและรหัสเพื่อใช้สำหรับการดึงข้อมูลในภายหลังในแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร ให้เพิ่มในแท็บที่ใช้งานอยู่
addViewer(emailAddress)Documentเพิ่มผู้ใช้ที่ระบุลงในรายชื่อผู้ดูของ Document
addViewer(user)Documentเพิ่มผู้ใช้ที่ระบุลงในรายชื่อผู้ดูของ Document
addViewers(emailAddresses)Documentเพิ่มอาร์เรย์ผู้ใช้ที่ระบุลงในรายการผู้ชมของ Document
getActiveTab()Tabรับ Tab ที่ใช้งานอยู่ในปัจจุบันของผู้ใช้ในเอกสาร
getAs(contentType)Blobดึงข้อมูลเนื้อหา Document ปัจจุบันเป็น Blob ของประเภทที่ระบุ
getBlob()Blobดึงข้อมูลเนื้อหา Document ปัจจุบันเป็น Blob
getBody()Bodyดึงข้อมูล Body ของแท็บแรก หรือ DocumentBodySection ของแท็บที่ใช้งานอยู่สำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร
getBookmark(id)Bookmarkรับ Bookmark ที่มีรหัสที่ระบุในแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร ให้รับแท็บที่ใช้งานอยู่
getBookmarks()Bookmark[]รับออบเจ็กต์ Bookmark ทั้งหมดในแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร ให้รับในแท็บที่ใช้งานอยู่
getCursor()Positionรับเคอร์เซอร์ของผู้ใช้ในแท็บที่ใช้งานอยู่
getEditors()User[]รับรายชื่อผู้แก้ไขสำหรับ Document นี้
getFooter()FooterSectionดึงข้อมูลส่วนท้ายของแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร ให้ดึงข้อมูลส่วนท้ายของแท็บที่ใช้งานอยู่
getFootnotes()Footnote[]ดึงข้อมูลองค์ประกอบ Footnote ทั้งหมดในเนื้อหาของแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร ให้ดึงข้อมูลเนื้อหาของแท็บที่ใช้งานอยู่
getHeader()HeaderSectionดึงข้อมูลส่วนหัวของแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร ให้ดึงข้อมูลส่วนหัวของแท็บที่ใช้งานอยู่
getId()Stringดึงข้อมูลตัวระบุที่ไม่ซ้ำกันของเอกสาร
getLanguage()Stringรับรหัสภาษาของเอกสาร
getName()Stringดึงข้อมูลชื่อเอกสาร
getNamedRangeById(id)NamedRangeรับ NamedRange ที่มีรหัสที่ระบุในแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร ให้รับแท็บที่ใช้งานอยู่
getNamedRanges()NamedRange[]รับออบเจ็กต์ NamedRange ทั้งหมดในแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร ให้รับในแท็บที่ใช้งานอยู่
getNamedRanges(name)NamedRange[]รับออบเจ็กต์ NamedRange ทั้งหมดที่มีชื่อที่ระบุในแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร ให้รับแท็บที่ใช้งานอยู่
getSelection()Rangeรับการเลือกของผู้ใช้ในแท็บที่ใช้งานอยู่
getSupportedLanguageCodes()String[]รับรหัสภาษาทั้งหมดที่รองรับในไฟล์ Google เอกสาร
getTab(tabId)Tabรับ Tab ที่มีรหัสที่ระบุ
getTabs()Tab[]รับ Tab ทั้งหมดที่ไม่ได้ฝังอยู่ซึ่งเป็นส่วนหนึ่งของเอกสาร
getUrl()Stringดึงข้อมูล URL เพื่อเข้าถึงเอกสารปัจจุบัน
getViewers()User[]รับรายการผู้ชมและผู้แสดงความคิดเห็นสำหรับ Document นี้
newPosition(element, offset)Positionสร้าง Position ใหม่ ซึ่งเป็นการอ้างอิงตำแหน่งในแท็บ โดยสัมพันธ์กับองค์ประกอบที่เฉพาะเจาะจงในแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร จะเป็นแท็บที่ใช้งานอยู่
newRange()RangeBuilderสร้างเครื่องมือสร้างที่ใช้สร้างออบเจ็กต์ Range จากองค์ประกอบแท็บในแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร จะเป็นแท็บที่ใช้งานอยู่
removeEditor(emailAddress)Documentนำผู้ใช้ที่ระบุออกจากรายชื่อผู้แก้ไขของ Document
removeEditor(user)Documentนำผู้ใช้ที่ระบุออกจากรายชื่อผู้แก้ไขของ Document
removeViewer(emailAddress)Documentนำผู้ใช้ที่ระบุออกจากรายชื่อผู้ชมและผู้แสดงความคิดเห็นของ Document
removeViewer(user)Documentนำผู้ใช้ที่ระบุออกจากรายชื่อผู้ชมและผู้แสดงความคิดเห็นของ Document
saveAndClose()voidบันทึก Document ปัจจุบัน
setActiveTab(tabId)voidตั้งค่า Tab ที่ผู้ใช้เลือกในเอกสารปัจจุบันเป็นแท็บที่มีรหัสที่ระบุ
setCursor(position)Documentตั้งค่าเคอร์เซอร์ของผู้ใช้โดยระบุ Position
setLanguage(languageCode)Documentตั้งค่ารหัสภาษาของเอกสาร
setName(name)Documentตั้งค่าชื่อเอกสาร
setSelection(range)Documentตั้งค่าการเลือกของผู้ใช้ในแท็บที่ใช้งานอยู่โดยระบุ Range

เอกสารประกอบโดยละเอียด

addBookmark(position)

เพิ่ม 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('123abc');

// 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());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
positionPositionตำแหน่งของบุ๊กมาร์กใหม่

รีเทิร์น

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

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

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

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

addEditor(emailAddress)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
emailAddressStringอีเมลของผู้ใช้ที่จะเพิ่ม

รีเทิร์น

Document — Document สำหรับใช้ต่อ

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

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

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

addEditor(user)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
userUserการแสดงผู้ใช้ที่จะเพิ่ม

รีเทิร์น

Document — Document สำหรับใช้ต่อ

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

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

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

addEditors(emailAddresses)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
emailAddressesString[]อาร์เรย์อีเมลของผู้ใช้ที่จะเพิ่ม

รีเทิร์น

Document — Document สำหรับใช้ต่อ

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

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

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

addFooter()

เพิ่มส่วนท้าย (หากไม่มี) ลงในแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร ให้เพิ่มลงในแท็บที่ใช้งานอยู่ หากต้องการเพิ่มส่วนท้ายลงในแท็บใดก็ตาม ให้ใช้เมธอด 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('123abc');

// 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

addHeader()

เพิ่มส่วนส่วนหัว (หากไม่มี) ลงในแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร ให้เพิ่มลงในแท็บที่ใช้งานอยู่ หากต้องการเพิ่มส่วนหัวในแท็บใดก็ตาม ให้ใช้เมธอด 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('123abc');

// 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

addNamedRange(name, range)

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

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

// Creates a named range that includes every table in the active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let 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());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
nameStringชื่อของช่วง ซึ่งไม่จำเป็นต้องไม่ซ้ำกัน ชื่อช่วงต้องมีความยาวระหว่าง 1-256 อักขระ
rangeRangeช่วงขององค์ประกอบที่จะเชื่อมโยงกับชื่อ ซึ่งอาจเป็นการเลือกที่ใช้งานอยู่ ผลการค้นหา หรือสร้างด้วย newRange() ด้วยตนเอง

รีเทิร์น

NamedRange — NamedRange

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

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

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

addViewer(emailAddress)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
emailAddressStringอีเมลของผู้ใช้ที่จะเพิ่ม

รีเทิร์น

Document — Document นี้สําหรับการต่อเชื่อม

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

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

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

addViewer(user)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
userUserการแสดงผู้ใช้ที่จะเพิ่ม

รีเทิร์น

Document — Document สำหรับใช้ต่อ

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

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

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

addViewers(emailAddresses)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
emailAddressesString[]อาร์เรย์อีเมลของผู้ใช้ที่จะเพิ่ม

รีเทิร์น

Document — Document สำหรับใช้ต่อ

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

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

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

getActiveTab()

รับ 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

getAs(contentType)

ดึงข้อมูลเนื้อหา 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('123abc');

// 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());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
contentTypeStringประเภท MIME ที่จะแปลงเป็น 'application/pdf' และ 'text/markdown'

รีเทิร์น

Blob — เอกสารปัจจุบันในรูปแบบ Blob

getBlob()

ดึงข้อมูลเนื้อหา 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('123abc');

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

รีเทิร์น

Blob — เอกสารปัจจุบันในรูปแบบ Blob

getBody()

ดึงข้อมูล 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('123abc');

// 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

getBookmark(id)

รับ 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('123abc');

// 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.');
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
idStringรหัสของ Bookmark

รีเทิร์น

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

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

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

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

getBookmarks()

รับออบเจ็กต์ 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('123abc');

// 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

getCursor()

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

// Insert some text at the cursor position and make it bold.
const 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.
  const 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

getEditors()

รับรายชื่อผู้แก้ไขสำหรับ Document นี้

รีเทิร์น

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

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

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

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

getFooter()

ดึงข้อมูลส่วนท้ายของแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร ให้ดึงข้อมูลส่วนท้ายของแท็บที่ใช้งานอยู่ หากต้องการดูส่วนท้ายของแท็บใดก็ตาม ให้ใช้เมธอด 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('123abc');

// 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

getFootnotes()

ดึงข้อมูลองค์ประกอบ 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('123abc');

// 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

getHeader()

ดึงข้อมูลส่วนหัวของแท็บแรก หรือสำหรับสคริปต์ที่เชื่อมโยงกับเอกสาร ให้ดึงข้อมูลส่วนหัวของแท็บที่ใช้งานอยู่ หากต้องการดูส่วนหัวของแท็บใดก็ตาม ให้ใช้เมธอด 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('123abc');

// 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

getId()

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

รีเทิร์น

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

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

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

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

getLanguage()

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

รีเทิร์น

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

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

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

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

getName()

ดึงข้อมูลชื่อเอกสาร

รีเทิร์น

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

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

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

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

getNamedRangeById(id)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
idStringรหัสของช่วง ซึ่งไม่ซ้ำกันภายในแท็บ

รีเทิร์น

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

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

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

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

getNamedRanges()

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

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

รีเทิร์น

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

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

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

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

getNamedRanges(name)

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
nameStringชื่อของช่วง ซึ่งไม่จำเป็นต้องไม่ซ้ำกัน

รีเทิร์น

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

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

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

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

getSelection()

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

// Display a dialog box that tells the user how many elements are included in
// the selection.
const selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  const 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

getSupportedLanguageCodes()

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

รีเทิร์น

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

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

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

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

getTab(tabId)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
tabIdStringรหัสของแท็บที่จะรับ

รีเทิร์น

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

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

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

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

getTabs()

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

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

รีเทิร์น

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

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

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

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

getUrl()

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

const 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

getViewers()

รับรายการผู้ชมและผู้แสดงความคิดเห็นสำหรับ Document นี้

รีเทิร์น

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

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

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

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

newPosition(element, offset)

สร้าง 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.
const doc = DocumentApp.getActiveDocument();
const paragraph = doc.getBody().appendParagraph('My new paragraph.');
const position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
elementElementองค์ประกอบที่ควรมี Position ใหม่ ซึ่งต้องเป็นองค์ประกอบ Text หรือองค์ประกอบคอนเทนเนอร์ เช่น Paragraph
offsetIntegerสําหรับองค์ประกอบ Text คือจํานวนของอักขระก่อน Position สําหรับองค์ประกอบอื่นๆ คือจํานวนองค์ประกอบย่อยก่อน Position ภายในองค์ประกอบคอนเทนเนอร์เดียวกัน

รีเทิร์น

Position — Position เวอร์ชันใหม่

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

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

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

newRange()

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

// Change the user's selection to a range that includes every table in the
// active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let 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

removeEditor(emailAddress)

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
emailAddressStringอีเมลของผู้ใช้ที่จะนำออก

รีเทิร์น

Document — Document สำหรับใช้ต่อ

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

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

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

removeEditor(user)

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
userUserการแสดงผู้ใช้ที่จะนำออก

รีเทิร์น

Document — Document นี้สําหรับการต่อเชื่อม

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

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

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

removeViewer(emailAddress)

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
emailAddressStringอีเมลของผู้ใช้ที่จะนำออก

รีเทิร์น

Document — Document นี้สําหรับการต่อเชื่อม

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

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

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

removeViewer(user)

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
userUserการแสดงผู้ใช้ที่จะนำออก

รีเทิร์น

Document — Document นี้สําหรับการต่อเชื่อม

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

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

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

saveAndClose()

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

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

Document ที่ปิดแล้วจะแก้ไขไม่ได้ ใช้ DocumentApp.openById() เพื่อเปิดเอกสารที่ต้องการแก้ไขอีกครั้ง

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

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

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

setActiveTab(tabId)

ตั้งค่า 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('123abc');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
tabIdStringรหัสของแท็บที่จะตั้งค่าเป็นใช้งานอยู่

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

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

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

setCursor(position)

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

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

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
positionPositionตำแหน่งเคอร์เซอร์ใหม่

รีเทิร์น

Document — Document สำหรับใช้ต่อ

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

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

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

setLanguage(languageCode)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
languageCodeStringรหัสภาษา

รีเทิร์น

Document — Document นี้สําหรับการต่อเชื่อม

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

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

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

setName(name)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
nameStringชื่อเอกสารใหม่

รีเทิร์น

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

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

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

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

setSelection(range)

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

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rangeRangeช่วงองค์ประกอบใหม่ที่จะเลือก

รีเทิร์น

Document — Document สำหรับใช้ต่อ

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

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

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