Halaman ini diterjemahkan oleh Cloud Translation API.

Class Document

Dokumen, yang berisi satu atau beberapa objek Tab, yang masing-masing berisi teks dan elemen kaya seperti tabel dan daftar.

Dokumen dapat dibuka atau dibuat menggunakan DocumentApp.

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

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

Metode pada class Document yang secara langsung mengakses dan mengubah konten teks beroperasi di tab aktif (dalam skrip yang terikat ke dokumen tertentu) atau tab pertama (jika tab aktif tidak tersedia). Skrip yang mengandalkan metode ini (misalnya, getBody()) dapat dimigrasikan untuk mendukung tab menggunakan getTabs(), lalu Tab.asDocumentTab().

Metode

Metode	Jenis hasil yang ditampilkan	Deskripsi singkat
`addBookmark(position)`	`Bookmark`	Menambahkan `Bookmark` di `Position` yang diberikan ke tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif.
`addEditor(emailAddress)`	`Document`	Menambahkan pengguna tertentu ke daftar editor untuk `Document`.
`addEditor(user)`	`Document`	Menambahkan pengguna tertentu ke daftar editor untuk `Document`.
`addEditors(emailAddresses)`	`Document`	Menambahkan array pengguna yang diberikan ke daftar editor untuk `Document`.
`addFooter()`	`FooterSection`	Menambahkan bagian footer, jika tidak ada, ke tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif.
`addHeader()`	`HeaderSection`	Menambahkan bagian header, jika tidak ada, ke tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif.
`addNamedRange(name, range)`	`NamedRange`	Menambahkan `NamedRange`, yang merupakan `Range` yang memiliki nama dan ID untuk digunakan untuk pengambilan nanti, di tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif.
`addViewer(emailAddress)`	`Document`	Menambahkan pengguna yang diberikan ke daftar penonton untuk `Document`.
`addViewer(user)`	`Document`	Menambahkan pengguna yang diberikan ke daftar penonton untuk `Document`.
`addViewers(emailAddresses)`	`Document`	Menambahkan array pengguna yang diberikan ke daftar penonton untuk `Document`.
`getActiveTab()`	`Tab`	Mendapatkan `Tab` pengguna yang saat ini aktif dalam dokumen.
`getAs(contentType)`	`Blob`	Mengambil konten `Document` saat ini sebagai blob dari jenis yang ditentukan.
`getBlob()`	`Blob`	Mengambil konten `Document` saat ini sebagai blob.
`getBody()`	`Body`	Mengambil `Body` tab pertama atau, untuk skrip yang terikat ke dokumen, `DocumentBodySection` tab aktif.
`getBookmark(id)`	`Bookmark`	Mendapatkan `Bookmark` dengan ID yang diberikan di tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif.
`getBookmarks()`	`Bookmark[]`	Mendapatkan semua objek `Bookmark` di tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif.
`getCursor()`	`Position`	Mendapatkan kursor pengguna di tab aktif.
`getEditors()`	`User[]`	Mendapatkan daftar editor untuk `Document` ini.
`getFooter()`	`FooterSection`	Mengambil bagian footer tab pertama atau, untuk skrip yang terikat ke dokumen, bagian footer tab aktif.
`getFootnotes()`	`Footnote[]`	Mengambil semua elemen `Footnote` di isi tab pertama atau, untuk skrip yang terikat ke dokumen, isi tab aktif.
`getHeader()`	`HeaderSection`	Mengambil bagian header tab pertama atau, untuk skrip yang terikat ke dokumen, bagian header tab aktif.
`getId()`	`String`	Mengambil ID unik dokumen.
`getLanguage()`	`String`	Mendapatkan kode bahasa dokumen.
`getName()`	`String`	Mengambil judul dokumen.
`getNamedRangeById(id)`	`NamedRange`	Mendapatkan `NamedRange` dengan ID yang diberikan di tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif.
`getNamedRanges()`	`NamedRange[]`	Mendapatkan semua objek `NamedRange` di tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif.
`getNamedRanges(name)`	`NamedRange[]`	Mendapatkan semua objek `NamedRange` dengan nama yang diberikan di tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif.
`getSelection()`	`Range`	Mendapatkan pilihan pengguna di tab aktif.
`getSupportedLanguageCodes()`	`String[]`	Mendapatkan semua kode bahasa yang didukung dalam file Dokumen Google.
`getTab(tabId)`	`Tab`	Mendapatkan `Tab` dengan ID yang ditentukan.
`getTabs()`	`Tab[]`	Mendapatkan semua `Tab` yang tidak disusun bertingkat yang merupakan bagian dari dokumen.
`getUrl()`	`String`	Mengambil URL untuk mengakses dokumen saat ini.
`getViewers()`	`User[]`	Mendapatkan daftar pelihat dan pengomentar untuk `Document` ini.
`newPosition(element, offset)`	`Position`	Membuat `Position` baru, yang merupakan referensi ke lokasi di tab, relatif terhadap elemen tertentu di tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif.
`newRange()`	`RangeBuilder`	Membuat builder yang digunakan untuk membuat objek `Range` dari elemen tab di tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif.
`removeEditor(emailAddress)`	`Document`	Menghapus pengguna tertentu dari daftar editor untuk `Document`.
`removeEditor(user)`	`Document`	Menghapus pengguna tertentu dari daftar editor untuk `Document`.
`removeViewer(emailAddress)`	`Document`	Menghapus pengguna tertentu dari daftar penonton dan pemberi komentar untuk `Document`.
`removeViewer(user)`	`Document`	Menghapus pengguna tertentu dari daftar penonton dan pemberi komentar untuk `Document`.
`saveAndClose()`	`void`	Menyimpan `Document` saat ini.
`setActiveTab(tabId)`	`void`	Menetapkan `Tab` yang dipilih pengguna dalam dokumen saat ini ke tab dengan ID yang ditentukan.
`setCursor(position)`	`Document`	Menetapkan kursor pengguna, dengan `Position`.
`setLanguage(languageCode)`	`Document`	Menetapkan kode bahasa dokumen.
`setName(name)`	`Document`	Menetapkan judul dokumen.
`setSelection(range)`	`Document`	Menetapkan pilihan pengguna di tab aktif, dengan `Range`.

