MCP Tools Reference: sheetsmcp.googleapis.com

ابزار: update_spreadsheet

یک یا چند به‌روزرسانی را در صفحه‌گسترده اعمال می‌کند.

مربوط به spreadsheets.batchUpdate در REST API: https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/batchUpdate

لیست به‌روزرسانی‌های احتمالی به شرح زیر است:

  • updateSpreadsheetProperties : ویژگی‌های صفحه‌گسترده را به‌روزرسانی می‌کند.
  • updateSheetProperties : ویژگی‌های یک برگه را به‌روزرسانی می‌کند.
  • updateDimensionProperties : ویژگی‌های ابعاد را به‌روزرسانی می‌کند.
  • updateNamedRange : یک محدوده نامگذاری شده را به‌روزرسانی می‌کند.
  • repeatCell : یک سلول واحد را در یک محدوده تکرار می‌کند.
  • addNamedRange : یک محدوده نامگذاری شده اضافه می‌کند.
  • deleteNamedRange : یک محدوده نامگذاری شده را حذف می‌کند.
  • addSheet : یک برگه اضافه می‌کند.
  • deleteSheet : یک برگه را حذف می‌کند.
  • autoFill : به طور خودکار داده‌های بیشتری را بر اساس داده‌های موجود پر می‌کند.
  • cutPaste : داده‌ها را از یک ناحیه برش داده و در ناحیه دیگری جایگذاری می‌کند.
  • copyPaste : داده‌ها را از یک ناحیه کپی کرده و در ناحیه دیگری پیست می‌کند.
  • mergeCells : سلول‌ها را با هم ادغام می‌کند.
  • unmergeCells : سلول‌های ادغام‌شده را از حالت ادغام‌شده خارج می‌کند.
  • updateBorders : حاشیه‌ها را در طیف وسیعی از سلول‌ها به‌روزرسانی می‌کند.
  • updateCells : تعداد زیادی سلول را به طور همزمان به‌روزرسانی می‌کند.
  • addFilterView : یک نمای فیلتر اضافه می‌کند.
  • appendCells : سلول‌هایی را بعد از آخرین ردیف حاوی داده‌ها در یک برگه اضافه می‌کند.
  • clearBasicFilter : فیلتر پایه را روی یک برگه پاک می‌کند.
  • deleteDimension : سطرها یا ستون‌های یک برگه را حذف می‌کند.
  • deleteEmbeddedObject : یک شیء جاسازی‌شده (مثلاً نمودار، تصویر) را در یک برگه حذف می‌کند.
  • deleteFilterView : یک نمای فیلتر را از یک برگه حذف می‌کند.
  • duplicateFilterView : یک نمای فیلتر را کپی می‌کند.
  • duplicateSheet : یک برگه را کپی می‌کند.
  • findReplace : موارد تکرار یک متن را پیدا کرده و با متن دیگری جایگزین می‌کند.
  • insertDimension : سطرها یا ستون‌های جدید را در یک برگه درج می‌کند.
  • insertRange : سلول‌های جدید را در یک برگه وارد می‌کند و سلول‌های موجود را جابجا می‌کند.
  • moveDimension : سطرها یا ستون‌ها را به مکان دیگری در یک برگه منتقل می‌کند.
  • updateEmbeddedObjectPosition : موقعیت یک شیء جاسازی‌شده (مثلاً نمودار، تصویر) را به‌روزرسانی می‌کند.
  • pasteData : داده‌ها (HTML یا جدا شده) را در یک برگه جایگذاری می‌کند.
  • textToColumns : یک ستون متن را به چندین ستون متن تبدیل می‌کند.
  • updateFilterView : ویژگی‌های یک نمای فیلتر را به‌روزرسانی می‌کند.
  • deleteRange : محدوده‌ای از سلول‌ها را از یک برگه حذف می‌کند و سلول‌های باقی‌مانده را جابجا می‌کند.
  • appendDimension ابعاد را به انتهای یک برگه اضافه می‌کند.
  • addConditionalFormatRule : یک قانون قالب‌بندی شرطی جدید اضافه می‌کند.
  • updateConditionalFormatRule : یک قانون قالب‌بندی شرطی موجود را به‌روزرسانی می‌کند.
  • deleteConditionalFormatRule : یک قانون قالب‌بندی شرطی موجود را حذف می‌کند.
  • sortRange : داده‌ها را در یک محدوده مرتب می‌کند.
  • setDataValidation : اعتبارسنجی داده‌ها را برای یک یا چند سلول تنظیم می‌کند.
  • setBasicFilter : فیلتر پایه را روی یک برگه تنظیم می‌کند.
  • addProtectedRange : یک محدوده محافظت‌شده اضافه می‌کند.
  • updateProtectedRange : یک محدوده محافظت‌شده را به‌روزرسانی می‌کند.
  • deleteProtectedRange : یک محدوده محافظت‌شده را حذف می‌کند.
  • autoResizeDimensions : به طور خودکار اندازه یک یا چند بُعد را بر اساس محتویات سلول‌های موجود در آن بُعد تغییر می‌دهد.
  • addChart : یک نمودار اضافه می‌کند.
  • updateChartSpec : مشخصات یک نمودار را به‌روزرسانی می‌کند.
  • updateBanding : یک محدوده‌ی نواری را به‌روزرسانی می‌کند.
  • addBanding : یک محدوده نواری جدید اضافه می‌کند.
  • deleteBanding : یک محدوده‌ی نواری را حذف می‌کند.
  • createDeveloperMetadata : متادیتای توسعه‌دهنده جدید ایجاد می‌کند.
  • updateDeveloperMetadata : ورودی متادیتای توسعه‌دهنده‌ی موجود را به‌روزرسانی می‌کند.
  • deleteDeveloperMetadata : متادیتای توسعه‌دهنده را حذف می‌کند.
  • randomizeRange ترتیب ردیف‌های یک محدوده را تصادفی می‌کند.
  • addDimensionGroup : یک گروه در محدوده مشخص شده ایجاد می‌کند.
  • deleteDimensionGroup : یک گروه را در محدوده مشخص شده حذف می‌کند.
  • updateDimensionGroup : وضعیت گروه مشخص شده را به‌روزرسانی می‌کند.
  • trimWhitespace : سلول‌های حاوی فضای خالی (مانند فاصله، تب یا خط جدید) را برش می‌دهد.
  • deleteDuplicates : ردیف‌های حاوی مقادیر تکراری را در ستون‌های مشخص‌شده از یک محدوده سلولی حذف می‌کند.
  • updateEmbeddedObjectBorder : حاشیه یک شیء جاسازی‌شده را به‌روزرسانی می‌کند.
  • addSlicer : یک برش‌دهنده اضافه می‌کند.
  • updateSlicerSpec : مشخصات یک برش‌دهنده را به‌روزرسانی می‌کند.
  • addDataSource : یک منبع داده اضافه می‌کند.
  • updateDataSource : یک منبع داده را به‌روزرسانی می‌کند.
  • deleteDataSource : یک منبع داده را حذف می‌کند.
  • refreshDataSource : یک یا چند منبع داده و dbobject های مرتبط را رفرش می‌کند.
  • cancelDataSourceRefresh : به‌روزرسانی‌های یک یا چند منبع داده و dbobjects مرتبط را لغو می‌کند.
  • addTable : یک جدول اضافه می‌کند.
  • updateTable : یک جدول را به‌روزرسانی می‌کند.
  • deleteTable : درخواستی برای حذف یک جدول.

