Method: spreadsheets.values.batchUpdateByDataFilter

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

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

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
spreadsheetId

string

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

درخواست بدنه

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

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

enum ( ValueInputOption )

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

data[]

object ( DataFilterValueRange )

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

includeValuesInResponse

boolean

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

responseValueRenderOption

enum ( ValueRenderOption )

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

responseDateTimeRenderOption

enum ( DateTimeRenderOption )

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

بدنه پاسخ

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

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

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

string

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

totalUpdatedRows

integer

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

totalUpdatedColumns

integer

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

totalUpdatedCells

integer

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

totalUpdatedSheets

integer

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

responses[]

object ( UpdateValuesByDataFilterResponse )

پاسخ برای هر محدوده به‌روزرسانی شد.

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

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

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

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

فیلتر دادهمقدارمحدوده

محدوده‌ای از مقادیر که مکان آنها توسط یک DataFilter مشخص شده است.

نمایش JSON 
{
  "dataFilter": {
    object (DataFilter)
  },
  "majorDimension": enum (Dimension),
  "values": [
    array
  ]
}
فیلدها
dataFilter

object ( DataFilter )

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

majorDimension

enum ( Dimension )

بُعد اصلی ارزش‌ها.

values[]

array ( ListValue format)

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

پاسخ UpdateValuesByDataFilter

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

نمایش JSON 
{
  "updatedRange": string,
  "updatedRows": integer,
  "updatedColumns": integer,
  "updatedCells": integer,
  "dataFilter": {
    object (DataFilter)
  },
  "updatedData": {
    object (ValueRange)
  }
}
فیلدها
updatedRange

string

محدوده‌ای (با نماد A1 ) که به‌روزرسانی‌ها روی آن اعمال شده است.

updatedRows

integer

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

updatedColumns

integer

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

updatedCells

integer

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

dataFilter

object ( DataFilter )

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

updatedData

object ( ValueRange )

مقادیر سلول‌های موجود در محدوده‌ای که پس از اعمال تمام به‌روزرسانی‌ها توسط dataFilter مطابقت داده شده‌اند. این مقدار فقط در صورتی لحاظ می‌شود که فیلد includeValuesInResponse درخواست، true داشته باشد.