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à
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");
Các phương thức trên lớp Document
truy cập trực tiếp và sửa đổi nội dung văn bản hoạt động
thẻ hoạt động (trong tập lệnh ràng buộc với
tài liệu cụ thể) hoặc thẻ đầu tiên (nếu không có thẻ nào đang hoạt động). Những tập lệnh dựa vào
bạn có thể di chuyển các phương thức này (ví dụ: getBody()
) sang các thẻ hỗ trợ bằng cách sử dụng
getTabs()
, sau đó là Tab.asDocumentTab()
.
Phương thức
Phương thức | Loại dữ liệu trả về | Mô tả ngắn |
---|---|---|
addBookmark(position) | Bookmark | Thêm Bookmark tại Position nhất định vào thẻ đầu tiên hoặc cho các tập lệnh
liên kết với một tài liệu, thẻ đang hoạt động. |
addEditor(emailAddress) | Document | Thêm người dùng cụ thể vào danh sách người chỉnh sửa cho Document . |
addEditor(user) | Document | Thêm người dùng cụ thể vào danh sách người chỉnh sửa cho Document . |
addEditors(emailAddresses) | Document | Thêm mảng người dùng nhất định vào danh sách người chỉnh sửa cho Document . |
addFooter() | FooterSection | Thêm phần chân trang (nếu không có) vào thẻ đầu tiên hoặc thêm thẻ đang hoạt động đối với tập lệnh được liên kết với tài liệu. |
addHeader() | HeaderSection | Thêm phần tiêu đề (nếu không có) vào thẻ đầu tiên hoặc thêm thẻ đang hoạt động đối với những tập lệnh được liên kết với tài liệu. |
addNamedRange(name, range) | NamedRange | Thêm NamedRange , là Range có tên và mã nhận dạng để dùng cho
truy xuất sau, trong thẻ đầu tiên hoặc thẻ đang hoạt động đối với các tập lệnh được liên kết với tài liệu. |
addViewer(emailAddress) | Document | Thêm người dùng cụ thể vào danh sách người xem cho Document . |
addViewer(user) | Document | Thêm người dùng cụ thể vào danh sách người xem cho Document . |
addViewers(emailAddresses) | Document | Thêm mảng người dùng nhất định vào danh sách người xem cho Document . |
getActiveTab() | Tab | Lấy Tab mà người dùng đang hoạt động trong tài liệu. |
getAs(contentType) | Blob | 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. |
getBlob() | Blob | Truy xuất nội dung Document hiện tại dưới dạng một blob. |
getBody() | Body | Truy xuất Body của thẻ đầu tiên hoặc truy xuất DocumentBodySection của thẻ đang hoạt động đối với các tập lệnh liên kết với tài liệu. |
getBookmark(id) | Bookmark | Lấy Bookmark có mã nhận dạng đã cho trong thẻ đầu tiên hoặc lấy thẻ đang hoạt động (đối với tập lệnh liên kết với tài liệu). |
getBookmarks() | Bookmark[] | Lấy mọi đối tượng Bookmark trong thẻ đầu tiên hoặc lấy 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. |
getCursor() | Position | Đưa con trỏ của người dùng vào thẻ đang hoạt động. |
getEditors() | User[] | Lấy danh sách người chỉnh sửa cho Document này. |
getFooter() | FooterSection | Truy xuất phần chân trang của thẻ đầu tiên hoặc truy xuất chân trang của thẻ đang hoạt động đối với các tập lệnh bị ràng buộc vào tài liệu . |
getFootnotes() | Footnote[] | Truy xuất tất cả phần tử Footnote trong phần nội dung của thẻ đầu tiên hoặc phần nội dung của thẻ đang hoạt động đối với các tập lệnh được liên kết với một tài liệu. |
getHeader() | HeaderSection | Truy xuất phần tiêu đề của thẻ đầu tiên hoặc, đối với các tập lệnh bị ràng buộc với một tài liệu, tiêu đề của thẻ đang hoạt động . |
getId() | String | Truy xuất giá trị nhận dạng duy nhất của tài liệu. |
getLanguage() | String | Lấy mã ngôn ngữ của tài liệu. |
getName() | String | Truy xuất tiêu đề của tài liệu. |
getNamedRangeById(id) | NamedRange | Lấy NamedRange có mã nhận dạng đã cho trong thẻ đầu tiên hoặc lấy thẻ đang hoạt động (đối với tập lệnh liên kết với tài liệu). |
getNamedRanges() | NamedRange[] | Lấy mọi đối tượng NamedRange trong thẻ đầu tiên hoặc lấy 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. |
getNamedRanges(name) | NamedRange[] | Lấy mọi đối tượng NamedRange có tên trong thẻ đầu tiên, hoặc đối với tập lệnh
được liên kết với một tài liệu là thẻ đang hoạt động. |
getSelection() | Range | Lấ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 | Lấy Tab có mã nhận dạng đã chỉ định. |
getTabs() | Tab[] | Lấy mọi Tab chưa lồng ghép trong tài liệu. |
getUrl() | String | Truy xuất URL để truy cập 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) | Position | Tạo một Position mới tham chiếu đến một vị trí trong thẻ, so với một
phần tử cụ thể trong thẻ đầu tiên hoặc 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. |
newRange() | RangeBuilder | Tạo một trình tạo dùng để tạo đối tượng Range qua các phần tử thẻ trong
tab đầu tiên hoặc đối với các tập lệnh bị ràng buộc với một
tài liệu, thẻ đang hoạt động. |
removeEditor(emailAddress) | Document | Xoá người dùng cụ thể khỏi danh sách người chỉnh sửa của Document . |
removeEditor(user) | Document | Xoá người dùng cụ thể khỏi danh sách người chỉnh sửa của Document . |
removeViewer(emailAddress) | Document | Xoá người dùng cụ thể khỏi danh sách người xem và người nhận xét đối với Document . |
removeViewer(user) | Document | Xoá người dùng cụ thể khỏi danh sách người xem và người nhận xét đối với Document . |
saveAndClose() | void | Lư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, với Position . |
setLanguage(languageCode) | Document | Đặt mã ngôn ngữ của tài liệu. |
setName(name) | Document | Đặt tiêu đề cho tài liệu. |
setSelection(range) | Document | Đặt lựa chọn của người dùng trong thẻ đang hoạt động, với Range . |
Tài liệu chi tiết
addBookmark(position)
Thêm Bookmark
tại Position
nhất định vào thẻ đầu tiên hoặc cho 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 một
dấu trang vào thẻ bất kỳ, 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(DOCUMENT_ID); // 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ên | Loại | Mô tả |
---|---|---|
position | Position | Vị 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 yêu cầu ủy 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 cụ thể vào danh sách người chỉnh sửa cho Document
. Nếu người dùng đã
trên danh sách người xem, thì phương pháp này sẽ đưa người dùng ra khỏi danh sách người xem.
Tham số
Tên | Loại | Mô tả |
---|---|---|
emailAddress | String | Đị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 yêu cầu ủy 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 cụ thể vào danh sách người chỉnh sửa cho Document
. Nếu người dùng đã
trên danh sách người xem, thì phương pháp này sẽ đưa người dùng ra khỏi danh sách người xem.
Tham số
Tên | Loại | Mô tả |
---|---|---|
user | User | Đại diện cho 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 yêu cầu ủy 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 nhất định vào danh sách người chỉnh sửa cho Document
. Nếu bất kỳ
người dùng đã có trong danh sách người xem, thì phương pháp này sẽ đẩy họ ra khỏi danh sách
người xem.
Tham số
Tên | Loại | Mô tả |
---|---|---|
emailAddresses | String[] | Một mảng đị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, để tạo chuỗi.
Ủy quyền
Tập lệnh sử dụng phương thức này yêu cầu ủy 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 đề (nếu không có) vào thẻ đầu tiên hoặc thêm thẻ đang hoạt động đối với những tập lệnh được liên kết với tài liệu. Cách thêm tiêu đề
vào thẻ bất kỳ, 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(DOCUMENT_ID); // 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
Tập lệnh sử dụng phương thức này yêu cầu ủy 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à Range
có tên và mã nhận dạng để dùng cho
truy xuất sau, trong thẻ đầu tiên hoặc thẻ đang hoạt động đối với các tập lệnh được liên kết với tài liệu. Để thêm NamedRange
vào thẻ bất kỳ, hãy sử dụng phương thức DocumentTab.addNamedRange(name, range)
. Tên thì 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, nhiều
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á 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 trường hợp ngoài ý muốn
xung đột giữa các tập lệnh, hãy xem xét việc thêm tiền tố vào 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. 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]); } // Adds the named range to the document's active tab. doc.addNamedRange('Document tables', rangeBuilder.build());
Tham số
Tên | Loại | Mô tả |
---|---|---|
name | String | Tên cho dải ô không cần phải là duy nhất; tên dải ô phải là từ 1 đến 256 ký tự. |
range | Range | Phạm vi các phần tử 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 yêu cầu ủy 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 cho Document
. Nếu người dùng đã
trên danh sách người chỉnh sửa, thì phương thức này không có hiệu lực.
Tham số
Tên | Loại | Mô tả |
---|---|---|
emailAddress | String | Đị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 yêu cầu ủy 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 cho Document
. Nếu người dùng đã
trên danh sách người chỉnh sửa, thì phương thức này không có hiệu lực.
Tham số
Tên | Loại | Mô tả |
---|---|---|
user | User | Đại diện cho 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 yêu cầu ủy 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 nhất định vào danh sách người xem cho Document
. Nếu bất kỳ
người dùng đã có trong danh sách người chỉnh sửa, nên phương pháp này không có ảnh hưởng gì đối với họ.
Tham số
Tên | Loại | Mô tả |
---|---|---|
emailAddresses | String[] | Một mảng đị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, để tạo chuỗi.
Ủy quyền
Tập lệnh sử dụng phương thức này yêu cầu ủy 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
getActiveTab()
Lấy Tab
mà người dùng đang hoạt động trong tài liệu. Một tập lệnh chỉ có thể truy cập vào
thẻ hoạt động của người dùng đang chạy tập lệnh và chỉ khi tập lệnh bị ràng buộc 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
– Tab
đang hoạt động của người dùng hoặc null
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 yêu cầu ủy 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 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(DOCUMENT_ID); // 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ên | Loại | Mô tả |
---|---|---|
contentType | String | Loạ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ạ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(DOCUMENT_ID); // 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 một blob.
getBody()
Truy xuất Body
của thẻ đầu tiên hoặc truy xuất DocumentBodySection
của thẻ đang hoạt động đối với các tập lệnh liên kết với tài liệu. Để lấy DocumentBodySection
của một thẻ bất kỳ, hãy sử dụng phương thức DocumentTab.getBody()
.
Thẻ có thể chứa nhiều loại mục (ví dụ: HeaderSection
, FooterSection
). Phần hoạt động của 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(DOCUMENT_ID); // 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
Tập lệnh sử dụng phương thức này yêu cầu ủy 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
có mã nhận dạng đã cho trong thẻ đầu tiên hoặc lấy thẻ đang hoạt động (đối với tập lệnh liên kết với tài liệu). Để có 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
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(DOCUMENT_ID); // 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ên | Loại | Mô tả |
---|---|---|
id | String | Mã 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
như vậy
tồn tại trong thẻ.
Ủy quyền
Tập lệnh sử dụng phương thức này yêu cầu ủy 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 thẻ đầu tiên hoặc lấy 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. Để xem tất cả
dấu trang trong thẻ bất kỳ, 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(DOCUMENT_ID); // 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
Tập lệnh sử dụng phương thức này yêu cầu ủy 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()
Đưa con trỏ của người dùng vào thẻ đ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 bị ràng buộc 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 có
con trỏ đặt trong 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
Tập lệnh sử dụng phương thức này yêu cầu ủy 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 yêu cầu ủy 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 phần nội dung của thẻ đầu tiên hoặc phần nội dung của thẻ đang hoạt động đối với các tập lệnh được liên kết với một tài liệu. Để tải
tất cả chú thích cuối trang trong thẻ bất kỳ, hãy sử dụng phương thức DocumentTab.getFootnotes()
.
Các lệnh gọi đến getFootnotes
sẽ khiến các phần tử của thẻ lặp lại. Đối với các thẻ lớn,
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(DOCUMENT_ID); // 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
Tập lệnh sử dụng phương thức này yêu cầu ủy 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 thẻ đầu tiên hoặc, đối với các tập lệnh bị ràng buộc với một tài liệu, tiêu đề của thẻ đang hoạt động
. Để lấy phần tiêu đề của thẻ bất kỳ, 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(DOCUMENT_ID); // 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
— Tiêu đề của thẻ.
Ủy quyền
Tập lệnh sử dụng phương thức này yêu cầu ủy 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 cụ thể của tài liệu.
Cầu thủ trả bóng
String
— Mã của tài liệu.
Ủy quyền
Tập lệnh sử dụng phương thức này yêu cầu ủy 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 mục Tệp của trình chỉnh sửa tài liệu > Ngôn ngữ, có thể không phải là ngôn ngữ thực tế có trong tài liệu.
Cầu thủ trả bóng
String
— Ngôn ngữ của 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 yêu cầu ủy 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 yêu cầu ủy 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
có mã nhận dạng đã cho trong thẻ đầu tiên hoặc lấy thẻ đang hoạt động (đối với tập lệnh liên kết với tài liệu). Để tải
NamedRange
với mã nhận dạng đã cung cấp trong thẻ bất kỳ, hãy sử dụng DocumentTab.getNamedRangeById(id)
. Phương thức này trả về null
nếu không có NamedRange
như vậy trong thẻ. Tên
không nhất thiết phải là duy nhất, thậm chí trên các thẻ; một số phạm vi khác nhau trong cùng một thẻ có thể
có cùng tên, giống như lớp trong HTML. Ngược lại, ID là duy nhất trong thẻ,
chẳng hạn như mã nhận dạng trong HTML.
Tham số
Tên | Loại | Mô tả |
---|---|---|
id | String | Mã nhận dạng của dải ô là giá trị duy nhất trong thẻ. |
Cầu thủ trả bóng
NamedRange
– NamedRange
với mã nhận dạng đã cho hoặc null
nếu không có dải ô như vậy tồn tại trong
thẻ.
Ủy quyền
Tập lệnh sử dụng phương thức này yêu cầu ủy 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 thẻ đầu tiên hoặc lấy 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. Để xem tất cả
Đối tượng NamedRange
trong thẻ bất kỳ, sử dụng phương thức DocumentTab.getNamedRanges()
.
Bất kỳ tập lệnh nào truy cập vào thẻ đó đều có thể truy cập NamedRange
. Cần 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ố vào tên dải ô bằng một chuỗi 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ó thể bao gồm nhiều đối tượng
dải ô có cùng tên.
Ủy quyền
Tập lệnh sử dụng phương thức này yêu cầu ủy 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 mọi đối tượng NamedRange
có tên trong thẻ đầu tiên, hoặc đối với tập lệnh
được liên kết với một tài liệu là thẻ đang hoạt động. Để tải
tất 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à duy nhất, ngay cả trên các thẻ; một số phạm vi khác nhau trong
cùng một thẻ 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 thẻ, 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 đều có thể truy cập NamedRange
. Cần 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ố vào tên dải ô bằng một chuỗi duy nhất.
Tham số
Tên | Loại | Mô tả |
---|---|---|
name | String | Tê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 được đặt.
Ủy quyền
Tập lệnh sử dụng phương thức này yêu cầu ủy 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 thẻ đ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 bị ràng buộc 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 có
bất kỳ mục nào được chọn trong thẻ, nếu chỉ phần cuối của đoạn được chọn, nếu chỉ phần cuối
của một đoạn và một dòng mới được chọn hoặc nếu tập lệnh không bị ràng buộc với tài liệu.
Ủy quyền
Tập lệnh sử dụng phương thức này yêu cầu ủy 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 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 yêu cầu ủy 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
getTab(tabId)
Lấy Tab
có mã nhận dạng đã chỉ định. Phương thức này trả về null
nếu không tồn tại Tab
như vậy. Có thể truy cập vào các thẻ ở mọi mức lồng.
Tham số
Tên | Loại | Mô tả |
---|---|---|
tabId | String | Mã nhận dạng của thẻ cần tải. |
Cầu thủ trả bóng
Tab
– Tab
với mã nhận dạng được chỉ định hoặc null
nếu không tồn tại Tab
như vậy.
Ủy quyền
Tập lệnh sử dụng phương thức này yêu cầu ủy 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
getTabs()
Lấy mọi Tab
chưa lồng ghép trong tài liệu.
Thẻ có thể chứa các thẻ con, một thẻ được lồng trong một thẻ khác. Có thể truy cập vào các thẻ con
đang sử dụng Tab.getChildTabs()
.
Cầu thủ trả bóng
Tab[]
– Danh sách tất cả Tab
thuộc tài liệu.
Ủy quyền
Tập lệnh sử dụng phương thức này yêu cầu ủy 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 yêu cầu ủy 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()
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 loạt 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 yêu cầu ủy 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 thẻ, so với một
phần tử cụ thể trong thẻ đầu tiên hoặc 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. Để tạo một
Position
tương ứng với một vị trí trong thẻ bất kỳ, hãy sử dụng DocumentTab.newPosition(element, offset)
. Con trỏ của người dùng được biểu thị dưới dạng Position
, cùng với các 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. var doc = DocumentApp.getActiveDocument(); var paragraph = doc.getBody().appendParagraph('My new paragraph.'); var position = doc.newPosition(paragraph.getChild(0), 2); doc.setCursor(position);
Tham số
Tên | Loại | Mô tả |
---|---|---|
element | Element | Phần tử cần chứa Position mới; đây phải là
Phần tử Text hoặc phần tử vùng chứa như Paragraph . |
offset | Integer | Đối với các phần tử Text , số 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
Tập lệnh sử dụng phương thức này yêu cầu ủy 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 đối tượng Range
qua các phần tử thẻ trong
tab đầu tiên hoặc đối với các tập lệnh bị ràng buộc với một
tài liệu, thẻ đang hoạt động. Cách tạo trình tạo dùng để tạo đối tượng DocumentRange
từ các phần tử thẻ trong thẻ bất kỳ, hãy sử dụng phương thức DocumentTab.newRange()
.
// Change the user's selection to a range that includes every table in the active tab. 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 yêu cầu ủy 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
sẽ 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 đã
quyền truy cập chung. Ví dụ: nếu Document
được chia sẻ với toàn bộ
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.
Tham số
Tên | Loại | Mô tả |
---|---|---|
emailAddress | String | Đị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 yêu cầu ủy 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
sẽ 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 đã
quyền truy cập chung. Ví dụ: nếu Document
được chia sẻ với toàn bộ
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.
Tham số
Tên | Loại | Mô tả |
---|---|---|
user | User | Hình ảnh đại diện cho 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 yêu cầu ủy 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 đối với Document
. Chiến dịch này
sẽ không có hiệu lực nếu người dùng là người chỉnh sửa, không phải là người xem hoặc người nhận xét. Phương pháp 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 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.
Tham số
Tên | Loại | Mô tả |
---|---|---|
emailAddress | String | Đị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 yêu cầu ủy 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 đối với Document
. Chiến dịch này
sẽ 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 Document
nếu họ thuộc một nhóm người dùng có quyền truy cập chung
quyền truy cập – 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.
Tham số
Tên | Loại | Mô tả |
---|---|---|
user | User | Hình ảnh đại diện cho 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 yêu cầu ủy 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. Làm cho các bản cập nhật đang chờ xử lý được đẩy và áp dụng.
Phương thức saveAndClose()
tự động được 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ở.
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
Tập lệnh sử dụng phương thức này yêu cầu ủy 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
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(TAB_ID);
Tham số
Tên | Loại | Mô tả |
---|---|---|
tabId | String | Mã nhận dạng của thẻ cần đặt thành đang hoạt động. |
Ủy quyền
Tập lệnh sử dụng phương thức này yêu cầu ủy 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, 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 bị ràng buộc với tài liệu.
Việc cung cấp 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.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); // Append a paragraph, then place the user's cursor after the first word of the new paragraph. var paragraph = documentTab.getBody().appendParagraph('My new paragraph.'); var position = documentTab.newPosition(paragraph.getChild(0), 2); doc.setCursor(position);
Tham số
Tên | Loại | Mô tả |
---|---|---|
position | Position | Vị 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 yêu cầu ủy 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 mục Tệp của trình chỉnh sửa tài liệu
> Ngôn ngữ, có thể không phải là ngôn ngữ thực tế có trong tài liệu. Sử dụng getSupportedLanguageCodes()
để nhận tất cả mã ngôn ngữ hợp lệ.
Tham số
Tên | Loại | Mô tả |
---|---|---|
languageCode | String | Mã 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 yêu cầu ủy 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 đề cho tài liệu.
Tham số
Tên | Loại | Mô tả |
---|---|---|
name | String | Tiê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 yêu cầu ủy 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 thẻ đ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 người dùng đang chạy tập lệnh và chỉ khi tập lệnh bị ràng buộc với tài liệu.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); // Change the user's selection to a range that includes every table in the document. var rangeBuilder = documentTab.newRange(); var tables = documentTab.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
Tham số
Tên | Loại | Mô tả |
---|---|---|
range | Range | Dải ô mới cho các phần tử để 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 yêu cầu ủy 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