Class Document

Doküman

Her biri zengin metin ve tablo ile liste gibi öğeler içeren bir veya daha fazla Tab nesnesi içeren bir doküman.

Dokümanlar DocumentApp kullanılarak açılabilir veya oluşturulabilir. 

// Open a document by ID.
let doc = DocumentApp.openById('<my-id>');

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

Document sınıfındaki, metin içeriklerine doğrudan erişip bunları değiştiren yöntemler, etkin sekmede (belirli bir dokümana bağlı komut dosyalarında) veya etkin sekme yoksa ilk sekmede çalışır. Bu yöntemleri (örneğin, getBody()) kullanan komut dosyaları, getTabs() ve ardından Tab.asDocumentTab() kullanarak sekmeleri destekleyecek şekilde taşınabilir.

Yöntemler

YöntemDönüş türüKısa açıklama
addBookmark(position)BookmarkBelirtilen Position konumuna ilk sekmeye veya bir dokümana bağlı komut dosyaları için etkin sekmeye Bookmark ekler.
addEditor(emailAddress)DocumentBelirtilen kullanıcıyı Document için düzenleyenler listesine ekler.
addEditor(user)DocumentBelirtilen kullanıcıyı Document için düzenleyenler listesine ekler.
addEditors(emailAddresses)DocumentBelirtilen kullanıcı dizisini Document için düzenleyenler listesine ekler.
addFooter()FooterSectionİlk sekmeye veya bir dokümana bağlı olan komut dosyaları için etkin sekmeye, henüz yoksa bir altbilgi bölümü ekler.
addHeader()HeaderSectionİlk sekmeye veya dokümana bağlı komut dosyaları için etkin sekmeye, yoksa bir başlık bölümü ekler.
addNamedRange(name, range)NamedRangeİlk sekmeye veya bir dokümana bağlı olan komut dosyaları için etkin sekmeye, daha sonra almak üzere kullanılacak bir ad ve kimliğe sahip Range olan NamedRange ekler.
addViewer(emailAddress)DocumentBelirtilen kullanıcıyı Document için görüntüleyiciler listesine ekler.
addViewer(user)DocumentBelirtilen kullanıcıyı Document için görüntüleyiciler listesine ekler.
addViewers(emailAddresses)DocumentBelirtilen kullanıcı dizisini Document için görüntüleyiciler listesine ekler.
getActiveTab()Tab|nullKullanıcının dokümanda şu anda etkin olan Tab öğesini alır.
getAs(contentType)BlobMevcut Document içeriğini belirtilen türde bir büyük ikili nesne (BLOB) olarak alır.
getBlob()BlobMevcut Document içeriğini büyük ikili nesne (BLOB) olarak alır.
getBody()Bodyİlk sekmenin Body değerini veya bir belgeye bağlı olan komut dosyaları için etkin sekmenin DocumentBodySection değerini alır.
getBookmark(id)Bookmark|nullİlk sekmede veya bir belgeye bağlı olan komut dosyaları için etkin sekmede, belirli kimliğe sahip Bookmark öğesini alır.
getBookmarks()Bookmark[]İlk sekmedeki tüm Bookmark nesnelerini veya bir dokümana bağlı olan komut dosyaları için etkin sekmeyi alır.
getCursor()Position|nullEtkin sekmedeki kullanıcının imlecini alır.
getEditors()User[]Bu Document için düzenleyenlerin listesini alır.
getFooter()FooterSection|nullİlk sekmenin altbilgi bölümünü veya bir belgeye bağlı olan komut dosyaları için etkin sekmenin altbilgi bölümünü alır.
getFootnotes()Footnote[]İlk sekmenin gövdesindeki tüm Footnote öğelerini veya bir dokümana bağlı olan komut dosyaları için etkin sekmenin gövdesindeki tüm öğeleri alır.
getHeader()HeaderSection|nullİlk sekmenin başlık bölümünü veya bir dokümana bağlı olan komut dosyaları için etkin sekmenin başlık bölümünü alır.
getId()StringDokümanın benzersiz tanımlayıcısını alır.
getLanguage()String|nullDokümanın dil kodunu alır.
getName()StringDokümanın başlığını alır.
getNamedRangeById(id)NamedRange|nullİlk sekmede veya bir belgeye bağlı olan komut dosyaları için etkin sekmede, belirli kimliğe sahip NamedRange öğesini alır.
getNamedRanges()NamedRange[]İlk sekmedeki tüm NamedRange nesnelerini veya bir dokümana bağlı olan komut dosyaları için etkin sekmeyi alır.
getNamedRanges(name)NamedRange[]İlk sekmede veya bir dokümana bağlı olan komut dosyaları için etkin sekmede, verilen ada sahip tüm NamedRange nesneleri alır.
getSelection()Range|nullEtkin sekmedeki kullanıcının seçimini alır.
getSupportedLanguageCodes()String[]Google Dokümanlar dosyalarında desteklenen tüm dil kodlarını alır.
getTab(tabId)Tab|nullBelirtilen kimliğe sahip Tab öğesini alır.
getTabs()Tab[]Belgenin parçası olan, iç içe yerleştirilmemiş tüm Tab'leri alır.
getUrl()StringGeçerli dokümana erişmek için URL'yi alır.
getViewers()User[]Bu Document için görüntüleyenlerin ve yorumcuların listesini alır.
newPosition(element, offset)PositionSekmedeki bir konuma referans veren yeni bir Position oluşturur. Bu konum, ilk sekmedeki belirli bir öğeye veya bir dokümana bağlı olan komut dosyaları için etkin sekmeye göre belirlenir.
newRange()RangeBuilderİlk sekmedeki sekme öğelerinden veya bir belgeye bağlı komut dosyaları için etkin sekmeden Range nesneleri oluşturmak üzere kullanılan bir oluşturucu oluşturur.
removeEditor(emailAddress)DocumentBelirtilen kullanıcıyı Document için düzenleyenler listesinden kaldırır.
removeEditor(user)DocumentBelirtilen kullanıcıyı Document için düzenleyenler listesinden kaldırır.
removeViewer(emailAddress)DocumentBelirtilen kullanıcıyı Document için izleyici ve yorumcu listesinden kaldırır.
removeViewer(user)DocumentBelirtilen kullanıcıyı Document için izleyici ve yorumcu listesinden kaldırır.
saveAndClose()voidMevcut Document öğesini kaydeder.
setActiveTab(tabId)voidKullanıcının geçerli dokümanda seçtiği Tab öğesini, belirtilen kimliğe sahip sekmeye ayarlar.
setCursor(position)DocumentPosition değeri verildiğinde kullanıcının imlecini ayarlar.
setLanguage(languageCode)DocumentBelgenin dil kodunu ayarlar.
setName(name)DocumentBelge başlığını ayarlar.
setSelection(range)DocumentRange değeri verildiğinde, etkin sekmedeki kullanıcı seçimini ayarlar.