Dokumentasi mendetail

`addBookmark(position)`

Menambahkan Bookmark di Position yang diberikan ke tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif. Untuk menambahkan bookmark ke tab mana pun, gunakan metode 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());

Parameter

Nama	Jenis	Deskripsi
`position`	`Position`	Posisi bookmark baru.

Pulang pergi

Bookmark — Bookmark baru.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`addEditor(emailAddress)`

Menambahkan pengguna tertentu ke daftar editor untuk Document. Jika pengguna sudah ada dalam daftar penonton, metode ini akan mempromosikan pengguna dari daftar penonton.

Parameter

Nama	Jenis	Deskripsi
`emailAddress`	`String`	Alamat email pengguna yang akan ditambahkan.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`addEditor(user)`

Menambahkan pengguna tertentu ke daftar editor untuk Document. Jika pengguna sudah ada dalam daftar penonton, metode ini akan mempromosikan pengguna dari daftar penonton.

Parameter

Nama	Jenis	Deskripsi
`user`	`User`	Representasi pengguna yang akan ditambahkan.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`addEditors(emailAddresses)`

Menambahkan array pengguna yang diberikan ke daftar editor untuk Document. Jika ada pengguna yang sudah ada dalam daftar penonton, metode ini akan mempromosikannya keluar dari daftar penonton.

Parameter

Nama	Jenis	Deskripsi
`emailAddresses`	`String[]`	Array alamat email pengguna yang akan ditambahkan.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`addFooter()`

Menambahkan bagian footer, jika tidak ada, ke tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif. Untuk menambahkan bagian footer ke tab mana pun, gunakan metode 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');

Pulang pergi

FooterSection — Footer tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`addHeader()`

Menambahkan bagian header, jika tidak ada, ke tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif. Untuk menambahkan bagian header ke tab mana pun, gunakan metode 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');

Pulang pergi

HeaderSection — Header tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`addNamedRange(name, range)`

Menambahkan NamedRange, yang merupakan Range yang memiliki nama dan ID untuk digunakan untuk pengambilan nanti, di tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif. Untuk menambahkan NamedRange di tab mana pun, gunakan metode DocumentTab.addNamedRange(name, range). Nama tidak harus unik; beberapa rentang yang berbeda dalam dokumen yang sama dapat memiliki nama yang sama, seperti class di HTML. Sebaliknya, ID bersifat unik dalam dokumen, seperti ID di HTML. Setelah menambahkan NamedRange ke dokumen, Anda tidak dapat mengubahnya, Anda hanya dapat menghapusnya.

Setiap skrip yang mengakses dokumen dapat mengakses NamedRange. Untuk menghindari konflik yang tidak disengaja antara skrip, pertimbangkan untuk menambahkan awalan nama rentang dengan string unik.

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

Parameter

Nama	Jenis	Deskripsi
`name`	`String`	Nama untuk rentang, yang tidak perlu unik; nama rentang harus antara 1-256 karakter.
`range`	`Range`	Rentang elemen yang akan dikaitkan dengan nama; rentang dapat berupa pilihan aktif, hasil penelusuran, atau dibuat secara manual dengan `newRange()`.

Pulang pergi

NamedRange — NamedRange.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`addViewer(emailAddress)`

Menambahkan pengguna yang diberikan ke daftar penonton untuk Document. Jika pengguna sudah ada dalam daftar editor, metode ini tidak akan berpengaruh.

Parameter

Nama	Jenis	Deskripsi
`emailAddress`	`String`	Alamat email pengguna yang akan ditambahkan.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`addViewer(user)`

Menambahkan pengguna yang diberikan ke daftar penonton untuk Document. Jika pengguna sudah ada dalam daftar editor, metode ini tidak akan berpengaruh.

Parameter

Nama	Jenis	Deskripsi
`user`	`User`	Representasi pengguna yang akan ditambahkan.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`addViewers(emailAddresses)`

Menambahkan array pengguna yang diberikan ke daftar penonton untuk Document. Jika salah satu pengguna sudah ada dalam daftar editor, metode ini tidak akan berpengaruh bagi mereka.

Parameter

Nama	Jenis	Deskripsi
`emailAddresses`	`String[]`	Array alamat email pengguna yang akan ditambahkan.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`getActiveTab()`

Mendapatkan Tab pengguna yang saat ini aktif dalam dokumen. Skrip hanya dapat mengakses tab aktif pengguna yang menjalankan skrip, dan hanya jika skrip terikat dengan dokumen.

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

Pulang pergi

Tab — Tab pengguna yang saat ini aktif, atau null jika skrip tidak terikat dengan dokumen.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`getAs(contentType)`

Mengambil konten Document saat ini sebagai blob dari jenis yang ditentukan.

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

Parameter

Nama	Jenis	Deskripsi
`contentType`	`String`	Jenis MIME yang akan dikonversi; `'application/pdf'` dan `'text/markdown'` didukung.

Pulang pergi

Blob — Dokumen saat ini sebagai blob.

`getBlob()`

Mengambil konten Document saat ini sebagai 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());

Pulang pergi

Blob — Dokumen saat ini sebagai blob.

`getBody()`

Mengambil Body tab pertama atau, untuk skrip yang terikat ke dokumen, DocumentBodySection tab aktif. Untuk mendapatkan DocumentBodySection dari tab mana pun, gunakan metode DocumentTab.getBody().

Tab dapat berisi berbagai jenis bagian (misalnya, HeaderSection, FooterSection). Bagian aktif untuk tab adalah Body.

Metode elemen di Document didelegasikan ke Body yang aktif.

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

Pulang pergi

Body — Bagian isi tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`getBookmark(id)`

Mendapatkan Bookmark dengan ID yang diberikan di tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif. Untuk mendapatkan bookmark di tab mana pun, gunakan metode DocumentTab.getBookmark(id). Metode ini menampilkan null jika tidak ada Bookmark tersebut dalam tab.

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

Parameter

Nama	Jenis	Deskripsi
`id`	`String`	ID untuk `Bookmark`.

Pulang pergi

Bookmark — Bookmark dengan ID yang diberikan, atau null jika tidak ada Bookmark tersebut dalam tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`getBookmarks()`

Mendapatkan semua objek Bookmark di tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif. Untuk mendapatkan semua bookmark di tab mana pun, gunakan metode 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);

Pulang pergi

Bookmark[] — Array objek Bookmark di tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`getCursor()`

Mendapatkan kursor pengguna di tab aktif. Skrip hanya dapat mengakses kursor pengguna yang menjalankan skrip, dan hanya jika skrip terikat ke dokumen.

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

Pulang pergi

Position — Representasi kursor pengguna, atau null jika pengguna tidak memiliki kursor yang ditempatkan di tab atau jika skrip tidak terikat ke dokumen.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`getEditors()`

Mendapatkan daftar editor untuk Document ini.

Pulang pergi

User[] — Array pengguna dengan izin edit.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`getFooter()`

Mengambil bagian footer tab pertama atau, untuk skrip yang terikat ke dokumen, bagian footer tab aktif. Untuk mendapatkan bagian footer dari tab mana pun, gunakan metode 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());

Pulang pergi

FooterSection — Footer tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`getFootnotes()`

Mengambil semua elemen Footnote di isi tab pertama atau, untuk skrip yang terikat ke dokumen, isi tab aktif. Untuk mendapatkan semua catatan kaki di tab mana pun, gunakan metode DocumentTab.getFootnotes().

Panggilan ke getFootnotes menyebabkan iterasi pada elemen tab. Untuk tab besar, hindari panggilan yang tidak perlu ke metode ini.

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

Pulang pergi

Footnote[] — Catatan kaki tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`getHeader()`

Mengambil bagian header tab pertama atau, untuk skrip yang terikat ke dokumen, bagian header tab aktif. Untuk mendapatkan bagian header tab mana pun, gunakan metode 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());

Pulang pergi

HeaderSection — Header tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`getId()`

Mengambil ID unik dokumen. ID dokumen digunakan dengan DocumentApp.openById() untuk membuka instance dokumen tertentu.

Pulang pergi

String — ID dokumen.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`getLanguage()`

Mendapatkan kode bahasa dokumen. Ini adalah bahasa yang ditampilkan di File > Bahasa editor dokumen, yang mungkin bukan bahasa sebenarnya yang ada dalam dokumen.

Pulang pergi

String — Bahasa dokumen, atau null jika tidak ditentukan.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`getName()`

Mengambil judul dokumen.

Pulang pergi

String — Judul dokumen.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`getNamedRangeById(id)`

Mendapatkan NamedRange dengan ID yang diberikan di tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif. Untuk mendapatkan NamedRange dengan ID yang diberikan di tab mana pun, gunakan metode DocumentTab.getNamedRangeById(id). Metode ini menampilkan null jika tidak ada NamedRange seperti itu di tab. Nama tidak harus unik, bahkan di seluruh tab; beberapa rentang yang berbeda di tab yang sama dapat memiliki nama yang sama, seperti class di HTML. Sebaliknya, ID bersifat unik dalam tab, seperti ID di HTML.

Parameter

Nama	Jenis	Deskripsi
`id`	`String`	ID rentang, yang unik dalam tab.

Pulang pergi

NamedRange — NamedRange dengan ID yang diberikan, atau null jika tidak ada rentang tersebut di tab.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`getNamedRanges()`

Mendapatkan semua objek NamedRange di tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif. Untuk mendapatkan semua objek NamedRange di tab mana pun, gunakan metode DocumentTab.getNamedRanges().

NamedRange dapat diakses oleh skrip apa pun yang mengakses tab. Untuk menghindari konflik yang tidak diinginkan antar-skrip, pertimbangkan untuk menambahkan awalan nama rentang dengan string unik.

Pulang pergi

NamedRange[] — Array objek NamedRange di tab, yang mungkin mencakup beberapa rentang dengan nama yang sama.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`getNamedRanges(name)`

Mendapatkan semua objek NamedRange dengan nama yang diberikan di tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif. Untuk mendapatkan semua objek NamedRange di tab mana pun, gunakan metode DocumentTab.getNamedRanges(name). Nama tidak harus unik, bahkan di seluruh tab; beberapa rentang yang berbeda di tab yang sama dapat memiliki nama yang sama, seperti class di HTML. Sebaliknya, ID bersifat unik dalam tab, seperti ID di HTML.

NamedRange dapat diakses oleh skrip apa pun yang mengakses dokumen. Untuk menghindari konflik yang tidak diinginkan antar-skrip, pertimbangkan untuk menambahkan awalan nama rentang dengan string unik.

Parameter

Nama	Jenis	Deskripsi
`name`	`String`	Nama rentang, yang tidak harus unik.

Pulang pergi

NamedRange[] — Array objek NamedRange di tab dengan nama yang diberikan.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`getSelection()`

Mendapatkan pilihan pengguna di tab aktif. Skrip hanya dapat mengakses pilihan pengguna yang menjalankan skrip, dan hanya jika skrip terikat ke dokumen.

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

Pulang pergi

Range — Representasi pilihan pengguna, atau null jika pengguna tidak memiliki apa pun yang dipilih di tab, jika hanya akhir paragraf yang dipilih, jika hanya akhir paragraf dan baris baru yang dipilih, atau jika skrip tidak terikat dengan dokumen.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`getSupportedLanguageCodes()`

Mendapatkan semua kode bahasa yang didukung dalam file Dokumen Google.

Pulang pergi

String[] — Array kode bahasa.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`getTab(tabId)`

Mendapatkan Tab dengan ID yang ditentukan. Metode ini akan menampilkan null jika tidak ada Tab tersebut. Dapat mengakses tab di tingkat susunan bertingkat mana pun.

Parameter

Nama	Jenis	Deskripsi
`tabId`	`String`	ID tab yang akan didapatkan.

Pulang pergi

Tab — Tab dengan ID yang ditentukan, atau null jika tidak ada Tab tersebut.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`getTabs()`

Mendapatkan semua Tab yang tidak disusun bertingkat yang merupakan bagian dari dokumen.

Tab dapat berisi tab turunan, tab yang bertingkat dalam tab lain. Tab turunan dapat diakses menggunakan Tab.getChildTabs().

Pulang pergi

Tab[] — Daftar semua Tab yang merupakan bagian dari dokumen.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`getUrl()`

Mengambil URL untuk mengakses dokumen saat ini.

const doc = DocumentApp.getActiveDocument();

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

Pulang pergi

String — URL untuk mengakses dokumen saat ini.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`getViewers()`

Mendapatkan daftar pelihat dan pengomentar untuk Document ini.

Pulang pergi

User[] — Array pengguna dengan izin lihat atau komentar.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`newPosition(element, offset)`

Membuat Position baru, yang merupakan referensi ke lokasi di tab, relatif terhadap elemen tertentu di tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif. Untuk membuat Position yang relatif terhadap lokasi di tab mana pun, gunakan metode DocumentTab.newPosition(element, offset). Kursor pengguna direpresentasikan sebagai Position, di antara penggunaan lainnya.

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

Parameter

Nama	Jenis	Deskripsi
`element`	`Element`	Elemen yang harus berisi `Position` baru; elemen ini harus berupa elemen `Text` atau elemen penampung seperti `Paragraph`.
`offset`	`Integer`	Untuk elemen `Text`, jumlah karakter sebelum `Position`; untuk elemen lain, jumlah elemen turunan sebelum `Position` dalam elemen penampung yang sama.

Pulang pergi

Position — Position baru.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`newRange()`

Membuat builder yang digunakan untuk membuat objek Range dari elemen tab di tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif. Untuk membuat builder yang digunakan untuk membuat objek DocumentRange dari elemen tab di tab mana pun, gunakan metode 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());

Pulang pergi

RangeBuilder — Builder baru.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`removeEditor(emailAddress)`

Menghapus pengguna tertentu dari daftar editor untuk Document. Metode ini tidak memblokir pengguna agar tidak mengakses Document jika mereka termasuk dalam class pengguna yang memiliki akses umum—misalnya, jika Document dibagikan ke seluruh domain pengguna, atau jika Document berada di drive bersama yang dapat diakses pengguna.

Untuk file Drive, tindakan ini juga akan menghapus pengguna dari daftar pelihat.

Parameter

Nama	Jenis	Deskripsi
`emailAddress`	`String`	Alamat email pengguna yang akan dihapus.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`removeEditor(user)`

Menghapus pengguna tertentu dari daftar editor untuk Document. Metode ini tidak memblokir pengguna agar tidak mengakses Document jika mereka termasuk dalam kelas pengguna yang memiliki akses umum—misalnya, jika Document dibagikan ke seluruh domain pengguna, atau jika Document berada di drive bersama yang dapat diakses pengguna.

Untuk file Drive, tindakan ini juga akan menghapus pengguna dari daftar pelihat.

Parameter

Nama	Jenis	Deskripsi
`user`	`User`	Representasi pengguna yang akan dihapus.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`removeViewer(emailAddress)`

Menghapus pengguna tertentu dari daftar penonton dan pemberi komentar untuk Document. Metode ini tidak berpengaruh jika pengguna adalah editor, bukan penonton atau pemberi komentar. Metode ini juga tidak memblokir pengguna agar tidak mengakses Document jika mereka termasuk dalam kelas pengguna yang memiliki akses umum—misalnya, jika Document dibagikan ke seluruh domain pengguna, atau jika Document berada di drive bersama yang dapat diakses pengguna.

Untuk file Drive, tindakan ini juga akan menghapus pengguna dari daftar editor.

Parameter

Nama	Jenis	Deskripsi
`emailAddress`	`String`	Alamat email pengguna yang akan dihapus.

Pulang pergi

Document — Document ini untuk pengaitan.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`removeViewer(user)`

Menghapus pengguna tertentu dari daftar penonton dan pemberi komentar untuk Document. Metode ini tidak berpengaruh jika pengguna adalah editor, bukan penonton. Metode ini juga tidak memblokir pengguna agar tidak mengakses Document jika mereka termasuk dalam kelas pengguna yang memiliki akses umum—misalnya, jika Document dibagikan ke seluruh domain pengguna, atau jika Document berada di drive bersama yang dapat diakses pengguna.

Untuk file Drive, tindakan ini juga akan menghapus pengguna dari daftar editor.

Parameter

Nama	Jenis	Deskripsi
`user`	`User`	Representasi pengguna yang akan dihapus.

Pulang pergi

Document — Document ini untuk pengaitan.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`saveAndClose()`

Menyimpan Document saat ini. Menyebabkan update tertunda dihapus dan diterapkan.

Metode saveAndClose() otomatis dipanggil di akhir eksekusi skrip untuk setiap Document terbuka yang dapat diedit.

Document yang ditutup tidak dapat diedit. Gunakan DocumentApp.openById() untuk membuka kembali dokumen tertentu untuk diedit.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`setActiveTab(tabId)`

Menetapkan Tab yang dipilih pengguna dalam dokumen saat ini ke tab dengan ID yang ditentukan.

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

Parameter

Nama	Jenis	Deskripsi
`tabId`	`String`	ID tab yang akan ditetapkan sebagai aktif.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`setCursor(position)`

Menetapkan kursor pengguna, dengan Position. Skrip hanya dapat mengakses kursor pengguna yang menjalankan skrip, dan hanya jika skrip terikat ke dokumen.

Memberikan Position dari Tab yang tidak aktif akan mengalihkan tab aktif pengguna.

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

Parameter

Nama	Jenis	Deskripsi
`position`	`Position`	Lokasi kursor baru.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`setLanguage(languageCode)`

Menetapkan kode bahasa dokumen. Ini adalah bahasa yang ditampilkan di File > Bahasa editor dokumen, yang mungkin bukan bahasa sebenarnya yang ada dalam dokumen. Gunakan getSupportedLanguageCodes() untuk mendapatkan semua kode bahasa yang valid.

Parameter

Nama	Jenis	Deskripsi
`languageCode`	`String`	Kode bahasa.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`setName(name)`

Menetapkan judul dokumen.

Parameter

Nama	Jenis	Deskripsi
`name`	`String`	Judul dokumen baru.

Pulang pergi

Document — Dokumen saat ini.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

`setSelection(range)`

Menetapkan pilihan pengguna di tab aktif, dengan Range. Skrip hanya dapat mengakses pilihan pengguna yang menjalankan skrip, dan hanya jika skrip terikat dengan dokumen.

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

Parameter

Nama	Jenis	Deskripsi
`range`	`Range`	Rentang elemen baru yang akan dipilih.

Pulang pergi

Document — Document ini, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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