Class Document

Dokument

Dokument zawierający co najmniej 1 obiekt Tab, z których każdy zawiera tekst sformatowany i takie jak tabele i listy.

Dokumenty można otwierać i tworzyć za pomocą DocumentApp.

// Open a document by ID.
var 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 tekstu i je modyfikują, działają na: aktywną kartę (w skryptach powiązanych z określonego dokumentu) lub pierwszej karty (jeśli aktywna jest niedostępna). Skrypty, na których bazują te metody (np. getBody()) można przenieść na obsługujące karty używające getTabs(), a następnie Tab.asDocumentTab().

Metody

MetodaZwracany typKrótki opis
addBookmark(position)BookmarkDodaje element Bookmark w danym Position na pierwszej karcie lub w przypadku skryptów, które są powiązane z dokumentem – aktywną kartą.
addEditor(emailAddress)DocumentDodaje danego użytkownika do listy edytorów zasobu Document.
addEditor(user)DocumentDodaje danego użytkownika do listy edytorów zasobu Document.
addEditors(emailAddresses)DocumentDodaje podaną tablicę użytkowników do listy edytorów zasobu Document.
addFooter()FooterSectionDodaje sekcję stopki (jeśli nie ma takiej opcji) do pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – do aktywnej karty.
addHeader()HeaderSectionDodaje sekcję nagłówka (jeśli nie ma takiej opcji) do pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – do aktywnej karty.
addNamedRange(name, range)NamedRangeDodaje obiekt NamedRange, który jest wartością Range, która ma nazwę i identyfikator dla pobierania na pierwszej karcie lub – w przypadku skryptów powiązanych z dokumentem – na aktywnej karcie.
addViewer(emailAddress)DocumentDodaje danego użytkownika do listy przeglądających w: Document.
addViewer(user)DocumentDodaje danego użytkownika do listy przeglądających w: Document.
addViewers(emailAddresses)DocumentDodaje podaną tablicę użytkowników do listy przeglądających obiekt Document.
getActiveTab()TabPobiera w dokumencie aktywne Tab użytkownika.
getAs(contentType)BlobPobiera bieżącą zawartość Document jako obiekt blob określonego typu.
getBlob()BlobPobiera bieżącą zawartość Document jako obiekt blob.
getBody()BodyPobiera wartość Body pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – uprawnienia DocumentBodySection aktywnej karty.
getBookmark(id)BookmarkPobiera element Bookmark z podanym identyfikatorem na pierwszej karcie lub aktywną kartę (w przypadku skryptów powiązanych z dokumentem).
getBookmarks()Bookmark[]Pobiera wszystkie obiekty Bookmark z pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – aktywną kartę.
getCursor()PositionPobiera kursor użytkownika na aktywnej karcie.
getEditors()User[]Pobiera listę edytorów elementu Document.
getFooter()FooterSectionPobiera sekcję stopki pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – stopkę aktywnej karty. .
getFootnotes()Footnote[]Pobiera wszystkie elementy Footnote z treści pierwszej karty lub w przypadku skryptów powiązanych z dokumentem treść aktywnej karty.
getHeader()HeaderSectionPobiera sekcję nagłówka pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – nagłówek aktywnej karty. .
getId()StringPobiera unikalny identyfikator dokumentu.
getLanguage()StringPobiera kod języka dokumentu.
getName()StringPobiera tytuł dokumentu.
getNamedRangeById(id)NamedRangePobiera element NamedRange z podanym identyfikatorem na pierwszej karcie lub aktywną kartę (w przypadku skryptów powiązanych z dokumentem).
getNamedRanges()NamedRange[]Pobiera wszystkie obiekty NamedRange z pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – aktywną kartę.
getNamedRanges(name)NamedRange[]Pobiera wszystkie obiekty NamedRange o danej nazwie na pierwszej karcie lub w przypadku skryptów, które są powiązane z dokumentem – aktywną kartą.
getSelection()RangePobiera elementy wybrane przez użytkownika z aktywnej karty.
getSupportedLanguageCodes()String[]Pobiera wszystkie kody języków obsługiwane w plikach Dokumentów Google.
getTab(tabId)TabPobiera obiekt Tab o podanym identyfikatorze.
getTabs()Tab[]Pobiera wszystkie niezagnieżdżone obiekty Tab, które są częścią dokumentu.
getUrl()StringPobiera adres URL umożliwiający dostęp do bieżącego dokumentu.
getViewers()User[]Pobiera listę przeglądających i komentujących dla elementu Document.
newPosition(element, offset)PositionTworzy nowy obiekt Position, który jest odwołaniem do lokalizacji na karcie względem konkretnego elementu na pierwszej karcie lub – w przypadku skryptów powiązanych z dokumentem – aktywnej karty.
newRange()RangeBuilderTworzy kreator służący do tworzenia obiektów Range z elementów karty w pierwszej karty lub w przypadku skryptów powiązanych z tagiem aktywnej karty.
removeEditor(emailAddress)DocumentUsuwa danego użytkownika z listy edytorów zasobu Document.
removeEditor(user)DocumentUsuwa danego użytkownika z listy edytorów zasobu Document.
removeViewer(emailAddress)DocumentUsuwa dane użytkownika z listy przeglądających i komentujących Document.
removeViewer(user)DocumentUsuwa dane użytkownika z listy przeglądających i komentujących Document.
saveAndClose()voidZapisuje bieżące ustawienie Document.
setActiveTab(tabId)voidUstawia element Tab wybrany przez użytkownika w bieżącym dokumencie na kartę o określonym identyfikatorze.
setCursor(position)DocumentUstawia kursor użytkownika z następującą wartością Position.
setLanguage(languageCode)DocumentUstawia kod języka dokumentu.
setName(name)DocumentOkreśla tytuł dokumentu.
setSelection(range)DocumentOkreśla wybór użytkownika w aktywnej karcie z uwzględnieniem Range.

