Class Document

Doküman

Her biri zengin metin ve tablolar ile listeler gibi öğeler içeren bir veya daha fazla Tab nesnesi içeren bir belge.

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 ilk sekmede (etkin bir sekme yoksa) çalışır. Bu yöntemlere dayanan komut dosyaları (örneğin, getBody()), getTabs() ve ardından Tab.asDocumentTab() kullanılarak destek sekmelerine 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ında etkin sekmeye bir Bookmark ekler.
addEditor(emailAddress)DocumentBelirtilen kullanıcıyı Document için düzenleyiciler listesine ekler.
addEditor(user)DocumentBelirtilen kullanıcıyı Document için düzenleyiciler listesine ekler.
addEditors(emailAddresses)DocumentBelirtilen kullanıcı dizisini Document için düzenleyiciler listesine ekler.
addFooter()FooterSectionİlk sekmeye veya bir dokümana bağlı komut dosyaları için etkin sekmeye, yoksa altbilgi bölümü ekler.
addHeader()HeaderSectionMevcut değilse ilk sekmeye veya bir dokümana bağlı komut dosyaları için etkin sekmeye bir başlık bölümü ekler.
addNamedRange(name, range)NamedRangeİlk sekmeye veya bir dokümana bağlı komut dosyaları için etkin sekmeye, daha sonra almak için kullanılacak bir ad ve kimliğe sahip bir Range olan bir NamedRange ekler.
addViewer(emailAddress)DocumentBelirtilen kullanıcıyı Document için izleyiciler listesine ekler.
addViewer(user)DocumentBelirtilen kullanıcıyı Document için izleyiciler listesine ekler.
addViewers(emailAddresses)DocumentBelirtilen kullanıcı dizisini Document için izleyici listesine ekler.
getActiveTab()TabKullanıcının dokümanda şu anda etkin olan Tab öğesini alır.
getAs(contentType)BlobMevcut Document içeriğini, belirtilen türde bir blob olarak alır.
getBlob()BlobMevcut Document içeriğini bir blob olarak alır.
getBody()Bodyİlk sekmenin Body değerini veya bir dokümana bağlı komut dosyaları için etkin sekmenin DocumentBodySection değerini alır.
getBookmark(id)Bookmarkİlk sekmede veya bir dokümana bağlı komut dosyalarında etkin sekmede belirtilen kimliğe sahip Bookmark öğesini alır.
getBookmarks()Bookmark[]İlk sekmedeki veya bir dokümana bağlı komut dosyalarında etkin sekmedeki tüm Bookmark nesnelerini alır.
getCursor()PositionEtkin sekmedeki kullanıcının imlecinin konumunu alır.
getEditors()User[]Bu Document için düzenleyenlerin listesini alır.
getFooter()FooterSectionİlk sekmenin altbilgi bölümünü veya bir dokümana bağlı komut dosyaları için etkin sekmenin altbilgi bölümünü alır.
getFootnotes()Footnote[]İlk sekmenin gövdesinde veya bir dokümana bağlı komut dosyalarında etkin sekmenin gövdesinde bulunan tüm Footnote öğelerini alır.
getHeader()HeaderSectionİlk sekmenin üstbilgi bölümünü veya bir dokümana bağlı komut dosyaları için etkin sekmenin üstbilgi bölümünü alır.
getId()StringBelgenin benzersiz tanımlayıcısını alır.
getLanguage()StringDokümanın dil kodunu alır.
getName()StringDokümanın başlığını alır.
getNamedRangeById(id)NamedRangeİlk sekmede veya bir dokümana bağlı komut dosyalarında etkin sekmede belirtilen kimliğe sahip NamedRange öğesini alır.
getNamedRanges()NamedRange[]İlk sekmedeki veya bir dokümana bağlı komut dosyalarında etkin sekmedeki tüm NamedRange nesnelerini alır.
getNamedRanges(name)NamedRange[]İlk sekmede veya bir dokümana bağlı komut dosyalarında etkin sekmede, belirtilen ada sahip tüm NamedRange nesnelerini alır.
getSelection()RangeEtkin sekmede 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)TabBelirtilen kimliğe sahip Tab öğesini alır.
getTabs()Tab[]Belgenin parçası olan tüm iç içe yerleştirilmemiş Tab öğelerini 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)Positionİlk sekmedeki belirli bir öğeye veya bir dokümana bağlı komut dosyaları için etkin sekmeye göre sekmedeki bir konuma referans veren yeni bir Position oluşturur.
newRange()RangeBuilderİlk sekmedeki sekme öğelerinden veya bir dokümana bağlı komut dosyalarında etkin sekmeden Range nesneleri oluşturmak için 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 görüntüleyen ve yorum yapanlar listesinden kaldırır.
removeViewer(user)DocumentBelirtilen kullanıcıyı Document için görüntüleyen ve yorum yapanlar listesinden kaldırır.
saveAndClose()voidMevcut Document'yi kaydeder.
setActiveTab(tabId)voidKullanıcının geçerli dokümanda seçtiği Tab'yi, belirtilen kimliğe sahip sekmeye ayarlar.
setCursor(position)DocumentPosition verildiğinde kullanıcının imlecesini ayarlar.
setLanguage(languageCode)DocumentDokümanın dil kodunu ayarlar.
setName(name)DocumentDoküman başlığını belirler.
setSelection(range)DocumentRange verildiğinde kullanıcının etkin sekmedeki seçimini belirler.

