דף זה תורגם על ידי Cloud Translation API.

Method: spreadsheets.values.batchUpdateByDataFilter

בקשת HTTP
פרמטרים של נתיב
גוף הבקשה
- ייצוג JSON
גוף התשובה
- ייצוג JSON
היקפי הרשאות
DataFilterValueRange
- ייצוג JSON
UpdateValuesByDataFilterResponse
- ייצוג JSON
רוצים לנסות?

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

בקשת HTTP

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

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

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

פרמטרים

פרמטרים
`spreadsheetId`	`string` המזהה של הגיליון האלקטרוני לעדכון.

spreadsheetId

string

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

גוף הבקשה

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

ייצוג JSON

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

{
  "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`. אפשרות העיבוד המוגדרת כברירת מחדל של תאריך ושעה היא `SERIAL_NUMBER`.

גוף התשובה

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

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

ייצוג JSON

ייצוג 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)
    }
  ]
}

שדות
`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

למידע נוסף, ניתן לעיין במדריך ההרשאה.

טווח של מסנן נתונים

טווח של ערכים שהמיקום שלהם מצוין על ידי DataFilter.

ייצוג JSON
{ "dataFilter": { object (`DataFilter`) }, "majorDimension": enum (`Dimension`), "values": [ array ] }

שדות

שדות
`dataFilter`	`object (DataFilter)` מסנן הנתונים שמתאר את מיקום הערכים בגיליון האלקטרוני.
`majorDimension`	`enum (Dimension)` המאפיין הראשי של הערכים.
`values[]`	`array (ListValue format)` הנתונים לכתיבה. אם הערכים שסופקו חורגים מטווחים אחרים שתואמים למסנן הנתונים, הבקשה תיכשל. אם הערכים שסופקו נמוכים מהטווחים התואמים בלבד, הם יכתבו רק את הערכים שצוינו. הערכים הקיימים בטווחים התואמים לא יושפעו.

dataFilter

object (DataFilter)

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

majorDimension

enum (Dimension)

המאפיין הראשי של הערכים.

values[]

array (ListValue format)

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

עדכוןValuesByDataFilterResponse

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

ייצוג 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`.