Method: spreadsheets.values.batchUpdateByDataFilter

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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)

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