Der Dokumentendienst erstellt und öffnet Documents
, die bearbeitet werden können.
// Open a document by ID. var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE'); // Create and open a document. doc = DocumentApp.create('Document Name');
Attribute
Property | Typ | Beschreibung |
---|---|---|
Attribute | Attribute | Die Attribute -Aufzählung. |
ElementType | ElementType | Die ElementType -Aufzählung. |
FontFamily |
| Die -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äche 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. var doc = DocumentApp.create('Document Name');
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | den Namen des neuen Dokuments |
Return
Document
– die neue Dokumentinstanz
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
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. var doc = DocumentApp.getActiveDocument();
Return
Document
– die Dokumentinstanz
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getUi()
Gibt eine Instanz der Benutzeroberfläche des Dokuments zurück, mit der das Skript Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzufügen kann. Ein Skript kann nur bei der aktuellen Instanz eines geöffneten Dokuments mit der UI interagieren, und zwar nur, wenn es an das Dokument gebunden ist. Weitere Informationen finden Sie in den Anleitungen zu Menüs sowie Dialogfeldern und 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(); }
Return
Ui
– eine Instanz der Benutzeroberfläche 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. var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');
Parameter
Name | Typ | Beschreibung |
---|---|---|
id | String | ID des zu öffnenden Dokuments |
Return
Document
– die Dokumentinstanz
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents
openByUrl(url)
Öffnet das Dokument mit der angegebenen URL und gibt es zurück. Wenn das Skript an das Dokument containergebunden ist, verwenden Sie stattdessen getActiveDocument()
.
// Open a document by URL. var doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit');
Parameter
Name | Typ | Beschreibung |
---|---|---|
url | String | Die URL des zu öffnenden Dokuments |
Return
Document
– die Dokumentinstanz
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents