Method: spreadsheets.values.batchUpdate

مقادیر را در یک یا چند محدوده از یک صفحه گسترده تنظیم می کند. تماس گیرنده باید شناسه صفحه گسترده، یک valueInputOption و یک یا چند ValueRanges را مشخص کند.

درخواست HTTP

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchUpdate

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
spreadsheetId

string

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

درخواست بدن

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

نمایندگی JSON 
{
  "valueInputOption": enum (ValueInputOption),
  "data": [
    {
      object (ValueRange)
    }
  ],
  "includeValuesInResponse": boolean,
  "responseValueRenderOption": enum (ValueRenderOption),
  "responseDateTimeRenderOption": enum (DateTimeRenderOption)
}
فیلدها
valueInputOption

enum ( ValueInputOption )

چگونه داده های ورودی باید تفسیر شوند.

data[]

object ( ValueRange )

مقادیر جدید برای اعمال به صفحه گسترده.

includeValuesInResponse

boolean

تعیین می کند که آیا پاسخ به روز رسانی باید شامل مقادیر سلول هایی باشد که به روز شده اند یا خیر. به طور پیش فرض، پاسخ ها شامل مقادیر به روز شده نمی شوند. فیلد updatedData در هر یک از BatchUpdateValuesResponse.responses حاوی مقادیر به روز شده است. اگر محدوده برای نوشتن بزرگتر از محدوده واقعی نوشته شده بود، پاسخ شامل تمام مقادیر در محدوده درخواستی می شود (به استثنای ردیف ها و ستون های خالی دنباله دار).

responseValueRenderOption

enum ( ValueRenderOption )

تعیین می کند که مقادیر در پاسخ چگونه باید ارائه شوند. گزینه رندر پیش فرض FORMATTED_VALUE است.

responseDateTimeRenderOption

enum ( DateTimeRenderOption )

تعیین می کند که چگونه تاریخ ها، زمان ها و مدت زمان در پاسخ باید ارائه شوند. اگر responseValueRenderOption FORMATTED_VALUE باشد، نادیده گرفته می شود. گزینه پیش‌فرض render dateTime SERIAL_NUMBER است.

بدن پاسخگو

پاسخ هنگام به روز رسانی محدوده ای از مقادیر در یک صفحه گسترده.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "spreadsheetId": string,
  "totalUpdatedRows": integer,
  "totalUpdatedColumns": integer,
  "totalUpdatedCells": integer,
  "totalUpdatedSheets": integer,
  "responses": [
    {
      object (UpdateValuesResponse)
    }
  ]
}
فیلدها
spreadsheetId

string

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

totalUpdatedRows

integer

تعداد کل ردیف هایی که حداقل یک سلول در آن ردیف به روز شده است.

totalUpdatedColumns

integer

تعداد کل ستون هایی که حداقل یک سلول در آن ستون به روز شده است.

totalUpdatedCells

integer

تعداد کل سلول‌ها به‌روزرسانی شد.

totalUpdatedSheets

integer

تعداد کل برگه‌هایی که حداقل یک سلول در آن به‌روزرسانی شده است.

responses[]

object ( UpdateValuesResponse )

یک UpdateValuesResponse در هر محدوده درخواستی، به همان ترتیبی که درخواست‌ها ظاهر شدند.

محدوده مجوز

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

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.