Requests

Anfrage

Eine einzelne Aktualisierung, die auf ein Dokument angewendet werden soll.

JSON-Darstellung 
{

  // Union field request can be only one of the following:
  "replaceAllText": {
    object (ReplaceAllTextRequest)
  },
  "insertText": {
    object (InsertTextRequest)
  },
  "updateTextStyle": {
    object (UpdateTextStyleRequest)
  },
  "createParagraphBullets": {
    object (CreateParagraphBulletsRequest)
  },
  "deleteParagraphBullets": {
    object (DeleteParagraphBulletsRequest)
  },
  "createNamedRange": {
    object (CreateNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "updateParagraphStyle": {
    object (UpdateParagraphStyleRequest)
  },
  "deleteContentRange": {
    object (DeleteContentRangeRequest)
  },
  "insertInlineImage": {
    object (InsertInlineImageRequest)
  },
  "insertTable": {
    object (InsertTableRequest)
  },
  "insertTableRow": {
    object (InsertTableRowRequest)
  },
  "insertTableColumn": {
    object (InsertTableColumnRequest)
  },
  "deleteTableRow": {
    object (DeleteTableRowRequest)
  },
  "deleteTableColumn": {
    object (DeleteTableColumnRequest)
  },
  "insertPageBreak": {
    object (InsertPageBreakRequest)
  },
  "deletePositionedObject": {
    object (DeletePositionedObjectRequest)
  },
  "updateTableColumnProperties": {
    object (UpdateTableColumnPropertiesRequest)
  },
  "updateTableCellStyle": {
    object (UpdateTableCellStyleRequest)
  },
  "updateTableRowStyle": {
    object (UpdateTableRowStyleRequest)
  },
  "replaceImage": {
    object (ReplaceImageRequest)
  },
  "updateDocumentStyle": {
    object (UpdateDocumentStyleRequest)
  },
  "mergeTableCells": {
    object (MergeTableCellsRequest)
  },
  "unmergeTableCells": {
    object (UnmergeTableCellsRequest)
  },
  "createHeader": {
    object (CreateHeaderRequest)
  },
  "createFooter": {
    object (CreateFooterRequest)
  },
  "createFootnote": {
    object (CreateFootnoteRequest)
  },
  "replaceNamedRangeContent": {
    object (ReplaceNamedRangeContentRequest)
  },
  "updateSectionStyle": {
    object (UpdateSectionStyleRequest)
  },
  "insertSectionBreak": {
    object (InsertSectionBreakRequest)
  },
  "deleteHeader": {
    object (DeleteHeaderRequest)
  },
  "deleteFooter": {
    object (DeleteFooterRequest)
  },
  "pinTableHeaderRows": {
    object (PinTableHeaderRowsRequest)
  },
  "insertPerson": {
    object (InsertPersonRequest)
  }
  // End of list of possible types for union field request.
}
Felder
Union-Feld request. Die spezifische Anfrage, die angewendet werden soll. Es ist genau ein Feld erforderlich. Für request ist nur einer der folgenden Werte zulässig:
replaceAllText

object (ReplaceAllTextRequest)

Ersetzt alle Instanzen des angegebenen Texts.

insertText

object (InsertTextRequest)

Fügt Text an der angegebenen Stelle ein.

updateTextStyle

object (UpdateTextStyleRequest)

Aktualisiert den Textstil im angegebenen Bereich.

createParagraphBullets

object (CreateParagraphBulletsRequest)

Erstellt Aufzählungszeichen für Absätze.

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

Entfernt Aufzählungszeichen aus Absätzen.

createNamedRange

object (CreateNamedRangeRequest)

Erstellt einen benannten Bereich.

deleteNamedRange

object (DeleteNamedRangeRequest)

Löscht einen benannten Bereich.

updateParagraphStyle

object (UpdateParagraphStyleRequest)

Aktualisiert den Absatzstil im angegebenen Bereich.

deleteContentRange

object (DeleteContentRangeRequest)

Löscht Inhalte aus dem Dokument.

insertInlineImage

object (InsertInlineImageRequest)

Fügt ein Inlinebild an der angegebenen Stelle ein.

insertTable

object (InsertTableRequest)

Fügt eine Tabelle an der angegebenen Position ein.

insertTableRow

object (InsertTableRowRequest)

Fügt eine leere Zeile in eine Tabelle ein.

insertTableColumn

object (InsertTableColumnRequest)

Fügt eine leere Spalte in eine Tabelle ein.

deleteTableRow

object (DeleteTableRowRequest)

Löscht eine Zeile aus einer Tabelle.

deleteTableColumn

object (DeleteTableColumnRequest)

Löscht eine Spalte aus einer Tabelle.

insertPageBreak

object (InsertPageBreakRequest)

Fügt an der angegebenen Stelle einen Seitenumbruch ein.

deletePositionedObject

object (DeletePositionedObjectRequest)

Löscht ein positioniertes Objekt aus dem Dokument.

updateTableColumnProperties

object (UpdateTableColumnPropertiesRequest)

Aktualisiert die Attribute von Spalten in einer Tabelle.

updateTableCellStyle

object (UpdateTableCellStyleRequest)

Aktualisiert den Stil von Tabellenzellen.

updateTableRowStyle

object (UpdateTableRowStyleRequest)

Aktualisiert den Zeilenstil in einer Tabelle.

replaceImage

object (ReplaceImageRequest)

Ersetzt ein Bild im Dokument.

updateDocumentStyle

object (UpdateDocumentStyleRequest)

Aktualisiert den Stil des Dokuments.

mergeTableCells

object (MergeTableCellsRequest)

Zellen in einer Tabelle werden zusammengeführt.

unmergeTableCells

object (UnmergeTableCellsRequest)

Hebt die Verbindung von Zellen in einer Tabelle auf.

createHeader

object (CreateHeaderRequest)

Erstellt einen Header.

createFootnote

object (CreateFootnoteRequest)

Erstellt eine Fußnote.

replaceNamedRangeContent

object (ReplaceNamedRangeContentRequest)

Ersetzt den Inhalt eines benannten Bereichs.

updateSectionStyle

object (UpdateSectionStyleRequest)

Aktualisiert den Abschnittsstil des angegebenen Bereichs.

insertSectionBreak

object (InsertSectionBreakRequest)

Fügt an der angegebenen Stelle einen Abschnittsumbruch ein.

deleteHeader

object (DeleteHeaderRequest)

Löscht eine Kopfzeile aus dem Dokument.

pinTableHeaderRows

object (PinTableHeaderRowsRequest)

Aktualisiert die Anzahl der fixierten Überschriftenzeilen in einer Tabelle.

insertPerson

object (InsertPersonRequest)

Fügt eine Erwähnung einer Person ein.

ReplaceAllTextRequest

Ersetzt alle Instanzen von Text, der einem Kriterium entspricht, durch replace text.

JSON-Darstellung 
{
  "replaceText": string,
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field criteria can be only one of the following:
  "containsText": {
    object (SubstringMatchCriteria)
  }
  // End of list of possible types for union field criteria.
}
Felder
replaceText

string

Der Text, der den abgeglichenen Text ersetzt.

tabsCriteria

object (TabsCriteria)

Optional. Die Kriterien, mit denen angegeben wird, auf welchen Tabs die Ersetzung erfolgt.

Wenn ausgelassen, gilt der Ersatz für alle Tabs.

In einem Dokument mit nur einem Tab:

  • Falls angegeben, muss sie mit der ID des einzelnen Tabs übereinstimmen.

  • Wenn nichts angegeben ist, gilt der Ersatz für den einzelnen Tab.

In einem Dokument mit mehreren Tabs:

  • Wenn angegeben, gilt der Ersatz für die angegebenen Tabs.

  • Wenn nichts angegeben ist, gilt der Ersatz für alle Tabs.

Union-Feld criteria. Die Kriterien, die zum Abgleichen des zu ersetzenden Texts verwendet werden. Für criteria ist nur einer der folgenden Werte zulässig:
containsText

object (SubstringMatchCriteria)

Sucht im Dokument nach Text, der mit dieser Teilzeichenfolge übereinstimmt.

SubstringMatchCriteria

Ein Kriterium, das mit einem bestimmten Textstring im Dokument übereinstimmt.

JSON-Darstellung 
{
  "text": string,
  "matchCase": boolean,
  "searchByRegex": boolean
}
Felder
text

string

Der Text, nach dem im Dokument gesucht werden soll.

matchCase

boolean

Gibt an, ob bei der Suche die Groß-/Kleinschreibung berücksichtigt werden soll:

  • True : Bei der Suche wird zwischen Groß- und Kleinschreibung unterschieden.
  • False : Bei der Suche wird die Groß-/Kleinschreibung nicht berücksichtigt.
searchByRegex

boolean

Optional. „True“, wenn der Suchwert als regulärer Ausdruck behandelt werden soll. Alle umgekehrten Schrägstriche im Muster müssen maskiert werden.

  • True : Der Suchtext wird als regulärer Ausdruck behandelt.
  • False : Der Suchtext wird als Teilstring für den Abgleich behandelt.

TabsCriteria

Ein Kriterium, das angibt, auf welchen Tabs eine Anfrage ausgeführt wird.

JSON-Darstellung 
{
  "tabIds": [
    string
  ]
}
Felder
tabIds[]

string

Die Liste der Tab-IDs, in denen die Anfrage ausgeführt wird.

InsertTextRequest

Fügt Text an der angegebenen Stelle ein.

JSON-Darstellung 
{
  "text": string,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Felder
text

string

Der einzufügende Text.

Wenn Sie ein Zeilenumbruchzeichen einfügen, wird implizit ein neues Paragraph an diesem Index erstellt. Der Absatzstil des neuen Absatzes wird aus dem Absatz am aktuellen Einfügeindex kopiert, einschließlich Listen und Aufzählungszeichen.

Textstile für eingefügten Text werden automatisch festgelegt. Dabei wird in der Regel der Stil des benachbarten Textes beibehalten. In den meisten Fällen entspricht die Textformatierung des eingefügten Texts dem Text unmittelbar vor dem Einfügeindex.

Einige Steuerzeichen (U+0000–U+0008, U+000C–U+001F) und Zeichen aus dem Unicode Basic Multilingual Plane Private Use Area (U+E000–U+F8FF) werden aus dem eingefügten Text entfernt.

Union-Feld insertion_location. Die Stelle, an der der Text eingefügt wird. Für insertion_location ist nur einer der folgenden Werte zulässig:
location

object (Location)

Fügt den Text an einer bestimmten Stelle im Dokument ein.

Text muss innerhalb der Grenzen eines vorhandenen Paragraph eingefügt werden. So kann beispielsweise kein Text am Startindex einer Tabelle eingefügt werden, also zwischen der Tabelle und dem vorherigen Absatz. Der Text muss in den vorhergehenden Absatz eingefügt werden.

endOfSegmentLocation

object (EndOfSegmentLocation)

Fügt den Text am Ende einer Kopf- oder Fußzeile, einer Fußnote oder des Dokumenttexts ein.

Standort

Eine bestimmte Stelle im Dokument.

JSON-Darstellung 
{
  "segmentId": string,
  "index": integer,
  "tabId": string
}
Felder
segmentId

string

Die ID der Kopfzeile, Fußzeile oder Fußnote, in der sich die Position befindet. Eine leere Segment-ID kennzeichnet den Text des Dokuments.

index

integer

Der nullbasierte Index in UTF-16-Codeeinheiten.

Der Index bezieht sich auf den Beginn des Segments, das durch segmentId angegeben wird.

tabId

string

Der Tab, auf dem sich der Standort befindet. Wird kein Wert angegeben, wird die Anfrage auf den ersten Tab angewendet.

In einem Dokument mit nur einem Tab:

  • Falls angegeben, muss sie mit der ID des einzelnen Tabs übereinstimmen.

  • Wenn nichts angegeben ist, bezieht sich die Anfrage auf den einzelnen Tab.

In einem Dokument mit mehreren Tabs:

  • Falls angegeben, bezieht sich die Anfrage auf den angegebenen Tab.

  • Wird nichts angegeben, bezieht sich die Anfrage auf den ersten Tab im Dokument.

EndOfSegmentLocation

Position am Ende eines Textkörpers, einer Kopf- oder Fußzeile oder einer Fußnote. Die Position befindet sich unmittelbar vor der letzten neuen Zeile im Dokumentsegment.

JSON-Darstellung 
{
  "segmentId": string,
  "tabId": string
}
Felder
segmentId

string

Die ID der Kopfzeile, Fußzeile oder Fußnote, in der sich die Position befindet. Eine leere Segment-ID kennzeichnet den Text des Dokuments.

tabId

string

Der Tab, auf dem sich der Standort befindet. Wird kein Wert angegeben, wird die Anfrage auf den ersten Tab angewendet.

In einem Dokument mit nur einem Tab:

  • Falls angegeben, muss sie mit der ID des einzelnen Tabs übereinstimmen.

  • Wenn nichts angegeben ist, bezieht sich die Anfrage auf den einzelnen Tab.

In einem Dokument mit mehreren Tabs:

  • Falls angegeben, bezieht sich die Anfrage auf den angegebenen Tab.

  • Wird nichts angegeben, bezieht sich die Anfrage auf den ersten Tab im Dokument.

UpdateTextStyleRequest

Aktualisieren Sie die Formatierung von Text.

JSON-Darstellung 
{
  "textStyle": {
    object (TextStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}
Felder
textStyle

object (TextStyle)

Die auf den Text anzuwendenden Formatierungen.

Wenn der Wert für ein bestimmtes Design mit dem des übergeordneten Elements übereinstimmt, wird das Design auf „inherit“ (erben) festgelegt.

Bestimmte Änderungen am Textstil können andere Änderungen zur Folge haben, um das Verhalten des Docs-Editors widerzuspiegeln. Weitere Informationen finden Sie in der Dokumentation zu TextStyle.

fields

string (FieldMask format)

Die Felder, die aktualisiert werden sollen.

Es muss mindestens ein Feld angegeben werden. Der Stamm textStyle ist impliziert und sollte nicht angegeben werden. Ein einzelnes "*" kann als Kurzform für die Auflistung aller Felder verwendet werden.

Wenn Sie beispielsweise den Textstil auf „fett“ aktualisieren möchten, legen Sie fields auf "bold" fest.

Wenn Sie ein Attribut auf den Standardwert zurücksetzen möchten, geben Sie den Feldnamen in der Feldmaske an, lassen Sie das Feld selbst jedoch leer.

Union-Feld insertion_location. Der Typ des Bereichs, in dem der Textstil aktualisiert wird. Für insertion_location ist nur einer der folgenden Werte zulässig:
range

object (Range)

Der Bereich des zu formatierenden Texts.

Der Bereich kann auf angrenzende Zeilenumbrüche ausgeweitet werden.

Wenn der Bereich einen Absatz einer Liste vollständig enthält, wird auch das Aufzählungszeichen des Absatzes mit dem entsprechenden Textstil aktualisiert.

Bereiche können nicht in eine relative UpdateTextStyleRequest eingefügt werden.

CreateParagraphBulletsRequest

Erstellt Aufzählungszeichen für alle Absätze, die sich mit dem angegebenen Bereich überschneiden.

Die Verschachtelungsebene jedes Absatzes wird durch Zählen der führenden Tabulatoren vor dem jeweiligen Absatz bestimmt. Um überflüssige Leerzeichen zwischen dem Aufzählungszeichen und dem entsprechenden Absatz zu vermeiden, werden diese führenden Tabulatoren durch diese Anfrage entfernt. Dadurch können sich die Indexe von Teilen des Texts ändern.

Wenn der Absatz unmittelbar vor den aktualisierten Absätzen in einer Liste mit einer passenden Voreinstellung steht, werden die aktualisierten Absätze dieser Liste hinzugefügt.

JSON-Darstellung 
{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
Felder
range

object (Range)

Der Bereich, auf den die Aufzählungszeichen-Voreinstellung angewendet werden soll.

bulletPreset

enum (BulletGlyphPreset)

Die Arten von Aufzählungszeichen, die verwendet werden sollen.

BulletGlyphPreset

Voreingestellte Muster für Aufzählungszeichen in Listen.

In diesen Mustern werden die folgenden Arten von Aufzählungszeichen verwendet:

  • ARROW : Ein Pfeil, der dem Unicode-Codepunkt U+2794 entspricht
  • ARROW3D : Ein Pfeil mit 3D-Schattierung, der dem Unicode-Codepunkt U+27a2 entspricht
  • CHECKBOX : Ein leeres Quadrat, das dem Unicode-Codepunkt U+274f entspricht
  • CIRCLE : Ein leerer Kreis, der dem Unicode-Codepunkt U+25cb entspricht
  • DIAMOND : Ein ausgefülltes Rhombus-Symbol, das dem Unicode-Codepunkt U+25c6 entspricht
  • DIAMONDX : Eine Raute mit einem „x“, entsprechend dem Unicode-Codepunkt U+2756
  • HOLLOWDIAMOND : Eine leere Raute, die dem Unicode-Codepunkt U+25c7 entspricht
  • DISC : Ein ausgefüllter Kreis, der dem Unicode-Codepunkt U+25cf entspricht
  • SQUARE : Ein ausgefülltes Quadrat, das dem Unicode-Codepunkt U+25a0 entspricht
  • STAR : Ein Stern, der dem Unicode-Codepunkt U+2605 entspricht
  • ALPHA : Ein Kleinbuchstabe wie „a“, „b“ oder „c“.
  • UPPERALPHA : Ein Großbuchstabe wie „A“, „B“ oder „C“.
  • DECIMAL : Eine Zahl wie „1“, „2“ oder „3“.
  • ZERODECIMAL : Eine Zahl, bei der einstellige Zahlen mit einer Null beginnen, z. B. „01“, „02“ oder „03“. Zahlen mit mehr als einer Ziffer haben keine vorangestellte Null.
  • ROMAN : Eine römische Ziffer in Kleinbuchstaben, z. B. „i“, „ii“ oder „iii“.
  • UPPERROMAN : Eine römische Ziffer in Großbuchstaben, z. B. „I“, „II“ oder „III“.
  • LEFTTRIANGLE : Ein nach links zeigendes Dreieck, das dem Unicode-Codepunkt U+25c4 entspricht
Enums
BULLET_GLYPH_PRESET_UNSPECIFIED Die Voreinstellung für das Aufzählungszeichen ist nicht angegeben.
BULLET_DISC_CIRCLE_SQUARE Eine Liste mit Aufzählungszeichen mit den Aufzählungszeichen DISC, CIRCLE und SQUARE für die ersten drei Verschachtelungsebenen.
BULLET_DIAMONDX_ARROW3D_SQUARE Eine Liste mit Aufzählungszeichen mit den Aufzählungszeichen DIAMONDX, ARROW3D und SQUARE für die ersten drei Verschachtelungsebenen.
BULLET_CHECKBOX Eine Aufzählungsliste mit CHECKBOX Aufzählungszeichen für alle Verschachtelungsebenen der Liste.
BULLET_ARROW_DIAMOND_DISC Eine Liste mit Aufzählungszeichen mit den Aufzählungszeichen ARROW, DIAMOND und DISC für die ersten drei Verschachtelungsebenen.
BULLET_STAR_CIRCLE_SQUARE Eine Liste mit Aufzählungszeichen mit den Aufzählungszeichen STAR, CIRCLE und SQUARE für die ersten drei Verschachtelungsebenen.
BULLET_ARROW3D_CIRCLE_SQUARE Eine Liste mit Aufzählungszeichen mit den Aufzählungszeichen ARROW3D, CIRCLE und SQUARE für die ersten drei Verschachtelungsebenen.
BULLET_LEFTTRIANGLE_DIAMOND_DISC Eine Liste mit Aufzählungszeichen mit den Aufzählungszeichen LEFTTRIANGLE, DIAMOND und DISC für die ersten drei Verschachtelungsebenen.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE Eine Liste mit Aufzählungszeichen mit den Aufzählungszeichen DIAMONDX, HOLLOWDIAMOND und SQUARE für die ersten drei Verschachtelungsebenen.
BULLET_DIAMOND_CIRCLE_SQUARE Eine Liste mit Aufzählungszeichen mit den Aufzählungszeichen DIAMOND, CIRCLE und SQUARE für die ersten drei Verschachtelungsebenen.
NUMBERED_DECIMAL_ALPHA_ROMAN Eine nummerierte Liste mit DECIMAL, ALPHA und ROMAN numerischen Glyphen für die ersten drei Verschachtelungsebenen der Liste, gefolgt von Punkten.
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS Eine nummerierte Liste mit DECIMAL, ALPHA und ROMAN numerischen Glyphen für die ersten drei Verschachtelungsebenen der Liste, gefolgt von einer schließenden Klammer.
NUMBERED_DECIMAL_NESTED Eine nummerierte Liste mit DECIMAL numerischen Glyphen, die durch Punkte getrennt sind. Bei jeder Verschachtelungsebene wird die Glyphe der vorherigen Verschachtelungsebene als Präfix verwendet. Beispiel: „1.“ '1.1.', '2.', '2.2.'.
NUMBERED_UPPERALPHA_ALPHA_ROMAN Eine nummerierte Liste mit UPPERALPHA, ALPHA und ROMAN numerischen Glyphen für die ersten drei Verschachtelungsebenen der Liste, gefolgt von Punkten.
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL Eine nummerierte Liste mit UPPERROMAN, UPPERALPHA und DECIMAL numerischen Glyphen für die ersten drei Verschachtelungsebenen der Liste, gefolgt von Punkten.
NUMBERED_ZERODECIMAL_ALPHA_ROMAN Eine nummerierte Liste mit ZERODECIMAL, ALPHA und ROMAN numerischen Glyphen für die ersten drei Verschachtelungsebenen der Liste, gefolgt von Punkten.

DeleteParagraphBulletsRequest

Löscht Aufzählungszeichen aus allen Absätzen, die sich mit dem angegebenen Bereich überschneiden.

Die Verschachtelungsebene jedes Absatzes wird visuell beibehalten, indem am Anfang des entsprechenden Absatzes ein Einzug hinzugefügt wird.

JSON-Darstellung 
{
  "range": {
    object (Range)
  }
}
Felder
range

object (Range)

Der Bereich, aus dem Aufzählungszeichen gelöscht werden sollen.

CreateNamedRangeRequest

Erstellt eine NamedRange, die auf den angegebenen Bereich verweist.

JSON-Darstellung 
{
  "name": string,
  "range": {
    object (Range)
  }
}
Felder
name

string

Der Name des benannten Bereichs. Namen müssen nicht eindeutig sein.

Namen müssen mindestens 1 Zeichen und dürfen höchstens 256 Zeichen (gemessen in UTF-16-Codeeinheiten) enthalten.

range

object (Range)

Der Bereich, auf den der Name angewendet werden soll.

DeleteNamedRangeRequest

Löscht ein NamedRange.

JSON-Darstellung 
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "name": string
  // End of list of possible types for union field named_range_reference.
}
Felder
tabsCriteria

object (TabsCriteria)

Optional. Die Kriterien, mit denen angegeben wird, auf welchen Tabellenblättern der Bereich gelöscht werden soll. Wird sie weggelassen, wird der Bereich für alle Tabs gelöscht.

In einem Dokument mit nur einem Tab:

  • Falls angegeben, muss sie mit der ID des einzelnen Tabs übereinstimmen.

  • Wenn nichts angegeben ist, wird der Bereich auf dem einzelnen Tab gelöscht.

In einem Dokument mit mehreren Tabs:

  • Falls angegeben, wird der Bereich in den angegebenen Tabs gelöscht.

  • Wenn nicht angegeben, wird der Bereich in allen Tabs gelöscht.

Union-Feld named_range_reference. Der Wert, der bestimmt, welcher Bereich oder welche Bereiche gelöscht werden sollen. Es muss genau einer festgelegt werden. Für named_range_reference ist nur einer der folgenden Werte zulässig:
namedRangeId

string

Die ID des zu löschenden benannten Bereichs.

name

string

Der Name des oder der zu löschenden Bereich(e). Alle benannten Bereiche mit dem angegebenen Namen werden gelöscht.

UpdateParagraphStyleRequest

Aktualisiert die Formatierung aller Absätze, die sich mit dem angegebenen Bereich überschneiden.

JSON-Darstellung 
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}
Felder
paragraphStyle

object (ParagraphStyle)

Die Stile, die für die Absätze festgelegt werden sollen.

Bestimmte Änderungen am Absatzstil können andere Änderungen nach sich ziehen, um das Verhalten des Docs-Editors widerzuspiegeln. Weitere Informationen finden Sie in der Dokumentation zu ParagraphStyle.

fields

string (FieldMask format)

Die Felder, die aktualisiert werden sollen.

Es muss mindestens ein Feld angegeben werden. Der Stamm paragraphStyle ist impliziert und sollte nicht angegeben werden. Ein einzelnes "*" kann als Kurzform für die Auflistung aller Felder verwendet werden.

Wenn Sie beispielsweise die Ausrichtungseigenschaft des Absatzformats aktualisieren möchten, legen Sie fields auf "alignment" fest.

Wenn Sie eine Property auf den Standardwert zurücksetzen möchten, geben Sie ihren Feldnamen in der Feldmaske an, lassen Sie das Feld selbst jedoch nicht festgelegt.

Union-Feld insertion_location. Der Typ des Bereichs, in dem der Absatzstil aktualisiert wird. Für insertion_location ist nur einer der folgenden Werte zulässig:
range

object (Range)

Der Bereich, der sich mit den zu formatierenden Absätzen überschneidet.

DeleteContentRangeRequest

Löscht Inhalte aus dem Dokument.

JSON-Darstellung 
{
  "range": {
    object (Range)
  }
}
Felder
range

object (Range)

Der zu löschende Inhaltsbereich.

Wenn Sie Text löschen, der über eine Absatzgrenze hinausgeht, kann dies zu Änderungen an Absatzformaten, Listen, positionierten Objekten und Lesezeichen führen, da die beiden Absätze zusammengeführt werden.

Wenn Sie versuchen, bestimmte Bereiche zu löschen, kann dies zu einer ungültigen Dokumentstruktur führen. In diesem Fall wird der Fehler „400 Bad Request“ zurückgegeben.

Beispiele für ungültige Löschanfragen:

InsertInlineImageRequest

Fügt ein InlineObject mit einem Bild an der angegebenen Position ein.

JSON-Darstellung 
{
  "uri": string,
  "objectSize": {
    object (Size)
  },

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Felder
uri

string

Der Image-URI.

Das Bild wird einmal beim Einfügen abgerufen und eine Kopie wird zur Anzeige im Dokument gespeichert. Bilder dürfen nicht größer als 50 MB sein, dürfen nicht mehr als 25 Megapixel haben und müssen im PNG-, JPEG- oder GIF-Format vorliegen.

Die angegebene URI muss öffentlich zugänglich sein und darf maximal 2 KB lang sein. Der URI selbst wird mit dem Bild gespeichert und über das Feld ImageProperties.content_uri verfügbar gemacht.

objectSize

object (Size)

Die Größe, in der das Bild im Dokument angezeigt werden soll. Dieses Attribut ist optional. Die endgültige Größe des Bildes im Dokument wird anhand der folgenden Regeln bestimmt: * Wenn weder Breite noch Höhe angegeben sind, wird eine Standardgröße des Bildes basierend auf seiner Auflösung berechnet. * Wenn eine Dimension angegeben ist, wird die andere berechnet, um das Seitenverhältnis des Bildes beizubehalten. * Wenn sowohl Breite als auch Höhe angegeben sind, wird das Bild so skaliert, dass es in die angegebenen Abmessungen passt, wobei das Seitenverhältnis beibehalten wird.

Union-Feld insertion_location. Der Ort, an dem das Bild eingefügt wird. Für insertion_location ist nur einer der folgenden Werte zulässig:
location

object (Location)

Fügt das Bild an einer bestimmten Stelle im Dokument ein.

Das Bild muss innerhalb der Grenzen eines vorhandenen Paragraph eingefügt werden. Sie kann beispielsweise nicht am Startindex einer Tabelle eingefügt werden, also zwischen der Tabelle und dem vorherigen Absatz.

Inlinebilder können nicht in eine Fußnote oder Gleichung eingefügt werden.

endOfSegmentLocation

object (EndOfSegmentLocation)

Fügt den Text am Ende einer Kopf- oder Fußzeile oder des Dokumenttexts ein.

Inline-Bilder können nicht in eine Fußnote eingefügt werden.

InsertTableRequest

Fügt eine Tabelle an der angegebenen Position ein.

Vor der eingefügten Tabelle wird ein Zeilenumbruch eingefügt.

JSON-Darstellung 
{
  "rows": integer,
  "columns": integer,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Felder
rows

integer

Die Anzahl der Zeilen in der Tabelle

columns

integer

Die Anzahl der Spalten in der Tabelle.

Union-Feld insertion_location. Die Stelle, an der die Tabelle eingefügt wird. Für insertion_location ist nur einer der folgenden Werte zulässig:
location

object (Location)

Fügt die Tabelle an einem bestimmten Modellindex ein.

Vor der eingefügten Tabelle wird ein Zeilenumbruchzeichen eingefügt. Der Startindex der Tabelle befindet sich daher am angegebenen Index des Speicherorts + 1.

Die Tabelle muss innerhalb der Grenzen eines vorhandenen Paragraph eingefügt werden. Sie kann beispielsweise nicht am Startindex einer Tabelle eingefügt werden, also zwischen einer vorhandenen Tabelle und dem vorherigen Absatz.

Tabellen können nicht in eine Fußnote oder Gleichung eingefügt werden.

endOfSegmentLocation

object (EndOfSegmentLocation)

Fügt die Tabelle am Ende der angegebenen Kopf- oder Fußzeile oder des Dokumenttexts ein. Vor der eingefügten Tabelle wird ein Zeilenumbruch eingefügt.

Tabellen können nicht in eine Fußnote eingefügt werden.

InsertTableRowRequest

Fügt eine leere Zeile in eine Tabelle ein.

JSON-Darstellung 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}
Felder
tableCellLocation

object (TableCellLocation)

Die Position der Referenztabellenzelle, ab der Zeilen eingefügt werden.

Eine neue Zeile wird über (oder unter) der Zeile eingefügt, in der sich die Referenzzelle befindet. Wenn die Referenzzelle eine zusammengeführte Zelle ist, wird eine neue Zeile über (oder unter) der zusammengeführten Zelle eingefügt.

insertBelow

boolean

Gibt an, ob eine neue Zeile unter der Referenzzelle eingefügt werden soll.

  • True : unter der Zelle einfügen.
  • False : Über der Zelle einfügen.

TableCellLocation

Position einer einzelnen Zelle in einer Tabelle.

JSON-Darstellung 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}
Felder
tableStartLocation

object (Location)

Die Position, an der die Tabelle im Dokument beginnt.

rowIndex

integer

Der nullbasierte Zeilenindex. Die zweite Zeile in der Tabelle hat beispielsweise den Zeilenindex 1.

columnIndex

integer

Der nullbasierte Spaltenindex. Die zweite Spalte in der Tabelle hat beispielsweise den Spaltenindex 1.

InsertTableColumnRequest

Fügt eine leere Spalte in eine Tabelle ein.

JSON-Darstellung 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}
Felder
tableCellLocation

object (TableCellLocation)

Die Position der Referenztabellenzelle, ab der Spalten eingefügt werden.

Eine neue Spalte wird links (oder rechts) von der Spalte eingefügt, in der sich die Referenzzelle befindet. Wenn die Referenzzelle eine zusammengeführte Zelle ist, wird eine neue Spalte links (oder rechts) von der zusammengeführten Zelle eingefügt.

insertRight

boolean

Gibt an, ob die neue Spalte rechts von der Referenzzelle eingefügt werden soll.

  • True : rechts einfügen.
  • False : links einfügen.

DeleteTableRowRequest

Löscht eine Zeile aus einer Tabelle.

JSON-Darstellung 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
Felder
tableCellLocation

object (TableCellLocation)

Die Position der Referenztabellenzelle, aus der die Zeile gelöscht wird.

Die Zeile, über die sich diese Zelle erstreckt, wird gelöscht. Wenn es sich um eine zusammengeführte Zelle handelt, die sich über mehrere Zeilen erstreckt, werden alle Zeilen gelöscht, über die sich die Zelle erstreckt. Wenn nach dem Löschen keine Zeilen mehr in der Tabelle vorhanden sind, wird die gesamte Tabelle gelöscht.

DeleteTableColumnRequest

Löscht eine Spalte aus einer Tabelle.

JSON-Darstellung 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
Felder
tableCellLocation

object (TableCellLocation)

Die Position der Referenztabellenzelle, aus der die Spalte gelöscht wird.

Die Spalte, über die sich diese Zelle erstreckt, wird gelöscht. Wenn es sich um eine zusammengeführte Zelle handelt, die sich über mehrere Spalten erstreckt, werden alle Spalten gelöscht, über die sich die Zelle erstreckt. Wenn nach dem Löschen keine Spalten mehr in der Tabelle vorhanden sind, wird die gesamte Tabelle gelöscht.

InsertPageBreakRequest

Fügt an der angegebenen Stelle einen Seitenumbruch gefolgt von einem Zeilenumbruch ein.

JSON-Darstellung 
{

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Felder
Union-Feld insertion_location. Die Stelle, an der der Seitenumbruch eingefügt wird. Für insertion_location ist nur einer der folgenden Werte zulässig:
location

object (Location)

Fügt den Seitenumbruch an einer bestimmten Stelle im Dokument ein.

Der Seitenumbruch muss innerhalb der Grenzen eines vorhandenen Paragraph eingefügt werden. Sie kann beispielsweise nicht am Startindex einer Tabelle eingefügt werden, also zwischen der Tabelle und dem vorherigen Absatz.

Seitenumbrüche können nicht in eine Tabelle, Gleichung, Fußnote, Kopf- oder Fußzeile eingefügt werden. Da Seitenumbrüche nur im Textkörper eingefügt werden können, muss das Feld segment ID leer sein.

endOfSegmentLocation

object (EndOfSegmentLocation)

Fügt den Seitenumbruch am Ende des Dokumentinhalts ein.

Seitenumbrüche können nicht in einer Fußnote, Kopf- oder Fußzeile eingefügt werden. Da Seitenumbrüche nur im Textkörper eingefügt werden können, muss das Feld segment ID leer sein.

DeletePositionedObjectRequest

Löscht ein PositionedObject aus dem Dokument.

JSON-Darstellung 
{
  "objectId": string,
  "tabId": string
}
Felder
objectId

string

Die ID des zu löschenden positionierten Objekts.

tabId

string

Die Registerkarte, auf der sich das zu löschende positionierte Objekt befindet. Wird kein Wert angegeben, wird die Anfrage auf den ersten Tab angewendet.

In einem Dokument mit nur einem Tab:

  • Falls angegeben, muss sie mit der ID des einzelnen Tabs übereinstimmen.

  • Wenn nichts angegeben ist, bezieht sich die Anfrage auf den einzelnen Tab.

In einem Dokument mit mehreren Tabs:

  • Falls angegeben, bezieht sich die Anfrage auf den angegebenen Tab.

  • Wird nichts angegeben, bezieht sich die Anfrage auf den ersten Tab im Dokument.

UpdateTableColumnPropertiesRequest

Aktualisiert die TableColumnProperties von Spalten in einer Tabelle.

JSON-Darstellung 
{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}
Felder
tableStartLocation

object (Location)

Die Position, an der die Tabelle im Dokument beginnt.

columnIndices[]

integer

Die Liste der nullbasierten Spaltenindizes, deren Attribut aktualisiert werden soll. Wenn keine Indexe angegeben sind, werden alle Spalten aktualisiert.

tableColumnProperties

object (TableColumnProperties)

Die zu aktualisierenden Eigenschaften der Tabellenspalte.

Wenn der Wert von tableColumnProperties#width kleiner als 5 Punkte (5/72 Zoll) ist, wird der Fehler „400 Bad Request“ zurückgegeben.

fields

string (FieldMask format)

Die Felder, die aktualisiert werden sollen.

Es muss mindestens ein Feld angegeben werden. Der Stamm tableColumnProperties ist impliziert und sollte nicht angegeben werden. Ein einzelnes "*" kann als Kurzform für die Auflistung aller Felder verwendet werden.

Wenn Sie beispielsweise die Spaltenbreite aktualisieren möchten, legen Sie fields auf "width" fest.

UpdateTableCellStyleRequest

Aktualisiert den Stil eines Bereichs von Tabellenzellen.

JSON-Darstellung 
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "fields": string,

  // Union field cells can be only one of the following:
  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
  // End of list of possible types for union field cells.
}
Felder
tableCellStyle

object (TableCellStyle)

Der Stil, der für die Tabellenzellen festgelegt werden soll.

Wenn Sie Rahmen aktualisieren und eine Zelle einen Rahmen mit einer angrenzenden Zelle teilt, wird auch die entsprechende Rahmeneigenschaft der angrenzenden Zelle aktualisiert. Zusammengeführte und unsichtbare Rahmen werden nicht aktualisiert.

Da das Aktualisieren einer gemeinsamen Rahmenlinie benachbarter Zellen in derselben Anfrage zu widersprüchlichen Rahmenlinienaktualisierungen führen kann, werden Rahmenlinienaktualisierungen in der folgenden Reihenfolge angewendet:

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

Die Felder, die aktualisiert werden sollen.

Es muss mindestens ein Feld angegeben werden. Der Stamm tableCellStyle ist impliziert und sollte nicht angegeben werden. Ein einzelnes "*" kann als Kurzform für die Auflistung aller Felder verwendet werden.

Wenn Sie beispielsweise die Hintergrundfarbe der Tabellenzelle aktualisieren möchten, legen Sie fields auf "backgroundColor" fest.

Wenn Sie eine Property auf den Standardwert zurücksetzen möchten, geben Sie ihren Feldnamen in der Feldmaske an, lassen Sie das Feld selbst jedoch nicht festgelegt.

Union-Feld cells. Die Zellen, die aktualisiert werden. Für cells ist nur einer der folgenden Werte zulässig:
tableRange

object (TableRange)

Der Tabellenbereich, der die Teilmenge der Tabelle darstellt, auf die die Aktualisierungen angewendet werden.

tableStartLocation

object (Location)

Die Position, an der die Tabelle im Dokument beginnt. Wenn angegeben, werden die Aktualisierungen auf alle Zellen in der Tabelle angewendet.

TableRange

Ein Tabellenbereich ist ein Verweis auf eine Teilmenge einer Tabelle.

Die durch einen Tabellenbereich angegebenen Zellen müssen nicht unbedingt ein Rechteck bilden. Nehmen wir an, wir haben eine 3 × 3-Tabelle, in der alle Zellen der letzten Zeile zusammengeführt sind. Die Tabelle sieht so aus: 

 [   ][   ][   ]
 [   ][   ][   ]
 [             ]

Ein Tabellenbereich mit dem Tabellenzellenstandort = (tableStartLocation, row = 0, column = 0), rowSpan = 3 und columnSpan = 2 gibt die folgenden Zellen an: 

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]
JSON-Darstellung 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
Felder
tableCellLocation

object (TableCellLocation)

Die Zellposition, an der der Tabellenbereich beginnt.

rowSpan

integer

Die Anzahl der Zeilen des Tabellenbereichs.

columnSpan

integer

Die Spaltenbreite des Tabellenbereichs.

UpdateTableRowStyleRequest

Aktualisiert die TableRowStyle von Zeilen in einer Tabelle.

JSON-Darstellung 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}
Felder
tableStartLocation

object (Location)

Die Position, an der die Tabelle im Dokument beginnt.

rowIndices[]

integer

Die Liste der nullbasierten Zeilenindizes, deren Stil aktualisiert werden soll. Wenn keine Indexe angegeben sind, werden alle Zeilen aktualisiert.

tableRowStyle

object (TableRowStyle)

Die Stile, die für die Zeilen festgelegt werden sollen.

fields

string (FieldMask format)

Die Felder, die aktualisiert werden sollen.

Es muss mindestens ein Feld angegeben werden. Der Stamm tableRowStyle ist impliziert und sollte nicht angegeben werden. Ein einzelnes "*" kann als Kurzform für die Auflistung aller Felder verwendet werden.

Wenn Sie beispielsweise die Mindestzeilenhöhe aktualisieren möchten, legen Sie fields auf "minRowHeight" fest.

ReplaceImageRequest

Ersetzt ein vorhandenes Bild durch ein neues Bild.

Wenn Sie ein Bild ersetzen, werden einige image effects aus dem vorhandenen Bild entfernt, um das Verhalten des Docs-Editors zu spiegeln.

JSON-Darstellung 
{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "tabId": string
}
Felder
imageObjectId

string

Die ID des vorhandenen Bildes, das ersetzt werden soll. Die ID kann aus der Antwort einer GET-Anfrage abgerufen werden.

uri

string

Der URI des neuen Bildes.

Das Bild wird einmal beim Einfügen abgerufen und eine Kopie wird zur Anzeige im Dokument gespeichert. Bilder dürfen nicht größer als 50 MB sein, dürfen nicht mehr als 25 Megapixel haben und müssen im PNG-, JPEG- oder GIF-Format vorliegen.

Der angegebene URI darf nicht länger als 2 KB sein. Der URI wird mit dem Bild gespeichert und über das Feld ImageProperties.source_uri verfügbar gemacht.

imageReplaceMethod

enum (ImageReplaceMethod)

Die Ersetzungsmethode.

tabId

string

Der Tab, auf dem sich das zu ersetzende Bild befindet. Wird kein Wert angegeben, wird die Anfrage auf den ersten Tab angewendet.

In einem Dokument mit nur einem Tab:

  • Falls angegeben, muss sie mit der ID des einzelnen Tabs übereinstimmen.

  • Wenn nichts angegeben ist, bezieht sich die Anfrage auf den einzelnen Tab.

In einem Dokument mit mehreren Tabs:

  • Falls angegeben, bezieht sich die Anfrage auf den angegebenen Tab.

  • Wird nichts angegeben, bezieht sich die Anfrage auf den ersten Tab im Dokument.

ImageReplaceMethod

Die Methode zum Ersetzen von Bildern.

Enums
IMAGE_REPLACE_METHOD_UNSPECIFIED Nicht angegebene Methode zum Ersetzen von Bildern. Dieser Wert darf nicht verwendet werden.
CENTER_CROP Das Bild wird skaliert und zentriert, um die Begrenzungen des Originalbilds auszufüllen. Das Bild wird möglicherweise zugeschnitten, damit es die Grenzen des Originalbilds ausfüllt. Die gerenderte Größe des Bildes entspricht der des Originalbildes.

UpdateDocumentStyleRequest

Aktualisiert die DocumentStyle.

JSON-Darstellung 
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string,
  "tabId": string
}
Felder
documentStyle

