Requests

{

  // 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)
  }
  // End of list of possible types for union field request.
}

object (ReplaceAllTextRequest)

Ersetzt alle Instanzen des angegebenen Texts.

object (InsertTextRequest)

Fügt Text an der angegebenen Stelle ein.

object (UpdateTextStyleRequest)

Aktualisiert den Textstil im angegebenen Bereich.

object (CreateParagraphBulletsRequest)

Erstellt Aufzählungspunkte für Absätze.

object (DeleteParagraphBulletsRequest)

Löscht Aufzählungspunkte aus Absätzen.

object (CreateNamedRangeRequest)

Erstellt einen benannten Bereich.

object (DeleteNamedRangeRequest)

Löscht einen benannten Bereich.

object (UpdateParagraphStyleRequest)

Aktualisiert den Absatzstil im angegebenen Bereich.

object (DeleteContentRangeRequest)

Löscht Inhalte aus dem Dokument.

object (InsertInlineImageRequest)

Fügt an der angegebenen Stelle ein Inline-Bild ein.

object (InsertTableRequest)

Fügt an der angegebenen Stelle eine Tabelle ein.

object (InsertTableRowRequest)

Fügt eine leere Zeile in eine Tabelle ein.

object (InsertTableColumnRequest)

Fügt eine leere Spalte in eine Tabelle ein.

object (DeleteTableRowRequest)

Löscht eine Zeile aus einer Tabelle.

object (DeleteTableColumnRequest)

Löscht eine Spalte aus einer Tabelle.

object (InsertPageBreakRequest)

Fügt an der angegebenen Stelle einen Seitenumbruch ein.

object (DeletePositionedObjectRequest)

Löscht ein positioniertes Objekt aus dem Dokument.

object (UpdateTableColumnPropertiesRequest)

Aktualisiert die Eigenschaften von Spalten in einer Tabelle.

object (UpdateTableCellStyleRequest)

Hiermit wird der Stil der Tabellenzellen aktualisiert.

object (UpdateTableRowStyleRequest)

Aktualisiert den Zeilenstil in einer Tabelle.

object (ReplaceImageRequest)

Ersetzt ein Bild im Dokument.

object (UpdateDocumentStyleRequest)

Der Stil des Dokuments wird aktualisiert.

object (MergeTableCellsRequest)

Zellen in einer Tabelle werden zusammengeführt.

object (UnmergeTableCellsRequest)

Zellen in einer Tabelle werden getrennt.

object (CreateHeaderRequest)

Erstellt einen Header.

object (CreateFooterRequest)

Erstellt einen Fußzeilenbereich.

object (CreateFootnoteRequest)

Erstellt eine Fußnote.

object (ReplaceNamedRangeContentRequest)

Ersetzt den Inhalt eines benannten Bereichs.

object (UpdateSectionStyleRequest)

Aktualisiert den Abschnittsstil des angegebenen Bereichs.

object (InsertSectionBreakRequest)

Fügt an der angegebenen Stelle einen Abschnittsumbruch ein.

object (DeleteHeaderRequest)

Löscht eine Überschrift aus dem Dokument.

object (DeleteFooterRequest)

Löscht eine Fußzeile aus dem Dokument.

object (PinTableHeaderRowsRequest)

Aktualisiert die Anzahl der angepinnten Überschriftenzeilen in einer Tabelle.

{
  "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.
}

string

Der Text, der den übereinstimmenden Text ersetzt.

object (TabsCriteria)

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

Wenn Sie den Parameter weglassen, gilt der Ersatz für alle Tabs.

In einem Dokument mit einem einzelnen Tab:

• Muss, falls angegeben, mit der ID des einzelnen Tabs übereinstimmen.

• Wenn Sie diese Option weglassen, wird der Ersatz auf den einzelnen Tab angewendet.

In einem Dokument mit mehreren Tabs:

• Wenn angegeben, wird der Ersatz auf die angegebenen Tabs angewendet.

• Wird der Parameter weggelassen, gilt der Ersatz für alle Tabs.

object (SubstringMatchCriteria)

Sucht im Dokument nach Text, der mit diesem Teilstring übereinstimmt.

{
  "text": string,
  "matchCase": boolean
}

string

Der Text, nach dem im Dokument gesucht werden soll.

boolean

Gibt an, ob die Groß-/Kleinschreibung bei der Suche 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.

{
  "tabIds": [
    string
  ]
}

string

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

{
  "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.
}

string

