Class Document

Document

Ein Dokument mit RTF und Elementen wie Tabellen und Listen

Dokumente können mit DocumentApp geöffnet oder erstellt werden. 

// Open a document by ID.
var doc = DocumentApp.openById("<my-id>");

// Create and open a document.
doc = DocumentApp.create("Document Title");

Methoden

MethodeRückgabetypKurzbeschreibung
addBookmark(position)BookmarkFügt ein Bookmark-Element an der angegebenen Position hinzu.
addEditor(emailAddress)DocumentDer entsprechende Nutzer wird der Liste der Mitbearbeiter für Document hinzugefügt.
addEditor(user)DocumentDer entsprechende Nutzer wird der Liste der Mitbearbeiter für Document hinzugefügt.
addEditors(emailAddresses)DocumentFügt das angegebene Array von Nutzern der Liste der Mitbearbeiter für Document hinzu.
addFooter()FooterSectionFügt einen Abschnitt für die Fußzeile eines Dokuments hinzu, falls kein Element vorhanden ist.
addHeader()HeaderSectionFügt einen Abschnitt des Dokumentenheaders hinzu, falls kein solcher vorhanden ist.
addNamedRange(name, range)NamedRangeFügt ein NamedRange-Element hinzu. Das ist ein Range mit einem Namen und einer ID, die später abgerufen werden sollen.
addViewer(emailAddress)DocumentDer entsprechende Nutzer wird der Liste der Betrachter für Document hinzugefügt.
addViewer(user)DocumentDer entsprechende Nutzer wird der Liste der Betrachter für Document hinzugefügt.
addViewers(emailAddresses)DocumentFügt das angegebene Array von Nutzern der Liste der Betrachter für Document hinzu.
getAs(contentType)BlobRuft den aktuellen Inhalt von Document als Blob des angegebenen Typs ab.
getBlob()BlobRuft den aktuellen Inhalt von Document als Blob ab.
getBody()BodyRuft die Body des aktiven Dokuments ab.
getBookmark(id)BookmarkRuft das Bookmark-Objekt mit der angegebenen ID ab.
getBookmarks()Bookmark[]Ruft alle Bookmark-Objekte im Dokument ab.
getCursor()PositionRuft den Cursor des Nutzers im aktiven Dokument ab.
getEditors()User[]Ruft die Liste der Editoren für dieses Document ab.
getFooter()FooterSectionRuft den Abschnitt für die Fußzeile des Dokuments ab, sofern vorhanden
getFootnotes()Footnote[]Ruft alle Footnote-Elemente im Dokument ab
getHeader()HeaderSectionRuft den Headerbereich des Dokuments ab, sofern vorhanden
getId()StringRuft die eindeutige Kennung des Dokuments ab
getLanguage()StringRuft den Sprachcode des Dokuments ab.
getName()StringRuft den Titel des Dokuments ab
getNamedRangeById(id)NamedRangeRuft das NamedRange-Objekt mit der angegebenen ID ab.
getNamedRanges()NamedRange[]Ruft alle NamedRange-Objekte im Dokument ab.
getNamedRanges(name)NamedRange[]Ruft alle NamedRange-Objekte im Dokument mit dem angegebenen Namen ab.
getSelection()RangeRuft die Auswahl des Nutzers im aktiven Dokument ab.
getSupportedLanguageCodes()String[]Ruft alle Sprachcodes ab, die in Google Docs-Dateien unterstützt werden.
getUrl()StringRuft die URL für den Zugriff auf das aktuelle Dokument ab
getViewers()User[]Ruft die Liste der Betrachter und Kommentatoren für dieses Document ab.
newPosition(element, offset)PositionErstellt ein neues Position, das auf einen Standort im Dokument relativ zu einem bestimmten Element verweist.
newRange()RangeBuilderErstellt einen Builder zum Erstellen von Range-Objekten aus Dokumentelementen.
removeEditor(emailAddress)DocumentEntfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für Document.
removeEditor(user)DocumentEntfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für Document.
removeViewer(emailAddress)DocumentEntfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren von Document.
removeViewer(user)DocumentEntfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren von Document.
saveAndClose()voidSpeichert die aktuelle Document.
setCursor(position)DocumentLegt den Cursor des Nutzers im aktiven Dokument anhand eines Position fest.
setLanguage(languageCode)DocumentLegt den Sprachcode des Dokuments fest.
setName(name)DocumentLegt den Titel des Dokuments fest.
setSelection(range)DocumentLegt die Auswahl des Nutzers im aktiven Dokument anhand eines Range fest.

Detaillierte Dokumentation

addBookmark(position)

Fügt ein Bookmark-Element an der angegebenen Position hinzu. 

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

// Gets the document 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());

}

Parameter

NameTypBeschreibung
positionPositionDie Position des neuen Lesezeichens.

Rückflug

Bookmark: Das neue Lesezeichen.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

addEditor(emailAddress)

Der entsprechende Nutzer wird der Liste der Mitbearbeiter für Document hinzugefügt. Wenn der Nutzer bereits auf der Liste der Betrachter steht, wird er mit dieser Methode aus der Betrachterliste hochgestuft.

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des Nutzers, den Sie hinzufügen möchten.

Rückflug

Document: Der Document für eine Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

addEditor(user)

Der entsprechende Nutzer wird der Liste der Mitbearbeiter für Document hinzugefügt. Wenn der Nutzer bereits auf der Liste der Betrachter steht, wird er mit dieser Methode aus der Betrachterliste hochgestuft.

Parameter

NameTypBeschreibung
userUserEine Darstellung des hinzuzufügenden Nutzers.

Rückflug

Document: Der Document für eine Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

addEditors(emailAddresses)

Fügt das angegebene Array von Nutzern der Liste der Mitbearbeiter für Document hinzu. Wenn einer der Nutzer bereits auf der Liste der Betrachter steht, wird er mit dieser Methode aus der Betrachterliste hochgestuft.

Parameter

NameTypBeschreibung
emailAddressesString[]Ein Array mit E-Mail-Adressen der hinzuzufügenden Nutzer.

Rückflug

Document: Der Document für eine Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

addFooter()

Fügt einen Abschnitt für die Fußzeile eines Dokuments hinzu, falls kein Element vorhanden ist. 

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

// Adds a footer to the document.
const footer = doc.addFooter();

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

Rückflug

FooterSection: Die Fußzeile des Dokuments.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

addHeader()

Fügt einen Abschnitt des Dokumentenheaders hinzu, falls kein solcher vorhanden ist. 

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

// Adds a header to the document.
const header = doc.addHeader();

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

Rückflug

HeaderSection: der Dokumentheader.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

addNamedRange(name, range)

Fügt ein NamedRange-Element hinzu. Das ist ein Range mit einem Namen und einer ID, die später abgerufen werden sollen. Namen sind nicht unbedingt eindeutig. Verschiedene Bereiche im selben Dokument haben denselben Namen, ähnlich wie bei einer Klasse in HTML. Im Gegensatz dazu sind IDs innerhalb des Dokuments eindeutig, z. B. eine ID in HTML. Wenn Sie einem Dokument eine NamedRange hinzufügen, können Sie sie nicht mehr ändern, sondern nur entfernen.

Jedes Skript, das auf das Dokument zugreift, kann auf ein NamedRange zugreifen. Um unbeabsichtigte Konflikte zwischen Skripts zu vermeiden, sollten Sie Bereichsnamen einen eindeutigen String voranstellen. 

// Creates a named range that includes every table in the document.
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.addNamedRange('Document tables', rangeBuilder.build());

Parameter

NameTypBeschreibung
nameStringDer Name des Bereichs muss nicht eindeutig sein. Bereichsnamen müssen zwischen 1 und 256 Zeichen lang sein.
rangeRangeDer Bereich der mit dem Namen zu verknüpfenden Elemente. Der Bereich kann die aktive Auswahl oder ein Suchergebnis sein oder mit newRange() manuell erstellt werden.

Rückflug

NamedRange: Der NamedRange.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

addViewer(emailAddress)

Der entsprechende Nutzer wird der Liste der Betrachter für Document hinzugefügt. Wenn sich der Nutzer bereits in der Liste der Bearbeiter befindet, hat diese Methode keine Auswirkungen.

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des Nutzers, den Sie hinzufügen möchten.

Rückflug

Document: Der Document für eine Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

addViewer(user)

Der entsprechende Nutzer wird der Liste der Betrachter für Document hinzugefügt. Wenn sich der Nutzer bereits in der Liste der Bearbeiter befindet, hat diese Methode keine Auswirkungen.

Parameter

NameTypBeschreibung
userUserEine Darstellung des hinzuzufügenden Nutzers.

Rückflug

Document: Der Document für eine Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

addViewers(emailAddresses)

Fügt das angegebene Array von Nutzern der Liste der Betrachter für Document hinzu. Wenn einer der Nutzer bereits auf der Liste der Mitbearbeiter steht, hat diese Methode keine Auswirkungen für ihn.

Parameter

NameTypBeschreibung
emailAddressesString[]Ein Array mit E-Mail-Adressen der hinzuzufügenden Nutzer.

Rückflug

Document: Der Document für eine Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getAs(contentType)

Ruft den aktuellen Inhalt von Document als Blob des angegebenen Typs ab. 

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

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

Parameter

NameTypBeschreibung
contentTypeStringDer MIME-Typ, in den konvertiert werden soll. Derzeit wird nur 'application/pdf' unterstützt.

Rückflug

Blob: Das aktuelle Dokument als Blob.

getBlob()

Ruft den aktuellen Inhalt von Document als Blob ab. 

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

// Retrieves the current document's contents as a blob and logs it to the console.
console.log(doc.getBlob().getContentType());

Rückflug

Blob: Das aktuelle Dokument als Blob.

getBody()

Ruft die Body des aktiven Dokuments ab.

Dokumente können verschiedene Typen von Abschnitten enthalten (z.B. HeaderSection, FooterSection). Der aktive Abschnitt für ein Dokument ist der Body.

Die Elementmethoden in Document delegieren an die aktive 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('abc123456');

// Gets the document body.
const body = doc.getBody();

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

Rückflug

Body: Der Abschnitt mit dem aktiven Dokumenttext.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getBookmark(id)

Ruft das Bookmark-Objekt mit der angegebenen ID ab. Wenn keine solche Bookmark vorhanden ist, gibt diese Methode null zurück. 

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

// Gets the bookmark by its ID.
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.');
}

Parameter

NameTypBeschreibung
idStringDie ID für Bookmark.

Rückflug

Bookmark: Der Bookmark mit der angegebenen ID oder null, wenn keine solche Bookmark vorhanden ist.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getBookmarks()

Ruft alle Bookmark-Objekte im Dokument ab. 

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

// Gets all of the bookmarks in the document.
const bookmarks = doc.getBookmarks();

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

Rückflug

Bookmark[]: ein Array der Bookmark-Objekte im Dokument.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getCursor()

Ruft den Cursor des Nutzers im aktiven Dokument ab. Ein Skript kann nur auf den Cursor des Nutzers zugreifen, der das Skript ausführt, und auch nur dann, wenn es an das Dokument gebunden ist. 

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

Rückflug

Position: Eine Darstellung des Cursors oder null, wenn der Nutzer keinen Cursor im Dokument platziert hat oder das Skript nicht an das Dokument gebunden ist.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getEditors()

Ruft die Liste der Editoren für dieses Document ab.

Rückflug

User[]: ein Array von Nutzern mit Bearbeitungsberechtigung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getFooter()

Ruft den Abschnitt für die Fußzeile des Dokuments ab, sofern vorhanden 

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

// Gets the text of the document's footer and logs it to the console.
console.log(doc.getFooter().getText());

Rückflug

FooterSection: Die Fußzeile des Dokuments.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getFootnotes()

Ruft alle Footnote-Elemente im Dokument ab

Aufrufe an getFootnotes führen zu einer Iteration der Elemente des Dokuments. Vermeiden Sie bei großen Dokumenten unnötige Aufrufe dieser Methode. 

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

// Gets the first footnote.
const footnote = doc.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

Rückflug

Footnote[]: Die Fußnoten des Dokuments.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getHeader()

Ruft den Headerbereich des Dokuments ab, sofern vorhanden 

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

// Gets the text of the document's header and logs it to the console.
console.log(doc.getHeader().getText());

Rückflug

HeaderSection: der Dokumentheader.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getId()

Ruft die eindeutige Kennung des Dokuments ab Die Dokument-ID wird mit DocumentApp.openById() verwendet, um eine bestimmte Dokumentinstanz zu öffnen.

Rückflug

String: die ID des Dokuments

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getLanguage()

Ruft den Sprachcode des Dokuments ab. Dies ist die Sprache, die im Editor unter „Datei“ > „Sprache“ angezeigt wird. Es handelt sich dabei möglicherweise nicht um die tatsächliche Sprache, die das Dokument enthält.

Rückflug

String: Die Dokumentsprache oder null, wenn nicht definiert.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getName()

Ruft den Titel des Dokuments ab

Rückflug

String: der Dokumenttitel

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getNamedRangeById(id)

Ruft das NamedRange-Objekt mit der angegebenen ID ab. Wenn keine solche NamedRange vorhanden ist, gibt diese Methode null zurück. Namen sind nicht unbedingt eindeutig. Verschiedene Bereiche im selben Dokument haben möglicherweise denselben Namen, ähnlich wie eine Klasse in HTML. Im Gegensatz dazu sind IDs innerhalb des Dokuments eindeutig, z. B. eine ID in HTML.

Parameter

NameTypBeschreibung
idStringDie ID des Bereichs, die innerhalb des Dokuments eindeutig ist

Rückflug

NamedRange: der NamedRange mit der angegebenen ID oder null, wenn kein solcher Bereich vorhanden ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getNamedRanges()

Ruft alle NamedRange-Objekte im Dokument ab.

Auf ein NamedRange kann von jedem Skript zugegriffen werden, das auf das Dokument zugreift. Um unbeabsichtigte Konflikte zwischen Skripts zu vermeiden, sollten Sie Bereichsnamen einen eindeutigen String voranstellen.

Rückflug

NamedRange[]: ein Array der NamedRange-Objekte im Dokument, wobei möglicherweise mehrere Bereiche mit demselben Namen eingeschlossen sind

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getNamedRanges(name)

Ruft alle NamedRange-Objekte im Dokument mit dem angegebenen Namen ab. Namen sind nicht unbedingt eindeutig. Verschiedene Bereiche im selben Dokument haben möglicherweise denselben Namen, ähnlich wie eine Klasse in HTML. Im Gegensatz dazu sind IDs innerhalb des Dokuments eindeutig, wie eine ID in HTML.

Auf ein NamedRange kann von jedem Skript zugegriffen werden, das auf das Dokument zugreift. Um unbeabsichtigte Konflikte zwischen Skripts zu vermeiden, sollten Sie Bereichsnamen einen eindeutigen String voranstellen.

Parameter

NameTypBeschreibung
nameStringDer Name des Bereichs, der nicht unbedingt eindeutig ist

Rückflug

NamedRange[]: ein Array der NamedRange-Objekte im Dokument mit dem angegebenen Namen

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getSelection()

Ruft die Auswahl des Nutzers im aktiven Dokument ab. Ein Skript kann nur auf die Auswahl des Nutzers zugreifen, der das Skript ausführt, und nur, wenn es an das Dokument gebunden ist. 

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

Rückflug

Range: Die Darstellung der Auswahl des Nutzers oder null, wenn der Nutzer keine Auswahl im Dokument getroffen hat, wenn nur das Ende eines Absatzes ausgewählt wird, wenn nur das Ende eines Absatzes und eine neue Zeile ausgewählt werden oder wenn das Skript nicht an das Dokument gebunden ist.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getSupportedLanguageCodes()

Ruft alle Sprachcodes ab, die in Google Docs-Dateien unterstützt werden.

Rückflug

String[]: ein Array von Sprachcodes

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getUrl()

Ruft die URL für den Zugriff auf das aktuelle Dokument ab 

var doc = DocumentApp.getActiveDocument();

// Send out the link to open the document.
MailApp.sendEmail("<email-address>", doc.getName(), doc.getUrl());

Rückflug

String: die URL für den Zugriff auf das aktuelle Dokument

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getViewers()

Ruft die Liste der Betrachter und Kommentatoren für dieses Document ab.

Rückflug

User[]: ein Array von Nutzern, die eine Lese- oder Kommentarberechtigung haben.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

newPosition(element, offset)

Erstellt ein neues Position, das auf einen Standort im Dokument relativ zu einem bestimmten Element verweist. Der Cursor des Nutzers wird unter anderem als Position dargestellt. 

// Append a paragraph, 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);

Parameter

NameTypBeschreibung
elementElementdas Element, das das neue Position enthält. Dies muss entweder ein Text-Element oder ein Containerelement wie Paragraph sein
offsetIntegerBei Text-Elementen die Anzahl der Zeichen vor der Position und bei anderen Elementen die Anzahl der untergeordneten Elemente vor der Position innerhalb desselben Containerelements

