Class Document

จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ
เอกสาร

เอกสารที่ประกอบด้วยข้อความและองค์ประกอบที่เป็นสื่อสมบูรณ์ เช่น ตารางและรายการ

เอกสารอาจเปิดหรือสร้างขึ้นโดยใช้ DocumentApp

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

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

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
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 ที่มีชื่อและ ID เพื่อเรียกข้อมูลในภายหลังได้
addViewer(emailAddress)Documentเพิ่มผู้ใช้รายดังกล่าวลงในรายการผู้ชมของDocument
addViewer(user)Documentเพิ่มผู้ใช้รายดังกล่าวลงในรายการผู้ชมของDocument
addViewers(emailAddresses)Documentเพิ่มอาร์เรย์ผู้ใช้ที่ระบุลงในรายการผู้ชมของ Document
getAs(contentType)Blobเรียกเนื้อหา Document ปัจจุบันเป็น Blob ของประเภทที่ระบุ
getBlob()Blobเรียกเนื้อหา Document ปัจจุบันเป็น BLOB
getBody()Bodyเรียกเอกสาร Body ที่ใช้งานอยู่
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 เอกสาร
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 ปัจจุบัน
setCursor(position)Documentตั้งค่าเคอร์เซอร์ของผู้ใช้ในเอกสารที่ใช้งานอยู่ โดยใส่ Position
setLanguage(languageCode)Documentตั้งค่ารหัสภาษาของเอกสาร
setName(name)Documentตั้งชื่อเอกสาร
setSelection(range)Documentตั้งค่าการเลือกของผู้ใช้ในเอกสารที่ใช้งานอยู่ซึ่งระบุ Range

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

addBookmark(position)

เพิ่ม Bookmark ที่ Position ที่ให้ไว้

พารามิเตอร์

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

ไปกลับ

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

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

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

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

addEditor(emailAddress)

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

พารามิเตอร์

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

ไปกลับ

DocumentDocument นี้สําหรับเชนธุรกิจ

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

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

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

addEditor(user)

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

พารามิเตอร์

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

ไปกลับ

DocumentDocument นี้สําหรับเชนธุรกิจ

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

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

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

addEditors(emailAddresses)

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

พารามิเตอร์

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

ไปกลับ

DocumentDocument นี้สําหรับเชนธุรกิจ

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

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

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

addFooter()

เพิ่มส่วนส่วนท้ายของเอกสาร หากยังไม่มี

ไปกลับ

FooterSection — ส่วนท้ายของเอกสาร

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

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

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

addHeader()

เพิ่มส่วนหัวของเอกสาร หากไม่มีอยู่

ไปกลับ

HeaderSection — ส่วนหัวของเอกสาร

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

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

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

addNamedRange(name, range)

เพิ่ม NamedRange ใหม่ ซึ่งเป็นRange ที่มีชื่อและ ID เพื่อเรียกข้อมูลในภายหลังได้ ชื่ออาจซ้ํากันได้หลายช่วง และใช้เอกสารหลายฉบับในชื่อเดียวกันร่วมกันได้ ซึ่งจะคล้ายกับชื่อของชั้นเรียนใน HTML เดียวกัน ในทางตรงกันข้าม รหัสภายในเอกสารจะไม่ซ้ํากัน เช่น รหัสใน HTML เมื่อเพิ่ม NamedRange ไปยังเอกสารแล้ว คุณจะแก้ไขไม่ได้และนําออกเท่านั้น

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

// Change the user's selection to a range that includes every table in the document.
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());

พารามิเตอร์

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

ไปกลับ

NamedRangeNamedRange ใหม่

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

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

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

addViewer(emailAddress)

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

พารามิเตอร์

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

ไปกลับ

DocumentDocument นี้สําหรับเชนธุรกิจ

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

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

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

addViewer(user)

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

พารามิเตอร์

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

ไปกลับ

DocumentDocument นี้สําหรับเชนธุรกิจ

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

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

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

addViewers(emailAddresses)

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

พารามิเตอร์

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

ไปกลับ

DocumentDocument นี้สําหรับเชนธุรกิจ

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

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

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

getAs(contentType)

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

พารามิเตอร์

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

ไปกลับ

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


getBlob()

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

ไปกลับ

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


getBody()

เรียกเอกสาร Body ที่ใช้งานอยู่

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

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

ไปกลับ

Body — ส่วนเนื้อหาของเอกสารที่ใช้งานอยู่

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

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

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