Ayrıntılı dokümanlar

addBookmark(position)

Belirtilen Position konumuna ilk sekmeye veya bir dokümana bağlı komut dosyalarında etkin sekmeye bir 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ı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

addEditor(emailAddress)

Belirtilen kullanıcıyı Document için düzenleyiciler listesine ekler. Kullanıcı zaten izleyici listesindeyse bu yöntem, kullanıcıyı izleyici listesinden çıkarır.

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ı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

addEditor(user)

Belirtilen kullanıcıyı Document için düzenleyiciler listesine ekler. Kullanıcı zaten izleyici listesindeyse bu yöntem, kullanıcıyı izleyici listesinden çıkarır.

Parametreler

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

Return

Document: Zincirleme için bu Document.

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

addEditors(emailAddresses)

Belirtilen kullanıcı dizisini Document için düzenleyiciler listesine ekler. Kullanıcılardan herhangi biri zaten izleyici listesindeyse bu yöntem, kullanıcıları izleyici listesinden çıkarır.

Parametreler

AdTürAçıklama
emailAddressesString[]Eklenecek kullanıcıların e-posta adresleri dizisi.

Return

Document: Zincirleme için bu Document.

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

addFooter()

İlk sekmeye veya bir dokümana bağlı komut dosyaları için etkin sekmeye, yoksa 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ı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

addHeader()

Mevcut değilse ilk sekmeye veya bir dokümana bağlı komut dosyaları için etkin sekmeye bir başlık bölümü ekler. Herhangi bir sekmeye başlık 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ı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

addNamedRange(name, range)

İlk sekmeye veya bir dokümana bağlı komut dosyaları için etkin sekmeye, daha sonra almak için kullanılacak bir ad ve kimliğe sahip bir Range olan bir NamedRange ekler. Herhangi bir sekmeye NamedRange eklemek için DocumentTab.addNamedRange(name, range) yöntemini kullanın. Adlar her zaman benzersiz değildir. Aynı dokümanda birden fazla farklı aralık aynı adı paylaşabilir. Bu durum, HTML'deki sınıflara benzer. Buna karşılık, kimlikler HTML'deki kimlikler gibi belge içinde benzersizdir. Bir dokümana NamedRange ekledikten sonra bu öğeyi değiştiremez, yalnızca kaldırabilirsiniz.

Belgeye erişen tüm komut dosyaları NamedRange'e erişebilir. Komut dosyaları arasında istenmeyen çakışmaları önlemek için aralık adlarına benzersiz bir dize ön ekleyerek başlayabilirsiniz. 

// 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 uzunluğunda olmalıdır.
rangeRangeAdla ilişkilendirilecek öğe aralığı; aralık etkin seçim, arama sonucu veya newRange() ile manuel olarak oluşturulabilir.

Return

NamedRange: NamedRange.

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

addViewer(emailAddress)

Belirtilen kullanıcıyı Document için izleyiciler listesine ekler. Kullanıcı zaten düzenleyiciler 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ı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

addViewer(user)

Belirtilen kullanıcıyı Document için izleyiciler listesine ekler. Kullanıcı zaten düzenleyiciler 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ı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

addViewers(emailAddresses)

