Method: spreadsheets.values.batchClear

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

درخواست HTTP

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

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

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

پارامترها
spreadsheetId

string

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

درخواست بدنه

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

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

string

محدوده‌هایی که باید پاک شوند، با نمادگذاری A1 یا نمادگذاری R1C1 .

بدنه پاسخ

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

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

نمایش 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

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