Ayrıntılı belgeler

addBookmark(position)

Belirtilen Position konumuna ilk sekmeye veya bir dokümana bağlı komut dosyaları için etkin sekmeye Bookmark ekler. Herhangi bir sekmeye yer işareti eklemek için DocumentTab.addBookmark(position) yöntemini kullanın. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the active or first tab's body and adds a paragraph.
const paragraph = doc.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = doc.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = doc.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

Parametreler

AdTürAçıklama
positionPositionYeni yer işaretinin konumu.

Return

Bookmark: Yeni yer işareti.

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

addEditor(emailAddress)

Belirtilen kullanıcıyı Document için düzenleyenler listesine ekler. Kullanıcı zaten izleyiciler listesindeyse bu yöntem, kullanıcının izleyiciler listesinden çıkmasını sağlar.

Parametreler

AdTürAçıklama
emailAddressStringEklenecek kullanıcının e-posta adresi.

Return

Document: Zincirleme için bu Document.

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

addEditor(user)

Belirtilen kullanıcıyı Document için düzenleyenler listesine ekler. Kullanıcı zaten izleyiciler listesindeyse bu yöntem, kullanıcının izleyiciler listesinden çıkmasını sağlar.

Parametreler

AdTürAçıklama
userUserEklenecek kullanıcının temsili.