Der einzufügende Text.

Wenn Sie einen Zeilenumbruch einfügen, wird an dieser Stelle implizit eine neue Paragraph 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 bestimmt. Dabei wird in der Regel der Stil des benachbarten Texts beibehalten. In den meisten Fällen entspricht der Textstil für den eingefügten Text dem Text direkt vor dem Einfügeindex.

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

object (Location)

Der Text wird an einer bestimmten Stelle im Dokument eingefügt.

Der Text muss innerhalb der Grenzen einer vorhandenen Paragraph eingefügt werden. Text kann beispielsweise nicht am Anfangsindex einer Tabelle eingefügt werden (d.h. zwischen der Tabelle und dem vorhergehenden Absatz). Der Text muss in den vorhergehenden Absatz eingefügt werden.

object (EndOfSegmentLocation)

Der Text wird am Ende einer Kopf- oder Fußzeile, einer Fußnote oder im Textkörper eingefügt.

{
  "segmentId": string,
  "index": integer,
  "tabId": string
}

string

Die ID der Kopf-, Fuß- oder Fußnote, in der sich der Standort befindet. Eine leere Segment-ID steht für den Textkörper des Dokuments.

integer

Der nullbasierte Index in UTF-16-Codeeinheiten.

Der Index ist relativ zum Beginn des durch segmentId angegebenen Segments.

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 einem einzelnen Tab:

• Muss, falls angegeben, mit der ID des einzelnen Tabs übereinstimmen.

• Wird diese Option nicht angegeben, bezieht sich die Anfrage auf den einzelnen Tab.

In einem Dokument mit mehreren Tabs:

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

• Wird dieser Parameter weggelassen, bezieht sich die Anfrage auf den ersten Tab im Dokument.

{
  "segmentId": string,
  "tabId": string
}

string

Die ID der Kopf-, Fuß- oder Fußnote, in der sich der Standort befindet. Eine leere Segment-ID steht für den Textkörper des Dokuments.

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 einem einzelnen Tab:

• Muss, falls angegeben, mit der ID des einzelnen Tabs übereinstimmen.

• Wird diese Option nicht angegeben, bezieht sich die Anfrage auf den einzelnen Tab.

In einem Dokument mit mehreren Tabs:

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

• Wird dieser Parameter weggelassen, bezieht sich die Anfrage auf den ersten Tab im Dokument.

{
  "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.
}

object (TextStyle)

Die Stile, die für den Text festgelegt werden sollen.

Wenn der Wert für einen bestimmten Stil mit dem des übergeordneten Stils übereinstimmt, wird dieser Stil übernommen.

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.

string (FieldMask format)

Die zu aktualisierenden Felder.

Es muss mindestens ein Feld angegeben werden. Der Stammknoten textStyle ist implizit und muss nicht angegeben werden. Ein einzelnes "*" kann als Kurzschreibweise für die Auflistung aller Felder verwendet werden.

Wenn Sie beispielsweise den Textstil fett formatieren möchten, setzen Sie fields auf "bold".

Wenn Sie eine Property auf den Standardwert zurücksetzen möchten, geben Sie den Feldnamen in die Feldmaske ein, lassen Sie das Feld aber leer.

object (Range)

Der Textbereich, der formatiert werden soll.

Der Bereich kann um benachbarte Zeilenumbrüche erweitert werden.

Wenn der Bereich einen ganzen Absatz enthält, der zu einer Liste gehört, wird auch der Aufzählungspunkt des Absatzes mit dem entsprechenden Textstil aktualisiert.

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

{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}

object (Range)

Der Bereich, auf den die Aufzählungsvorlage angewendet werden soll.

enum (BulletGlyphPreset)

Die Art der zu verwendenden Aufzählungszeichen.

{
  "range": {
    object (Range)
  }
}

object (Range)

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

{
  "name": string,
  "range": {
    object (Range)
  }
}

string

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

Namen müssen mindestens ein und maximal 256 Zeichen lang sein, gemessen in UTF-16-Codeeinheiten.

object (Range)

Der Bereich, auf den der Name angewendet werden soll.

{
  "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.
}

object (TabsCriteria)

Optional. Die Kriterien, mit denen angegeben wird, auf welchem oder welchen Tabs der Bereich gelöscht werden soll. Wird der Tab weggelassen, wird der Bereich auf alle Tabs angewendet.

In einem Dokument mit einem einzelnen Tab:

• Muss, falls angegeben, mit der ID des einzelnen Tabs übereinstimmen.

• Wenn Sie diesen Parameter weglassen, wird der Bereich auf dem gesamten Tab gelöscht.

In einem Dokument mit mehreren Tabs:

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

• Wenn Sie keinen Wert angeben, wird der Bereich auf allen Tabs gelöscht.

string

Die ID des benannten Bereichs, der gelöscht werden soll.

string

Der Name der zu löschenden Bereiche. Alle benannten Bereiche mit dem angegebenen Namen werden gelöscht.

{
  "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.
}

object (ParagraphStyle)

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

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

string (FieldMask format)

Die zu aktualisierenden Felder.

Es muss mindestens ein Feld angegeben werden. Der Stammknoten paragraphStyle ist implizit und muss nicht angegeben werden. Ein einzelnes "*" kann als Kurzschreibweise für die Auflistung aller Felder verwendet werden.

Wenn Sie beispielsweise die Ausrichtungseigenschaft des Absatzstils aktualisieren möchten, setzen Sie fields auf "alignment".

Wenn Sie eine Property auf den Standardwert zurücksetzen möchten, geben Sie den Feldnamen in die Feldmaske ein, lassen Sie das Feld aber leer.

object (Range)

Der Bereich, der sich mit den Absätzen überschneidet, die formatiert werden sollen.

{
  "range": {
    object (Range)
  }
}

object (Range)

Der Bereich der Inhalte, die gelöscht werden sollen.

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

Wenn Sie versuchen, bestimmte Bereiche zu löschen, kann das zu einer ungültigen Dokumentstruktur führen. In diesem Fall wird der Fehler 400 (Ungültige Anfrage) zurückgegeben.

Beispiele für ungültige Löschanfragen:

• Löschen einer Codeeinheit eines Surrogatenpaars
• Löschen des letzten Zeichens für neue Zeile in einem Body-, Header-, Footer-, Footnote-, TableCell- oder TableOfContents-Element
• Start oder Ende eines Table-, TableOfContents- oder Equation-Elements löschen, ohne das gesamte Element zu löschen
• Löschen Sie das Zeichen für neue Zeile vor einem Table, TableOfContents oder SectionBreak, ohne das Element zu löschen.
• Einzelne Zeilen oder Zellen einer Tabelle löschen Das Löschen von Inhalten in einer Tabellenzelle ist zulässig.

{
  "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.
}

string

Der Image-URI.

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

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

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 ist, wird eine Standardgröße des Bildes basierend auf seiner Auflösung berechnet. * Wenn eine Dimension angegeben ist, wird die andere so berechnet, dass das Seitenverhältnis des Bildes erhalten bleibt. * 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.

object (Location)

Das Bild wird an einer bestimmten Stelle im Dokument eingefügt.

Das Bild muss innerhalb der Grenzen einer vorhandenen Paragraph eingefügt werden. Sie können sie beispielsweise nicht am Startindex einer Tabelle einfügen (d.h. zwischen der Tabelle und dem vorhergehenden Absatz).

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

object (EndOfSegmentLocation)

Der Text wird am Ende einer Kopf- oder Fußzeile oder im Textkörper eingefügt.

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

{
  "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.
}

integer

Die Anzahl der Zeilen in der Tabelle

integer

Die Anzahl der Spalten in der Tabelle.

object (Location)

Die Tabelle wird an einem bestimmten Modellindex eingefügt.

Vor der eingefügten Tabelle wird ein Zeilenumbruchzeichen eingefügt. Der Startindex der Tabelle ist daher der angegebene Speicherortindex + 1.

Die Tabelle muss innerhalb der Grenzen einer vorhandenen Paragraph eingefügt werden. Sie können beispielsweise nicht am Startindex einer Tabelle eingefügt werden, also nicht zwischen einer vorhandenen Tabelle und dem vorstehenden Absatz.

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

object (EndOfSegmentLocation)

Die Tabelle wird am Ende der angegebenen Kopf- oder Fußzeile oder im Dokumentkörper eingefügt. Vor der eingefügten Tabelle wird ein Zeilenumbruch eingefügt.

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

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}

object (TableCellLocation)

Die Position der Zelle in der Referenztabelle, von der aus Zeilen eingefügt werden.

Eine neue Zeile wird über oder unter der Zeile eingefügt, in der sich die Referenzzelle befindet. Wenn es sich bei der Referenzzelle um eine zusammengeführte Zelle handelt, wird eine neue Zeile über oder unter der zusammengeführten Zelle eingefügt.

