Method: spreadsheets.values.batchClear

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

בקשת HTTP

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

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

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

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

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