Class Document

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

Dokument zawierający tekst sformatowany i elementy, takie jak tabele i listy.

Dokumenty można otwierać lub tworzyć przy użyciu aplikacji DocumentApp.

// Open a document by ID.
var doc = DocumentApp.openById("<my-id>");

// Create and open a document.
doc = DocumentApp.create("Document Title");

Metody

MetodaZwracany typKrótki opis
addBookmark(position)BookmarkDodaje pole Bookmark w danym elemencie Position.
addEditor(emailAddress)DocumentDodaje wybranego użytkownika do listy edytorów Document.
addEditor(user)DocumentDodaje wybranego użytkownika do listy edytorów Document.
addEditors(emailAddresses)DocumentDodaje określoną tablicę użytkowników do listy edytorów Document.
addFooter()FooterSectionDodaje sekcję stopki dokumentu, jeśli nie istnieje.
addHeader()HeaderSectionDodaje sekcję nagłówka dokumentu, jeśli nie istnieje.
addNamedRange(name, range)NamedRangeDodaje wartość NamedRange w polu Range, która ma nazwę i identyfikator do późniejszego pobrania.
addViewer(emailAddress)DocumentDodaje danego użytkownika do listy widzów elementu Document.
addViewer(user)DocumentDodaje danego użytkownika do listy widzów elementu Document.
addViewers(emailAddresses)DocumentDodaje określoną tablicę użytkowników do listy widzów elementu Document.
getAs(contentType)BlobPobiera bieżącą zawartość Document jako obiekt blob określonego typu.
getBlob()BlobPobiera bieżącą zawartość Document jako obiekt blob.
getBody()BodyPobiera Body aktywnego dokumentu.
getBookmark(id)BookmarkPobiera Bookmark o podanym identyfikatorze.
getBookmarks()Bookmark[]Pobiera wszystkie obiekty Bookmark w dokumencie.
getCursor()PositionPobiera kursor użytkownika w aktywnym dokumencie.
getEditors()User[]Pobiera listę edytorów tego pliku (Document).
getFooter()FooterSectionPobiera sekcję stopki dokumentu, jeśli taka istnieje.
getFootnotes()Footnote[]Pobiera wszystkie elementy Footnote w treści dokumentu.
getHeader()HeaderSectionPobiera sekcję nagłówka dokumentu, jeśli taka istnieje.
getId()StringPobiera unikalny identyfikator dokumentu.
getLanguage()StringPobiera kod języka dokumentu.
getName()StringPobiera tytuł dokumentu.
getNamedRangeById(id)NamedRangePobiera NamedRange o podanym identyfikatorze.
getNamedRanges()NamedRange[]Pobiera wszystkie obiekty NamedRange w dokumencie.
getNamedRanges(name)NamedRange[]Pobiera wszystkie obiekty NamedRange w dokumencie o podanej nazwie.
getSelection()RangePobiera zaznaczenie użytkownika w aktywnym dokumencie.
getSupportedLanguageCodes()String[]Pobiera wszystkie kody języków obsługiwane w plikach Dokumentów Google.
getUrl()StringPobiera adres URL umożliwiający dostęp do bieżącego dokumentu.
getViewers()User[]Pobiera listę widzów i komentarzy do filmu Document.
newPosition(element, offset)PositionTworzy nowy obiekt Position, który jest odniesieniem do lokalizacji w dokumencie względem konkretnego elementu.
newRange()RangeBuilderTworzy konstruktor służący do tworzenia obiektów Range z elementów dokumentu.
removeEditor(emailAddress)DocumentUsunięcie użytkownika z listy edytorów Document.
removeEditor(user)DocumentUsunięcie użytkownika z listy edytorów Document.
removeViewer(emailAddress)DocumentUsunięcie użytkownika z listy widzów i komentujących: Document.
removeViewer(user)DocumentUsunięcie użytkownika z listy widzów i komentujących: Document.
saveAndClose()voidZapisuje bieżący plik Document.
setCursor(position)DocumentUstawia kursor użytkownika w aktywnym dokumencie z uwzględnieniem elementu Position.
setLanguage(languageCode)DocumentUstawia kod języka dokumentu.
setName(name)DocumentUstawia tytuł dokumentu.
setSelection(range)DocumentUstawia wybór użytkownika w aktywnym dokumencie, biorąc pod uwagę Range.

Szczegółowa dokumentacja

addBookmark(position)

Dodaje pole Bookmark w danym elemencie Position.

