מנקה טווח אחד או יותר של ערכים מגיליון אלקטרוני. המתקשר חייב לציין את מזהה הגיליון האלקטרוני וטווח אחד או יותר. רק הערכים נמחקים – כל שאר המאפיינים של התא (למשל עיצוב הנתונים ואימות הנתונים) נשמרים.
בקשת HTTP
POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchClear
כתובת ה-URL כוללת תחביר של קידוד gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
spreadsheetId |
המזהה של הגיליון האלקטרוני לעדכון. |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "ranges": [ string ] } |
שדות | |
---|---|
ranges[] |
הטווחים שיש לנקות, בסימון A1 או בסימון R1C1. |
גוף התשובה
התגובה כשמנקים טווח ערכים בגיליון אלקטרוני.
אם התגובה הצליחה, גוף התגובה מכיל נתונים עם המבנה הבא:
ייצוג JSON |
---|
{ "spreadsheetId": string, "clearedRanges": [ string ] } |
שדות | |
---|---|
spreadsheetId |
הגיליון האלקטרוני שעליו הוחלו העדכונים. |
clearedRanges[] |
הטווחים שנמחקו, בסימון A1. אם הבקשות הן של טווח לא תוחם או של טווח שחורג מגבולות הגיליון, זהו הטווחים שנמחקו בפועל, והם חורגים מהמגבלות של הגיליון. |
היקפי הרשאה
מחייב אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/spreadsheets
למידע נוסף, ניתן לעיין במדריך ההרשאה.