Class Document

Dokument

Dokument zawierający co najmniej 1 obiekt Tab, z których każdy zawiera zwykły tekst oraz 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 klasy Document, które bezpośrednio uzyskują dostęp do zawartości tekstu i ją modyfikują, działają na aktywnej karcie (w skryptach powiązanych z określonym dokumentem) lub na pierwszej karcie (jeśli aktywna karta jest niedostępna). Skrypty korzystające z tych metod (np. getBody()) można przenieść na karty pomocy, używając getTabs(), a następnie Tab.asDocumentTab().

Metody

MetodaZwracany typKrótki opis
addBookmark(position)BookmarkDodaje Bookmark w danym Position do pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, do aktywnej karty.
addEditor(emailAddress)DocumentDodaje danego użytkownika do listy edytujących Document.
addEditor(user)DocumentDodaje danego użytkownika do listy edytujących Document.
addEditors(emailAddresses)DocumentDodaje podany tablicowy zbiór użytkowników do listy edytujących w przypadku Document.
addFooter()FooterSectionDodaje sekcję stopki, jeśli nie ma żadnej, do pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, do aktywnej karty.
addHeader()HeaderSectionDodaje 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)NamedRangeDodaje element NamedRange, czyli element Range z nazwą i identyfikatorem do użycia do późniejszego pobrania, na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie.
addViewer(emailAddress)DocumentDodaje danego użytkownika do listy widzów Document.
addViewer(user)DocumentDodaje danego użytkownika do listy widzów Document.
addViewers(emailAddresses)DocumentDodaje podany tablicowy zbiór użytkowników do listy widzów Document.
getActiveTab()TabPobiera aktualnie aktywny Tab użytkownika w dokumencie.
getAs(contentType)BlobPobiera bieżącą zawartość Document jako blob określonego typu.
getBlob()BlobPobiera bieżącą zawartość Document jako blob.
getBody()BodyPobiera wartość Body z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, wartość DocumentBodySection z aktywnej karty.
getBookmark(id)BookmarkPobiera Bookmark o danym identyfikatorze na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie.
getBookmarks()Bookmark[]Pobiera wszystkie obiekty Bookmark z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, z aktywnej karty.
getCursor()PositionPobiera kursor użytkownika na aktywnej karcie.
getEditors()User[]Pobiera listę edytorów tego Document.
getFooter()FooterSectionPobiera sekcję stopki pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, sekcję stopki aktywnej karty.
getFootnotes()Footnote[]Pobiera wszystkie elementy Footnote w ciele pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, w ciele aktywnej karty.
getHeader()HeaderSectionPobiera sekcję nagłówka pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, sekcję nagłówka aktywnej karty.
getId()StringPobiera unikalny identyfikator dokumentu.
getLanguage()StringPobiera kod języka dokumentu.
getName()StringPobiera tytuł dokumentu.
getNamedRangeById(id)NamedRangePobiera NamedRange o danym identyfikatorze na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie.
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 NamedRange o danej nazwie na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie.
getSelection()RangePobiera wybrany przez użytkownika element na karcie aktywnej.
getSupportedLanguageCodes()String[]Pobiera wszystkie kody języków obsługiwane w plikach Dokumentów Google.
getTab(tabId)TabPobiera Tab o określonym identyfikatorze.
getTabs()Tab[]Pobiera wszystkie niezawinicowione Tab, które są częścią dokumentu.
getUrl()StringPobiera adres URL dostępu do bieżącego dokumentu.
getViewers()User[]Pobiera listę osób, które oglądały lub komentowały ten Document.
newPosition(element, offset)PositionTworzy nową zmienną Position, która jest odwołaniem do lokalizacji na karcie względem określonego elementu na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, do aktywnej karty.
newRange()RangeBuilderTworzy kreator służący 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)DocumentUsunięcie danego użytkownika z listy edytujących w przypadku Document.
removeEditor(user)DocumentUsunięcie danego użytkownika z listy edytujących w przypadku Document.
removeViewer(emailAddress)DocumentUsunięcie danego użytkownika z listy widzów i komentujących Document.
removeViewer(user)DocumentUsunięcie danego użytkownika z listy widzów i komentujących Document.
saveAndClose()voidZapisuje bieżący Document.
setActiveTab(tabId)voidUstawia wybrany przez użytkownika element Tab w bieżącym dokumencie na kartę o określonym identyfikatorze.
setCursor(position)DocumentUstawia kursor użytkownika na podstawie Position.
setLanguage(languageCode)DocumentUstawia kod języka dokumentu.
setName(name)DocumentUstawia tytuł dokumentu.
setSelection(range)DocumentUstawia wybrany przez użytkownika element na karcie aktywnej, pod warunkiem że Range.

