Anfrage
Eine einzelne Aktualisierung, die auf ein Dokument angewendet werden soll.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld
request Die spezifische Anfrage, die angewendet werden soll. Es ist genau ein Feld erforderlich.
request
kann nur einer der folgenden Werte sein:
|
|
replaceAllText
|
Ersetzt alle Instanzen des angegebenen Textes. |
insertText
|
Fügt Text an der angegebenen Stelle ein. |
updateTextStyle
|
Aktualisiert den Textstil im angegebenen Bereich. |
createParagraphBullets
|
Erstellt Aufzählungszeichen für Absätze. |
deleteParagraphBullets
|
Löscht Aufzählungszeichen aus Absätzen. |
createNamedRange
|
Erstellt einen benannten Bereich. |
deleteNamedRange
|
Löscht einen benannten Bereich. |
updateParagraphStyle
|
Aktualisiert den Absatzstil im angegebenen Bereich. |
deleteContentRange
|
Löscht Inhalte aus dem Dokument. |
insertInlineImage
|
Fügt an der angegebenen Stelle ein Inline-Bild ein. |
insertTable
|
Fügt an der angegebenen Stelle eine Tabelle ein. |
insertTableRow
|
Fügt eine leere Zeile in eine Tabelle ein. |
insertTableColumn
|
Fügt eine leere Spalte in eine Tabelle ein. |
deleteTableRow
|
Löscht eine Zeile aus einer Tabelle. |
deleteTableColumn
|
Löscht eine Spalte aus einer Tabelle. |
insertPageBreak
|
Fügt an der angegebenen Stelle einen Seitenumbruch ein. |
deletePositionedObject
|
Löscht ein positioniertes Objekt aus dem Dokument. |
updateTableColumnProperties
|
Aktualisiert die Eigenschaften von Spalten in einer Tabelle. |
updateTableCellStyle
|
Hiermit wird der Stil der Tabellenzellen aktualisiert. |
updateTableRowStyle
|
Aktualisiert den Zeilenstil in einer Tabelle. |
replaceImage
|
Ersetzt ein Bild im Dokument. |
updateDocumentStyle
|
Aktualisiert den Stil des Dokuments. |
mergeTableCells
|
Verbindet Zellen in einer Tabelle. |
unmergeTableCells
|
Hebt den Zellenverbund in einer Tabelle auf. |
createHeader
|
Erstellt einen Header. |
createFooter
|
Erstellt eine Fußzeile. |
createFootnote
|
Erstellt eine Fußnote. |
replaceNamedRangeContent
|
Ersetzt den Inhalt eines benannten Bereichs. |
updateSectionStyle
|
Aktualisiert den Abschnittsstil des angegebenen Bereichs. |
insertSectionBreak
|
Fügt an der angegebenen Stelle einen Abschnittsumbruch ein. |
deleteHeader
|
Löscht eine Kopfzeile aus dem Dokument. |
deleteFooter
|
Löscht eine Fußzeile aus dem Dokument. |
pinTableHeaderRows
|
Aktualisiert die Anzahl der angepinnten Überschriftenzeilen in einer Tabelle. |
ReplaceAllTextRequest
Ersetzt alle Textinstanzen, die einem bestimmten Kriterium entsprechen, durch replace text
.
JSON-Darstellung |
---|
{ "replaceText": string, "tabsCriteria": { object ( |
Felder | |
---|---|
replaceText
|
Der Text, der den übereinstimmenden Text ersetzt. |
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:
In einem Dokument mit mehreren Tabs:
|
Union-Feld
criteria Die Kriterien, anhand derer der zu ersetzende Text abgeglichen wird.
criteria
kann nur einer der folgenden Werte sein:
|
|
containsText
|
Sucht im Dokument nach Text, der mit diesem Teilstring übereinstimmt. |
SubstringMatchCriteria
Ein Kriterium, das mit einer bestimmten Textzeichenfolge im Dokument übereinstimmt.
JSON-Darstellung |
---|
{ "text": string, "matchCase": boolean } |
Felder | |
---|---|
text
|
Der Text, nach dem im Dokument gesucht werden soll. |
matchCase
|
Gibt an, ob bei der Suche die Groß- und Kleinschreibung berücksichtigt werden soll:
|
TabsCriteria
Ein Kriterium, das angibt, auf welchen Tabs eine Anfrage ausgeführt wird.
JSON-Darstellung |
---|
{ "tabIds": [ string ] } |
Felder | |
---|---|
tabIds[]
|
Die Liste der Tab-IDs, in denen die Anfrage ausgeführt wird. |
InsertTextRequest
Fügt Text an der angegebenen Position ein.
JSON-Darstellung |
---|
{ "text": string, // Union field |
Felder | |
---|---|
text
|
Der Text, der eingefügt werden soll.
Durch das Einfügen eines Zeilenumbruchzeichens wird implizit ein neues
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 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 werden soll.
insertion_location darf nur einen der folgenden Werte haben:
|
|
location
|
Fügt den Text bei einem bestimmten Index im Dokument ein.
Der Text muss innerhalb der Grenzen einer vorhandenen |
endOfSegmentLocation
|
Der Text wird am Ende einer Kopf- oder Fußzeile, einer Fußnote oder im Textkörper eingefügt. |
Standort
Eine bestimmte Stelle im Dokument.
JSON-Darstellung |
---|
{ "segmentId": string, "index": integer, "tabId": string } |
Felder | |
---|---|
segmentId
|
Die ID der Kopf-, Fußzeile oder Fußnote, in der sich der Standort befindet. Eine leere Segment-ID steht für den Textkörper des Dokuments. |
index
|
Der nullbasierte Index in UTF-16-Codeeinheiten.
Der Index bezieht sich auf den Anfang des durch
|
tabId
|
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:
In einem Dokument mit mehreren Tabs:
|
EndOfSegmentLocation
Position am Ende eines Textkörpers, einer Kopf- oder Fußzeile oder einer Fußnote. Die Position befindet sich unmittelbar vor der letzten Zeilenvorschubzeile im Dokumentsegment.
JSON-Darstellung |
---|
{ "segmentId": string, "tabId": string } |
Felder | |
---|---|
segmentId
|
Die ID der Kopf-, Fußzeile oder Fußnote, in der sich der Standort befindet. Eine leere Segment-ID kennzeichnet den Textkörper des Dokuments. |
tabId
|
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:
In einem Dokument mit mehreren Tabs:
|
UpdateTextStyleRequest
Aktualisieren Sie das Text-Styling.
JSON-Darstellung |
---|
{ "textStyle": { object ( |
Felder | |
---|---|
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 |
fields
|
Die zu aktualisierenden Felder.
Es muss mindestens ein Feld angegeben werden. Der Stammknoten
Wenn Sie beispielsweise den Textstil fett formatieren möchten, setzen Sie 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. |
Union-Feld
insertion_location . Der Bereichstyp, in dem der Textstil aktualisiert wird.
insertion_location
kann nur einer der folgenden Werte sein:
|
|
range
|
Der Textbereich, der formatiert werden soll. Der Bereich kann auf benachbarte Zeilenumbrüche erweitert werden. Wenn der Bereich einen Absatz vollständig 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. |
CreateParagraphBulletsRequest
Erstellt Aufzählungspunkte für alle Absätze, die sich mit dem angegebenen Bereich überschneiden.
Die Verschachtelungsebene jedes Absatzes wird durch das Zählen der Tabulatorzeichen vor jedem Absatz bestimmt. Um unnötigen Abstand zwischen dem Aufzählungszeichen und dem entsprechenden Absatz zu vermeiden, werden diese führenden Tabulatoren im Rahmen dieser Anfrage entfernt. Dadurch können sich die Indizes von Textteilen ändern.
Wenn sich der Absatz unmittelbar vor dem zu aktualisierenden Absatz in einer Liste mit einer übereinstimmenden Voreinstellung befindet, werden die zu aktualisierenden Absätze der vorherigen Liste hinzugefügt.
JSON-Darstellung |
---|
{ "range": { object ( |
Felder | |
---|---|
range
|
Der Bereich, auf den die Voreinstellung für Aufzählungszeichen angewendet werden soll. |
bulletPreset
|
Die Art der zu verwendenden Aufzählungszeichen. |
BulletGlyphPreset
Vordefinierte Muster von Aufzählungszeichen für Listen.
In diesen Mustern werden folgende Arten von Aufzählungspunkten verwendet:
-
ARROW
: Ein Pfeil, der einem Unicode-U+2794-Codepunkt entspricht -
ARROW3D
: Ein Pfeil mit 3D-Schattierung, der einem Unicode-U+27a2-Codepunkt entspricht -
CHECKBOX
: Ein leeres Quadrat, das einem Unicode-Codepunkt U+274f entspricht -
CIRCLE
: Ein hohler Kreis, der dem Unicode-Codepunkt U+25cb entspricht -
DIAMOND
: Eine durchgezogene Raute, die dem Unicode-Codepunkt U+25c6 entspricht -
DIAMONDX
: Eine Raute mit einem "x", die einem Unicode U+2756-Codepunkt entspricht -
HOLLOWDIAMOND
: Eine gefüllte Raute, die dem Unicode-Codepunkt U+25c7 entspricht -
DISC
: Ein solider Kreis, der dem Unicode-Codepunkt U+25cf entspricht -
SQUARE
: Ein ausgefülltes Quadrat, das einem Codepunkt in Unicode U+25a0 entspricht -
STAR
: Ein Stern, der dem Unicode-Codepunkt U+2605 entspricht -
ALPHA
: Ein Kleinbuchstabe wie „a“, „b“ oder „c“. -
UPPERALPHA
: Ein Großbuchstaben wie "A", "B" oder "C". -
DECIMAL
: Eine Zahl wie "1", "2" oder "3". -
ZERODECIMAL
: Eine Zahl, bei der einstellige Zahlen mit einer Null vorangestellt werden, z. B. „01“, „02“ oder „03“. Bei Zahlen mit mehr als einer Ziffer wird keine Null vorangestellt. -
ROMAN
: Ein Kleinbuchstabe einer römischen Ziffer, z. B. „i“, „ii“ oder „iii“. -
UPPERROMAN
: Eine große römische Zahl wie "I", "II" oder "III". -
LEFTTRIANGLE
: Ein nach links zeigendes Dreieck, das einem Unicode-U+25c4-Codepunkt entspricht
Enums | |
---|---|
BULLET_GLYPH_PRESET_UNSPECIFIED
|
Die Voreinstellung für das Symbol für Aufzählungszeichen ist nicht angegeben. |
BULLET_DISC_CIRCLE_SQUARE
|
Eine Aufzählungsliste mit den Aufzählungszeichen DISC , CIRCLE und SQUARE für die ersten drei Verschachtelungsebenen der Liste.
|
BULLET_DIAMONDX_ARROW3D_SQUARE
|
Eine Aufzählungsliste mit einem
DIAMONDX ,
ARROW3D
und
SQUARE
Aufzählungszeichen für die ersten drei Verschachtelungsebenen der Liste.
|
BULLET_CHECKBOX
|
Eine Aufzählungsliste mit
CHECKBOX
Aufzählungszeichen Glyphen für alle Verschachtelungsebenen einer Liste.
|
BULLET_ARROW_DIAMOND_DISC
|
Eine Aufzählungsliste mit einem
ARROW ,
DIAMOND
und
DISC
Aufzählungszeichen für die ersten drei Verschachtelungsebenen der Liste.
|
BULLET_STAR_CIRCLE_SQUARE
|
Eine Aufzählungsliste mit einem
STAR ,
CIRCLE
und
SQUARE
Aufzählungszeichen für die ersten drei Verschachtelungsebenen der Liste.
|
BULLET_ARROW3D_CIRCLE_SQUARE
|
Eine Aufzählungsliste mit den Aufzählungszeichen ARROW3D , CIRCLE und SQUARE für die ersten drei Verschachtelungsebenen der Liste.
|
BULLET_LEFTTRIANGLE_DIAMOND_DISC
|
Eine Liste mit Aufzählungszeichen mit den Aufzählungszeichen LEFTTRIANGLE , DIAMOND und DISC für die ersten drei Verschachtelungsebenen der Liste.
|
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE
|
Eine Aufzählungsliste mit einem
DIAMONDX ,
HOLLOWDIAMOND
und
SQUARE
Aufzählungszeichen für die ersten drei Verschachtelungsebenen der Liste.
|
BULLET_DIAMOND_CIRCLE_SQUARE
|
Eine Aufzählungsliste mit den Aufzählungszeichen DIAMOND , CIRCLE und SQUARE für die ersten drei Verschachtelungsebenen der Liste.
|
NUMBERED_DECIMAL_ALPHA_ROMAN
|
Eine nummerierte Liste mit den numerischen Zeichen DECIMAL , ALPHA und ROMAN für die ersten drei Listenverschachtelungsebenen, gefolgt von Punkten.
|
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS
|
Eine nummerierte Liste mit
DECIMAL ,
ALPHA
und
ROMAN
numerische Glyphen für die ersten drei Listenverschachtelungsebenen, gefolgt von Klammern.
|
NUMBERED_DECIMAL_NESTED
|
Eine nummerierte Liste mit
DECIMAL
numerische Glyphen, die durch Punkte getrennt sind, wobei für jede Verschachtelungsebene das Glyphe der vorherigen Verschachtelungsebene als Präfix verwendet wird. Beispiel: „1.“ '1.1.', '2.', „2.2.“.
|
NUMBERED_UPPERALPHA_ALPHA_ROMAN
|
Eine nummerierte Liste mit
UPPERALPHA ,
ALPHA
und
ROMAN
numerische Glyphen für die ersten drei Listenverschachtelungsebenen, gefolgt von Punkten.
|
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL
|
Eine nummerierte Liste mit den numerischen Zeichen UPPERROMAN , UPPERALPHA und DECIMAL für die ersten drei Listenverschachtelungsebenen, gefolgt von Punkten.
|
NUMBERED_ZERODECIMAL_ALPHA_ROMAN
|
Eine nummerierte Liste mit den numerischen Zeichen ZERODECIMAL , ALPHA und ROMAN für die ersten drei Listenverschachtelungsebenen, gefolgt von Punkten.
|
DeleteParagraphBulletsRequests
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 (
|
Felder | |
---|---|
range
|
Bereich, aus dem Aufzählungszeichen gelöscht werden sollen |
CreateNamedRangeRequest
Erstellt ein
NamedRange
, der auf den angegebenen Bereich verweist.
JSON-Darstellung |
---|
{
"name": string,
"range": {
object (
|
Felder | |
---|---|
name
|
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. |
range
|
Der Bereich, auf den der Name angewendet werden soll. |
DeleteNamedRangeRequest
Löscht einen NamedRange
.
JSON-Darstellung |
---|
{ "tabsCriteria": { object ( |
Felder | |
---|---|
tabsCriteria
|
Optional. Die Kriterien, mit denen angegeben wird, auf welchem oder welchen Tabs der Bereich gelöscht werden soll. Wird der Bereich weggelassen, wird er auf alle Tabs angewendet. In einem Dokument mit einem einzelnen Tab:
In einem Dokument mit mehreren Tabs:
|
Union-Feld
named_range_reference Der Wert, der bestimmt, welcher Bereich oder welche Bereiche gelöscht werden sollen. Es muss genau ein Wert festgelegt werden.
named_range_reference darf nur einen der folgenden Werte haben:
|
|
namedRangeId
|
Die ID des benannten Bereichs, der gelöscht werden soll. |
name
|
Der Name der zu löschenden Bereiche. Alle benannten Bereiche mit diesem Namen werden gelöscht. |
UpdateParagraphStyleRequest
Das Format aller Absätze wird aktualisiert, die sich mit dem angegebenen Bereich überschneiden.
JSON-Darstellung |
---|
{ "paragraphStyle": { object ( |
Felder | |
---|---|
paragraphStyle
|
Die Stile, die für die Absätze festgelegt werden sollen.
Bestimmte Änderungen am Absatzstil können andere Änderungen zur Folge haben, die dem Verhalten des Docs-Editors entsprechen. Weitere Informationen finden Sie in der Dokumentation zu
|
fields
|
Die zu aktualisierenden Felder.
Es muss mindestens ein Feld angegeben werden. Der Stamm
Wenn Sie beispielsweise die Ausrichtungseigenschaft des Absatzstils aktualisieren möchten, setzen Sie Wenn Sie eine Eigenschaft auf den Standardwert zurücksetzen möchten, fügen Sie ihren Feldnamen in die Feldmaske ein, lassen das Feld aber nicht. |
Union-Feld
insertion_location . Der Bereichstyp, in dem der Absatzstil aktualisiert wird.
insertion_location darf nur einen der folgenden Werte haben:
|
|
range
|
Der Bereich, der die zu formatierenden Absätze überschneidet. |
DeleteContentRangeRequest
Löscht Inhalte aus dem Dokument.
JSON-Darstellung |
---|
{
"range": {
object (
|
Felder | |
---|---|
range
|
Der Bereich der zu löschenden Inhalte. Das Löschen von Text, der eine Absatzgrenze überschreitet, kann beim Zusammenführen der beiden Absätze zu Änderungen an Absatzformaten, Listen, positionierten Objekten und Lesezeichen führen. 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:
|
InsertInlineImageRequest
Fügt ein
InlineObject
mit einem Bild an einem bestimmten Ort.
JSON-Darstellung |
---|
{ "uri": string, "objectSize": { object ( |
Felder | |
---|---|
uri
|
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 nicht mehr als 25 Megapixel haben. Sie müssen im PNG-, JPEG- oder GIF-Format vorliegen.
Der angegebene URI muss öffentlich zugänglich sein und darf höchstens 2 KB lang sein. Der URI selbst wird mit dem Bild gespeichert und über den
|
objectSize
|
Die Größe, in der das Bild im Dokument angezeigt werden soll. Diese Eigenschaft ist optional und die endgültige Größe des Bildes im Dokument wird durch die folgenden Regeln bestimmt: * Wenn weder Breite noch Höhe angegeben ist, wird eine Standardgröße des Bildes auf der Grundlage seiner Auflösung berechnet. * Wenn eine Dimension angegeben ist, wird die andere Dimension 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 den angegebenen Abmessungen entspricht. Das Seitenverhältnis wird dabei beibehalten. |
Union-Feld
insertion_location Die Stelle, an der das Bild eingefügt werden soll.
insertion_location
kann nur einer der folgenden Werte sein:
|
|
location
|
Das Bild wird an einer bestimmten Stelle im Dokument eingefügt.
Das Bild muss innerhalb der Grenzen einer vorhandenen Inline-Bilder können nicht innerhalb einer Fußnote oder Gleichung eingefügt werden. |
endOfSegmentLocation
|
Der Text wird am Ende einer Kopf- oder Fußzeile oder im Textkörper eingefügt. Inline-Bilder können nicht innerhalb einer Fußnote eingefügt werden. |
InsertTableRequest
Fügt eine Tabelle an der angegebenen Position ein.
Ein Zeilenumbruchzeichen wird vor der eingefügten Tabelle eingefügt.
JSON-Darstellung |
---|
{ "rows": integer, "columns": integer, // Union field |
Felder | |
---|---|
rows
|
Die Anzahl der Zeilen in der Tabelle |
columns
|
Die Anzahl der Spalten in der Tabelle. |
Union-Feld
insertion_location Die Stelle, an der die Tabelle eingefügt werden soll.
insertion_location
kann nur einer der folgenden Werte sein:
|
|
location
|
Die Tabelle wird an einem bestimmten Modellindex eingefügt. Ein Zeilenumbruchzeichen wird vor der eingefügten Tabelle eingefügt. Daher befindet sich der Startindex der Tabelle am angegebenen Positionsindex + 1.
Die Tabelle muss innerhalb der Grenzen einer vorhandenen Tabellen können nicht in Fußnoten oder Gleichungen eingefügt werden. |
endOfSegmentLocation
|
Die Tabelle wird am Ende der angegebenen Kopf- oder Fußzeile oder im Dokumentkörper eingefügt. Ein Zeilenumbruchzeichen wird vor der eingefügten Tabelle 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 (
|
Felder | |
---|---|
tableCellLocation
|
Die Position der Zellen der Referenztabelle, von der aus Zeilen eingefügt werden. Über (oder unter) der Zeile, in der sich die Referenzzelle befindet, wird eine neue Zeile eingefügt. Wenn es sich bei der Referenzzelle um eine verbundene Zelle handelt, wird oberhalb (oder unterhalb) der verbundenen Zelle eine neue Zeile eingefügt. |
insertBelow
|
Gibt an, ob eine neue Zeile unterhalb der Position der Referenzzelle eingefügt werden soll.
|
TableCellLocation
Position einer einzelnen Zelle in einer Tabelle.
JSON-Darstellung |
---|
{
"tableStartLocation": {
object (
|
Felder | |
---|---|
tableStartLocation
|
Die Stelle im Dokument, an der die Tabelle beginnt. |
rowIndex
|
Der nullbasierte Zeilenindex. Die zweite Zeile in der Tabelle hat beispielsweise den Zeilenindex 1. |
columnIndex
|
Der nullbasierte Spaltenindex. Die zweite Spalte der Tabelle hat beispielsweise einen Spaltenindex von 1. |
InsertTableColumnRequest
Fügt eine leere Spalte in eine Tabelle ein.
JSON-Darstellung |
---|
{
"tableCellLocation": {
object (
|
Felder | |
---|---|
tableCellLocation
|
Die Position der Referenztabellenzelle, von der aus Spalten eingefügt werden. Links (oder rechts) der Spalte, in der sich die Referenzzelle befindet, wird eine neue Spalte eingefügt. Wenn die Referenzzelle eine zusammengeführte Zelle ist, wird links (oder rechts) von der verbundenen Zelle eine neue Spalte eingefügt. |
insertRight
|
Gibt an, ob eine neue Spalte rechts neben der Referenzzelle eingefügt werden soll.
|
DeleteTableRowRequest
Löscht eine Zeile aus einer Tabelle.
JSON-Darstellung |
---|
{
"tableCellLocation": {
object (
|
Felder | |
---|---|
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, die die Zelle umfasst. 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 (
|
Felder | |
---|---|
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 sich über mehrere Spalten erstreckt, werden alle Spalten gelöscht, die die Zelle überspannt. 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 Position einen Seitenumbruch gefolgt von einem Zeilenumbruch ein.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld
insertion_location . Die Stelle, an der der Seitenumbruch eingefügt wird.
insertion_location darf nur einen der folgenden Werte haben:
|
|
location
|
Fügt den Seitenumbruch an einer bestimmten Stelle im Dokument ein.
Der Seitenumbruch muss innerhalb der Grenzen eines vorhandenen
Seitenumbrüche können nicht innerhalb einer Tabelle, einer Gleichung, einer Fußnote, einer Kopf- oder Fußzeile eingefügt werden. Da Seitenumbrüche nur innerhalb des Textkörpers eingefügt werden können,
|
endOfSegmentLocation
|
Fügt einen Seitenumbruch am Ende des Textkörpers ein.
Seitenumbrüche können nicht in einer Fußnote, Kopf- oder Fußzeile eingefügt werden. Da Seitenumbrüche nur innerhalb des Textkörpers eingefügt werden können,
|
DeletePositionedObjectRequest
Löscht ein
PositionedObject
aus dem Dokument.
JSON-Darstellung |
---|
{ "objectId": string, "tabId": string } |
Felder | |
---|---|
objectId
|
Die ID des zu löschenden Objekts. |
tabId
|
Der Tab, auf dem sich das zu löschende Objekt befindet. Ohne Angabe wird die Anfrage auf den ersten Tab angewendet. In einem Dokument mit einem einzelnen Tab:
In einem Dokument mit mehreren Tabs:
|
UpdateTableColumnPropertiesRequest
Aktualisiert die
TableColumnProperties
Spalten in einer Tabelle.
JSON-Darstellung |
---|
{ "tableStartLocation": { object ( |
Felder | |
---|---|
tableStartLocation
|
Die Stelle im Dokument, an der die Tabelle beginnt. |
columnIndices[]
|
Liste der nullbasierten Spaltenindizes, deren Eigenschaft aktualisiert werden soll. Wenn keine Indexe angegeben sind, werden alle Spalten aktualisiert. |
tableColumnProperties
|
Die Eigenschaften der Tabellenspalte, die aktualisiert werden sollen.
Wenn der Wert von
|
fields
|
Die Felder, die aktualisiert werden sollen.
Es muss mindestens ein Feld angegeben werden. Der Stammknoten
Um beispielsweise die Spaltenbreite zu aktualisieren,
|
UpdateTableCellStyleRequest
Aktualisiert den Stil eines Tabellenzellbereichs.
JSON-Darstellung |
---|
{ "tableCellStyle": { object ( |
Felder | |
---|---|
tableCellStyle
|
Der Stil, der für die Tabellenzellen festgelegt werden soll. Wenn Sie Rahmen aktualisieren und eine Zelle einen Rahmen mit einer angrenzenden Zelle teilen, wird auch die entsprechende Rahmeneigenschaft der angrenzenden Zelle aktualisiert. Zusammengeführte und unsichtbare Grenzen werden nicht aktualisiert. Da die Aktualisierung eines Rahmens, der von benachbarten Zellen in derselben Anfrage gemeinsam genutzt wird, Konflikte bei der Aktualisierung des Rahmens verursachen kann, werden die Rahmenaktualisierungen in der folgenden Reihenfolge angewendet:
|
fields
|
Die Felder, die aktualisiert werden sollen.
Es muss mindestens ein Feld angegeben werden. Der Stammknoten
Wenn Sie beispielsweise die Hintergrundfarbe der Tabellenzelle aktualisieren möchten, legen Sie Wenn Sie eine Eigenschaft auf den Standardwert zurücksetzen möchten, fügen Sie ihren Feldnamen in die Feldmaske ein, lassen das Feld aber nicht. |
Union-Feld
cells Die Zellen, die aktualisiert werden sollen.
cells darf nur einen der folgenden Werte haben:
|
|
tableRange
|
Der Tabellenbereich, der die Teilmenge der Tabelle darstellt, auf die die Aktualisierungen angewendet werden. |
tableStartLocation
|
Die Stelle im Dokument, an der die Tabelle beginnt. Wenn dieses Flag angegeben ist, werden die Aktualisierungen auf alle Zellen in der Tabelle angewendet. |
TableRange
Ein Tabellenbereich stellt einen Verweis auf eine Teilmenge einer Tabelle dar.
Beachten Sie, dass die durch einen Tabellenbereich angegebenen Zellen nicht unbedingt ein Rechteck bilden. Nehmen wir beispielsweise an, wir haben eine 3 x 3-Tabelle, in der alle Zellen der letzten Zeile zusammengeführt sind. Die Tabelle sieht so aus:
[ ][ ][ ]
[ ][ ][ ]
[ ]
Ein Tabellenbereich mit der Tabellenzellposition (tableStartLocation, row = 0, column = 0), einer Zeilenspanne von 3 und einer Spaltenspanne von 2 gibt die folgenden Zellen an:
[ x ][ x ][ ]
[ x ][ x ][ ]
[ x x x ]
JSON-Darstellung |
---|
{
"tableCellLocation": {
object (
|
Felder | |
---|---|
tableCellLocation
|
Die Zelle, in der der Tabellenbereich beginnt. |
rowSpan
|
Der Zeilenumfang des Tabellenbereichs. |
columnSpan
|
Die Spaltenspanne des Tabellenbereichs. |
UpdateTableRowStyleRequest
Aktualisiert die TableRowStyle
von Zeilen in einer Tabelle.
JSON-Darstellung |
---|
{ "tableStartLocation": { object ( |
Felder | |
---|---|
tableStartLocation
|
Die Stelle im Dokument, an der die Tabelle beginnt. |
rowIndices[]
|
Liste der nullbasierten Zeilenindizes, deren Stil aktualisiert werden soll. Wenn keine Indizes angegeben sind, werden alle Zeilen aktualisiert. |
tableRowStyle
|
Die Stile, die für die Zeilen festgelegt werden sollen. |
fields
|
Die Felder, die aktualisiert werden sollen.
Es muss mindestens ein Feld angegeben werden. Der Stamm
Wenn Sie beispielsweise die Mindestzeilenhöhe aktualisieren möchten, setzen Sie |
ReplaceImageRequest
Ersetzt ein vorhandenes Bild durch ein neues.
Wenn Sie ein Bild ersetzen, werden einige image effects
aus dem vorhandenen Bild entfernt, um das Verhalten des Docs-Editors widerzuspiegeln.
JSON-Darstellung |
---|
{
"imageObjectId": string,
"uri": string,
"imageReplaceMethod": enum (
|
Felder | |
---|---|
imageObjectId
|
Die ID des vorhandenen Bildes, das ersetzt werden soll. Die ID kann aus der Antwort einer GET-Anfrage abgerufen werden. |
uri
|
Der URI des neuen Images. Das Bild wird einmal beim Einfügen abgerufen und eine Kopie 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 nicht länger als 2 KB sein. Der URI wird mit dem Bild gespeichert und über die
|
imageReplaceMethod
|
Die Ersetzungsmethode. |
tabId
|
Der Tab, auf dem sich das Bild befindet, das ersetzt werden soll. Ohne Angabe wird die Anfrage auf den ersten Tab angewendet. In einem Dokument mit einem einzelnen Tab:
In einem Dokument mit mehreren Tabs:
|
ImageReplaceMethod
Die Bildersetzungsmethode.
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 den Begrenzungsbereich des Originalbilds zu füllen. Das Bild wird möglicherweise zugeschnitten, damit es die Grenzen des Originalbilds ausfüllt. Das Bild wird genauso groß wie das Originalbild gerendert. |
UpdateDocumentStyleRequest
Aktualisiert den DocumentStyle
.
JSON-Darstellung |
---|
{
"documentStyle": {
object (
|
Felder | |
---|---|
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 |
fields
|
Die zu aktualisierenden Felder.
Es muss mindestens ein Feld angegeben werden. Der Stammknoten
Um beispielsweise den Hintergrund zu aktualisieren,
|
tabId
|
Der Tab mit dem zu aktualisierenden Stil. Wenn keine Angabe gemacht wird, gilt die Anfrage für den ersten Tab. In einem Dokument mit einem einzelnen Tab:
In einem Dokument mit mehreren Tabs:
|
MergeTableCellsRequest
Verbindet Zellen in einem
Table
JSON-Darstellung |
---|
{
"tableRange": {
object (
|
Felder | |
---|---|
tableRange
|
Der Tabellenbereich, der angibt, welche Zellen der Tabelle verbunden werden sollen. Der Text in den zusammengeführten Zellen wird zusammengefügt und in der Kopfzelle des Bereichs gespeichert. Ist die Inhaltsrichtung von links nach rechts, ist dies die linke obere Zelle des Bereichs. Ist dies der Fall, ist dies die obere rechte Zelle des Bereichs. Wenn der Bereich nicht rechteckig ist (was in einigen Fällen vorkommen kann, in denen der Bereich Zellen umfasst, die bereits verbunden sind oder die Tabelle nicht rechteckig ist), wird der Fehler 400 für die fehlerhafte Anforderung zurückgegeben. |
UnmergeTableCellsRequest
Hebt den Zellenverbund in einem auf
Table
JSON-Darstellung |
---|
{
"tableRange": {
object (
|
Felder | |
---|---|
tableRange
|
Der Tabellenbereich, der angibt, welche Zellen der Tabelle getrennt werden sollen. Der Zellenverbund für alle Zellen in diesem Bereich wird aufgehoben. Bereits zusammengeführte Zellen sind davon nicht betroffen. Wenn der Bereich keine zusammengeführten Zellen enthält, geschieht durch die Anfrage nichts. Wenn sich in einer der verbundenen Zellen Text befindet, bleibt der Text im Kopfbereich. Zelle des resultierenden Blocks von nicht verbundenen Zellen. Die Kopfzelle ist die linke obere Zelle, wenn die Inhaltsrichtung von links nach rechts ist, andernfalls die rechte obere Zelle. |
CreateHeaderRequest
Erstellt einen Header
. Der neue Header wird auf die SectionStyle
am Speicherort der SectionBreak
angewendet, sofern angegeben. Andernfalls wird er auf die DocumentStyle
angewendet.
Wenn ein Header des angegebenen Typs bereits vorhanden ist, wird der Fehler 400 (ungültige Anfrage) zurückgegeben.
JSON-Darstellung |
---|
{ "type": enum ( |
Felder | |
---|---|
type
|
Der zu erstellende Headertyp. |
sectionBreakLocation
|
Der Standort des
|
CreateFootnoteRequest
Erstellt ein
Footnote
Segment und fügt ein neues
FootnoteReference
an einem bestimmten Ort hinzufügen.
Das neue
Footnote
enthält ein Leerzeichen, gefolgt von einem Zeilenumbruchzeichen.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld
footnote_reference_location . Die Stelle, an der der Fußnotenverweis eingefügt wird.
footnote_reference_location darf nur einen der folgenden Werte haben:
|
|
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
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 |
endOfSegmentLocation
|
Fügt den Fußnotenverweis am Ende des Dokumenttexts ein.
Fußnotenverweise können nicht in eine Kopf-, Fuß- oder Fußnote eingefügt werden. Da Fußnotenverweise nur in den Textkörper eingefügt werden können,
|
ReplaceNamedRangeContentRequest
Ersetzt den Inhalt der angegebenen NamedRange
oder NamedRanges
durch den angegebenen Ersatzinhalt.
Beachten Sie, dass eine Person
NamedRange
kann aus mehreren uneinheitlichen
ranges
. In diesem Fall wird nur der Inhalt im ersten Bereich ersetzt. Die anderen Bereiche und ihr Inhalt werden gelöscht.
In Fällen, in denen 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 ( |
Felder | |
---|---|
tabsCriteria
|
Optional. Die Kriterien, mit denen festgelegt wird, auf welchen Tabs die Ersetzung erfolgt. Wenn keine Angabe gemacht wird, wird die Ersetzung auf alle Tabs angewendet. In einem Dokument mit einem einzelnen Tab:
In einem Dokument mit mehreren Tabs:
|
Union-Feld
replacement_content . Der Inhalt, durch den der vorhandene Inhalt des benannten Bereichs ersetzt werden soll.
replacement_content
kann nur einer der folgenden Werte sein:
|
|
text
|
Ersetzt den Inhalt der angegebenen benannten Bereiche durch den angegebenen Text. |
Union-Feld
named_range_reference Ein Verweis auf die benannten Bereiche, deren Inhalt ersetzt werden soll.
named_range_reference darf nur einen der folgenden Werte haben:
|
|
namedRangeId
|
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ültig. |
namedRangeName
|
Der Name der
Wenn es mehrere |
UpdateSectionStyleRequest
Aktualisiert die
SectionStyle
JSON-Darstellung |
---|
{ "range": { object ( |
Felder | |
---|---|
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 |
sectionStyle
|
Die Stile, die für den Abschnitt festgelegt werden sollen.
Bestimmte Änderungen am Abschnittsstil können andere Änderungen zur Folge haben, die dem Verhalten des Docs-Editors entsprechen. Weitere Informationen finden Sie in der Dokumentation zu
|
fields
|
Die Felder, die aktualisiert werden sollen.
Es muss mindestens ein Feld angegeben werden. Der Stammknoten
Wenn Sie beispielsweise den linken Rand aktualisieren möchten, setzen Sie |
InsertSectionBreakRequest
Fügt an der angegebenen Position einen Abschnittswechsel ein.
Vor dem Abschnittswechsel wird ein Zeilenumbruchzeichen eingefügt.
JSON-Darstellung |
---|
{ "sectionType": enum ( |
Felder | |
---|---|
sectionType
|
Der Typ des einzufügenden Abschnitts. |
Union-Feld
insertion_location . Die Stelle, an der die Unterbrechung eingefügt wird.
insertion_location darf nur einen der folgenden Werte haben:
|
|
location
|
Fügt bei einem bestimmten Index im Dokument einen Zeilenumbruch und einen Abschnittswechsel ein.
Der Abschnittswechsel muss innerhalb der Grenzen einer vorhandenen
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 |
endOfSegmentLocation
|
Fügt am Ende des Dokumenttexts einen Zeilenumbruch und einen Abschnittswechsel ein.
Abschnittswechsel können nicht innerhalb einer Fußnote, Kopf- oder Fußzeile eingefügt werden. Da Abschnittswechsel nur innerhalb des Textkörpers eingefügt werden können,
|
DeleteHeaderRequest
Löscht ein
Header
aus dem Dokument.
JSON-Darstellung |
---|
{ "headerId": string, "tabId": string } |
Felder | |
---|---|
headerId
|
Die ID des zu löschenden Headers. Wenn dieser Abschnitt auf |
tabId
|
Der Tab mit der zu löschenden Kopfzeile. Ohne Angabe wird die Anfrage auf den ersten Tab angewendet. In einem Dokument mit einem einzelnen Tab:
In einem Dokument mit mehreren Tabs:
|
PinTableHeaderRowsRequest
Aktualisiert die Anzahl der angepinnten Kopfzeilen von Tabellen in einer Tabelle.
JSON-Darstellung |
---|
{
"tableStartLocation": {
object (
|
Felder | |
---|---|
tableStartLocation
|
Die Stelle im Dokument, an der die Tabelle beginnt. |
pinnedHeaderRowsCount
|
Die Anzahl der anzupinnenden Tabellenzeilen. „0“ bedeutet, dass alle Zeilen nicht angepinnt sind. |