Class Document

Dokumen

Dokumen yang berisi rich text dan elemen seperti tabel dan daftar.

Dokumen dapat dibuka atau dibuat menggunakan DocumentApp.

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

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

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addBookmark(position)BookmarkMenambahkan Bookmark pada Position yang ditentukan.
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 dokumen, jika belum ada.
addHeader()HeaderSectionMenambahkan bagian header dokumen, jika belum ada.
addNamedRange(name, range)NamedRangeMenambahkan NamedRange, yang merupakan Range yang memiliki nama dan ID untuk digunakan untuk pengambilan nanti.
addViewer(emailAddress)DocumentMenambahkan pengguna tertentu ke daftar pelihat untuk Document.
addViewer(user)DocumentMenambahkan pengguna tertentu ke daftar pelihat untuk Document.
addViewers(emailAddresses)DocumentMenambahkan array pengguna tertentu ke daftar pelihat untuk Document.
getAs(contentType)BlobMengambil konten Document saat ini sebagai blob dari jenis yang ditentukan.
getBlob()BlobMengambil konten Document saat ini sebagai blob.
getBody()BodyMengambil Body dokumen yang aktif.
getBookmark(id)BookmarkMendapatkan Bookmark dengan ID yang diberikan.
getBookmarks()Bookmark[]Mendapatkan semua objek Bookmark dalam dokumen.
getCursor()PositionMendapatkan kursor pengguna dalam dokumen yang aktif.
getEditors()User[]Mendapatkan daftar editor untuk Document ini.
getFooter()FooterSectionMengambil bagian footer dokumen, jika ada.
getFootnotes()Footnote[]Mengambil semua elemen Footnote di isi dokumen.
getHeader()HeaderSectionMengambil bagian header dokumen, jika ada.
getId()StringMengambil ID unik dokumen.
getLanguage()StringMendapatkan kode bahasa dokumen.
getName()StringMengambil judul dokumen.
getNamedRangeById(id)NamedRangeMendapatkan NamedRange dengan ID yang diberikan.
getNamedRanges()NamedRange[]Mendapatkan semua objek NamedRange dalam dokumen.
getNamedRanges(name)NamedRange[]Mendapatkan semua objek NamedRange dalam dokumen dengan nama yang diberikan.
getSelection()RangeMendapatkan pilihan pengguna dalam dokumen yang aktif.
getSupportedLanguageCodes()String[]Mendapatkan semua kode bahasa yang didukung dalam file Google 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 dalam dokumen, relatif terhadap elemen tertentu.
newRange()RangeBuilderMembuat builder yang digunakan untuk membuat objek Range dari elemen dokumen.
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 pelihat dan pengomentar untuk Document.
removeViewer(user)DocumentMenghapus pengguna tertentu dari daftar pelihat dan pengomentar untuk Document.
saveAndClose()voidMenyimpan Document saat ini.
setCursor(position)DocumentMenetapkan kursor pengguna dalam dokumen aktif, dengan Position.
setLanguage(languageCode)DocumentMenetapkan kode bahasa dokumen.
setName(name)DocumentMenetapkan judul dokumen.
setSelection(range)DocumentMenetapkan pilihan pengguna dalam dokumen aktif, dengan Range.

Dokumentasi mendetail

addBookmark(position)

Menambahkan Bookmark pada Position 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('abc123456');

// Gets the document body and adds a paragraph.
const paragraph = doc.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = doc.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = doc.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

}

Parameter

NamaJenisDeskripsi
positionPositionPosisi bookmark baru.

Return

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 di daftar audiens, metode ini akan mempromosikan pengguna dari daftar pelihat.

Parameter

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang akan ditambahkan.

Return

DocumentDocument 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 di daftar audiens, metode ini akan mempromosikan pengguna dari daftar pelihat.

Parameter

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan ditambahkan.

Return

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

Parameter

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

Return

DocumentDocument 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 dokumen, jika belum ada.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Adds a footer to the document.
const footer = doc.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

Return

FooterSection — Footer 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

addHeader()

Menambahkan bagian header dokumen, jika belum ada.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Adds a header to the document.
const header = doc.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

Return

HeaderSection — Header 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

addNamedRange(name, range)

Menambahkan NamedRange, yang merupakan Range yang memiliki nama dan ID untuk digunakan untuk pengambilan nanti. Nama tidak selalu unik; beberapa rentang berbeda dalam dokumen yang sama dapat memiliki nama yang sama, seperti class di HTML. Sebaliknya, ID bersifat unik dalam dokumen, seperti ID dalam 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 diinginkan antar-skrip, pertimbangkan untuk mengawali nama rentang dengan string unik.

// Creates a named range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.addNamedRange('Document tables', rangeBuilder.build());

Parameter

NamaJenisDeskripsi
nameStringNama untuk rentang, yang tidak harus unik; nama rentang harus antara 1-256 karakter.
rangeRangeRentang elemen yang akan dikaitkan dengan nama; rentang dapat berupa pilihan aktif, hasil penelusuran, atau dibuat secara manual dengan newRange().

Return

NamedRangeNamedRange.

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 pelihat untuk Document. Jika pengguna sudah ada di daftar editor, metode ini tidak akan berpengaruh.

Parameter

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang akan ditambahkan.

Return

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

Parameter

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan ditambahkan.

Return

DocumentDocument 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 tertentu ke daftar pelihat 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.

Return

DocumentDocument 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

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

// Gets the document as a PDF.
const pdf = doc.getAs('application/pdf');

// Logs the name of the PDF to the console.
console.log(pdf.getName());

Parameter

NamaJenisDeskripsi
contentTypeStringJenis MIME yang akan dikonversi; saat ini hanya 'application/pdf' yang didukung.

Return

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

// Retrieves the current document's contents as a blob and logs it to the console.
console.log(doc.getBlob().getContentType());

Return

Blob — Dokumen saat ini sebagai blob.


getBody()

Mengambil Body dokumen yang aktif.

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

Metode elemen dalam 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('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

Return

Body — Bagian isi dokumen yang 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

getBookmark(id)

Mendapatkan Bookmark dengan ID yang diberikan. Metode ini menampilkan null jika Bookmark tersebut tidak ada.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the bookmark by its ID.
const bookmark = doc.getBookmark('id.xyz654321');

// If the bookmark exists, logs the character offset of its position to the console.
// otherwise, logs 'No bookmark exists with the given ID.' to the console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

Parameter

NamaJenisDeskripsi
idStringID untuk Bookmark.

Return

BookmarkBookmark dengan ID yang diberikan, atau null jika tidak ada Bookmark seperti itu.

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 dalam dokumen.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
const doc = DocumentApp.openById('abc123456');

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

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

Return

Bookmark[] — Array objek Bookmark dalam 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

getCursor()

Mendapatkan kursor pengguna dalam dokumen yang 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.
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.');
}

Return

Position — Representasi kursor pengguna, atau null jika pengguna tidak memiliki kursor yang ditempatkan dalam dokumen atau jika skrip tidak terikat pada 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.

Return

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 dokumen, jika ada.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

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

Return

FooterSection — Footer 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

getFootnotes()

Mengambil semua elemen Footnote di isi dokumen.

Panggilan ke getFootnotes menyebabkan iterasi pada elemen dokumen. Untuk dokumen 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('abc123456');

// Gets the first footnote.
const footnote = doc.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

Return

Footnote[] — Catatan kaki 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

getHeader()

Mengambil bagian header dokumen, jika ada.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

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

Return

HeaderSection — Header 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

getId()

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

Return

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 dalam File > Language pada editor dokumen, yang mungkin bukan bahasa sebenarnya yang terdapat dalam dokumen.

Return

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.

Return

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. Metode ini akan menampilkan null jika tidak ada NamedRange. Nama tidak selalu unik; beberapa rentang berbeda dalam dokumen yang sama dapat memiliki nama yang sama, seperti class dalam HTML. Sebaliknya, ID bersifat unik dalam dokumen, seperti ID dalam HTML.

Parameter

NamaJenisDeskripsi
idStringID rentang yang unik dalam dokumen

Return

NamedRangeNamedRange dengan ID yang diberikan, atau null jika tidak ada rentang 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

getNamedRanges()

Mendapatkan semua objek NamedRange dalam dokumen.

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

Return

NamedRange[] — array objek NamedRange dalam dokumen, mungkin menyertakan 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 dalam dokumen dengan nama yang diberikan. Nama tidak selalu unik; beberapa rentang yang berbeda pada dokumen yang sama dapat memiliki nama yang sama, seperti halnya class dalam HTML. Sebaliknya, ID bersifat unik dalam dokumen, seperti ID dalam HTML.

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

Parameter

NamaJenisDeskripsi
nameStringnama rentang, yang belum tentu unik

Return

NamedRange[] — array objek NamedRange dalam dokumen dengan nama tertentu

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 dalam dokumen yang aktif. Skrip hanya dapat mengakses pemilihan 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.
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.');
}

Return

Range — Representasi pilihan pengguna, atau null jika pengguna tidak memiliki apa pun yang dipilih dalam dokumen, jika hanya akhir paragraf yang dipilih, jika hanya akhir paragraf dan baris baru yang dipilih, atau jika skrip tidak terikat pada 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.

Return

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

getUrl()

Mengambil URL untuk mengakses dokumen saat ini.

var doc = DocumentApp.getActiveDocument();

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

Return

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.

Return

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 dalam dokumen, relatif terhadap elemen tertentu. Kursor pengguna direpresentasikan sebagai Position, di antara penggunaan lainnya.

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var doc = DocumentApp.getActiveDocument();
var paragraph = doc.getBody().appendParagraph('My new paragraph.');
var position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parameter

NamaJenisDeskripsi
elementElementelemen yang akan berisi Position baru; ini harus berupa elemen Text atau elemen container seperti Paragraph
offsetIntegeruntuk elemen Text, jumlah karakter sebelum Position; untuk elemen lainnya, jumlah elemen turunan sebelum Position dalam elemen penampung yang sama

Return

PositionPosition 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 dokumen.

// Change the user's selection to a range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Return

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

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang akan dihapus.

Return

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

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan dihapus.

Return

DocumentDocument 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 pelihat dan pengomentar untuk Document. Metode ini tidak akan berpengaruh jika pengguna adalah editor, bukan pelihat atau pengomentar. Metode ini juga tidak memblokir pengguna agar tidak mengakses Document jika mereka termasuk dalam class 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.

Return

DocumentDocument 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(user)

Menghapus pengguna tertentu dari daftar pelihat dan pengomentar untuk Document. Metode ini tidak akan berpengaruh jika pengguna adalah editor, bukan pelihat. Metode ini juga tidak akan 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 editor.

Parameter

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan dihapus.

Return

DocumentDocument 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

saveAndClose()

Menyimpan Document saat ini. Menyebabkan update yang tertunda akan dikosongkan dan diterapkan.

Metode saveAndClose() otomatis dipanggil 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

setCursor(position)

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

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var doc = DocumentApp.getActiveDocument();
var paragraph = doc.getBody().appendParagraph('My new paragraph.');
var position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parameter

NamaJenisDeskripsi
positionPositionlokasi kursor baru

Return

DocumentDocument 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 dalam File > Language pada editor dokumen, yang mungkin bukan bahasa sebenarnya yang terdapat dalam dokumen. Gunakan getSupportedLanguageCodes() untuk mendapatkan semua kode bahasa yang valid.

Parameter

NamaJenisDeskripsi
languageCodeStringKode bahasa.

Return

DocumentDocument 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

NamaJenisDeskripsi
nameStringjudul dokumen baru

Return

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 dalam dokumen aktif, dengan Range. Skrip hanya dapat mengakses pemilihan pengguna yang menjalankan skrip, dan hanya jika skrip terikat ke dokumen.

// Change the user's selection to a range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Parameter

NamaJenisDeskripsi
rangeRangerentang elemen baru untuk dipilih

Return

DocumentDocument 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