Rückflug

Position – die neue Position

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

newRange()

Erstellt einen Builder zum Erstellen von Range-Objekten aus Dokumentelementen. 

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

Rückflug

RangeBuilder – der neue Builder

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

removeEditor(emailAddress)

Entfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für Document. Diese Methode hindert Nutzer nicht daran, auf Document zuzugreifen, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören, z. B. wenn die Document für die gesamte Domain des Nutzers freigegeben ist oder wenn sich Document in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

Bei Drive-Dateien wird der Nutzer dadurch aus der Liste der Betrachter entfernt.

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des Nutzers, der entfernt werden soll.

Rückflug

Document: Der Document für eine Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

removeEditor(user)

Entfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für Document. Diese Methode hindert Nutzer nicht daran, auf Document zuzugreifen, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören, z. B. wenn die Document für die gesamte Domain des Nutzers freigegeben ist oder wenn sich Document in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

Bei Drive-Dateien wird der Nutzer dadurch aus der Liste der Betrachter entfernt.

Parameter

NameTypBeschreibung
userUserDarstellung des zu entfernenden Nutzers

Rückflug

Document: Der Document für eine Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

removeViewer(emailAddress)

Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren von Document. Diese Methode hat keine Auswirkungen, wenn der Nutzer ein Bearbeiter ist, kein Betrachter oder Kommentator. Diese Methode verhindert auch nicht, dass Nutzer auf Document zugreifen, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören, z. B. wenn die Document für die gesamte Domain des Nutzers freigegeben ist oder wenn sich das Document in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

Bei Drive-Dateien wird der Nutzer dadurch auch aus der Liste der Mitbearbeiter entfernt.

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des Nutzers, der entfernt werden soll.

Rückflug

Document: Document für Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

removeViewer(user)

Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren von Document. Diese Methode hat keine Auswirkungen, wenn der Nutzer ein Bearbeiter ist, kein Betrachter. Diese Methode hindert Nutzer auch nicht daran, auf Document zuzugreifen, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören, z. B. wenn die Document für die gesamte Domain des Nutzers freigegeben ist oder wenn sich Document in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

Bei Drive-Dateien wird der Nutzer dadurch auch aus der Liste der Mitbearbeiter entfernt.

Parameter

NameTypBeschreibung
userUserDarstellung des zu entfernenden Nutzers

Rückflug

Document: Document für Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

saveAndClose()

Speichert die aktuelle Document. Beseitigt ausstehende Updates und wird angewendet.

Am Ende der Skriptausführung wird für jeden geöffneten bearbeitbaren Document automatisch die Methode saveAndClose() aufgerufen.

Ein geschlossenes Document-Element kann nicht bearbeitet werden. Verwenden Sie DocumentApp.openById(), um ein bestimmtes Dokument zum Bearbeiten noch einmal zu öffnen.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setCursor(position)

Legt den Cursor des Nutzers im aktiven Dokument anhand eines Position fest. Ein Skript kann nur auf den Cursor des Nutzers zugreifen, der das Skript ausführt, und auch nur dann, wenn es an das Dokument gebunden ist. 

// Append a paragraph, 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);

Parameter

NameTypBeschreibung
positionPositiondie neue Cursorposition

Rückflug

Document: Document, für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setLanguage(languageCode)

Legt den Sprachcode des Dokuments fest. Dies ist die Sprache, die im Editor unter „Datei“ > „Sprache“ angezeigt wird. Es handelt sich dabei möglicherweise nicht um die tatsächliche Sprache, die das Dokument enthält. Verwenden Sie getSupportedLanguageCodes(), um alle gültigen Sprachcodes abzurufen.

Parameter

NameTypBeschreibung
languageCodeStringSprachcode

Rückflug

Document: Der Document für eine Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setName(name)

Legt den Titel des Dokuments fest.

Parameter

NameTypBeschreibung
nameStringTitel des neuen Dokuments

Rückflug

Document: Das aktuelle Dokument.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setSelection(range)

Legt die Auswahl des Nutzers im aktiven Dokument anhand eines Range fest. Ein Skript kann nur auf die Auswahl des Nutzers zugreifen, der das Skript ausführt, und nur, wenn es an das Dokument gebunden ist. 

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

Parameter

NameTypBeschreibung
rangeRangeAuswahl neuer Elemente

Rückflug

Document: Document, für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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