Class Document

Doküman

Zengin metin ile tablo ve listeler gibi öğeler içeren bir doküman.

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

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

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

Yöntemler

YöntemDönüş türüKısa açıklama
addBookmark(position)BookmarkBelirtilen Position için bir Bookmark ekler.
addEditor(emailAddress)DocumentKullanıcıyı Document düzenleyici listesine ekler.
addEditor(user)DocumentKullanıcıyı Document düzenleyici listesine ekler.
addEditors(emailAddresses)DocumentBelirtilen kullanıcı dizisini, Document düzenleyicisi listesine ekler.
addFooter()FooterSectionDoküman altbilgisi bölümü (yoksa) ekler.
addHeader()HeaderSectionMevcut değilse bir doküman üstbilgisi bölümü ekler.
addNamedRange(name, range)NamedRangeBir NamedRange ekler. Bu öğe, daha sonra almak üzere kullanılacak bir ada ve kimliğe sahip bir Range olur.
addViewer(emailAddress)DocumentKullanıcıyı Document öğesini görüntüleyenler listesine ekler.
addViewer(user)DocumentKullanıcıyı Document öğesini görüntüleyenler listesine ekler.
addViewers(emailAddresses)DocumentBelirtilen kullanıcı dizisini, Document için görüntüleyen listesine ekler.
getAs(contentType)BlobGeçerli Document içeriğini belirtilen türde bir blob olarak alır.
getBlob()BlobGeçerli Document içeriğini blob olarak alır.
getBody()BodyEtkin dokümanın Body öğesini alır.
getBookmark(id)BookmarkVerilen kimliğe sahip Bookmark öğesini alır.
getBookmarks()Bookmark[]Dokümandaki tüm Bookmark nesnelerini alır.
getCursor()PositionEtkin dokümanda kullanıcının imlecini getirir.
getEditors()User[]Bu Document için düzenleyenlerin listesini alır.
getFooter()FooterSectionVarsa, dokümanın altbilgi bölümünü alır.
getFootnotes()Footnote[]Doküman gövdesindeki tüm Footnote öğelerini alır.
getHeader()HeaderSectionVarsa dokümanın üstbilgi bölümünü alır.
getId()StringDokümanın benzersiz tanımlayıcısını alır.
getLanguage()StringBelgenin dil kodunu alır.
getName()StringDokümanın başlığını getirir.
getNamedRangeById(id)NamedRangeVerilen kimliğe sahip NamedRange öğesini alır.
getNamedRanges()NamedRange[]Dokümandaki tüm NamedRange nesnelerini alır.
getNamedRanges(name)NamedRange[]Belgede belirtilen ada sahip tüm NamedRange nesnelerini alır.
getSelection()RangeEtkin dokümanda kullanıcının seçimini alır.
getSupportedLanguageCodes()String[]Google Dokümanlar dosyalarında desteklenen tüm dil kodlarını 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 yorum yapanların listesini alır.
newPosition(element, offset)PositionDokümandaki bir konuma ilişkin belirli bir öğeye göre yeni bir Position oluşturur.
newRange()RangeBuilderDoküman öğelerinden Range nesneleri oluşturmak için kullanılan bir derleyici oluşturur.
removeEditor(emailAddress)DocumentKullanıcıyı, Document düzenleyici listesinden kaldırır.
removeEditor(user)DocumentKullanıcıyı, Document düzenleyici listesinden kaldırır.
removeViewer(emailAddress)Documentİlgili kullanıcıyı, Document için görüntüleyenler ve yorum yapanlar listesinden kaldırır.
removeViewer(user)Documentİlgili kullanıcıyı, Document için görüntüleyenler ve yorum yapanlar listesinden kaldırır.
saveAndClose()voidGeçerli Document öğesini kaydeder.
setCursor(position)DocumentBelirli bir Position verildiğinde kullanıcının imlecini etkin dokümanda ayarlar.
setLanguage(languageCode)DocumentDokümanın dil kodunu ayarlar.
setName(name)DocumentDoküman başlığını ayarlar.
setSelection(range)DocumentBelirli bir Range değerine sahip olarak kullanıcının etkin dokümanda yaptığı seçimi ayarlar.

Ayrıntılı belgeler

addBookmark(position)

Belirtilen Position için bir Bookmark ekler. 

// 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('abc123456');

