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

พารามิเตอร์

รีเทิร์น

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

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

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

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

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

พารามิเตอร์

รีเทิร์น

Document — This Document, for chaining.

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

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

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

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

พารามิเตอร์

รีเทิร์น

Document — This Document, for chaining.

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

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

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

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

พารามิเตอร์

รีเทิร์น

Document — This Document, for chaining.

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

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

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

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

พารามิเตอร์

รีเทิร์น

NamedRange — NamedRange

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

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

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

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

พารามิเตอร์

รีเทิร์น

Document — This Document, for chaining.

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

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

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

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

พารามิเตอร์

รีเทิร์น

Document — This Document, for chaining.

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

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

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

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

พารามิเตอร์

รีเทิร์น

Document — This Document, for chaining.

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

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

พารามิเตอร์

รีเทิร์น

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

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

รับ 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.');
}

พารามิเตอร์

รีเทิร์น

Bookmark|null — 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('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

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

// 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 — การแสดงเคอร์เซอร์ของผู้ใช้ หรือ 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('123abc');

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

รีเทิร์น

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

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

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 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('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[]|null — เชิงอรรถของแท็บ

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

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 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('123abc');

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

รีเทิร์น

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

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

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 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|null — 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.
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 — ตัวแทนของสิ่งที่ผู้ใช้เลือก หรือ 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 เพื่อเข้าถึงเอกสารปัจจุบัน

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

รับรายการผู้มีสิทธิ์อ่านและผู้แสดงความคิดเห็นสำหรับ 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.
const doc = DocumentApp.getActiveDocument();
const paragraph = doc.getBody().appendParagraph('My new paragraph.');
const 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.
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

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

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

พารามิเตอร์

รีเทิร์น

Document — This Document, for chaining.

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

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

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

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

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

พารามิเตอร์

รีเทิร์น

Document — This Document, for chaining.

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

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

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

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

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

พารามิเตอร์

รีเทิร์น

Document — This Document for chaining.

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

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

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

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

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

พารามิเตอร์

รีเทิร์น

Document — This Document for chaining.

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

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 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('123abc');

พารามิเตอร์

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

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

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

ตั้งค่าเคอร์เซอร์ของผู้ใช้เมื่อระบุ 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);

พารามิเตอร์

รีเทิร์น

Document — This Document, for chaining.

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

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

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

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

พารามิเตอร์

รีเทิร์น

Document — This Document, for chaining.

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

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

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

พารามิเตอร์

รีเทิร์น

Document — This Document, for chaining.

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

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

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