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

מידע נוסף זמין במדריך ההרשאות.