Class Document

Tài liệu

Tài liệu 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.
var doc = DocumentApp.openById("<my-id>");

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

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
addBookmark(position)BookmarkThêm Bookmark vào Position đã cho.
addEditor(emailAddress)DocumentThêm người dùng đã cho vào danh sách người chỉnh sửa của Document.
addEditor(user)DocumentThêm người dùng đã cho vào danh sách người chỉnh sửa của Document.
addEditors(emailAddresses)DocumentThêm mảng người dùng đã cho vào danh sách trình chỉnh sửa của Document.
addFooter()FooterSectionThêm phần chân trang của tài liệu, nếu không có phần nào.
addHeader()HeaderSectionThêm phần tiêu đề tài liệu nếu không có.
addNamedRange(name, range)NamedRangeThêm NamedRange, là một Range có tên và mã nhận dạng để sử dụng cho quá trình truy xuất sau này.
addViewer(emailAddress)DocumentThêm người dùng cụ thể vào danh sách người xem của Document.
addViewer(user)DocumentThêm người dùng cụ thể 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 của Document.
getAs(contentType)BlobTruy xuất nội dung Document hiện tại dưới dạng blob thuộc loại đã chỉ định.
getBlob()BlobTruy xuất nội dung Document hiện tại dưới dạng blob.
getBody()BodyTruy xuất Body của tài liệu đang hoạt động.
getBookmark(id)BookmarkLấy Bookmark bằng mã nhận dạng đã cho.
getBookmarks()Bookmark[]Lấy mọi đối tượng Bookmark trong tài liệu.
getCursor()PositionLấy con trỏ của người dùng trong tài liệu đang hoạt động.
getEditors()User[]Lấy danh sách người chỉnh sửa cho Document này.
getFooter()FooterSectionTruy xuất phần chân trang của tài liệu, nếu có.
getFootnotes()Footnote[]Truy xuất tất cả phần tử Footnote trong nội dung tài liệu.
getHeader()HeaderSectionTruy xuất phần tiêu đề của tài liệu, nếu có.
getId()StringTruy xuất giá trị nhận dạng duy nhất của tài liệu.
getLanguage()StringLấ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)NamedRangeLấy NamedRange bằng mã nhận dạng đã cho.
getNamedRanges()NamedRange[]Lấy mọi đối tượng NamedRange trong tài liệu.
getNamedRanges(name)NamedRange[]Lấy tất cả đối tượng NamedRange trong tài liệu bằng tên đã cho.
getSelection()RangeLấy lựa chọn của người dùng trong tài liệu đang hoạt động.
getSupportedLanguageCodes()String[]Lấy tất cả mã ngôn ngữ được hỗ trợ trong các tệp Google Tài liệu.
getUrl()StringTruy xuất URL để truy cập tài liệu hiện tại.
getViewers()User[]Xem 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. Tham chiếu đến một vị trí trong tài liệu, tương ứng với một phần tử cụ thể.
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ử tài liệu.
removeEditor(emailAddress)DocumentXoá người dùng cụ thể khỏi danh sách người chỉnh sửa của Document.
removeEditor(user)DocumentXoá người dùng cụ thể khỏi danh sách người chỉnh sửa của Document.
removeViewer(emailAddress)DocumentXoá người dùng cụ thể khỏi danh sách người xem và người nhận xét của Document.
removeViewer(user)DocumentXoá người dùng cụ thể khỏi danh sách người xem và người nhận xét của Document.
saveAndClose()voidLưu Document hiện tại.
setCursor(position)DocumentĐặt con trỏ của người dùng trong tài liệu đang hoạt động, với 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 tài liệu đang hoạt động, với Range.

Tài liệu chi tiết

addBookmark(position)

Thêm Bookmark vào Position đã cho. 

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

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

}

Các tham số

TênLoạiNội dung mô 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

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

  • 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 của Document. Nếu người dùng đã có trong danh sách người xem, phương thức này sẽ đẩy người dùng ra khỏi danh sách người xem.

Các tham số

TênLoạiNội dung mô 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, để tạo chuỗi.

Ủy quyền

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

  • 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 của Document. Nếu người dùng đã có trong danh sách người xem, phương thức này sẽ đẩy người dùng ra khỏi danh sách người xem.

Các tham số

TênLoạiNội dung mô tả
userUserĐại diện cho người dùng mà bạn cần thêm.

Cầu thủ trả bóng

Document – Document này, để tạo chuỗi.

Ủy quyền

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

  • 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 trình chỉnh sửa của Document. Nếu bất kỳ người dùng nào đã có trong danh sách người xem, phương thức này sẽ thăng hạng họ ra khỏi danh sách người xem.

Các tham số

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

Cầu thủ trả bóng

Document – Document này, để tạo chuỗi.

Ủy quyền

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

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

addFooter()

Thêm phần chân trang của tài liệu, nếu không có phần nào. 

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

// Adds a footer to the document.
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 tài liệu.

Ủy quyền

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

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

addHeader()

Thêm phần tiêu đề tài liệu nếu không có. 

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

// Adds a header to the document.
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 đề tài liệu.

Ủy quyền

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

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

addNamedRange(name, range)

Thêm NamedRange, là một Range có tên và mã nhận dạng để sử dụng cho quá trình truy xuất sau này. Tên không nhất thiết là duy nhất; nhiều dải ô trong cùng một tài liệu có thể trùng 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, 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á nó.

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 ngoài ý muốn giữa các tập lệnh, hãy cân nhắc việc thêm một chuỗi duy nhất vào trước tên dải ô. 

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

Các tham số

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

Cầu thủ trả bóng

NamedRange – NamedRange.

Ủy quyền

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

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

addViewer(emailAddress)

Thêm người dùng cụ thể 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.

Các tham số

TênLoạiNội dung mô 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, để tạo chuỗi.

Ủy quyền

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

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

addViewer(user)

Thêm người dùng cụ thể 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.

Các tham số

TênLoạiNội dung mô tả
userUserĐại diện cho người dùng mà bạn cần thêm.

Cầu thủ trả bóng

Document – Document này, để tạo chuỗi.

Ủy quyền

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

  • 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 của 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ọ.

Các tham số

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

Cầu thủ trả bóng

Document – Document này, để tạo chuỗi.

Ủy quyền

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

  • 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 blob thuộc loại đã 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('abc123456');

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

Các tham số

TênLoạiNội dung mô tả
contentTypeStringLoại MIME cần chuyển đổi; hiện chỉ hỗ trợ 'application/pdf'.

Cầu thủ trả bóng

Blob – Tài liệu hiện tại ở dạng blob.

getBlob()

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

// 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ạng blob.

getBody()

Truy xuất Body của tài liệu đang hoạt động.

Tài liệu có thể chứa nhiều loại phần (ví dụ: HeaderSection, FooterSection). Phần đang hoạt động của tài liệu 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('abc123456');

// Gets the document 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 tài liệu đang hoạt động.

Ủy quyền

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

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

getBookmark(id)

Lấy Bookmark bằng mã nhận dạng đã cho. Phương thức này trả về null nếu không tồn tại Bookmark nào như vậy. 

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

// Gets the bookmark by its ID.
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.');
}

Các tham số

TênLoạiNội dung mô tả
idStringMã nhận dạng của Bookmark.

Cầu thủ trả bóng

Bookmark – Bookmark với mã nhận dạng đã cho, hoặc null nếu không có Bookmark nào như vậy.

Ủy quyền

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

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

getBookmarks()

Lấy mọi đối tượng Bookmark trong tài liệu. 

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

// Gets all of the bookmarks in the document.
const bookmarks = doc.getBookmarks();

// Logs the number of bookmarks in the document to the console.
console.log(bookmarks.length);

Cầu thủ trả bóng

Bookmark[] – Một mảng các đối tượng Bookmark trong tài liệu.

Ủy quyền

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

  • 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 tài liệu đang hoạt động. Một tập lệnh chỉ có thể truy cập 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.
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.');
}

Cầu thủ trả bóng

Position – 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ỏ trong tài liệu hoặc nếu tập lệnh không được liên kết với tài liệu.

Ủy quyền

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

  • 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

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

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

getFooter()

Truy xuất phần chân trang của tài liệu, nếu có. 

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

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

Cầu thủ trả bóng

FooterSection — Chân trang của tài liệu.

Ủy quyền

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

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

getFootnotes()

Truy xuất tất cả phần tử Footnote trong nội dung tài liệu.

Các lệnh gọi đến getFootnotes khiến các phần tử của tài liệu lặp lại. Đối với các tài liệu có kích thước lớn, hãy tránh các lệnh gọi không cần thiết đến phương thức này. 

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

// Gets the first footnote.
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 tài liệu.

Ủy quyền

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

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

getHeader()

Truy xuất phần tiêu đề của tài liệu, nếu có. 

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

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

Cầu thủ trả bóng

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

Ủy quyền

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

  • 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

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

  • 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ữ được hiển thị trong File > Language (Tệp > Ngôn ngữ) của trình chỉnh sửa tài liệu, có thể không phải là ngôn ngữ thực tế trong tài liệu.

Cầu thủ trả bóng

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

Ủy quyền

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

  • 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

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

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

getNamedRangeById(id)

Lấy NamedRange bằng mã nhận dạng đã cho. Phương thức này trả về null nếu không tồn tại NamedRange nào như vậy. Tên không nhất thiết là duy nhất; nhiều dải ô trong cùng một tài liệu có thể có cùng 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, như mã nhận dạng trong HTML.

Các tham số

TênLoạiNội dung mô tả
idStringmã của dải ô, đây là mã duy nhất trong tài liệu

Cầu thủ trả bóng

NamedRange — NamedRange với mã nhận dạng đã cho, hoặc null nếu không tồn tại dải ô như vậy

Ủy quyền

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

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

getNamedRanges()

Lấy mọi đối tượng NamedRange trong tài liệu.

Bất kỳ tập lệnh nào truy cập vào tài liệu này đều có thể truy cập NamedRange. Để tránh xung đột ngoài ý muốn giữa các tập lệnh, hãy cân nhắc thêm một chuỗi duy nhất vào trước tên dải ô.

Cầu thủ trả bóng

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

Ủy quyền

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

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

getNamedRanges(name)

Lấy tất cả đối tượng NamedRange trong tài liệu bằng tên đã cho. Tên không nhất thiết phải là duy nhất; nhiều dải ô khác nhau trong cùng một tài liệu có thể có cùng 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, giống như mã nhận dạng trong HTML.

Bất kỳ tập lệnh nào truy cập vào tài liệu này đều có thể truy cập NamedRange. Để tránh xung đột ngoài ý muốn giữa các tập lệnh, hãy cân nhắc thêm một chuỗi duy nhất vào trước tên dải ô.

Các tham số

TênLoạiNội dung mô tả
nameStringtên của dải ô, tên này không nhất thiết là duy nhất

Cầu thủ trả bóng

NamedRange[] – một mảng các đối tượng NamedRange trong tài liệu có tên đã cho

Ủy quyền

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

  • 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 tài liệu đang hoạt động. Một 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.
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.');
}

Cầu thủ trả bóng

Range – 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 mục nào trong tài liệu, trong trường hợp chỉ chọn cuối một đoạn, chỉ chọn cuối một đoạn và một dòng mới hoặc nếu tập lệnh không liên kết với tài liệu.

Ủy quyền

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

  • 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 các 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

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

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

getUrl()

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

var 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

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

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

getViewers()

Xem 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

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

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

newPosition(element, offset)

Tạo một Position mới. Tham chiếu đến một vị trí trong tài liệu, tương ứng với một phần tử cụ thể. Con trỏ của người dùng được biểu thị dưới dạng Position, ngoài các trường hợp sử dụng khác. 

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

Các tham số

TênLoạiNội dung mô tả
elementElementphần tử sẽ chứa Position mới; đâ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 là số lượng ký tự trước Position; đối với các phần tử khác là số lượng các 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

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

  • 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ử tài liệu. 

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

Cầu thủ trả bóng

RangeBuilder — trình tạo mới

Ủy quyền

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

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

removeEditor(emailAddress)

Xoá người dùng cụ thể 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 lớp 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 bộ nhớ dùng chung mà người dùng có thể truy cập.

Đối với các 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.

Các tham số

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

Cầu thủ trả bóng

Document – Document này, để tạo chuỗi.

Ủy quyền

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

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

removeEditor(user)

Xoá người dùng cụ thể 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 lớp 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 bộ nhớ dùng chung mà người dùng có thể truy cập.

Đối với các 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.

Các tham số

TênLoạiNội dung mô tả
userUserBiểu thị người dùng cần xoá.

Cầu thủ trả bóng

Document – Document này, để tạo chuỗi.

Ủy quyền

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

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

removeViewer(emailAddress)

Xoá người dùng cụ thể khỏi danh sách người xem và người nhận xét của Document. Phương thức này không có tác dụng nếu người dùng là người chỉnh sửa chứ không phải là người xem hoặc người nhận xét. 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 lớp 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 bộ nhớ dùng chung mà người dùng có thể truy cập.

Đối với các 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.

Các tham số

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

Cầu thủ trả bóng

Document – Document này để tạo chuỗi.

Ủy quyền

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

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

removeViewer(user)

Xoá người dùng cụ thể khỏi danh sách người xem và người nhận xét 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 lớp 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 bộ nhớ dùng chung mà người dùng có thể truy cập.

Đối với các 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.

Các tham số

TênLoạiNội dung mô tả
userUserBiểu thị người dùng cần xoá.

Cầu thủ trả bóng

Document – Document này để tạo chuỗi.

Ủy quyền

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

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

saveAndClose()

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

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

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

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

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

setCursor(position)

Đặt con trỏ của người dùng trong tài liệu đang hoạt động, với Position. Một tập lệnh chỉ có thể truy cập 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. 

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

Các tham số

TênLoạiNội dung mô tả
positionPositionvị trí con trỏ mới

Cầu thủ trả bóng

Document — Document này, để tạo chuỗi

Ủy quyền

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

  • 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ữ được hiển thị trong File > Language (Tệp > Ngôn ngữ) của trình chỉnh sửa tài liệu, có thể không phải là ngôn ngữ thực tế trong tài liệu. Sử dụng getSupportedLanguageCodes() để nhận tất cả mã ngôn ngữ hợp lệ.

Các tham số

TênLoạiNội dung mô tả
languageCodeStringMã ngôn ngữ.

Cầu thủ trả bóng

Document – Document này, để tạo chuỗi.

Ủy quyền

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

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

setName(name)

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

Các tham số

TênLoạiNội dung mô tả
nameStringtiêu đề tài liệu mới

Cầu thủ trả bóng

Document — tài liệu hiện tại

Ủy quyền

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

  • 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 tài liệu đang hoạt động, với Range. Một 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. 

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

Các tham số

TênLoạiNội dung mô tả
rangeRangedải phần tử mới để chọn

Cầu thủ trả bóng

Document — Document này, để tạo chuỗi

Ủy quyền

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

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