Method: spreadsheets.values.batchClearByDataFilter

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

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

درخواست HTTP

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

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

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

پارامترها
spreadsheetId

string

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

درخواست بدنه

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

نمایش JSON 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ]
}
فیلدها
dataFilters[]

object ( DataFilter )

فیلترهای DataFilters برای تعیین محدوده‌هایی که باید پاک شوند، استفاده می‌شوند.

بدنه پاسخ

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

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

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

string

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

clearedRanges[]

string

محدوده‌هایی که پاک شده‌اند، با نمادگذاری A1 . اگر درخواست‌ها برای یک محدوده نامحدود یا محدوده‌ای بزرگتر از مرزهای برگه باشند، این محدوده‌های واقعی پاک شده هستند که به محدودیت‌های برگه محدود شده‌اند.

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

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

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

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