Szczegółowa dokumentacja

addBookmark(position)

Dodaje Bookmark w danym Position do pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, do aktywnej karty. 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

NazwaTypOpis
positionPositionpozycja nowej zakładki.

Powrót

Bookmark – nowa zakładka.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

addEditor(emailAddress)

Dodaje danego użytkownika do listy edytujących Document. Jeśli użytkownik był już na liście widzów, ta metoda powoduje usunięcie go z tej listy.

Parametry

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

Powrót

Document – ta Document służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

addEditor(user)

Dodaje danego użytkownika do listy edytujących Document. Jeśli użytkownik był już na liście widzów, ta metoda powoduje usunięcie go z tej listy.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika, którego chcesz dodać.

Powrót

Document – ta Document służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

addEditors(emailAddresses)

Dodaje podany tablicowy zbiór użytkowników do listy edytujących w przypadku Document. Jeśli któryś z użytkowników znajduje się już na liście widzów, ta metoda spowoduje usunięcie go z tej listy.

Parametry

NazwaTypOpis
emailAddressesString[]Tablica adresów e-mail użytkowników, których chcesz dodać.

Powrót

Document – ta Document służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

addFooter()

Dodaje sekcję stopki, jeśli nie ma żadnej, 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, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

addHeader()

Dodaje sekcję nagłówka (jeśli nie istnieje) do pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, do aktywnej karty. Aby dodać nagłówek 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, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

addNamedRange(name, range)

Dodaje element NamedRange, czyli element Range z nazwą i identyfikatorem do użycia do późniejszego pobrania, 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. W tym samym dokumencie może być kilka różnych zakresów o tej samej nazwie, podobnie jak klasa w HTML. Identyfikatory są natomiast unikalne w dokumentach, podobnie jak identyfikatory w HTML. Po dodaniu NamedRange do dokumentu nie można go zmodyfikować, można 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, 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

NazwaTypOpis
nameStringNazwa zakresu, która nie musi być niepowtarzalna. Nazwy zakresów muszą mieć od 1 do 256 znaków.
rangeRangeZakres elementów do powiązania z nazwą. Zakres może być aktywnym wyborem, wynikiem wyszukiwania lub zostać ręcznie utworzony za pomocą atrybutu newRange().

Powrót

NamedRange – NamedRange.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

addViewer(emailAddress)

Dodaje danego użytkownika do listy widzów Document. Jeśli użytkownik był już na liście redaktorów, ta metoda nie przyniesie efektu.

Parametry

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

Powrót

Document – ta Document służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

addViewer(user)

Dodaje danego użytkownika do listy widzów Document. Jeśli użytkownik był już na liście redaktorów, ta metoda nie przyniesie efektu.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika, którego chcesz dodać.

Powrót

Document – ta Document służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

addViewers(emailAddresses)

Dodaje podany tablicowy zbiór 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

NazwaTypOpis
emailAddressesString[]Tablica adresów e-mail użytkowników, których chcesz dodać.

Powrót

Document – ta Document służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

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 skrypt 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 – obecnie aktywny Tab użytkownika lub null, jeśli skrypt nie jest powiązany z dokumentem.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getAs(contentType)

Pobiera bieżącą zawartość Document jako 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

NazwaTypOpis
contentTypeStringTyp MIME, na który chcesz przekonwertować plik. Obsługiwane są typy 'application/pdf' i 'text/markdown'.

Powrót

Blob – bieżący dokument jako blob.

getBlob()

Pobiera bieżącą zawartość Document jako 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 blob.

getBody()

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

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

Metody elementów w Document są delegowane do aktywnego 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, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getBookmark(id)

Pobiera Bookmark o danym identyfikatorze na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie. Aby uzyskać zakładkę z zakładką, użyj metody DocumentTab.getBookmark(id). Ta metoda zwraca null, jeśli na karcie nie ma takiego elementu Bookmark. 

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

NazwaTypOpis
idStringIdentyfikator Bookmark.

Powrót

Bookmark – Bookmark o podanym identyfikatorze lub null, jeśli na karcie nie ma takiego Bookmark.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getBookmarks()

Pobiera wszystkie obiekty Bookmark z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, z aktywnej karty. Aby uzyskać dostęp do wszystkich zakładek 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, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getCursor()

