Method: spreadsheets.values.batchUpdateByDataFilter

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

درخواست HTTP

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

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

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

مولفه های
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 باشد، نادیده گرفته می شود. گزینه پیش‌فرض render 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

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

DataFilterValueRange

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

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

object ( DataFilter )

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

majorDimension

enum ( Dimension )

بعد اصلی ارزش ها

values[]

array ( ListValue format)

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

UpdateValuesByDataFilterResponse

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

نمایندگی 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 باشد.