Class DocumentApp

DocumentApp

Mit dem Dokumentdienst werden Documents erstellt und geöffnet, die bearbeitet werden können.

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

Properties

Attribut	Typ	Beschreibung
Attribute	Attribute	Die Aufzählung Attribute.
ElementType	ElementType	Die ElementType Aufzählung.
FontFamily	FontFamily	Die FontFamily Aufzählung.
GlyphType	GlyphType	Die GlyphType Aufzählung.
HorizontalAlignment	HorizontalAlignment	Die HorizontalAlignment Aufzählung.
ParagraphHeading	ParagraphHeading	Die ParagraphHeading Aufzählung.
PositionedLayout	PositionedLayout	Die PositionedLayout Aufzählung.
TextAlignment	TextAlignment	Die TextAlignment Aufzählung.
VerticalAlignment	VerticalAlignment	Die VerticalAlignment Aufzählung.

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
create(name)	Document	Erstellt ein neues Dokument und gibt es zurück.
getActiveDocument()	Document	Gibt das Dokument zurück, an das das Skript containergebunden ist.
getUi()	Ui	Gibt eine Instanz der Benutzeroberflächenumgebung des Dokuments zurück, mit der das Skript Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzufügen kann.
openById(id)	Document	Gibt das Dokument mit der angegebenen ID zurück.
openByUrl(url)	Document	Öffnet das Dokument mit der angegebenen URL und gibt es zurück.

Detaillierte Dokumentation

create(name)

Erstellt ein neues Dokument und gibt es zurück.

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

Parameter

Name	Typ	Beschreibung
name	String	Der Name des neuen Dokuments.

Rückgabe

Document – die neue Dokumentinstanz.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

---

getActiveDocument()

Gibt das Dokument zurück, an das das Skript containergebunden ist. Wenn Sie mit einem Dokument interagieren möchten, an das das Skript nicht containergebunden ist, verwenden Sie stattdessen openById(id) oder openByUrl(url).

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

Rückgabe

Document – die Dokumentinstanz

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

---

getUi()

Gibt eine Instanz der Benutzeroberflächenumgebung des Dokuments zurück, mit der das Skript Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzufügen kann. Ein Skript kann nur mit der Benutzeroberfläche für die aktuelle Instanz eines geöffneten Dokuments interagieren und nur, wenn das Skript an das Dokument gebunden ist. Weitere Informationen finden Sie in den Leitfäden zu Menüs und Dialogfeldern sowie Seitenleisten.

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

Rückgabe

Ui – eine Instanz der Benutzeroberflächenumgebung dieses Dokuments

---

openById(id)

Gibt das Dokument mit der angegebenen ID zurück. Wenn das Skript containergebunden an das Dokument ist, verwenden Sie stattdessen getActiveDocument().

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

Parameter

Name	Typ	Beschreibung
id	String	Die ID des zu öffnenden Dokuments.

Rückgabe

Document – die Dokumentinstanz.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

---

openByUrl(url)

Öffnet das Dokument mit der angegebenen URL und gibt es zurück. Wenn das Skript containergebunden an das Dokument ist, verwenden Sie stattdessen getActiveDocument().

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

Parameter

Name	Typ	Beschreibung
url	String	Die URL des zu öffnenden Dokuments

Rückgabe

Document – die Dokumentinstanz

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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