Class Document

Dokumen

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 pada tab aktif (dalam skrip 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

MetodeJenis nilai yang ditampilkanDeskripsi singkat
addBookmark(position)BookmarkMenambahkan Bookmark pada Position tertentu ke tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif.
addEditor(emailAddress)DocumentMenambahkan pengguna tertentu ke daftar editor untuk Document.
addEditor(user)DocumentMenambahkan pengguna tertentu ke daftar editor untuk Document.
addEditors(emailAddresses)DocumentMenambahkan array pengguna tertentu ke daftar editor untuk Document.
addFooter()FooterSectionMenambahkan bagian footer, jika tidak ada, ke tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif.
addHeader()HeaderSectionMenambahkan bagian header, jika tidak ada, ke tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif.
addNamedRange(name, range)NamedRangeMenambahkan NamedRange, yaitu Range yang memiliki nama dan ID untuk digunakan pada pengambilan berikutnya, di tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif.
addViewer(emailAddress)DocumentMenambahkan pengguna tertentu ke daftar penonton untuk Document.
addViewer(user)DocumentMenambahkan pengguna tertentu ke daftar penonton untuk Document.
addViewers(emailAddresses)DocumentMenambahkan array pengguna tertentu ke daftar penonton untuk Document.
getActiveTab()Tab|nullMendapatkan Tab pengguna yang saat ini aktif dalam dokumen.
getAs(contentType)BlobMengambil konten Document saat ini sebagai blob dari jenis yang ditentukan.
getBlob()BlobMengambil konten Document saat ini sebagai blob.
getBody()BodyMengambil Body tab pertama atau, untuk skrip yang terikat ke dokumen, DocumentBodySection tab aktif.
getBookmark(id)Bookmark|nullMendapatkan 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|nullMendapatkan kursor pengguna di tab aktif.
getEditors()User[]Mendapatkan daftar editor untuk Document ini.
getFooter()FooterSection|nullMengambil 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|nullMengambil bagian header tab pertama atau, untuk skrip yang terikat ke dokumen, bagian header tab aktif.
getId()StringMengambil ID unik dokumen.
getLanguage()String|nullMendapatkan kode bahasa dokumen.
getName()StringMengambil judul dokumen.
getNamedRangeById(id)NamedRange|nullMendapatkan 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 tertentu di tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif.
getSelection()Range|nullMendapatkan pilihan pengguna di tab aktif.
getSupportedLanguageCodes()String[]Mendapatkan semua kode bahasa yang didukung dalam file Google Dokumen.
getTab(tabId)Tab|nullMendapatkan Tab dengan ID yang ditentukan.
getTabs()Tab[]Mendapatkan semua Tab yang tidak bertingkat yang merupakan bagian dari dokumen.
getUrl()StringMengambil URL untuk mengakses dokumen saat ini.
getViewers()User[]Mendapatkan daftar pelihat dan pengomentar untuk Document ini.
newPosition(element, offset)PositionMembuat 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()RangeBuilderMembuat builder yang digunakan untuk membuat objek Range dari elemen tab di tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif.
removeEditor(emailAddress)DocumentMenghapus pengguna tertentu dari daftar editor untuk Document.
removeEditor(user)DocumentMenghapus pengguna tertentu dari daftar editor untuk Document.
removeViewer(emailAddress)DocumentMenghapus pengguna tertentu dari daftar penonton dan pemberi komentar untuk Document.
removeViewer(user)DocumentMenghapus pengguna tertentu dari daftar penonton dan pemberi komentar untuk Document.
saveAndClose()voidMenyimpan Document saat ini.
setActiveTab(tabId)voidMenetapkan Tab yang dipilih pengguna dalam dokumen saat ini ke tab dengan ID yang ditentukan.
setCursor(position)DocumentMenetapkan kursor pengguna, dengan Position tertentu.
setLanguage(languageCode)DocumentMenetapkan kode bahasa dokumen.
setName(name)DocumentMenetapkan judul dokumen.
setSelection(range)DocumentMenetapkan pilihan pengguna di tab aktif, dengan Range tertentu.

Dokumentasi mendetail

addBookmark(position)

Menambahkan Bookmark pada Position tertentu ke tab pertama atau, untuk skrip yang terikat ke dokumen, tab aktif. Untuk menambahkan penanda 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

NamaJenisDeskripsi
positionPositionPosisi 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 keluar dari daftar penonton.

Parameter

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang akan ditambahkan.

Pulang pergi

Document — Document ini, untuk dirangkaikan.

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 keluar dari daftar penonton.

Parameter

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan ditambahkan.

Pulang pergi

Document — Document ini, untuk dirangkaikan.

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 tertentu ke daftar editor untuk Document. Jika salah satu pengguna sudah ada dalam daftar pelihat, metode ini akan mempromosikannya keluar dari daftar pelihat.

Parameter

NamaJenisDeskripsi
emailAddressesString[]Array alamat email pengguna yang akan ditambahkan.

Pulang pergi

Document — Document ini, untuk dirangkaikan.

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, yaitu Range yang memiliki nama dan ID untuk digunakan pada pengambilan berikutnya, 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 selalu unik; beberapa rentang berbeda dalam dokumen yang sama dapat memiliki nama yang sama, seperti kelas dalam HTML. Sebaliknya, ID bersifat unik dalam dokumen, seperti ID di HTML. Setelah menambahkan NamedRange ke dokumen, Anda tidak dapat mengubahnya, Anda hanya dapat menghapusnya.

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

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

NamaJenisDeskripsi
nameStringNama rentang, yang tidak harus unik; nama rentang harus terdiri dari 1-256 karakter.
rangeRangeRentang 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 tertentu ke daftar penonton untuk Document. Jika pengguna sudah ada dalam daftar editor, metode ini tidak akan berpengaruh.

Parameter

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang akan ditambahkan.

Pulang pergi

Document — Document ini, untuk dirangkaikan.

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 tertentu ke daftar penonton untuk Document. Jika pengguna sudah ada dalam daftar editor, metode ini tidak akan berpengaruh.

Parameter

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan ditambahkan.

Pulang pergi

Document — Document ini, untuk dirangkaikan.

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 tertentu ke daftar penonton untuk Document. Jika salah satu pengguna sudah ada dalam daftar editor, metode ini tidak akan berpengaruh bagi mereka.

Parameter

NamaJenisDeskripsi
emailAddressesString[]Array alamat email pengguna yang akan ditambahkan.

Pulang pergi

Document — Document ini, untuk dirangkaikan.

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 ke 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|null — Tab pengguna yang saat ini aktif, atau null 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

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

NamaJenisDeskripsi
contentTypeStringJenis 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 tab apa 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 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 penanda di tab mana pun, gunakan metode DocumentTab.getBookmark(id). Metode ini menampilkan null jika tidak ada Bookmark seperti itu 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

NamaJenisDeskripsi
idStringID untuk Bookmark.

Pulang pergi

Bookmark|null — 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 penanda 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|null — 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|null — 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 apa 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|null — 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|null — 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 tertentu di tab mana pun, gunakan metode DocumentTab.getNamedRangeById(id). Metode ini menampilkan null jika tidak ada NamedRange seperti itu di tab. Nama tidak selalu unik, bahkan di seluruh tab; beberapa rentang berbeda dalam tab yang sama dapat berbagi nama yang sama, seperti class di HTML. Sebaliknya, ID bersifat unik dalam tab, seperti ID di HTML.

Parameter

NamaJenisDeskripsi
idStringID rentang, yang unik dalam tab.

Pulang pergi

NamedRange|null — NamedRange dengan ID yang diberikan, atau null jika tidak ada rentang seperti itu 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 pada 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 tertentu 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 selalu unik, bahkan di seluruh tab; beberapa rentang berbeda dalam 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 pada nama rentang dengan string unik.

Parameter

NamaJenisDeskripsi
nameStringNama 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|null — Representasi pilihan pengguna, atau null jika pengguna tidak memilih apa pun di tab, jika hanya akhir paragraf yang dipilih, jika hanya akhir paragraf dan baris baru yang dipilih, 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

getSupportedLanguageCodes()

Mendapatkan semua kode bahasa yang didukung dalam file Google Dokumen.

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 seperti itu. Dapat mengakses tab di tingkat susunan bertingkat mana pun.

Parameter

NamaJenisDeskripsi
tabIdStringID tab yang akan didapatkan.

Pulang pergi

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

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 bertingkat yang merupakan bagian dari dokumen.

Tab dapat berisi tab turunan, yaitu tab yang berada di dalam tab lain. Tab anak 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 melihat atau mengomentari.

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 relatif terhadap lokasi di tab mana pun, gunakan metode DocumentTab.newPosition(element, offset). Kursor pengguna ditampilkan 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

NamaJenisDeskripsi
elementElementElemen yang harus berisi Position baru; elemen ini harus berupa elemen Text atau elemen penampung seperti Paragraph.
offsetIntegerUntuk 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 mengakses Document jika mereka termasuk dalam kelas pengguna yang memiliki akses umum—misalnya, jika Document dibagikan dengan 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

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang akan dihapus.

Pulang pergi

Document — Document ini, untuk dirangkaikan.

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 mengakses Document jika mereka termasuk dalam kelas pengguna yang memiliki akses umum—misalnya, jika Document dibagikan dengan 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

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan dihapus.

Pulang pergi

Document — Document ini, untuk dirangkaikan.

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 pelihat 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 dengan 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

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang akan dihapus.

Pulang pergi

Document — Document ini untuk dirangkaikan.

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 pelihat. Metode ini juga tidak memblokir pengguna mengakses Document jika mereka termasuk dalam kelas pengguna yang memiliki akses umum—misalnya, jika Document dibagikan dengan 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

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan dihapus.

Pulang pergi

Document — Document ini untuk dirangkaikan.

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 dibatalkan dan diterapkan.

Metode saveAndClose() dipanggil secara otomatis di akhir eksekusi skrip untuk setiap Document yang terbuka dan 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

NamaJenisDeskripsi
tabIdStringID 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 tertentu. Skrip hanya dapat mengakses kursor pengguna yang menjalankan skrip, dan hanya jika skrip terikat ke dokumen.

Menyediakan 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

NamaJenisDeskripsi
positionPositionLokasi kursor baru.

Pulang pergi

Document — Document ini, untuk dirangkaikan.

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

NamaJenisDeskripsi
languageCodeStringKode bahasa.

Pulang pergi

Document — Document ini, untuk dirangkaikan.

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

NamaJenisDeskripsi
nameStringJudul 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 tertentu. Skrip hanya dapat mengakses pilihan pengguna yang menjalankan skrip, dan hanya jika skrip terikat ke 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

NamaJenisDeskripsi
rangeRangeRentang elemen baru yang akan dipilih.

Pulang pergi

Document — Document ini, untuk dirangkaikan.

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