Method: spreadsheets.values.batchClearByDataFilter

מנקה ערכים מטווח אחד או יותר בגיליון אלקטרוני. מידע נוסף מפורט במאמר קריאה, כתיבה וחיפוש של מטא-נתונים.

המתקשר צריך לציין את מזהה הגיליון האלקטרוני ואת אחד או יותר מהערכים DataFilters. הטווחים שתואמים לאחד ממסנני הנתונים שצוינו יימחקו. רק הערכים נמחקים – כל שאר המאפיינים של התא (כמו עיצוב, אימות נתונים וכו') נשמרים.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
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

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