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 Document 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, get) kullanan komut dosyaları, get ve ardından Tab.asDocumentTab() kullanarak sekmeleri destekleyecek şekilde taşınabilir.
Yöntemler
| Yöntem | Dönüş türü | Kısa açıklama |
|---|---|---|
add | Bookmark | Belirtilen Position konumuna ilk sekmeye veya bir dokümana bağlı komut dosyaları için etkin sekmeye Bookmark ekler. |
add | Document | Belirtilen kullanıcıyı Document için düzenleyenler listesine ekler. |
add | Document | Belirtilen kullanıcıyı Document için düzenleyenler listesine ekler. |
add | Document | Belirtilen kullanıcı dizisini Document için düzenleyenler listesine ekler. |
add | Footer | İlk sekmeye veya bir dokümana bağlı olan komut dosyaları için etkin sekmeye, henüz yoksa bir altbilgi bölümü ekler. |
add | Header | İlk sekmeye veya dokümana bağlı komut dosyaları için etkin sekmeye, yoksa bir başlık bölümü ekler. |
add | Named | İ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 Named ekler. |
add | Document | Belirtilen kullanıcıyı Document için görüntüleyiciler listesine ekler. |
add | Document | Belirtilen kullanıcıyı Document için görüntüleyiciler listesine ekler. |
add | Document | Belirtilen kullanıcı dizisini Document için görüntüleyiciler listesine ekler. |
get | Tab | Kullanıcının dokümanda şu anda etkin olan Tab öğesini alır. |
get | Blob | Mevcut Document içeriğini belirtilen türde bir blob olarak alır. |
get | Blob | Mevcut Document içeriğini blob olarak alır. |
get | Body | İlk sekmenin Body değerini veya bir dokümana bağlı olan komut dosyaları için etkin sekmenin Document değerini alır. |
get | Bookmark|null | İlk sekmede veya bir belgeye bağlı komut dosyaları için etkin sekmede, verilen kimliğe sahip Bookmark öğesini alır. |
get | Bookmark[] | İlk sekmedeki tüm Bookmark nesnelerini veya bir dokümana bağlı olan komut dosyaları için etkin sekmeyi alır. |
get | Position|null | Etkin sekmedeki kullanıcının imlecini alır. |
get | User[] | Bu Document için düzenleyenlerin listesini alır. |
get | Footer | İ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. |
get | Footnote[]|null | İ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. |
get | Header | İ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. |
get | String | Dokümanın benzersiz tanımlayıcısını alır. |
get | String | Dokümanın dil kodunu alır. |
get | String | Dokümanın başlığını alır. |
get | Named | İlk sekmede veya bir belgeye bağlı komut dosyaları için etkin sekmede, verilen kimliğe sahip Named öğesini alır. |
get | Named | İlk sekmedeki tüm Named nesnelerini veya bir dokümana bağlı olan komut dosyaları için etkin sekmeyi alır. |
get | Named | İlk sekmede veya bir dokümana bağlı olan komut dosyaları için etkin sekmede, verilen ada sahip tüm Named nesnelerini alır. |
get | Range|null | Etkin sekmedeki kullanıcının seçimini alır. |
get | String[] | Google Dokümanlar dosyalarında desteklenen tüm dil kodlarını alır. |
get | Tab | Belirtilen kimliğe sahip Tab öğesini alır. |
get | Tab[] | Belgenin parçası olan, iç içe yerleştirilmemiş tüm Tab'leri alır. |
get | String | Geçerli dokümana erişmek için URL'yi alır. |
get | User[] | Bu Document için görüntüleyenlerin ve yorumcuların listesini alır. |
new | Position | Sekmedeki bir konuma referans veren yeni bir Position oluşturur. Bu konum, ilk sekmedeki belirli bir öğeye veya bir belgeye bağlı komut dosyaları için etkin sekmeye göre belirlenir. |
new | Range | İlk sekmedeki sekme öğelerinden veya bir dokümana bağlı olan komut dosyaları için etkin sekmeden Range nesneleri oluşturmak üzere kullanılan bir oluşturucu oluşturur. |
remove | Document | Belirtilen kullanıcıyı Document için düzenleyenler listesinden kaldırır. |
remove | Document | Belirtilen kullanıcıyı Document için düzenleyenler listesinden kaldırır. |
remove | Document | Belirtilen kullanıcıyı Document için izleyici ve yorumcu listesinden kaldırır. |
remove | Document | Belirtilen kullanıcıyı Document için izleyici ve yorumcu listesinden kaldırır. |
save | void | Mevcut Document öğesini kaydeder. |
set | void | Kullanıcının geçerli dokümanda seçtiği Tab öğesini, belirtilen kimliğe sahip sekmeye ayarlar. |
set | Document | Position değeri verildiğinde kullanıcının imlecini ayarlar. |
set | Document | Belgenin dil kodunu ayarlar. |
set | Document | Doküman başlığını ayarlar. |
set | Document | Range değeri verildiğinde etkin sekmedeki kullanıcı seçimini ayarlar. |
Ayrıntılı belgeler
add Bookmark(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 Document 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
| Ad | Tür | Açıklama |
|---|---|---|
position | Position | Yeni 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
add Editor(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
| Ad | Tür | Açıklama |
|---|---|---|
email | String | Eklenecek kullanıcının e-posta adresi. |
Return
Document: 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
add Editor(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
| Ad | Tür | Açıklama |
|---|---|---|
user | User | Eklenecek kullanıcının temsili. |
Return
Document: 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
add Editors(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
| Ad | Tür | Açıklama |
|---|---|---|
email | String[] | Eklenecek kullanıcıların e-posta adreslerinden oluşan bir dizi. |
Return
Document: 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
add Header()
İ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 Document 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
Header: 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
add Named Range(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 Named ekler. Herhangi bir sekmeye Named eklemek için Document 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 Named ekledikten sonra bu simgeyi değiştiremezsiniz, yalnızca kaldırabilirsiniz.
Belgeye erişen tüm komut dosyaları Named öğesine erişebilir. Komut dosyaları arasında istenmeyen çakışmaları önlemek için aralık adlarına benzersiz bir dizeyle önek eklemeyi düşünebilirsiniz.
// 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
| Ad | Tür | Açıklama |
|---|---|---|
name | String | Aralığın adı. Benzersiz olması gerekmez. Aralık adları 1-256 karakter arasında olmalıdır. |
range | Range | Adla ilişkilendirilecek öğe aralığı. Aralık etkin seçim, arama sonucu olabilir veya new ile manuel olarak oluşturulabilir. |
Return
Named — Named.
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
add Viewer(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
| Ad | Tür | Açıklama |
|---|---|---|
email | String | Eklenecek kullanıcının e-posta adresi. |
Return
Document: 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
add Viewer(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
| Ad | Tür | Açıklama |
|---|---|---|
user | User | Eklenecek kullanıcının temsili. |
Return
Document: 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
add Viewers(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öntem söz konusu kullanıcılar için geçerli olmaz.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
email | String[] | Eklenecek kullanıcıların e-posta adreslerinden oluşan bir dizi. |
Return
Document: 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
get Active Tab()
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: 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
get As(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
| Ad | Tür | Açıklama |
|---|---|---|
content | String | Dönüştürülecek MIME türü; 'application/pdf' ve 'text/markdown' desteklenir. |
Return
Blob: Geçerli doküman blob olarak.
get Blob()
Mevcut 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('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.
get Body()
İlk sekmenin Body değerini veya bir dokümana bağlı olan komut dosyaları için etkin sekmenin Document değerini alır. Herhangi bir sekmenin Document değerini almak için Document yöntemini kullanın.
Sekmeler farklı türlerde bölümler (ör. Header, Footer) 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
get Bookmark(id)
İlk sekmede veya bir belgeye bağlı komut dosyaları için etkin sekmede, verilen kimliğe sahip Bookmark öğesini alır. Herhangi bir sekmede yer işareti almak için Document 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
| Ad | Tür | Açıklama |
|---|---|---|
id | String | Bookmark 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
get Bookmarks()
İ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 Document 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
get Cursor()
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
get Editors()
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
get Footnotes()
İ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 Document yöntemini kullanın.
get ç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[]|null: 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
get Header()
İ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 Document 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
Header: 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
get Id()
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 Document 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
get Language()
Dokümanın 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 kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Name()
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
get Named Range By Id(id)
İlk sekmede veya bir belgeye bağlı komut dosyaları için etkin sekmede, verilen kimliğe sahip Named öğesini alır. Herhangi bir sekmede belirli kimliğe sahip Named öğesini almak için Document yöntemini kullanın. Bu yöntem, sekmede böyle bir Named 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 sekme içinde benzersizdir (ör. HTML'deki bir kimlik).
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
id | String | Sekme içinde benzersiz olan aralığın kimliği. |
Return
Named: Belirtilen kimliğe sahip Named 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
get Named Ranges()
İlk sekmedeki tüm Named nesnelerini veya bir dokümana bağlı olan komut dosyaları için etkin sekmeyi alır. Herhangi bir sekmedeki tüm Named nesnelerini almak için Document yöntemini kullanın.
Bir Named, 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
Named: Sekmedeki Named 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
get Named Ranges(name)
İlk sekmede veya bir dokümana bağlı olan komut dosyaları için etkin sekmede, verilen ada sahip tüm Named nesnelerini alır. Herhangi bir sekmedeki tüm Named nesnelerini almak için Document 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 Named, 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
| Ad | Tür | Açıklama |
|---|---|---|
name | String | Aralığın adı (benzersiz olması gerekmez). |
Return
Named: Belirtilen ada sahip sekmedeki Named 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
get Selection()
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
get Supported Language Codes()
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
get Tab(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
| Ad | Tür | Açıklama |
|---|---|---|
tab | String | Alı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ı, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Tabs()
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
get Url()
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
get Viewers()
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
new Position(element, offset)
Sekmedeki bir konuma referans veren yeni bir Position oluşturur. Bu konum, ilk sekmedeki belirli bir öğeye veya bir belgeye bağlı komut dosyaları için etkin sekmeye göre belirlenir. Herhangi bir sekmedeki konuma göre Position oluşturmak için Document 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
| Ad | Tür | Açıklama |
|---|---|---|
element | Element | Yeni Position öğesini içermesi gereken öğe; bu, Text öğesi veya Paragraph gibi bir kapsayıcı öğe olmalıdır. |
offset | Integer | Text öğeleri için Position karakterinden önceki karakter sayısı; diğer öğeler için aynı kapsayıcı öğe içindeki Position öğesinden önceki 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
new Range()
İlk sekmedeki sekme öğelerinden veya bir dokümana bağlı olan komut dosyaları için etkin sekmeden Range nesneleri oluşturmak üzere kullanılan bir oluşturucu oluşturur. Herhangi bir sekmedeki sekme öğelerinden Document nesneleri oluşturmak için kullanılan bir oluşturucu oluşturmak üzere Document 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
Range: Yeni oluşturucu.
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
remove Editor(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
| Ad | Tür | Açıklama |
|---|---|---|
email | String | Kaldırılacak kullanıcının e-posta adresi. |
Return
Document: 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
remove Editor(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
| Ad | Tür | Açıklama |
|---|---|---|
user | User | Kaldırılacak kullanıcının temsili. |
Return
Document: 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
remove Viewer(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
| Ad | Tür | Açıklama |
|---|---|---|
email | String | Kaldı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
remove Viewer(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
| Ad | Tür | Açıklama |
|---|---|---|
user | User | Kaldı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
save And Close()
Mevcut Document öğesini kaydeder. Bekleyen güncellemelerin temizlenip uygulanmasına neden olur.
save yöntemi, her açık düzenlenebilir Document için komut dosyası yürütme işleminin sonunda otomatik olarak çağrılır.
Kapatılan Document düzenlenemez. Belirli bir dokümanı düzenlemek için yeniden açmak üzere Document 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
set Active Tab(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
| Ad | Tür | Açıklama |
|---|---|---|
tab | String | Etkin 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
set Cursor(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 öğesinden 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
| Ad | Tür | Açıklama |
|---|---|---|
position | Position | Yeni imleç konumu. |
Return
Document: 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
set Language(languageCode)
Belgenin 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 get işlevini kullanın.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
language | String | Dil kodu. |
Return
Document: 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
set Name(name)
Doküman başlığını ayarlar.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
name | String | Yeni 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
set Selection(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
| Ad | Tür | Açıklama |
|---|---|---|
range | Range | Seçilecek yeni öğe aralığı. |
Return
Document: 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