object (DocumentStyle)

Die Stile, die für das Dokument festgelegt werden sollen.

Bestimmte Änderungen am Dokumentstil können andere Änderungen zur Folge haben, um das Verhalten des Docs-Editors widerzuspiegeln. Weitere Informationen finden Sie in der Dokumentation zu DocumentStyle.

fields

string (FieldMask format)

Die Felder, die aktualisiert werden sollen.

Es muss mindestens ein Feld angegeben werden. Der Stamm documentStyle ist impliziert und sollte nicht angegeben werden. Ein einzelnes "*" kann als Kurzform für die Auflistung aller Felder verwendet werden.

Wenn Sie beispielsweise den Hintergrund aktualisieren möchten, legen Sie fields auf "background" fest.

tabId

string

Der Tab, der den zu aktualisierenden Stil enthält. Wird kein Wert angegeben, bezieht sich die Anfrage auf den ersten Tab.

In einem Dokument mit nur einem Tab:

  • Falls angegeben, muss sie mit der ID des einzelnen Tabs übereinstimmen.

  • Wenn nichts angegeben ist, bezieht sich die Anfrage auf den einzelnen Tab.

In einem Dokument mit mehreren Tabs:

  • Falls angegeben, bezieht sich die Anfrage auf den angegebenen Tab.

  • Wenn nicht angegeben, bezieht sich die Anfrage auf den ersten Tab im Dokument.