Pobiera kursor użytkownika na aktywnej karcie. Skrypt może uzyskać dostęp do kursora tylko wtedy, gdy uruchamia go użytkownik, i tylko wtedy, gdy skrypt 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 – reprezentacja kursora użytkownika lub null, jeśli użytkownik nie ma kursora na karcie lub jeśli skrypt nie jest powiązany z dokumentem.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getEditors()

Pobiera listę edytorów tego Document.

Powrót

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

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getFooter()

Pobiera sekcję stopki pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, sekcję stopki aktywnej karty. Aby uzyskać sekcję 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 – stopka karty.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getFootnotes()

Pobiera wszystkie elementy Footnote w ciele pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, w ciele aktywnej karty. Aby uzyskać wszystkie przypisy w dowolnej karcie, użyj metody DocumentTab.getFootnotes().

Wywołania funkcji getFootnotes powodują iterację elementów 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 do karty.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getHeader()

Pobiera sekcję nagłówka pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, sekcję nagłówka aktywnej karty. Aby uzyskać nagłówek 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 – nagłówek karty.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getId()

Pobiera unikalny identyfikator dokumentu. Identyfikator dokumentu jest używany z DocumentApp.openById() do otwierania konkretnej wersji dokumentu.

Powrót

String – identyfikator dokumentu.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getLanguage()

Pobiera kod języka dokumentu. Jest to język wyświetlany w sekcji Plik > Język w edytorze dokumentu, ale może nie być rzeczywistym językiem dokumentu.

Powrót

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

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getName()

Pobiera tytuł dokumentu.

Powrót

String – tytuł dokumentu.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getNamedRangeById(id)

Pobiera NamedRange o danym identyfikatorze na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie. Aby uzyskać NamedRange z danym identyfikatorem na dowolnej karcie, użyj metody DocumentTab.getNamedRangeById(id). Ta metoda zwraca null, jeśli na karcie nie ma takiego elementu NamedRange. Nazwy nie muszą być unikalne, nawet na różnych kartach. Kilka różnych zakresów na tej samej karcie może mieć tę samą nazwę, podobnie jak klasa w HTML. Identyfikatory są natomiast unikalne na karcie, podobnie jak identyfikator w HTML.

Parametry

NazwaTypOpis
idStringIdentyfikator zakresu, który jest unikalny w ramach karty.

Powrót

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

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getNamedRanges()

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

Do NamedRange może uzyskać dostęp dowolny skrypt, który uzyskuje dostęp do karty. Aby uniknąć niezamierzonych 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, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getNamedRanges(name)

Pobiera wszystkie obiekty NamedRange o danej nazwie na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie. Aby uzyskać wszystkie obiekty NamedRange na dowolnej karcie, użyj metody DocumentTab.getNamedRanges(name). Nazwa nie musi być unikalna nawet na różnych kartach. Wiele różnych zakresów na tej samej karcie może mieć tę samą nazwę, podobnie jak klasa w HTML. Identyfikatory są natomiast unikalne w ramach karty, podobnie jak identyfikator w HTML.

Do NamedRange może uzyskać dostęp dowolny skrypt, który uzyskuje dostęp do dokumentu. Aby uniknąć niezamierzonych konfliktów między skryptami, rozważ dodanie do nazw zakresów unikalnego ciągu znaków.

Parametry

NazwaTypOpis
nameStringNazwa zakresu, która nie musi być unikalna.

Powrót

NamedRange[] – tablica obiektów NamedRange na karcie o podanej nazwie.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getSelection()

Pobiera wybrany przez użytkownika element na karcie aktywnej. Skrypt może uzyskać dostęp tylko do elementów wybranych przez użytkownika, który go uruchamia, i tylko wtedy, gdy skrypt 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 – reprezentacja zaznaczenia użytkownika lub null, jeśli użytkownik nie ma niczego zaznaczonego na karcie, jeśli zaznaczony jest tylko koniec akapitu, jeśli zaznaczony jest tylko koniec akapitu i nowy wiersz lub jeśli skrypt nie jest powiązany z dokumentem.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getSupportedLanguageCodes()

Pobiera wszystkie kody języków obsługiwane w plikach Dokumentów Google.

Powrót

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

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getTab(tabId)

Pobiera Tab o określonym identyfikatorze. Jeśli nie istnieje taka Tab, ta metoda zwraca null. mają dostęp do kart na dowolnym poziomie zagnieżdżenia.

Parametry

NazwaTypOpis
tabIdStringIdentyfikator karty, którą chcesz pobrać.

Powrót

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

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getTabs()

Pobiera wszystkie niezawinicowione Tab, które są częścią dokumentu.

Karty mogą zawierać karty podrzędne, czyli karty umieszczone w innej karcie. Karty podrzędne są dostępne za pomocą Tab.getChildTabs().

