MCP Tools Reference: sheetsmcp.googleapis.com

כלי: update_spreadsheet

החלת עדכון אחד או יותר על הגיליון האלקטרוני.

תואם ל-spreadsheets.batchUpdate ב-API בארכיטקטורת REST‏: https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/batchUpdate

רשימת העדכונים האפשריים:

  • ‫updateSpreadsheetProperties: עדכון המאפיינים של הגיליון האלקטרוני. סכימה:
  • ‫properties (אובייקט, חובה): מאפייני הגיליון האלקטרוני שצריך לעדכן ({"title": string, "locale": string, "timeZone": string}).
  • ‫fields (מחרוזת, חובה): אנונימיזציה של שדות של מאפיינים לעדכון (למשל, "title" או "*").
  • ‫updateSheetProperties: עדכון המאפיינים של גיליון. סכימה:
  • ‫properties (אובייקט, חובה): מאפייני הגיליון ({"sheetId": int, "title": string, "index": int, "gridProperties": {"rowCount": int, "columnCount": int, "frozenRowCount": int, "frozenColumnCount": int, "hideGridlines": bool}, "hidden": bool, "tabColorStyle": {"rgbColor": {"red": float, "green": float, "blue": float}}}).
  • ‫fields (מחרוזת, חובה): מסכת שדות של מאפיינים לעדכון (למשל "title", "gridProperties.frozenRowCount").
  • ‫updateDimensionProperties: עדכון מאפיינים של מימדים (למשל, גובה שורה או רוחב עמודה). סכימה:
  • ‫range (אובייקט, חובה): טווח המאפיינים ({"sheetId": int, "dimension": "ROWS"|"COLUMNS", "startIndex": int, "endIndex": int}).
  • ‫properties (אובייקט, חובה): מאפייני המאפיין ({"pixelSize": int, "hiddenByUser": bool}).
  • ‫fields (מחרוזת, חובה): מסכת שדות של מאפיינים לעדכון (למשל, "pixelSize").
  • ‫updateNamedRange: עדכון של טווח תאים בעל שם. סכימה:
  • ‫namedRange (אובייקט, חובה): הגדרת טווח תאים בעל שם ({"namedRangeId": string, "name": string, "range": {"sheetId": int, "startRowIndex": int, "endRowIndex": int, "startColumnIndex": int, "endColumnIndex": int}}).
  • ‫fields (מחרוזת, חובה): מסכת שדות של השדות שרוצים לעדכן (למשל "name,range" או "*").
  • ‫repeatCell: חזרה על תא אחד בטווח. סכימה:
  • range (אובייקט, חובה): טווח הרשת שעליו רוצים להחיל את הנתונים או העיצוב של התאים ({"sheetId": int, "startRowIndex": int, "endRowIndex": int, "startColumnIndex": int, "endColumnIndex": int}).
  • ‫cell (אובייקט, חובה): נתוני תא ({"userEnteredValue": {"stringValue": str, "numberValue": float, "formulaValue": str}, "userEnteredFormat": {"textFormat": {"bold": bool, "italic": bool, "fontSize": int}, "backgroundColorStyle": {"rgbColor": {"red": float, "green": float, "blue": float}}, "horizontalAlignment": "LEFT"|"CENTER"|"RIGHT", "wrapStrategy": "WRAP"|"CLIP"|"OVERFLOW_CELL"}}).
  • ‫fields (מחרוזת, חובה): אנונימיזציה של שדות התאים שרוצים לעדכן (למשל "userEnteredFormat.textFormat.bold" או "userEnteredValue").
  • ‫addNamedRange: הוספת טווח תאים בעל שם. סכימה:
  • ‫namedRange (אובייקט, חובה): טווח תאים בעל שם שרוצים להוסיף ({"namedRangeId": string (optional), "name": string, "range": {"sheetId": int, "startRowIndex": int, "endRowIndex": int, "startColumnIndex": int, "endColumnIndex": int}}).
  • ‫deleteNamedRange: מחיקת טווח תאים בעל שם לפי המזהה שלו. סכימה:
  • ‫namedRangeId (מחרוזת, חובה): המזהה של טווח התאים בעל השם שרוצים למחוק.
  • ‫addSheet: הוספת גיליון. סכימה:
  • ‫properties (אובייקט, אופציונלי): מאפייני הגיליון ({"title": string, "sheetId": int (optional), "index": int (optional), "gridProperties": {"rowCount": int, "columnCount": int}}).
  • ‫deleteSheet: מחיקת גיליון. סכימה:
  • ‫sheetId (מספר שלם, חובה): מזהה הגיליון שרוצים למחוק.
  • autoFill: מילוי אוטומטי של נתונים נוספים על סמך נתונים קיימים. סכימה:
  • ‫range (אובייקט, אופציונלי): הטווח שצריך לבדוק ולמלא ({"sheetId": int, "startRowIndex": int, "endRowIndex": int, "startColumnIndex": int, "endColumnIndex": int}).
  • ‫sourceAndDestination (אובייקט, אופציונלי): מקור מפורש ואורך מילוי ({"source": GridRange, "dimension": "ROWS"|"COLUMNS", "fillLength": int}).
  • ‫useAlternateSeries (ערך בוליאני, אופציונלי): אם להשתמש בסדרות חלופיות.
  • cutPaste: גזירת נתונים מאזור אחד והדבקה שלהם באזור אחר. סכימה:
  • ‫source (אובייקט, חובה): טווח הרשת של המקור.
  • ‫destination (אובייקט, חובה): הקואורדינטה של הפינה השמאלית העליונה של היעד ({"sheetId": int, "rowIndex": int, "columnIndex": int}).
  • ‫pasteType (מחרוזת, אופציונלי): "PASTE_NORMAL", "PASTE_VALUES", "PASTE_FORMAT", "PASTE_NO_BORDERS", "PASTE_FORMULA".
  • copyPaste: מעתיק נתונים מאזור אחד ומדביק אותם באזור אחר. סכימה:
  • ‫source (אובייקט, חובה): טווח הרשת של המקור.
  • destination (אובייקט, חובה): טווח הרשת של היעד.
  • ‫pasteType (מחרוזת, אופציונלי): "PASTE_NORMAL", "PASTE_VALUES", "PASTE_FORMAT", "PASTE_NO_BORDERS", "PASTE_FORMULA".
  • pasteOrientation (מחרוזת, אופציונלי): "NORMAL" או "TRANSPOSE".
  • ‫mergeCells: מיזוג תאים. סכימה:
  • ‫range (אובייקט, חובה): טווח המשבצות למיזוג.
  • ‫mergeType (מחרוזת, חובה): "MERGE_ALL",‏ "MERGE_COLUMNS" או "MERGE_ROWS".
  • ‫unmergeCells: ביטול המיזוג של תאים שמוזגו. סכימה:
  • range (אובייקט, חובה): טווח הרשת שבו רוצים לבטל את המיזוג של כל התאים.
  • ‫updateBorders: עדכון הגבולות בטווח של תאים. סכימה:
  • ‫range (אובייקט, חובה): טווח הרשת שבו רוצים לעדכן את הגבולות.
  • ‫top / bottom / left / right / innerHorizontal / innerVertical (אובייקט, אופציונלי): סגנון הגבול ({"style": "SOLID"|"DASHED"|"DOTTED"|"DOUBLE"|"NONE", "width": int, "colorStyle": {"rgbColor": {"red": float, "green": float, "blue": float}}}).
  • ‫updateCells: עדכון של הרבה תאים בבת אחת. סכימה:
  • אזור (חובה לציין בדיוק אחד):
    • ‫start (אובייקט): הקואורדינטה בפינה השמאלית העליונה ({"sheetId": int, "rowIndex": int, "columnIndex": int}).
    • ‫range (אובייקט): טווח הרשת.
  • ‫rows (מערך של RowData, חובה): שורות של תאים ([{"values": [{"userEnteredValue": {"stringValue": str, "numberValue": float, "formulaValue": str}}]}]).
  • ‫fields (מחרוזת, חובה): מסכת שדות של שדות תאים לעדכון (למשל "userEnteredValue" או "userEnteredFormat").
  • ‫addFilterView: הוספת תצוגה מסוננת. סכימה:
  • ‫filter (אובייקט, חובה): הגדרת תצוגה מסוננת ({"title": string, "range": GridRange, "criteria": map, "sortSpecs": list}).
  • ‫appendCells: הוספת תאים אחרי השורה האחרונה שמכילה נתונים בגיליון. סכימה:
  • ‫sheetId (מספר שלם, חובה): מזהה הגיליון שאליו רוצים להוסיף נתונים.
  • ‫rows (מערך של RowData, חובה): שורות של נתונים שרוצים להוסיף.
  • ‫fields (מחרוזת, חובה): אנונימיזציה של שדות (למשל "userEnteredValue").
  • ‫clearBasicFilter: ניקוי המסנן הבסיסי בגיליון. סכימה:
  • ‫sheetId (מספר שלם, חובה): מזהה הגיליון שבו רוצים לנקות את המסנן הבסיסי.
  • deleteDimension: מחיקת שורות או עמודות בגיליון. סכימה:
  • ‫range (אובייקט, חובה): טווח המאפיינים למחיקה ({"sheetId": int, "dimension": "ROWS"|"COLUMNS", "startIndex": int, "endIndex": int}).
  • ‫deleteEmbeddedObject: מחיקת אובייקט מוטמע (למשל תרשים או תמונה) בגיליון. סכימה:
  • ‫objectId (מספר שלם, חובה): המזהה של האובייקט המוטמע שרוצים למחוק.
  • ‫deleteFilterView: מחיקת תצוגה מסוננת מגיליון. סכימה:
  • ‫filterId (מספר שלם, חובה): המזהה של התצוגה המסוננת שרוצים למחוק.
  • ‫duplicateFilterView: שכפול של תצוגה מסוננת. סכימה:
  • ‫filterId (מספר שלם, חובה): המזהה של התצוגה המסוננת שרוצים לשכפל.
  • ‫duplicateSheet: שכפול גיליון. סכימה:
  • ‫sourceSheetId (מספר שלם, חובה): מזהה הגיליון שרוצים לשכפל.
  • insertSheetIndex (מספר שלם, אופציונלי): אינדקס שמתחיל מ-0 שבו צריך להוסיף את הגיליון החדש.
  • ‫newSheetId (מספר שלם, אופציונלי): מזהה הגיליון החדש.
  • newSheetName (מחרוזת, אופציונלי): שם הגיליון החדש.
  • ‫findReplace: חיפוש והחלפה של מופעים של טקסט מסוים בטקסט אחר. סכימה:
  • ‫find (מחרוזת, חובה): הערך שרוצים לחפש.
  • replacement (מחרוזת, חובה): הערך החלופי.
  • היקף (צריך לבחור בדיוק אחד):
    • ‫range (אובייקט): טווח הרשת.
    • ‫sheetId (מספר שלם): מזהה הגיליון.
    • ‫allSheets (בוליאני): true כדי לחפש בכל הגיליונות.
  • ‫matchCase / matchEntireCell / searchByRegex / includeFormulas (ערך בוליאני, אופציונלי).
  • ‫insertDimension: הוספת שורות או עמודות חדשות בגיליון. סכימה:
  • ‫range (אובייקט, חובה): טווח המאפיינים שרוצים להוסיף ({"sheetId": int, "dimension": "ROWS"|"COLUMNS", "startIndex": int, "endIndex": int}).
  • ‫inheritFromBefore (ערך בוליאני, אופציונלי): true כדי לרשת את העיצוב מהשורה או מהעמודה הקודמת.
  • ‫insertRange: הוספת תאים חדשים בגיליון והזזת התאים הקיימים. סכימה:
  • range (אובייקט, חובה): טווח הרשת שאליו רוצים להוסיף תאים.
  • shiftDimension (מחרוזת, חובה): "ROWS" או "COLUMNS".
  • ‫moveDimension: העברת שורות או עמודות למיקום אחר בגיליון. סכימה:
  • ‫source (אובייקט, חובה): טווח המאפיינים של המקור ({"sheetId": int, "dimension": "ROWS"|"COLUMNS", "startIndex": int, "endIndex": int}).
  • ‫destinationIndex (מספר שלם, חובה): אינדקס היעד, החל מ-0.
  • ‫updateEmbeddedObjectPosition: עדכון המיקום של אובייקט מוטמע (למשל: תרשים, תמונה). סכימה:
  • ‫objectId (מספר שלם, חובה): המזהה של האובייקט המוטמע.
  • ‫newPosition (אובייקט, חובה): מיקום חדש ({"overlayPosition": {"anchorCell": {"sheetId": int, "rowIndex": int, "columnIndex": int}, "widthPixels": int, "heightPixels": int}}).
  • ‫fields (מחרוזת, חובה): אנונימיזציה של שדות (למשל "overlayPosition.anchorCell").
  • pasteData: הדבקת נתונים (HTML או מופרדים) בגיליון. סכימה:
  • ‫coordinate (אובייקט, חובה): הקואורדינטה בפינה השמאלית העליונה ({"sheetId": int, "rowIndex": int, "columnIndex": int}).
  • data (מחרוזת, חובה): טקסט מופרד או נתוני HTML.
  • ‫delimiter (מחרוזת, אופציונלי) או html (בוליאני, אופציונלי).
  • type (מחרוזת, אופציונלי): "PASTE_NORMAL", "PASTE_VALUES" וכו'.
  • textToColumns: המרה של עמודת טקסט אחת לכמה עמודות טקסט. סכימה:
  • source (אובייקט, חובה): טווח רשת של עמודה אחת.
  • ‫delimiterType (מחרוזת, חובה): "COMMA", "SEMICOLON", "PERIOD", "SPACE", "CUSTOM", "AUTODETECT".
  • delimiter (מחרוזת, אופציונלי): תו מפריד כש-delimiterType הוא "CUSTOM".
  • ‫updateFilterView: עדכון המאפיינים של תצוגה מסוננת. סכימה:
  • ‫filter (אובייקט, חובה): הגדרת התצוגה המסוננת, כולל filterViewId.
  • ‫fields (מחרוזת, חובה): אנונימיזציה של שדות (למשל "title,criteria" או "*").
  • ‫deleteRange: מחיקת טווח של תאים מגיליון והזזת התאים שנותרו. סכימה:
  • ‫range (אובייקט, חובה): טווח המשבצות שרוצים למחוק.
  • shiftDimension (מחרוזת, חובה): "ROWS" או "COLUMNS".
  • ‫appendDimension: הוספת מאפיינים לסוף הגיליון. סכימה:
  • ‫sheetId (מספר שלם, חובה): מזהה הגיליון.
  • dimension (מחרוזת, חובה): "ROWS" או "COLUMNS".
  • length (מספר שלם, חובה): מספר השורות או העמודות שרוצים להוסיף.
  • ‫addConditionalFormatRule: הוספת כלל חדש לעיצוב מותנה. סכימה:
  • rule (אובייקט, חובה): כלל עיצוב מותנה ({"ranges": [GridRange], "booleanRule": {"condition": {"type": "NUMBER_GREATER_THAN_EQ"|"TEXT_CONTAINS"|..., "values": [{"userEnteredValue": string}]}, "format": CellFormat}, "gradientRule": {...}}).
  • ‫index (מספר שלם, אופציונלי): אינדקס שמתחיל מ-0 שבו צריך להוסיף את הכלל.
  • ‫updateConditionalFormatRule: עדכון של כלל קיים של עיצוב מותנה. סכימה:
  • rule (אובייקט, חובה): כלל חדש של עיצוב מותנה.
  • אינדקס / מזהה כלל (חובה להזין אחד מהם):
    • index (מספר שלם): אינדקס של הכלל שמתחיל בספרה אפס.
    • ‫sheetId (מספר שלם): מזהה הגיליון, אם מעדכנים לפי אינדקס הגיליון.
  • ‫newIndex (מספר שלם, אופציונלי): אינדקס חדש להעברת הכלל.
  • ‫deleteConditionalFormatRule: מחיקת כלל קיים של עיצוב מותנה. סכימה:
  • ‫index (מספר שלם, חובה): אינדקס מבוסס-אפס של הכלל שרוצים למחוק.
  • ‫sheetId (מספר שלם, חובה): מזהה הגיליון של הכלל.
  • ‫sortRange: מיון נתונים בטווח. סכימה:
  • ‫range (אובייקט, חובה): טווח הרשת למיון.
  • ‫sortSpecs (מערך של SortSpec, חובה): מפרטי מיון ([{"dimensionIndex": int, "sortOrder": "ASCENDING"|"DESCENDING"}]).
  • ‫setDataValidation: הגדרת אימות נתונים לתא אחד או יותר. סכימה:
  • ‫range (אובייקט, חובה): טווח הרשת.
  • rule (אובייקט, אופציונלי): כלל אימות ({"condition": {"type": "ONE_OF_LIST"|"NUMBER_BETWEEN"|..., "values": [{"userEnteredValue": string}]}, "strict": bool, "showCustomUi": bool}). אם משמיטים את הפרמטר הזה, האימות נמחק.
  • ‫setBasicFilter: הגדרת המסנן הבסיסי בגיליון. סכימה:
  • ‫filter (אובייקט, חובה): הגדרת מסנן בסיסית ({"range": GridRange, "criteria": map, "sortSpecs": list}).
  • ‫addProtectedRange: הוספת טווח תאים מוגן. סכימה:
  • ‫protectedRange (אובייקט, חובה): הגדרת טווח מוגן ({"range": GridRange, "description": string, "warningOnly": bool, "editors": {"users": [string]}}).
  • ‫updateProtectedRange: עדכון של טווח תאים מוגן. סכימה:
  • ‫protectedRange (אובייקט, חובה): הגדרת טווח מוגן עם protectedRangeId.
  • ‫fields (מחרוזת, חובה): אנונימיזציה של שדות (למשל "description,warningOnly" או "*").
  • ‫deleteProtectedRange: מחיקת טווח מוגן. סכימה:
  • ‫protectedRangeId (מספר שלם, חובה): המזהה של טווח התאים המוגן שרוצים למחוק.
  • ‫autoResizeDimensions: משנה באופן אוטומטי את הגודל של מאפיין אחד או יותר על סמך תוכן התא. סכימה:
  • ‫dimensions (אובייקט, חובה): טווח המאפיינים ({"sheetId": int, "dimension": "ROWS"|"COLUMNS", "startIndex": int, "endIndex": int}).
  • ‫addChart: הוספת תרשים. סכימה:
  • ‫chart (אובייקט, חובה): הגדרת התרשים ({"spec": {"title": string, "basicChart": {"chartType": "COLUMN"|"BAR"|"LINE"|"PIE"|"COMBO"|"SCATTER", "legendPosition": string, "axis": list, "domains": list, "series": list}}, "position": {"overlayPosition": {"anchorCell": {"sheetId": int, "rowIndex": int, "columnIndex": int}}}}).
  • updateChartSpec: עדכון המפרט של תרשים. סכימה:
  • ‫chartId (מספר שלם, חובה): מזהה התרשים.
  • ‫spec (אובייקט, חובה): מפרט חדש של תרשים.
  • ‫updateBanding: עדכון של טווח עם פסים. סכימה:
  • ‫bandedRange (אובייקט, חובה): הגדרת טווח עם פסים באמצעות bandedRangeId.
  • ‫fields (מחרוזת, חובה): אנונימיזציה של שדות.
  • ‫addBanding: הוספת טווח חדש של שורות או עמודות לסירוגין. סכימה:
  • ‫bandedRange (אובייקט, חובה): הגדרת טווח עם פסים ({"range": GridRange, "rowProperties": {"headerColorStyle": ColorStyle, "firstBandColorStyle": ColorStyle, "secondBandColorStyle": ColorStyle}}).
  • ‫deleteBanding: הסרת טווח עם פסים. סכימה:
  • ‫bandedRangeId (מספר שלם, חובה): המזהה של טווח הצבעים למחיקה.
  • ‫createDeveloperMetadata: יצירת מטא-נתונים חדשים למפתחים. סכימה:
  • ‫developerMetadata (אובייקט, חובה): הגדרת מטא-נתונים ({"metadataKey": string, "metadataValue": string, "location": {"locationType": "ROW"|"COLUMN"|"SHEET"|"SPREADSHEET", "sheetId": int}, "visibility": "DOCUMENT"|"PROJECT"}).
  • ‫updateDeveloperMetadata: עדכון של רשומת מטא-נתונים קיימת של מפתחים. סכימה:
  • ‫dataFilters (מערך של DataFilter, חובה): מסננים לבחירת מטא-נתונים.
  • ‫developerMetadata (אובייקט, חובה): ערכי המטא-נתונים המעודכנים.
  • ‫fields (מחרוזת, חובה): אנונימיזציה של שדות.
  • ‫deleteDeveloperMetadata: מחיקת מטא-נתונים של מפתחים. סכימה:
  • ‫dataFilter (אובייקט, חובה): מסנן שמתאר את הקריטריונים למחיקת המטא-נתונים.
  • ‫randomizeRange: משנה באופן אקראי את סדר השורות בטווח. סכימה:
  • range (אובייקט, חובה): טווח המשבצות שרוצים לשנות את הסדר שלהן באופן אקראי.
  • addDimensionGroup: יצירת קבוצה בטווח שצוין. סכימה:
  • ‫range (אובייקט, חובה): טווח המאפיינים לקיבוץ ({"sheetId": int, "dimension": "ROWS"|"COLUMNS", "startIndex": int, "endIndex": int}).
  • ‫deleteDimensionGroup: מחיקת קבוצה בטווח שצוין. סכימה:
  • ‫range (אובייקט, חובה): טווח המאפיינים של הקבוצה שרוצים למחוק.
  • ‫updateDimensionGroup: עדכון המצב של הקבוצה שצוינה. סכימה:
  • ‫dimensionGroup (אובייקט, חובה): הגדרת קבוצה ({"range": DimensionRange, "depth": int, "collapsed": bool}).
  • ‫fields (מחרוזת, חובה): אנונימיזציה של שדות (למשל "collapsed").
  • ‫trimWhitespace: הסרת רווחים לבנים (כמו רווחים, טאבים או שורות חדשות) מתאים. סכימה:
  • ‫range (אובייקט, חובה): טווח הרשת שהתאים שלו יקוצצו.
  • ‫deleteDuplicates: הסרת שורות שמכילות ערכים כפולים בעמודות שצוינו בטווח תאים. סכימה:
  • ‫range (אובייקט, חובה): טווח המשבצות שממנו רוצים להסיר כפילויות.
  • comparisonColumns (מערך של DimensionRange, אופציונלי): עמודות ספציפיות לניתוח.
  • ‫updateEmbeddedObjectBorder: עדכון הגבול של אובייקט מוטמע. סכימה:
  • ‫objectId (מספר שלם, חובה): המזהה של האובייקט המוטמע.
  • ‫border (אובייקט, חובה): הגדרת גבול ({"colorStyle": ColorStyle, "section": "ALL"}).
  • ‫fields (מחרוזת, חובה): אנונימיזציה של שדות.
  • ‫addSlicer: הוספת כלי סינון. סכימה:
  • ‫slicer (אובייקט, חובה): הגדרת כלי הסינון ({"spec": {"dataRange": GridRange, "columnIndex": int, "title": string}, "position": {"overlayPosition": {"anchorCell": {"sheetId": int, "rowIndex": int, "columnIndex": int}}}}).
  • updateSlicerSpec: עדכון המפרט של כלי הסינון. סכימה:
  • ‫slicerId (מספר שלם, חובה): המזהה של כלי הסינון.
  • ‫spec (אובייקט, חובה): מפרט חדש של כלי הסינון.
  • ‫fields (מחרוזת, חובה): אנונימיזציה של שדות.
  • ‫addDataSource: הוספת מקור נתונים. סכימה:
  • ‫dataSource (אובייקט, חובה): הגדרת מקור הנתונים ({"spec": {"bigQuery": {"projectId": string, "query": string}}}).
  • ‫updateDataSource: עדכון של מקור נתונים. סכימה:
  • ‫dataSource (אובייקט, חובה): הגדרת מקור נתונים עם dataSourceId.
  • ‫fields (מחרוזת, חובה): אנונימיזציה של שדות.
  • ‫deleteDataSource: מחיקת מקור נתונים. סכימה:
  • ‫dataSourceId (מחרוזת, חובה): מזהה מקור הנתונים שרוצים למחוק.
  • ‫refreshDataSource: רענון של מקור נתונים אחד או יותר ושל אובייקטים משויכים של מסד נתונים. סכימה:
  • ‫dataSourceId (מחרוזת, אופציונלי) או isAll (ערך בוליאני, אופציונלי) או references (אובייקט, אופציונלי).
  • ‫force (בוליאני, אופציונלי): אם לאלץ רענון.
  • ‫cancelDataSourceRefresh: מבטל רענונים של מקור נתונים אחד או יותר ושל dbobjects משויכים. סכימה:
  • ‫dataSourceId (מחרוזת, אופציונלי) או isAll (ערך בוליאני, אופציונלי) או references (אובייקט, אופציונלי).
  • ‫addTable: הוספת טבלה. סכימה:
  • ‫table (אובייקט, חובה): הגדרת הטבלה ({"range": GridRange, "name": string, "hasHeaderRow": bool, "hasTotalsRow": bool}).
  • ‫updateTable: עדכון טבלה. סכימה:
  • ‫table (אובייקט, חובה): הגדרת טבלה עם tableId.
  • ‫fields (מחרוזת, חובה): אנונימיזציה של שדות.
  • ‫deleteTable: בקשה למחיקת טבלה. סכימה:
  • ‫tableId (מחרוזת, חובה): מזהה הטבלה שרוצים למחוק.
  • ‫insertComment: הוספת תגובה לגיליון האלקטרוני. סכימה:
  • content (מחרוזת, חובה): תוכן התגובה בטקסט פשוט.
  • ‫coordinate (אובייקט, חובה): קואורדינטת רשת בגיליון לעיגון התגובה:
    • ‫sheetId (מספר שלם, חובה): מזהה הגיליון.
    • rowIndex (מספר שלם, חובה): אינדקס שורות שמתחיל באפס.
    • columnIndex (מספר שלם, חובה): אינדקס עמודות שמתחיל ב-0.
  • assigneeEmailAddress (מחרוזת, אופציונלי): כתובת האימייל של מקבל ההקצאה של התגובה.
  • addCommentReply: הוספת תשובה לשרשור תגובות קיים. אפשר גם להשתמש בה כדי לסמן שרשור כ"טופל" או לפתוח אותו מחדש. סכימה:
  • commentId (מחרוזת, חובה): המזהה של שרשור התגובות.
  • ‫post (אובייקט, חובה):
    • content (מחרוזת, חובה אלא אם הערך של commentAction הוא RESOLVE או REOPEN): תוכן הטקסט הפשוט של פוסט התגובה.
    • ‫commentAction (מחרוזת, אופציונלי): הפעולה שבוצעה בתגובה הזו ("RESOLVE" או "REOPEN").
    • assigneeEmail (מחרוזת, אופציונלי): כתובת האימייל שאליה רוצים להקצות את השרשור.
  • ‫updateCommentPost: עדכון התוכן של פוסט תגובה בשרשור תגובות. סכימה:
  • commentId (מחרוזת, חובה): המזהה של שרשור התגובות.
  • ‫postId (מחרוזת, חובה): המזהה של פוסט התגובה שרוצים לעדכן.
  • ‫content (מחרוזת, חובה): התוכן המעודכן של התגובה.
  • ‫deleteComment: מחיקת שרשור תגובות. סכימה:
  • ‫commentId (מחרוזת, חובה): המזהה של שרשור התגובות שרוצים למחוק.
  • deleteCommentReply: מחיקת פוסט תגובה. סכימה:
  • commentId (מחרוזת, חובה): המזהה של שרשור התגובות.
  • ‫postId (מחרוזת, חובה): המזהה של פוסט התגובה שרוצים למחוק.

