דף זה תורגם על ידי 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

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

DataFilterValueRange

טווח ערכים שהמיקום שלהם מצוין על ידי 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)

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

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`.