Powrót

Tab[] – lista wszystkich Tab, które są częścią dokumentu.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getUrl()

Pobiera adres URL 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 umożliwiający dostęp do bieżącego dokumentu.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getViewers()

Pobiera listę osób, które oglądały lub komentowały ten Document.

Powrót

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

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

newPosition(element, offset)

Tworzy nową zmienną Position, która jest odwołaniem do lokalizacji na karcie względem określonego elementu na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, do aktywnej karty. Aby utworzyć Position względem lokalizacji na dowolnej karcie, użyj metody DocumentTab.newPosition(element, offset). Kursor użytkownika jest reprezentowany przez Position, między innymi. 

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

NazwaTypOpis
elementElementElement, który powinien zawierać nowy element Position. Musi to być element Text lub element kontenera, np. Paragraph.
offsetIntegerW przypadku elementów Text liczba znaków przed Position; w przypadku innych elementów liczba elementów podrzędnych przed Position w tym samym elemencie kontenera.

Powrót

Position – nowy Position.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

newRange()

Tworzy kreator służący 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ć kreatora służącego do tworzenia obiektów DocumentRange z elementów karty 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, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

removeEditor(emailAddress)

Usunięcie danego użytkownika z listy edytujących w przypadku Document. Ta metoda nie blokuje dostępu do Document użytkownikom, którzy należą do grupy użytkowników z ogólnym dostępem. Na przykład, 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 widzów.

Parametry

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

Powrót

Document – ta Document służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

removeEditor(user)

Usunięcie danego użytkownika z listy edytujących w przypadku Document. Ta metoda nie blokuje dostępu do Document użytkownikom, którzy należą do grupy użytkowników z ogólnym dostępem. Na przykład, 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 widzów.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika do usunięcia.

Powrót

Document – ta Document służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

removeViewer(emailAddress)

Usunięcie danego użytkownika z listy widzów i komentujących Document. Ta metoda nie ma żadnego wpływu, jeśli użytkownik jest edytorem, a nie widzem lub komentatorem. Ta metoda nie blokuje też dostępu do Document użytkownikom, którzy należą do grupy użytkowników z ogólnym dostępem. Na przykład, 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 edytorów.

Parametry

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

Powrót

Document – Document do łańcucha.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

removeViewer(user)

Usunięcie danego użytkownika z listy widzów i komentujących Document. Ta metoda nie ma żadnego wpływu, jeśli użytkownik jest edytorem, a nie widzem. Ta metoda nie blokuje też dostępu do Document użytkownikom, którzy należą do grupy użytkowników z ogólnym dostępem. Na przykład 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.Document

W przypadku plików na Dysku spowoduje to również usunięcie użytkownika z listy edytorów.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika do usunięcia.

Powrót

Document – Document do łańcucha.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

saveAndClose()

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

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

Zamkniętego Document nie można edytować. Aby ponownie otworzyć dokument do edycji, użyj opcji DocumentApp.openById().

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setActiveTab(tabId)

Ustawia wybrany przez użytkownika element 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

NazwaTypOpis
tabIdStringIdentyfikator karty, którą chcesz ustawić jako aktywną.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setCursor(position)

Ustawia kursor użytkownika na podstawie Position. Skrypt może uzyskać dostęp do kursora tylko użytkownika, który go uruchamia, i tylko wtedy, gdy skrypt jest powiązany z dokumentem.

Przejście z nieaktywnej Position do 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

NazwaTypOpis
positionPositionNowa lokalizacja kursora.

Powrót

Document – ta Document służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setLanguage(languageCode)

Ustawia kod języka dokumentu. Jest to język wyświetlany w sekcji Plik > Język w edytorze dokumentu, ale może nie być rzeczywistym językiem dokumentu. Aby uzyskać listę wszystkich prawidłowych kodów języka, użyj polecenia getSupportedLanguageCodes().

Parametry

NazwaTypOpis
languageCodeStringKod języka.

Powrót

Document – ta Document służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setName(name)

Ustawia tytuł dokumentu.

Parametry

NazwaTypOpis
nameStringTytuł nowego dokumentu.

Powrót

Document – bieżący dokument.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setSelection(range)

Ustawia wybrany przez użytkownika element na karcie aktywnej, pod warunkiem że Range. Skrypt może uzyskać dostęp tylko do elementów wybranych przez użytkownika, który go uruchamia, i tylko wtedy, gdy skrypt 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

NazwaTypOpis
rangeRangeNowy zakres elementów do wybrania.

Powrót

Document – ta Document służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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