MCP Tools Reference: docsmcp.googleapis.com

Tool: update_doc

Aktualisiert ein Dokument mithilfe von Batch-Update-Anfragen. Sie akzeptiert eine documents.batchUpdate-Anfrage (als JSON).

Entspricht documents.batchUpdate in der REST API.

Die Liste der möglichen Updates:

  • replaceAllText: Ersetzt alle Instanzen des angegebenen Texts. Schema:
    • replaceText (String, erforderlich): Der Text, der den abgeglichenen Text ersetzt.
    • Kriterien (genau eines erforderlich):
    • containsText (Objekt): Kriterien für den Abgleich von Text:
      • text (String, erforderlich): Der Text, nach dem im Dokument gesucht werden soll.
      • matchCase (boolesch, optional): Gibt an, ob bei der Suche die Groß-/Kleinschreibung berücksichtigt werden soll.
      • searchByRegex (boolesch, optional): Gibt an, ob der Suchtext als regulärer Ausdruck behandelt wird.
    • tabsCriteria (Objekt, optional): Kriterien, mit denen angegeben wird, auf welchen Tabs der Ersatz erfolgen soll:
    • tabIds (Array von Strings, optional): Die Liste der Tab-IDs, in denen die Anfrage ausgeführt wird.
  • insertText: Fügt Text an der angegebenen Stelle ein. Schema:
    • text (String, erforderlich): Der einzufügende Text.
    • Einfügeort (genau einer erforderlich):
    • location (object): Fügt Text an einem bestimmten Index ein:
      • index (Ganzzahl, erforderlich): Nullbasierter Index in UTF-16-Codeeinheiten.
      • segmentId (String, optional): Die ID der Kopfzeile, Fußzeile oder Fußnote. Leer für den Dokumenttext.
      • tabId (string, optional): Der Tab, auf dem sich der Standort befindet.
    • endOfSegmentLocation (Objekt): Fügt Text am Ende einer Kopfzeile, Fußzeile, Fußnote oder des Dokumenttexts ein:
      • segmentId (String, optional): Die ID der Kopfzeile, Fußzeile oder Fußnote. Leer für den Dokumenttext.
      • tabId (string, optional): Der Tab, auf dem sich der Standort befindet.
  • updateTextStyle: Aktualisiert den Textstil im angegebenen Bereich. Schema:
    • textStyle (Objekt, erforderlich): Die Stile, die für den Text festgelegt werden sollen:
    • bold (boolesch, optional): Gibt an, ob der Text fett gerendert wird.
    • italic (boolescher Wert, optional): Gibt an, ob der Text kursiv formatiert ist.
    • underline (boolescher Wert, optional): Gibt an, ob der Text unterstrichen ist.
    • strikethrough (boolesch, optional): Gibt an, ob der Text durchgestrichen ist.
    • smallCaps (boolescher Wert, optional): Gibt an, ob der Text in Kapitälchen gerendert wird.
    • backgroundColor (Objekt, optional): Text-Hintergrundfarbe: {"color": {"rgbColor": {"red": number, "green": number, "blue": number}}}.
    • foregroundColor (object, optional): Text foreground color: {"color": {"rgbColor": {"red": number, "green": number, "blue": number}}}.
    • fontSize (Objekt, optional): Schriftgröße: {"magnitude": number, "unit": "PT"}.
    • weightedFontFamily (object, optional): Schriftfamilie und ‑stärke: {"fontFamily": string, "weight": integer}.
    • baselineOffset (String, optional): Vertikaler Offset: "NONE", "SUPERSCRIPT" oder "SUBSCRIPT".
    • link (object, optional): Hyperlink-Ziel: {"url": string} oder {"tabId": string}.
    • fields (String, erforderlich): Durch Kommas getrennte Liste der Felder, die aktualisiert werden sollen (z.B. "bold,foregroundColor" oder "*").
    • Einfügeort (genau einer erforderlich):
    • range (Objekt): Der zu formatierende Textbereich:
      • startIndex (Ganzzahl, optional): Nullbasierter Startindex dieses Bereichs.
      • endIndex (Ganzzahl, optional): Nullbasierter Endindex dieses Bereichs.
      • segmentId (String, optional): Die ID der Kopfzeile, Fußzeile oder Fußnote. Leer für den Dokumenttext.
      • tabId (String, optional): Der Tab, der diesen Bereich enthält.
  • createParagraphBullets: Erstellt Aufzählungszeichen für Absätze. Schema:
    • range (object, erforderlich): Der Bereich, auf den die Aufzählungszeichen-Voreinstellung angewendet werden soll:
    • startIndex (Ganzzahl, optional): Nullbasierter Startindex dieses Bereichs.
    • endIndex (Ganzzahl, optional): Nullbasierter Endindex dieses Bereichs.
    • segmentId (String, optional): Die ID der Kopfzeile, Fußzeile oder Fußnote. Leer für den Dokumenttext.
    • tabId (String, optional): Der Tab, der diesen Bereich enthält.
    • bulletPreset (String, erforderlich): Voreingestelltes Muster von Aufzählungszeichen für Listen: "BULLET_DISC_CIRCLE_SQUARE", "BULLET_DIAMONDX_ARROW3D_SQUARE", "BULLET_CHECKBOX", "BULLET_ARROW_DIAMOND_DISC", "BULLET_STAR_CIRCLE_SQUARE", "BULLET_ARROW3D_CIRCLE_SQUARE", "BULLET_LEFTTRIANGLE_DIAMOND_DISC", "BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE", "BULLET_DIAMOND_CIRCLE_SQUARE", "NUMBERED_DECIMAL_ALPHA_ROMAN", "NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS", "NUMBERED_DECIMAL_NESTED", "NUMBERED_UPPERALPHA_ALPHA_ROMAN", "NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL", "NUMBERED_ZERODECIMAL_ALPHA_ROMAN".
  • deleteParagraphBullets: Löscht Aufzählungszeichen aus Absätzen. Schema:
    • range (object, erforderlich): Der Bereich, aus dem Aufzählungszeichen gelöscht werden sollen:
    • startIndex (Ganzzahl, optional): Nullbasierter Startindex dieses Bereichs.
    • endIndex (Ganzzahl, optional): Nullbasierter Endindex dieses Bereichs.
    • segmentId (String, optional): Die ID der Kopfzeile, Fußzeile oder Fußnote. Leer für den Dokumenttext.
    • tabId (String, optional): Der Tab, der diesen Bereich enthält.
  • createNamedRange: Erstellt einen benannten Bereich. Schema:
    • name (String, erforderlich): Der Name des NamedRange-Objekts (1 bis 256 Zeichen).
    • range (Objekt, erforderlich): Der Bereich, auf den der Name angewendet werden soll:
    • startIndex (Ganzzahl, optional): Nullbasierter Startindex dieses Bereichs.
    • endIndex (Ganzzahl, optional): Nullbasierter Endindex dieses Bereichs.
    • segmentId (String, optional): Die ID der Kopfzeile, Fußzeile oder Fußnote. Leer für den Dokumenttext.
    • tabId (String, optional): Der Tab, der diesen Bereich enthält.
  • deleteNamedRange: Löscht einen benannten Bereich. Schema:
    • Verweis auf benannten Bereich (genau einer erforderlich):
    • namedRangeId (String): Die ID des zu löschenden benannten Bereichs.
    • name (String): Der Name des oder der zu löschenden Bereich(e). Alle benannten Bereiche mit diesem Namen werden gelöscht.
    • tabsCriteria (Objekt, optional): Kriterien, mit denen angegeben wird, auf welche Tabs sich das Löschen des Bereichs bezieht:
    • tabIds (Array von Strings, optional): Die Liste der Tab-IDs.
  • updateParagraphStyle: Aktualisiert den Absatzstil im angegebenen Bereich. Schema:
    • paragraphStyle (Objekt, erforderlich): Die Formatierungen, die für die Absätze festgelegt werden sollen:
    • alignment (String, optional): Textausrichtung: "START", "CENTER", "END", "JUSTIFIED".
    • lineSpacing (Zahl, optional): Prozentsatz für den Zeilenabstand (z.B. 100 für 100%).
    • direction (String, optional): Textrichtung: "LEFT_TO_RIGHT", "RIGHT_TO_LEFT".
    • spacingMode (String, optional): Abstandmodus: "NEVER_COLLAPSE", "COLLAPSE_LISTS".
    • spaceAbove (Objekt, optional): Abstand über dem Absatz: {"magnitude": number, "unit": "PT"}.
    • spaceBelow (Objekt, optional): Abstand unter dem Absatz: {"magnitude": number, "unit": "PT"}.
    • borderBetween / borderTop / borderBottom / borderLeft / borderRight (Objekt, optional): {"color": {"color": {"rgbColor": ...}}, "width": {"magnitude": number, "unit": "PT"}, "padding": {"magnitude": number, "unit": "PT"}, "dashStyle": "SOLID"|"DOT"|"DASH"}.
    • indentFirstLine (Objekt, optional): Einzug der ersten Zeile: {"magnitude": number, "unit": "PT"}.
    • indentStart (Objekt, optional): Einzug am Anfang: {"magnitude": number, "unit": "PT"}.
    • indentEnd (Objekt, optional): Einzug am Ende: {"magnitude": number, "unit": "PT"}.
    • namedStyleType (String, optional): Benannter Stiltyp: "NORMAL_TEXT", "TITLE", "SUBTITLE", "HEADING_1", "HEADING_2", "HEADING_3", "HEADING_4", "HEADING_5", "HEADING_6".
    • keepWithNext (boolesch, optional): Gibt an, ob der Absatz auf derselben Seite wie der nächste angezeigt werden soll.
    • keepLinesTogether (boolesch, optional): Gibt an, ob alle Zeilen auf derselben Seite bleiben sollen.
    • avoidWidowAndOrphan (boolescher Wert, optional): Gibt an, ob Witwen-/Waisenkindzeilen vermieden werden sollen.
    • shading (Objekt, optional): Hintergrundschattierung für Absatz: {"backgroundColor": {"color": {"rgbColor": {"red": number, "green": number, "blue": number}}}}.
    • pageBreakBefore (boolesch, optional): Gibt an, ob der Absatz immer am Anfang einer Seite beginnen soll.
    • fields (String, erforderlich): Durch Kommas getrennte Liste der Felder, die aktualisiert werden sollen (z.B. "alignment,namedStyleType" oder "*").
    • Einfügeort (genau einer erforderlich):
    • range (Objekt): Der Bereich, der sich mit den zu formatierenden Absätzen überschneidet:
      • startIndex (Ganzzahl, optional): Nullbasierter Startindex dieses Bereichs.
      • endIndex (Ganzzahl, optional): Nullbasierter Endindex dieses Bereichs.
      • segmentId (String, optional): Die ID der Kopfzeile, Fußzeile oder Fußnote. Leer für den Dokumenttext.
      • tabId (String, optional): Der Tab, der diesen Bereich enthält.
  • deleteContentRange: Löscht Inhalte aus dem Dokument. Schema:
    • range (Objekt, erforderlich): Der zu löschende Inhaltsbereich:
    • startIndex (Ganzzahl, optional): Nullbasierter Startindex dieses Bereichs.
    • endIndex (Ganzzahl, optional): Nullbasierter Endindex dieses Bereichs.
    • segmentId (String, optional): Die ID der Kopfzeile, Fußzeile oder Fußnote. Leer für den Dokumenttext.
    • tabId (String, optional): Der Tab, der diesen Bereich enthält.
  • insertInlineImage: Fügt an der angegebenen Stelle ein Inlinebild ein. Schema:
    • uri (String, erforderlich): Der Bild-URI. Sie muss öffentlich zugänglich sein und darf maximal 2 KB lang sein.
    • objectSize (Objekt, optional): Größe, in der das Bild im Dokument angezeigt werden soll: {"width": {"magnitude": number, "unit": "PT"}, "height": {"magnitude": number, "unit": "PT"}}.
    • Einfügeort (genau einer erforderlich):
    • location (Objekt): Fügt ein Bild an einer bestimmten Stelle ein:
      • index (Ganzzahl, erforderlich): Nullbasierter Index in UTF-16-Codeeinheiten.
      • segmentId (String, optional): Die ID der Kopfzeile, Fußzeile oder Fußnote. Leer für den Dokumenttext.
      • tabId (string, optional): Der Tab, auf dem sich der Standort befindet.
    • endOfSegmentLocation (Objekt): Fügt ein Bild am Ende der Kopfzeile, Fußzeile oder des Dokumentinhalts ein:
      • segmentId (String, optional): Die ID der Kopfzeile, Fußzeile oder Fußnote. Leer für den Dokumenttext.
      • tabId (string, optional): Der Tab, auf dem sich der Standort befindet.
  • insertTable: Fügt eine Tabelle an der angegebenen Stelle ein. Schema:
    • rows (Ganzzahl, erforderlich): Anzahl der Zeilen in der Tabelle.
    • columns (Ganzzahl, erforderlich): Anzahl der Spalten in der Tabelle.
    • Einfügeort (genau einer erforderlich):
    • location (Objekt): Fügt eine Tabelle an einer bestimmten Stelle ein:
      • index (Ganzzahl, erforderlich): Nullbasierter Index in UTF-16-Codeeinheiten.
      • segmentId (String, optional): Die ID der Kopfzeile, Fußzeile oder Fußnote. Leer für den Dokumenttext.
      • tabId (string, optional): Der Tab, auf dem sich der Standort befindet.
    • endOfSegmentLocation (Objekt): Fügt eine Tabelle am Ende der Kopfzeile, Fußzeile oder des Dokumentinhalts ein:
      • segmentId (String, optional): Die ID der Kopfzeile, Fußzeile oder Fußnote. Leer für den Dokumenttext.
      • tabId (string, optional): Der Tab, auf dem sich der Standort befindet.
  • insertTableRow: Fügt eine leere Zeile in eine Tabelle ein. Schema:
    • tableCellLocation (Objekt, erforderlich): Speicherort der Referenztabellenzelle, ab der Zeilen eingefügt werden:
    • tableStartLocation (Objekt, erforderlich): Position, an der die Tabelle im Dokument beginnt:
      • index (Ganzzahl, erforderlich): Nullbasierter Index für den Beginn der Tabelle in UTF-16-Codeeinheiten.
      • segmentId (String, optional): ID der Kopfzeile, Fußzeile oder Fußnote. Leer oder ausgelassen für den Dokumenttext.
      • tabId (String, optional): Tab, der die Tabelle enthält.
    • rowIndex (Ganzzahl, erforderlich): Nullbasierter Zeilenindex.
    • columnIndex (Ganzzahl, erforderlich): Nullbasierter Spaltenindex.
    • insertBelow (boolesch, erforderlich): Gibt an, ob die neue Zeile unter der Referenzzelle eingefügt werden soll (true für „darunter“, false für „darüber“).
  • insertTableColumn: Fügt eine leere Spalte in eine Tabelle ein. Schema:
    • tableCellLocation (Objekt, erforderlich): Die Position der Referenztabellenzelle, ab der Spalten eingefügt werden:
    • tableStartLocation (Objekt, erforderlich): Position, an der die Tabelle im Dokument beginnt:
      • index (Ganzzahl, erforderlich): Nullbasierter Index für den Beginn der Tabelle in UTF-16-Codeeinheiten.
      • segmentId (String, optional): ID der Kopfzeile, Fußzeile oder Fußnote. Leer oder ausgelassen für den Dokumenttext.
      • tabId (String, optional): Tab, der die Tabelle enthält.
    • rowIndex (Ganzzahl, erforderlich): Nullbasierter Zeilenindex.
    • columnIndex (Ganzzahl, erforderlich): Nullbasierter Spaltenindex.
    • insertRight (boolesch, erforderlich): Gibt an, ob die neue Spalte rechts von der Referenzzelle eingefügt werden soll (true für rechts, false für links).
  • deleteTableRow: Löscht eine Zeile aus einer Tabelle. Schema:
    • tableCellLocation (Objekt, erforderlich): Referenztabellenzellenposition, aus der die Zeile gelöscht wird:
    • tableStartLocation (Objekt, erforderlich): Position, an der die Tabelle im Dokument beginnt:
      • index (Ganzzahl, erforderlich): Nullbasierter Index für den Beginn der Tabelle in UTF-16-Codeeinheiten.
      • segmentId (String, optional): ID der Kopfzeile, Fußzeile oder Fußnote. Leer oder ausgelassen für den Dokumenttext.
      • tabId (String, optional): Tab, der die Tabelle enthält.
    • rowIndex (Ganzzahl, erforderlich): Nullbasierter Zeilenindex.
    • columnIndex (Ganzzahl, erforderlich): Nullbasierter Spaltenindex.
  • deleteTableColumn: Löscht eine Spalte aus einer Tabelle. Schema:
    • tableCellLocation (Objekt, erforderlich): Referenztabellenzellenposition, aus der die Spalte gelöscht wird:
    • tableStartLocation (Objekt, erforderlich): Position, an der die Tabelle im Dokument beginnt:
      • index (Ganzzahl, erforderlich): Nullbasierter Index für den Beginn der Tabelle in UTF-16-Codeeinheiten.
      • segmentId (String, optional): ID der Kopfzeile, Fußzeile oder Fußnote. Leer oder ausgelassen für den Dokumenttext.
      • tabId (String, optional): Tab, der die Tabelle enthält.
    • rowIndex (Ganzzahl, erforderlich): Nullbasierter Zeilenindex.
    • columnIndex (Ganzzahl, erforderlich): Nullbasierter Spaltenindex.
  • insertPageBreak: Fügt an der angegebenen Stelle einen Seitenumbruch ein. Schema:
    • Einfügeort (genau einer erforderlich):
    • location (Objekt): Fügt einen Seitenumbruch an einem bestimmten Index ein:
      • index (Ganzzahl, erforderlich): Nullbasierter Index in UTF-16-Codeeinheiten.
      • segmentId (String, optional): Die ID der Kopfzeile, Fußzeile oder Fußnote. Leer für den Dokumenttext.
      • tabId (string, optional): Der Tab, auf dem sich der Standort befindet.
    • endOfSegmentLocation (Objekt): Fügt am Ende des Dokumentinhalts einen Seitenumbruch ein:
      • segmentId (String, optional): Die ID der Kopfzeile, Fußzeile oder Fußnote. Leer für den Dokumenttext.
      • tabId (string, optional): Der Tab, auf dem sich der Standort befindet.
  • deletePositionedObject: Löscht ein positioniertes Objekt aus dem Dokument. Schema:
    • objectId (String, erforderlich): ID des zu löschenden positionierten Objekts.
    • tabId (String, optional): Tab, der das positionierte Objekt enthält.
  • updateTableColumnProperties: Aktualisiert die Eigenschaften von Spalten in einer Tabelle. Schema:
    • tableStartLocation (Objekt, erforderlich): Speicherort, an dem die Tabelle im Dokument beginnt:
    • index (Ganzzahl, erforderlich): Nullbasierter Index für den Beginn der Tabelle in UTF-16-Codeeinheiten.
    • segmentId (String, optional): ID der Kopfzeile, Fußzeile oder Fußnote. Leer oder ausgelassen für den Dokumenttext.
    • tabId (String, optional): Tab, der die Tabelle enthält.
    • columnIndices (Array von Ganzzahlen, optional): Auf null basierende Spaltenindexe, die aktualisiert werden sollen. Wenn sie weggelassen wird, werden alle Spalten aktualisiert.
    • tableColumnProperties (Objekt, erforderlich): Spalteneigenschaften, die aktualisiert werden sollen:
    • width (Objekt, optional): Spaltenbreite: {"magnitude": number, "unit": "PT"}.
    • widthType (String, optional): "EVENLY_DISTRIBUTED", "FIXED_WIDTH".
    • fields (String, erforderlich): Durch Kommas getrennte Liste der Felder, die aktualisiert werden sollen (z.B. "width" oder "*").
  • updateTableCellStyle: Aktualisiert den Stil von Tabellenzellen. Schema:
    • Zellen (genau eine erforderlich):
    • tableRange (Objekt): Teilmenge der zu aktualisierenden Tabellenzellen:
      • tableCellLocation (Objekt, erforderlich): Speicherort der Bezugszelle:
      • tableStartLocation (Objekt, erforderlich): Position, an der die Tabelle im Dokument beginnt:
        • index (Ganzzahl, erforderlich): Nullbasierter Index für den Beginn der Tabelle in UTF-16-Codeeinheiten.
        • segmentId (String, optional): ID der Kopfzeile, Fußzeile oder Fußnote. Leer oder ausgelassen für den Dokumenttext.
        • tabId (String, optional): Tab, der die Tabelle enthält.
      • rowIndex (Ganzzahl, erforderlich): Nullbasierter Zeilenindex.
      • columnIndex (Ganzzahl, erforderlich): Nullbasierter Spaltenindex.
      • rowSpan (Ganzzahl, erforderlich): Zeilenbereich des Tabellenbereichs.
      • columnSpan (Ganzzahl, erforderlich): Spaltenbereich des Tabellenbereichs.
    • tableStartLocation (Objekt): Position, ab der die Tabelle auf alle Zellen in der Tabelle angewendet wird:
      • index (Ganzzahl, erforderlich): Nullbasierter Index für den Beginn der Tabelle in UTF-16-Codeeinheiten.
      • segmentId (String, optional): ID der Kopfzeile, Fußzeile oder Fußnote. Leer oder ausgelassen für den Dokumenttext.
      • tabId (String, optional): Tab, der die Tabelle enthält.
    • tableCellStyle (Objekt, erforderlich): Festzulegender Zellenstil:
    • backgroundColor (Objekt, optional): {"color": {"rgbColor": {"red": number, "green": number, "blue": number}}}.
    • paddingTop / paddingBottom / paddingLeft / paddingRight (Objekt, optional): {"magnitude": number, "unit": "PT"}.
    • contentAlignment (String, optional): "TOP", "MIDDLE", "BOTTOM".
    • borderTop / borderBottom / borderLeft / borderRight (Objekt, optional): {"color": {"color": {"rgbColor": ...}}, "width": {"magnitude": number, "unit": "PT"}, "dashStyle": "SOLID"|"DOT"|"DASH"}.
    • fields (String, erforderlich): Durch Kommas getrennte Liste der Felder, die aktualisiert werden sollen (z.B. "backgroundColor,contentAlignment" oder "*").
  • updateTableRowStyle: Aktualisiert den Zeilenstil in einer Tabelle. Schema:
    • tableStartLocation (Objekt, erforderlich): Speicherort, an dem die Tabelle im Dokument beginnt:
    • index (Ganzzahl, erforderlich): Nullbasierter Index für den Beginn der Tabelle in UTF-16-Codeeinheiten.
    • segmentId (String, optional): ID der Kopfzeile, Fußzeile oder Fußnote. Leer oder ausgelassen für den Dokumenttext.
    • tabId (String, optional): Tab, der die Tabelle enthält.
    • rowIndices (Array aus Ganzzahlen, optional): Nullbasierte Zeilenindizes, die aktualisiert werden sollen. Wenn weggelassen, werden alle Zeilen aktualisiert.
    • tableRowStyle (Objekt, erforderlich): Zeilenstil, der festgelegt werden soll:
    • minRowHeight (Objekt, optional): Mindesthöhe der Zeile: {"magnitude": number, "unit": "PT"}.
    • preventOverflow (boolesch, optional): Gibt an, ob Zeilen seitenübergreifend umgebrochen werden dürfen.
    • fields (String, erforderlich): Durch Kommas getrennte Liste der Felder, die aktualisiert werden sollen (z.B. "minRowHeight" oder "*").
  • replaceImage: Ersetzt ein Bild im Dokument. Schema:
    • imageObjectId (String, erforderlich): ID des vorhandenen Bildes, das ersetzt werden soll.
    • uri (String, erforderlich): URI des neuen Bildes. Sie müssen öffentlich zugänglich sein.
    • imageReplaceMethod (String, optional): "CENTER_CROP".
    • tabId (string, optional): Tab, der das zu ersetzende Bild enthält.
  • updateDocumentStyle: Aktualisiert den Stil des Dokuments. Schema:
    • documentStyle (Objekt, erforderlich): Dokumentstil, der festgelegt werden soll:
    • background (Objekt, optional): {"color": {"color": {"rgbColor": {"red": number, "green": number, "blue": number}}}}.
    • marginTop / marginBottom / marginLeft / marginRight (Objekt, optional): {"magnitude": number, "unit": "PT"}.
    • pageSize (Objekt, optional): {"width": {"magnitude": number, "unit": "PT"}, "height": {"magnitude": number, "unit": "PT"}}.
    • useCustomHeaderFooterMargins (boolesch, optional): Gibt an, ob benutzerdefinierte Kopf- und Fußzeilenränder verwendet werden sollen.
    • marginHeader / marginFooter (Objekt, optional): {"magnitude": number, "unit": "PT"}.
    • fields (String, erforderlich): Durch Kommas getrennte Liste der Felder, die aktualisiert werden sollen (z.B. "background,marginTop" oder "*").
    • tabId (string, optional): Tab mit dem zu aktualisierenden Dokumentstil.
  • mergeTableCells: Verbindet Zellen in einer Tabelle. Schema:
    • tableRange (object, erforderlich): Tabellenbereich, der angibt, welche Zellen zusammengeführt werden sollen:
    • tableCellLocation (Objekt, erforderlich): Position der Referenzzelle:
      • tableStartLocation (Objekt, erforderlich): Speicherort, an dem die Tabelle im Dokument beginnt:
      • index (Ganzzahl, erforderlich): Nullbasierter Index für den Beginn der Tabelle in UTF-16-Codeeinheiten.
      • segmentId (String, optional): ID der Kopfzeile, Fußzeile oder Fußnote. Leer oder ausgelassen für den Dokumenttext.
      • tabId (String, optional): Tab, der die Tabelle enthält.
      • rowIndex (Ganzzahl, erforderlich): Nullbasierter Zeilenindex.
      • columnIndex (Ganzzahl, erforderlich): Nullbasierter Spaltenindex.
    • rowSpan (Ganzzahl, erforderlich): Zeilenbereich des Tabellenbereichs.
    • columnSpan (Ganzzahl, erforderlich): Spaltenbereich des Tabellenbereichs.
  • unmergeTableCells: Hebt den Verbund von Zellen in einer Tabelle auf. Schema:
    • tableRange (Objekt, erforderlich): Tabellenbereich, der angibt, welche Zellen zusammengeführt werden sollen:
    • tableCellLocation (Objekt, erforderlich): Position der Referenzzelle:
      • tableStartLocation (Objekt, erforderlich): Speicherort, an dem die Tabelle im Dokument beginnt:
      • index (Ganzzahl, erforderlich): Nullbasierter Index für den Beginn der Tabelle in UTF-16-Codeeinheiten.
      • segmentId (String, optional): ID der Kopfzeile, Fußzeile oder Fußnote. Leer oder ausgelassen für den Dokumenttext.
      • tabId (String, optional): Tab, der die Tabelle enthält.
      • rowIndex (Ganzzahl, erforderlich): Nullbasierter Zeilenindex.
      • columnIndex (Ganzzahl, erforderlich): Nullbasierter Spaltenindex.
    • rowSpan (Ganzzahl, erforderlich): Zeilenbereich des Tabellenbereichs.
    • columnSpan (Ganzzahl, erforderlich): Spaltenbereich des Tabellenbereichs.
  • createHeader: Erstellt eine Überschrift. Schema:
    • type (String, erforderlich): Typ des Headers: "DEFAULT", "FIRST_PAGE".
    • sectionBreakLocation (Objekt, optional): Position des Abschnittswechsels, mit dem der Abschnitt beginnt, zu dem dieser Header gehört. Wenn nichts angegeben ist, gilt Folgendes für den Dokumentstil:
    • index (Ganzzahl, erforderlich): Nullbasierter Index in UTF-16-Codeeinheiten.
    • segmentId (String, optional): ID der Kopfzeile, Fußzeile oder Fußnote. Leer oder ausgelassen für den Dokumenttext.
    • tabId (String, optional): Tab, der den Abschnittswechsel enthält.
  • createFooter: Erstellt eine Fußzeile. Schema:
    • type (String, erforderlich): Art der Fußzeile: "DEFAULT", "FIRST_PAGE".
    • sectionBreakLocation (Objekt, optional): Position des Abschnittsumbruchs vor dem Abschnitt, zu dem diese Fußzeile gehört. Wenn nichts angegeben ist, gilt Folgendes für den Dokumentstil:
    • index (Ganzzahl, erforderlich): Nullbasierter Index in UTF-16-Codeeinheiten.
    • segmentId (String, optional): ID der Kopfzeile, Fußzeile oder Fußnote. Leer oder ausgelassen für den Dokumenttext.
    • tabId (String, optional): Tab, der den Abschnittswechsel enthält.
  • createFootnote: Erstellt eine Fußnote. Schema:
    • Speicherort des Fußnotenverweises (genau einer erforderlich):
    • location (object): Fügt eine Fußnotenreferenz an einem bestimmten Index ein:
      • index (Ganzzahl, erforderlich): Nullbasierter Index in UTF-16-Codeeinheiten.
      • tabId (string, optional): Der Tab, auf dem sich der Standort befindet.
    • endOfSegmentLocation (Objekt): Fügt am Ende des Dokumenttexts eine Fußnotenreferenz ein:
      • tabId (string, optional): Der Tab, auf dem sich der Standort befindet.
  • replaceNamedRangeContent: Ersetzt den Inhalt in einem benannten Bereich. Schema:
    • text (String, erforderlich): Text, durch den der Inhalt ersetzt werden soll.
    • Verweis auf benannten Bereich (genau einer erforderlich):
    • namedRangeId (String): ID des zu ersetzenden benannten Bereichs.
    • namedRangeName (String): Name der zu ersetzenden benannten Bereiche.
    • tabsCriteria (Objekt, optional):
    • tabIds (Array von Strings, optional): Die Liste der Tab-IDs, in denen der Ersatz erfolgt.
  • updateSectionStyle: Aktualisiert den Abschnittsstil des angegebenen Bereichs. Schema:
    • range (object, erforderlich): Bereiche mit sich überschneidenden Abschnitten, die formatiert werden sollen:
    • startIndex (Ganzzahl, optional): Nullbasierter Startindex des Bereichs.
    • endIndex (Ganzzahl, optional): Nullbasierter Endindex des Bereichs.
    • tabId (String, optional): Tab, der diesen Bereich enthält.
    • sectionStyle (Objekt, erforderlich): Eigenschaften für den Abschnittsstil:
    • columnProperties (optional, Array von Objekten): Eigenschaften für jede Spalte (bis zu 3 Spalten):
      • paddingEnd (Objekt, optional): Der Abstand am Ende der Spalte: {"magnitude": number, "unit": "PT"}.
      • width (Objekt, optional): Spaltenbreite: {"magnitude": number, "unit": "PT"}.
    • columnSeparatorStyle (String, optional): "NONE", "BETWEEN_EACH_COLUMN".
    • contentDirection (String, optional): "LEFT_TO_RIGHT", "RIGHT_TO_LEFT".
    • marginTop / marginBottom / marginLeft / marginRight / marginHeader / marginFooter (Objekt, optional): {"magnitude": number, "unit": "PT"}.
    • sectionType (String, optional): "CONTINUOUS", "NEXT_PAGE".
    • fields (String, erforderlich): Durch Kommas getrennte Liste der Felder, die aktualisiert werden sollen (z.B. "marginTop,sectionType" oder "*").
  • insertSectionBreak: Fügt an der angegebenen Stelle einen Abschnittsumbruch ein. Schema:
    • sectionType (String, erforderlich): Typ des Bereichs: "CONTINUOUS" oder "NEXT_PAGE".
    • Einfügeort (genau einer erforderlich):
    • location (Objekt): Fügt an einem bestimmten Index im Dokument einen Abschnittsumbruch ein:
      • index (Ganzzahl, erforderlich): Nullbasierter Index in UTF-16-Codeeinheiten.
      • tabId (string, optional): Der Tab, auf dem sich der Standort befindet.
    • endOfSegmentLocation (Objekt): Fügt am Ende des Dokumentinhalts einen Abschnittswechsel ein:
      • tabId (string, optional): Der Tab, auf dem sich der Standort befindet.
  • deleteHeader: Löscht eine Kopfzeile aus dem Dokument. Schema:
    • headerId (String, erforderlich): ID des zu löschenden Headers.
    • tabId (String, optional): Tab mit dem zu löschenden Header.
  • deleteFooter: Löscht eine Fußzeile aus dem Dokument. Schema:
    • footerId (String, erforderlich): ID der zu löschenden Fußzeile.
    • tabId (String, optional): Tab mit der zu löschenden Fußzeile.
  • pinTableHeaderRows: Aktualisiert die Anzahl der fixierten Kopfzeilen in einer Tabelle. Schema:
    • tableStartLocation (Objekt, erforderlich): Speicherort, an dem die Tabelle im Dokument beginnt:
    • index (Ganzzahl, erforderlich): Nullbasierter Index für den Beginn der Tabelle in UTF-16-Codeeinheiten.
    • segmentId (String, optional): ID der Kopfzeile, Fußzeile oder Fußnote. Leer oder ausgelassen für den Dokumenttext.
    • tabId (String, optional): Tab, der die Tabelle enthält.
    • pinnedHeaderRowsCount (Ganzzahl, erforderlich): Anzahl der anzupinnenden Tabellenzeilen (0 entfernt alle Fixierungen).
  • addDocumentTab: Fügt einen Dokument-Tab hinzu. Schema:
    • tabProperties (Objekt, optional): Eigenschaften des hinzuzufügenden Tabs:
    • tabId (string, optional): Vom Nutzer angegebene Tab-ID.
    • title (String, optional): Titel des Tabs.
    • index (Ganzzahl, optional): Nullbasierter Index, an dem der Tab eingefügt wird.
    • parentTabId (string, optional): ID des übergeordneten Tabs für verschachtelte Tabs.
    • iconEmoji (String, optional): Emoji-Symbol, das mit dem Tab angezeigt wird.
  • deleteTab: Löscht einen Dokument-Tab. Schema:
    • tabId (String, erforderlich): ID des zu löschenden Tabs.
  • updateDocumentTabProperties: Aktualisiert die Eigenschaften eines Dokument-Tabs. Schema:
    • tabProperties (Objekt, erforderlich): Tab-Attribute, die aktualisiert werden sollen:
    • tabId (String, erforderlich): ID des zu aktualisierenden Tabs.
    • title (String, optional): Aktualisierter Titel des Tabs.
    • index (Ganzzahl, optional): Aktualisierter nullbasierter Index des Tabs.
    • parentTabId (string, optional): Aktualisierte ID des übergeordneten Tabs.
    • iconEmoji (String, optional): Aktualisiertes Emoji-Symbol, das mit dem Tab angezeigt wird.
    • fields (String, erforderlich): Durch Kommas getrennte Liste der Felder, die aktualisiert werden sollen (z.B. "title,iconEmoji" oder "*").
  • insertPerson: Fügt eine Erwähnung einer Person ein. Schema:
    • personProperties (Objekt, erforderlich): Personenattribute:
    • email (String, erforderlich): E-Mail-Adresse der Person.
    • name (String, optional): Name der Person.
    • Einfügeort (genau einer erforderlich):
    • location (Objekt): Fügt eine Erwähnung einer Person an einer bestimmten Stelle ein:
      • index (Ganzzahl, erforderlich): Nullbasierter Index in UTF-16-Codeeinheiten.
      • segmentId (String, optional): Die ID der Kopfzeile, Fußzeile oder Fußnote. Leer für den Dokumenttext.
      • tabId (string, optional): Der Tab, auf dem sich der Standort befindet.
    • endOfSegmentLocation (Objekt): Fügt eine Erwähnung der Person am Ende der Kopfzeile, Fußzeile, Fußnote oder des Dokumenttexts ein:
      • segmentId (String, optional): Die ID der Kopfzeile, Fußzeile oder Fußnote. Leer für den Dokumenttext.
      • tabId (string, optional): Der Tab, auf dem sich der Standort befindet.
  • updateNamedStyle: Aktualisiert einen benannten Stil. Schema:
    • namedStyle (Objekt, erforderlich): Benannter Stil, der aktualisiert werden soll:
    • namedStyleType (String, erforderlich): Benannter Stiltyp: "NORMAL_TEXT", "TITLE", "SUBTITLE", "HEADING_1", "HEADING_2", "HEADING_3", "HEADING_4", "HEADING_5", "HEADING_6".
    • textStyle (Objekt, optional): Eigenschaften für den Textstil für diesen benannten Stil.
    • paragraphStyle (Objekt, optional): Absatzstileigenschaften für diesen benannten Stil.
    • fields (String, erforderlich): Durch Kommas getrennte Liste der Felder, die aktualisiert werden sollen (z.B. "textStyle,paragraphStyle" oder "*").
    • tabId (string, optional): Tab, der aktualisiert werden soll.
  • insertRichLink: Einen Rich-Link einfügen. Schema:
    • richLinkProperties (Objekt, erforderlich): Eigenschaften für Rich-Links:
    • uri (String, erforderlich): URI des Rich-Links.
    • title (String, optional): Titel des Rich-Links.
    • mimeType (String, optional): MIME-Typ des Rich-Links.
    • Einfügeort (genau einer erforderlich):
    • location (Objekt): Fügt einen Rich-Link an einer bestimmten Stelle ein:
      • index (Ganzzahl, erforderlich): Nullbasierter Index in UTF-16-Codeeinheiten.
      • segmentId (String, optional): Die ID der Kopfzeile, Fußzeile oder Fußnote. Leer für den Dokumenttext.
      • tabId (string, optional): Der Tab, auf dem sich der Standort befindet.
    • endOfSegmentLocation (Objekt): Fügt einen Rich-Link am Ende der Kopfzeile, Fußzeile, Fußnote oder des Dokumenttexts ein:
      • segmentId (String, optional): Die ID der Kopfzeile, Fußzeile oder Fußnote. Leer für den Dokumenttext.
      • tabId (string, optional): Der Tab, auf dem sich der Standort befindet.
  • insertDate: Fügt ein Datum ein. Schema:
    • dateElementProperties (Objekt, erforderlich): Datumseigenschaften:
    • timestamp (String, erforderlich): UTC-Zeitstempel.
    • timeZoneId (String, optional): Zeitzone (z.B. "America/New_York"). Der Standardwert ist "etc/UTC".
    • locale (String, optional): Gebietsschemacode (z.B. "en").
    • dateFormat (String, optional): "DATE_FORMAT_MONTH_DAY_ABBREVIATED", "DATE_FORMAT_MONTH_DAY_FULL", "DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED", "DATE_FORMAT_ISO8601".
    • timeFormat (String, optional): "TIME_FORMAT_DISABLED", "TIME_FORMAT_HOUR_MINUTE", "TIME_FORMAT_HOUR_MINUTE_TIMEZONE".
    • Einfügeort (genau einer erforderlich):
    • location (Objekt): Fügt das Datum an einer bestimmten Stelle ein:
      • index (Ganzzahl, erforderlich): Nullbasierter Index in UTF-16-Codeeinheiten.
      • segmentId (String, optional): Die ID der Kopfzeile, Fußzeile oder Fußnote. Leer für den Dokumenttext.
      • tabId (string, optional): Der Tab, auf dem sich der Standort befindet.
    • endOfSegmentLocation (Objekt): Fügt das Datum am Ende der Kopf- oder Fußzeile oder des Dokumentinhalts ein:
      • segmentId (String, optional): Die ID der Kopfzeile, Fußzeile oder Fußnote. Leer für den Dokumenttext.
      • tabId (string, optional): Der Tab, auf dem sich der Standort befindet.
  • insertComment: Fügt einen Kommentar in das Dokument ein. Schema:
    • content (String, erforderlich): Kommentarinhalt im Nur-Text-Format.
    • assigneeEmailAddress (string, optional): Die E-Mail-Adresse des Empfängers des Kommentars. Lassen Sie das Feld leer, wenn der Kommentar nicht zugewiesen werden soll.
    • Anker (genau einer erforderlich):
    • range (Objekt): Der Bereich im Dokument, an dem der Kommentar verankert werden soll:
      • startIndex (Ganzzahl, optional): Der nullbasierte Startindex dieses Bereichs.
      • endIndex (Ganzzahl, optional): Der nullbasierte Endindex dieses Bereichs.
      • segmentId (String, optional): Die ID der Kopfzeile, Fußzeile oder Fußnote. Leer für den Dokumenttext.
      • tabId (String, optional): Der Tab, der diesen Bereich enthält.
  • addCommentReply: Fügt einem vorhandenen Kommentar- oder Vorschlagsthread eine Antwort hinzu. Schema:
    • Thread-ID (genau eine erforderlich):
    • commentId (String): ID des Kommentar-Threads.
    • suggestionId (String): ID des Vorschlags-Threads.
    • post (Objekt, erforderlich):
    • content (String, erforderlich, sofern nicht geschlossen/wieder geöffnet): Antwortinhalt im Nur-Text-Format.
    • commentAction (String, optional): Aktion für Kommentar-Threads ("NO_COMMENT_ACTION_CHANGE", "RESOLVE", "REOPEN").
    • assigneeEmail (String, optional): Die E-Mail-Adresse des Nutzers, der diesem Beitrag entsprechend neu dem Thread zugewiesen wird.
  • updateCommentPost: Aktualisiert den Inhalt eines Kommentarbeitrags in einem Kommentar- oder Vorschlagsthread. Schema:
    • Thread-ID (genau eine erforderlich):
    • commentId (String): ID des Kommentar-Threads.
    • suggestionId (String): ID des Vorschlags-Threads.
    • postId (string, erforderlich): ID des zu aktualisierenden Kommentarbeitrags.
    • content (String, erforderlich): Der aktualisierte Inhalt des Kommentarbeitrags.
  • deleteComment: Löscht einen Kommentarbereich. Schema:
    • commentId (string, erforderlich): ID des zu löschenden Kommentar-Threads.
  • deleteCommentReply: Löscht einen Antwortbeitrag aus einem Kommentar- oder Vorschlagsthread. Schema:
    • Thread-ID (genau eine erforderlich):
    • commentId (String): ID des Kommentar-Threads.
    • suggestionId (String): ID des Vorschlags-Threads.
    • postId (String, erforderlich): ID des zu löschenden Antwortbeitrags.
  • acceptSuggestion: Nimmt einen Vorschlag an. Schema:
    • suggestionId (String, erforderlich): ID des Vorschlags, der akzeptiert werden soll.
  • rejectSuggestion: Lehnt einen Vorschlag ab. Schema:
    • suggestionId (String, erforderlich): ID des abzulehnenden Vorschlags.
  • deleteSuggestion: Löscht einen Vorschlag. Schema:
    • suggestionId (String, erforderlich): ID des zu löschenden Vorschlags.

Das folgende Codebeispiel zeigt, wie Sie mit curl das MCP-Tool update_doc aufrufen.

Curl-Anfrage
curl --location 'https://docsmcp.googleapis.com/mcp/v1' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "update_doc",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Eingabeschema

UpdateDocRequest

JSON-Darstellung
{
  "documentId": string,
  "requests": [
    {
      object
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Felder
documentId

string

Erforderlich. Die ID des zu aktualisierenden Dokuments. Dies entspricht der file_id aus Drive-Tools.

requests[]

object (Struct format)

Eine Liste der Aktualisierungen, die auf das Dokument angewendet werden sollen. Jede Anfrage muss ein gültiges documents.batchUpdate-Anfrageobjekt sein, das dem in https://developers.google.com/workspace/docs/api/reference/rest/v1/documents/request dokumentierten Schema entspricht. Anfragen werden in der angegebenen Reihenfolge angewendet. Wenn eine Anfrage ungültig ist, werden keine Anfragen angewendet.

writeControl

object (WriteControl)

Optional. Bietet Kontrolle darüber, wie Schreibanfragen ausgeführt werden.

Struct

JSON-Darstellung
{
  "fields": {
    string: value,
    ...
  }
}
Felder
fields

map (key: string, value: value (Value format))

Ungeordnete Zuordnung von dynamisch typisierten Werten.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

JSON-Darstellung
{
  "key": string,
  "value": value
}
Felder
key

string

value

value (Value format)

Wert

JSON-Darstellung
{

  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
}
Felder
Union-Feld kind. Die Art des Werts. Für kind ist nur einer der folgenden Werte zulässig:
nullValue

null

Stellt ein JSON-null dar.

numberValue

number

Stellt eine JSON-Zahl dar. Darf nicht NaN, Infinity oder -Infinity sein, da diese in JSON nicht unterstützt werden. Auch große Int64-Werte können nicht dargestellt werden, da das JSON-Format sie in seinem Zahlentyp im Allgemeinen nicht unterstützt.

stringValue

string

Stellt einen JSON-String dar.

boolValue

boolean

Stellt einen booleschen JSON-Wert dar (true- oder false-Literal in JSON).

structValue

object (Struct format)

Stellt ein JSON-Objekt dar.

listValue

array (ListValue format)

Stellt ein JSON-Array dar.

ListValue

JSON-Darstellung
{
  "values": [
    value
  ]
}
Felder
values[]

value (Value format)

Wiederkehrendes Feld mit dynamisch typisierten Werten.

WriteControl

JSON-Darstellung
{
  "writeMode": enum (WriteMode),

  "requiredRevisionId": string,
  "targetRevisionId": string
}
Felder
writeMode

enum (WriteMode)

Optional. Der Schreibmodus der Anfrage.

Union-Feld control. Bestimmt die Version des Dokuments, in die geschrieben werden soll, und wie sich die Anfrage verhalten soll, wenn diese Version nicht die aktuelle Version des Dokuments ist. Für control ist nur einer der folgenden Werte zulässig:
requiredRevisionId

string

Die Revisions-ID des Dokuments, auf das der Schreibvorgang angewendet wird. Wenn es sich nicht um die aktuelle Version des Dokuments handelt, wird die Anfrage nicht verarbeitet und es wird der Fehler „400 Bad Request“ zurückgegeben.

Wenn in einer Antwort eine erforderliche Revisions-ID zurückgegeben wird, gibt sie die Revisions-ID des Dokuments nach der Anwendung der Anfrage an.

targetRevisionId

string

Die Zielversions-ID des Dokuments, auf das die Schreibanfrage angewendet wird. Wenn nach dem Abrufen der Zielversions-ID Änderungen durch Mitbearbeiter vorgenommen wurden, kann das zu einem anderen Ergebnis führen, als wenn die Änderungen auf die Zielversions-ID angewendet worden wären.

Wenn eine Zielüberarbeitungs-ID angegeben wird, wird die Schreibanfrage basierend auf der Zielüberarbeitungs-ID angewendet und die Überarbeitungs-ID des Dokuments wird um 1 erhöht.

Wenn Sie keine Zielversions-ID angeben, wird die Schreibanfrage auf die neueste Versions-ID angewendet und die Versions-ID des Dokuments wird um 1 erhöht.

Wenn in einer Antwort eine Zielversions-ID zurückgegeben wird, gibt sie die Versions-ID des Dokuments nach der Anwendung der Anfrage an.

NullValue

Stellt ein JSON-null dar.

NullValue ist ein Sentinel, der einen Enum mit nur einem Wert verwendet, um den Nullwert für die Typvereinigung Value darzustellen.

Ein Feld vom Typ NullValue mit einem anderen Wert als 0 gilt als ungültig. Die meisten ProtoJSON-Serialisierer geben ein Value mit einem als JSON-null festgelegten null_value aus, unabhängig vom Ganzzahlwert, und führen so zu einem Roundtrip zu einem 0-Wert.

Enums
NULL_VALUE Nullwert.

WriteMode

Der Modus für Schreibanfragen.

Enums
WRITE_MODE_UNSPECIFIED Der Standardschreibmodus. Eine Anfrage ohne angegebenen Schreibmodus wird als EDIT behandelt.
EDIT Änderungen werden direkt auf das Dokument angewendet.
SUGGEST Änderungen werden als Vorschläge vorgenommen.

Ausgabeschema

UpdateDocResponse

JSON-Darstellung
{
  "replies": [
    {
      object
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Felder
replies[]

object (Struct format)

Die Antworten auf die Ausführung der Batch-Update-Anfragen. Enthält Fehler, Warnungen und Roh-API-Antworten, damit das Modell Anpassungen vornehmen kann. Die Roh-API-Antworten verwenden das in https://developers.google.com/workspace/docs/api/reference/rest/v1/documents/response dokumentierte Schema.

writeControl

object (WriteControl)

Die Version des Dokuments nach den vorgenommenen Aktualisierungen. Übergeben Sie write_control.required_revision_id in der nächsten update_doc-Anfrage, um den Schreibvorgang abzulehnen, wenn sich das Dokument zwischenzeitlich geändert hat.

Struct

JSON-Darstellung
{
  "fields": {
    string: value,
    ...
  }
}
Felder
fields

map (key: string, value: value (Value format))

Ungeordnete Zuordnung von dynamisch typisierten Werten.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

JSON-Darstellung
{
  "key": string,
  "value": value
}
Felder
key

string

value

value (Value format)

Wert

JSON-Darstellung
{

  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
}
Felder
Union-Feld kind. Die Art des Werts. Für kind ist nur einer der folgenden Werte zulässig:
nullValue

null

Stellt ein JSON-null dar.

numberValue

number

Stellt eine JSON-Zahl dar. Darf nicht NaN, Infinity oder -Infinity sein, da diese in JSON nicht unterstützt werden. Auch große Int64-Werte können nicht dargestellt werden, da das JSON-Format sie in seinem Zahlentyp im Allgemeinen nicht unterstützt.

stringValue

string

Stellt einen JSON-String dar.

boolValue

boolean

Stellt einen booleschen JSON-Wert dar (true- oder false-Literal in JSON).

structValue

object (Struct format)

Stellt ein JSON-Objekt dar.

listValue

array (ListValue format)

Stellt ein JSON-Array dar.

ListValue

JSON-Darstellung
{
  "values": [
    value
  ]
}
Felder
values[]

value (Value format)

Wiederkehrendes Feld mit dynamisch typisierten Werten.

WriteControl

JSON-Darstellung
{
  "writeMode": enum (WriteMode),

  "requiredRevisionId": string,
  "targetRevisionId": string
}
Felder
writeMode

enum (WriteMode)

Optional. Der Schreibmodus der Anfrage.

Union-Feld control. Bestimmt die Version des Dokuments, in die geschrieben werden soll, und wie sich die Anfrage verhalten soll, wenn diese Version nicht die aktuelle Version des Dokuments ist. Für control ist nur einer der folgenden Werte zulässig:
requiredRevisionId

string

Die Revisions-ID des Dokuments, auf das der Schreibvorgang angewendet wird. Wenn es sich nicht um die aktuelle Version des Dokuments handelt, wird die Anfrage nicht verarbeitet und es wird der Fehler „400 Bad Request“ zurückgegeben.

Wenn in einer Antwort eine erforderliche Revisions-ID zurückgegeben wird, gibt sie die Revisions-ID des Dokuments nach der Anwendung der Anfrage an.

targetRevisionId

string

Die Zielversions-ID des Dokuments, auf das die Schreibanfrage angewendet wird. Wenn nach dem Abrufen der Zielversions-ID Änderungen durch Mitbearbeiter vorgenommen wurden, kann das zu einem anderen Ergebnis führen, als wenn die Änderungen auf die Zielversions-ID angewendet worden wären.

Wenn eine Zielüberarbeitungs-ID angegeben wird, wird die Schreibanfrage basierend auf der Zielüberarbeitungs-ID angewendet und die Überarbeitungs-ID des Dokuments wird um 1 erhöht.

Wenn Sie keine Zielversions-ID angeben, wird die Schreibanfrage auf die neueste Versions-ID angewendet und die Versions-ID des Dokuments wird um 1 erhöht.

Wenn in einer Antwort eine Zielversions-ID zurückgegeben wird, gibt sie die Versions-ID des Dokuments nach der Anwendung der Anfrage an.

NullValue

Stellt ein JSON-null dar.

NullValue ist ein Sentinel, der einen Enum mit nur einem Wert verwendet, um den Nullwert für die Typvereinigung Value darzustellen.

Ein Feld vom Typ NullValue mit einem anderen Wert als 0 gilt als ungültig. Die meisten ProtoJSON-Serialisierer geben ein Value mit einem als JSON-null festgelegten null_value aus, unabhängig vom Ganzzahlwert, und führen so zu einem Roundtrip zu einem 0-Wert.

Enums
NULL_VALUE Nullwert.

WriteMode

Der Modus für Schreibanfragen.

Enums
WRITE_MODE_UNSPECIFIED Der Standardschreibmodus. Eine Anfrage ohne angegebenen Schreibmodus wird als EDIT behandelt.
EDIT Änderungen werden direkt auf das Dokument angewendet.
SUGGEST Änderungen werden als Vorschläge vorgenommen.

Tool-Annotationen

Tool-Anmerkungen werden an MCP-Clients gesendet, um das grundlegende Risiko eines bestimmten Tools zu beschreiben. Die meisten Clients behandeln diese Hinweise als nicht vertrauenswürdig, sie können aber verwendet werden, um zu entscheiden, wann ein Bestätigungs-Prompt an einen Nutzer gesendet werden soll.

Zusammen mit dem Titelstring werden die folgenden booleschen Hinweise so definiert:

  • readOnlyHint: Wenn „true“, ändert das Tool seine Umgebung nicht. Standardeinstellung: false.
  • destructiveHint: Wenn „true“, kann das Tool destruktive Aktionen ausführen. Wenn „false“, kann das Tool nur additive Aktionen ausführen. Standardeinstellung: true.
  • idempotentHint: Wenn „true“, hat das wiederholte Aufrufen des Tools mit denselben Argumenten keine zusätzlichen Auswirkungen auf die Umgebung. Standardeinstellung: false.
  • openWorldHint: Wenn „true“, kann das Tool mit einer „offenen Welt“ externer Einheiten interagieren. Wenn „false“, kann das Tool nur mit internen Einheiten interagieren. Ein Tool für die Websuche wäre beispielsweise Open World, ein Tool für das Gedächtnis nicht.

Destruktiver Hinweis: ❌ | Idempotenter Hinweis: ❌ | Hinweis „Nur lesen“: ❌ | Hinweis „Offene Welt“: ✅

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/documents