// Gets the document 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 kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

addEditor(emailAddress)

Kullanıcıyı Document düzenleyici listesine ekler. Kullanıcı zaten görüntüleyen listesindeyse bu yöntem kullanıcıyı görüntüleyen listesinin dışına çıkarır.

Parametreler

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

Return

Document — Bu Document, zincirleme bağlantı için.

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

addEditor(user)

Kullanıcıyı Document düzenleyici listesine ekler. Kullanıcı zaten görüntüleyen listesindeyse bu yöntem kullanıcıyı görüntüleyen listesinin dışına çıkarır.

Parametreler

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

Return

Document — Bu Document, zincirleme bağlantı için.

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

addEditors(emailAddresses)

Belirtilen kullanıcı dizisini, Document düzenleyicisi listesine ekler. Kullanıcılardan biri zaten görüntüleyen listesindeyse bu yöntem, söz konusu kullanıcıları görüntüleyen listesinin dışına çıkarır.

Parametreler

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

Return

Document — Bu Document, zincirleme bağlantı için.

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

addFooter()

Doküman altbilgisi bölümü (yoksa) ekler. 

// 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('abc123456');

// Adds a footer to the document.
const footer = doc.addFooter();

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

Return

FooterSection: Doküman altbilgisi.

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

addHeader()

Mevcut değilse bir doküman üstbilgisi bölümü ekler. 

// 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('abc123456');

// Adds a header to the document.
const header = doc.addHeader();

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

Return

HeaderSection: Doküman üstbilgisi.

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

addNamedRange(name, range)

Bir NamedRange ekler. Bu öğe, daha sonra almak üzere kullanılacak bir ada ve kimliğe sahip bir Range olur. Adlar benzersiz değildir. HTML'deki bir sınıf gibi, aynı dokümandaki birkaç farklı aralık aynı adı paylaşabilir. Buna karşın kimlikler, HTML'deki kimlikler gibi doküman içinde benzersizdir. Bir dokümana NamedRange ekledikten sonra bu öğeyi değiştiremez, ancak kaldırabilirsiniz.

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

// Creates a named range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
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 veya arama sonucu olabilir ya da newRange() ile manuel olarak oluşturulmuş olabilir.

Return

NamedRange — NamedRange.

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

addViewer(emailAddress)

Kullanıcıyı Document öğesini görüntüleyenler listesine ekler. Kullanıcı zaten düzenleyenler listesindeyse bu yöntemin herhangi bir etkisi olmaz.

Parametreler

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

Return

Document — Bu Document, zincirleme bağlantı için.

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

addViewer(user)

Kullanıcıyı Document öğesini görüntüleyenler listesine ekler. Kullanıcı zaten düzenleyenler listesindeyse bu yöntemin herhangi bir etkisi olmaz.

Parametreler

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

Return

Document — Bu Document, zincirleme bağlantı için.

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

addViewers(emailAddresses)

Belirtilen kullanıcı dizisini, Document için görüntüleyen listesine ekler. Kullanıcılardan biri zaten düzenleyen listesindeyse bu yöntemin o kullanıcılar için bir etkisi yoktur.

Parametreler

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

Return

Document — Bu Document, zincirleme bağlantı için.

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

getAs(contentType)

Geçerli 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('abc123456');

// 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ü; şu anda yalnızca 'application/pdf' desteklenmektedir.

Return

Blob: Blob olarak geçerli doküman.

getBlob()

Geçerli Document içeriğini 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('abc123456');

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

Return

Blob: Blob olarak geçerli doküman.

getBody()

Etkin dokümanın Body öğesini alır.

Dokümanlar farklı türlerde bölümler (ör. HeaderSection, FooterSection) içerebilir. Bir dokümanın etkin bölümü Body'dir.

Document içindeki öğ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('abc123456');

// Gets the document body.
const body = doc.getBody();

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

Return

Body — Etkin doküman gövdesi bölümü.

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

getBookmark(id)

Verilen kimliğe sahip Bookmark öğesini alır. Böyle bir Bookmark yoksa bu yöntem 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('abc123456');

// Gets the bookmark by its ID.
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 böyle bir Bookmark yoksa null.

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

getBookmarks()

Dokümandaki tüm Bookmark nesnelerini 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.
const doc = DocumentApp.openById('abc123456');

// Gets all of the bookmarks in the document.
const bookmarks = doc.getBookmarks();

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

Return

Bookmark[]: Dokümandaki Bookmark nesnelerinden oluşan bir dizi.

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

getCursor()

Etkin dokümanda kullanıcının imlecini getirir. Bir komut dosyası yalnızca komut dosyasını çalıştıran kullanıcının imlecine erişebilir ve komut dosyasının dokümana bağlı olması gerekir. 

// Insert some text at the cursor position and make it bold.
var 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.
  var 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 imlecinin temsili veya kullanıcı dokümanda imleç yoksa ya da komut dosyası dokümana bağlı değilse null.

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

getEditors()

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

Return

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

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

getFooter()

Varsa, dokümanın altbilgi bölümünü 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('abc123456');

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

Return

FooterSection: Doküman altbilgisi.

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

getFootnotes()

Doküman gövdesindeki tüm Footnote öğelerini alır.

getFootnotes çağrıları, dokümanın öğeleri üzerinde yinelemeye neden olur. Büyük belgelerde 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('abc123456');

// Gets the first footnote.
const footnote = doc.getFootnotes()[0];

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

Return

Footnote[]: Doküman dipnotları.

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

getHeader()

Varsa dokümanın üstbilgi bölümünü 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('abc123456');

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

Return

HeaderSection: Doküman üstbilgisi.

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

getId()

Dokümanın 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 kullanılır.

Return

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

getLanguage()

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

Return

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

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

getName()

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

Return

String — doküman başlığı

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

getNamedRangeById(id)

Verilen kimliğe sahip NamedRange öğesini alır. Böyle bir NamedRange yoksa bu yöntem null değerini döndürür. Adlar benzersiz değildir. HTML'deki bir sınıfa benzer şekilde, aynı dokümandaki birkaç farklı aralık aynı adı paylaşabilir. Buna karşın kimlikler, HTML'deki kimlikler gibi doküman içinde benzersizdir.

Parametreler

AdTürAçıklama
idStringaralık kimliği (dokümanda benzersizdir)

Return

NamedRange: Verilen kimliğe sahip NamedRange veya bu tür bir aralık yoksa null

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

getNamedRanges()

Dokümandaki tüm NamedRange nesnelerini alır.

Bir NamedRange öğesine, dokümana erişen herhangi bir komut dosyası tarafından erişilebilir. Komut dosyaları arasında istenmeyen çakışmaları önlemek için aralık adlarına benzersiz bir dize eklemeyi düşünün.

Return

NamedRange[] : Muhtemelen aynı ada sahip birden fazla aralık içeren, belgedeki NamedRange nesnelerinden oluşan dizi

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

getNamedRanges(name)

Belgede belirtilen ada sahip tüm NamedRange nesnelerini alır. Adlar mutlaka benzersiz değildir; HTML'deki bir sınıfa benzer şekilde, aynı dokümandaki birkaç farklı aralık aynı adı paylaşabilir. Buna karşın kimlikler, HTML'deki kimlikler gibi doküman içinde benzersizdir.

Bir NamedRange öğesine, dokümana erişen herhangi bir komut dosyası tarafından erişilebilir. Komut dosyaları arasında istenmeyen çakışmaları önlemek için aralık adlarına benzersiz bir dize eklemeyi düşünün.

Parametreler

AdTürAçıklama
nameStringaralığın adıdır. Bu adın benzersiz olması gerekmez

Return

NamedRange[] - belgedeki belirtilen ada sahip NamedRange nesnelerinden oluşan dizi

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

getSelection()

Etkin dokümanda 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 komut dosyasının dokümana bağlı olması gerekir. 

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

Return

Range: Kullanıcı seçiminin temsili; kullanıcı dokümanda hiçbir şey seçmediyse, bir paragrafın yalnızca sonu seçilmişse, yalnızca bir paragrafın sonu ve yeni bir satır seçilmişse veya komut dosyası dokümana bağlı değilse null.

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

getSupportedLanguageCodes()

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

Return

String[]: Dil kodları dizisidir.

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

getUrl()

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

var 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ılacak URL

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

getViewers()

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

Return

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

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

newPosition(element, offset)

Dokümandaki bir konuma ilişkin belirli bir öğeye göre yeni bir Position oluşturur. Kullanıcının imleci, diğer kullanımların yanı sıra Position olarak gösterilir. 

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

