Class DocumentApp

DokumentAplikacja

Usługa dokumentu tworzy i otwiera Documents, który można edytować. 

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
let doc = DocumentApp.openById('DOCUMENT_ID');

// Create and open a document.
doc = DocumentApp.create('Document Name');

Właściwości

WłaściwośćTypOpis
AttributeAttributeWyliczenie Attribute.
ElementTypeElementTypeWyliczenie ElementType.
FontFamilyFontFamilyWyliczenie FontFamily.
GlyphTypeGlyphTypeWyliczenie GlyphType.
HorizontalAlignmentHorizontalAlignmentWyliczenie HorizontalAlignment.
ParagraphHeadingParagraphHeadingWyliczenie ParagraphHeading.
PositionedLayoutPositionedLayoutWyliczenie PositionedLayout.
TextAlignmentTextAlignmentWyliczenie TextAlignment.
VerticalAlignmentVerticalAlignmentWyliczenie VerticalAlignment.

Metody

MetodaZwracany typKrótki opis
create(name)DocumentTworzy i zwraca nowy dokument.
getActiveDocument()DocumentZwraca dokument, do którego skrypt jest powiązany z kontenerem.
getUi()UiZwraca instancję środowiska interfejsu użytkownika dokumentu, która umożliwia skryptowi dodawanie funkcji takich jak menu, okna dialogowe i paski boczne.
openById(id)DocumentZwraca dokument o określonym identyfikatorze.
openByUrl(url)DocumentOtwiera i zwraca dokument o określonym adresie URL.

Szczegółowa dokumentacja

create(name)

Tworzy i zwraca nowy dokument. 

// Create and open a new document.
const doc = DocumentApp.create('Document Name');

Parametry

NazwaTypOpis
nameStringNazwa nowego dokumentu.

Powrót

Document – nowa instancja 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

getActiveDocument()

Zwraca dokument, do którego skrypt jest powiązany z kontenerem. Aby pracować z dokumentem, do którego skrypt nie jest powiązany z kontenerem, użyj zamiast tego funkcji openById(id) lub openByUrl(url). 

// Get the document to which this script is bound.
const doc = DocumentApp.getActiveDocument();

Powrót

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

getUi()

Zwraca instancję środowiska interfejsu użytkownika dokumentu, która umożliwia skryptowi dodawanie funkcji takich jak menu, okna dialogowe i paski boczne. Skrypt może wchodzić w interakcję z interfejsem tylko w przypadku bieżącej instancji otwartego dokumentu i tylko wtedy, gdy jest powiązany z tym dokumentem. Więcej informacji znajdziesz w wskazówkach dotyczących menu oraz okienek dialogowych i pasków bocznych. 

// Add a custom menu to the active document, including a separator and a
// sub-menu.
function onOpen(e) {
  DocumentApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(
          DocumentApp.getUi()
              .createMenu('My sub-menu')
              .addItem('One sub-menu item', 'mySecondFunction')
              .addItem('Another sub-menu item', 'myThirdFunction'),
          )
      .addToUi();
}

Powrót

Ui – instancja środowiska interfejsu użytkownika w tym dokumencie

openById(id)

Zwraca dokument o określonym identyfikatorze. Jeśli skrypt jest powiązany z kontenerem dokumentu, użyj zamiast tego getActiveDocument(). 

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('DOCUMENT_ID');

Parametry

NazwaTypOpis
idStringIdentyfikator dokumentu do otwarcia.

Powrót

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

openByUrl(url)

Otwiera i zwraca dokument o określonym adresie URL. Jeśli skrypt jest powiązany z kontenerem dokumentu, użyj zamiast tego getActiveDocument(). 

// Open a document by URL.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit',
);

Parametry

NazwaTypOpis
urlStringadres URL dokumentu do otwarcia.

Powrót

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