Belirtilen kullanıcı dizisini Document için izleyici listesine ekler. Kullanıcılardan herhangi biri zaten düzenleyiciler listesindeyse bu yöntemin bu kullanıcılar üzerinde herhangi bir etkisi olmaz.

Parametreler

AdTürAçıklama
emailAddressesString[]Eklenecek kullanıcıların e-posta adresleri dizisi.

Return

Document: Zincirleme için bu Document.

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

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 bu da komut dosyası dokümana bağlıysa geçerli olur. 

// 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: Kullanıcının şu anda etkin Tab veya komut dosyası belgeye bağlı değilse null değeridir.

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

getAs(contentType)

Mevcut Document içeriğini, belirtilen türde bir 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, blob olarak.

getBlob()

Mevcut Document içeriğini bir 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, blob olarak.

getBody()

İlk sekmenin Body değerini veya bir dokümana bağlı 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ı bölüm türleri (ör. HeaderSection, FooterSection) içerebilir. Sekmenin etkin bölümü Body'dir.

Document öğe yöntemleri, etkin Body öğesine yetki verir. 

// 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övde bölümü.

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

getBookmark(id)

İlk sekmede veya bir dokümana bağlı komut dosyalarında etkin sekmede belirtilen kimliğe sahip Bookmark öğesini alır. Herhangi bir sekmede yer işareti almak için DocumentTab.getBookmark(id) yöntemini kullanın. Sekmede böyle bir Bookmark yoksa bu yöntem null 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 öğesinin kimliği.

Return

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

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

getBookmarks()

İlk sekmedeki veya bir dokümana bağlı komut dosyalarında etkin sekmedeki tüm Bookmark nesnelerini 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ı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

getCursor()

Etkin sekmedeki kullanıcının imlecinin konumunu alır. Bir komut dosyası yalnızca komut dosyasını çalıştıran kullanıcının imlecine erişebilir ve bu da yalnızca komut dosyası dokümana bağlıysa geçerlidir. 

// 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: Kullanıcının imlecini temsil eder. Kullanıcının sekmede imleci yoksa veya komut dosyası dokümana bağlı değilse null gösterilir.

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

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ı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

getFooter()

İlk sekmenin altbilgi bölümünü veya bir dokümana bağlı 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: Sekmenin altbilgisi.

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

getFootnotes()

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

getFootnotes çağrıları, sekmenin öğeleri üzerinde iterasyona neden olur. Büyük sekmeler için bu yöntemi gereksiz yere çağırmayı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ı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

getHeader()

İlk sekmenin üstbilgi bölümünü veya bir dokümana bağlı komut dosyaları için etkin sekmenin üstbilgi 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: Sekmenin başlığı.

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

getId()

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

Return

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

getLanguage()

Dokümanın dil kodunu alır. Bu, doküman düzenleyicisinin Dosya > Dil bölümünde gösterilen dildir ve dokümanın gerçek dili olmayabilir.

Return

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

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

getName()

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

Return

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

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

getNamedRangeById(id)

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

Parametreler

AdTürAçıklama
idStringAralıktaki benzersiz kimlik.

Return

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

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

getNamedRanges()

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

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

Return

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

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

getNamedRanges(name)

İlk sekmede veya bir dokümana bağlı komut dosyalarında etkin sekmede, belirtilen ada sahip tüm NamedRange nesnelerini 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 olmak zorunda değildir. Aynı sekmedeki birkaç farklı aralık, HTML'deki bir sınıfa benzer şekilde aynı adı paylaşabilir. Buna karşılık, kimlikler HTML'deki kimlikler gibi sekme içinde benzersizdir.

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

Parametreler

AdTürAçıklama
nameStringAralık adı (benzersiz olmayabilir).

Return

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

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

getSelection()

Etkin sekmede 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 bu da yalnızca komut dosyası dokümana bağlıysa geçerlidir. 

// 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: Kullanıcının seçimini temsil eder. Sekmede seçili bir öğe yoksa, yalnızca bir paragrafın sonu seçiliyse, yalnızca bir paragrafın sonu ve yeni bir satır seçiliyse veya komut dosyası dokümana bağlı değilse null değerini alır.

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

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ı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

getTab(tabId)

Belirtilen kimliğe sahip Tab öğesini alır. Böyle bir Tab yoksa bu yöntem null değerini döndürür. Sekmelere herhangi bir iç içe yerleştirme düzeyinde erişebilir.

