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 darf nur einen der folgenden Werte haben:
|
|
replace
|
Ersetzt alle Instanzen des angegebenen Texts. |
insert
|
Fügt Text an der angegebenen Stelle ein. |
update
|
Aktualisiert den Textstil im angegebenen Bereich. |
create
|
Erstellt Aufzählungspunkte für Absätze. |
delete
|
Löscht Aufzählungspunkte aus Absätzen. |
create
|
Erstellt einen benannten Bereich. |
delete
|
Löscht einen benannten Bereich. |
update
|
Aktualisiert den Absatzstil im angegebenen Bereich. |
delete
|
Löscht Inhalte aus dem Dokument. |
insert
|
Fügt an der angegebenen Stelle ein Inline-Bild ein. |
insert
|
Fügt an der angegebenen Stelle eine Tabelle ein. |
insert
|
Fügt eine leere Zeile in eine Tabelle ein. |
insert
|
Fügt eine leere Spalte in eine Tabelle ein. |
delete
|
Löscht eine Zeile aus einer Tabelle. |
delete
|
Löscht eine Spalte aus einer Tabelle. |
insert
|
Fügt an der angegebenen Stelle einen Seitenumbruch ein. |
delete
|
Löscht ein positioniertes Objekt aus dem Dokument. |
update
|
Aktualisiert die Eigenschaften von Spalten in einer Tabelle. |
update
|
Hiermit wird der Stil der Tabellenzellen aktualisiert. |
update
|
Aktualisiert den Zeilenstil in einer Tabelle. |
replace
|
Ersetzt ein Bild im Dokument. |
update
|
Der Stil des Dokuments wird aktualisiert. |
merge
|
Zellen in einer Tabelle werden zusammengeführt. |
unmerge
|
Zellen in einer Tabelle werden getrennt. |
create
|
Erstellt einen Header. |
create
|
Erstellt einen Fußzeilenbereich. |
create
|
Erstellt eine Fußnote. |
replace
|
Ersetzt den Inhalt in einem benannten Bereich. |
update
|
Aktualisiert den Abschnittsstil des angegebenen Bereichs. |
insert
|
Fügt an der angegebenen Stelle einen Abschnittsumbruch ein. |
delete
|
Löscht eine Überschrift aus dem Dokument. |
delete
|
Löscht einen Fußzeilentext aus dem Dokument. |
pin
|
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 | |
---|---|
replace
|
Der Text, der den übereinstimmenden Text ersetzt. |
tabs
|
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
criteria . Das Kriterium, das zum Abgleich des zu ersetzenden Textes verwendet wird.
criteria darf nur einen der folgenden Werte haben:
|
|
contains
|
Findet im Dokument Text, der mit dieser Teilzeichenfolge übereinstimmt. |
SubstringMatchCriteria
Ein Kriterium, das mit einem bestimmten Textstring im Dokument übereinstimmt.
JSON-Darstellung |
---|
{ "text": string, "matchCase": boolean } |
Felder | |
---|---|
text
|
Der Text, nach dem im Dokument gesucht werden soll. |
match
|
Gibt an, ob bei der Suche die Groß- und Kleinschreibung berücksichtigt werden soll:
|
TabsCriteria
Ein Kriterium, das angibt, in welchen Tabs eine Anfrage ausgeführt wird.
JSON-Darstellung |
---|
{ "tabIds": [ string ] } |
Felder | |
---|---|
tab
|
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 einzufügende Text.
Wenn Sie einen Zeilenumbruch einfügen, wird an dieser Stelle implizit ein neuer 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 unmittelbar vor dem Einfügungsindex. 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 Position, an der der Text eingefügt wird.
insertion_location darf nur einen der folgenden Werte haben:
|
|
location
|
Der Text wird an einer bestimmten Stelle im Dokument eingefügt.
Text muss innerhalb der Grenzen einer vorhandenen |
end
|
Der Text wird am Ende einer Kopfzeile, Fußzeile, Fußnote oder des Dokumenttexts eingefügt. |
Standort
Eine bestimmte Stelle im Dokument.
JSON-Darstellung |
---|
{ "segmentId": string, "index": integer, "tabId": string } |
Felder | |
---|---|
segment
|
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. |
index
|
Der nullbasierte Index in UTF-16-Codeeinheiten.
Der Index ist relativ zum Beginn des durch |
tab
|
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. Der Ort befindet sich direkt vor der letzten Zeile im Dokumentsegment.
JSON-Darstellung |
---|
{ "segmentId": string, "tabId": string } |
Felder | |
---|---|
segment
|
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. |
tab
|
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 | |
---|---|
text
|
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 Textstiländerungen 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 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.
Für insertion_location ist nur einer der folgenden Werte zulässig:
|
|
range
|
Der Textbereich, der formatiert werden soll. Der Bereich kann um 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 innerhalb einer relativen 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 das Zählen der Tabulatorzeichen vor jedem Absatz bestimmt. Um zu vermeiden, dass zu viel Platz zwischen dem Aufzählungspunkt und dem entsprechenden Absatz entsteht, werden diese Tabulatorzeichen durch diese Anfrage entfernt. Dadurch können sich die Indizes von Textteilen ändern.
Wenn sich der Absatz direkt vor den zu aktualisierenden Absätzen in einer Liste mit einer übereinstimmenden Voreinstellung befindet, werden die zu aktualisierenden Absätze dieser Liste hinzugefügt.
JSON-Darstellung |
---|
{ "range": { object ( |
Felder | |
---|---|
range
|
Der Bereich, auf den die Aufzählungsvorlage angewendet werden soll. |
bullet
|
Die Art der zu verwendenden Aufzählungszeichen. |
BulletGlyphPreset
Vordefinierte Muster von Aufzählungszeichen für Listen.
Bei diesen Mustern werden folgende Arten von Aufzählungszeichen verwendet:
-
ARROW
: Ein Pfeil, der dem Unicode-Codepunkt U+2794 entspricht -
ARROW3D
: ein Pfeil mit 3D-Schattierung, der einem Unicode-U+27a2-Codepunkt entspricht -
CHECKBOX
: Ein leeres Quadrat, das dem 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
: Raute mit einem „x“, entspricht dem Unicode-Codepunkt U+2756 -
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 durchgezogenes Quadrat, das dem Unicode-Codepunkt U+25a0 entspricht -
STAR
: ein Stern, der einem Unicode-U+2605-Codepunkt 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 mit einer Null vorangestellt sind, 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 dem Unicode-Codepunkt U+25c4 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 den Aufzählungszeichen DIAMONDX , ARROW3D und SQUARE für die ersten drei Verschachtelungsebenen der Liste.
|
BULLET_CHECKBOX
|
Eine Aufzählungsliste mit CHECKBOX Symbolen für Aufzählungszeichen für alle Verschachtelungsebenen von Listen.
|
BULLET_ARROW_DIAMOND_DISC
|
Eine Aufzählungsliste mit den Aufzählungszeichen ARROW , DIAMOND und DISC für die ersten drei Verschachtelungsebenen der Liste.
|
BULLET_STAR_CIRCLE_SQUARE
|
Eine Aufzählungsliste mit den Aufzählungszeichen STAR , CIRCLE und SQUARE 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 Aufzählungsliste mit den Aufzählungszeichen LEFTTRIANGLE , DIAMOND und DISC für die ersten drei Verschachtelungsebenen der Liste.
|
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE
|
Eine Aufzählungsliste mit den Aufzählungszeichen DIAMONDX , HOLLOWDIAMOND und SQUARE für die ersten drei Verschachtelungsebenen der Liste.
|
BULLET_DIAMOND_CIRCLE_SQUARE
|
Eine Liste mit Aufzählungszeichen 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 den Ziffern DECIMAL , ALPHA und ROMAN für die ersten drei Listenverschachtelungsebenen, gefolgt von Klammern.
|
NUMBERED_DECIMAL_NESTED
|
Eine nummerierte Liste mit DECIMAL -Zahlensymbolen, die durch Punkte getrennt sind. Dabei wird für jede Verschachtelungsebene das Symbol der vorherigen Verschachtelungsebene als Präfix verwendet. Beispiel: „1.“ '1.1.', '2.', 2.2.
|
NUMBERED_UPPERALPHA_ALPHA_ROMAN
|
Eine nummerierte Liste mit numerischen Symbolen für UPPERALPHA , ALPHA und ROMAN für die ersten drei Verschachtelungsebenen der Liste, 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.
|
DeleteParagraphBulletsRequest
Löscht Aufzählungspunkte 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
|
Der Bereich, aus dem Aufzählungspunkte gelöscht werden sollen. |
CreateNamedRangeRequest
Erstellt eine NamedRange
, die 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 ein NamedRange
.
JSON-Darstellung |
---|
{ "tabsCriteria": { object ( |
Felder | |
---|---|
tabs
|
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:
In einem Dokument mit mehreren Tabs:
|
Union-Feld
named_range_reference . Der Wert, der bestimmt, welcher Bereich bzw. welche Bereiche gelöscht werden sollen. Es muss genau eine festgelegt werden.
named_range_reference darf nur einen der folgenden Werte haben:
|
|
named
|
Die ID des benannten Bereichs, der gelöscht werden soll. |
name
|
Der Name der zu löschenden Bereiche. Alle benannten Bereiche mit dem angegebenen Namen werden gelöscht. |
UpdateParagraphStyleRequest
Das Format aller Absätze wird aktualisiert, die sich mit dem angegebenen Bereich überschneiden.
JSON-Darstellung |
---|
{ "paragraphStyle": { object ( |
Felder | |
---|---|
paragraph
|
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 |
fields
|
Die zu aktualisierenden Felder.
Es muss mindestens ein Feld angegeben werden. Der Stammknoten
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 sich mit den Absätzen überschneidet, die formatiert werden sollen. |
DeleteContentRangeRequest
Löscht Inhalte aus dem Dokument.
JSON-Darstellung |
---|
{
"range": {
object ( |
Felder | |
---|---|
range
|
Der Bereich der Inhalte, die gelöscht werden sollen. 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. Der Versuch, bestimmte Bereiche zu löschen, kann zu einer ungültigen Dokumentstruktur führen. In diesem Fall wird der Fehler 400 ungültig. Beispiele für ungültige Löschanfragen:
|
InsertInlineImageRequest
Fügt an der angegebenen Stelle ein InlineObject
mit einem Bild ein.
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 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 |
object
|
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 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 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
|
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. |
end
|
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. |
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 |
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 darf nur einen der folgenden Werte haben:
|
|
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 Tabellen können nicht in eine Fußnote oder Gleichung eingefügt werden. |
end
|
Fügt die Tabelle am Ende der angegebenen Kopf-, Fußzeile oder des Dokumenttexts ein. Vor der eingefügten Tabelle wird ein Zeilenumbruch eingefügt. Tabellen können nicht innerhalb einer Fußnote eingefügt werden. |
InsertTableRowRequest
Fügt eine leere Zeile in eine Tabelle ein.
JSON-Darstellung |
---|
{
"tableCellLocation": {
object ( |
Felder | |
---|---|
table
|
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. |
insert
|
Gibt an, ob eine neue Zeile unter der Referenzzelle eingefügt werden soll.
|
TableCellLocation
Die Position einer einzelnen Zelle in einer Tabelle.
JSON-Darstellung |
---|
{
"tableStartLocation": {
object ( |
Felder | |
---|---|
table
|
Die Stelle im Dokument, an der die Tabelle beginnt. |
row
|
Der nullbasierte Zeilenindex. Die zweite Zeile in der Tabelle hat beispielsweise den Zeilenindex 1. |
column
|
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 ( |
Felder | |
---|---|
table
|
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. |
insert
|
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 | |
---|---|
table
|
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. |
DeleteTableColumnRequest
Löscht eine Spalte aus einer Tabelle.
JSON-Darstellung |
---|
{
"tableCellLocation": {
object ( |
Felder | |
---|---|
table
|
Die Position der Referenztabelle, von der aus die Spalte gelöscht wird. Die Spalte, die sich über diese Zelle erstreckt, 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. |
InsertPageBreakRequest
Fügt an der angegebenen Stelle einen Seitenumbruch gefolgt von einem Zeilenumbruch ein.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld insertion_location . Die Stelle, an der der Seitenumbruch eingefügt werden soll.
insertion_location darf nur einen der folgenden Werte haben:
|
|
location
|
Fügt den Seitenumbruch bei einem bestimmten Index im Dokument ein.
Der Seitenumbruch muss innerhalb der Grenzen einer 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 im Textkörper eingefügt werden können, muss das Feld |
end
|
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 |
DeletePositionedObjectRequest
Löscht ein PositionedObject
aus dem Dokument.
JSON-Darstellung |
---|
{ "objectId": string, "tabId": string } |
Felder | |
---|---|
object
|
Die ID des zu löschenden Objekts. |
tab
|
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:
In einem Dokument mit mehreren Tabs:
|
UpdateTableColumnPropertiesRequest
Aktualisiert die TableColumnProperties
von Spalten in einer Tabelle.
JSON-Darstellung |
---|
{ "tableStartLocation": { object ( |
Felder | |
---|---|
table
|
Die Stelle im Dokument, an der die Tabelle beginnt. |
column
|
Die Liste der nullbasierten Spaltenindexe, deren Attribut aktualisiert werden soll. Wenn keine Indizes angegeben sind, werden alle Spalten aktualisiert. |
table
|
Die zu aktualisierenden Eigenschaften der Tabellenspalte.
Wenn der Wert von |
fields
|
Die Felder, die aktualisiert werden sollen.
Es muss mindestens ein Feld angegeben werden. Das Stamm-
Wenn Sie beispielsweise die Spaltenbreite aktualisieren möchten, setzen Sie |
UpdateTableCellStyleRequest
Aktualisiert den Stil eines Tabellenzellbereichs.
JSON-Darstellung |
---|
{ "tableCellStyle": { object ( |
Felder | |
---|---|
table
|
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:
|
fields
|
Die zu aktualisierenden Felder.
Es muss mindestens ein Feld angegeben werden. Der Stammknoten
Wenn Sie beispielsweise die Hintergrundfarbe der Tabellenzelle aktualisieren möchten, legen 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
cells . Die Zellen, die aktualisiert werden sollen.
cells darf nur einen der folgenden Werte haben:
|
|
table
|
Der Tabellenbereich, der den Teil der Tabelle darstellt, auf den die Aktualisierungen angewendet werden. |
table
|
Die Stelle im Dokument, an der die Tabelle beginnt. Wenn Sie diese Option angeben, werden die Änderungen auf alle Zellen in der Tabelle angewendet. |
TableRange
Ein Tabellenbereich ist ein Verweis auf einen Teil einer Tabelle.
Die Zellen, die durch einen Tabellenbereich angegeben werden, bilden nicht unbedingt ein Rechteck. Angenommen, wir haben eine Tabelle mit 3 × 3 Zeilen, in der alle Zellen der letzten Zeile zusammengeführt sind. Die Tabelle sieht so aus:
[ ][ ][ ]
[ ][ ][ ]
[ ]
Ein Tabellenbereich mit Tabellenzellenposition = (tableStartLocation, Zeile = 0, Spalte = 0), Zeilenspanne = 3 und Spaltenspanne = 2 gibt die folgenden Zellen an:
[ x ][ x ][ ]
[ x ][ x ][ ]
[ x x x ]
JSON-Darstellung |
---|
{
"tableCellLocation": {
object ( |
Felder | |
---|---|
table
|
Die Zelle, an der der Tabellenbereich beginnt. |
row
|
Die Zeilenspanne des Tabellenbereichs. |
column
|
Die Spaltenspanne des Tabellenbereichs. |
UpdateTableRowStyleRequest
Aktualisiert die TableRowStyle
von Zeilen in einer Tabelle.
JSON-Darstellung |
---|
{ "tableStartLocation": { object ( |
Felder | |
---|---|
table
|
Die Stelle im Dokument, an der die Tabelle beginnt. |
row
|
Liste der nullbasierten Zeilenindizes, deren Stil aktualisiert werden soll. Wenn keine Indizes angegeben sind, werden alle Zeilen aktualisiert. |
table
|
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 Stammknoten
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 | |
---|---|
image
|
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 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 |
image
|
Die Ersetzungsmethode. |
tab
|
Der Tab, auf dem sich das Bild befindet, das ersetzt werden soll. 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:
|
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 Begrenzungen des Originalbilds ausfüllt. Die gerenderte Größe des Bildes entspricht der Größe des Originalbilds. |
UpdateDocumentStyleRequest
Aktualisiert DocumentStyle
.
JSON-Darstellung |
---|
{
"documentStyle": {
object ( |
Felder | |
---|---|
document
|
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. Das Stamm-
Wenn Sie beispielsweise den Hintergrund aktualisieren möchten, legen Sie |
tab
|
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:
In einem Dokument mit mehreren Tabs:
|
MergeTableCellsRequest
Zellen in einer Table
zusammenführen
JSON-Darstellung |
---|
{
"tableRange": {
object ( |
Felder | |
---|---|
table
|
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 die Tabelle nicht rechteckig ist), wird der Fehler 400 zurückgegeben. |
UnmergeTableCellsRequest
Heben Sie den Zellenverbund in einer Table
auf.
JSON-Darstellung |
---|
{
"tableRange": {
object ( |
Felder | |
---|---|
table
|
Der Tabellenbereich, der angibt, welche Zellen der Tabelle getrennt werden sollen. Für alle verbundenen Zellen in diesem Bereich wird die Verbindung aufgehoben. Bereits zusammengeführte Zellen sind davon nicht betroffen. Wenn der Bereich keine verbundenen Zellen enthält, führt die Anfrage nichts aus. Wenn sich in einer der zusammengeführten Zellen Text befindet, bleibt dieser Text in der Kopfzelle des resultierenden Blocks nicht zusammengeführter Zellen erhalten. Die Kopfzelle ist die linke obere Zelle, wenn die Inhaltsrichtung von links nach rechts ist, andernfalls die rechte obere Zelle. |
CreateHeaderRequest
Erstellt ein Header
. Der neue Header wird auf die SectionStyle
an der Position von 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. |
section
|
Die Position der |
CreateFootnoteRequest
Erstellt ein Footnote
-Segment und fügt an der angegebenen Stelle eine neue FootnoteReference
ein.
Das neue Footnote
-Segment enthält einen Leerraum, gefolgt von einem Zeilenumbruch.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld footnote_reference_location . Die Stelle, an der der Verweis auf die Fußnote eingefügt werden soll.
Für footnote_reference_location ist nur einer der folgenden Werte zulässig:
|
|
location
|
Fügt den Fußnotenverweis bei einem bestimmten Index im Dokument ein.
Der Verweis auf die Fußnote muss innerhalb der Grenzen einer vorhandenen
Fußnotenverweise können nicht innerhalb einer Gleichung, einer Kopfzeile, einer Fußzeile oder einer Fußnote eingefügt werden. Da Fußnoten nur im Textkörper eingefügt werden können, muss das Feld |
end
|
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ßnotenverweise nur im Textkörper eingefügt werden können, muss das Feld |
ReplaceNamedRangeContentRequest
Ersetzt den Inhalt der angegebenen NamedRange
oder NamedRanges
durch den angegebenen Ersatzinhalt.
Ein einzelner NamedRange
kann aus mehreren nicht zusammenhängenden ranges
bestehen. In diesem Fall wird nur der Inhalt im ersten Bereich ersetzt. Die anderen Bereiche und ihr Inhalt 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 ( |
Felder | |
---|---|
tabs
|
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
replacement_content . Der Inhalt, durch den der vorhandene Inhalt des benannten Bereichs ersetzt werden soll.
replacement_content darf nur einen der folgenden Werte haben:
|
|
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:
|
|
named
|
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. |
named
|
Der Name der
Wenn es mehrere |
UpdateSectionStyleRequest
Aktualisiert den SectionStyle
.
JSON-Darstellung |
---|
{ "range": { object ( |
Felder | |
---|---|
range
|
Der Bereich, der die zu gestaltenden Abschnitte überschneidet.
Da Abschnittsübergänge nur im Textkörper eingefügt werden können, muss das Feld |
section
|
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 |
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 Stelle einen Abschnittswechsel ein.
Vor dem Abschnittswechsel wird ein Zeilenumbruchzeichen eingefügt.
JSON-Darstellung |
---|
{ "sectionType": enum ( |
Felder | |
---|---|
section
|
Der einzufügende Abschnittstyp. |
Union-Feld
insertion_location . Die Stelle, an der die Unterbrechung eingefügt werden soll.
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 innerhalb einer Tabelle, einer Gleichung, einer Fußnote, einer Kopf- oder Fußzeile eingefügt werden. Da Abschnittsübergänge nur im Textkörper eingefügt werden können, muss das Feld |
end
|
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 Abschnittsübergänge nur im Textkörper eingefügt werden können, muss das Feld |
DeleteHeaderRequest
Löscht einen Header
aus dem Dokument.
JSON-Darstellung |
---|
{ "headerId": string, "tabId": string } |
Felder | |
---|---|
header
|
Die ID des zu löschenden Headers. Wenn dieser Abschnitt auf |
tab
|
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 | |
---|---|
table
|
Die Stelle im Dokument, an der die Tabelle beginnt. |
pinned
|
Die Anzahl der anzupinnenden Tabellenzeilen. „0“ bedeutet, dass alle Zeilen nicht angepinnt sind. |