Her biri zengin metin ve resim içeren en az bir Tab
nesne içeren dokümanlar
öğe ekleyin.
Dokümanlar DocumentApp
kullanılarak 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");
Document
sınıfında, metin içeriğine doğrudan erişen ve değiştiren yöntemler üzerinde çalışır
etkin sekme (komut dosyalarında bağlı
belirli bir doküman) veya ilk sekmeye (etkin bir doküman yoksa) gidin. Komut dosyaları
bu yöntemler (örneğin, getBody()
), destek sekmelerine taşımak için
getTabs()
ve ardından Tab.asDocumentTab()
.
Yöntemler
Yöntem | Dönüş türü | Kısa açıklama |
---|---|---|
addBookmark(position) | Bookmark | Belirtilen Position için ilk sekmeye veyaBookmark
etkin sekmeye bağlıdır. |
addEditor(emailAddress) | Document | Belirtilen kullanıcıyı Document için düzenleyenler listesine ekler. |
addEditor(user) | Document | Belirtilen kullanıcıyı Document için düzenleyenler listesine ekler. |
addEditors(emailAddresses) | Document | Belirtilen kullanıcı dizisini, Document için düzenleyenler listesine ekler. |
addFooter() | FooterSection | İlk sekmeye veya bir dokümana bağlı komut dosyaları için etkin sekmeye (yoksa) bir altbilgi bölümü ekler. |
addHeader() | HeaderSection | İlk sekmeye veya bir dokümana bağlı komut dosyaları için etkin sekmeye (yoksa) bir üstbilgi bölümü ekler. |
addNamedRange(name, range) | NamedRange | Şunun için kullanılacak adı ve kimliği olan bir Range olan NamedRange ekler:
alınan komut dosyası, ilk sekmede veya bir dokümana bağlı komut dosyaları için etkin sekmede yer alır. |
addViewer(emailAddress) | Document | Belirtilen kullanıcıyı Document için görüntüleyenler listesine ekler. |
addViewer(user) | Document | Belirtilen kullanıcıyı Document için görüntüleyenler listesine ekler. |
addViewers(emailAddresses) | Document | Belirtilen kullanıcı dizisini, Document için görüntüleyenler listesine ekler. |
getActiveTab() | Tab | Kullanıcının dokümanda o anda etkin olan Tab bilgisini alır. |
getAs(contentType) | Blob | Geçerli Document içeriğini, belirtilen türde bir blob olarak alır. |
getBlob() | Blob | Geçerli Document içeriğini blob olarak alır. |
getBody() | Body | İlk sekmenin Body 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ı için etkin sekmede, belirtilen kimliğe sahip Bookmark öğesini alır. |
getBookmarks() | Bookmark[] | İlk sekmedeki veya bir dokümana bağlı komut dosyaları için etkin sekmedeki Bookmark nesnelerin tümünü alır. |
getCursor() | Position | Kullanıcının etkin sekmeye imlecini getirir. |
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 altbilgisini alır bölümüne bakın. |
getFootnotes() | Footnote[] | İlk sekmenin gövdesindeki veya bir dokümana bağlı komut dosyaları için etkin sekmenin gövdesindeki 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 başlığını alır bölümüne bakın. |
getId() | String | Dokümanın benzersiz tanımlayıcısını alır. |
getLanguage() | String | Belgenin dil kodunu alır. |
getName() | String | Dokümanın başlığını alır. |
getNamedRangeById(id) | NamedRange | İlk sekmede veya bir dokümana bağlı komut dosyaları için etkin sekmede, belirtilen kimliğe sahip NamedRange öğesini alır. |
getNamedRanges() | NamedRange[] | İlk sekmedeki veya bir dokümana bağlı komut dosyaları için etkin sekmedeki NamedRange nesnelerin tümünü alır. |
getNamedRanges(name) | NamedRange[] | İlk sekmede belirtilen ada sahip NamedRange nesnelerin tümünü alır veya
bir dokümana (etkin sekmeye) bağlı olmalıdır. |
getSelection() | Range | Etkin 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) | Tab | Belirtilen kimliğe sahip Tab öğesini alır. |
getTabs() | Tab[] | Dokümanın bir parçası olan, iç içe yerleştirilmemiş tüm Tab 'leri alır. |
getUrl() | String | Geç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 | Bir konuma göre sekmedeki bir konuma referans olan yeni bir Position oluşturur
ilk sekmedeki belirli bir öğe veya bir dokümana bağlı komut dosyaları için etkin sekme. |
newRange() | RangeBuilder | tablodaki sekme öğelerinden Range nesneleri oluşturmak için kullanılan bir oluşturucu oluşturur
bir komut dosyasına bağlı komut dosyaları için
doküman, etkin sekme. |
removeEditor(emailAddress) | Document | Belirtilen kullanıcıyı Document için düzenleyenler listesinden kaldırır. |
removeEditor(user) | Document | Belirtilen kullanıcıyı Document için düzenleyenler listesinden kaldırır. |
removeViewer(emailAddress) | Document | Belirtilen kullanıcıyı Document için görüntüleyenler ve yorumcular listesinden kaldırır. |
removeViewer(user) | Document | Belirtilen kullanıcıyı Document için görüntüleyenler ve yorumcular listesinden kaldırır. |
saveAndClose() | void | Geçerli Document öğesini kaydeder. |
setActiveTab(tabId) | void | Kullanıcının geçerli dokümandaki seçili Tab ayarını, belirtilen kimliğe sahip sekme olarak ayarlar. |
setCursor(position) | Document | Position verildiğinde kullanıcının imlecini ayarlar. |
setLanguage(languageCode) | Document | Dokümanın dil kodunu ayarlar. |
setName(name) | Document | Doküman başlığını ayarlar. |
setSelection(range) | Document | Range verildiğinde, etkin sekmedeki kullanıcı seçimini ayarlar. |
Ayrıntılı belgeler
addBookmark(position)
Belirtilen Position
için ilk sekmeye veyaBookmark
etkin sekmeye bağlıdır. Bir
yer işareti koyabilmek 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(DOCUMENT_ID); // 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 bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditor(emailAddress)
Belirtilen kullanıcıyı Document
için düzenleyenler listesine ekler. Kullanıcı zaten
bu yöntemle kullanıcıyı görüntüleyenler listesinden çıkarır.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
emailAddress | String | Eklenecek 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 kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditor(user)
Belirtilen kullanıcıyı Document
için düzenleyenler listesine ekler. Kullanıcı zaten
bu yöntemle kullanıcıyı görüntüleyenler listesinden çıkarır.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
user | User | Eklenecek kullanıcıyı gösteren bir temsil. |
Return
Document
— Bu Document
, zincirleme bağlantı için.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditors(emailAddresses)
Belirtilen kullanıcı dizisini, Document
için düzenleyenler listesine ekler.
İzleyici listesinde bulunan kullanıcılar, bu yöntem sayesinde diğer kullanıcılar tarafından
izleyiciler.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
emailAddresses | String[] | 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 kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addHeader()
İlk sekmeye veya bir dokümana bağlı komut dosyaları için etkin sekmeye (yoksa) bir üstbilgi bölümü ekler. Üstbilgi eklemek için
bölümünü herhangi bir sekmeye taşımak 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(DOCUMENT_ID); // Adds a header to the document's active or first tab. const header = doc.addHeader(); // Sets the header text to 'This is a header.' header.setText('This is a header');
Return
HeaderSection
: Sekme başlığı.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addNamedRange(name, range)
Şunun için kullanılacak adı ve kimliği olan bir Range
olan NamedRange
ekler:
alınan komut dosyası, ilk sekmede veya bir dokümana bağlı komut dosyaları için etkin sekmede yer alır. Herhangi bir sekmede NamedRange
eklemek için DocumentTab.addNamedRange(name, range)
yöntemini kullanın. Adlar
benzersiz olması gerekir. aynı doküman içinde birkaç farklı aralık aynı adı, çoğu zaman
dönüştürme işlemlerini yapabilirsiniz. Buna karşın kimlikler, doküman içindeki HTML'deki kimlikler gibi benzersizdir.
Bir dokümana NamedRange
ekledikten sonra bu öğeyi değiştiremezsiniz, yalnızca kaldırabilirsiniz.
Dokümana erişen tüm komut dosyaları NamedRange
öğesine erişebilir. İstenmeyen değişikliklerden kaçınmak için
komut dosyaları arasında çakışma varsa aralık adlarının önüne benzersiz bir dize ekleyebilirsiniz.
// Creates a named range that includes every table in the active tab. 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]); } // 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ık adı (benzersiz olması gerekmez); aralık adları şöyle olmalıdır: 1-256 karakter arasında. |
range | Range | Adla ilişkilendirilecek öğe aralığı; aralık, etkin seçim, bir arama sonucu veya newRange() ile manuel olarak oluşturulabilir. |
Return
NamedRange
— NamedRange
.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewer(emailAddress)
Belirtilen kullanıcıyı Document
için görüntüleyenler listesine ekler. Kullanıcı zaten
kullanıyorsanız bu yöntemin herhangi bir etkisi yoktur.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
emailAddress | String | Eklenecek 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 kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewer(user)
Belirtilen kullanıcıyı Document
için görüntüleyenler listesine ekler. Kullanıcı zaten
kullanıyorsanız bu yöntemin herhangi bir etkisi yoktur.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
user | User | Eklenecek kullanıcıyı gösteren bir temsil. |
Return
Document
— Bu Document
, zincirleme bağlantı için.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir 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üleyenler listesine ekler.
kullanıcı zaten düzenleyenler listesinde olduğundan bu yöntemin onlar için bir etkisi yoktur.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
emailAddresses | String[] | 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 kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getActiveTab()
Kullanıcının dokümanda o anda etkin olan Tab
bilgisini alır. Bir komut dosyası yalnızca
etkin sekmesinden ve yalnızca komut dosyası dokümana bağlıysa.
// 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ı bağlı değilse null
kontrol edebilirsiniz.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir 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(DOCUMENT_ID); // 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 |
---|---|---|
contentType | String | Dönüşümün gerçekleştirileceği MIME türü; 'application/pdf' ve 'text/markdown' desteklenir. |
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(DOCUMENT_ID); // 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()
İlk sekmenin Body
veya bir dokümana bağlı komut dosyaları için etkin sekmenin DocumentBodySection
değerini alır. Herhangi bir sekmenin DocumentBodySection
öğesini almak için DocumentTab.getBody()
yöntemini kullanın.
Sekmeler farklı türde bölümler içerebilir (örneğin, HeaderSection
, FooterSection
). Bir sekmenin etkin bölümü Body
şeklindedir.
Document
içindeki öğe yöntemleri, etkin Body
için 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(DOCUMENT_ID); // 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 bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBookmark(id)
İlk sekmede veya bir dokümana bağlı komut dosyaları için etkin sekmede, belirtilen kimliğe sahip Bookmark
öğesini alır. Bir
yer işareti eklemek için DocumentTab.getBookmark(id)
yöntemini kullanın. Sekmede 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(DOCUMENT_ID); // 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
— Verilen kimliğe sahip Bookmark
veya böyle bir Bookmark
yoksa null
var.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBookmarks()
İlk sekmedeki veya bir dokümana bağlı komut dosyaları için etkin sekmedeki Bookmark
nesnelerin tümünü alır. Tüm bildirimleri almak için
yer işaretlerini kullanmak 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(DOCUMENT_ID); // 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
nesnelerinden oluşan bir dizi.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getCursor()
Kullanıcının etkin sekmeye imlecini getirir. Bir komut dosyası yalnızca kullanıcının imlecine erişebilir. komut dosyasını çalıştırıyorsa ve yalnızca komut dosyası dokümana bağlıysa.
// 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 bir temsili veya kullanıcınınnull
imleç sekmenin içine yerleştirilmişse veya komut dosyası dokümana bağlı değilse kullanılabilir.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir 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 bir kullanıcı dizisi.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getFootnotes()
İlk sekmenin gövdesindeki veya bir dokümana bağlı komut dosyaları için etkin sekmenin gövdesindeki tüm Footnote
öğelerini alır. Şunları almak için:
herhangi bir sekmedeki tüm dipnotlar için DocumentTab.getFootnotes()
yöntemini kullanın.
getFootnotes
için yapılan çağrılar, sekmenin öğeleri üzerinde iterasyona neden olur. Büyük sekmelerde
bu yönteme yapılan 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(DOCUMENT_ID); // Gets the first footnote in the active or first tab's body. const footnote = doc.getFootnotes()[0]; // Logs footnote contents to the console. console.log(footnote.getFootnoteContents().getText());
Return
Footnote[]
— Sekmenin dipnotları.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
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 başlığını alır
bölümüne bakın. 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(DOCUMENT_ID); // 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ı, aşağıdaki kapsamlardan bir 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 kapsamlardan bir 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 Dosyasında gösterilen dildir > Dil'i seçin.
Return
String
— Belge dili. Tanımlanmamışsa null
.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getName()
Dokümanın başlığını alır.
Return
String
— Dokümanın başlığı.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRangeById(id)
İlk sekmede veya bir dokümana bağlı komut dosyaları için etkin sekmede, belirtilen kimliğe sahip NamedRange
öğesini alır. To almak için
Herhangi bir sekmede belirtilen kimlikle NamedRange
için DocumentTab.getNamedRangeById(id)
kullanın
yöntemidir. Sekmede böyle bir NamedRange
yoksa bu yöntem null
değerini döndürür. İsimler
farklı sekmeler arasında bile benzersiz değildir; aynı sekmede birkaç farklı aralık,
aynı adı paylaşan, HTML'deki bir sınıfa benzer. Buna karşın, kimlikler sekme içinde benzersizdir,
örneğin HTML'deki bir kimlik gibi.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
id | String | Sekme içinde benzersiz olan aralığın kimliği. |
Return
NamedRange
— Verilen kimliğe sahip NamedRange
veyanull
tıklayın.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRanges()
İlk sekmedeki veya bir dokümana bağlı komut dosyaları için etkin sekmedeki NamedRange
nesnelerin tümünü alır. Tüm bildirimleri almak için
NamedRange
nesne eklemek için DocumentTab.getNamedRanges()
yöntemini kullanın.
NamedRange
uygulamasına, sekmeye erişen herhangi bir komut dosyası tarafından erişilebilir. Kaçınılması gerekenler
komut dosyaları arasında istenmeyen çakışmalar varsa aralık adlarının önüne benzersiz bir dize ekleyin.
Return
NamedRange[]
— Sekmedeki NamedRange
nesnelerinden oluşan bir dizi (büyük olasılıkla birden fazla öğe içerir)
aynı ada sahip aralıklar.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRanges(name)
İlk sekmede belirtilen ada sahip NamedRange
nesnelerin tümünü alır veya
bir dokümana (etkin sekmeye) bağlı olmalıdır. Şunları almak için:
herhangi bir sekmedeki NamedRange
nesnesinin tamamı için DocumentTab.getNamedRanges(name)
yöntemini kullanın. Adların, sekmeler arasında bile benzersiz olması gerekmez; farklı zaman aralıklarında
aynı sekme, aynı HTML sınıfına benzer şekilde aynı adı paylaşabilir. Buna karşın kimlikler benzersizdir
(HTML'deki bir kimlik gibi).
NamedRange
öğesine, dokümana erişen herhangi bir komut dosyası tarafından erişilebilir. Kaçınılması gerekenler
komut dosyaları arasında istenmeyen çakışmalar varsa aralık adlarının önüne benzersiz bir dize ekleyin.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
name | String | Her zaman benzersiz olmayan aralığın adı. |
Return
NamedRange[]
— Belirtilen ada sahip sekmedeki NamedRange
nesne dizisi.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
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 kullanıcı seçimine erişebilir komut dosyasını kimin çalıştırdığını ve yalnızca komut dosyası dokümana bağlıysa ekleyebilirsiniz.
// 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 bir temsili veya kullanıcının sahip olmadığı durumlarda null
bir paragrafın yalnızca sonu seçilmişse, yalnızca sonu seçiliyse,
yeni bir satır seçildiğinde veya komut dosyası dokümana bağlı olmadığında gösterilir.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSupportedLanguageCodes()
Google Dokümanlar dosyalarında desteklenen tüm dil kodlarını alır.
Return
String[]
: Dil kodları dizisi.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTab(tabId)
Belirtilen kimliğe sahip Tab
öğesini alır. Böyle bir Tab
yoksa bu yöntem null
değerini döndürür. Tüm iç içe yerleştirme seviyelerindeki sekmelere erişebilir.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
tabId | 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 bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTabs()
Dokümanın bir parçası olan, iç içe yerleştirilmemiş tüm Tab
'leri alır.
Sekmeler, başka bir sekmenin içine yerleştirilmiş bir sekme olan alt sekmeler içerebilir. Alt sekmeler erişilebilir
Tab.getChildTabs()
kullanılıyor.
Return
Tab[]
— Dokümanın bir parçası olan tüm Tab
öğelerinin listesi.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir 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 URL.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getViewers()
Bu Document
için görüntüleyenlerin ve yorumcuların listesini alır.
Return
User[]
: Görüntüleme veya yorum yapma iznine sahip bir kullanıcı dizisi.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
newPosition(element, offset)
Bir konuma göre sekmedeki bir konuma referans olan yeni bir Position
oluşturur
ilk sekmedeki belirli bir öğe veya bir dokümana bağlı komut dosyaları için etkin sekme. Bir
Position
eşlemek için DocumentTab.newPosition(element, offset)
kullanın
yöntemidir. 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. var doc = DocumentApp.getActiveDocument(); var paragraph = doc.getBody().appendParagraph('My new paragraph.'); var 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 ya bir
Text öğesi veya Paragraph gibi bir kapsayıcı öğe. |
offset | Integer | Text öğeleri için Position öğesinden önceki karakter sayısı;
diğer öğeler için, Position
aynı kapsayıcı öğedir. |
Return
Position
— Yeni Position
.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
newRange()
tablodaki sekme öğelerinden Range
nesneleri oluşturmak için kullanılan bir oluşturucu oluşturur
bir komut dosyasına bağlı komut dosyaları için
doküman, etkin sekme. DocumentRange
nesne oluşturmak için kullanılan bir oluşturucu oluşturmak için
seçeneğini belirlemek için DocumentTab.newRange()
yöntemini kullanın.
// Change the user's selection to a range that includes every table in the active tab. 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 oluşturucu.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeEditor(emailAddress)
Belirtilen kullanıcıyı Document
için düzenleyenler listesinden kaldırır. Bu yöntem
Şu özelliklere sahip bir kullanıcı sınıfına aitse, kullanıcıların Document
öğesine erişmesini engelle:
genel erişim (örneğin, Document
, kullanıcının tümüyle paylaşılıyorsa)
veya Document
, kullanıcının erişebileceği bir ortak drive'da bulunuyorsa.
Bu işlem, Drive dosyaları için kullanıcıyı, görüntüleyenler listesinden de kaldırır.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
emailAddress | String | Kaldı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 kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeEditor(user)
Belirtilen kullanıcıyı Document
için düzenleyenler listesinden kaldırır. Bu yöntem
Şu özelliklere sahip bir kullanıcı sınıfına aitse, kullanıcıların Document
öğesine erişmesini engelle:
genel erişim (örneğin, Document
, kullanıcının tümüyle paylaşılıyorsa)
veya Document
, kullanıcının erişebileceği bir ortak drive'da bulunuyorsa.
Bu işlem, Drive dosyaları için 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ıyı gösteren bir temsil. |
Return
Document
— Bu Document
, zincirleme bağlantı için.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeViewer(emailAddress)
Belirtilen kullanıcıyı Document
için görüntüleyenler ve yorumcular listesinden kaldırır. Bu
Kullanıcı bir görüntüleyen veya yorumcu değil de düzenleyen ise, yönteminin herhangi bir etkisi yoktur. Bu yöntem ayrıca
Kullanıcı, aşağıdaki koşulları karşılayan bir kullanıcı sınıfına aitse, kullanıcıların Document
öğesine erişmesini engellemez:
genel erişime sahip olmalıdır (örneğin, Document
, kullanıcının
alanın tamamını veya Document
, kullanıcının erişebileceği bir ortak drive'da bulunuyorsa.
Bu işlem, Drive dosyalarında kullanıcıyı düzenleyenler listesinden de kaldırır.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
emailAddress | String | Kaldırılacak kullanıcının e-posta adresi. |
Return
Document
— Zincirleme için bu Document
.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeViewer(user)
Belirtilen kullanıcıyı Document
için görüntüleyenler ve yorumcular listesinden kaldırır. Bu
Kullanıcı bir görüntüleyen değil de düzenleyen olduğunda, yönteminin herhangi bir etkisi yoktur. Bu yöntem ayrıca,
bir kullanıcının Document
erişim (örneğin, Document
, kullanıcının tüm alanıyla paylaşılıyorsa veya
Document
öğesi kullanıcının erişebileceği bir ortak drive'daysa.
Bu işlem, Drive dosyalarında kullanıcıyı düzenleyenler listesinden de kaldırır.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
user | User | Kaldırılacak kullanıcıyı gösteren bir temsil. |
Return
Document
— Zincirleme için bu Document
.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir 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, komut dosyası yürütme işleminin sonunda otomatik olarak çağrılır
her açık düzenlenebilir Document
için.
Kapalı Document
düzenlenemez. Bir web sitesini yeniden açmak için DocumentApp.openById()
düzenleme için verilen dokümandır.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setActiveTab(tabId)
Kullanıcının geçerli dokümandaki seçili Tab
ayarını, belirtilen kimliğe sahip sekme olarak 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(TAB_ID);
Parametreler
Ad | Tür | Açıklama |
---|---|---|
tabId | String | Etkin olarak ayarlanacak sekmenin kimliği. |
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setCursor(position)
Position
verildiğinde kullanıcının imlecini ayarlar. Bir komut dosyası yalnızca
işlemini yapan kullanıcıdır. Kullanıcının yalnızca komut dosyası dokümana bağlı olması gerekir.
Etkin olmayan bir Tab
öğesinden Position
sağlanırsa kullanıcının etkin sekmesi değişir.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); // Append a paragraph, then place the user's cursor after the first word of the new paragraph. var paragraph = documentTab.getBody().appendParagraph('My new paragraph.'); var position = documentTab.newPosition(paragraph.getChild(0), 2); doc.setCursor(position);
Parametreler
Ad | Tür | Açıklama |
---|---|---|
position | Position | Yeni imlecin konumu. |
Return
Document
— Bu Document
, zincirleme bağlantı için.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir 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 Dosyasında gösterilen dildir
> Dil'i seçin. Geçerli tüm dil kodlarını almak için getSupportedLanguageCodes()
kullanın.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
languageCode | String | Dil kodu. |
Return
Document
— Bu Document
, zincirleme bağlantı için.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir 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
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 bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setSelection(range)
Range
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 ve yalnızca komut dosyası dokümana bağlıysa erişin.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); // Change the user's selection to a range that includes every table in the document. var rangeBuilder = documentTab.newRange(); var tables = documentTab.getBody().getTables(); for (var 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
— Bu Document
, zincirleme bağlantı için.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents