Class Document

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 Bookmark w danym elemencie Position.
addEditor(emailAddress)DocumentDodaje danego użytkownika do listy edytorów elementu Document.
addEditor(user)DocumentDodaje danego użytkownika do listy edytorów elementu Document.
addEditors(emailAddresses)DocumentDodaje podaną tablicę użytkowników do listy edytorów obiektu Document.
addFooter()FooterSectionDodaje sekcję stopki dokumentu, jeśli nie istnieje.
addHeader()HeaderSectionDodaje sekcję nagłówka dokumentu, jeśli nie istnieje.
addNamedRange(name, range)NamedRangeDodaje właściwość NamedRange, która jest Range z nazwą i identyfikatorem, których można później użyć do pobrania.
addViewer(emailAddress)DocumentDodaje danego użytkownika do listy gogli Document.
addViewer(user)DocumentDodaje danego użytkownika do listy gogli Document.
addViewers(emailAddresses)DocumentDodaje podaną tablicę użytkowników do listy widzów obiektu 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 na koncie 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 taki 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 wybór użytkownika w aktywnym dokumencie.
getSupportedLanguageCodes()String[]Pobiera wszystkie kody języków, które są 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 komentujących ten element (Document).
newPosition(element, offset)PositionTworzy nowy obiekt Position, który jest odniesieniem do lokalizacji w dokumencie do określonego elementu.
newRange()RangeBuilderTworzy kreatora, który służy do tworzenia obiektów Range z elementów dokumentu.
removeEditor(emailAddress)DocumentUsunięcie tego użytkownika z listy edytorów Document.
removeEditor(user)DocumentUsunięcie tego użytkownika z listy edytorów Document.
removeViewer(emailAddress)DocumentUsunięcie użytkownika z listy widzów i komentujących w przypadku Document.
removeViewer(user)DocumentUsunięcie użytkownika z listy widzów i komentujących w przypadku Document.
saveAndClose()voidZapisuje bieżącą tabelę Document.
setCursor(position)DocumentUstawia kursor użytkownika na aktywnym dokumencie, biorąc pod uwagę Position.
setLanguage(languageCode)DocumentUstawia kod języka dokumentu.
setName(name)DocumentOkreśla tytuł dokumentu.
setSelection(range)DocumentOkreśla wybór użytkownika w aktywnym dokumencie, biorąc pod uwagę Range.

Szczegółowa dokumentacja

addBookmark(position)

Dodaje Bookmark w danym elemencie 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

NazwaTypOpis
positionPositionPozycja nowej zakładki.

Powrót

Bookmark – nowa zakładka.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

addEditor(emailAddress)

Dodaje danego użytkownika do listy edytorów elementu Document. Jeśli użytkownik był już na liście widzów, ta metoda przenosi go z listy.

Parametry

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

Powrót

Document – Document w celu tworzenia łańcuchów.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

addEditor(user)

Dodaje danego użytkownika do listy edytorów elementu Document. Jeśli użytkownik był już na liście widzów, ta metoda przenosi go z listy.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika do dodania.

Powrót

Document – Document w celu tworzenia łańcuchów.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 edytorów obiektu Document. Jeśli którykolwiek z użytkowników znajduje się już na liście widzów, ta metoda przenosi ich na listę widzów.

Parametry

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

Powrót

Document – Document w celu tworzenia łańcuchów.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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. 

// 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 footer to the document.
const footer = doc.addFooter();

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

Powrót

FooterSection – stopka dokumentu.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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. 

// 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');

Powrót

HeaderSection – nagłówek dokumentu.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

addNamedRange(name, range)

Dodaje właściwość NamedRange, która jest Range z nazwą i identyfikatorem, których można później użyć do pobrania. Nazwy nie muszą być niepowtarzalne. Różne zakresy w tym samym dokumencie mogą mieć tę samą nazwę, podobnie jak klasa w kodzie HTML. W przeciwieństwie do identyfikatorów w dokumencie HTML są one niepowtarzalne. Po dodaniu uprawnienia NamedRange do dokumentu nie możesz go zmodyfikować. Możesz tylko usunąć dokument.

Każdy skrypt, który ma dostęp do dokumentu, może uzyskać dostęp do NamedRange. Aby uniknąć niezamierzonego konfliktu między skryptami, możesz poprzedzać nazwy zakresów unikalnymi ciągami 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 zakresów muszą mieć od 1 do 256 znaków.
rangeRangeZakres elementów, które można powiązać z nazwą. Może to być aktywny wybór, wynik wyszukiwania lub utworzony ręcznie za pomocą newRange().

Powrót

NamedRange – NamedRange.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 gogli Document. Jeśli użytkownik był już na liście edytorów, ta metoda nie przyniesie efektu.

Parametry

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

Powrót

Document – Document w celu tworzenia łańcuchów.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 gogli Document. Jeśli użytkownik był już na liście edytorów, ta metoda nie przyniesie efektu.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika do dodania.

Powrót

Document – Document w celu tworzenia łańcuchów.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 obiektu Document. Jeśli którykolwiek z użytkowników był już na liście edytorów, ta metoda nie będzie miała dla nich żadnego wpływu.

Parametry

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

Powrót

Document – Document w celu tworzenia łańcuchów.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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('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

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

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('abc123456');

// 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 aktywnego dokumentu.

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

Metody elementów w Document są kierowane do aktywnej 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());

Powrót

Body – sekcja aktywnej treści dokumentu.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 wartość null, jeśli taki Bookmark 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');

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

NazwaTypOpis
idStringIdentyfikator elementu Bookmark.

Powrót

Bookmark – Bookmark z podanym identyfikatorem lub null, jeśli taki Bookmark nie istnieje.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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. 

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

Powrót

Bookmark[] – tablica obiektów Bookmark w dokumencie;

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 uruchomi, 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.');
}

Powrót

Position – reprezentacja kursora użytkownika lub null, jeśli w dokumencie nie ma kursora lub skrypt nie jest powiązany z dokumentem;

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 na koncie Document.

Powrót

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

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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. 

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

Powrót

FooterSection – stopka dokumentu.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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ą iterację elementów dokumentu. W przypadku dużych dokumentów unikaj 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());

Powrót

Footnote[] – przypisy do dokumentu

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 taki 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());

Powrót

HeaderSection – nagłówek dokumentu.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 w DocumentApp.openById() do otwierania określonej instancji dokumentu.

Powrót

String – identyfikator dokumentu;

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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. To język widoczny w edytorze dokumentów w sekcji Plik > Język. Może on nie być tym samym, co język dokumentu.

Powrót

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

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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;

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 wartość null, jeśli taki NamedRange nie istnieje. Nazwy nie muszą być niepowtarzalne. Różne zakresy w tym samym dokumencie mogą mieć tę samą nazwę, podobnie jak klasa w kodzie HTML. W przeciwieństwie do identyfikatorów w dokumencie HTML są one niepowtarzalne.

Parametry

NazwaTypOpis
idStringunikalny identyfikator zakresu w dokumencie.

Powrót

NamedRange – NamedRange o podanym identyfikatorze lub null, jeśli taki zakres nie istnieje.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 dla każdego skryptu, który uzyskuje dostęp do dokumentu. Aby uniknąć niezamierzonych konfliktów między skryptami, warto poprzedzić nazwy zakresów unikalnymi ciągami znaków.

Powrót

NamedRange[] – tablica obiektów NamedRange w dokumencie, która może zawierać wiele zakresów o tej samej nazwie;

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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. Kilka różnych zakresów w tym samym dokumencie może mieć taką samą nazwę, podobnie jak klasa w kodzie HTML. Z kolei identyfikatory w dokumencie są unikalne, podobnie jak w przypadku kodu HTML.

Element NamedRange jest dostępny dla każdego skryptu, który uzyskuje dostęp do dokumentu. Aby uniknąć niezamierzonych konfliktów między skryptami, warto poprzedzić nazwy zakresów unikalnymi ciągami znaków.

Parametry

NazwaTypOpis
nameStringnazwa zakresu, która niekoniecznie jest unikalna

Powrót

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

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 w aktywnym dokumencie. Skrypt ma dostęp tylko do zaznaczonego użytkownika, który uruchamia skrypt i tylko jeśli jest on 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.');
}

Powrót