MergeTableCellsRequest

Führt Zellen in einem Table zusammen.

JSON-Darstellung 
{
  "tableRange": {
    object (TableRange)
  }
}
Felder
tableRange

object (TableRange)

Der Tabellenbereich, der angibt, welche Zellen der Tabelle zusammengeführt werden sollen.

Der Text in den Zellen, die zusammengeführt werden, wird verkettet und in der „head“-Zelle des Bereichs gespeichert. Dies ist die Zelle oben links im Bereich, wenn die Inhaltsrichtung von links nach rechts verläuft, und die Zelle oben rechts im Bereich, wenn die Inhaltsrichtung von rechts nach links verläuft.

Wenn der Bereich nicht rechteckig ist (was in einigen Fällen vorkommen kann, wenn der Bereich Zellen umfasst, die bereits zusammengeführt wurden, oder wenn die Tabelle nicht rechteckig ist), wird ein Fehler vom Typ „400 Bad Request“ zurückgegeben.

UnmergeTableCellsRequest

Hebt den Zellenverbund in einem Table auf.

JSON-Darstellung 
{
  "tableRange": {
    object (TableRange)
  }
}
Felder
tableRange

object (TableRange)

Der Tabellenbereich, der angibt, welche Zellen der Tabelle zusammengeführt werden sollen.

