Dokument zawierający co najmniej 1 obiekt Tab, z których każdy zawiera tekst sformatowany i elementy takie jak tabele i listy.
Dokumenty można otwierać i tworzyć za pomocą Document.
// Open a document by ID. let doc = DocumentApp.openById('<my-id>'); // Create and open a document. doc = DocumentApp.create('Document Title');
Metody w klasie Document, które bezpośrednio uzyskują dostęp do treści tekstowych i je modyfikują, działają na aktywnej karcie (w skryptach powiązanych z konkretnym dokumentem) lub na pierwszej karcie (jeśli aktywna karta nie jest dostępna). Skrypty korzystające z tych metod (np. get) można przekształcić tak, aby obsługiwały karty za pomocą get, a następnie Tab.asDocumentTab().
Metody
| Metoda | Zwracany typ | Krótki opis |
|---|---|---|
add | Bookmark | Dodaje znak Bookmark w podanym Position na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie. |
add | Document | Dodaje podanego użytkownika do listy edytujących Document. |
add | Document | Dodaje podanego użytkownika do listy edytujących Document. |
add | Document | Dodaje podaną tablicę użytkowników do listy edytujących Document. |
add | Footer | Dodaje sekcję stopki (jeśli nie istnieje) do pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, do aktywnej karty. |
add | Header | Dodaje sekcję nagłówka (jeśli nie istnieje) do pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, do aktywnej karty. |
add | Named | Dodaje Named, czyli Range z nazwą i identyfikatorem, który można później wykorzystać do pobierania danych, na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie. |
add | Document | Dodaje podanego użytkownika do listy osób, które mogą wyświetlać Document. |
add | Document | Dodaje podanego użytkownika do listy osób, które mogą wyświetlać Document. |
add | Document | Dodaje podaną tablicę użytkowników do listy widzów Document. |
get | Tab | Pobiera aktualnie aktywny Tab użytkownika w dokumencie. |
get | Blob | Pobiera bieżącą zawartość Document jako obiekt blob określonego typu. |
get | Blob | Pobiera bieżącą zawartość Document jako obiekt blob. |
get | Body | Pobiera Body pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, Document aktywnej karty. |
get | Bookmark|null | Pobiera Bookmark o podanym identyfikatorze z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, z aktywnej karty. |
get | Bookmark[] | Pobiera wszystkie obiekty Bookmark z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, z aktywnej karty. |
get | Position|null | Pobiera kursor użytkownika na aktywnej karcie. |
get | User[] | Pobiera listę edytorów tego Document. |
get | Footer | Pobiera sekcję stopki pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, sekcję stopki aktywnej karty. |
get | Footnote[]|null | Pobiera wszystkie elementy Footnote w treści pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, w treści aktywnej karty. |
get | Header | Pobiera sekcję nagłówka pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, sekcję nagłówka aktywnej karty. |
get | String | Pobiera unikalny identyfikator dokumentu. |
get | String | Pobiera kod języka dokumentu. |
get | String | Pobiera tytuł dokumentu. |
get | Named | Pobiera Named o podanym identyfikatorze z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, z aktywnej karty. |
get | Named | Pobiera wszystkie obiekty Named z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, z aktywnej karty. |
get | Named | Pobiera wszystkie obiekty Named o podanej nazwie na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie. |
get | Range|null | Pobiera wybór użytkownika na aktywnej karcie. |
get | String[] | Pobiera wszystkie kody języków obsługiwane w plikach Dokumentów Google. |
get | Tab | Pobiera Tab o określonym identyfikatorze. |
get | Tab[] | Pobiera wszystkie niezagłębione elementy Tab, które są częścią dokumentu. |
get | String | Pobiera adres URL dostępu do bieżącego dokumentu. |
get | User[] | Pobiera listę przeglądających i komentujących dla tego Document. |
new | Position | Tworzy nowy Position, który jest odwołaniem do lokalizacji na karcie względem określonego elementu na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, aktywnej karty. |
new | Range | Tworzy narzędzie do tworzenia obiektów Range z elementów karty na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie. |
remove | Document | Usuwa danego użytkownika z listy osób edytujących Document. |
remove | Document | Usuwa danego użytkownika z listy osób edytujących Document. |
remove | Document | Usuwa danego użytkownika z listy przeglądających i komentujących Document. |
remove | Document | Usuwa danego użytkownika z listy przeglądających i komentujących Document. |
save | void | Zapisuje bieżący Document. |
set | void | Ustawia wybraną przez użytkownika Tab w bieżącym dokumencie na kartę o określonym identyfikatorze. |
set | Document | Ustawia kursor użytkownika na podstawie wartości Position. |
set | Document | Ustawia kod języka dokumentu. |
set | Document | Ustawia tytuł dokumentu. |
set | Document | Ustawia wybór użytkownika na aktywnej karcie, biorąc pod uwagę Range. |
Szczegółowa dokumentacja
add Bookmark(position)
Dodaje znak Bookmark w podanym Position na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie. Aby dodać zakładkę do dowolnej karty, użyj metody Document.
// 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());
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
position | Position | Położenie nowej zakładki. |
Powrót
Bookmark – nowa zakładka.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
add Editor(emailAddress)
Dodaje podanego użytkownika do listy edytujących Document. Jeśli użytkownik był już na liście widzów, ta metoda usuwa go z tej listy.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
email | String | Adres e-mail użytkownika, którego chcesz dodać. |
Powrót
Document – ten Document do tworzenia łańcuszków.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
add Editor(user)
Dodaje podanego użytkownika do listy edytujących Document. Jeśli użytkownik był już na liście widzów, ta metoda usuwa go z tej listy.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
user | User | Reprezentacja użytkownika, którego chcesz dodać. |
Powrót
Document – ten Document do tworzenia łańcuszków.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
add Editors(emailAddresses)
Dodaje podaną tablicę użytkowników do listy edytujących Document. Jeśli któryś z użytkowników był już na liście widzów, ta metoda usuwa go z tej listy.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
email | String[] | Tablica adresów e-mail użytkowników, których chcesz dodać. |
Powrót
Document – ten Document do tworzenia łańcuszków.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
add Header()
Dodaje sekcję nagłówka (jeśli nie istnieje) do pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, do aktywnej karty. Aby dodać sekcję nagłówka do dowolnej karty, użyj metody Document.
// 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');
Powrót
Header – nagłówek karty.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
add Named Range(name, range)
Dodaje Named, czyli Range z nazwą i identyfikatorem, który można później wykorzystać do pobierania danych, na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie. Aby dodać Named na dowolnej karcie, użyj metody Document. Nazwy nie muszą być unikalne. Kilka różnych zakresów w tym samym dokumencie może mieć tę samą nazwę, podobnie jak klasa w HTML. Identyfikatory są natomiast unikalne w obrębie dokumentu, tak jak identyfikator w HTML-u.
Po dodaniu Named do dokumentu nie możesz go zmodyfikować, możesz go tylko usunąć.
Każdy skrypt, który ma dostęp do dokumentu, może uzyskać dostęp do Named. Aby uniknąć niezamierzonych konfliktów między skryptami, rozważ dodanie do nazw zakresów unikalnego ciągu znaków.
// 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());
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
name | String | Nazwa zakresu, która nie musi być unikalna. Nazwy zakresów muszą mieć od 1 do 256 znaków. |
range | Range | Zakres elementów do powiązania z nazwą. Może to być aktywny wybór, wynik wyszukiwania lub zakres utworzony ręcznie za pomocą symbolu new. |
Powrót
Named – Named.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
add Viewer(emailAddress)
Dodaje podanego użytkownika do listy osób, które mogą wyświetlać Document. Jeśli użytkownik był już na liście edytujących, ta metoda nie ma wpływu.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
email | String | Adres e-mail użytkownika, którego chcesz dodać. |
Powrót
Document – ten Document do tworzenia łańcuszków.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
add Viewer(user)
Dodaje podanego użytkownika do listy osób, które mogą wyświetlać Document. Jeśli użytkownik był już na liście edytujących, ta metoda nie ma wpływu.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
user | User | Reprezentacja użytkownika, którego chcesz dodać. |
Powrót
Document – ten Document do tworzenia łańcuszków.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
add Viewers(emailAddresses)
Dodaje podaną tablicę użytkowników do listy widzów Document. Jeśli któryś z użytkowników był już na liście edytujących, ta metoda nie będzie miała na niego wpływu.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
email | String[] | Tablica adresów e-mail użytkowników, których chcesz dodać. |
Powrót
Document – ten Document do tworzenia łańcuszków.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Active Tab()
Pobiera aktualnie aktywny Tab użytkownika w dokumencie. Skrypt może uzyskać dostęp tylko do aktywnej karty użytkownika, który go uruchamia, i tylko wtedy, gdy jest powiązany z dokumentem.
// 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()}`);
Powrót
Tab – aktualnie aktywny Tab użytkownika lub null, jeśli skrypt nie jest powiązany z dokumentem.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get As(contentType)
Pobiera bieżącą zawartość Document jako obiekt blob określonego typu.
// 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());
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
content | String | Typ MIME, na który ma zostać przekonwertowany plik. Obsługiwane są typy 'application/pdf' i 'text/markdown'. |
Powrót
Blob – bieżący dokument jako obiekt blob.
get Blob()
Pobiera bieżącą zawartość Document jako obiekt blob.
// 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());
Powrót
Blob – bieżący dokument jako obiekt blob.
get Body()
Pobiera Body pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, Document aktywnej karty. Aby uzyskać Document dowolnej karty, użyj metody Document.
Karty mogą zawierać różne typy sekcji (np. Header, Footer). Aktywna sekcja karty to Body.
Metody elementów w Document delegują do aktywnego elementu Body.
// 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());
Powrót
Body – sekcja treści karty.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Bookmark(id)
Pobiera Bookmark o podanym identyfikatorze z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, z aktywnej karty. Aby dodać zakładkę na dowolnej karcie, użyj metody Document. Jeśli w karcie nie ma takiego elementu Bookmark, ta metoda zwraca wartość null.
// 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.'); }
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
id | String | Identyfikator Bookmark. |
Powrót
Bookmark|null – Bookmark o podanym identyfikatorze lub null, jeśli na karcie nie ma takiego elementu Bookmark.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Bookmarks()
Pobiera wszystkie obiekty Bookmark z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, z aktywnej karty. Aby uzyskać wszystkie zakładki na dowolnej karcie, użyj metody Document.
// 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);
Powrót
Bookmark[] – tablica obiektów Bookmark na karcie.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Cursor()
Pobiera kursor użytkownika na aktywnej karcie. Skrypt może uzyskać dostęp do kursora tylko użytkownika, który go uruchamia, i tylko wtedy, gdy jest powiązany z dokumentem.
// 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.'); }
Powrót
Position|null – reprezentacja kursora użytkownika lub null, jeśli użytkownik nie umieścił kursora na karcie lub jeśli skrypt nie jest powiązany z dokumentem.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Editors()
Pobiera listę edytorów tego Document.
Powrót
User[] – tablica użytkowników z uprawnieniami do edycji.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Footnotes()
Pobiera wszystkie elementy Footnote w treści pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, w treści aktywnej karty. Aby uzyskać wszystkie przypisy w dowolnej karcie, użyj metody Document.
Wywołania funkcji get powodują iterację po elementach karty. W przypadku dużych kart unikaj niepotrzebnych wywołań tej metody.
// 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());
Powrót
Footnote[]|null – przypisy na karcie.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Header()
Pobiera sekcję nagłówka pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, sekcję nagłówka aktywnej karty. Aby uzyskać sekcję nagłówka dowolnej karty, użyj metody Document.
// 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());
Powrót
Header – nagłówek karty.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Id()
Pobiera unikalny identyfikator dokumentu. Identyfikator dokumentu jest używany z parametrem Document do otwierania konkretnej wersji dokumentu.
Powrót
String – identyfikator dokumentu.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Language()
Pobiera kod języka dokumentu. Jest to język wyświetlany w edytorze dokumentów w sekcji Plik > Język, który może nie być rzeczywistym językiem dokumentu.
Powrót
String – język dokumentu lub null, jeśli nie jest zdefiniowany.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Name()
Pobiera tytuł dokumentu.
Powrót
String – tytuł dokumentu.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Named Range By Id(id)
Pobiera Named o podanym identyfikatorze z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, z aktywnej karty. Aby pobrać element Named o podanym identyfikatorze na dowolnej karcie, użyj metody Document. Jeśli na karcie nie ma takiego elementu Named, ta metoda zwraca wartość null. Nazwy nie muszą być niepowtarzalne, nawet w obrębie kart. Kilka różnych zakresów na tej samej karcie może mieć tę samą nazwę, podobnie jak klasa w HTML. Identyfikatory są natomiast unikalne w obrębie karty, podobnie jak identyfikator w HTML-u.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
id | String | Identyfikator zakresu, który jest unikalny w obrębie karty. |
Powrót
Named – Named o podanym identyfikatorze lub null, jeśli w karcie nie ma takiego zakresu.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Named Ranges()
Pobiera wszystkie obiekty Named z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, z aktywnej karty. Aby pobrać wszystkie obiekty Named na dowolnej karcie, użyj metody Document.
Do Named może uzyskać dostęp każdy skrypt, który ma dostęp do karty. Aby uniknąć niepożądanych konfliktów między skryptami, rozważ dodanie do nazw zakresów unikalnego ciągu znaków.
Powrót
Named – tablica obiektów Named na karcie, która może zawierać wiele zakresów o tej samej nazwie.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Named Ranges(name)
Pobiera wszystkie obiekty Named o podanej nazwie na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie. Aby pobrać wszystkie obiekty Named na dowolnej karcie, użyj metody Document. Nazwy nie muszą być unikalne, nawet w obrębie kart. Kilka różnych zakresów na tej samej karcie może mieć tę samą nazwę, podobnie jak klasa w HTML. Identyfikatory są natomiast unikalne w obrębie karty, podobnie jak identyfikator w HTML-u.
Do Named może uzyskać dostęp każdy skrypt, który ma dostęp do dokumentu. Aby uniknąć niepożądanych konfliktów między skryptami, rozważ dodanie do nazw zakresów unikalnego ciągu znaków.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
name | String | Nazwa zakresu, która nie musi być unikalna. |
Powrót
Named – tablica obiektów Named na karcie o podanej nazwie.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Selection()
Pobiera wybór użytkownika na aktywnej karcie. Skrypt może uzyskać dostęp do zaznaczenia użytkownika, który go uruchamia, tylko wtedy, gdy jest powiązany z dokumentem.
// 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.'); }
Powrót
Range|null – reprezentacja wyboru użytkownika lub null, jeśli użytkownik nie ma niczego wybranego na karcie, jeśli wybrany jest tylko koniec akapitu, jeśli wybrany jest tylko koniec akapitu i nowy wiersz lub jeśli skrypt nie jest powiązany z dokumentem.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Supported Language Codes()
Pobiera wszystkie kody języków obsługiwane w plikach Dokumentów Google.
Powrót
String[] – tablica kodów języków.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Tab(tabId)
Pobiera Tab o określonym identyfikatorze. Jeśli nie ma takiego elementu Tab, ta metoda zwraca wartość null. ma dostęp do kart na dowolnym poziomie zagnieżdżenia.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
tab | String | Identyfikator karty do pobrania. |
Powrót
Tab – element Tab o podanym identyfikatorze lub null, jeśli taki element Tab nie istnieje.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Tabs()
Pobiera wszystkie niezagłębione elementy Tab, które są częścią dokumentu.
Karty mogą zawierać karty podrzędne, czyli karty zagnieżdżone w innych kartach. Karty podrzędne są dostępne za pomocą klawisza Tab.getChildTabs().
Powrót
Tab[] – lista wszystkich Tab, które są częścią dokumentu.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Url()
Pobiera adres URL dostępu do bieżącego dokumentu.
const doc = DocumentApp.getActiveDocument(); // Send out the link to open the document. MailApp.sendEmail('<email-address>', doc.getName(), doc.getUrl());
Powrót
String – adres URL, pod którym można uzyskać dostęp do bieżącego dokumentu.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Viewers()
Pobiera listę przeglądających i komentujących dla tego Document.
Powrót
User[] – tablica użytkowników z uprawnieniami do wyświetlania lub komentowania.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
new Position(element, offset)
Tworzy nowy Position, który jest odwołaniem do lokalizacji na karcie względem określonego elementu na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, aktywnej karty. Aby utworzyć Position względem lokalizacji na dowolnej karcie, użyj metody Document. Kursor użytkownika jest reprezentowany przez symbol Position.
// 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);
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
element | Element | Element, który powinien zawierać nowy element Position. Musi to być element Text lub element kontenera, np. Paragraph. |
offset | Integer | W przypadku elementów Text liczba znaków przed elementem Position; w przypadku innych elementów liczba elementów podrzędnych przed elementem Position w tym samym elemencie kontenera. |
Powrót
Position – Nowy Position.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
new Range()
Tworzy narzędzie do tworzenia obiektów Range z elementów karty na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie. Aby utworzyć narzędzie do tworzenia obiektów Document z elementów kart na dowolnej karcie, użyj metody Document.
// 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());
Powrót
Range – nowy kreator.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
remove Editor(emailAddress)
Usuwa danego użytkownika z listy osób edytujących Document. Ta metoda nie blokuje użytkownikom dostępu do Document, jeśli należą oni do klasy użytkowników, którzy mają ogólny dostęp, np. jeśli Document jest udostępniony całej domenie użytkownika lub jeśli Document znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.
W przypadku plików na Dysku spowoduje to również usunięcie użytkownika z listy osób, które mogą je wyświetlać.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
email | String | Adres e-mail użytkownika, którego chcesz usunąć. |
Powrót
Document – ten Document do tworzenia łańcuszków.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
remove Editor(user)
Usuwa danego użytkownika z listy osób edytujących Document. Ta metoda nie blokuje użytkownikom dostępu do Document, jeśli należą oni do klasy użytkowników, którzy mają ogólny dostęp, np. jeśli Document jest udostępniony całej domenie użytkownika lub jeśli Document znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.
W przypadku plików na Dysku spowoduje to również usunięcie użytkownika z listy osób, które mogą je wyświetlać.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
user | User | Reprezentacja użytkownika do usunięcia. |
Powrót
Document – ten Document do tworzenia łańcuszków.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
remove Viewer(emailAddress)
Usuwa danego użytkownika z listy przeglądających i komentujących Document. Ta metoda nie ma wpływu, jeśli użytkownik jest edytującym, a nie przeglądającym lub komentującym. Ta metoda nie blokuje też dostępu do Document użytkownikom, którzy należą do grupy użytkowników mających ogólny dostęp, np. jeśli Document jest udostępniony całej domenie użytkownika lub jeśli Document znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.
W przypadku plików na Dysku spowoduje to również usunięcie użytkownika z listy edytujących.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
email | String | Adres e-mail użytkownika, którego chcesz usunąć. |
Powrót
Document – ten znak Document służy do łączenia.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
remove Viewer(user)
Usuwa danego użytkownika z listy przeglądających i komentujących Document. Ta metoda nie ma wpływu, jeśli użytkownik jest edytującym, a nie przeglądającym. Ta metoda nie blokuje też dostępu do Document użytkownikom, którzy należą do klasy użytkowników mających ogólny dostęp, np. jeśli Document jest udostępniony całej domenie użytkownika lub jeśli Document znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.
W przypadku plików na Dysku spowoduje to również usunięcie użytkownika z listy edytujących.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
user | User | Reprezentacja użytkownika do usunięcia. |
Powrót
Document – ten znak Document służy do łączenia.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
save And Close()
Zapisuje bieżący Document. Powoduje opróżnienie i zastosowanie oczekujących aktualizacji.
Metoda save jest automatycznie wywoływana na końcu wykonywania skryptu
dla każdego otwartego edytowalnego Document.
Zamkniętego Document nie można edytować. Użyj Document, aby ponownie otworzyć dany dokument do edycji.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Active Tab(tabId)
Ustawia wybraną przez użytkownika Tab w bieżącym dokumencie na kartę o określonym identyfikatorze.
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');
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
tab | String | Identyfikator karty, którą chcesz ustawić jako aktywną. |
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Cursor(position)
Ustawia kursor użytkownika na podstawie wartości Position. Skrypt może uzyskać dostęp do kursora użytkownika, który go uruchamia, tylko wtedy, gdy jest powiązany z dokumentem.
Wysłanie Position z nieaktywnego Tab powoduje przełączenie aktywnej karty użytkownika.
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);
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
position | Position | Nowa lokalizacja kursora. |
Powrót
Document – ten Document do tworzenia łańcuszków.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Language(languageCode)
Ustawia kod języka dokumentu. Jest to język wyświetlany w edytorze dokumentów w sekcji Plik > Język, który może nie być rzeczywistym językiem dokumentu. Użyj get, aby uzyskać wszystkie prawidłowe kody języka.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
language | String | Kod języka. |
Powrót
Document – ten Document do tworzenia łańcuszków.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Name(name)
Ustawia tytuł dokumentu.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
name | String | Nowy tytuł dokumentu. |
Powrót
Document – bieżący dokument.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Selection(range)
Ustawia wybór użytkownika na aktywnej karcie, biorąc pod uwagę Range. Skrypt może uzyskać dostęp do zaznaczenia użytkownika, który go uruchamia, tylko wtedy, gdy jest powiązany z dokumentem.
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());
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
range | Range | Nowy zakres elementów do wybrania. |
Powrót
Document – ten Document do tworzenia łańcuszków.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents