Class DocumentApp

DocumentApp

Doküman hizmeti, düzenleyebileceğiniz Documents dosyası oluşturur ve açar.

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

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

Özellikler

ÖzellikTürAçıklama
AttributeAttributeAttribute sıralaması.
ElementTypeElementTypeElementType sıralaması.
FontFamilyFontFamilyFontFamily sıralaması.
GlyphTypeGlyphTypeGlyphType sıralaması.
HorizontalAlignmentHorizontalAlignmentHorizontalAlignment sıralaması.
ParagraphHeadingParagraphHeadingParagraphHeading sıralaması.
PositionedLayoutPositionedLayoutPositionedLayout sıralaması.
TextAlignmentTextAlignmentTextAlignment sıralaması.
VerticalAlignmentVerticalAlignmentVerticalAlignment sıralaması.

Yöntemler

YöntemDönüş türüKısa açıklama
create(name)DocumentYeni bir doküman oluşturur ve 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, belgenin 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)DocumentDokümanı belirtilen URL ile açar ve döndürür.

Ayrıntılı belgeler

create(name)

Yeni bir doküman oluşturur ve 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 doküman örneği

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri 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. Komut dosyasının kapsayıcıya bağlı olmadığı belgeyle etkileşim kurmak için bunun yerine openById(id) veya openByUrl(url) kullanın.

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

Return

Document - doküman örneği

Yetkilendirme

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

  • 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, belgenin kullanıcı arayüzü ortamının bir örneğini döndürür. Bir komut dosyası yalnızca açık bir dokümanın geçerli örneği için kullanıcı arayüzüyle ve sadece komut dosyası dokümana bağlı olduğunda etkileşimde bulunabilir. Daha fazla bilgi için menü kılavuzları ile iletişim kutuları ve kenar çubukları kılavuzlarına bakın.

// 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ı dokümana kapsayıcıya bağlıysa bunun yerine getActiveDocument() politikasını kullanın.

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

Parametreler

AdTürAçıklama
idStringaçılacak belgenin kimliği

Return

Document - doküman örneği

Yetkilendirme

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

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

openByUrl(url)

Dokümanı belirtilen URL ile açar ve döndürür. Komut dosyası dokümana kapsayıcıya bağlıysa 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 - doküman örneği

Yetkilendirme

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

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