Anfragen
Eine Aktualisierung, die auf ein Dokument angewendet werden soll.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld request . Die spezielle Anfrage, die angewendet werden soll. Genau ein Feld ist erforderlich.
request darf nur einer der folgenden Werte sein:
|
|
replaceAllText
|
Ersetzt alle Instanzen des angegebenen Textes. |
insertText
|
Fügt Text am angegebenen Speicherort ein. |
updateTextStyle
|
Aktualisiert den Textstil im angegebenen Bereich. |
createParagraphBullets
|
Erstellt Aufzählungspunkte für Absätze. |
deleteParagraphBullets
|
Löscht Aufzählungspunkte 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 eine Tabelle am angegebenen Speicherort 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 einen Seitenumbruch am angegebenen Ort ein. |
deletePositionedObject
|
Löscht ein positioniertes Objekt aus dem Dokument. |
updateTableColumnProperties
|
Aktualisiert die Eigenschaften von Spalten in einer Tabelle. |
updateTableCellStyle
|
Aktualisiert den Stil der Tabellenzellen. |
updateTableRowStyle
|
Aktualisiert den Zeilenstil in einer Tabelle |
replaceImage
|
Ersetzt ein Bild im Dokument. |
updateDocumentStyle
|
Aktualisiert den Stil des Dokuments |
mergeTableCells
|
Zellen in einer Tabelle werden zusammengeführt. |
unmergeTableCells
|
Zellenverbund in einer Tabelle aufheben. |
createHeader
|
Erstellt einen Header. |
createFooter
|
Eine Fußzeile wird erstellt. |
createFootnote
|
Eine Fußnote wird erstellt. |
replaceNamedRangeContent
|
Ersetzt den Inhalt in einem benannten Bereich. |
updateSectionStyle
|
Aktualisiert den Abschnittsstil des angegebenen Bereichs |
insertSectionBreak
|
Fügt einen Abschnittswechsel an der angegebenen Stelle ein. |
deleteHeader
|
Löscht einen Header aus dem Dokument |
deleteFooter
|
Löscht eine Fußzeile aus dem Dokument |
pinTableHeaderRows
|
Aktualisiert die Anzahl der angepinnten Kopfzeilen in einer Tabelle |
AlleTextanfrage ersetzen
Ersetzt alle Instanzen eines Texts, die einem Kriterium entsprechen, durch replace text
.
JSON-Darstellung |
---|
{ "replaceText": string, // Union field |
Felder | |
---|---|
replaceText
|
Der Text, der den übereinstimmenden Text ersetzt |
Union-Feld criteria . Die Kriterien, die verwendet werden, um dem zu ersetzenden Text zu entsprechen.
criteria darf nur einer der folgenden Werte sein:
|
|
containsText
|
Hiermit wird Text im Dokument gefunden, der mit dem Teilstring übereinstimmt. |
TeilstringÜbereinstimmungen
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. |
matchCase
|
Gibt an, ob bei der Suche Groß- und Kleinschreibung berücksichtigt werden soll:
|
Textanfrage einfügen
Fügt Text am angegebenen Speicherort ein.
JSON-Darstellung |
---|
{ "text": string, // Union field |
Felder | |
---|---|
text
|
Der Text, der eingefügt werden soll
Wenn Sie ein Zeilenumbruchzeichen einfügen, wird implizit ein neuer Textstile für eingefügten Text werden automatisch ermittelt. Der Stil des benachbarten Textes wird in der Regel beibehalten. In den meisten Fällen stimmt der Textstil des eingefügten Texts mit dem Text direkt vor dem eingefügten Index überein. Einige Steuerzeichen (U+0000-U+0008, U+000C-U+001F) und Zeichen aus der Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) werden aus dem eingefügten Text entfernt. |
Union-Feld insertion_location . Der Ort, an dem der Text eingefügt wird.
insertion_location darf nur einer der folgenden Werte sein:
|
|
location
|
Fügt den Text an einem bestimmten Index im Dokument ein.
Text muss innerhalb der Grenzen eines vorhandenen |
endOfSegmentLocation
|
Fügt den Text am Ende einer Kopfzeile, Fußzeile, Fußnote oder des Textes des Dokuments ein. |
Standort
Ein bestimmter Speicherort im Dokument.
JSON-Darstellung |
---|
{ "segmentId": string, "index": integer } |
Felder | |
---|---|
segmentId
|
Die ID der Kopf-, Fußzeile oder Fußnote, in der sich der Ort befindet. Eine leere Segment-ID gibt den Text des Dokuments an. |
index
|
Der nullbasierte Index in UTF-16-Codeeinheiten.
Der Index relativ zum Anfang des Segments, das durch |
Ende des Segmentorts
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 } |
Felder | |
---|---|
segmentId
|
Die ID der Kopf-, Fußzeile oder Fußnote, in der sich der Ort befindet. Eine leere Segment-ID gibt den Text des Dokuments an. |
Anfragetext aktualisieren
Ändern Sie den Textstil.
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 Elements übereinstimmt, wird für diesen Stil die Übernahme übernommen.
Bestimmte Textstiländerungen können andere Änderungen verursachen, um das Verhalten des Docs-Editors zu spiegeln. Weitere Informationen finden Sie in der Dokumentation zu |
fields
|
Die Felder, die aktualisiert werden sollen.
Es muss mindestens ein Feld angegeben werden. Das Stammverzeichnis
Wenn Sie beispielsweise den Textstil fett formatieren möchten, setzen Sie Wenn Sie ein Attribut auf den Standardwert zurücksetzen möchten, nehmen Sie seinen Feldnamen in die Feldmaske auf, aber lassen Sie das Feld selbst leer. |
Union-Feld insertion_location . Der Typ des Bereichs, in dem der Textstil aktualisiert wird.
insertion_location darf nur einer der folgenden Werte sein:
|
|
range
|
Der Textbereich, der gestaltet werden soll. Der Bereich kann um nachfolgende Zeilenumbrüche erweitert werden. Wenn der Bereich einen Absatz enthält, der zu einer Liste gehört, wird auch der Absatzpunkt mit dem entsprechenden Textstil aktualisiert. Bereiche können nicht in eine relative UpdateTextStyleRequest eingefügt werden. |
Anfrage zum Erstellen einer Absatzanfrage
Erstellt Aufzählungspunkte für alle Absätze, die sich mit dem angegebenen Bereich überschneiden.
Die Verschachtelungsebene jedes Absatzes wird ermittelt, indem führende Tabs vor jedem Absatz gezählt werden. Um den Abstand zwischen Aufzählungspunkt und dem entsprechenden Absatz zu reduzieren, werden die führenden Tabs durch diese Anfrage entfernt. Dadurch können die Indexe der Textabschnitte geändert werden.
Wenn sich der Absatz direkt vor den zu aktualisierenden Absätzen in einer Liste mit einer übereinstimmenden Voreinstellung befindet, werden die aktualisierten Absätze der vorherigen Liste hinzugefügt.
JSON-Darstellung |
---|
{ "range": { object ( |
Felder | |
---|---|
range
|
Der Bereich, auf den die Aufzählungseinstellung angewendet wird. |
bulletPreset
|
Die Arten der zu verwendenden Aufzählungszeichen. |
Aufzählungszeichen Glyphe
Voreingestellte Muster von Aufzählungspunkten für Listen.
Diese Muster verwenden folgende Arten von Aufzählungszeichen:
-
ARROW
: Ein Pfeil, der einem Unicode-Code für U+2794 entspricht -
ARROW3D
: Ein Pfeil mit 3D-Schattierung, der einem Unicode-Code für U+27a2 entspricht -
CHECKBOX
: Ein hohles Quadrat, das einem Unicode-U+274f-Codepunkt entspricht -
CIRCLE
: ein hohler Kreis, der einem Unicode-U+25cb-Codepunkt entspricht -
DIAMOND
: Ein massiver Diamant, der einem Unicode-Code für U+25c6 entspricht -
DIAMONDX
: Ein Diamant mit einem „x“, der einem Unicode U+2756-Codepunkt entspricht -
HOLLOWDIAMOND
: Ein hohler Diamant, der einem Unicode-Code für U+25c7 entspricht -
DISC
: Ein durchgezogener Kreis, der einem Unicode-Code für U+25cf entspricht -
SQUARE
: Ein ausgefülltes Quadrat, das einem Unicode-U+25a0-Codepunkt entspricht -
STAR
: : Ein Stern, der einem Unicode-U+2605-Codepunkt entspricht -
ALPHA
: Ein Kleinbuchstaben, z. B. „a“, „b“ oder „c“. -
UPPERALPHA
: Ein Großbuchstaben, z. B. „A“, „B“ oder „C“. -
DECIMAL
: Eine Zahl, z. B. „1“, „2“ oder „3“. -
ZERODECIMAL
: Eine Zahl, der einstellige Ziffern vor einer Null vorangestellt sind, z. B. „01“, „02“ oder „03“. Ziffern mit mehr als einer Ziffer werden nicht mit einer Null versehen. -
ROMAN
: Ein römisches Kleinbuchstabe, z. B. „i“, „ii“ oder „iii“. -
UPPERROMAN
: Große römische Zahl, z. B. „I“, „II“ oder „III“. -
LEFTTRIANGLE
: Ein Dreieck, das nach links zeigt und einem Unicode-Code für U+25c4 entspricht
Enums | |
---|---|
BULLET_GLYPH_PRESET_UNSPECIFIED
|
Die Voreinstellung für das Aufzählungszeichen ist nicht angegeben. |
BULLET_DISC_CIRCLE_SQUARE
|
Eine Aufzählungsliste mit einer
DISC , CIRCLE
und
SQUARE
Aufzählungszeichen Glyphe für die ersten 3 Verschachtelungsebenen.
|
BULLET_DIAMONDX_ARROW3D_SQUARE
|
Eine Aufzählungsliste mit einer
DIAMONDX , ARROW3D
und
SQUARE
Aufzählungszeichen Glyphe für die ersten 3 Verschachtelungsebenen.
|
BULLET_CHECKBOX
|
Eine Aufzählungsliste mit CHECKBOX -Aufzählungszeichen für alle Listenebenen.
|
BULLET_ARROW_DIAMOND_DISC
|
Eine Aufzählungsliste mit einer
ARROW , DIAMOND
und
DISC
Aufzählungszeichen Glyphe für die ersten 3 Verschachtelungsebenen.
|
BULLET_STAR_CIRCLE_SQUARE
|
Eine Aufzählungsliste mit einer
STAR , CIRCLE
und
SQUARE
Aufzählungszeichen Glyphe für die ersten 3 Verschachtelungsebenen.
|
BULLET_ARROW3D_CIRCLE_SQUARE
|
Eine Aufzählungsliste mit einer
ARROW3D , CIRCLE
und
SQUARE
Aufzählungszeichen Glyphe für die ersten 3 Verschachtelungsebenen.
|
BULLET_LEFTTRIANGLE_DIAMOND_DISC
|
Eine Aufzählungsliste mit einer
LEFTTRIANGLE , DIAMOND
und
DISC
Aufzählungszeichen Glyphe für die ersten 3 Verschachtelungsebenen.
|
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE
|
Eine Aufzählungsliste mit einer
DIAMONDX , HOLLOWDIAMOND
und
SQUARE
Aufzählungszeichen Glyphe für die ersten 3 Verschachtelungsebenen.
|
BULLET_DIAMOND_CIRCLE_SQUARE
|
Eine Aufzählungsliste mit einer
DIAMOND , CIRCLE
und
SQUARE
Aufzählungszeichen Glyphe für die ersten 3 Verschachtelungsebenen.
|
NUMBERED_DECIMAL_ALPHA_ROMAN
|
Eine nummerierte Liste mit den numerischen Glyphen DECIMAL , ALPHA und ROMAN für die ersten drei Verschachtelungsebenen, gefolgt von Punkten.
|
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS
|
Eine nummerierte Liste mit den numerischen Glyphen DECIMAL , ALPHA und ROMAN für die ersten drei Verschachtelungsebenen, gefolgt von Klammern.
|
NUMBERED_DECIMAL_NESTED
|
Eine nummerierte Liste mit numerischen DECIMAL -Glyphen, getrennt durch Punkte, wobei jede Verschachtelungsebene das Glyphen der vorherigen Verschachtelungsebene als Präfix verwendet. Beispiel: „1.“, „1.1.“, „2.“, „2.2.“.
|
NUMBERED_UPPERALPHA_ALPHA_ROMAN
|
Eine nummerierte Liste mit den numerischen Glyphen UPPERALPHA , ALPHA und ROMAN für die ersten drei Verschachtelungsebenen, gefolgt von Punkten.
|
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL
|
Eine nummerierte Liste mit den numerischen Glyphen UPPERROMAN , UPPERALPHA und DECIMAL für die ersten drei Verschachtelungsebenen, gefolgt von Punkten.
|
NUMBERED_ZERODECIMAL_ALPHA_ROMAN
|
Eine nummerierte Liste mit den numerischen Glyphen ZERODECIMAL , ALPHA und ROMAN für die ersten drei Verschachtelungsebenen, gefolgt von Punkten.
|
LöschenParagraphBulletsAnfrage
Löscht Aufzählungspunkte aus allen Absätzen, die sich mit dem angegebenen Bereich überschneiden
Die Verschachtelungsebene jedes Absatzes wird visuell beibehalten, indem Sie ein Einzug am Anfang des entsprechenden Absatzes einfügen.
JSON-Darstellung |
---|
{
"range": {
object (
|
Felder | |
---|---|
range
|
Der Bereich, aus dem Aufzählungspunkte gelöscht werden sollen. |
AnfragenameBereich festlegen
Erstellt eine NamedRange
, die auf den angegebenen Bereich verweist.
JSON-Darstellung |
---|
{
"name": string,
"range": {
object (
|
Felder | |
---|---|
name
|
Der Name von NamedRange. Namen müssen nicht eindeutig sein. Namen müssen mindestens 1 Zeichen und nicht mehr als 256 Zeichen lang sein und in UTF-16-Codeeinheiten gemessen werden. |
range
|
Der Bereich, auf den der Name angewendet werden soll. |
LöschnameNameBereichsanfrage
Löscht eine NamedRange
.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld named_range_reference . Der Wert, der bestimmt, welche Bereiche oder Bereiche gelöscht werden. Es muss genau eins festgelegt werden.
named_range_reference darf nur einer der folgenden Werte sein:
|
|
namedRangeId
|
Die ID des benannten Bereichs, der gelöscht werden soll. |
name
|
Der Name des zu löschenden Bereichs bzw. der zu löschenden Bereiche. Alle benannten Bereiche mit dem angegebenen Namen werden gelöscht. |
UpdateParagraphStyleRequest
Der Stil aller Absätze, die sich mit dem angegebenen Bereich überschneiden, wird aktualisiert.
JSON-Darstellung |
---|
{ "paragraphStyle": { object ( |
Felder | |
---|---|
paragraphStyle
|
Die Stile, die für die Absätze festgelegt werden sollen.
Bestimmte Absatzstiländerungen können andere Änderungen verursachen, um das Verhalten des Docs-Editors zu spiegeln. Weitere Informationen finden Sie in der Dokumentation zu |
fields
|
Die Felder, die aktualisiert werden sollen.
Es muss mindestens ein Feld angegeben werden. Das Stammverzeichnis
Wenn Sie beispielsweise das Ausrichtungsattribut des Absatzstils aktualisieren möchten, legen Sie Wenn Sie ein Attribut auf den Standardwert zurücksetzen möchten, nehmen Sie seinen Feldnamen in die Feldmaske auf, aber lassen Sie das Feld selbst leer. |
Union-Feld insertion_location . Der Typ des Bereichs, in dem der Absatzstil aktualisiert wird.
insertion_location darf nur einer der folgenden Werte sein:
|
|
range
|
Der Bereich, der sich mit den Absätzen überschneidet. |
"ContentContentRange"-Anfrage löschen
Löscht Inhalte aus dem Dokument.
JSON-Darstellung |
---|
{
"range": {
object (
|
Felder | |
---|---|
range
|
Der Bereich, der gelöscht werden soll. Beim Löschen von Text, der eine Absatzgrenze überschreitet, können sich Absatzstile, Listen, positionierte Objekte und Lesezeichen ändern, wenn die beiden Absätze zusammengeführt werden. Der Versuch, bestimmte Bereiche zu löschen, kann zu einer ungültigen Dokumentstruktur führen. In diesem Fall wird der Fehler 400 zurückgegeben. Beispiele für ungültige Löschanfragen:
|
Inline-Bildanfrage einfügen
Fügt ein InlineObject
ein, das ein Bild am angegebenen Standort enthält.
JSON-Darstellung |
---|
{ "uri": string, "objectSize": { object ( |
Felder | |
---|---|
uri
|
Image-URI Das Bild wird beim Einfügen einmal abgerufen und eine Kopie zur Anzeige im Dokument gespeichert. Bilder müssen kleiner als 50 MB sein, nicht größer als 25 Megapixel sein und im PNG-, JPEG- oder GIF-Format vorliegen.
Der angegebene URI muss öffentlich zugänglich sein und darf maximal 2 KB groß sein. Der URI selbst wird mit dem Bild gespeichert und über das Feld |
objectSize
|
Die Größe, in der das Bild im Dokument angezeigt werden soll. Diese Eigenschaft ist optional und die finale Größe des Bildes im Dokument wird durch folgende Regeln bestimmt: * Wenn weder Breite noch Höhe angegeben ist, wird die Standardgröße des Bildes anhand seiner Auflösung berechnet. * Ist eine Dimension angegeben, wird die andere Dimension berechnet, um das Seitenverhältnis des Bilds beizubehalten. * Wenn sowohl Breite als auch Höhe angegeben werden, wird das Bild an die angegebenen Abmessungen angepasst, dabei aber das Seitenverhältnis beibehalten. |
Union-Feld insertion_location . Der Ort, an dem das Bild eingefügt wird.
insertion_location darf nur einer der folgenden Werte sein:
|
|
location
|
Fügt das Bild an einem bestimmten Index im Dokument ein.
Das Bild muss innerhalb der Grenzen eines vorhandenen Inline-Bilder können nicht in Fußnoten oder Gleichungen eingefügt werden. |
endOfSegmentLocation
|
Fügt den Text am Ende einer Kopfzeile, Fußzeile oder des Textkörpers des Dokuments ein. Inline-Bilder können nicht in eine Fußnote eingefügt werden. |
Tabellenanfrage einfügen
Fügt eine Tabelle am angegebenen Speicherort ein.
Es wird ein Zeilenumbruch 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 . Der Ort, an dem die Tabelle eingefügt wird.
insertion_location darf nur einer der folgenden Werte sein:
|
|
location
|
Fügt die Tabelle an einem bestimmten Modellindex ein. Es wird ein Zeilenumbruch vor der eingefügten Tabelle eingefügt, daher befindet sich der Tabellenstartindex am angegebenen Speicherortindex + 1.
Die Tabelle muss innerhalb der Grenzen eines vorhandenen Tabellen können nicht in eine Fußnote oder eine Gleichung eingefügt werden. |
endOfSegmentLocation
|
Fügt die Tabelle am Ende der angegebenen Kopfzeile, Fußzeile oder des Dokuments ein. Es wird ein Zeilenumbruch vor der eingefügten Tabelle eingefügt. Tabellen können nicht in einer Fußnote eingefügt werden. |
Tabellenanforderung eingeben
Fügt eine leere Zeile in eine Tabelle ein.
JSON-Darstellung |
---|
{
"tableCellLocation": {
object (
|
Felder | |
---|---|
tableCellLocation
|
Die Zelle der Referenztabelle, aus der die Zeilen eingefügt werden. Es wird eine neue Zeile oberhalb oder unterhalb der Zeile eingefügt, in der sich die Referenzzelle befindet. Wenn die Referenzzelle eine zusammengeführte Zelle ist, wird eine neue Zeile oberhalb oder unterhalb der verbundenen Zelle eingefügt. |
insertBelow
|
Gibt an, ob eine neue Zeile unterhalb der Position der Referenzzelle eingefügt werden soll.
|
TabellenZelle
Speicherort einer einzelnen Zelle in einer Tabelle.
JSON-Darstellung |
---|
{
"tableStartLocation": {
object (
|
Felder | |
---|---|
tableStartLocation
|
Der Ort, an dem die Tabelle im Dokument beginnt. |
rowIndex
|
Der nullbasierte Zeilenindex. Die zweite Zeile in der Tabelle hat beispielsweise den Zeilenindex 1. |
columnIndex
|
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 | |
---|---|
tableCellLocation
|
Die Zelle der Referenztabelle, aus der Spalten eingefügt werden. Links oder rechts neben der Spalte, in der sich die Referenzzelle befindet, wird eine neue Spalte eingefügt. |
insertRight
|
Gibt an, ob eine neue Spalte rechts neben der Position der Referenzzelle eingefügt werden soll.
|
Tabellenzeilenanforderung löschen
Löscht eine Zeile aus einer Tabelle
JSON-Darstellung |
---|
{
"tableCellLocation": {
object (
|
Felder | |
---|---|
tableCellLocation
|
Der Speicherort der Referenztabellenzelle, aus der die Zeile gelöscht wird. Die Zeile, die diese Zelle enthält, wird gelöscht. Wenn dies eine zusammengeführte Zelle ist, die sich über mehrere Zeilen erstreckt, werden alle Zeilen gelöscht, die diese Zelle umfassen. Wenn nach dem Löschen keine Zeilen mehr in der Tabelle verbleiben, wird die gesamte Tabelle gelöscht. |
Tabellenspaltenanforderung löschen
Löscht eine Spalte aus einer Tabelle
JSON-Darstellung |
---|
{
"tableCellLocation": {
object (
|
Felder | |
---|---|
tableCellLocation
|
Der Speicherort der Referenztabellenzelle, aus der die Spalte gelöscht wird. Die Spalte, die diese Zelle enthält, wird gelöscht. Wenn dies eine zusammengeführte Zelle ist, die sich über mehrere Spalten erstreckt, werden alle Spalten gelöscht, die die Zelle umfassen. Wenn nach dem Löschen keine Spalten mehr in der Tabelle verbleiben, wird die gesamte Tabelle gelöscht. |
„Seitenumbruchanfrage“ einfügen
Fügt einen Seitenumbruch gefolgt von einem Zeilenumbruch am angegebenen Ort ein.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld insertion_location . Die Position, an der der Seitenumbruch eingefügt wird.
insertion_location darf nur einer der folgenden Werte sein:
|
|
location
|
Fügt den Seitenumbruch an einem bestimmten Index in das Dokument ein.
Der Seitenumbruch muss innerhalb der Grenzen eines vorhandenen
Seitenumbrüche können nicht in Tabellen, Gleichungen, Fußnoten, Kopf- oder Fußzeilen eingefügt werden. Da Seitenumbrüche nur innerhalb des Felds eingefügt werden können, darf das Feld |
endOfSegmentLocation
|
Fügt den Seitenumbruch am Ende des Dokumenttexts ein.
Seitenumbrüche können nicht in Fußnoten, Kopf- oder Fußzeilen eingefügt werden. Da Seitenumbrüche nur innerhalb des Felds eingefügt werden können, darf das Feld |
Anfrage vom Typ „Objekt löschen“
Löscht eine PositionedObject
aus dem Dokument.
JSON-Darstellung |
---|
{ "objectId": string } |
Felder | |
---|---|
objectId
|
Die ID des zu löschenden positionierten Objekts. |
UpdateTableColumnPropertiesRequest
Aktualisiert die TableColumnProperties
der Spalten in einer Tabelle.
JSON-Darstellung |
---|
{ "tableStartLocation": { object ( |
Felder | |
---|---|
tableStartLocation
|
Der Ort, an dem die Tabelle im Dokument beginnt. |
columnIndices[]
|
Die Liste der nullbasierten Spaltenindexe, deren Property aktualisiert werden soll. Wenn keine Indexe angegeben sind, werden alle Spalten aktualisiert. |
tableColumnProperties
|
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 Stammverzeichnis
Wenn Sie beispielsweise die Spaltenbreite aktualisieren möchten, setzen Sie |
Tabellenzelle aktualisieren
Aktualisiert den Stil eines Bereichs von Tabellenzellen.
JSON-Darstellung |
---|
{ "tableCellStyle": { object ( |
Felder | |
---|---|
tableCellStyle
|
Der Stil, der für die Tabellenzellen festgelegt werden soll. Wird eine Rahmenlinie beim Aktualisieren einer Rahmenlinie mit einer angrenzenden Zelle geteilt, wird auch die zugehörige Rahmeneigenschaft der angrenzenden Zelle aktualisiert. Rahmenlinien, die zusammengeführt und nicht sichtbar sind, werden nicht aktualisiert. Da die Aktualisierung eines Rahmens, der von benachbarten Zellen in derselben Anfrage gemeinsam genutzt wird, zu Konflikten bei der Aktualisierung des Rahmens führen kann, werden die folgenden Schritte angewendet:
|
fields
|
Die Felder, die aktualisiert werden sollen.
Es muss mindestens ein Feld angegeben werden. Das Stammverzeichnis
Wenn Sie beispielsweise die Hintergrundfarbe der Tabellenzelle aktualisieren möchten, setzen Sie Wenn Sie ein Attribut auf den Standardwert zurücksetzen möchten, nehmen Sie seinen Feldnamen in die Feldmaske auf, aber lassen Sie das Feld selbst leer. |
Union-Feld cells . Die Zellen, die aktualisiert werden.
cells darf nur einer der folgenden Werte sein:
|
|
tableRange
|
Der Tabellenbereich, der den Teil der Tabelle darstellt, auf die die Aktualisierungen angewendet werden. |
tableStartLocation
|
Der Ort, an dem die Tabelle im Dokument beginnt. Wenn Sie dies tun, werden die Aktualisierungen auf alle Zellen in der Tabelle angewendet. |
Tabellenbereich
Ein Tabellenbereich steht für einen Verweis auf eine Teilmenge einer Tabelle.
Die Zellen in einem Tabellenbereich bilden nicht unbedingt ein Rechteck. Beispiel: Wir haben eine 3 × 3-Tabelle, in der alle Zellen der letzten Zeile zusammengeführt sind. Die Tabelle sieht so aus:
[ ][ ][ ]
[ ][ ][ ]
[ ]
Ein Tabellenbereich mit den Zellen der Tabellenzelle = (tableStartLocation, Zeile = 0, Spalte = 0), der Zeilenbereich = 3 und dem Spaltenbereich = 2 gibt die folgenden Zellen an:
[ x ][ x ][ ]
[ x ][ x ][ ]
[ x x x ]
JSON-Darstellung |
---|
{
"tableCellLocation": {
object (
|
Felder | |
---|---|
tableCellLocation
|
Zellposition, an der der Tabellenbereich beginnt. |
rowSpan
|
Der Zeilenbereich des Tabellenbereichs |
columnSpan
|
Der Spaltenbereich des Tabellenbereichs. |
UpdateTableRowStyleRequest
Aktualisiert die TableRowStyle
der Zeilen in einer Tabelle.
JSON-Darstellung |
---|
{ "tableStartLocation": { object ( |
Felder | |
---|---|
tableStartLocation
|
Der Ort, an dem die Tabelle im Dokument beginnt. |
rowIndices[]
|
Die Liste der nullbasierten Zeilenindexe, deren Stil aktualisiert werden soll. Wenn keine Indexe 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. Das Stammverzeichnis
Wenn Sie beispielsweise die Mindestzeilenhöhe aktualisieren möchten, setzen Sie |
Bildanfrage ersetzen
Ersetzt ein vorhandenes Bild durch ein neues.
Beim Ersetzen eines Bildes wird image effects
aus dem vorhandenen Bild entfernt, um das Verhalten des Docs-Editors zu spiegeln.
JSON-Darstellung |
---|
{
"imageObjectId": string,
"uri": string,
"imageReplaceMethod": enum (
|
Felder | |
---|---|
imageObjectId
|
Die ID des vorhandenen Bilds, das ersetzt wird. Die ID kann aus der Antwort einer „get“-Anfrage abgerufen werden. |
uri
|
Der URI des neuen Bilds. Das Bild wird beim Einfügen einmal abgerufen und eine Kopie zur Anzeige im Dokument gespeichert. Bilder müssen kleiner als 50 MB sein, nicht größer als 25 Megapixel sein und im PNG-, JPEG- oder GIF-Format vorliegen.
Der angegebene URI darf eine Länge von 2 KB nicht überschreiten. Der URI wird mit dem Bild gespeichert und über das Feld |
imageReplaceMethod
|
Die Ersatzmethode. |
Bildersetzungsmethode
Die Methode zum Ersetzen von Bildern
Enums | |
---|---|
IMAGE_REPLACE_METHOD_UNSPECIFIED
|
Nicht angegebene Bildersetzungsmethode. Dieser Wert darf nicht verwendet werden. |
CENTER_CROP
|
Skaliert und zentriert das Bild, um die Grenzen des Originalbilds zu füllen. Das Bild wird möglicherweise zugeschnitten, um die Rahmen des Originalbilds zu füllen. Die gerenderte Größe des Bildes entspricht der des Originalbilds. |
UpdateDocumentStyleRequest
Aktualisiert die DocumentStyle
.
JSON-Darstellung |
---|
{
"documentStyle": {
object (
|
Felder | |
---|---|
documentStyle
|
Die für das Dokument festzulegenden Stile.
Bestimmte Änderungen am Dokumentstil können andere Änderungen verursachen, um das Verhalten des Docs-Editors zu übernehmen. Weitere Informationen finden Sie in der Dokumentation zu |
fields
|
Die Felder, die aktualisiert werden sollen.
Es muss mindestens ein Feld angegeben werden. Das Stammverzeichnis
Wenn Sie beispielsweise den Hintergrund aktualisieren möchten, setzen Sie |
MergeTableCellsRequest
Führt Zellen in einer Table
zusammen.
JSON-Darstellung |
---|
{
"tableRange": {
object (
|
Felder | |
---|---|
tableRange
|
Der Tabellenbereich, der angibt, welche Zellen der Tabelle zusammengeführt werden sollen. Jeder Text in den Zellen, die zusammengeführt werden, wird verkettet und in der Zelle „head“ des Bereichs gespeichert. Das ist die Zelle links oben im Bereich, wenn die Inhaltsrichtung von links nach rechts ist, und die Zelle oben rechts im Bereich. Wenn der Bereich nicht rechteckig ist, was vorkommen kann, wenn der Bereich bereits zusammengeführte Zellen enthält oder die Tabelle nicht rechteckig ist, wird ein Fehler vom Typ „400 – Anfrage“ zurückgegeben. |
UnmergeTableCellsRequest anfordern
Verbindet Zellen in einer Table
zusammen.
JSON-Darstellung |
---|
{
"tableRange": {
object (
|
Felder | |
---|---|
tableRange
|
Der Tabellenbereich, der angibt, für welche Zellen die Tabelle zusammengeführt werden soll. Die Verbindung aller Zellen in diesem Bereich wird aufgehoben. Bereits zusammengeführte Zellen sind davon nicht betroffen. Wenn der Bereich keine verbundenen Zellen hat, führt die Anfrage nichts aus. Wenn in einer der verbundenen Zellen Text enthalten ist, bleibt er in der „head“-Zelle der Zellen, die nicht zusammengeführt wurden. Die Zelle „Kopf“ ist die Zelle oben links, wenn die Inhaltsrichtung von links nach rechts ist, ansonsten ist sie oben rechts. |
HeaderHeader-Anfrage erstellen
Erstellt Header
. Der neue Header wird, sofern angegeben, auf die SectionStyle
am Speicherort der SectionBreak
angewendet. Andernfalls wird er auf die DocumentStyle
angewendet.
Wenn bereits ein Header des angegebenen Typs vorhanden ist, wird ein Fehler vom Typ „400“ zurückgegeben.
JSON-Darstellung |
---|
{ "type": enum ( |
Felder | |
---|---|
type
|
Der Typ der zu erstellenden Überschrift. |
sectionBreakLocation
|
Der Speicherort von |
Anfrage erstellenFußnote
Erstellt ein Footnote
-Segment und fügt an der angegebenen Position ein neues FootnoteReference
-Element ein.
Das neue Segment Footnote
enthält ein Leerzeichen, gefolgt von einem Zeilenumbruch.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld footnote_reference_location . Der Ort, an dem die Fußnotenreferenz eingefügt werden soll.
footnote_reference_location darf nur einer der folgenden Werte sein:
|
|
location
|
Fügt die Fußnotenreferenz an einem bestimmten Index im Dokument ein.
Die Fußnotenreferenz muss innerhalb der Grenzen eines vorhandenen
Verweise auf Fußnoten können nicht in Gleichungen, Überschriften, Fußzeilen und Fußnoten eingefügt werden. Da Fußnotenreferenzen nur im Text eingefügt werden können, muss das Feld |
endOfSegmentLocation
|
Fügt die Fußnotenreferenz am Ende des Dokumenttexts ein.
Verweise auf Fußnoten können nicht in einer Kopf-, Fußzeile oder Fußnote eingefügt werden. Da Fußnotenreferenzen nur im Text eingefügt werden können, muss das Feld |
AustauschnameNameBereichContentAnfrage
Ersetzt den Inhalt des angegebenen NamedRange
- oder NamedRanges
-Elements durch den angegebenen Ersatzinhalt.
Ein einzelner NamedRange
kann aus mehreren nicht zusammenhängenden ranges
-Werten bestehen. In diesem Fall wird nur der Content aus dem ersten Bereich ersetzt. Die anderen Bereiche und deren Inhalte werden gelöscht.
Wenn das Ersetzen oder Löschen von Bereichen zu einer ungültigen Dokumentstruktur führt, wird der Fehler „400“ zurückgegeben.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld replacement_content . Der Inhalt, durch den der vorhandene Inhalt des benannten Bereichs ersetzt werden soll.
replacement_content darf 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, dessen Inhalte ersetzt werden.
named_range_reference darf nur einer der folgenden Werte sein:
|
|
namedRangeId
|
Die ID des benannten Bereichs, dessen Inhalte ersetzt werden. Wenn kein benannter Bereich mit der angegebenen ID vorhanden ist, wird der Fehler „400 Ungültige Anfrage“ zurückgegeben. |
namedRangeName
|
Der Name der
Wenn es mehrere |
Anfrage zur Aktualisierung des Bereichsstils
Aktualisiert die SectionStyle
.
JSON-Darstellung |
---|
{ "range": { object ( |
Felder | |
---|---|
range
|
Der Bereich, der die Abschnitte mit Stil überschneidet.
Da Abschnittswechsel nur im Text eingefügt werden können, darf das Feld |
sectionStyle
|
Die Stile, die für den Abschnitt festgelegt werden sollen
Bestimmte Stiländerungen können sich auf das Design des Docs-Editors auswirken. Weitere Informationen finden Sie in der Dokumentation zu |
fields
|
Die Felder, die aktualisiert werden sollen.
Es muss mindestens ein Feld angegeben werden. Das Stammverzeichnis
Wenn Sie beispielsweise den linken Rand aktualisieren möchten, setzen Sie |
Anfrage zum Einfügen des Abschnitts
Fügt an dem angegebenen Ort einen Abschnittswechsel ein.
Es wird ein Zeilenumbruch vor dem Abschnittswechsel eingefügt.
JSON-Darstellung |
---|
{ "sectionType": enum ( |
Felder | |
---|---|
sectionType
|
Der Typ des Abschnitts, den Sie einfügen möchten. |
Union-Feld insertion_location . Der Ort, an dem die Werbeunterbrechung eingefügt wird.
insertion_location darf nur einer der folgenden Werte sein:
|
|
location
|
Hiermit werden ein Zeilenumbruch und ein Abschnittswechsel an einem bestimmten Index im Dokument eingefügt.
Der Abschnittswechsel muss innerhalb der Grenzen eines vorhandenen
Abschnittswechsel können nicht in Tabellen, Gleichungen, Fußnoten, Kopf- oder Fußzeilen eingefügt werden. Da Abschnittswechsel nur im Text eingefügt werden können, darf das Feld |
endOfSegmentLocation
|
Hiermit werden ein Zeilenumbruch und ein Abschnittswechsel am Ende des Dokumenttexts eingefügt.
Abschnittswechsel können nicht in Fußnoten, Kopf- oder Fußzeilen eingefügt werden. Da Abschnittswechsel nur im Text eingefügt werden können, darf das Feld |
HeaderRequest löschen
Löscht eine Header
aus dem Dokument.
JSON-Darstellung |
---|
{ "headerId": string } |
Felder | |
---|---|
headerId
|
Die ID des zu löschenden Headers. Wenn dieser Header in |
PinTableHeaderRowsAnfrage
Aktualisiert die Anzahl der angepinnten Tabellenheader in einer Tabelle
JSON-Darstellung |
---|
{
"tableStartLocation": {
object (
|
Felder | |
---|---|
tableStartLocation
|
Der Ort, an dem die Tabelle im Dokument beginnt. |
pinnedHeaderRowsCount
|
Die Anzahl der anzupinnenden Tabellenzeilen, wobei 0 bedeutet, dass alle Zeilen losgelöst werden. |