Class Document

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ą DocumentApp.

// 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. getBody()) można przekształcić tak, aby obsługiwały karty za pomocą metod getTabs() i Tab.asDocumentTab().

Metody

Metoda	Zwracany typ	Krótki opis
`addBookmark(position)`	`Bookmark`	Dodaje `Bookmark` w podanym `Position` na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie.
`addEditor(emailAddress)`	`Document`	Dodaje podanego użytkownika do listy edytujących `Document`.
`addEditor(user)`	`Document`	Dodaje podanego użytkownika do listy edytujących `Document`.
`addEditors(emailAddresses)`	`Document`	Dodaje podaną tablicę użytkowników do listy edytujących `Document`.
`addFooter()`	`FooterSection`	Dodaje sekcję stopki (jeśli nie istnieje) do pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, do aktywnej karty.
`addHeader()`	`HeaderSection`	Dodaje sekcję nagłówka (jeśli nie istnieje) do pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, do aktywnej karty.
`addNamedRange(name, range)`	`NamedRange`	Dodaje `NamedRange`, 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.
`addViewer(emailAddress)`	`Document`	Dodaje podanego użytkownika do listy osób, które mogą wyświetlać `Document`.
`addViewer(user)`	`Document`	Dodaje podanego użytkownika do listy osób, które mogą wyświetlać `Document`.
`addViewers(emailAddresses)`	`Document`	Dodaje podaną tablicę użytkowników do listy widzów `Document`.
`getActiveTab()`	`Tab\|null`	Pobiera aktualnie aktywny `Tab` użytkownika w dokumencie.
`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 `Body` pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, `DocumentBodySection` aktywnej karty.
`getBookmark(id)`	`Bookmark\|null`	Pobiera `Bookmark` o podanym identyfikatorze z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, z aktywnej karty.
`getBookmarks()`	`Bookmark[]`	Pobiera wszystkie obiekty `Bookmark` z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, z aktywnej karty.
`getCursor()`	`Position\|null`	Pobiera kursor użytkownika na aktywnej karcie.
`getEditors()`	`User[]`	Pobiera listę edytorów tego `Document`.
`getFooter()`	`FooterSection\|null`	Pobiera sekcję stopki pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, sekcję stopki aktywnej karty.
`getFootnotes()`	`Footnote[]`	Pobiera wszystkie elementy `Footnote` w treści pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, w treści aktywnej karty.
`getHeader()`	`HeaderSection\|null`	Pobiera sekcję nagłówka pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, sekcję nagłówka aktywnej karty.
`getId()`	`String`	Pobiera unikalny identyfikator dokumentu.
`getLanguage()`	`String\|null`	Pobiera kod języka dokumentu.
`getName()`	`String`	Pobiera tytuł dokumentu.
`getNamedRangeById(id)`	`NamedRange\|null`	Pobiera `NamedRange` o podanym identyfikatorze z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, z aktywnej karty.
`getNamedRanges()`	`NamedRange[]`	Pobiera wszystkie obiekty `NamedRange` z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, z aktywnej karty.
`getNamedRanges(name)`	`NamedRange[]`	Pobiera wszystkie obiekty o podanej nazwie na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie.`NamedRange`
`getSelection()`	`Range\|null`	Pobiera wybór użytkownika na aktywnej karcie.
`getSupportedLanguageCodes()`	`String[]`	Pobiera wszystkie kody języków obsługiwane w plikach Dokumentów Google.
`getTab(tabId)`	`Tab\|null`	Pobiera `Tab` o określonym identyfikatorze.
`getTabs()`	`Tab[]`	Pobiera wszystkie niezagłębione elementy `Tab`, które są częścią dokumentu.
`getUrl()`	`String`	Pobiera adres URL dostępu do bieżącego dokumentu.
`getViewers()`	`User[]`	Pobiera listę przeglądających i komentujących dla tego `Document`.
`newPosition(element, offset)`	`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.
`newRange()`	`RangeBuilder`	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.
`removeEditor(emailAddress)`	`Document`	Usuwa danego użytkownika z listy osób edytujących `Document`.
`removeEditor(user)`	`Document`	Usuwa danego użytkownika z listy osób edytujących `Document`.
`removeViewer(emailAddress)`	`Document`	Usuwa danego użytkownika z listy przeglądających i komentujących `Document`.
`removeViewer(user)`	`Document`	Usuwa danego użytkownika z listy przeglądających i komentujących `Document`.
`saveAndClose()`	`void`	Zapisuje bieżący `Document`.
`setActiveTab(tabId)`	`void`	Ustawia wybraną przez użytkownika `Tab` w bieżącym dokumencie na kartę o określonym identyfikatorze.
`setCursor(position)`	`Document`	Ustawia kursor użytkownika na podstawie wartości `Position`.
`setLanguage(languageCode)`	`Document`	Ustawia kod języka dokumentu.
`setName(name)`	`Document`	Ustawia tytuł dokumentu.
`setSelection(range)`	`Document`	Ustawia zaznaczenie użytkownika na aktywnej karcie na podstawie podanego `Range`.