Alle zusammengeführten Zellen in diesem Bereich werden wieder getrennt. Zellen, die bereits getrennt sind, sind davon nicht betroffen. Wenn der Bereich keine zusammengeführten Zellen enthält, wird durch die Anfrage nichts bewirkt.

Wenn in einer der zusammengeführten Zellen Text enthalten ist, bleibt dieser in der „Kopfzelle“ des resultierenden Blocks nicht zusammengeführter Zellen erhalten. Die Kopfzelle ist die Zelle oben links, wenn die Inhaltsrichtung von links nach rechts verläuft, und andernfalls die Zelle oben rechts.

CreateHeaderRequest

Erstellt einen Header. Der neue Header wird auf SectionStyle am Speicherort von SectionBreak angewendet, sofern angegeben. Andernfalls wird er auf DocumentStyle angewendet.

Wenn bereits ein Header des angegebenen Typs vorhanden ist, wird der Fehler „400 Bad Request“ zurückgegeben.

JSON-Darstellung 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Felder
type

enum (HeaderFooterType)

Der Typ des Headers, der erstellt werden soll.

sectionBreakLocation

object (Location)

Die Position des SectionBreak , mit dem der Abschnitt beginnt, zu dem diese Überschrift gehören soll. Wenn „sectionBreakLocation“ nicht festgelegt ist oder sich auf den ersten Abschnittsumbruch im Dokumentkörper bezieht, gilt die Kopfzeile für die DocumentStyle.

HeaderFooterType

Die Arten von Kopf- und Fußzeilen, die erstellt werden können.

Enums
DEFAULT Eine Standardkopf- und ‑fußzeile.

CreateFooterRequest

Erstellt einen Footer. Die neue Fußzeile wird auf die SectionStyle angewendet, sofern die SectionBreak angegeben ist. Andernfalls wird sie auf die DocumentStyle angewendet.

Wenn bereits eine Fußzeile des angegebenen Typs vorhanden ist, wird der Fehler „400 Bad Request“ zurückgegeben.

JSON-Darstellung 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Felder
type

enum (HeaderFooterType)

Der Typ der zu erstellenden Fußzeile.

sectionBreakLocation

object (Location)

Die Position des SectionBreak unmittelbar vor dem Abschnitt, zu dessen SectionStyle diese Fußzeile gehören soll. Wenn diese Einstellung nicht festgelegt ist oder sich auf den ersten Abschnittsumbruch im Dokument bezieht, gilt die Fußzeile für den Dokumentstil.

CreateFootnoteRequest

Erstellt ein Footnote-Segment und fügt an der angegebenen Stelle ein neues FootnoteReference ein.

Das neue Segment Footnote enthält ein Leerzeichen, gefolgt von einem Zeilenumbruch.

JSON-Darstellung 
{

  // Union field footnote_reference_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field footnote_reference_location.
}
Felder
Union-Feld footnote_reference_location. Die Stelle, an der der Fußnotenverweis eingefügt werden soll. Für footnote_reference_location ist nur einer der folgenden Werte zulässig:
location

