یک یا چند محدوده از مقادیر را از یک صفحه گسترده پاک می کند. تماس گیرنده باید شناسه صفحه گسترده و یک یا چند DataFilters
را مشخص کند. محدوده های مطابق با هر یک از فیلترهای داده مشخص شده پاک خواهند شد. فقط مقادیر پاک می شوند -- تمام خصوصیات دیگر سلول (مانند قالب بندی، اعتبارسنجی داده ها و غیره) حفظ می شوند.
درخواست HTTP
POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
مولفه های | |
---|---|
spreadsheetId | شناسه صفحهگسترده برای بهروزرسانی. |
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"dataFilters": [
{
object ( |
زمینه های | |
---|---|
dataFilters[] | |
بدن پاسخگو
پاسخ هنگام پاک کردن محدوده ای از مقادیر انتخاب شده با DataFilters
در یک صفحه گسترده.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "spreadsheetId": string, "clearedRanges": [ string ] } |
زمینه های | |
---|---|
spreadsheetId | صفحهگستردهای که بهروزرسانیها روی آن اعمال شد. |
clearedRanges[] | محدوده هایی که پاک شدند، در نماد A1 . اگر درخواستها برای یک محدوده نامحدود یا یک رنجر بزرگتر از محدوده صفحه باشد، این محدودههای واقعی پاک شده و محدود به محدودیتهای برگه است. |
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/drive
-
https://www.googleapis.com/auth/drive.file
-
https://www.googleapis.com/auth/spreadsheets
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.