Szczegółowa dokumentacja

addBookmark(position)

Dodaje element Bookmark w danym Position na pierwszej karcie lub w przypadku skryptów, które są powiązane z dokumentem – aktywną kartą. Aby dodać 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(DOCUMENT_ID);

// 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 korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

addEditor(emailAddress)

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

Parametry

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

Powrót

DocumentDocument do łańcuchów.

Autoryzacja

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

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

addEditor(user)

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

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika, który ma zostać dodany.

Powrót

DocumentDocument do łańcuchów.

Autoryzacja

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

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

addEditors(emailAddresses)

Dodaje podaną tablicę użytkowników do listy edytorów zasobu Document. Jeśli któryś z Użytkownicy byli już na liście widzów, więc ta metoda powoduje wyeliminowanie ich z listy widzów.

Parametry

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

Powrót

DocumentDocument do łańcuchów.

Autoryzacja

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

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

addFooter()

Dodaje sekcję stopki (jeśli nie ma takiej opcji) do pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – do aktywnej karty. Aby dodać stopkę 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(DOCUMENT_ID);

// Adds a footer to the document's active or first tab.
const footer = doc.addFooter();

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

Powrót

FooterSection – stopka karty.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z 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 ma takiej opcji) 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(DOCUMENT_ID);

// Adds a header to the document's active or first tab.
const header = doc.addHeader();

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

Powrót

HeaderSection – nagłówek karty.

Autoryzacja

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

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

addNamedRange(name, range)

Dodaje obiekt NamedRange, który jest wartością Range, która ma nazwę i identyfikator dla pobierania na pierwszej karcie lub – w przypadku skryptów powiązanych z dokumentem – na aktywnej karcie. Aby dodać element NamedRange na dowolnej karcie, użyj metody DocumentTab.addNamedRange(name, range). Nazwy nie są musi być unikalny; kilka różnych zakresów w tym samym dokumencie może mieć taką samą nazwę, bardzo jak klasa w języku HTML. Identyfikatory są natomiast unikalne w obrębie dokumentu, tak jak identyfikator w kodzie HTML. Po dodaniu elementu NamedRange do dokumentu nie można go zmodyfikować – możesz go tylko usunąć.

Każdy skrypt, który uzyskuje dostęp do dokumentu, może uzyskać dostęp do elementu NamedRange. Aby uniknąć niezamierzonego konflikty między skryptami, rozważ poprzedzenie nazw zakresów unikalnymi ciągami znaków.

// Creates a named range that includes every table in the active tab.
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]);
}
// 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ą być od 1 do 256 znaków.
rangeRangeZakres elementów, które mają zostać powiązane z nazwą; zakres może być aktywnym zaznaczeniem, wynikiem wyszukiwania lub ręcznie utworzonym za pomocą funkcji newRange().

Powrót

NamedRangeNamedRange.

Autoryzacja

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

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

addViewer(emailAddress)

Dodaje danego użytkownika do listy przeglądających w: Document. Jeśli użytkownik był już na liście redaktorów, ta metoda nie będzie działać.

Parametry

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

Powrót

DocumentDocument do łańcuchów.

Autoryzacja

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

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

addViewer(user)

Dodaje danego użytkownika do listy przeglądających w: Document. Jeśli użytkownik był już na liście redaktorów, ta metoda nie będzie działać.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika, który ma zostać dodany.