نمونه زیر نحوه استفاده از curl برای فراخوانی ابزار update_spreadsheet MCP را نشان می‌دهد.

درخواست کرل 
curl --location 'https://sheetsmcp.googleapis.com/mcp' \
--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 tool MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

طرحواره ورودی

درخواست به‌روزرسانی محتوا

نمایش JSON 
{
  "spreadsheetId": string,
  "requests": [
    {
      object
    }
  ]
}
فیلدها
spreadsheetId

string

الزامی. شناسه‌ی صفحه‌گسترده برای به‌روزرسانی.

requests[]

object ( Struct format)

الزامی. فهرستی از به‌روزرسانی‌ها برای اعمال در صفحه‌گسترده. هر درخواست باید یک شیء معتبر spreadsheets.batchUpdate Request باشد که از طرحواره مستند شده در: https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/request استفاده می‌کند. درخواست‌ها به ترتیبی که مشخص شده‌اند اعمال می‌شوند. اگر هر درخواستی معتبر نباشد، هیچ درخواستی اعمال نخواهد شد.

ساختار

نمایش JSON 
{
  "fields": {
    string: value,
    ...
  }
}
فیلدها
fields

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

نقشه نامرتب از مقادیر با نوع پویا.

یک شیء شامل لیستی از جفت‌های "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

فیلدهاورود

نمایش JSON 
{
  "key": string,
  "value": value
}
فیلدها
key

string

value

value ( Value format)

ارزش

نمایش JSON 
{

  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
}
فیلدها
فیلد Union kind . نوع مقدار. kind فقط می‌تواند یکی از موارد زیر باشد:
nullValue

null

نشان دهنده یک JSON null .

numberValue

number

نشان دهنده یک عدد JSON است. نباید NaN ، Infinity یا -Infinity باشد، زیرا این موارد در JSON پشتیبانی نمی‌شوند. این همچنین نمی‌تواند مقادیر بزرگ Int64 را نشان دهد، زیرا فرمت JSON معمولاً از آنها در نوع عدد خود پشتیبانی نمی‌کند.

stringValue

string

نشان دهنده یک رشته JSON است.

boolValue

boolean

نشان دهنده یک مقدار بولی JSON (در JSON، مقدار حقیقی یا غیر حقیقی true یا false ) است.

structValue

object ( Struct format)

نشان دهنده یک شیء JSON است.

listValue

array ( ListValue format)

نشان دهنده یک آرایه JSON است.

مقدار لیست

نمایش JSON 
{
  "values": [
    value
  ]
}
فیلدها
values[]

value ( Value format)

فیلد تکراری با مقادیر تایپ‌شده‌ی پویا.

مقدار تهی

نشان دهنده یک JSON null .

NullValue یک نگهبان است که از یک enum با تنها یک مقدار برای نمایش مقدار null برای نوع Value استفاده می‌کند.

فیلدی از نوع NullValue با هر مقداری غیر از 0 نامعتبر در نظر گرفته می‌شود. اکثر سریالایزرهای ProtoJSON صرف نظر از مقدار صحیح، Value با null_value که به عنوان JSON null تنظیم شده است، منتشر می‌کنند و بنابراین به صورت رفت و برگشتی به مقدار 0 می‌رسند.

انوم‌ها
NULL_VALUE مقدار تهی.

طرحواره خروجی

نشان دهنده یک شیء JSON است.

یک نگاشت کلید-مقدار نامرتب، با هدف ثبت کامل معانی یک شیء JSON. این امر امکان تجزیه هر بار داده دلخواه JSON را به عنوان یک فیلد پیام در قالب ProtoJSON فراهم می‌کند.

این از دستورالعمل‌های RFC 8259 برای JSON سازگار پیروی می‌کند: به‌ویژه این نوع نمی‌تواند مقادیر بزرگ Int64 یا اعداد NaN / Infinity را نمایش دهد، زیرا فرمت JSON عموماً از این مقادیر در نوع عددی خود پشتیبانی نمی‌کند.

اگر قصد ندارید JSON دلخواه را در پیام خود تجزیه کنید، به جای استفاده از این نوع، یک پیام با نوع داده سفارشی ترجیح داده می‌شود.

ساختار

نمایش JSON 
{
  "fields": {
    string: value,
    ...
  }
}
فیلدها
fields

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

نقشه نامرتب از مقادیر با نوع پویا.

یک شیء شامل لیستی از جفت‌های "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

فیلدهاورود

نمایش JSON 
{
  "key": string,
  "value": value
}
فیلدها
key

string

value

value ( Value format)

ارزش

نمایش JSON 
{

  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
}
فیلدها
فیلد Union kind . نوع مقدار. kind فقط می‌تواند یکی از موارد زیر باشد:
nullValue

null

نشان دهنده یک JSON null .

numberValue

number

نشان دهنده یک عدد JSON است. نباید NaN ، Infinity یا -Infinity باشد، زیرا این موارد در JSON پشتیبانی نمی‌شوند. این همچنین نمی‌تواند مقادیر بزرگ Int64 را نشان دهد، زیرا فرمت JSON معمولاً از آنها در نوع عدد خود پشتیبانی نمی‌کند.

stringValue

string

نشان دهنده یک رشته JSON است.

boolValue

boolean

نشان دهنده یک مقدار بولی JSON (در JSON، مقدار حقیقی یا مجازی true یا false ) است.

structValue

object ( Struct format)

نشان دهنده یک شیء JSON است.

listValue

array ( ListValue format)

نشان دهنده یک آرایه JSON است.

مقدار لیست

نمایش JSON 
{
  "values": [
    value
  ]
}
فیلدها
values[]

value ( Value format)

فیلد تکراری با مقادیر تایپ‌شده‌ی پویا.

مقدار تهی

نشان دهنده یک JSON null .

NullValue یک نگهبان است که از یک enum با تنها یک مقدار برای نمایش مقدار null برای نوع Value استفاده می‌کند.

فیلدی از نوع NullValue با هر مقداری غیر از 0 نامعتبر در نظر گرفته می‌شود. اکثر سریالایزرهای ProtoJSON صرف نظر از مقدار صحیح، Value با null_value که به عنوان JSON null تنظیم شده است، منتشر می‌کنند و بنابراین به صورت رفت و برگشتی به مقدار 0 می‌رسند.

انوم‌ها
NULL_VALUE مقدار تهی.

حاشیه‌نویسی ابزار

راهنمایی مخرب: ❌ | راهنمایی بی‌اثر: ❌ | راهنمایی فقط خواندنی: ❌ | راهنمایی جهان باز: ✅

دامنه‌های مجوز

به یکی از حوزه‌های OAuth زیر نیاز دارد:

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