Return

Document: Zincirleme için bu Document.

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

addEditors(emailAddresses)

Belirtilen kullanıcı dizisini Document için düzenleyenler listesine ekler. Kullanıcılardan herhangi biri zaten izleyiciler listesindeyse bu yöntemle kullanıcılar izleyiciler listesinden çıkarılır.

Parametreler

AdTürAçıklama
emailAddressesString[]Eklenecek kullanıcıların e-posta adreslerinden oluşan bir dizi.

Return

Document: Zincirleme için bu Document.

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

addFooter()

İlk sekmeye veya bir dokümana bağlı olan komut dosyaları için etkin sekmeye, henüz yoksa bir altbilgi bölümü ekler. Herhangi bir sekmeye altbilgi bölümü eklemek için DocumentTab.addFooter() yöntemini kullanın. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Adds a footer to the document's active or first tab.
const footer = doc.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

Return

FooterSection: Sekme altbilgisi.

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

addHeader()

İlk sekmeye veya dokümana bağlı komut dosyaları için etkin sekmeye, yoksa bir başlık bölümü ekler. Herhangi bir sekmeye üstbilgi bölümü eklemek için DocumentTab.addHeader() yöntemini kullanın. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Adds a header to the document's active or first tab.
const header = doc.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

Return

HeaderSection: Sekme başlığı.

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

addNamedRange(name, range)

İlk sekmeye veya bir dokümana bağlı olan komut dosyaları için etkin sekmeye, daha sonra almak üzere kullanılacak bir ad ve kimliğe sahip Range olan NamedRange ekler. Herhangi bir sekmeye NamedRange eklemek için DocumentTab.addNamedRange(name, range) yöntemini kullanın. Adlar benzersiz olmak zorunda değildir. Aynı belgedeki birkaç farklı aralık, HTML'deki bir sınıf gibi aynı adı paylaşabilir. Buna karşılık, kimlikler HTML'deki bir kimlik gibi doküman içinde benzersizdir. Bir belgeye NamedRange ekledikten sonra bu işareti değiştiremezsiniz, yalnızca kaldırabilirsiniz.

Belgeye erişen tüm komut dosyaları NamedRange öğesine erişebilir. Komut dosyaları arasında istenmeyen çakışmaları önlemek için aralık adlarının önüne benzersiz bir dize ekleyebilirsiniz. 

// Creates a named range that includes every table in the active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
// Adds the named range to the document's active tab.
doc.addNamedRange('Document tables', rangeBuilder.build());

Parametreler

AdTürAçıklama
nameStringAralığın adı. Benzersiz olması gerekmez. Aralık adları 1-256 karakter arasında olmalıdır.
rangeRangeAdla ilişkilendirilecek öğe aralığı. Aralık, etkin seçim, arama sonucu olabilir veya newRange() ile manuel olarak oluşturulabilir.

Return

NamedRange — NamedRange.

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

addViewer(emailAddress)

Belirtilen kullanıcıyı Document için görüntüleyiciler listesine ekler. Kullanıcı zaten düzenleyenler listesindeyse bu yöntemin etkisi olmaz.

Parametreler

AdTürAçıklama
emailAddressStringEklenecek kullanıcının e-posta adresi.

Return

Document: Zincirleme için bu Document.

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

addViewer(user)

Belirtilen kullanıcıyı Document için görüntüleyiciler listesine ekler. Kullanıcı zaten düzenleyenler listesindeyse bu yöntemin etkisi olmaz.

Parametreler