Powrót

DocumentDocument do łańcuchów.

Autoryzacja

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

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

addViewers(emailAddresses)

Dodaje podaną tablicę użytkowników do listy przeglądających obiekt Document. Jeśli któryś z Użytkownicy byli już na liście edytorów, ta metoda nie ma u nich żadnego efektu.

Parametry

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

Powrót

DocumentDocument do łańcuchów.

Autoryzacja

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

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

getActiveTab()

Pobiera w dokumencie aktywne Tab użytkownika. Skrypt ma dostęp tylko do aktywnej karty użytkownika, który uruchomił skrypt, 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 – użytkownik jest obecnie aktywny Tab lub null, jeśli skrypt nie jest powiązany z dokument.

Autoryzacja

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

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

getAs(contentType)

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

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// 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 ma zostać skonwertowany: Obsługiwane są języki 'application/pdf' i 'text/markdown'.

Powrót

Blob – bieżący dokument jako obiekt blob.


getBlob()

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

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// 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 wartość Body pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – uprawnienia DocumentBodySection aktywnej karty. Aby uzyskać DocumentBodySection dowolnej karty, użyj metody DocumentTab.getBody().

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

Metody elementów w narzędziu Document są przekazywane do aktywnego elementu Body.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the active or first tab's body.
const body = doc.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

Powrót

Body – sekcja treści karty.

Autoryzacja

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

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

getBookmark(id)

Pobiera element Bookmark z podanym identyfikatorem na pierwszej karcie lub aktywną kartę (w przypadku skryptów powiązanych z dokumentem). Aby uzyskać na dowolnej karcie, użyj metody DocumentTab.getBookmark(id). Ta metoda zwraca wartość null, jeśli na karcie nie ma takiego 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(DOCUMENT_ID);

// 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 elementu Bookmark.

Powrót

BookmarkBookmark z podanym identyfikatorem lub null, jeśli nie ma takiego identyfikatora Bookmark znajduje się na karcie.

Autoryzacja

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

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

getBookmarks()

Pobiera wszystkie obiekty Bookmark z pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – aktywną kartę. Aby uzyskać wszystkie 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(DOCUMENT_ID);

// Gets all of the bookmarks in the document's active or first tab.
const bookmarks = doc.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

Powrót

Bookmark[] – tablica obiektów Bookmark na karcie.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z 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 ma dostęp tylko do kursora użytkownika, który jest uruchomiony i tylko wtedy, gdy skrypt jest powiązany z dokumentem.

// Insert some text at the cursor position and make it bold.
var cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns null, the cursor's
  // containing element doesn't allow insertions, so show the user an error message.
  var element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

Powrót

Position – reprezentacja kursora użytkownika lub null, jeśli użytkownik nie ma kursor zostanie umieszczony na karcie lub jeśli skrypt nie jest powiązany z dokumentem.

Autoryzacja

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

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

getEditors()

Pobiera listę edytorów elementu Document.

Powrót

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

Autoryzacja

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

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

getFooter()

Pobiera sekcję stopki pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – stopkę aktywnej karty. . Aby wyświetlić sekcję stopki dowolnej karty, 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(DOCUMENT_ID);

// 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 korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getFootnotes()

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

Wywołania getFootnotes powodują wystąpienie iteracji nad elementami karty. W przypadku dużych kart unikaj zbędnych wywołań tej metody.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// 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 korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getHeader()

Pobiera sekcję nagłówka pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – nagłówek aktywnej karty. . Aby uzyskać sekcję nagłówka dowolnej karty, użyj metody DocumentTab.getHeader().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// 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 korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getId()

Pobiera unikalny identyfikator dokumentu. Identyfikator dokumentu jest używany w polu DocumentApp.openById() do otwierania określonych wystąpień dokumentu.

Powrót

String – identyfikator dokumentu.

Autoryzacja

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

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

getLanguage()

Pobiera kod języka dokumentu. Jest to język wyświetlany w pliku edytora dokumentów &gt; język, czyli rzeczywisty język dokumentu.

Powrót

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

Autoryzacja

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

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

getName()

Pobiera tytuł dokumentu.

Powrót

String – tytuł dokumentu.

Autoryzacja

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

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

getNamedRangeById(id)

Pobiera element NamedRange z podanym identyfikatorem na pierwszej karcie lub aktywną kartę (w przypadku skryptów powiązanych z dokumentem). Aby uzyskać NamedRange z podanym identyfikatorem na dowolnej karcie, użyj DocumentTab.getNamedRangeById(id) . Jeśli na karcie nie ma żadnego z tych elementów NamedRange, ta metoda zwraca wartość null. Nazwy nie muszą być unikalne nawet na różnych kartach; w ramach jednej karty można mają taką samą nazwę, jak klasa w kodzie HTML. Identyfikatory są natomiast unikalne na karcie, np. identyfikator w kodzie HTML.