Range – reprezentacja wyboru użytkownika lub null, jeśli użytkownik nie zaznaczył żadnego elementu w dokumencie, zaznaczony jest tylko koniec akapitu, zaznaczony jest tylko koniec akapitu i nowy wiersz lub skrypt nie jest powiązany z danym dokumentem;

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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, które są obsługiwane w plikach Dokumentów Google.

Powrót

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

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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());

Powrót

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

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 komentujących ten element (Document).

Powrót

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

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 do określonego elementu. Kursor użytkownika jest m.in. oznaczony jako 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

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 właściwością Position, a w przypadku innych elementów – liczbę elementów podrzędnych poprzedzających element Position w ramach tego samego elementu kontenera.

Powrót

Position – nowy Position

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

newRange()

Tworzy kreatora, który służy 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());

Powrót

RangeBuilder – nowy kreator

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

removeEditor(emailAddress)

Usunięcie tego użytkownika z listy edytorów Document. Ta metoda nie blokuje dostępu do Document, jeśli należą one do grupy użytkowników, którzy mają dostęp ogólny, na przykład jeśli Document jest udostępniany w całej domenie użytkownika lub gdy Document znajduje się na dysku współdzielonym, do którego ma dostęp użytkownik.

W przypadku plików na Dysku również zostanie on usunięty z listy przeglądających.

Parametry

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

Powrót

Document – Document w celu tworzenia łańcuchów.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

removeEditor(user)

Usunięcie tego użytkownika z listy edytorów Document. Ta metoda nie blokuje dostępu do Document, jeśli należą one do grupy użytkowników, którzy mają dostęp ogólny, na przykład jeśli Document jest udostępniany w całej domenie użytkownika lub gdy Document znajduje się na dysku współdzielonym, do którego ma dostęp użytkownik.

W przypadku plików na Dysku również zostanie on usunięty z listy przeglądających.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika do usunięcia.

Powrót

Document – Document w celu tworzenia łańcuchów.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 w przypadku 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 tych elementów: Document, jeśli należą one do grupy użytkowników, którzy mają ogólny dostęp, np. gdy element Document jest udostępniany w całej domenie użytkownika lub gdy Document znajduje się na dysku współdzielonym, do którego ma dostęp użytkownik.

W przypadku plików na Dysku również zostanie on usunięty z listy edytorów.

Parametry

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

Powrót

Document – to Document na potrzeby łańcucha.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 w przypadku Document. Ta metoda nie działa, jeśli użytkownik jest edytorem, a nie przeglądającym. Ta metoda nie blokuje też dostępu do tych elementów (Document), jeśli należą one do klasy użytkowników ogólnych, na przykład gdy element Document jest udostępniany w całej domenie użytkownika lub gdy dysk Document znajduje się na dysku współdzielonym, do którego ma dostęp użytkownik.

W przypadku plików na Dysku również zostanie on usunięty z listy edytorów.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika do usunięcia.

Powrót

Document – to Document na potrzeby łańcucha.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

saveAndClose()

Zapisuje bieżącą tabelę Document. Powoduje, że oczekujące aktualizacje są usuwane i stosowane.

Na końcu wykonywania skryptu każde wywołanie Document jest wywoływane automatycznie za pomocą metody saveAndClose().

Nie można edytować zamkniętej karty Document. Aby ponownie otworzyć dokument, który chcesz edytować, użyj DocumentApp.openById().

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 aktywnym dokumencie, biorąc pod uwagę 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

Powrót

Document – to Document na potrzeby łańcucha

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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. To język widoczny w edytorze dokumentów w sekcji Plik > Język. Może on nie być tym samym, co język dokumentu. Użyj kodu getSupportedLanguageCodes(), aby uzyskać wszystkie prawidłowe kody języków.

Parametry

NazwaTypOpis
languageCodeStringKod języka.

Powrót

Document – Document w celu tworzenia łańcuchów.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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

setName(name)

Określa tytuł dokumentu.

Parametry

NazwaTypOpis
nameStringtytuł nowego dokumentu,

Powrót

Document – bieżący dokument

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego 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, biorąc pod uwagę Range. Skrypt ma dostęp tylko do wybranego użytkownika, który go uruchomi, i tylko wtedy, gdy jest on powiązany z danym 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

Powrót

Document – to Document na potrzeby łańcucha

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:

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