Method: spreadsheets.values.batchClear

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

בקשת HTTP

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

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

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