Parametry

NazwaTypOpis
idStringIdentyfikator zakresu, który jest unikalny na karcie.

Powrót

NamedRangeNamedRange o podanym identyfikatorze lub null, jeśli nie ma takiego zakresu w kartę.

Autoryzacja

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

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

getNamedRanges()

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

Dostęp do elementu NamedRange można uzyskać za pomocą dowolnego skryptu, który uzyskuje dostęp do karty. Aby unikać niezamierzone konflikty między skryptami, rozważ dodanie do nazw zakresów unikalnych ciągów znaków.

Powrót

NamedRange[] – tablica obiektów NamedRange na karcie, zawierająca prawdopodobnie kilka wartości; zakresy o tej samej nazwie.

Autoryzacja

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

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

getNamedRanges(name)

Pobiera wszystkie obiekty NamedRange o danej nazwie na pierwszej karcie lub w przypadku skryptów, które są powiązane z dokumentem – aktywną kartą. Aby uzyskać wszystkich obiektów NamedRange na dowolnej karcie, użyj metody DocumentTab.getNamedRanges(name). Nazwy nie muszą być unikalne, nawet dla różnych kart. kilka różnych zakresów w ta sama karta może mieć taką samą nazwę, podobnie jak klasa w kodzie HTML. W przeciwieństwie do tego identyfikatory są unikalne. na karcie, tak jak identyfikator w kodzie HTML.

Dostęp do elementu NamedRange można uzyskać za pomocą dowolnego skryptu, który uzyskuje dostęp do dokumentu. Aby unikać niezamierzone konflikty między skryptami, rozważ dodanie do nazw zakresów unikalnych ciągów 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 korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getSelection()

Pobiera elementy wybrane przez użytkownika z aktywnej karty. Skrypt ma dostęp tylko do wyboru użytkownika kto uruchamia skrypt, 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.
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 go nie ma wszystko zaznaczone na karcie, o ile został zaznaczony tylko koniec akapitu, lub tylko koniec akapitu. tekstu i nowego wiersza oraz gdy skrypt nie jest powiązany z dokumentem.

Autoryzacja

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

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

getSupportedLanguageCodes()

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

Powrót

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

Autoryzacja

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

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

getTab(tabId)

Pobiera obiekt Tab o podanym identyfikatorze. Jeśli nie ma takiego elementu Tab, ta metoda zwraca wartość null. Ma dostęp do kart na dowolnym poziomie zagnieżdżenia.

Parametry

NazwaTypOpis
tabIdStringIdentyfikator karty, która ma zostać pobrana.

Powrót

TabTab o określonym identyfikatorze lub null, jeśli taki element Tab nie istnieje.

Autoryzacja

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

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

getTabs()

Pobiera wszystkie niezagnieżdżone obiekty Tab, które są częścią dokumentu.

Karty mogą zawierać karty podrzędne, czyli karty zagnieżdżone w innych kartach. Karty podrzędne są dostępne za pomocą funkcji Tab.getChildTabs().

Powrót

Tab[] – lista wszystkich elementów Tab wchodzących w skład dokumentu.

Autoryzacja

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

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

getUrl()

Pobiera adres URL 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 – adres URL bieżącego dokumentu.

Autoryzacja

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

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

getViewers()

Pobiera listę przeglądających i komentujących dla elementu Document.

Powrót

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

Autoryzacja

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

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

newPosition(element, offset)

Tworzy nowy obiekt Position, który jest odwołaniem do lokalizacji na karcie względem konkretnego elementu na pierwszej karcie lub – w przypadku skryptów powiązanych z dokumentem – aktywnej karty. Aby utworzyć Position względem lokalizacji na dowolnej karcie, użyj DocumentTab.newPosition(element, offset) . Kursor użytkownika jest reprezentowany m.in. jako Position.

// Append a paragraph to the active tab, 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 powinien zawierać nowy element Position; musi to być Text lub kontenera, np. Paragraph.
offsetIntegerW przypadku elementów Text jest to liczba znaków przed Position; dla pozostałych elementów, jest to liczba elementów podrzędnych przed Position w ten sam element kontenera.

Powrót

Position – nowe Position.

Autoryzacja

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

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

newRange()

Tworzy kreator służący do tworzenia obiektów Range z elementów karty w pierwszej karty lub w przypadku skryptów powiązanych z tagiem aktywnej karty. Do utworzenia konstruktora do budowania 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.
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.

