Class DocumentApp

DocumentApp

Doküman hizmeti, düzenlenebilen 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ş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üler, iletişim kutuları ve kenar çubukları 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ı belgeler

create(name)

Yeni bir doküman oluşturur ve 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ı, aşağıdaki kapsamlardan 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ığı bir dokümanla etkileşimde bulunmak için bunun yerine openById(id) veya openByUrl(url) 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ı, aşağıdaki kapsamlardan 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üler, iletişim kutuları ve kenar çubukları gibi özellikler eklemesine olanak tanıyan dokümanın kullanıcı arayüzü ortamının bir örneğini döndürür. Bir komut dosyası yalnızca açık bir belgenin mevcut örneğinin kullanıcı arayüzüyle etkileşimde bulunabilir ve yalnızca komut dosyası belgeye bağlıysa bu etkileşim gerçekleşebilir. Daha fazla bilgi için menüler ile iletişim kutuları ve kenar çubukları ile ilgili kılavuzlara 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 bağlı bir kapsayıcı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: Doküman örneği.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri 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ı dokümana bağlı bir kapsayıcıysa bunun yerine getActiveDocument() işlevini 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ı, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:

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