Class Document

Tài liệu

Một tài liệu chứa một hoặc nhiều đối tượng Tab, mỗi đối tượng chứa văn bản đa dạng thức và các phần tử như bảng và danh sách.

Bạn có thể mở hoặc tạo tài liệu bằng DocumentApp. 

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

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

Các phương thức trên lớp Document trực tiếp truy cập và sửa đổi nội dung văn bản hoạt động trên Tab đang hoạt động (trong tập lệnh liên kết với một tài liệu cụ thể) hoặc Tab đầu tiên (nếu không có Tab đang hoạt động). Bạn có thể di chuyển các tập lệnh dựa vào những phương thức này (ví dụ: getBody()) để hỗ trợ các thẻ bằng cách sử dụng getTabs() rồi đến Tab.asDocumentTab().

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
addBookmark(position)BookmarkThêm một Bookmark vào Position đã cho vào thẻ đầu tiên hoặc, đối với các tập lệnh liên kết với một tài liệu, hãy thêm vào thẻ đang hoạt động.
addEditor(emailAddress)DocumentThêm người dùng đã cho vào danh sách người chỉnh sửa cho Document.
addEditor(user)DocumentThêm người dùng đã cho vào danh sách người chỉnh sửa cho Document.
addEditors(emailAddresses)DocumentThêm mảng người dùng đã cho vào danh sách người chỉnh sửa cho Document.
addFooter()FooterSectionThêm một phần chân trang (nếu chưa có) vào thẻ đầu tiên hoặc thẻ đang hoạt động (đối với tập lệnh liên kết với một tài liệu).
addHeader()HeaderSectionThêm một phần tiêu đề (nếu chưa có) vào thẻ đầu tiên hoặc thẻ đang hoạt động (đối với tập lệnh liên kết với một tài liệu).
addNamedRange(name, range)NamedRangeThêm một NamedRange, là một Range có tên và mã nhận dạng để sử dụng cho việc truy xuất sau này, trong thẻ đầu tiên hoặc, đối với các tập lệnh liên kết với một tài liệu, thẻ đang hoạt động.
addViewer(emailAddress)DocumentThêm người dùng đã cho vào danh sách người xem của Document.
addViewer(user)DocumentThêm người dùng đã cho vào danh sách người xem của Document.
addViewers(emailAddresses)DocumentThêm mảng người dùng đã cho vào danh sách người xem cho Document.
getActiveTab()Tab|nullLấy Tab hiện đang hoạt động của người dùng trong tài liệu.
getAs(contentType)BlobTruy xuất nội dung Document hiện tại dưới dạng một blob thuộc loại được chỉ định.
getBlob()BlobTruy xuất nội dung Document hiện tại dưới dạng một blob.
getBody()BodyTruy xuất Body của thẻ đầu tiên hoặc DocumentBodySection của thẻ đang hoạt động đối với những tập lệnh liên kết với một tài liệu.
getBookmark(id)Bookmark|nullLấy Bookmark có mã nhận dạng đã cho trong thẻ đầu tiên hoặc, đối với tập lệnh liên kết với một tài liệu, thẻ đang hoạt động.
getBookmarks()Bookmark[]Lấy tất cả các đối tượng Bookmark trong thẻ đầu tiên hoặc thẻ đang hoạt động (đối với tập lệnh liên kết với một tài liệu).
getCursor()Position|nullLấy con trỏ của người dùng trong thẻ đang hoạt động.
getEditors()User[]Lấy danh sách người chỉnh sửa cho Document này.
getFooter()FooterSection|nullTruy xuất phần chân trang của thẻ đầu tiên hoặc, đối với tập lệnh liên kết với một tài liệu, phần chân trang của thẻ đang hoạt động.
getFootnotes()Footnote[]Truy xuất tất cả các phần tử Footnote trong nội dung của thẻ đầu tiên hoặc đối với các tập lệnh được liên kết với một tài liệu, nội dung của thẻ đang hoạt động.
getHeader()HeaderSection|nullTruy xuất phần tiêu đề của thẻ đầu tiên hoặc, đối với các tập lệnh liên kết với một tài liệu, phần tiêu đề của thẻ đang hoạt động.
getId()StringTruy xuất giá trị nhận dạng duy nhất của tài liệu.
getLanguage()String|nullLấy mã ngôn ngữ của tài liệu.
getName()StringTruy xuất tiêu đề của tài liệu.
getNamedRangeById(id)NamedRange|nullLấy NamedRange có mã nhận dạng đã cho trong thẻ đầu tiên hoặc, đối với tập lệnh liên kết với một tài liệu, thẻ đang hoạt động.
getNamedRanges()NamedRange[]Lấy tất cả các đối tượng NamedRange trong thẻ đầu tiên hoặc thẻ đang hoạt động (đối với tập lệnh liên kết với một tài liệu).
getNamedRanges(name)NamedRange[]Lấy tất cả các đối tượng NamedRange có tên đã cho trong thẻ đầu tiên hoặc, đối với các tập lệnh được liên kết với một tài liệu, thẻ đang hoạt động.
getSelection()Range|nullLấy lựa chọn của người dùng trong thẻ đang hoạt động.
getSupportedLanguageCodes()String[]Lấy tất cả mã ngôn ngữ được hỗ trợ trong tệp Google Tài liệu.
getTab(tabId)Tab|nullLấy Tab có mã nhận dạng được chỉ định.
getTabs()Tab[]Lấy tất cả các Tab không lồng nhau thuộc tài liệu.
getUrl()StringTruy xuất URL để truy cập vào tài liệu hiện tại.
getViewers()User[]Lấy danh sách người xem và người nhận xét cho Document này.
newPosition(element, offset)PositionTạo một Position mới, đây là một tham chiếu đến một vị trí trong thẻ, tương ứng với một phần tử cụ thể trong thẻ đầu tiên hoặc, đối với các tập lệnh liên kết với một tài liệu, thì đó là thẻ đang hoạt động.
newRange()RangeBuilderTạo một trình tạo dùng để tạo các đối tượng Range từ các phần tử thẻ trong thẻ đầu tiên hoặc đối với các tập lệnh được liên kết với một tài liệu, thẻ đang hoạt động.
removeEditor(emailAddress)DocumentXoá người dùng đã cho khỏi danh sách người chỉnh sửa của Document.
removeEditor(user)DocumentXoá người dùng đã cho khỏi danh sách người chỉnh sửa của Document.
removeViewer(emailAddress)DocumentXoá người dùng đã cho khỏi danh sách người xem và người bình luận của Document.
removeViewer(user)DocumentXoá người dùng đã cho khỏi danh sách người xem và người bình luận của Document.
saveAndClose()voidLưu Document hiện tại.
setActiveTab(tabId)voidĐặt Tab mà người dùng đã chọn trong tài liệu hiện tại thành thẻ có mã nhận dạng được chỉ định.
setCursor(position)DocumentĐặt con trỏ của người dùng, cho trước một Position.
setLanguage(languageCode)DocumentĐặt mã ngôn ngữ của tài liệu.
setName(name)DocumentĐặt tiêu đề tài liệu.
setSelection(range)DocumentĐặt lựa chọn của người dùng trong thẻ đang hoạt động, cho trước một Range.