Autoryzacja

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

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

removeEditor(emailAddress)

Usuwa danego użytkownika z listy edytorów zasobu Document. Ta metoda nie: zablokuj dostęp do usługi Document użytkownikom, którzy należą do klasy użytkowników, którzy ogólny dostęp – na przykład jeśli domena Document jest udostępniona całej domenie domeny 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 też usunięcie użytkownika z listy przeglądających.

Parametry

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

Powrót

DocumentDocument do łańcuchów.

Autoryzacja

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

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

removeEditor(user)

Usuwa danego użytkownika z listy edytorów zasobu Document. Ta metoda nie: zablokuj dostęp do usługi Document użytkownikom, którzy należą do klasy użytkowników, którzy ogólny dostęp – na przykład jeśli domena Document jest udostępniona całej domenie domeny 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 też usunięcie użytkownika z listy przeglądających.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika do usunięcia.

Powrót

DocumentDocument do łańcuchów.

Autoryzacja

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

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

removeViewer(emailAddress)

Usuwa dane użytkownika z listy przeglądających i komentujących Document. Ten nie ma zastosowania, jeśli użytkownik jest edytującym, a nie przeglądającym lub komentującym. Ta metoda również Nie blokuje dostępu do elementu Document użytkownikom, którzy należą do klasy użytkowników, mieć ogólny dostęp – na przykład jeśli domena Document została udostępniona domenie całej domeny 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 też usunięcie użytkownika z listy redaktorów.

Parametry

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

Powrót

DocumentDocument do tworzenia łańcuchów.

Autoryzacja

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

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

removeViewer(user)

Usuwa dane użytkownika z listy przeglądających i komentujących Document. Ten nie ma zastosowania, jeśli użytkownik jest edytorem, a nie przeglądającym. Ta metoda nie blokuje też dostępu do funkcji Document przez użytkowników, jeśli należą do klasy użytkowników, którzy mają ogólne warunki dostępu – na przykład jeśli element Document został 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 też usunięcie użytkownika z listy redaktorów.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika do usunięcia.

Powrót

DocumentDocument do tworzenia łańcuchów.

Autoryzacja

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

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

saveAndClose()

Zapisuje bieżące ustawienie Document. Powoduje to opróżnienie i zastosowanie oczekujących aktualizacji.

Metoda saveAndClose() jest automatycznie wywoływana po zakończeniu wykonywania skryptu dla każdej otwartej edytowalnej komórki Document.

Zamkniętego pliku Document nie można edytować. Użyj kodu DocumentApp.openById(), aby ponownie otworzyć dany dokument do edycji.

Autoryzacja

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

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

setActiveTab(tabId)

Ustawia element Tab wybrany przez użytkownika 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(TAB_ID);

Parametry

NazwaTypOpis
tabIdStringIdentyfikator karty, która ma być ustawiona jako aktywna.

Autoryzacja

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

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

setCursor(position)

Ustawia kursor użytkownika z następującą wartością Position. Skrypt może uzyskać dostęp tylko do kursora użytkownika, który uruchamia skrypt, i tylko wtedy, gdy skrypt jest powiązany z dokumentem.

Jeśli podasz Position z nieaktywnego elementu Tab, aktywujesz aktywną kartę użytkownika.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
var position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parametry

NazwaTypOpis
positionPositionNowa lokalizacja kursora.

Powrót

DocumentDocument do łańcuchów.

Autoryzacja

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

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

setLanguage(languageCode)

Ustawia kod języka dokumentu. Jest to język wyświetlany w pliku edytora dokumentów &gt; język, czyli rzeczywisty język dokumentu. Użyj kodu getSupportedLanguageCodes(), aby pobrać wszystkie prawidłowe kody języków.

Parametry

NazwaTypOpis
languageCodeStringKod języka.

Powrót

DocumentDocument do łańcuchów.

Autoryzacja

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

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

setName(name)

Określa tytuł dokumentu.

Parametry

NazwaTypOpis
nameStringTytuł nowego dokumentu.

Powrót

Document – bieżący dokument.

Autoryzacja

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

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

setSelection(range)

Określa wybór użytkownika w aktywnej karcie z uwzględnieniem Range. Skrypt może mieć tylko dostęp do wyboru użytkownika, który uruchamia skrypt, i tylko wtedy, gdy skrypt jest powiązany z dokumentem.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();

// Change the user's selection to a range that includes every table in the document.
var rangeBuilder = documentTab.newRange();
var tables = documentTab.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

DocumentDocument do łańcuchów.

Autoryzacja

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

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