Parametreler

AdTürAçıklama
elementElementyeni Position öğesini içerecek öğe; bu bir Text öğesi veya Paragraph gibi bir kapsayıcı öğe olmalıdır
offsetIntegerText öğeleri için Position işaretinden önceki karakter sayısı; diğer öğeler için aynı kapsayıcı öğesinde Position karakterinden önceki alt öğelerin sayısı

Return

Position - yeni Position

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

newRange()

Doküman öğelerinden Range nesneleri oluşturmak için kullanılan bir derleyici oluşturur. 

// Change the user's selection to a range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var 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 kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

removeEditor(emailAddress)

Kullanıcıyı, Document düzenleyici listesinden kaldırır. Genel erişime sahip bir kullanıcı sınıfına ait olan (örneğin, Document, kullanıcının tüm alan adıyla paylaşılıyorsa veya Document, kullanıcının erişebildiği bir ortak Drive'da yer alıyorsa) bu yöntem, kullanıcıların Document ürününe erişmesini engellemez.

Bu işlem, Drive dosyalarını 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 — Bu Document, zincirleme bağlantı için.

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

removeEditor(user)

Kullanıcıyı, Document düzenleyici listesinden kaldırır. Genel erişime sahip bir kullanıcı sınıfına ait olan (örneğin, Document, kullanıcının tüm alan adıyla paylaşılıyorsa veya Document, kullanıcının erişebildiği bir ortak Drive'da yer alıyorsa) bu yöntem, kullanıcıların Document ürününe erişmesini engellemez.

Bu işlem, Drive dosyalarını görüntüleyenler listesinden de kaldırır.

Parametreler

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

Return

Document — Bu Document, zincirleme bağlantı için.

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

removeViewer(emailAddress)

İlgili kullanıcıyı, Document için görüntüleyenler ve yorum yapanlar listesinden kaldırır. Kullanıcı düzenleyen veya görüntüleyen ya da yorumcu değilse bu yöntemin herhangi bir etkisi yoktur. Ayrıca, Document, kullanıcının tüm alanıyla paylaşılıyorsa veya Document kullanıcının erişebildiği bir ortak Drive'da yer alıyorsa bu yöntem, genel erişime sahip bir kullanıcı sınıfında yer alan kullanıcıların Document öğesine erişimini de engellemez.

Bu işlem, Drive dosyalarında 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 — Zincirleme için bu Document.

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

removeViewer(user)

İlgili kullanıcıyı, Document için görüntüleyenler ve yorum yapanlar listesinden kaldırır. Kullanıcı görüntüleyen değil düzenleyense bu yöntemin herhangi bir etkisi yoktur. Ayrıca, Document kullanıcının tüm alanıyla paylaşılıyorsa veya Document kullanıcının erişebildiği bir ortak Drive'da bulunuyorsa bu yöntem, genel erişime sahip bir kullanıcı sınıfında bulunan kullanıcıların Document öğesine erişimini de engellemez.

Bu işlem, Drive dosyalarında kullanıcıyı düzenleyenler 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 kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

saveAndClose()

Geçerli Document öğesini kaydeder. Bekleyen güncellemelerin temizlenmesine ve uygulanmasına neden olur.

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

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

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

setCursor(position)

Belirli bir Position verildiğinde kullanıcının imlecini etkin dokümanda ayarlar. Bir komut dosyası, yalnızca komut dosyasını çalıştıran kullanıcının imlecine erişebilir ve komut dosyasının dokümana bağlı olması gerekir. 

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

Parametreler

AdTürAçıklama
positionPositionyeni imlecin konumu

Return

Document — bu Document, zincirleme bağlantı için

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

setLanguage(languageCode)

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

Parametreler

AdTürAçıklama
languageCodeStringDil kodu.

Return

Document — Bu Document, zincirleme bağlantı için.

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

setName(name)

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

Parametreler

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

Return

Document — mevcut doküman

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

setSelection(range)

Belirli bir Range değerine sahip olarak kullanıcının etkin dokümanda yaptığı seçimi ayarlar. Bir komut dosyası yalnızca komut dosyasını çalıştıran kullanıcının seçimine erişebilir ve komut dosyasının dokümana bağlı olması gerekir. 

// Change the user's selection to a range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var 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 — bu Document, zincirleme bağlantı için

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