Tài liệu chi tiết

addBookmark(position)

Thêm một Bookmark vào Position đã cho vào thẻ đầu tiên hoặc, đối với các tập lệnh liên kết với một tài liệu, hãy thêm vào thẻ đang hoạt động. Để thêm dấu trang vào bất kỳ thẻ nào, hãy sử dụng phương thức 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());

Tham số

TênLoạiMô tả
positionPositionVị trí của dấu trang mới.

Cầu thủ trả bóng

Bookmark – Dấu trang mới.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

addEditor(emailAddress)

Thêm người dùng đã cho vào danh sách người chỉnh sửa cho Document. Nếu người dùng đã có trong danh sách người xem, thì phương thức này sẽ loại người dùng đó ra khỏi danh sách người xem.

Tham số

TênLoạiMô tả
emailAddressStringĐịa chỉ email của người dùng cần thêm.

Cầu thủ trả bóng

Document – Document này dùng để xâu chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

addEditor(user)

Thêm người dùng đã cho vào danh sách người chỉnh sửa cho Document. Nếu người dùng đã có trong danh sách người xem, thì phương thức này sẽ loại người dùng đó ra khỏi danh sách người xem.

Tham số

TênLoạiMô tả
userUserThông tin về người dùng cần thêm.

Cầu thủ trả bóng

Document – Document này dùng để xâu chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

addEditors(emailAddresses)

Thêm mảng người dùng đã cho vào danh sách người chỉnh sửa cho Document. Nếu có người dùng nào đó đã có trong danh sách người xem, thì phương thức này sẽ loại họ ra khỏi danh sách người xem.

