- בקשת HTTP
- פרמטרים של נתיב
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- DataFilterValueRange
- UpdateValuesByDataFilterResponse
- רוצים לנסות?
הגדרת ערכים בטווח אחד או יותר של גיליון אלקטרוני. מבצע הקריאה החוזרת חייב לציין את מזהה הגיליון האלקטרוני, valueInputOption
ו-DataFilterValueRanges
אחד או יותר.
בקשת HTTP
POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
spreadsheetId |
מזהה הגיליון האלקטרוני שיש לעדכן. |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "valueInputOption": enum ( |
שדות | |
---|---|
valueInputOption |
האופן שבו יש לפרש את נתוני הקלט. |
data[] |
הערכים החדשים שיחולו על הגיליון האלקטרוני. אם יש יותר מטווח אחד שתואם לערך |
includeValuesInResponse |
המדיניות הזו קובעת אם התגובה לעדכון צריכה לכלול את הערכים של התאים שעודכנו. כברירת מחדל, התשובות לא כוללות את הערכים המעודכנים. השדה |
responseValueRenderOption |
קביעת אופן העיבוד של הערכים בתשובה. אפשרות ברירת המחדל לעיבוד היא |
responseDateTimeRenderOption |
קובע את אופן העיבוד של תאריכים, שעות ומשכי זמן בתגובה. המערכת תתעלם מהמאפיין הזה אם הערך של |
גוף התשובה
התגובה כשמעדכנים טווח ערכים בגיליון אלקטרוני.
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"spreadsheetId": string,
"totalUpdatedRows": integer,
"totalUpdatedColumns": integer,
"totalUpdatedCells": integer,
"totalUpdatedSheets": integer,
"responses": [
{
object ( |
שדות | |
---|---|
spreadsheetId |
הגיליון האלקטרוני שעליו בוצעו העדכונים. |
totalUpdatedRows |
המספר הכולל של השורות שבהן עודכן לפחות תא אחד בשורה. |
totalUpdatedColumns |
המספר הכולל של העמודות שבהן עודכן לפחות תא אחד בעמודה. |
totalUpdatedCells |
המספר הכולל של התאים שעודכנו. |
totalUpdatedSheets |
המספר הכולל של גיליונות שבהם עודכן לפחות תא אחד בגיליון. |
responses[] |
התשובה לכל טווח עודכנה. |
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/spreadsheets
למידע נוסף, עיינו במדריך ההרשאות.
DataFilterValueRange
טווח של ערכים שהמיקום שלהם מצוין על ידי DataFilter
.
ייצוג JSON |
---|
{ "dataFilter": { object ( |
שדות | |
---|---|
dataFilter |
מסנן הנתונים שמתאר את המיקום של הערכים בגיליון האלקטרוני. |
majorDimension |
המאפיין העיקרי של הערכים. |
values[] |
הנתונים לכתיבה. אם הערכים שסופקו חורגים מאחד מהטווחים שתואמים למסנן הנתונים, הבקשה תיכשל. אם הערכים שסופקו נמוכים מהטווחים התואמים, רק הערכים שצוינו נכתבו, הערכים הקיימים בטווחים המותאמים לא יושפעו. |
UpdateValuesByDataFilterResponse
התגובה שמתעדכנים כשמעדכנים טווח של ערכים באמצעות מסנן נתונים בגיליון אלקטרוני.
ייצוג JSON |
---|
{ "updatedRange": string, "updatedRows": integer, "updatedColumns": integer, "updatedCells": integer, "dataFilter": { object ( |
שדות | |
---|---|
updatedRange |
הטווח (בסימון A1) שעליו הוחלו העדכונים. |
updatedRows |
מספר השורות שבהן עודכן תא אחד לפחות בשורה. |
updatedColumns |
מספר העמודות שבהן עודכן תא אחד לפחות בעמודה. |
updatedCells |
מספר התאים שעודכנו. |
dataFilter |
מסנן הנתונים שבחר את הטווח שעודכן. |
updatedData |
ערכי התאים בטווח שהותאמו על ידי מסנן הנתונים, לאחר החלת כל העדכונים. הערך הזה נכלל רק אם שדה |