בדוגמת הקוד הבאה מוסבר איך להשתמש ב-curl כדי להפעיל את כלי ה-MCP‏ update_spreadsheet.

בקשת Curl 
curl --location 'https://sheetsmcp.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_spreadsheet",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

סכימת הקלט

UpdateContentRequest

ייצוג ב-JSON 
{
  "spreadsheetId": string,
  "requests": [
    {
      object
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
שדות
spreadsheetId

string

חובה. המזהה של הגיליון האלקטרוני שרוצים לעדכן.
requests[]

object (Struct format)

חובה. רשימת עדכונים שצריך להחיל על הגיליון האלקטרוני. כל בקשה צריכה להיות אובייקט בקשה תקין של spreadsheets.batchUpdate, באמצעות הסכימה שמתועדת בכתובת: https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/request הבקשות יחולו לפי הסדר שבו הן צוינו. אם אחת מהבקשות לא תקינה, אף אחת מהבקשות לא תיושם.
writeControl

object (WriteControl)

אופציונלי. מאפשרת לשלוט באופן הביצוע של בקשות כתיבה.

Struct

ייצוג ב-JSON 
{
  "fields": {
    string: value,
    ...
  }
}
שדות
fields

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

מפה לא מסודרת של ערכים שהוקלדו באופן דינמי.

אובייקט שמכיל רשימה של זוגות "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

ייצוג ב-JSON 
{
  "key": string,
  "value": value
}
שדות
key

string
value

value (Value format)

ערך

ייצוג ב-JSON 
{

  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
}
שדות
שדה של איחוד kind. סוג הערך. הערך kind יכול להיות רק אחד מהבאים:
nullValue

null

מייצג null ב-JSON.
numberValue

number

מייצג מספר ב-JSON. הערך לא יכול להיות NaN,‏ Infinity או -Infinity, כי אין להם תמיכה ב-JSON. הוא גם לא יכול לייצג ערכי Int64 גדולים, כי בדרך כלל פורמט JSON לא תומך בהם בסוג המספר שלו.
stringValue

string

מייצג מחרוזת JSON.
boolValue

boolean

מייצג ערך בוליאני של JSON (ליטרל true או false ב-JSON).
structValue

object (Struct format)

מייצג אובייקט JSON.
listValue

array (ListValue format)

מייצג מערך JSON.

ListValue

ייצוג ב-JSON 
{
  "values": [
    value
  ]
}
שדות
values[]

value (Value format)

שדה חוזר של ערכים שהוקלדו באופן דינמי.

WriteControl

ייצוג ב-JSON 
{

  "requiredRevisionId": string
}
שדות
שדה של איחוד control. ההגדרה הזו קובעת לאיזו גרסה של הגיליון האלקטרוני לכתוב, ואיך הבקשה צריכה להתנהג אם הגרסה הזו היא לא הגרסה הנוכחית של הגיליון האלקטרוני. הערך control יכול להיות רק אחד מהבאים:
requiredRevisionId

string

מזהה הגרסה של הגיליון האלקטרוני שעליו תוחל בקשת הכתיבה. אם זו לא הגרסה האחרונה של המסמך, הבקשה לא תעובד ותופיע הודעת השגיאה ‎400 Bad Request.

כשמזהה גרסה נדרש מוחזר בתגובה, הוא מציין את מזהה הגרסה של הגיליון האלקטרוני אחרי שהבקשה הוחלה.

NullValue

מייצג null ב-JSON.

‫NullValue הוא sentinel, שמשתמש ב-enum עם ערך אחד בלבד כדי לייצג את הערך null לאיחוד מסוג Value.

שדה מסוג NullValue עם ערך שונה מ-0 נחשב לא תקין. רוב ה-serializers של ProtoJSON יפיקו Value עם null_value שמוגדר כ-null של JSON, בלי קשר לערך של המספר השלם, ולכן יחזרו לערך 0.

טיפוסים בני מנייה (enum)
NULL_VALUE ערך Null.

סכימת הפלט

UpdateContentResponse

ייצוג ב-JSON 
{
  "content": {
    object
  }
}
שדות
content

object (Struct format)

התגובה של spreadsheets.batchUpdate, בפורמט JSON של Sheets API, בתוספת שדה status.

Struct

ייצוג ב-JSON 
{
  "fields": {
    string: value,
    ...
  }
}
שדות
fields

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

מפה לא מסודרת של ערכים שהוקלדו באופן דינמי.

אובייקט שמכיל רשימה של זוגות "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

ייצוג ב-JSON 
{
  "key": string,
  "value": value
}
שדות
key

string
value

value (Value format)

ערך

ייצוג ב-JSON 
{

  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
}
שדות
שדה של איחוד kind. סוג הערך. הערך kind יכול להיות רק אחד מהבאים:
nullValue

null

מייצג null ב-JSON.
numberValue

number

מייצג מספר ב-JSON. הערך לא יכול להיות NaN,‏ Infinity או -Infinity, כי אין להם תמיכה ב-JSON. הוא גם לא יכול לייצג ערכי Int64 גדולים, כי בדרך כלל פורמט JSON לא תומך בהם בסוג המספר שלו.
stringValue

string

מייצג מחרוזת JSON.
boolValue

boolean

מייצג ערך בוליאני של JSON (ליטרל true או false ב-JSON).
structValue

object (Struct format)

מייצג אובייקט JSON.
listValue

array (ListValue format)

מייצג מערך JSON.

ListValue

ייצוג ב-JSON 
{
  "values": [
    value
  ]
}
שדות
values[]

value (Value format)

שדה חוזר של ערכים שהוקלדו באופן דינמי.

NullValue

מייצג null ב-JSON.

‫NullValue הוא sentinel, שמשתמש ב-enum עם ערך אחד בלבד כדי לייצג את הערך null לאיחוד מסוג Value.

שדה מסוג NullValue עם ערך שונה מ-0 נחשב לא תקין. רוב ה-serializers של ProtoJSON יפיקו Value עם null_value שמוגדר כ-null של JSON, בלי קשר לערך של המספר השלם, ולכן יחזרו לערך 0.

טיפוסים בני מנייה (enum)
NULL_VALUE ערך Null.

הערות לגבי הכלים

הערות הכלים נשלחות ללקוחות MCP כדי לתאר את הסיכון הבסיסי של כלי מסוים. רוב הלקוחות מתייחסים לרמזים האלה כלא מהימנים, אבל אפשר להשתמש בהם כדי להחליט מתי לשלוח למשתמש בקשה לאישור.

בנוסף למחרוזת הכותרת, הרמזים הבוליאניים הבאים מוגדרים כך:

  • ‫readOnlyHint: אם הערך הוא True, הכלי לא משנה את הסביבה שלו. ברירת המחדל: false.
  • ‫destructiveHint: אם הערך הוא True, הכלי יכול לבצע פעולות הרסניות. אם הערך הוא False, הכלי יכול לבצע רק פעולות הוספה. ברירת המחדל: true.
  • ‫idempotentHint: אם הערך הוא True, קריאה חוזרת לכלי עם אותם ארגומנטים לא תשפיע על הסביבה שלו. ברירת המחדל: false.
  • ‫openWorldHint: אם הערך הוא True, הכלי יכול לקיים אינטראקציה עם "עולם פתוח" של ישויות חיצוניות. אם הערך הוא false, הכלי יכול לקיים אינטראקציה רק עם ישויות פנימיות. לדוגמה, כלי חיפוש באינטרנט הוא כלי בעולם פתוח, אבל כלי זיכרון הוא לא כלי בעולם פתוח.

רמז לפעולה הרסנית: ❌ | רמז לפעולה אידמפוטנטית: ❌ | רמז לפעולה לקריאה בלבד: ❌ | רמז לפעולה בעולם פתוח: ✅

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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