AdTürAçıklama
userUserEklenecek kullanıcının temsili.

Return

Document: Zincirleme için bu Document.

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

addViewers(emailAddresses)

Belirtilen kullanıcı dizisini Document için görüntüleyiciler listesine ekler. Kullanıcılardan herhangi biri zaten düzenleyenler listesindeyse bu yöntemin söz konusu kullanıcılar üzerinde etkisi olmaz.

Parametreler

AdTürAçıklama
emailAddressesString[]Eklenecek kullanıcıların e-posta adreslerinden oluşan bir dizi.

Return

Document: Zincirleme için bu Document.

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

getActiveTab()

Kullanıcının dokümanda şu anda etkin olan Tab öğesini alır. Bir komut dosyası yalnızca komut dosyasını çalıştıran kullanıcının etkin sekmesine erişebilir ve yalnızca komut dosyası dokümana bağlıysa erişebilir. 

// Display a dialog box that shows the title of the tab that the
// user is currently viewing.
const tab = DocumentApp.getActiveDocument().getActiveTab();
DocumentApp.getUi().alert(`ID of selected tab: ${tab.getTitle()}`);

Return

Tab|null: Kullanıcının şu anda etkin olan Tab veya komut dosyası belgeye bağlı değilse null.

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

getAs(contentType)

Mevcut Document içeriğini belirtilen türde bir büyük ikili nesne (BLOB) olarak alır. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the document as a PDF.
const pdf = doc.getAs('application/pdf');

// Logs the name of the PDF to the console.
console.log(pdf.getName());

Parametreler

AdTürAçıklama
contentTypeStringDönüştürülecek MIME türü; 'application/pdf' ve 'text/markdown' desteklenir.

Return

Blob: Geçerli doküman büyük ikili nesne (BLOB) olarak.

getBlob()

Mevcut Document içeriğini büyük ikili nesne (BLOB) olarak alır. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Retrieves the current document's contents as a blob and logs it to the
// console.
console.log(doc.getBlob().getContentType());

Return

Blob: Geçerli doküman büyük ikili nesne (BLOB) olarak.

getBody()

İlk sekmenin Body değerini veya bir belgeye bağlı olan komut dosyaları için etkin sekmenin DocumentBodySection değerini alır. Herhangi bir sekmenin DocumentBodySection değerini almak için DocumentTab.getBody() yöntemini kullanın.

Sekmeler farklı türlerde bölümler (ör. HeaderSection, FooterSection) içerebilir. Bir sekmenin etkin bölümü Body'dir.

Document içindeki öğe yöntemleri, etkin Body'ye temsilci olarak atanır. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the active or first tab's body.
const body = doc.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

Return

Body: Sekme gövdesi bölümü.

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

getBookmark(id)

İlk sekmede veya bir belgeye bağlı olan komut dosyaları için etkin sekmede, belirli kimliğe sahip Bookmark öğesini alır. Herhangi bir sekmede yer işareti almak için DocumentTab.getBookmark(id) yöntemini kullanın. Bu yöntem, sekmede böyle bir Bookmark yoksa null değerini döndürür. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the bookmark by its ID in the document's active or first tab.
const bookmark = doc.getBookmark('id.xyz654321');

// If the bookmark exists, logs the character offset of its position to the
// console. otherwise, logs 'No bookmark exists with the given ID.' to the
// console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

Parametreler

AdTürAçıklama
idStringBookmark için kimlik.

Return

Bookmark|null: Belirtilen kimliğe sahip Bookmark veya sekmede böyle bir Bookmark yoksa null.

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

getBookmarks()

İlk sekmedeki tüm Bookmark nesnelerini veya bir dokümana bağlı olan komut dosyaları için etkin sekmeyi alır. Herhangi bir sekmedeki tüm yer işaretlerini almak için DocumentTab.getBookmarks() yöntemini kullanın. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
const doc = DocumentApp.openById('123abc');

// Gets all of the bookmarks in the document's active or first tab.
const bookmarks = doc.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

Return

Bookmark[]: Sekmedeki Bookmark nesnelerinin dizisi.

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

getCursor()

Etkin sekmedeki kullanıcının imlecini alır. Bir komut dosyası yalnızca komut dosyasını çalıştıran kullanıcının imlecine erişebilir ve yalnızca komut dosyası dokümana bağlıysa bu erişimi gerçekleştirebilir. 

// Insert some text at the cursor position and make it bold.
const cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns
  // null, the cursor's containing element doesn't allow insertions, so show the
  // user an error message.
  const element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

Return

Position|null: Kullanıcının imlecinin gösterimi veya kullanıcı sekmede imleç yerleştirmediyse ya da komut dosyası dokümana bağlı değilse null.

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

getEditors()

Bu Document için düzenleyenlerin listesini alır.

Return

User[]: Düzenleme iznine sahip kullanıcı dizisi.

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

getFooter()

İlk sekmenin altbilgi bölümünü veya bir belgeye bağlı olan komut dosyaları için etkin sekmenin altbilgi bölümünü alır. Herhangi bir sekmenin altbilgi bölümünü almak için DocumentTab.getFooter() yöntemini kullanın. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the text of the active or first tab's footer and logs it to the console.
console.log(doc.getFooter().getText());

Return

FooterSection|null: Sekmenin altbilgisi.

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

getFootnotes()

İlk sekmenin gövdesindeki tüm Footnote öğelerini veya bir dokümana bağlı olan komut dosyaları için etkin sekmenin gövdesindeki tüm öğeleri alır. Herhangi bir sekmedeki tüm dipnotları almak için DocumentTab.getFootnotes() yöntemini kullanın.

getFootnotes çağrıları, sekmenin öğeleri üzerinde yinelemeye neden olur. Büyük sekmeler için bu yönteme gereksiz çağrılardan kaçının. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the first footnote in the active or first tab's body.
const footnote = doc.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

Return

Footnote[]: Sekmenin dipnotları.

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

getHeader()

İlk sekmenin başlık bölümünü veya bir dokümana bağlı olan komut dosyaları için etkin sekmenin başlık bölümünü alır. Herhangi bir sekmenin üstbilgi bölümünü almak için DocumentTab.getHeader() yöntemini kullanın. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the text of the active or first tab's header and logs it to the console.
console.log(doc.getHeader().getText());

Return

HeaderSection|null: Sekmenin başlığı.

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

getId()

Dokümanın benzersiz tanımlayıcısını alır. Belirli bir doküman örneğini açmak için doküman kimliği DocumentApp.openById() ile birlikte kullanılır.

Return

String: Dokümanın kimliğ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

getLanguage()

Dokümanın dil kodunu alır. Bu, belge düzenleyicinin Dosya > Dil bölümünde gösterilen dildir ve belgenin içerdiği gerçek dil olmayabilir.

Return

String|null: Belge dili veya tanımlanmamışsa null.

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

getName()

Dokümanın başlığını alır.

Return

String: Doküman başlığı.

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

getNamedRangeById(id)

İlk sekmede veya bir belgeye bağlı olan komut dosyaları için etkin sekmede, belirli kimliğe sahip NamedRange öğesini alır. Herhangi bir sekmede belirli kimliğe sahip NamedRange öğesini almak için DocumentTab.getNamedRangeById(id) yöntemini kullanın. Bu yöntem, sekmede böyle bir NamedRange yoksa null değerini döndürür. Adlar, sekmeler arasında bile benzersiz olmayabilir. Aynı sekmedeki birkaç farklı aralık, HTML'deki bir sınıf gibi aynı adı paylaşabilir. Buna karşılık, kimlikler HTML'deki kimlik gibi sekme içinde benzersizdir.

Parametreler

AdTürAçıklama
idStringSekme içinde benzersiz olan aralığın kimliği.

Return

