เอกสารที่มีข้อความและองค์ประกอบที่เป็นริชมีเดีย เช่น ตารางและรายการ
เอกสารอาจเปิดหรือสร้างขึ้นโดยใช้ 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 ที่มีชื่อและรหัสที่จะใช้เพื่อดึงข้อมูลในภายหลัง |
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
ที่ระบุ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
position | Position | ตําแหน่งของบุ๊กมาร์กใหม่ |
ไปกลับ
Bookmark
— บุ๊กมาร์กใหม่
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditor(emailAddress)
เพิ่มผู้ใช้ที่ต้องการลงในรายการเอดิเตอร์ของ Document
หากผู้ใช้อยู่ในรายการผู้ชมอยู่แล้ว วิธีการนี้จะโปรโมตผู้ใช้ออกจากรายชื่อผู้ชม
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
emailAddress | String | อีเมลของผู้ใช้ที่ต้องการเพิ่ม |
ไปกลับ
Document
— Document
นี้สําหรับเชนธุรกิจ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditor(user)
เพิ่มผู้ใช้ที่ต้องการลงในรายการเอดิเตอร์ของ Document
หากผู้ใช้อยู่ในรายการผู้ชมอยู่แล้ว วิธีการนี้จะโปรโมตผู้ใช้ออกจากรายชื่อผู้ชม
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
user | User | การแสดงผู้ใช้เพื่อเพิ่ม |
ไปกลับ
Document
— Document
นี้สําหรับเชนธุรกิจ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditors(emailAddresses)
เพิ่มอาร์เรย์ผู้ใช้ที่ระบุลงในรายการเอดิเตอร์ของ Document
หากผู้ใช้รายใดอยู่ในรายการผู้ชมแล้ว วิธีนี้โปรโมตนอกรายชื่อผู้ชม
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
emailAddresses | String[] | อาร์เรย์ของอีเมลของผู้ใช้ที่จะเพิ่ม |
ไปกลับ
Document
— Document
นี้สําหรับเชนธุรกิจ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 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
ที่มีชื่อและรหัสที่จะใช้เพื่อดึงข้อมูลในภายหลัง ชื่อไม่จําเป็นต้องเหมือนกัน ช่วงต่างๆ ในเอกสารเดียวกันอาจมีชื่อเดียวกัน เช่นเดียวกับชั้นเรียนใน HTML ในทางตรงกันข้าม ID ภายในเอกสารจะไม่ซ้ํากัน เช่น รหัสใน HTML หลังจากเพิ่ม NamedRange
ลงในเอกสารแล้ว คุณจะแก้ไขไม่ได้ แต่จะนําออกได้เท่านั้น
สคริปต์ที่เข้าถึงเอกสารจะเข้าถึง NamedRange
ได้ หากต้องการหลีกเลี่ยงไม่ให้เกิดข้อขัดแย้งโดยไม่เจตนาระหว่างสคริปต์ ให้พิจารณาคํานําหน้าชื่อช่วงด้วยสตริงที่ไม่ซ้ํากัน
// Creates a named 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.addNamedRange('Document tables', rangeBuilder.build());
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
name | String | ชื่อของช่วงซึ่งไม่จําเป็นต้องไม่ซ้ํากัน ชื่อช่วงต้องอยู่ระหว่าง 1-256 อักขระ |
range | Range | ช่วงขององค์ประกอบที่จะเชื่อมโยงกับชื่อ ช่วงอาจเป็นการเลือกที่ใช้งานอยู่ ผลการค้นหา หรือสร้างขึ้นด้วยตนเองด้วย newRange() |
ไปกลับ
NamedRange
— NamedRange
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewer(emailAddress)
เพิ่มผู้ใช้ที่ต้องการลงในรายการผู้ชมของ Document
หากผู้ใช้อยู่ในรายชื่อผู้แก้ไขอยู่แล้ว เมธอดนี้จะไม่มีผล
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
emailAddress | String | อีเมลของผู้ใช้ที่ต้องการเพิ่ม |
ไปกลับ
Document
— Document
นี้สําหรับเชนธุรกิจ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewer(user)
เพิ่มผู้ใช้ที่ต้องการลงในรายการผู้ชมของ Document
หากผู้ใช้อยู่ในรายชื่อผู้แก้ไขอยู่แล้ว เมธอดนี้จะไม่มีผล
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
user | User | การแสดงผู้ใช้เพื่อเพิ่ม |
ไปกลับ
Document
— Document
นี้สําหรับเชนธุรกิจ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewers(emailAddresses)
เพิ่มอาร์เรย์ผู้ใช้ที่ระบุลงในรายการผู้ชมของ Document
หากมีผู้ใช้รายใดอยู่ในรายการเอดิเตอร์แล้ว เมธอดนี้ไม่มีผลต่อผู้ใช้
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
emailAddresses | String[] | อาร์เรย์ของอีเมลของผู้ใช้ที่จะเพิ่ม |
ไปกลับ
Document
— Document
นี้สําหรับเชนธุรกิจ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAs(contentType)
ดึงเนื้อหา Document
ปัจจุบันเป็น BLOB ในประเภทที่ระบุ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
contentType | String | ประเภท MIME ที่จะแปลงเป็น ปัจจุบันรองรับเฉพาะ 'application/pdf' |
ไปกลับ
Blob
— เอกสารปัจจุบันเป็น BLOB
getBlob()
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
ดังกล่าว
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
id | String | รหัสของ Bookmark |
ไปกลับ
Bookmark
— Bookmark
ที่มีรหัสที่ระบุ หรือ 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()
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 ในทางตรงกันข้าม ID ภายในเอกสารจะไม่ซ้ํากัน เช่น รหัสใน HTML
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
id | String | รหัสของช่วง ซึ่งเป็นค่าที่ไม่ซ้ํากันในเอกสาร |
ไปกลับ
NamedRange
— NamedRange
ที่มีรหัสที่ระบุ หรือ 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 ในทางตรงกันข้าม ID ในเอกสารจะไม่ซ้ํากัน เช่น รหัสใน HTML
สคริปต์ที่เข้าถึงเอกสารได้ก็เข้าถึง NamedRange
ได้ หากต้องการหลีกเลี่ยงไม่ให้เกิดข้อขัดแย้งโดยไม่เจตนาระหว่างสคริปต์ ให้พิจารณาคํานําหน้าชื่อช่วงด้วยสตริงที่ไม่ซ้ํากัน
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
name | String | ชื่อของช่วงซึ่งไม่จําเป็นต้องเหมือนกัน |
ไปกลับ
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);
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
element | Element | องค์ประกอบที่จะมี Position ใหม่ ต้องเป็นองค์ประกอบ Text หรือองค์ประกอบคอนเทนเนอร์ เช่น Paragraph |
offset | Integer | สําหรับองค์ประกอบ Text , จํานวนอักขระก่อน Position , สําหรับองค์ประกอบอื่นๆ จํานวนองค์ประกอบย่อยก่อน Position ภายในองค์ประกอบคอนเทนเนอร์เดียวกัน |
ไปกลับ
Position
— Position
ใหม่
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 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
อยู่ในไดรฟ์ที่แชร์ที่ผู้ใช้เข้าถึงได้
สําหรับไฟล์ในไดรฟ์ การดําเนินการนี้จะนําผู้ใช้ออกจากรายการผู้มีสิทธิ์อ่านด้วย
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
emailAddress | String | อีเมลของผู้ใช้ที่ต้องการนําออก |
ไปกลับ
Document
— Document
นี้สําหรับเชนธุรกิจ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeEditor(user)
นําผู้ใช้ที่ระบุออกจากรายการเอดิเตอร์ของ Document
วิธีการนี้จะไม่บล็อกผู้ใช้ไม่ให้เข้าถึง Document
หากผู้ใช้อยู่ในชั้นเรียนที่มีสิทธิ์เข้าถึงทั่วไป เช่น หากมีการแชร์ Document
กับทั้งโดเมนของผู้ใช้ หรือหาก Document
อยู่ในไดรฟ์ที่แชร์ที่ผู้ใช้เข้าถึงได้
สําหรับไฟล์ในไดรฟ์ การดําเนินการนี้จะนําผู้ใช้ออกจากรายการผู้มีสิทธิ์อ่านด้วย
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
user | User | การนําเสนอผู้ใช้ที่จะนําออก |
ไปกลับ
Document
— Document
นี้สําหรับเชนธุรกิจ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeViewer(emailAddress)
นําผู้ใช้ที่ระบุออกจากรายการผู้ดูและผู้แสดงความคิดเห็นสําหรับ Document
วิธีนี้จะไม่มีผลหากผู้ใช้เป็นเอดิเตอร์ ไม่ใช่ผู้มีสิทธิ์อ่านหรือผู้แสดงความคิดเห็น วิธีนี้จะไม่บล็อกผู้ใช้ไม่ให้เข้าถึง Document
หากผู้ใช้เหล่านั้นเป็นสมาชิกชั้นเรียนที่มีสิทธิ์เข้าถึงทั่วไป เช่น หากมีการแชร์ Document
กับโดเมนทั้งหมดของผู้ใช้ หรือหาก Document
อยู่ในไดรฟ์ที่แชร์ที่ผู้ใช้เข้าถึงได้
และสําหรับไฟล์ในไดรฟ์ ก็จะนําผู้ใช้ออกจากรายการเครื่องมือแก้ไขด้วย
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
emailAddress | String | อีเมลของผู้ใช้ที่ต้องการนําออก |
ไปกลับ
Document
— Document
นี้สําหรับเชนธุรกิจ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeViewer(user)
นําผู้ใช้ที่ระบุออกจากรายการผู้ดูและผู้แสดงความคิดเห็นสําหรับ Document
วิธีการนี้จะไม่มีผลหากผู้ใช้เป็นผู้แก้ไข ไม่ใช่ผู้มีสิทธิ์ดู วิธีนี้จะไม่ป้องกันไม่ให้ผู้ใช้เข้าถึง Document
หากผู้ใช้เหล่านั้นอยู่ในชั้นเรียนของผู้ใช้ที่มีสิทธิ์เข้าถึงทั่วไป เช่น หากมีการแชร์ Document
กับทั้งโดเมนของผู้ใช้ หรือหาก Document
อยู่ในไดรฟ์ที่แชร์ที่ผู้ใช้เข้าถึงได้
และสําหรับไฟล์ในไดรฟ์ ก็จะนําผู้ใช้ออกจากรายการเครื่องมือแก้ไขด้วย
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
user | User | การนําเสนอผู้ใช้ที่จะนําออก |
ไปกลับ
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
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);
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
position | Position | ตําแหน่งเคอร์เซอร์ใหม่ |
ไปกลับ
Document
— Document
นี้สําหรับเชนธุรกิจ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLanguage(languageCode)
ตั้งค่ารหัสภาษาของเอกสาร นี่คือภาษาที่แสดงในไฟล์
> ภาษาของเครื่องมือแก้ไขเอกสาร ซึ่งอาจไม่ใช่ภาษาจริงในเอกสาร ใช้ getSupportedLanguageCodes()
เพื่อรับรหัสภาษาที่ถูกต้องทั้งหมด
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
languageCode | String | รหัสภาษา |
ไปกลับ
Document
— Document
นี้สําหรับเชนธุรกิจ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setName(name)
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());
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
range | Range | ช่วงใหม่ขององค์ประกอบเพื่อเลือก |
ไปกลับ
Document
— Document
นี้สําหรับเชนธุรกิจ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents