Class DocumentApp

DocumentApp

Layanan dokumen membuat dan membuka Documents yang dapat diedit.

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');

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

Properti

PropertiJenisDeskripsi
AttributeAttributeEnumerasi Attribute.
ElementTypeElementTypeEnumerasi ElementType.
FontFamilyFontFamilyEnumerasi FontFamily.
GlyphTypeGlyphTypeEnumerasi GlyphType.
HorizontalAlignmentHorizontalAlignmentEnumerasi HorizontalAlignment.
ParagraphHeadingParagraphHeadingEnumerasi ParagraphHeading.
PositionedLayoutPositionedLayoutEnumerasi PositionedLayout.
TextAlignmentTextAlignmentEnumerasi TextAlignment.
VerticalAlignmentVerticalAlignmentEnumerasi VerticalAlignment.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
create(name)DocumentMembuat dan menampilkan dokumen baru.
getActiveDocument()DocumentMenampilkan dokumen yang skripnya terikat penampung.
getUi()UiMenampilkan instance lingkungan antarmuka pengguna dokumen yang memungkinkan skrip menambahkan fitur seperti menu, dialog, dan sidebar.
openById(id)DocumentMenampilkan dokumen dengan ID yang ditentukan.
openByUrl(url)DocumentMembuka dan menampilkan dokumen dengan URL yang ditentukan.

Dokumentasi mendetail

create(name)

Membuat dan menampilkan dokumen baru.

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

Parameter

NamaJenisDeskripsi
nameStringnama dokumen baru

Return

Document — instance dokumen baru

Otorisasi

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

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

getActiveDocument()

Menampilkan dokumen yang skripnya terikat penampung. Untuk berinteraksi dengan dokumen yang skripnya tidak terikat penampung, gunakan openById(id) atau openByUrl(url).

// Get the document to which this script is bound.
var doc = DocumentApp.getActiveDocument();

Return

Document — instance 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

getUi()

Menampilkan instance lingkungan antarmuka pengguna dokumen yang memungkinkan skrip menambahkan fitur seperti menu, dialog, dan sidebar. Skrip hanya dapat berinteraksi dengan UI untuk instance dokumen terbuka saat ini, dan hanya jika skrip terikat ke dokumen. Untuk mengetahui informasi selengkapnya, lihat panduan untuk menu serta dialog dan sidebar.

// Add a custom menu to the active document, including a separator and a sub-menu.
function onOpen(e) {
  DocumentApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(DocumentApp.getUi().createMenu('My sub-menu')
          .addItem('One sub-menu item', 'mySecondFunction')
          .addItem('Another sub-menu item', 'myThirdFunction'))
      .addToUi();
}

Return

Ui — instance lingkungan antarmuka pengguna dokumen ini


openById(id)

Menampilkan dokumen dengan ID yang ditentukan. Jika skrip terikat penampung pada dokumen, gunakan getActiveDocument() sebagai gantinya.

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');

Parameter

NamaJenisDeskripsi
idStringID dokumen yang akan dibuka

Return

Document — instance dokumen

Otorisasi

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

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

openByUrl(url)

Membuka dan menampilkan dokumen dengan URL yang ditentukan. Jika skrip terikat penampung pada dokumen, gunakan getActiveDocument() sebagai gantinya.

// Open a document by URL.
var doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit');

Parameter

NamaJenisDeskripsi
urlStringURL dokumen yang akan dibuka

Return

Document — instance dokumen

Otorisasi

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

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