NamedRange|null: Belirtilen kimliğe sahip NamedRange veya sekmede böyle bir aralık yoksa null.

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

getNamedRanges()

İlk sekmedeki tüm NamedRange nesnelerini veya bir dokümana bağlı olan komut dosyaları için etkin sekmeyi alır. Herhangi bir sekmedeki tüm NamedRange nesnelerini almak için DocumentTab.getNamedRanges() yöntemini kullanın.

Bir NamedRange, sekmeye erişen tüm komut dosyaları tarafından kullanılabilir. Komut dosyaları arasında istenmeyen çakışmaları önlemek için aralık adlarının önüne benzersiz bir dize ekleyebilirsiniz.

Return

NamedRange[]: Sekmedeki NamedRange nesnelerinin dizisi. Aynı ada sahip birden fazla aralık içerebilir.

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

getNamedRanges(name)

İlk sekmedeki veya bir dokümana bağlı olan komut dosyaları için etkin sekmedeki belirli ada sahip tüm NamedRange nesneleri alır. Herhangi bir sekmedeki tüm NamedRange nesnelerini almak için DocumentTab.getNamedRanges(name) yöntemini kullanın. Adlar, sekmeler arasında bile benzersiz olmayabilir. Aynı sekmedeki birkaç farklı aralık, HTML'deki bir sınıf gibi aynı adı paylaşabilir. Buna karşılık, kimlikler sekme içinde benzersizdir (ör. HTML'deki bir kimlik).

Bir NamedRange, dokümana erişen tüm komut dosyaları tarafından kullanılabilir. Komut dosyaları arasında istenmeyen çakışmaları önlemek için aralık adlarının önüne benzersiz bir dize ekleyebilirsiniz.

Parametreler

AdTürAçıklama
nameStringAralığın adı (benzersiz olması gerekmez).

Return

NamedRange[]: Belirtilen ada sahip sekmedeki NamedRange nesnelerinin dizisi.

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

getSelection()

Etkin sekmedeki kullanıcının seçimini alır. Bir komut dosyası yalnızca komut dosyasını çalıştıran kullanıcının seçimine erişebilir ve yalnızca komut dosyası dokümana bağlıysa bu erişimi gerçekleştirebilir. 

// Display a dialog box that tells the user how many elements are included in
// the selection.
const selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  const elements = selection.getRangeElements();
  DocumentApp.getUi().alert(`Number of selected elements: ${elements.length}`);
} else {
  DocumentApp.getUi().alert('Nothing is selected.');
}

Return

Range|null: Kullanıcının seçiminin gösterimi veya null: Kullanıcı sekmede herhangi bir şey seçmediyse, yalnızca bir paragrafın sonu seçildiyse, yalnızca bir paragrafın sonu ve yeni bir satır seçildiyse ya da komut dosyası dokümana bağlı değilse.

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

getSupportedLanguageCodes()

Google Dokümanlar dosyalarında desteklenen tüm dil kodlarını alır.

Return

String[]: Dil kodları dizisi.

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

getTab(tabId)

Belirtilen kimliğe sahip Tab öğesini alır. Bu yöntem, böyle bir Tab yoksa null değerini döndürür. İç içe yerleştirme düzeyinden bağımsız olarak sekmelere erişebilir.

Parametreler

AdTürAçıklama
tabIdStringAlınacak sekmenin kimliği.

Return

Tab|null: Belirtilen kimliğe sahip Tab veya böyle bir Tab yoksa null.

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

getTabs()

Belgenin parçası olan, iç içe yerleştirilmemiş tüm Tab'leri alır.

Sekmeler, alt sekmeler (başka bir sekmenin içine yerleştirilmiş sekme) içerebilir. Çocuk sekmelerine Tab.getChildTabs() kullanılarak erişilebilir.

Return

Tab[]: Belgenin bir parçası olan tüm Tab'lerin listesi.

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

getUrl()

Geçerli dokümana erişmek için URL'yi alır. 

const doc = DocumentApp.getActiveDocument();

// Send out the link to open the document.
MailApp.sendEmail('<email-address>', doc.getName(), doc.getUrl());

Return

String: Geçerli dokümana erişmek için kullanılan URL.

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

getViewers()

Bu Document için görüntüleyenlerin ve yorumcuların listesini alır.

Return

User[]: Görüntüleme veya yorum yapma izni olan kullanıcı dizisi.

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

newPosition(element, offset)

Sekmedeki bir konuma referans veren yeni bir Position oluşturur. Bu konum, ilk sekmedeki belirli bir öğeye veya bir dokümana bağlı olan komut dosyaları için etkin sekmeye göre belirlenir. Herhangi bir sekmedeki konuma göre Position oluşturmak için DocumentTab.newPosition(element, offset) yöntemini kullanın. Kullanıcının imleci, diğer kullanımların yanı sıra Position olarak gösterilir. 

// Append a paragraph to the active tab, then place the user's cursor after the
// first word of the new paragraph.
const doc = DocumentApp.getActiveDocument();
const paragraph = doc.getBody().appendParagraph('My new paragraph.');
const position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parametreler

AdTürAçıklama
elementElementYeni Position öğesini içermesi gereken öğe; bu, Text öğesi veya Paragraph gibi bir kapsayıcı öğe olmalıdır.
offsetIntegerText öğeleri için Position öncesindeki karakter sayısı; diğer öğeler için aynı kapsayıcı öğe içindeki Position öncesindeki alt öğe sayısı.

Return

Position — Yeni Position.

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

newRange()

İlk sekmedeki sekme öğelerinden veya bir belgeye bağlı komut dosyaları için etkin sekmeden Range nesneleri oluşturmak üzere kullanılan bir oluşturucu oluşturur. Herhangi bir sekmedeki sekme öğelerinden DocumentRange nesneleri oluşturmak için kullanılan bir oluşturucu oluşturmak üzere DocumentTab.newRange() yöntemini kullanın. 

// Change the user's selection to a range that includes every table in the
// active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Return

RangeBuilder: Yeni derleyici.

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

removeEditor(emailAddress)

Belirtilen kullanıcıyı Document için düzenleyenler listesinden kaldırır. Bu yöntem, genel erişime sahip bir kullanıcı sınıfına ait olmaları durumunda kullanıcıların Document erişmesini engellemez. Örneğin, Document kullanıcının alanının tamamıyla paylaşılıyorsa veya Document, kullanıcının erişebileceği bir ortak Drive'daysa.

Drive dosyaları için bu işlem, kullanıcıyı görüntüleyenler listesinden de kaldırır.

Parametreler

AdTürAçıklama
emailAddressStringKaldırılacak kullanıcının e-posta adresi.

Return

Document: Zincirleme için bu Document.

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

removeEditor(user)

Belirtilen kullanıcıyı Document için düzenleyenler listesinden kaldırır. Bu yöntem, genel erişime sahip bir kullanıcı sınıfına ait olmaları durumunda kullanıcıların Document erişmesini engellemez. Örneğin, Document kullanıcının alanının tamamıyla paylaşılıyorsa veya Document, kullanıcının erişebileceği bir ortak Drive'daysa.

Drive dosyaları için bu işlem, kullanıcıyı görüntüleyenler listesinden de kaldırır.

Parametreler

AdTürAçıklama
userUserKaldırılacak kullanıcının temsili.

Return

Document: Zincirleme için bu Document.

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

removeViewer(emailAddress)

Belirtilen kullanıcıyı Document için izleyici ve yorumcu listesinden kaldırır. Bu yöntem, kullanıcı görüntüleyici veya yorumcu değil de düzenleyiciyse etkili olmaz. Bu yöntem, genel erişime sahip bir kullanıcı sınıfına ait olmaları durumunda kullanıcıların Document erişimini de engellemez. Örneğin, Document kullanıcının alanının tamamıyla paylaşılıyorsa veya Document, kullanıcının erişebileceği bir ortak Drive'daysa.

Drive dosyaları için bu işlem, kullanıcıyı düzenleyenler listesinden de kaldırır.

Parametreler

AdTürAçıklama
emailAddressStringKaldırılacak kullanıcının e-posta adresi.

Return

Document: Bu, zincirleme için Document.

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

removeViewer(user)

Belirtilen kullanıcıyı Document için izleyici ve yorumcu listesinden kaldırır. Bu yöntem, kullanıcı görüntüleyici değil düzenleyiciyse etkili olmaz. Bu yöntem, genel erişime sahip bir kullanıcı sınıfına ait olmaları durumunda kullanıcıların Document erişimini de engellemez. Örneğin, Document kullanıcının alanının tamamıyla paylaşılıyorsa veya Document kullanıcının erişebileceği bir ortak Drive'da bulunuyorsa.

Drive dosyaları için bu işlem, kullanıcıyı düzenleyenler listesinden de kaldırır.

Parametreler

AdTürAçıklama
userUserKaldırılacak kullanıcının temsili.

Return

Document: Bu, zincirleme için Document.

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

saveAndClose()

Mevcut Document öğesini kaydeder. Bekleyen güncellemelerin temizlenip uygulanmasına neden olur.

saveAndClose() yöntemi, komut dosyası yürütme işleminin sonunda her açık düzenlenebilir Document için otomatik olarak çağrılır.

Kapatılan Document düzenlenemez. Belirli bir dokümanı düzenlemek için yeniden açmak üzere DocumentApp.openById() simgesini kullanın.

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

setActiveTab(tabId)

Kullanıcının geçerli dokümanda seçtiği Tab öğesini, belirtilen kimliğe sahip sekmeye ayarlar. 

const doc = DocumentApp.getActiveDocument();

// Sets the user's selected tab by its ID.
// TODO(developer): Replace the ID with your own.
const tab = doc.setActiveTab('123abc');

Parametreler

AdTürAçıklama
tabIdStringEtkin olarak ayarlanacak sekmenin kimliğ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

setCursor(position)

Position değeri verildiğinde kullanıcının imlecini ayarlar. Komut dosyaları yalnızca komut dosyasını çalıştıran kullanıcının imlecine erişebilir ve bu erişim yalnızca komut dosyası dokümana bağlıysa mümkündür.

Etkin olmayan bir Tab'den Position sağlandığında kullanıcının etkin sekmesi değiştirilir. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();

// Append a paragraph, then place the user's cursor after the first word of the
// new paragraph.
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
const position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parametreler

AdTürAçıklama
positionPositionYeni imleç konumu.

Return

Document: Zincirleme için bu Document.

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

setLanguage(languageCode)

Belgenin dil kodunu ayarlar. Bu, belge düzenleyicinin Dosya > Dil bölümünde gösterilen dildir ve belgenin içerdiği gerçek dil olmayabilir. Geçerli tüm dil kodlarını almak için getSupportedLanguageCodes() işlevini kullanın.

Parametreler

AdTürAçıklama
languageCodeStringDil kodu.

Return

Document: Zincirleme için bu Document.

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

setName(name)

Belge başlığını ayarlar.

Parametreler

AdTürAçıklama
nameStringYeni doküman başlığı.

Return

Document: Geçerli doküman.

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

setSelection(range)

Range değeri verildiğinde, etkin sekmedeki kullanıcı seçimini ayarlar. Bir komut dosyası yalnızca komut dosyasını çalıştıran kullanıcının seçimine erişebilir ve yalnızca komut dosyası dokümana bağlıysa bu erişimi gerçekleştirebilir. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();

// Change the user's selection to a range that includes every table in the
// document.
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Parametreler

AdTürAçıklama
rangeRangeSeçilecek yeni öğe aralığı.

Return

Document: Zincirleme için bu Document.

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