Szczegółowa dokumentacja

`addBookmark(position)`

Dodaje 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 DocumentTab.addBookmark(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('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

`addEditor(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
`emailAddress`	`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

`addEditor(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

`addEditors(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
`emailAddresses`	`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

`addFooter()`

Dodaje sekcję stopki (jeśli nie istnieje) do pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, do aktywnej karty. Aby dodać sekcję stopki do dowolnej karty, użyj metody DocumentTab.addFooter().

// 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 footer to the document's active or first tab.
const footer = doc.addFooter();

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

Powrót

FooterSection – stopka 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

`addHeader()`

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 DocumentTab.addHeader().

// 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

HeaderSection – 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

`addNamedRange(name, range)`

Dodaje NamedRange, 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ć NamedRange na dowolnej karcie, użyj metody DocumentTab.addNamedRange(name, range). 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. Po dodaniu NamedRange 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 NamedRange. 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ą znaku `newRange()`.

Powrót

NamedRange – NamedRange.

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

`addViewer(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
`emailAddress`	`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

`addViewer(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

`addViewers(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
`emailAddresses`	`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

`getActiveTab()`

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|null – obecnie 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

`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('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
`contentType`	`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.

`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('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.

`getBody()`

Pobiera Body pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, DocumentBodySection aktywnej karty. Aby uzyskać DocumentBodySection dowolnej karty, użyj metody DocumentTab.getBody().

Karty mogą zawierać różne typy sekcji (np. HeaderSection, FooterSection). Aktywna sekcja karty to Body.

Metody elementów w Document są przekazywane 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

`getBookmark(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 DocumentTab.getBookmark(id). Jeśli na 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 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

`getBookmarks()`

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 DocumentTab.getBookmarks().

// 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

`getCursor()`

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

`getEditors()`

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

`getFooter()`

Pobiera sekcję stopki pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, sekcję stopki aktywnej karty. Aby przejść do sekcji stopki na dowolnej karcie, użyj metody DocumentTab.getFooter().

// 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 footer and logs it to the console.
console.log(doc.getFooter().getText());

Powrót

FooterSection|null – stopka 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

`getFootnotes()`

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 DocumentTab.getFootnotes().

Wywołania funkcji getFootnotes 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[] – 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

`getHeader()`

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 DocumentTab.getHeader().

// 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

HeaderSection|null – 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

`getId()`

Pobiera unikalny identyfikator dokumentu. Identyfikator dokumentu jest używany z parametrem DocumentApp.openById() 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

`getLanguage()`

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|null – 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

`getName()`

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

`getNamedRangeById(id)`

Pobiera NamedRange o podanym identyfikatorze z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, z aktywnej karty. Aby pobrać element NamedRange o podanym identyfikatorze na dowolnej karcie, użyj metody DocumentTab.getNamedRangeById(id). Jeśli na karcie nie ma takiego elementu NamedRange, ta metoda zwraca wartość null. 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.

Parametry

Nazwa	Typ	Opis
`id`	`String`	Identyfikator zakresu, który jest unikalny w obrębie karty.

Powrót

NamedRange|null – NamedRange 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

`getNamedRanges()`

Pobiera wszystkie obiekty NamedRange z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, z aktywnej karty. Aby pobrać wszystkie obiekty NamedRange na dowolnej karcie, użyj metody DocumentTab.getNamedRanges().

Do NamedRange 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

NamedRange[] – tablica obiektów NamedRange 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

`getNamedRanges(name)`

Pobiera wszystkie obiekty o podanej nazwie na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie.NamedRange Aby pobrać wszystkie obiekty NamedRange na dowolnej karcie, użyj metody DocumentTab.getNamedRanges(name). 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 NamedRange 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

NamedRange[] – tablica obiektów NamedRange 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

`getSelection()`

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

`getSupportedLanguageCodes()`

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

`getTab(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
`tabId`	`String`	Identyfikator karty, którą chcesz pobrać.

Powrót

Tab|null – 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

`getTabs()`

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

`getUrl()`

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

`getViewers()`

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

`newPosition(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 DocumentTab.newPosition(element, offset). 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

`newRange()`

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 DocumentRange z elementów kart na dowolnej karcie, użyj metody DocumentTab.newRange().

// 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

RangeBuilder – 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

`removeEditor(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
`emailAddress`	`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

`removeEditor(user)`

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

`removeViewer(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
`emailAddress`	`String`	Adres e-mail użytkownika, którego chcesz usunąć.

Powrót

Document – ten 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

`removeViewer(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 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

`saveAndClose()`

Zapisuje bieżący Document. Powoduje opróżnienie i zastosowanie oczekujących aktualizacji.

Metoda saveAndClose() jest automatycznie wywoływana na końcu wykonywania skryptu dla każdego otwartego edytowalnego Document.

Zamkniętego Document nie można edytować. Użyj DocumentApp.openById(), 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

`setActiveTab(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
`tabId`	`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

`setCursor(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

`setLanguage(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 getSupportedLanguageCodes(), aby uzyskać wszystkie prawidłowe kody języka.

Parametry

Nazwa	Typ	Opis
`languageCode`	`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

`setName(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

`setSelection(range)`

Ustawia zaznaczenie użytkownika na aktywnej karcie na podstawie podanego 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

Class Document Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.

Metody

Szczegółowa dokumentacja

addBookmark(position)

Parametry

Powrót

Autoryzacja

addEditor(emailAddress)

Parametry

Powrót

Autoryzacja

addEditor(user)

Parametry

Powrót

Autoryzacja

addEditors(emailAddresses)

Parametry

Powrót

Autoryzacja

addFooter()

Powrót

Autoryzacja

addHeader()

Powrót

Autoryzacja

addNamedRange(name, range)

Parametry

Powrót

Autoryzacja

addViewer(emailAddress)

Parametry

Powrót

Autoryzacja

addViewer(user)

Parametry

Powrót

Autoryzacja

addViewers(emailAddresses)

Parametry

Powrót

Autoryzacja

getActiveTab()

Powrót

Autoryzacja

getAs(contentType)

Parametry

Powrót

getBlob()

Powrót

getBody()

Powrót

Autoryzacja

getBookmark(id)

Parametry

Powrót

Autoryzacja

getBookmarks()

Powrót

Autoryzacja

getCursor()

Powrót

Autoryzacja

getEditors()

Powrót

Autoryzacja

getFooter()

Powrót

Autoryzacja

getFootnotes()

Powrót

Autoryzacja

getHeader()

Powrót

Autoryzacja

getId()

Powrót

Autoryzacja

getLanguage()

Powrót

Autoryzacja

Class Document

`addBookmark(position)`

`addEditor(emailAddress)`

`addEditor(user)`

`addEditors(emailAddresses)`

`addFooter()`

`addHeader()`

`addNamedRange(name, range)`

`addViewer(emailAddress)`

`addViewer(user)`

`addViewers(emailAddresses)`

`getActiveTab()`

`getAs(contentType)`

`getBlob()`

`getBody()`

`getBookmark(id)`

`getBookmarks()`

`getCursor()`

`getEditors()`

`getFooter()`

`getFootnotes()`

`getHeader()`

`getId()`

`getLanguage()`

`getName()`

`getNamedRangeById(id)`

`getNamedRanges()`

`getNamedRanges(name)`

`getSelection()`

`getSupportedLanguageCodes()`

`getTab(tabId)`

`getTabs()`

`getUrl()`

`getViewers()`

`newPosition(element, offset)`

`newRange()`

`removeEditor(emailAddress)`

`removeEditor(user)`

`removeViewer(emailAddress)`

`removeViewer(user)`

`saveAndClose()`

`setActiveTab(tabId)`

`setCursor(position)`

`setLanguage(languageCode)`

`setName(name)`