Tham số

TênLoạiMô tả
emailAddressesString[]Một mảng gồm địa chỉ email của những người dùng cần thêm.

Cầu thủ trả bóng

Document – Document này dùng để xâu chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

addFooter()

Thêm một phần chân trang (nếu chưa có) vào thẻ đầu tiên hoặc thẻ đang hoạt động (đối với tập lệnh liên kết với một tài liệu). Để thêm một phần chân trang vào bất kỳ thẻ nào, hãy sử dụng phương thức 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');

Cầu thủ trả bóng

FooterSection – Chân trang của thẻ.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

addHeader()

Thêm một phần tiêu đề (nếu chưa có) vào thẻ đầu tiên hoặc thẻ đang hoạt động (đối với tập lệnh liên kết với một tài liệu). Để thêm một phần tiêu đề vào bất kỳ thẻ nào, hãy sử dụng phương thức 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');

Cầu thủ trả bóng

HeaderSection – Tiêu đề thẻ.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

addNamedRange(name, range)

Thêm một NamedRange, là một Range có tên và mã nhận dạng để sử dụng cho việc truy xuất sau này, trong thẻ đầu tiên hoặc, đối với các tập lệnh liên kết với một tài liệu, thẻ đang hoạt động. Để thêm NamedRange vào bất kỳ thẻ nào, hãy sử dụng phương thức DocumentTab.addNamedRange(name, range). Tên không nhất thiết phải là duy nhất; một số dải ô khác nhau trong cùng một tài liệu có thể dùng chung một tên, giống như một lớp trong HTML. Ngược lại, mã nhận dạng là duy nhất trong tài liệu, chẳng hạn như mã nhận dạng trong HTML. Sau khi thêm NamedRange vào tài liệu, bạn không thể sửa đổi mà chỉ có thể xoá dấu này.

Mọi tập lệnh truy cập vào tài liệu đều có thể truy cập vào một NamedRange. Để tránh xung đột không mong muốn giữa các tập lệnh, hãy cân nhắc việc thêm tiền tố cho tên dải ô bằng một chuỗi duy nhất. 

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

Tham số

TênLoạiMô tả
nameStringTên của dải ô (không cần phải là duy nhất); tên dải ô phải có từ 1 đến 256 ký tự.
rangeRangePhạm vi của các phần tử cần liên kết với tên; phạm vi có thể là vùng chọn đang hoạt động, kết quả tìm kiếm hoặc được tạo theo cách thủ công bằng newRange().

Cầu thủ trả bóng

NamedRange – NamedRange.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

addViewer(emailAddress)

Thêm người dùng đã cho vào danh sách người xem của Document. Nếu người dùng đã có trong danh sách người chỉnh sửa, thì phương thức này sẽ không có hiệu lực.

Tham số

TênLoạiMô tả
emailAddressStringĐịa chỉ email của người dùng cần thêm.

Cầu thủ trả bóng

Document – Document này dùng để xâu chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

addViewer(user)

Thêm người dùng đã cho vào danh sách người xem của Document. Nếu người dùng đã có trong danh sách người chỉnh sửa, thì phương thức này sẽ không có hiệu lực.

Tham số

TênLoạiMô tả
userUserThông tin về người dùng cần thêm.

Cầu thủ trả bóng

Document – Document này dùng để xâu chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

addViewers(emailAddresses)

Thêm mảng người dùng đã cho vào danh sách người xem cho Document. Nếu bất kỳ người dùng nào đã có trong danh sách người chỉnh sửa, thì phương thức này sẽ không có hiệu lực đối với họ.

Tham số

TênLoạiMô tả
emailAddressesString[]Một mảng gồm địa chỉ email của những người dùng cần thêm.

Cầu thủ trả bóng

Document – Document này dùng để xâu chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

getActiveTab()

Lấy Tab hiện đang hoạt động của người dùng trong tài liệu. Một tập lệnh chỉ có thể truy cập vào thẻ đang hoạt động của người dùng đang chạy tập lệnh và chỉ khi tập lệnh đó được liên kết với tài liệu. 

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

Cầu thủ trả bóng

Tab|null – Tab hiện đang hoạt động của người dùng hoặc null nếu tập lệnh không được liên kết với tài liệu.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

getAs(contentType)

Truy xuất nội dung Document hiện tại dưới dạng một blob thuộc loại được chỉ định. 

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

Tham số

TênLoạiMô tả
contentTypeStringLoại MIME cần chuyển đổi; 'application/pdf' và 'text/markdown' được hỗ trợ.

Cầu thủ trả bóng

Blob – Tài liệu hiện tại dưới dạng một blob.

getBlob()

Truy xuất nội dung Document hiện tại dưới dạng một 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());

Cầu thủ trả bóng

Blob – Tài liệu hiện tại dưới dạng một blob.

getBody()

Truy xuất Body của thẻ đầu tiên hoặc DocumentBodySection của thẻ đang hoạt động đối với những tập lệnh liên kết với một tài liệu. Để lấy DocumentBodySection của bất kỳ thẻ nào, hãy sử dụng phương thức DocumentTab.getBody().

Các thẻ có thể chứa nhiều loại phần (ví dụ: HeaderSection, FooterSection). Phần đang hoạt động của một thẻ là Body.

Các phương thức phần tử trong Document uỷ quyền cho Body đang hoạt động. 

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

Cầu thủ trả bóng

Body – Phần nội dung thẻ.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

getBookmark(id)

Lấy Bookmark có mã nhận dạng đã cho trong thẻ đầu tiên hoặc, đối với tập lệnh liên kết với một tài liệu, thẻ đang hoạt động. Để lấy một dấu trang trong thẻ bất kỳ, hãy sử dụng phương thức DocumentTab.getBookmark(id). Phương thức này trả về null nếu không có Bookmark nào như vậy trong thẻ. 

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

Tham số

TênLoạiMô tả
idStringMã nhận dạng của Bookmark.

Cầu thủ trả bóng

Bookmark|null – Bookmark có mã nhận dạng đã cho hoặc null nếu không có Bookmark nào như vậy trong thẻ.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

getBookmarks()

Lấy tất cả các đối tượng Bookmark trong thẻ đầu tiên hoặc thẻ đang hoạt động (đối với tập lệnh liên kết với một tài liệu). Để lấy tất cả dấu trang trong bất kỳ thẻ nào, hãy sử dụng phương thức 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);

Cầu thủ trả bóng

Bookmark[] – Một mảng gồm các đối tượng Bookmark trong thẻ.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

getCursor()

Lấy con trỏ của người dùng trong thẻ đang hoạt động. Tập lệnh chỉ có thể truy cập vào con trỏ của người dùng đang chạy tập lệnh và chỉ khi tập lệnh được liên kết với tài liệu. 

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

Cầu thủ trả bóng

Position|null – Biểu thị con trỏ của người dùng hoặc null nếu người dùng không đặt con trỏ vào thẻ hoặc nếu tập lệnh không được liên kết với tài liệu.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

getEditors()

Lấy danh sách người chỉnh sửa cho Document này.

Cầu thủ trả bóng

User[] – Một mảng người dùng có quyền chỉnh sửa.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

getFooter()

Truy xuất phần chân trang của thẻ đầu tiên hoặc, đối với tập lệnh liên kết với một tài liệu, phần chân trang của thẻ đang hoạt động. Để lấy phần chân trang của bất kỳ thẻ nào, hãy sử dụng phương thức 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());

Cầu thủ trả bóng

FooterSection|null – Chân trang của thẻ.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

getFootnotes()

Truy xuất tất cả các phần tử Footnote trong nội dung của thẻ đầu tiên hoặc đối với các tập lệnh được liên kết với một tài liệu, nội dung của thẻ đang hoạt động. Để lấy tất cả chú thích ở bất kỳ thẻ nào, hãy sử dụng phương thức DocumentTab.getFootnotes().

Các lệnh gọi đến getFootnotes sẽ gây ra một lần lặp lại trên các phần tử của thẻ. Đối với các thẻ lớn, hãy tránh gọi phương thức này một cách không cần thiết. 

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

Cầu thủ trả bóng

Footnote[] – Chú thích cuối trang của thẻ.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

getHeader()

Truy xuất phần tiêu đề của thẻ đầu tiên hoặc, đối với các tập lệnh liên kết với một tài liệu, phần tiêu đề của thẻ đang hoạt động. Để lấy phần tiêu đề của bất kỳ thẻ nào, hãy sử dụng phương thức 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());

Cầu thủ trả bóng

HeaderSection|null – Tiêu đề của thẻ.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

getId()

Truy xuất giá trị nhận dạng duy nhất của tài liệu. Mã nhận dạng tài liệu được dùng với DocumentApp.openById() để mở một phiên bản tài liệu cụ thể.

Cầu thủ trả bóng

String – Mã nhận dạng của tài liệu.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

getLanguage()

Lấy mã ngôn ngữ của tài liệu. Đây là ngôn ngữ xuất hiện trong phần Tệp > Ngôn ngữ của trình chỉnh sửa tài liệu. Ngôn ngữ này có thể không phải là ngôn ngữ thực tế mà tài liệu chứa.

Cầu thủ trả bóng

String|null – Ngôn ngữ của tài liệu hoặc null nếu không được xác định.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

getName()

Truy xuất tiêu đề của tài liệu.

Cầu thủ trả bóng

String – Tiêu đề tài liệu.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

getNamedRangeById(id)

Lấy NamedRange có mã nhận dạng đã cho trong thẻ đầu tiên hoặc, đối với tập lệnh liên kết với một tài liệu, thẻ đang hoạt động. Để lấy NamedRange có mã nhận dạng đã cho trong bất kỳ thẻ nào, hãy sử dụng phương thức DocumentTab.getNamedRangeById(id). Phương thức này trả về null nếu không có NamedRange nào như vậy trong thẻ. Tên không nhất thiết phải là duy nhất, ngay cả trên các thẻ; một số dải ô khác nhau trong cùng một thẻ có thể dùng chung tên, giống như một lớp trong HTML. Ngược lại, các mã nhận dạng là duy nhất trong thẻ, chẳng hạn như mã nhận dạng trong HTML.

Tham số

TênLoạiMô tả
idStringMã nhận dạng của dải ô, là mã nhận dạng riêng biệt trong thẻ.

Cầu thủ trả bóng

NamedRange|null – NamedRange có mã nhận dạng đã cho hoặc null nếu không có phạm vi nào như vậy trong thẻ.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

getNamedRanges()

Lấy tất cả các đối tượng NamedRange trong thẻ đầu tiên hoặc thẻ đang hoạt động (đối với tập lệnh liên kết với một tài liệu). Để lấy tất cả các đối tượng NamedRange trong thẻ bất kỳ, hãy sử dụng phương thức DocumentTab.getNamedRanges().

Mọi tập lệnh truy cập vào thẻ đều có thể truy cập vào NamedRange. Để tránh xung đột không mong muốn giữa các tập lệnh, hãy cân nhắc thêm tiền tố là một chuỗi duy nhất vào tên dải ô.

Cầu thủ trả bóng

NamedRange[] – Một mảng gồm các đối tượng NamedRange trong thẻ, có thể bao gồm nhiều dải ô có cùng tên.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

getNamedRanges(name)

Lấy tất cả các đối tượng NamedRange có tên đã cho trong thẻ đầu tiên hoặc, đối với các tập lệnh được liên kết với một tài liệu, thẻ đang hoạt động. Để lấy tất cả các đối tượng NamedRange trong thẻ bất kỳ, hãy sử dụng phương thức DocumentTab.getNamedRanges(name). Tên không nhất thiết phải là tên riêng biệt, ngay cả trên các thẻ; một số dải ô khác nhau trong cùng một thẻ có thể dùng chung tên, giống như một lớp trong HTML. Ngược lại, mã nhận dạng là duy nhất trong thẻ, chẳng hạn như mã nhận dạng trong HTML.

Mọi tập lệnh truy cập vào tài liệu đều có thể truy cập vào NamedRange. Để tránh xung đột không mong muốn giữa các tập lệnh, hãy cân nhắc thêm tiền tố là một chuỗi duy nhất vào tên dải ô.

Tham số

TênLoạiMô tả
nameStringTên của dải ô (không nhất thiết phải là duy nhất).

Cầu thủ trả bóng

NamedRange[] – Một mảng gồm các đối tượng NamedRange trong thẻ có tên đã cho.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

getSelection()

Lấy lựa chọn của người dùng trong thẻ đang hoạt động. Tập lệnh chỉ có thể truy cập vào lựa chọn của người dùng đang chạy tập lệnh và chỉ khi tập lệnh được liên kết với tài liệu. 

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

Cầu thủ trả bóng

Range|null – Biểu thị lựa chọn của người dùng hoặc null nếu người dùng không chọn nội dung nào trong thẻ, nếu chỉ chọn phần cuối của một đoạn văn, nếu chỉ chọn phần cuối của một đoạn văn và một dòng mới hoặc nếu tập lệnh không được liên kết với tài liệu.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