Parametreler

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

Return

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

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

getTabs()

Belgenin parçası olan tüm iç içe yerleştirilmemiş Tab öğelerini alır.

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

Return

Tab[]: Belgenin parçası olan tüm Tab öğelerinin listesi.

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

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ı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

getViewers()

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

Return

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

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

newPosition(element, offset)

İlk sekmedeki belirli bir öğeye veya bir dokümana bağlı komut dosyaları için etkin sekmeye göre sekmedeki bir konuma referans veren yeni bir Position oluşturur. Herhangi bir sekmedeki bir 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, bir Text öğesi veya Paragraph gibi bir kapsayıcı öğe olmalıdır.
offsetIntegerText öğeleri için Position'den önceki karakter sayısı, diğer öğeler için ise aynı kapsayıcı öğe içinde Position'den önceki alt öğe sayısı.

Return

Position: Yeni Position.

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

newRange()

İlk sekmedeki sekme öğelerinden veya bir dokümana bağlı komut dosyalarında etkin sekmeden Range nesneleri oluşturmak için 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 istiyorsanız 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 oluşturucu.

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

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 olan kullanıcıların Document'e erişimini engellemez. Örneğin, Document kullanıcının alanının tamamıyla paylaşılıyorsa veya Document, kullanıcının erişebildiği bir ortak Drive'da bulunuyorsa.

Drive dosyaları için bu işlem, kullanıcıyı görüntüleyen kullanıcılar 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ı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

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 olan kullanıcıların Document'e erişimini engellemez. Örneğin, Document kullanıcının alanının tamamıyla paylaşılıyorsa veya Document, kullanıcının erişebildiği bir ortak Drive'da bulunuyorsa.

Drive dosyaları için bu işlem, kullanıcıyı görüntüleyen kullanıcılar 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ı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

removeViewer(emailAddress)

Belirtilen kullanıcıyı Document için görüntüleyen ve yorum yapanlar listesinden kaldırır. Kullanıcı izleyici veya yorumcu değilse bu yöntemin hiçbir etkisi yoktur. Bu yöntem, genel erişime sahip bir kullanıcı sınıfına ait kullanıcıların Document'e erişmesini de engellemez. Örneğin, Document kullanıcının alanının tamamıyla paylaşılıyorsa veya Document kullanıcının erişebildiği bir ortak Drive'da bulunuyorsa.

Drive dosyaları için bu işlem, kullanıcıyı düzenleyiciler 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ı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

removeViewer(user)

Belirtilen kullanıcıyı Document için görüntüleyen ve yorum yapanlar listesinden kaldırır. Kullanıcı izleyici değil de düzenleyiciyse bu yöntemin hiçbir etkisi olmaz. Bu yöntem, genel erişime sahip bir kullanıcı sınıfına ait kullanıcıların Document'e 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şebildiği bir ortak Drive'da bulunuyorsa.

Drive dosyaları için bu işlem, kullanıcıyı düzenleyiciler 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ı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

saveAndClose()

Mevcut Document'yi kaydeder. Beklemedeki güncellemelerin temizlenmesine ve uygulanmasına neden olur.

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

Kapalı 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ı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

setActiveTab(tabId)

Kullanıcının geçerli dokümanda seçtiği Tab'yi, 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ı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

setCursor(position)

Position verildiğinde kullanıcının imlecesini ayarlar. Komut dosyaları yalnızca komut dosyasını çalıştıran kullanıcının imlecine erişebilir ve bu da yalnızca komut dosyası dokümana bağlıysa geçerlidir.

Etkin olmayan bir Tab'ten Position gönderdiğinizde kullanıcının etkin sekmesi değişir. 

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ı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

setLanguage(languageCode)

Dokümanın dil kodunu ayarlar. Bu, doküman düzenleyicisinin Dosya > Dil bölümünde gösterilen dildir ve dokümanın gerçek dili olmayabilir. Geçerli tüm dil kodlarını almak için getSupportedLanguageCodes() değerini kullanın.

Parametreler

AdTürAçıklama
languageCodeStringDil kodu.

Return

Document: Zincirleme için bu Document.

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

setName(name)

Doküman başlığını belirler.

Parametreler

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

Return

Document: Geçerli doküman.

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

setSelection(range)

Range verildiğinde kullanıcının etkin sekmedeki seçimini belirler. 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. 

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ı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