Dokument zawierający tekst sformatowany oraz elementy takie jak tabele i listy.
Dokumenty można otwierać lub tworzyć za pomocą aplikacji DocumentApp
.
// Open a document by ID. var doc = DocumentApp.openById("<my-id>"); // Create and open a document. doc = DocumentApp.create("Document Title");
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addBookmark(position) | Bookmark | Dodaje element Bookmark w podanej kolumnie Position . |
addEditor(emailAddress) | Document | Dodaje wskazanego użytkownika do listy edytorów w Document . |
addEditor(user) | Document | Dodaje wskazanego użytkownika do listy edytorów w Document . |
addEditors(emailAddresses) | Document | Dodaje podaną tablicę użytkowników do listy edytorów elementu Document . |
addFooter() | FooterSection | Dodaje sekcję stopki dokumentu, jeśli nie istnieje. |
addHeader() | HeaderSection | Dodaje sekcję nagłówka dokumentu, jeśli nie istnieje. |
addNamedRange(name, range) | NamedRange | Dodaje element NamedRange , czyli obiekt Range z nazwą i identyfikatorem, który ma być użyty do późniejszego pobrania. |
addViewer(emailAddress) | Document | Dodaje danego użytkownika do listy przeglądających stronę Document . |
addViewer(user) | Document | Dodaje danego użytkownika do listy przeglądających stronę Document . |
addViewers(emailAddresses) | Document | Dodaje podaną tablicę użytkowników do listy osób przeglądających element Document . |
getAs(contentType) | Blob | Pobiera bieżącą zawartość Document jako obiekt blob określonego typu. |
getBlob() | Blob | Pobiera bieżącą zawartość Document jako obiekt blob. |
getBody() | Body | Pobiera element Body aktywnego dokumentu. |
getBookmark(id) | Bookmark | Pobiera element Bookmark o podanym identyfikatorze. |
getBookmarks() | Bookmark[] | Pobiera wszystkie obiekty Bookmark z dokumentu. |
getCursor() | Position | Pobiera kursor użytkownika w aktywnym dokumencie. |
getEditors() | User[] | Pobiera listę edytorów tego elementu (Document ). |
getFooter() | FooterSection | Pobiera sekcję stopki dokumentu, jeśli istnieje. |
getFootnotes() | Footnote[] | Pobiera wszystkie elementy Footnote znajdujące się w treści dokumentu. |
getHeader() | HeaderSection | Pobiera sekcję nagłówka dokumentu, jeśli istnieje. |
getId() | String | Pobiera unikalny identyfikator dokumentu. |
getLanguage() | String | Pobiera kod języka dokumentu. |
getName() | String | Pobiera tytuł dokumentu. |
getNamedRangeById(id) | NamedRange | Pobiera element NamedRange o podanym identyfikatorze. |
getNamedRanges() | NamedRange[] | Pobiera wszystkie obiekty NamedRange z dokumentu. |
getNamedRanges(name) | NamedRange[] | Pobiera wszystkie obiekty NamedRange z dokumentu o podanej nazwie. |
getSelection() | Range | Pobiera wybór użytkownika z aktywnego dokumentu. |
getSupportedLanguageCodes() | String[] | Pobiera wszystkie kody języków obsługiwane w plikach Dokumentów Google. |
getUrl() | String | Pobiera adres URL, aby uzyskać dostęp do bieżącego dokumentu. |
getViewers() | User[] | Pobiera listę przeglądających i komentujących tego elementu (Document ). |
newPosition(element, offset) | Position | Tworzy nowy element Position , który jest odwołaniem do lokalizacji w dokumencie względem konkretnego elementu. |
newRange() | RangeBuilder | Tworzy konstruktor służący do tworzenia obiektów Range na podstawie elementów dokumentu. |
removeEditor(emailAddress) | Document | Usuwa danego użytkownika z listy edytorów Document . |
removeEditor(user) | Document | Usuwa danego użytkownika z listy edytorów Document . |
removeViewer(emailAddress) | Document | Usuwa danego użytkownika z listy przeglądających i komentujących elementu Document . |
removeViewer(user) | Document | Usuwa danego użytkownika z listy przeglądających i komentujących elementu Document . |
saveAndClose() | void | Zapisuje bieżące Document . |
setCursor(position) | Document | Ustawia kursor użytkownika w aktywnym dokumencie z użyciem parametru Position . |
setLanguage(languageCode) | Document | Określa kod języka dokumentu. |
setName(name) | Document | Określa tytuł dokumentu. |
setSelection(range) | Document | Określa wybór użytkownika w aktywnym dokumencie z określoną wartością Range . |
Szczegółowa dokumentacja
addBookmark(position)
Dodaje element Bookmark
w podanej kolumnie Position
.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the document body and adds a paragraph. const paragraph = doc.getBody().appendParagraph('My new paragraph.'); // Creates a position at the first character of the paragraph text. const position = doc.newPosition(paragraph.getChild(0), 0); // Adds a bookmark at the first character of the paragraph text. const bookmark = doc.addBookmark(position); // Logs the bookmark ID to the console. console.log(bookmark.getId()); }
Parametry
Nazwa | Typ | Opis |
---|---|---|
position | Position | Pozycja nowej zakładki. |
Powroty
Bookmark
– nowa zakładka.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditor(emailAddress)
Dodaje wskazanego użytkownika do listy edytorów w Document
. Jeśli użytkownik był już na liście widzów, ta metoda przesuwa go poza listę widzów.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddress | String | Adres e-mail użytkownika, którego chcesz dodać. |
Powroty
Document
– ten element typu Document
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditor(user)
Dodaje wskazanego użytkownika do listy edytorów w Document
. Jeśli użytkownik był już na liście widzów, ta metoda przesuwa go poza listę widzów.
Parametry
Nazwa | Typ | Opis |
---|---|---|
user | User | Reprezentacja użytkownika, który ma zostać dodany. |
Powroty
Document
– ten element typu Document
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditors(emailAddresses)
Dodaje podaną tablicę użytkowników do listy edytorów elementu Document
. Jeśli którykolwiek z użytkowników był już na liście widzów, ta metoda przesuwa go poza listę widzów.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddresses | String[] | Tablica adresów e-mail użytkowników do dodania. |
Powroty
Document
– ten element typu Document
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addHeader()
Dodaje sekcję nagłówka dokumentu, jeśli nie istnieje.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Adds a header to the document. const header = doc.addHeader(); // Sets the header text to 'This is a header.' header.setText('This is a header');
Powroty
HeaderSection
– nagłówek dokumentu.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addNamedRange(name, range)
Dodaje element NamedRange
, czyli obiekt Range
z nazwą i identyfikatorem, który ma być użyty do późniejszego pobrania. Nazwy nie muszą być niepowtarzalne. Kilka różnych zakresów w jednym dokumencie może mieć tę samą nazwę, podobnie jak klasa w kodzie HTML. Z kolei identyfikatory są unikalne w dokumencie,
tak jak identyfikator w kodzie HTML. Po dodaniu do dokumentu elementu NamedRange
nie możesz go już zmodyfikować. Możesz go tylko usunąć.
Każdy skrypt, który uzyskuje dostęp do dokumentu, może też uzyskać dostęp do elementu NamedRange
. Aby uniknąć niezamierzonych konfliktów między skryptami, rozważ dodanie do nazw zakresów niepowtarzalnego ciągu znaków.
// Creates a named range that includes every table in the document. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.addNamedRange('Document tables', rangeBuilder.build());
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, które można powiązać z nazwą. Zakresem może być aktywny wybór, wynik wyszukiwania lub utworzony ręcznie za pomocą parametru newRange() . |
Powroty
NamedRange
– NamedRange
.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewer(emailAddress)
Dodaje danego użytkownika do listy przeglądających stronę Document
. Jeśli użytkownik był już na liście edytorów, ta metoda nie ma żadnego efektu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddress | String | Adres e-mail użytkownika, którego chcesz dodać. |
Powroty
Document
– ten element typu Document
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewer(user)
Dodaje danego użytkownika do listy przeglądających stronę Document
. Jeśli użytkownik był już na liście edytorów, ta metoda nie ma żadnego efektu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
user | User | Reprezentacja użytkownika, który ma zostać dodany. |
Powroty
Document
– ten element typu Document
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewers(emailAddresses)
Dodaje podaną tablicę użytkowników do listy osób przeglądających element Document
. Jeśli którykolwiek z użytkowników był już na liście edytorów, ta metoda nie będzie działać.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddresses | String[] | Tablica adresów e-mail użytkowników do dodania. |
Powroty
Document
– ten element typu Document
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAs(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('abc123456'); // Gets the document as a PDF. const pdf = doc.getAs('application/pdf'); // Logs the name of the PDF to the console. console.log(pdf.getName());
Parametry
Nazwa | Typ | Opis |
---|---|---|
contentType | String | Typ MIME, na który ma zostać przekonwertowany. Obecnie obsługiwany jest tylko typ 'application/pdf' . |
Powroty
Blob
– bieżący dokument jako obiekt blob.
getBlob()
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('abc123456'); // Retrieves the current document's contents as a blob and logs it to the console. console.log(doc.getBlob().getContentType());
Powroty
Blob
– bieżący dokument jako obiekt blob.
getBody()
Pobiera element Body
aktywnego dokumentu.
Dokumenty mogą zawierać różne typy sekcji (np. HeaderSection
, FooterSection
). Aktywna sekcja dokumentu to Body
.
Metody elementów w elemencie Document
przekazują 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('abc123456'); // Gets the document body. const body = doc.getBody(); // Gets the body text and logs it to the console. console.log(body.getText());
Powroty
Body
– aktywna sekcja treści dokumentu.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBookmark(id)
Pobiera element Bookmark
o podanym identyfikatorze. Jeśli metoda Bookmark
nie istnieje, 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('abc123456'); // Gets the bookmark by its ID. const bookmark = doc.getBookmark('id.xyz654321'); // If the bookmark exists, logs the character offset of its position to the console. // otherwise, logs 'No bookmark exists with the given ID.' to the console. if (bookmark) { console.log(bookmark.getPosition().getOffset()); } else { console.log('No bookmark exists with the given ID.'); }
Parametry
Nazwa | Typ | Opis |
---|---|---|
id | String | Identyfikator pola Bookmark . |
Powroty
Bookmark
– Bookmark
o podanym identyfikatorze lub null
, jeśli nie istnieje taki element Bookmark
.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBookmarks()
Pobiera wszystkie obiekty Bookmark
z dokumentu.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. const doc = DocumentApp.openById('abc123456'); // Gets all of the bookmarks in the document. const bookmarks = doc.getBookmarks(); // Logs the number of bookmarks in the document to the console. console.log(bookmarks.length);
Powroty
Bookmark[]
– tablica obiektów Bookmark
w dokumencie.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getCursor()
Pobiera kursor użytkownika w aktywnym dokumencie. Skrypt ma dostęp tylko do kursora 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. 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.'); }
Powroty
Position
– przykład kursora użytkownika lub null
, jeśli użytkownik nie ma kursora w dokumencie lub skrypt nie jest powiązany z dokumentem.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getEditors()
Pobiera listę edytorów tego elementu (Document
).
Powroty
User[]
– tablica użytkowników z uprawnieniami do edycji.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getFootnotes()
Pobiera wszystkie elementy Footnote
znajdujące się w treści dokumentu.
Wywołania getFootnotes
powodują powtórzenie elementów dokumentu. W przypadku dużych dokumentów unikaj zbędnych 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('abc123456'); // Gets the first footnote. const footnote = doc.getFootnotes()[0]; // Logs footnote contents to the console. console.log(footnote.getFootnoteContents().getText());
Powroty
Footnote[]
– przypisy do dokumentu.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getHeader()
Pobiera sekcję nagłówka dokumentu, jeśli istnieje.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the text of the document's header and logs it to the console. console.log(doc.getHeader().getText());
Powroty
HeaderSection
– nagłówek dokumentu.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getId()
Pobiera unikalny identyfikator dokumentu. Identyfikator dokumentu jest używany w zasadzie DocumentApp.openById()
do otwierania konkretnego wystąpienia dokumentu.
Powroty
String
– identyfikator dokumentu;
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLanguage()
Pobiera kod języka dokumentu. Jest to język wyświetlany w edytorze dokumentu po wybraniu opcji Plik > Język. Może to nie być rzeczywisty język dokumentu.
Powroty
String
– język dokumentu lub null
, jeśli nie został zdefiniowany.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getName()
Pobiera tytuł dokumentu.
Powroty
String
– tytuł dokumentu,
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRangeById(id)
Pobiera element NamedRange
o podanym identyfikatorze. Jeśli metoda NamedRange
nie istnieje, ta metoda zwraca wartość null
. Nazwy nie muszą być niepowtarzalne. Kilka różnych zakresów w jednym dokumencie może mieć tę samą nazwę, podobnie jak klasa w kodzie HTML. Z kolei identyfikatory są unikalne w dokumencie,
tak jak identyfikator w kodzie HTML.
Parametry
Nazwa | Typ | Opis |
---|---|---|
id | String | niepowtarzalny identyfikator zakresu w obrębie dokumentu, |
Powroty
NamedRange
– NamedRange
o podanym identyfikatorze lub null
, jeśli taki zakres nie istnieje.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRanges()
Pobiera wszystkie obiekty NamedRange
z dokumentu.
Dostęp do NamedRange
może uzyskać każdy skrypt uzyskujący dostęp do dokumentu. Aby uniknąć niezamierzonych konfliktów między skryptami, rozważ dodanie do nazw zakresów niepowtarzalnego ciągu znaków.
Powroty
NamedRange[]
– tablica obiektów NamedRange
w dokumencie, prawdopodobnie zawierająca wiele zakresów o tej samej nazwie
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRanges(name)
Pobiera wszystkie obiekty NamedRange
z dokumentu o podanej nazwie. Nazwy nie muszą być niepowtarzalne. Kilka różnych zakresów w jednym dokumencie może mieć tę samą nazwę, podobnie jak klasa w kodzie HTML. Z kolei identyfikatory są unikalne w obrębie dokumentu, podobnie jak identyfikator w kodzie HTML.
Dostęp do NamedRange
może uzyskać każdy skrypt uzyskujący dostęp do dokumentu. Aby uniknąć niezamierzonych konfliktów między skryptami, rozważ dodanie do nazw zakresów niepowtarzalnego ciągu znaków.
Parametry
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa zakresu, która nie musi być niepowtarzalna; |
Powroty
NamedRange[]
– tablica obiektów NamedRange
w dokumencie o podanej nazwie.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSelection()
Pobiera wybór użytkownika z aktywnego dokumentu. Skrypt ma dostęp tylko do użytkownika, który ma go uruchamiać, i tylko wtedy, gdy jest powiązany z dokumentem.
// 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.'); }
Powroty
Range
– reprezentuje wybór użytkownika lub null
, jeśli użytkownik nie wybrał niczego w dokumencie, jeśli zaznaczony jest tylko koniec akapitu, wybrany jest tylko koniec akapitu i nowy wiersz lub skrypt nie jest powiązany z dokumentem.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSupportedLanguageCodes()
Pobiera wszystkie kody języków obsługiwane w plikach Dokumentów Google.
Powroty
String[]
– tablica kodów języków.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getUrl()
Pobiera adres URL, aby uzyskać dostęp do bieżącego dokumentu.
var doc = DocumentApp.getActiveDocument(); // Send out the link to open the document. MailApp.sendEmail("<email-address>", doc.getName(), doc.getUrl());
Powroty
String
– adres URL umożliwiający dostęp do bieżącego dokumentu.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getViewers()
Pobiera listę przeglądających i komentujących tego elementu (Document
).
Powroty
User[]
– tablica użytkowników z uprawnieniami do wyświetlania lub komentowania.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
newPosition(element, offset)
Tworzy nowy element Position
, który jest odwołaniem do lokalizacji w dokumencie względem konkretnego elementu. Kursor użytkownika ma między innymi postać Position
.
// Append a paragraph, then place the user's cursor after the first word of the new paragraph. var doc = DocumentApp.getActiveDocument(); var paragraph = doc.getBody().appendParagraph('My new paragraph.'); var position = doc.newPosition(paragraph.getChild(0), 2); doc.setCursor(position);
Parametry
Nazwa | Typ | Opis |
---|---|---|
element | Element | element, który będzie zawierać nowy Position ; musi to być element Text lub element kontenera, taki jak Paragraph |
offset | Integer | W przypadku elementów Text jest to liczba znaków przed elementem Position , a w przypadku innych elementów – liczba elementów podrzędnych przed elementem Position w tym samym elemencie kontenera |
Powroty
Position
– nowy Position
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
newRange()
Tworzy konstruktor służący do tworzenia obiektów Range
na podstawie elementów dokumentu.
// Change the user's selection to a range that includes every table in the document. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
Powroty
RangeBuilder
– nowy kreator
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeEditor(emailAddress)
Usuwa danego użytkownika z listy edytorów Document
. Ta metoda nie blokuje użytkownikom dostępu do Document
, jeśli należą do klasy użytkowników z dostępem ogólnym – na przykład gdy zasób Document
jest udostępniany całej domenie użytkownika lub gdy Document
znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.
W przypadku plików na Dysku spowoduje to też usunięcie użytkownika z listy osób przeglądających.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddress | String | Adres e-mail użytkownika, którego chcesz usunąć. |
Powroty
Document
– ten element typu Document
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeEditor(user)
Usuwa danego użytkownika z listy edytorów Document
. Ta metoda nie blokuje użytkownikom dostępu do Document
, jeśli należą do klasy użytkowników z dostępem ogólnym – na przykład gdy zasób Document
jest udostępniany całej domenie użytkownika lub gdy Document
znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.
W przypadku plików na Dysku spowoduje to też usunięcie użytkownika z listy osób przeglądających.
Parametry
Nazwa | Typ | Opis |
---|---|---|
user | User | Reprezentacja użytkownika, który ma zostać usunięty. |
Powroty
Document
– ten element typu Document
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeViewer(emailAddress)
Usuwa danego użytkownika z listy przeglądających i komentujących elementu Document
. Ta metoda nie działa, jeśli użytkownik jest edytującym, a nie przeglądającym lub komentującym. Ta metoda nie blokuje też użytkownikom dostępu do zasobu Document
, jeśli należą do klasy użytkowników z ogólnymi uprawnieniami dostępu – na przykład gdy Document
jest udostępniony całej domenie użytkownika lub gdy Document
znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.
W przypadku plików na Dysku spowoduje to też usunięcie użytkownika z listy edytorów.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddress | String | Adres e-mail użytkownika, którego chcesz usunąć. |
Powroty
Document
– ten element typu Document
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeViewer(user)
Usuwa danego użytkownika z listy przeglądających i komentujących elementu Document
. Ta metoda nie działa, jeśli użytkownik jest edytorem, a nie przeglądającym. Ta metoda nie blokuje też użytkownikom dostępu do Document
, jeśli należą do klasy użytkowników z ogólnymi uprawnieniami dostępu – na przykład gdy Document
jest udostępniony całej domenie użytkownika lub Document
znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.
W przypadku plików na Dysku spowoduje to też usunięcie użytkownika z listy edytorów.
Parametry
Nazwa | Typ | Opis |
---|---|---|
user | User | Reprezentacja użytkownika, który ma zostać usunięty. |
Powroty
Document
– ten element typu Document
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
saveAndClose()
Zapisuje bieżące Document
. Powoduje usunięcie i zastosowanie oczekujących aktualizacji.
Metoda saveAndClose()
jest automatycznie wywoływana po zakończeniu wykonywania skryptu w przypadku każdego otwartego elementu Document
z możliwością edytowania.
Nie można edytować zamkniętego elementu Document
. Użyj klawisza DocumentApp.openById()
, aby ponownie otworzyć
udostępniony dokument do edycji.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setCursor(position)
Ustawia kursor użytkownika w aktywnym dokumencie z użyciem parametru Position
. Skrypt ma dostęp tylko do kursora użytkownika, który go uruchamia, i tylko wtedy, gdy jest powiązany z dokumentem.
// Append a paragraph, then place the user's cursor after the first word of the new paragraph. var doc = DocumentApp.getActiveDocument(); var paragraph = doc.getBody().appendParagraph('My new paragraph.'); var position = doc.newPosition(paragraph.getChild(0), 2); doc.setCursor(position);
Parametry
Nazwa | Typ | Opis |
---|---|---|
position | Position | nowe położenie kursora |
Powroty
Document
– ten Document
, do łańcuchów
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLanguage(languageCode)
Określa kod języka dokumentu. Jest to język wyświetlany w edytorze dokumentu po wybraniu opcji Plik > Język. Może to nie być rzeczywisty język dokumentu. Użyj getSupportedLanguageCodes()
, aby uzyskać wszystkie prawidłowe kody językowe.
Parametry
Nazwa | Typ | Opis |
---|---|---|
languageCode | String | Kod języka. |
Powroty
Document
– ten element typu Document
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setName(name)
Określa tytuł dokumentu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
name | String | tytuł nowego dokumentu |
Powroty
Document
– bieżący dokument.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setSelection(range)
Określa wybór użytkownika w aktywnym dokumencie z określoną wartością Range
. Skrypt ma dostęp tylko do użytkownika, który ma go uruchamiać, i tylko wtedy, gdy jest powiązany z dokumentem.
// Change the user's selection to a range that includes every table in the document. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
Parametry
Nazwa | Typ | Opis |
---|---|---|
range | Range | nowy zakres elementów do zaznaczenia |
Powroty
Document
– ten Document
, do łańcuchów
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents