Method: spreadsheets.values.batchClearByDataFilter

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של 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

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