object (Location)

Fügt den Fußnotenverweis an einer bestimmten Stelle im Dokument ein.

Die Fußnotenreferenz muss innerhalb der Grenzen eines vorhandenen Paragraph eingefügt werden. Sie kann beispielsweise nicht am Startindex einer Tabelle eingefügt werden, also zwischen der Tabelle und dem vorherigen Absatz.

Fußnotenverweise können nicht in eine Gleichung, Kopfzeile, Fußzeile oder Fußnote eingefügt werden. Da Fußnotenverweise nur im Textkörper eingefügt werden können, muss das Feld segment ID leer sein.

endOfSegmentLocation

object (EndOfSegmentLocation)

Fügt die Fußnotenreferenz am Ende des Dokumenttexts ein.

Fußnotenverweise können nicht in eine Kopf- oder Fußzeile oder eine Fußnote eingefügt werden. Da Fußnotenverweise nur im Textkörper eingefügt werden können, muss das Feld segment ID leer sein.

ReplaceNamedRangeContentRequest

Ersetzt den Inhalt des angegebenen NamedRange oder NamedRanges durch den angegebenen Ersatzinhalt.

Ein einzelnes NamedRange kann aus mehreren diskontinuierlichen ranges bestehen. In diesem Fall wird nur der Inhalt im ersten Bereich ersetzt. Die anderen Bereiche und ihre Inhalte werden gelöscht.

Wenn das Ersetzen oder Löschen von Bereichen zu einer ungültigen Dokumentstruktur führen würde, wird der Fehler „400 Bad Request“ zurückgegeben.

JSON-Darstellung 
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field replacement_content can be only one of the following:
  "text": string
  // End of list of possible types for union field replacement_content.

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "namedRangeName": string
  // End of list of possible types for union field named_range_reference.
}
Felder
tabsCriteria

object (TabsCriteria)

Optional. Die Kriterien, mit denen angegeben wird, auf welchen Tabs die Ersetzung erfolgt. Wenn ausgelassen, gilt der Ersatz für alle Tabs.

In einem Dokument mit nur einem Tab:

  • Falls angegeben, muss sie mit der ID des einzelnen Tabs übereinstimmen.

  • Wenn nichts angegeben ist, gilt der Ersatz für den einzelnen Tab.

In einem Dokument mit mehreren Tabs:

  • Wenn angegeben, gilt der Ersatz für die angegebenen Tabs.

  • Wenn nichts angegeben ist, gilt der Ersatz für alle Tabs.

Union-Feld replacement_content. Der Inhalt, mit dem der vorhandene Inhalt des benannten Bereichs ersetzt werden soll. Für replacement_content ist nur einer der folgenden Werte zulässig:
text

string

Ersetzt den Inhalt der angegebenen benannten Bereiche durch den angegebenen Text.

Union-Feld named_range_reference. Eine Referenz auf die benannten Bereiche, deren Inhalt ersetzt wird. Für named_range_reference ist nur einer der folgenden Werte zulässig:
namedRangeId

string

Die ID des benannten Bereichs, dessen Inhalt ersetzt werden soll.

Wenn kein benannter Bereich mit der angegebenen ID vorhanden ist, wird der Fehler „400 Bad Request“ zurückgegeben.

namedRangeName

string

Der Name der NamedRanges, deren Inhalt ersetzt wird.

Wenn es mehrere named ranges mit dem angegebenen Namen gibt, wird der Inhalt jedes einzelnen ersetzt. Wenn keine benannten Bereiche mit dem angegebenen Namen vorhanden sind, wird die Anfrage nicht ausgeführt.

UpdateSectionStyleRequest

Aktualisiert die SectionStyle.

JSON-Darstellung 
{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}
Felder
range

object (Range)

Der Bereich, der sich mit den zu formatierenden Abschnitten überschneidet.

Da Abschnittsumbrüche nur im Textkörper eingefügt werden können, muss das Feld segment ID leer sein.

sectionStyle

object (SectionStyle)

Die für den Abschnitt festzulegenden Stile.

Bestimmte Änderungen am Abschnittsstil können andere Änderungen nach sich ziehen, um das Verhalten des Docs-Editors widerzuspiegeln. Weitere Informationen finden Sie in der Dokumentation zu SectionStyle.

fields

string (FieldMask format)

Die Felder, die aktualisiert werden sollen.

Es muss mindestens ein Feld angegeben werden. Der Stamm sectionStyle ist impliziert und darf nicht angegeben werden. Ein einzelnes "*" kann als Kurzform für die Auflistung aller Felder verwendet werden.

Wenn Sie beispielsweise den linken Rand aktualisieren möchten, legen Sie fields auf "marginLeft" fest.

InsertSectionBreakRequest

Fügt an der angegebenen Stelle einen Abschnittswechsel ein.

Vor dem Abschnittsumbruch wird ein Zeilenumbruchzeichen eingefügt.

JSON-Darstellung 
{
  "sectionType": enum (SectionType),

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Felder
sectionType

enum (SectionType)

Der Typ des einzufügenden Abschnitts.

Union-Feld insertion_location. Die Position, an der die Pause eingefügt wird. Für insertion_location ist nur einer der folgenden Werte zulässig:
location

object (Location)

Fügt an einer bestimmten Stelle im Dokument eine neue Zeile und einen Abschnittsumbruch ein.

Der Abschnittsumbruch muss innerhalb der Grenzen eines vorhandenen Paragraph eingefügt werden. Sie kann beispielsweise nicht am Startindex einer Tabelle eingefügt werden, also zwischen der Tabelle und dem vorherigen Absatz.

Abschnittsumbrüche können nicht in eine Tabelle, Gleichung, Fußnote, Kopf- oder Fußzeile eingefügt werden. Da Abschnittsumbrüche nur im Body eingefügt werden können, muss das Feld segment ID leer sein.

endOfSegmentLocation

object (EndOfSegmentLocation)

Fügt am Ende des Dokumentinhalts einen Zeilenumbruch und einen Abschnittsumbruch ein.

Abschnittsumbrüche können nicht in Fußnoten, Kopf- oder Fußzeilen eingefügt werden. Da Abschnittsumbrüche nur im Textkörper eingefügt werden können, muss das Feld segment ID leer sein.

DeleteHeaderRequest

Löscht ein Header aus dem Dokument.

JSON-Darstellung 
{
  "headerId": string,
  "tabId": string
}
Felder
headerId

string

Die ID des zu löschenden Headers. Wenn diese Kopfzeile für DocumentStyle definiert ist, wird der Verweis auf diese Kopfzeile entfernt. Das führt dazu, dass für den ersten Abschnitt des Dokuments keine Kopfzeile dieses Typs vorhanden ist. Wenn dieser Header für ein SectionStyle definiert ist, wird der Verweis auf diesen Header entfernt und der Header dieses Typs wird nun aus dem vorherigen Abschnitt fortgesetzt.

tabId

string

Der Tab mit dem zu löschenden Header. Wird kein Wert angegeben, wird die Anfrage auf den ersten Tab angewendet.

In einem Dokument mit nur einem Tab:

  • Falls angegeben, muss sie mit der ID des einzelnen Tabs übereinstimmen.

  • Wenn nichts angegeben ist, bezieht sich die Anfrage auf den einzelnen Tab.

In einem Dokument mit mehreren Tabs:

  • Falls angegeben, bezieht sich die Anfrage auf den angegebenen Tab.

  • Wird nichts angegeben, bezieht sich die Anfrage auf den ersten Tab im Dokument.

DeleteFooterRequest

Löscht ein Footer aus dem Dokument.

JSON-Darstellung 
{
  "footerId": string,
  "tabId": string
}
Felder
footerId

string

Die ID der zu löschenden Fußzeile. Wenn diese Fußzeile für DocumentStyle definiert ist, wird der Verweis auf diese Fußzeile entfernt. Das führt dazu, dass für den ersten Abschnitt des Dokuments keine Fußzeile dieses Typs vorhanden ist. Wenn diese Fußzeile für ein SectionStyle definiert ist, wird der Verweis auf diese Fußzeile entfernt und die Fußzeile dieses Typs wird nun aus dem vorherigen Abschnitt fortgesetzt.

tabId

string

Der Tab, der die zu löschende Fußzeile enthält. Wird kein Wert angegeben, wird die Anfrage auf den ersten Tab angewendet.

In einem Dokument mit nur einem Tab:

  • Falls angegeben, muss sie mit der ID des einzelnen Tabs übereinstimmen.

  • Wenn nichts angegeben ist, bezieht sich die Anfrage auf den einzelnen Tab.

In einem Dokument mit mehreren Tabs:

  • Falls angegeben, bezieht sich die Anfrage auf den angegebenen Tab.

  • Wird nichts angegeben, bezieht sich die Anfrage auf den ersten Tab im Dokument.

PinTableHeaderRowsRequest

Aktualisiert die Anzahl der angepinnten Tabellenüberschriftenzeilen in einer Tabelle.

JSON-Darstellung 
{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}
Felder
tableStartLocation

object (Location)

Die Position, an der die Tabelle im Dokument beginnt.

pinnedHeaderRowsCount

integer

Die Anzahl der Tabellenzeilen, die angepinnt werden sollen. Bei 0 sind alle Zeilen nicht angepinnt.

InsertPersonRequest

Fügt eine Erwähnung einer Person ein.

JSON-Darstellung 
{
  "personProperties": {
    object (PersonProperties)
  },

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Felder
personProperties

object (PersonProperties)

Die Eigenschaften der einzufügenden Personenangabe.

Union-Feld insertion_location. Der Ort, an dem die Erwähnung der Person eingefügt wird. Für insertion_location ist nur einer der folgenden Werte zulässig:
location

object (Location)

Fügt die Erwähnung der Person an einer bestimmten Stelle im Dokument ein.

Die Erwähnung muss innerhalb der Grenzen eines vorhandenen Paragraph eingefügt werden. Sie kann beispielsweise nicht am Startindex einer Tabelle eingefügt werden, also zwischen der Tabelle und dem vorherigen Absatz.

Personenerwähnungen können nicht in eine Gleichung eingefügt werden.

endOfSegmentLocation

object (EndOfSegmentLocation)

Fügt die Erwähnung der Person am Ende einer Kopf- oder Fußzeile, einer Fußnote oder des Dokumenttexts ein.