getBookmark(id)

รับ Bookmark ด้วยรหัสที่ระบุ เมธอดนี้จะแสดงผล null หากไม่มี Bookmark ดังกล่าว

พารามิเตอร์

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

ไปกลับ

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

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

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

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

getBookmarks()

รับออบเจ็กต์ Bookmark ทั้งหมดในเอกสาร

ไปกลับ

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

getEditors()

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

ไปกลับ

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

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

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

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

getFooter()

เรียกส่วนส่วนท้ายของเอกสาร หากมี

ไปกลับ

FooterSection — ส่วนท้ายของเอกสาร

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

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

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

getFootnotes()

เรียกองค์ประกอบ Footnote ทั้งหมดในเนื้อความเอกสาร

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

ไปกลับ

Footnote[] — เชิงอรรถของเอกสาร

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

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

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

getHeader()

เรียกส่วนหัวของเอกสาร' หากมี

ไปกลับ

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 ด้วยรหัสที่ระบุ เมธอดนี้จะแสดงผล null หากไม่มี NamedRange ดังกล่าว ชื่ออาจซ้ํากันได้หลายรายการ ช่วงต่างๆ ในเอกสารเดียวกันจะใช้ชื่อเดียวกัน เช่น ชั้นเรียนใน HTML ในทางตรงกันข้าม รหัสรหัสจะไม่ซ้ํากันภายในเอกสาร เช่น รหัสใน HTML

พารามิเตอร์

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

ไปกลับ

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

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

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

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

getNamedRanges()

รับออบเจ็กต์ NamedRange ทั้งหมดในเอกสาร

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

ไปกลับ

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

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

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

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

getNamedRanges(name)

รับออบเจ็กต์ NamedRange ทั้งหมดในเอกสารที่มีชื่อที่กําหนด ชื่อไม่จําเป็นต้องซ้ํากัน ช่วงต่างๆ ในเอกสารเดียวกันอาจมีชื่อเดียวกัน เช่น ชั้นเรียนใน 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.
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

getSupportedLanguageCodes()

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

ไปกลับ

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

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

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

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

getUrl()

เรียกข้อมูล 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

getViewers()

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

ไปกลับ

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

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

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

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

newPosition(element, offset)

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

// Append a paragraph, 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);

พารามิเตอร์

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

ไปกลับ

PositionPosition ใหม่

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

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

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

newRange()

สร้างเครื่องมือสร้างที่ใช้สร้างออบเจ็กต์ Range จากองค์ประกอบเอกสาร

// Change the user's selection to a range that includes every table in the document.
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

removeEditor(emailAddress)

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

สําหรับไฟล์ในไดรฟ์ การดําเนินการนี้จะนําผู้ใช้ออกจากรายชื่อผู้มีสิทธิ์อ่านด้วย

พารามิเตอร์

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

ไปกลับ

DocumentDocument นี้สําหรับเชนธุรกิจ

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

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

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

removeEditor(user)

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

สําหรับไฟล์ในไดรฟ์ การดําเนินการนี้จะนําผู้ใช้ออกจากรายชื่อผู้มีสิทธิ์อ่านด้วย

พารามิเตอร์

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

ไปกลับ

DocumentDocument นี้สําหรับเชนธุรกิจ

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

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

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

removeViewer(emailAddress)

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

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

พารามิเตอร์

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

ไปกลับ

DocumentDocument นี้สําหรับเชนธุรกิจ

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

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

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

removeViewer(user)

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

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

พารามิเตอร์

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

ไปกลับ

DocumentDocument นี้สําหรับเชนธุรกิจ

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

สคริปต์ที่ใช้วิธีนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 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

setCursor(position)

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

// Append a paragraph, 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);

พารามิเตอร์

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

ไปกลับ

DocumentDocument นี้สําหรับเชนธุรกิจ

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

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

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

setLanguage(languageCode)

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

พารามิเตอร์

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

ไปกลับ

DocumentDocument นี้สําหรับเชนธุรกิจ

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

สคริปต์ที่ใช้วิธีนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 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 สคริปต์สามารถเข้าถึงการเลือกของผู้ใช้ที่กําลังเรียกใช้สคริปต์ และเฉพาะในกรณีที่สคริปต์เชื่อมโยงกับเอกสารเท่านั้น

// Change the user's selection to a range that includes every table in the document.
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());

พารามิเตอร์

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

ไปกลับ

DocumentDocument นี้สําหรับเชนธุรกิจ

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

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

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