Parametry

NazwaTypOpis
positionPositionpołożenie nowej zakładki,

Zwróć

Bookmark – nowa zakładka

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addEditor(emailAddress)

Dodaje wybranego użytkownika do listy edytorów Document. Jeśli użytkownik był już na liście widzów, ta metoda powoduje, że zostanie on usunięty z listy widzów.

Parametry

NazwaTypOpis
emailAddressStringAdres e-mail użytkownika, którego chcesz dodać.

Zwróć

Document – to Document do łańcucha.

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addEditor(user)

Dodaje wybranego użytkownika do listy edytorów Document. Jeśli użytkownik był już na liście widzów, ta metoda powoduje, że zostanie on usunięty z listy widzów.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika do dodania.

Zwróć

Document – to Document do łańcucha.

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addEditors(emailAddresses)

Dodaje określoną tablicę użytkowników do listy edytorów Document. Jeśli którykolwiek użytkownik był na liście widzów, ta metoda spowoduje, że znikną oni z listy widzów.

Parametry

NazwaTypOpis
emailAddressesString[]Tablica adresów e-mail użytkowników do dodania.

Zwróć

Document – to Document do łańcucha.

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addFooter()

Dodaje sekcję stopki dokumentu, jeśli nie istnieje.

Zwróć

FooterSection – stopka dokumentu;

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu 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 dokumentu, jeśli nie istnieje.

Zwróć

HeaderSection – nagłówek dokumentu;

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addNamedRange(name, range)

Dodaje wartość NamedRange w polu Range, która ma nazwę i identyfikator do późniejszego pobrania. Nazwy nie zawsze muszą być unikalne. Wiele różnych zakresów w tym samym dokumencie może mieć taką samą nazwę, podobnie jak klasa w kodzie HTML. Z kolei identyfikatory w obrębie dokumentu są unikalne, tak jak w HTML-u. Po dodaniu atrybutu NamedRange do dokumentu nie możesz go zmienić. Możesz go tylko usunąć.

Każdy skrypt, który uzyskuje dostęp do dokumentu, może uzyskać dostęp do NamedRange. Aby uniknąć niezamierzonych konfliktów między skryptami, możesz poprzedzać nazwy zakresów unikalnym ciągiem 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

NazwaTypOpis
nameStringNazwa zakresu, która nie musi być unikalna; nazwy muszą mieć od 1 do 256 znaków.
rangeRangeZakres elementów, które można powiązać z nazwą. Zakres może być aktywny wybór, wynik wyszukiwania lub ręcznie utworzony za pomocą newRange().

Zwróć

NamedRangeNamedRange.

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu co najmniej jednego 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 widzów elementu Document. Jeśli użytkownik był już na liście edytorów, ta metoda nie ma żadnego efektu.

Parametry

NazwaTypOpis
emailAddressStringAdres e-mail użytkownika, którego chcesz dodać.

Zwróć

Document – to Document do łańcucha.

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu co najmniej jednego 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 widzów elementu Document. Jeśli użytkownik był już na liście edytorów, ta metoda nie ma żadnego efektu.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika do dodania.

Zwróć

Document – to Document do łańcucha.

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addViewers(emailAddresses)

Dodaje określoną tablicę użytkowników do listy widzów elementu Document. Jeśli którykolwiek użytkownik był już na liście edytorów, ta metoda nie będzie miała wpływu na jego konto.

Parametry

NazwaTypOpis
emailAddressesString[]Tablica adresów e-mail użytkowników do dodania.

Zwróć

Document – to Document do łańcucha.

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu 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.

Parametry

NazwaTypOpis
contentTypeStringtyp MIME, na który chcesz przekonwertować. Obecnie obsługiwany jest tylko typ 'application/pdf'

Zwróć

Blob – bieżący dokument jako obiekt blob;


getBlob()

Pobiera bieżącą zawartość Document jako obiekt blob.

Zwróć

Blob – bieżący dokument jako obiekt blob;


getBody()

Pobiera Body aktywnego dokumentu.

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

Metody elementów w Document są delegowane do aktywnego elementu Body.

Zwróć

Body – sekcja aktywnej dokumentu

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu 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. Ta metoda zwraca null, jeśli nie ma takiego elementu Bookmark.

Parametry

NazwaTypOpis
idStringidentyfikator zasobu Bookmark

Zwróć

BookmarkBookmark z podanym identyfikatorem lub null, jeśli nie ma takiego elementu Bookmark

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu 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 w dokumencie.