getSupportedLanguageCodes()

Lấy tất cả mã ngôn ngữ được hỗ trợ trong tệp Google Tài liệu.

Cầu thủ trả bóng

String[] – Một mảng mã ngôn ngữ.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

getTab(tabId)

Lấy Tab có mã nhận dạng được chỉ định. Phương thức này trả về null nếu không có Tab nào như vậy. Có thể truy cập vào các thẻ ở mọi cấp độ lồng.

Tham số

TênLoạiMô tả
tabIdStringMã nhận dạng của thẻ cần lấy.

Cầu thủ trả bóng

Tab|null – Tab có mã nhận dạng được chỉ định hoặc null nếu không có Tab nào như vậy.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

getTabs()

Lấy tất cả các Tab không lồng nhau thuộc tài liệu.

Các thẻ có thể chứa thẻ con, tức là một thẻ được lồng trong một thẻ khác. Bạn có thể truy cập vào các thẻ con bằng cách sử dụng Tab.getChildTabs().

Cầu thủ trả bóng

Tab[] – Danh sách tất cả các Tab có trong tài liệu.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

getUrl()

Truy xuất URL để truy cập vào tài liệu hiện tại. 

const doc = DocumentApp.getActiveDocument();

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

Cầu thủ trả bóng

String – URL để truy cập vào tài liệu hiện tại.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

getViewers()

Lấy danh sách người xem và người nhận xét cho Document này.

Cầu thủ trả bóng

User[] – Một mảng người dùng có quyền xem hoặc nhận xét.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

newPosition(element, offset)

Tạo một Position mới, đây là một tham chiếu đến một vị trí trong thẻ, tương ứng với một phần tử cụ thể trong thẻ đầu tiên hoặc, đối với các tập lệnh liên kết với một tài liệu, thì đó là thẻ đang hoạt động. Để tạo một Position tương ứng với một vị trí trong thẻ bất kỳ, hãy sử dụng phương thức DocumentTab.newPosition(element, offset). Con trỏ của người dùng được biểu thị dưới dạng Position, trong số những mục đích sử dụng khác. 

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

Tham số

TênLoạiMô tả
elementElementPhần tử phải chứa Position mới; phần tử này phải là phần tử Text hoặc phần tử vùng chứa như Paragraph.
offsetIntegerĐối với các phần tử Text, số lượng ký tự trước Position; đối với các phần tử khác, số lượng phần tử con trước Position trong cùng một phần tử vùng chứa.

Cầu thủ trả bóng

Position – Position mới.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

newRange()

Tạo một trình tạo dùng để tạo các đối tượng Range từ các phần tử thẻ trong thẻ đầu tiên hoặc đối với các tập lệnh được liên kết với một tài liệu, thẻ đang hoạt động. Để tạo một trình tạo dùng để tạo các đối tượng DocumentRange từ các phần tử thẻ trong bất kỳ thẻ nào, hãy dùng phương thức 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());

Cầu thủ trả bóng

RangeBuilder – Trình tạo mới.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

removeEditor(emailAddress)

Xoá người dùng đã cho khỏi danh sách người chỉnh sửa của Document. Phương thức này không chặn người dùng truy cập vào Document nếu họ thuộc một nhóm người dùng có quyền truy cập chung – ví dụ: nếu Document được chia sẻ với toàn bộ miền của người dùng hoặc nếu Document nằm trong một bộ nhớ dùng chung mà người dùng có thể truy cập.

Đối với tệp trên Drive, thao tác này cũng sẽ xoá người dùng khỏi danh sách người xem.

Tham số

TênLoạiMô tả
emailAddressStringĐịa chỉ email của người dùng cần xoá.

Cầu thủ trả bóng

Document – Document này dùng để xâu chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

removeEditor(user)

Xoá người dùng đã cho khỏi danh sách người chỉnh sửa của Document. Phương thức này không chặn người dùng truy cập vào Document nếu họ thuộc một nhóm người dùng có quyền truy cập chung – ví dụ: nếu Document được chia sẻ với toàn bộ miền của người dùng hoặc nếu Document nằm trong một bộ nhớ dùng chung mà người dùng có thể truy cập.

Đối với tệp trên Drive, thao tác này cũng sẽ xoá người dùng khỏi danh sách người xem.

Tham số

TênLoạiMô tả
userUserThông tin về người dùng cần xoá.

Cầu thủ trả bóng

Document – Document này dùng để xâu chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

removeViewer(emailAddress)

Xoá người dùng đã cho khỏi danh sách người xem và người bình luận của Document. Phương thức này không có hiệu lực nếu người dùng là người chỉnh sửa, chứ không phải người xem hoặc người bình luận. Phương thức này cũng không ngăn người dùng truy cập vào Document nếu họ thuộc một nhóm người dùng có quyền truy cập chung – ví dụ: nếu Document được chia sẻ với toàn bộ miền của người dùng hoặc nếu Document nằm trong một bộ nhớ dùng chung mà người dùng có thể truy cập.

Đối với tệp trên Drive, thao tác này cũng sẽ xoá người dùng khỏi danh sách người chỉnh sửa.

Tham số

TênLoạiMô tả
emailAddressStringĐịa chỉ email của người dùng cần xoá.

Cầu thủ trả bóng

Document – Document này dùng để xâu chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

removeViewer(user)

Xoá người dùng đã cho khỏi danh sách người xem và người bình luận của Document. Phương thức này không có hiệu lực nếu người dùng là người chỉnh sửa chứ không phải người xem. Phương thức này cũng không chặn người dùng truy cập vào Document nếu họ thuộc một nhóm người dùng có quyền truy cập chung – ví dụ: nếu Document được chia sẻ với toàn bộ miền của người dùng hoặc nếu Document nằm trong một bộ nhớ dùng chung mà người dùng có thể truy cập.

Đối với tệp trên Drive, thao tác này cũng sẽ xoá người dùng khỏi danh sách người chỉnh sửa.

Tham số

TênLoạiMô tả
userUserThông tin về người dùng cần xoá.

Cầu thủ trả bóng

Document – Document này dùng để xâu chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

saveAndClose()

Lưu Document hiện tại. Khiến các bản cập nhật đang chờ xử lý được xoá và áp dụng.

Phương thức saveAndClose() sẽ tự động được gọi vào cuối quá trình thực thi tập lệnh cho mỗi Document có thể chỉnh sửa đang mở.

Bạn không thể chỉnh sửa Document đã đóng. Sử dụng DocumentApp.openById() để mở lại một tài liệu nhất định để chỉnh sửa.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

setActiveTab(tabId)

Đặt Tab mà người dùng đã chọn trong tài liệu hiện tại thành thẻ có mã nhận dạng được chỉ định. 

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

Tham số

TênLoạiMô tả
tabIdStringMã nhận dạng của thẻ cần đặt làm thẻ đang hoạt động.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

setCursor(position)

Đặt con trỏ của người dùng, cho trước một Position. Tập lệnh chỉ có thể truy cập vào con trỏ của người dùng đang chạy tập lệnh và chỉ khi tập lệnh được liên kết với tài liệu.

Việc cung cấp một Position từ một Tab không hoạt động sẽ chuyển đổi thẻ đang hoạt động của người dùng. 

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

Tham số

TênLoạiMô tả
positionPositionVị trí mới của con trỏ.

Cầu thủ trả bóng

Document – Document này dùng để xâu chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

setLanguage(languageCode)

Đặt mã ngôn ngữ của tài liệu. Đây là ngôn ngữ xuất hiện trong phần Tệp > Ngôn ngữ của trình chỉnh sửa tài liệu. Ngôn ngữ này có thể không phải là ngôn ngữ thực tế mà tài liệu chứa. Sử dụng getSupportedLanguageCodes() để lấy tất cả mã ngôn ngữ hợp lệ.

Tham số

TênLoạiMô tả
languageCodeStringMã ngôn ngữ.

Cầu thủ trả bóng

Document – Document này dùng để xâu chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

setName(name)

Đặt tiêu đề tài liệu.

Tham số

TênLoạiMô tả
nameStringTiêu đề mới của tài liệu.

Cầu thủ trả bóng

Document – Tài liệu hiện tại.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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

setSelection(range)

Đặt lựa chọn của người dùng trong thẻ đang hoạt động, cho trước một Range. Tập lệnh chỉ có thể truy cập vào lựa chọn của người dùng đang chạy tập lệnh và chỉ khi tập lệnh được liên kết với tài liệu. 

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

Tham số

TênLoạiMô tả
rangeRangePhạm vi mới của các phần tử cần chọn.

Cầu thủ trả bóng

Document – Document này dùng để xâu chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:

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