Class DocumentApp

DocumentApp

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

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

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

Özellikler

ÖzellikTü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şturur ve yeni bir doküman döndürür.
getActiveDocument()DocumentKomut dosyasının kapsayıcıya bağlı olduğu dokümanı döndürür.
getUi()UiDokümanın kullanıcı arayüzü ortamının, komut dosyasının aşağıdaki gibi dosya eklemesine izin veren bir örneğini döndürür: özellikler (ör. menüler, iletişim kutuları ve kenar çubukları)
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ı belgeler

create(name)

Yeni bir doküman oluşturur ve yeni bir doküman döndürür.

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

Parametreler

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

Return

Document — Yeni belge örneği.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

getActiveDocument()

Komut dosyasının kapsayıcıya bağlı olduğu dokümanı döndürür. Hangi dokümanla etkileşimde bulunulacağı komut dosyası kapsayıcıya bağlı değil, openById(id) veya openByUrl(url) kullanın .

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

Return

Document — belge örneği

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

getUi()

Dokümanın kullanıcı arayüzü ortamının, komut dosyasının aşağıdaki gibi dosya eklemesine izin veren bir örneğini döndürür: özellikler (ör. menüler, iletişim kutuları ve kenar çubukları) Bir komut dosyası yalnızca açık bir dokümanın geçerli örneğini ve yalnızca komut dosyası dokümana bağlıysa. Daha fazla bilgi için menüler ile iletişim kutuları ve kenar çubukları kılavuzlarını bulabilirsiniz.

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


openById(id)

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

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

Parametreler

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

Return

Document — Doküman örneği.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

openByUrl(url)

Belirtilen URL'ye sahip dokümanı açar ve döndürür. Komut dosyası, bunun yerine getActiveDocument() kullanın.

// Open a document by URL.
var 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 — belge örneği

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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