Zwróć

Bookmark[] – tablica obiektów Bookmark w dokumencie

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu 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 w aktywnym dokumencie. Skrypt ma dostęp tylko do kursora użytkownika, który go uruchamia, i tylko wtedy, gdy jest on 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.');
}

Zwróć

Position – ilustracja kursora użytkownika lub parametr null, jeśli użytkownik nie ma kursora w dokumencie lub jeśli skrypt nie jest powiązany z dokumentem.

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu 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 pliku (Document).

Zwróć

User[] – tablica użytkowników z uprawnieniami do edycji.

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getFooter()

Pobiera sekcję stopki dokumentu, jeśli taka istnieje.

Zwróć

FooterSection – stopka dokumentu;

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu 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 dokumentu.

Wywołania getFootnotes powodują powtórzenie elementów dokumentu. W przypadku dużych dokumentów unikaj niepotrzebnych wywołań tej metody.

Zwróć

Footnote[] – przypisy do dokumentów,

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu 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 dokumentu, jeśli taka istnieje.

Zwróć

HeaderSection – nagłówek dokumentu;

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu 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. Ten identyfikator jest używany w DocumentApp.openById() do otwierania określonej instancji dokumentu.

Zwróć

String – identyfikator dokumentu;

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu 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 widoczny w pliku > Język w edytorze dokumentów, który może nie być językiem, w którym dokument się znajduje.

Zwróć

String – język dokumentu lub null, jeśli nie został zdefiniowany.

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getName()

Pobiera tytuł dokumentu.

Zwróć

String – tytuł dokumentu;

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu 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. Ta metoda zwraca null, jeśli taki NamedRange nie istnieje. Nazwy nie muszą być niepowtarzalne. Różne zakresy w tym samym dokumencie mogą mieć taką samą nazwę, podobnie jak klasa w HTML. Z kolei identyfikatory w dokumencie są unikalne, tak jak identyfikatory w HTML-u.

Parametry

NazwaTypOpis
idStringunikalny identyfikator zakresu.

Zwróć

NamedRangeNamedRange z podanym identyfikatorem lub null, jeśli nie ma takiego zakresu

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu 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 w dokumencie.

Element NamedRange jest dostępny przez dowolny skrypt mający dostęp do dokumentu. Aby uniknąć niezamierzonych konfliktów między skryptami, możesz poprzedzać nazwy zakresów unikalnym ciągiem znaków.

Zwróć

NamedRange[] – tablica obiektów NamedRange w dokumencie, prawdopodobnie zawierająca wiele zakresów o tej samej nazwie

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu 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 NamedRange w dokumencie o podanej nazwie. Nazwy nie muszą być niepowtarzalne. Wiele różnych zakresów w tym samym dokumencie może mieć taką samą nazwę, podobnie jak klasa w HTML. Z kolei identyfikatory w obrębie dokumentu są unikalne, np. w formacie HTML.

Element NamedRange jest dostępny przez dowolny skrypt mający dostęp do dokumentu. Aby uniknąć niezamierzonych konfliktów między skryptami, możesz poprzedzać nazwy zakresów unikalnym ciągiem znaków.

Parametry

NazwaTypOpis
nameStringnazwę zakresu, która niekoniecznie jest unikalna;

Zwróć

NamedRange[] – tablica obiektów NamedRange w dokumencie o podanej nazwie

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getSelection()

Pobiera zaznaczenie użytkownika w aktywnym dokumencie. Skrypt ma dostęp tylko do wybranych użytkowników, którzy go uruchomią, i tylko wtedy, gdy są powiązani 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.');
}

Zwróć

Range – wybór użytkownika lub null, jeśli użytkownik nie wybrał żadnego elementu w dokumencie, zaznaczono tylko koniec akapitu, zaznaczono tylko koniec akapitu i nowego wiersza lub jeśli skrypt nie jest powiązany z dokumentem.

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu 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.

Zwróć

String[] – tablica kodów języków.

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getUrl()

Pobiera adres URL umożliwiający 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());

Zwróć

String – adres URL umożliwiający dostęp do bieżącego dokumentu.

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getViewers()

Pobiera listę widzów i komentarzy do filmu Document.

Zwróć

User[] – tablica użytkowników z uprawnieniami do wyświetlania lub komentowania.

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu 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 obiekt Position, który jest odniesieniem do lokalizacji w dokumencie względem konkretnego elementu. Kursor użytkownika jest reprezentowany jako Position między innymi.

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

