Class DocumentApp

DokümanUygulama

Doküman hizmeti, düzenlenebilir Documents oluşturur ve açar.

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
let doc = DocumentApp.openById('DOCUMENT_ID');

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

Özellikler

MülkTürAçıklama
AttributeAttributeAttribute numaralandırması.
ElementTypeElementTypeElementType numaralandırması.
FontFamilyFontFamilyFontFamily numaralandırması.
GlyphTypeGlyphTypeGlyphType numaralandırması.
HorizontalAlignmentHorizontalAlignmentHorizontalAlignment numaralandırması.
ParagraphHeadingParagraphHeadingParagraphHeading numaralandırması.
PositionedLayoutPositionedLayoutPositionedLayout numaralandırması.
TextAlignmentTextAlignmentTextAlignment numaralandırması.
VerticalAlignmentVerticalAlignmentVerticalAlignment numaralandırması.

Yöntemler

YöntemDönüş türüKısa açıklama
create(name)DocumentYeni bir doküman oluşturup döndürür.
getActiveDocument()DocumentKomut dosyasının kapsayıcıya bağlı olduğu dokümanı döndürür.
getUi()UiKomut dosyasının menü, iletişim kutusu ve kenar çubuğu gibi özellikler eklemesine olanak tanıyan, dokümanın kullanıcı arayüzü ortamının bir örneğini döndürür.
openById(id)DocumentBelirtilen kimliğe sahip dokümanı döndürür.
openByUrl(url)DocumentBelirtilen URL'ye sahip dokümanı açar ve döndürür.

Ayrıntılı dokümanlar

create(name)

Yeni bir doküman oluşturup döndürür.

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

Parametreler

AdTürAçıklama
nameStringYeni dokümanın adı.

Return

Document: Yeni doküman örneği.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getActiveDocument()

Komut dosyasının kapsayıcıya bağlı olduğu dokümanı döndürür. Komut dosyasının kapsayıcıya bağlı olmadığı dokümanla etkileşim kurmak için bunun yerine openById(id) veya openByUrl(url) işlevini kullanın.

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

Return

Document: doküman örneği

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getUi()

Komut dosyasının menü, iletişim kutusu ve kenar çubuğu gibi özellikler eklemesine olanak tanıyan, dokümanın kullanıcı arayüzü ortamının bir örneğini döndürür. Komut dosyaları yalnızca açık bir dokümanın mevcut örneğinin kullanıcı arayüzüyle etkileşime geçebilir ve bu da yalnızca komut dosyası dokümana bağlıysa geçerli olur. Daha fazla bilgi için menüler ve iletişim kutuları ve kenar çubukları ile ilgili kılavuzları inceleyin.

// 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: Bu belgenin kullanıcı arayüzü ortamının bir örneği


openById(id)

Belirtilen kimliğe sahip dokümanı döndürür. Komut dosyası, belgeye kapsayıcı bağlıysa bunun yerine getActiveDocument() kullanın.

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('DOCUMENT_ID');

Parametreler

AdTürAçıklama
idStringAçılacak dokümanın kimliği.

Return

Document: Belge örneği.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

openByUrl(url)

Belirtilen URL'ye sahip dokümanı açar ve döndürür. Komut dosyası belgeye kapsayıcı bağlıysa bunun yerine getActiveDocument() kullanın.

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

Parametreler

AdTürAçıklama
urlStringaçılacak dokümanın URL'si

Return

Document: doküman örneği

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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