Method: spreadsheets.values.batchUpdateByDataFilter

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

המתקשר צריך לציין את מזהה הגיליון האלקטרוני, valueInputOption אחד או יותר וDataFilterValueRanges אחד או יותר.

בקשת HTTP

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

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

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

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

הערכים של התאים בטווח שתואם ל-dataFilter אחרי שכל העדכונים הוחלו. השדה הזה נכלל רק אם הערך של השדה includeValuesInResponse בבקשה היה true.