boolean

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

• True : Einfügen unter der Zelle.
• False : Einfügen über der Zelle.

{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}

object (Location)

Die Stelle im Dokument, an der die Tabelle beginnt.

integer

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

integer

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

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}

object (TableCellLocation)

Die Position der Referenztabellenzelle, von der aus Spalten eingefügt werden.

Eine neue Spalte wird links (oder rechts) neben der Spalte eingefügt, in der sich die Referenzzelle befindet. Wenn es sich bei der Referenzzelle um eine zusammengeführte Zelle handelt, wird die neue Spalte links (oder rechts) neben der zusammengeführten Zelle eingefügt.

boolean

Gibt an, ob eine neue Spalte rechts neben der Referenzzelle eingefügt werden soll.

• True : Einfügen nach rechts.
• False : Einfügen links.

{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}

object (TableCellLocation)

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

Die Zeile, die diese Zelle umfasst, wird gelöscht. Wenn es sich um eine zusammengeführte Zelle handelt, die mehrere Zeilen umfasst, werden alle Zeilen gelöscht, die von der Zelle abgedeckt werden. Wenn nach diesem Löschvorgang keine Zeilen mehr in der Tabelle vorhanden sind, wird die gesamte Tabelle gelöscht.

{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}

object (TableCellLocation)

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

Die Spalte, die diese Zelle umfasst, wird gelöscht. Wenn es sich um eine zusammengeführte Zelle handelt, die mehrere Spalten umfasst, werden alle Spalten gelöscht, die von der Zelle abgedeckt werden. Wenn nach diesem Löschvorgang keine Spalten mehr in der Tabelle vorhanden sind, wird die gesamte Tabelle gelöscht.

{

  // 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.
}

object (Location)

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

Der Seitenumbruch muss innerhalb der Grenzen einer vorhandenen Paragraph eingefügt werden. Sie können sie beispielsweise nicht am Startindex einer Tabelle einfügen (d.h. zwischen der Tabelle und dem vorhergehenden Absatz).

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

object (EndOfSegmentLocation)

Fügt am Ende des Textkörpers einen Seitenumbruch 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.

{
  "objectId": string,
  "tabId": string
}

string

Die ID des zu löschenden Objekts.

string

Der Tab, auf dem sich das zu löschende Objekt befindet. Wird kein Wert angegeben, wird die Anfrage auf den ersten Tab angewendet.

In einem Dokument mit einem einzelnen Tab:

• Muss, falls angegeben, mit der ID des einzelnen Tabs übereinstimmen.

• Wird diese Option nicht angegeben, bezieht sich die Anfrage auf den einzelnen Tab.

In einem Dokument mit mehreren Tabs:

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

• Wird dieser Parameter weggelassen, bezieht sich die Anfrage auf den ersten Tab im Dokument.

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

object (Location)

Die Stelle im Dokument, an der die Tabelle beginnt.

integer

Liste der nullbasierten Spaltenindizes, deren Eigenschaft aktualisiert werden soll. Wenn keine Indizes angegeben sind, werden alle Spalten aktualisiert.

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 zurückgegeben.

string (FieldMask format)

Die zu aktualisierenden Felder.

Es muss mindestens ein Feld angegeben werden. Der Stammknoten tableColumnProperties ist implizit und muss nicht angegeben werden. Ein einzelnes "*" kann als Kurzschreibweise für die Auflistung aller Felder verwendet werden.

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

{
  "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.
}

object (TableCellStyle)

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

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

Da das Aktualisieren eines Rahmens, der von benachbarten Zellen in derselben Anfrage geteilt wird, zu widersprüchlichen Rahmenaktualisierungen führen kann, werden Rahmenaktualisierungen in der folgenden Reihenfolge angewendet:

• borderRight
• borderLeft
• borderBottom
• borderTop

string (FieldMask format)

Die zu aktualisierenden Felder.

Es muss mindestens ein Feld angegeben werden. Der Stammknoten tableCellStyle ist implizit und muss nicht angegeben werden. Ein einzelnes "*" kann als Kurzschreibweise 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 den Feldnamen in die Feldmaske ein, lassen Sie das Feld aber leer.

object (TableRange)

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

object (Location)

Die Stelle im Dokument, an der die Tabelle beginnt. Wenn Sie diese Option angeben, werden die Änderungen auf alle Zellen in der Tabelle angewendet.

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}

object (TableCellLocation)

Die Zelle, in der der Tabellenbereich beginnt.

integer

Die Zeilenspanne des Tabellenbereichs.

integer

Die Spaltenspanne des Tabellenbereichs.

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

object (Location)

Die Stelle im Dokument, an der die Tabelle beginnt.

integer

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

object (TableRowStyle)

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

string (FieldMask format)

Die zu aktualisierenden Felder.

Es muss mindestens ein Feld angegeben werden. Der Stammknoten tableRowStyle ist implizit und muss nicht angegeben werden. Ein einzelnes "*" kann als Kurzschreibweise für die Auflistung aller Felder verwendet werden.

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

{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "tabId": string
}

string

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

string

Der URI des neuen Bildes.

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

Der angegebene URI darf maximal 2 KB lang sein. Der URI wird mit dem Bild gespeichert und über das Feld ImageProperties.source_uri freigegeben.

enum (ImageReplaceMethod)

Die Ersetzungsmethode.

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 einem einzelnen Tab:

• Muss, falls angegeben, mit der ID des einzelnen Tabs übereinstimmen.

• Wird diese Option nicht angegeben, bezieht sich die Anfrage auf den einzelnen Tab.

In einem Dokument mit mehreren Tabs:

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

• Wird dieser Parameter weggelassen, bezieht sich die Anfrage auf den ersten Tab im Dokument.

{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string,
  "tabId": string
}

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.

string (FieldMask format)

Die zu aktualisierenden Felder.

Es muss mindestens ein Feld angegeben werden. Der Stammknoten documentStyle ist implizit und muss nicht angegeben werden. Ein einzelnes "*" kann als Kurzschreibweise für die Auflistung aller Felder verwendet werden.

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

string

Der Tab mit dem zu aktualisierenden Stil. Wird der Parameter weggelassen, gilt die Anfrage für den ersten Tab.

In einem Dokument mit einem einzelnen Tab:

• Muss, falls angegeben, mit der ID des einzelnen Tabs übereinstimmen.

• Wird diese Option nicht angegeben, bezieht sich die Anfrage auf den einzelnen Tab.

In einem Dokument mit mehreren Tabs:

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

• Wenn Sie keinen angeben, gilt die Anfrage für den ersten Tab im Dokument.

{
  "tableRange": {
    object (TableRange)
  }
}

object (TableRange)

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

Der Text in den zusammengeführten Zellen wird zusammengefügt und in der Kopfzelle des Bereichs gespeichert. Das ist die Zelle links oben im Bereich, wenn die Inhaltsrichtung von links nach rechts ist, andernfalls die Zelle rechts oben im Bereich.

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 der Fehler 400 zurückgegeben.

{
  "tableRange": {
    object (TableRange)
  }
}

object (TableRange)

Der Tabellenbereich, der angibt, welche Zellen der Tabelle getrennt werden sollen.

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

Wenn sich in einer der zusammengeführten Zellen Text befindet, bleibt er in der Kopfzelle des resultierenden Blocks nicht zusammengeführter Zellen. Die Kopfzelle ist die linke obere Zelle, wenn die Inhaltsrichtung von links nach rechts ist, andernfalls die rechte obere Zelle.

{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}

enum (HeaderFooterType)

Der zu erstellende Headertyp.

object (Location)

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

{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}

enum (HeaderFooterType)

Der zu erstellende Fußzeilentyp.

object (Location)

Der Speicherort der SectionBreak unmittelbar vor dem Abschnitt, zu dessen SectionStyle diese Fußzeile gehören soll. Wenn diese Option nicht festgelegt ist oder sich auf den ersten Abschnittswechsel im Dokument bezieht, wird die Fußzeile auf den Dokumentstil angewendet.

{

  // 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.
}

object (Location)

Der Verweis auf die Fußnote wird an einer bestimmten Stelle im Dokument eingefügt.

Der Verweis auf die Fußnote muss innerhalb der Grenzen einer vorhandenen Paragraph eingefügt werden. Sie können sie beispielsweise nicht am Startindex einer Tabelle einfügen (d.h. zwischen der Tabelle und dem vorhergehenden Absatz).

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

object (EndOfSegmentLocation)

Die Fußnote wird am Ende des Textkörpers eingefügt.

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

{
  "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.
}

object (TabsCriteria)

Optional. Die Kriterien, mit denen festgelegt wird, auf welchen Tabs die Ersetzung erfolgt. Wenn Sie den Parameter weglassen, gilt der Ersatz für alle Tabs.

In einem Dokument mit einem einzelnen Tab:

• Muss, falls angegeben, mit der ID des einzelnen Tabs übereinstimmen.

• Wenn Sie diese Option weglassen, wird der Ersatz auf den einzelnen Tab angewendet.

In einem Dokument mit mehreren Tabs:

• Wenn angegeben, wird der Ersatz auf die angegebenen Tabs angewendet.

• Wird der Parameter weggelassen, gilt der Ersatz für alle Tabs.

string

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

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 (Ungültige Anfrage) zurückgegeben.

string

Der Name der NamedRanges, deren Inhalt ersetzt werden soll.

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

{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}

object (Range)

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

Da Abschnittsübergänge nur im Textkörper eingefügt werden können, muss das Feld segment ID leer sein.

object (SectionStyle)

Die Stile, die für den Abschnitt festgelegt werden sollen.

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

string (FieldMask format)

Die zu aktualisierenden Felder.

Es muss mindestens ein Feld angegeben werden. Der Stammknoten sectionStyle ist implizit und muss nicht angegeben werden. Ein einzelnes "*" kann als Kurzschreibweise für die Auflistung aller Felder verwendet werden.

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

{
  "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.
}

enum (SectionType)

Der einzufügende Abschnittstyp.

object (Location)

Fügt an einer bestimmten Stelle im Dokument einen neuen Absatz und einen Abschnittswechsel ein.

Der Abschnittswechsel muss innerhalb der Grenzen einer vorhandenen Paragraph eingefügt werden. Sie können sie beispielsweise nicht am Startindex einer Tabelle einfügen, also zwischen der Tabelle und dem vorhergehenden Absatz.

Abschnittswechsel können nicht in Tabellen, Gleichungen, Fußnoten, Kopf- oder Fußzeilen eingefügt werden. Da Abschnittsübergänge nur im Textkörper eingefügt werden können, muss das Feld segment ID leer sein.

object (EndOfSegmentLocation)

Fügt am Ende des Textkörpers einen Zeilenumbruch und einen Abschnittswechsel ein.

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

{
  "headerId": string,
  "tabId": string
}

string

Die ID der Überschrift, die gelöscht werden soll. Wenn dieser Abschnitt auf DocumentStyle definiert ist, wird der Verweis auf diesen Abschnitt entfernt. Für den ersten Abschnitt des Dokuments gibt es dann keine Überschrift dieses Typs. Wenn dieser Header auf einer SectionStyle definiert ist, wird der Verweis auf diesen Header entfernt und der Header dieses Typs wird jetzt im vorherigen Abschnitt fortgesetzt.

string

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

In einem Dokument mit einem einzelnen Tab:

• Muss, falls angegeben, mit der ID des einzelnen Tabs übereinstimmen.

• Wird diese Option nicht angegeben, bezieht sich die Anfrage auf den einzelnen Tab.

In einem Dokument mit mehreren Tabs:

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

• Wird dieser Parameter weggelassen, bezieht sich die Anfrage auf den ersten Tab im Dokument.

{
  "footerId": string,
  "tabId": string
}

string

Die ID der zu löschenden Fußzeile. Wenn diese Fußzeile unter DocumentStyle definiert ist, wird der Verweis auf diese Fußzeile entfernt. Für den ersten Abschnitt des Dokuments wird dann keine Fußzeile dieses Typs verwendet. Wenn diese Fußzeile auf einer SectionStyle definiert ist, wird der Verweis auf diese Fußzeile entfernt und die Fußzeile dieses Typs wird jetzt im vorherigen Abschnitt fortgesetzt.

string

Der Tab mit der zu löschenden Fußzeile. Wird kein Wert angegeben, wird die Anfrage auf den ersten Tab angewendet.

In einem Dokument mit einem einzelnen Tab:

• Muss, falls angegeben, mit der ID des einzelnen Tabs übereinstimmen.

• Wird diese Option nicht angegeben, bezieht sich die Anfrage auf den einzelnen Tab.

In einem Dokument mit mehreren Tabs:

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

• Wird dieser Parameter weggelassen, bezieht sich die Anfrage auf den ersten Tab im Dokument.

{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}

object (Location)

Die Stelle im Dokument, an der die Tabelle beginnt.

integer

Die Anzahl der anzupinnenden Tabellenzeilen. „0“ bedeutet, dass alle Zeilen nicht angepinnt sind.