Method: spreadsheets.values.batchUpdateByDataFilter

הגדרת ערכים בטווח אחד או יותר של גיליון אלקטרוני. מבצע הקריאה החוזרת חייב לציין את מזהה הגיליון האלקטרוני, valueInputOption ו-DataFilterValueRanges אחד או יותר.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

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

פרמטרים
spreadsheetId

string

מזהה הגיליון האלקטרוני שיש לעדכן.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "valueInputOption": enum (ValueInputOption),
  "data": [
    {
      object (DataFilterValueRange)
    }
  ],
  "includeValuesInResponse": boolean,
  "responseValueRenderOption": enum (ValueRenderOption),
  "responseDateTimeRenderOption": enum (DateTimeRenderOption)
}
שדות
valueInputOption

enum (ValueInputOption)

האופן שבו יש לפרש את נתוני הקלט.
data[]

object (DataFilterValueRange)

הערכים החדשים שיחולו על הגיליון האלקטרוני. אם יש יותר מטווח אחד שתואם לערך DataFilter שצוין, הערכים שצוינו יחולו על כל הטווחים האלה.
includeValuesInResponse

boolean

המדיניות הזו קובעת אם התגובה לעדכון צריכה לכלול את הערכים של התאים שעודכנו. כברירת מחדל, התשובות לא כוללות את הערכים המעודכנים. השדה updatedData בתוך כל אחד מה-BatchUpdateValuesResponse.responses מכיל את הערכים המעודכנים. אם הטווח לכתיבה היה גדול מהטווח שנכתב בפועל, התשובה תכלול את כל הערכים בטווח המבוקש (למעט שורות ועמודות ריקות בסוף).
responseValueRenderOption

enum (ValueRenderOption)

קביעת אופן העיבוד של הערכים בתשובה. אפשרות ברירת המחדל לעיבוד היא FORMATTED_VALUE.
responseDateTimeRenderOption

enum (DateTimeRenderOption)

קובע את אופן העיבוד של תאריכים, שעות ומשכי זמן בתגובה. המערכת תתעלם מהמאפיין הזה אם הערך של responseValueRenderOption הוא FORMATTED_VALUE. אפשרות ברירת המחדל לרינדור dateTime היא SERIAL_NUMBER.

גוף התשובה

התגובה כשמעדכנים טווח ערכים בגיליון אלקטרוני.

אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "spreadsheetId": string,
  "totalUpdatedRows": integer,
  "totalUpdatedColumns": integer,
  "totalUpdatedCells": integer,
  "totalUpdatedSheets": integer,
  "responses": [
    {
      object (UpdateValuesByDataFilterResponse)
    }
  ]
}
שדות
spreadsheetId

string

הגיליון האלקטרוני שעליו בוצעו העדכונים.
totalUpdatedRows

integer

המספר הכולל של השורות שבהן עודכן לפחות תא אחד בשורה.
totalUpdatedColumns

integer

המספר הכולל של העמודות שבהן עודכן לפחות תא אחד בעמודה.
totalUpdatedCells

integer

המספר הכולל של התאים שעודכנו.
totalUpdatedSheets

integer

המספר הכולל של גיליונות שבהם עודכן לפחות תא אחד בגיליון.
responses[]

object (UpdateValuesByDataFilterResponse)

התשובה לכל טווח עודכנה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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": enum (Dimension),
  "values": [
    array
  ]
}
שדות
dataFilter

object (DataFilter)

מסנן הנתונים שמתאר את המיקום של הערכים בגיליון האלקטרוני.
majorDimension

enum (Dimension)

המאפיין העיקרי של הערכים.
values[]

array (ListValue format)

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

UpdateValuesByDataFilterResponse

התגובה שמתעדכנים כשמעדכנים טווח של ערכים באמצעות מסנן נתונים בגיליון אלקטרוני.

ייצוג JSON 
{
  "updatedRange": string,
  "updatedRows": integer,
  "updatedColumns": integer,
  "updatedCells": integer,
  "dataFilter": {
    object (DataFilter)
  },
  "updatedData": {
    object (ValueRange)
  }
}
שדות
updatedRange

string

הטווח (בסימון A1) שעליו הוחלו העדכונים.
updatedRows

integer

מספר השורות שבהן עודכן תא אחד לפחות בשורה.
updatedColumns

integer

מספר העמודות שבהן עודכן תא אחד לפחות בעמודה.
updatedCells

integer

מספר התאים שעודכנו.
dataFilter

object (DataFilter)

מסנן הנתונים שבחר את הטווח שעודכן.
updatedData

object (ValueRange)

ערכי התאים בטווח שהותאמו על ידי מסנן הנתונים, לאחר החלת כל העדכונים. הערך הזה נכלל רק אם שדה includeValuesInResponse של הבקשה היה true.