NazwaTypOpis
elementElementelement, który będzie zawierać nowy element Position; musi to być element Text lub element kontenera taki jak Paragraph
offsetIntegerw 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

Zwróć

Position – nowy Position

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu co najmniej jednego 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 z 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());

Zwróć

RangeBuilder – nowy kreator

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeEditor(emailAddress)

Usunięcie 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 ogólnym dostępem – na przykład gdy Document jest udostępniany w całej domenie użytkownika lub gdy Document znajduje się na dysku współdzielonym, do którego ten użytkownik ma dostęp.

W przypadku plików na Dysku użytkownik zostanie też usunięty z listy przeglądających.

Parametry

NazwaTypOpis
emailAddressStringAdres e-mail użytkownika, którego chcesz usunąć.

Zwróć

Document – to Document do łańcucha.

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeEditor(user)

Usunięcie 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 ogólnym dostępem – na przykład gdy Document jest udostępniany w całej domenie użytkownika lub gdy Document znajduje się na dysku współdzielonym, do którego ten użytkownik ma dostęp.

W przypadku plików na Dysku użytkownik zostanie też usunięty z listy przeglądających.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika do usunięcia.

Zwróć

Document – to Document do łańcucha.

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeViewer(emailAddress)

Usunięcie użytkownika z listy widzów i komentujących: Document. Ta metoda nie działa, jeśli użytkownik jest edytorem, a nie przeglądającym lub komentującym. Ta metoda nie blokuje też dostępu do Document, jeśli należą oni do grupy użytkowników, którzy mają ogólny dostęp (na przykład jeśli Document jest udostępniony w całej domenie użytkownika lub Document znajduje się na dysku współdzielonym, do którego ten użytkownik ma dostęp).

W przypadku plików na Dysku użytkownik zostanie też usunięty z listy edytorów.

Parametry

NazwaTypOpis
emailAddressStringAdres e-mail użytkownika, którego chcesz usunąć.

Zwróć

Document – to Document do łańcucha.

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeViewer(user)

Usunięcie użytkownika z listy widzów i komentujących: Document. Ta metoda nie działa, jeśli użytkownik jest edytorem, a nie przeglądającym. Ta metoda również nie blokuje dostępu do zasobu Document, jeśli należą oni do grupy użytkowników, którzy mają ogólny dostęp (na przykład jeśli Document jest udostępniony w całej domenie użytkownika lub gdy Document znajduje się na dysku współdzielonym, do którego ten użytkownik ma dostęp).

W przypadku plików na Dysku użytkownik zostanie też usunięty z listy edytorów.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika do usunięcia.

Zwróć

Document – to Document do łańcucha.

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

saveAndClose()

Zapisuje bieżący plik Document. Powoduje, że oczekujące aktualizacje są usuwane i stosowane.

Metoda saveAndClose() jest automatycznie wywoływana na końcu wykonania skryptu w przypadku każdego otwartego kodu Document dostępnego do edycji.

Nie można edytować zamkniętego Document. Użyj DocumentApp.openById(), aby ponownie otworzyć dany dokument do edycji.

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu 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 w aktywnym dokumencie z uwzględnieniem elementu Position. Skrypt ma dostęp tylko do kursora użytkownika, który go uruchomi, i tylko wtedy, gdy jest on 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

NazwaTypOpis
positionPositionnowa lokalizacja kursora

Zwróć

Document – ten Document to łańcuch

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu 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 widoczny w pliku > Język w edytorze dokumentów, który może nie być językiem, w którym dokument się znajduje. Użyj kodu getSupportedLanguageCodes(), aby uzyskać wszystkie prawidłowe kody języków.

Parametry

NazwaTypOpis
languageCodeStringKod języka.

Zwróć

Document – to Document do łańcucha.

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu 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

NazwaTypOpis
nameStringnowy tytuł dokumentu

Zwróć

Document – bieżący dokument,

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setSelection(range)

Ustawia wybór użytkownika w aktywnym dokumencie, biorąc pod uwagę Range. Skrypt ma dostęp tylko do informacji o użytkowniku, który uruchomi skrypt – i tylko wtedy, gdy jest on 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

NazwaTypOpis
rangeRangenowy zakres elementów do wyboru

Zwróć

Document – ten Document to łańcuch

Upoważnienie

Skrypty, które używają tej metody, wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents