- בקשת HTTP
- פרמטרים של נתיב
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- שליחת בקשה
- UpdateSpreadsheetPropertiesRequest
- UpdateSheetPropertiesRequest
- UpdateDimensionPropertiesRequest
- DataSourceSheetDimensionRange
- UpdateNamedRangeRequest
- RepeatCellRequest
- AddNamedRangeRequest
- DeleteNamedRangeRequest
- AddSheetRequest
- DeleteSheetRequest
- AutoFillRequest
- SourceAndDestination
- CutPasteRequest
- PasteType
- CopyPasteRequest
- PasteOrientation
- MergeCellsRequest
- MergeType
- UnmergeCellsRequest
- UpdateBordersRequest
- UpdateCellsRequest
- AddFilterViewRequest
- AppendCellsRequest
- ClearBasicFilterRequest
- DeleteDimensionRequest
- DeleteEmbeddedObjectRequest
- DeleteFilterViewRequest
- DuplicateFilterViewRequest
- DuplicateSheetRequest
- FindReplaceRequest
- InsertDimensionRequest
- InsertRangeRequest
- MoveDimensionRequest
- UpdateEmbeddedObjectPositionRequest
- PasteDataRequest
- TextToColumnsRequest
- DelimiterType
- UpdateFilterViewRequest
- DeleteRangeRequest
- AppendDimensionRequest
- AddConditionalFormatRuleRequest
- UpdateConditionalFormatRuleRequest
- DeleteConditionalFormatRuleRequest
- SortRangeRequest
- SetDataValidationRequest
- SetBasicFilterRequest
- AddProtectedRangeRequest
- UpdateProtectedRangeRequest
- DeleteProtectedRangeRequest
- AutoResizeDimensionsRequest
- AddChartRequest
- UpdateChartSpecRequest
- UpdateBandingRequest
- AddBandingRequest
- DeleteBandingRequest
- CreateDeveloperMetadataRequest
- UpdateDeveloperMetadataRequest
- DeleteDeveloperMetadataRequest
- RandomizeRangeRequest
- AddDimensionGroupRequest
- DeleteDimensionGroupRequest
- UpdateDimensionGroupRequest
- TrimWhitespaceRequest
- DeleteDuplicatesRequest
- UpdateEmbeddedObjectBorderRequest
- AddSlicerRequest
- UpdateSlicerSpecRequest
- AddDataSourceRequest
- UpdateDataSourceRequest
- DeleteDataSourceRequest
- RefreshDataSourceRequest
- DataSourceObjectReferences
- DataSourceObjectReference
- CancelDataSourceRefreshRequest
- תגובה
- AddNamedRangeResponse
- AddSheetResponse
- AddFilterViewResponse
- DuplicateFilterViewResponse
- DuplicateSheetResponse
- FindReplaceResponse
- UpdateEmbeddedObjectPositionResponse
- UpdateConditionalFormatRuleResponse
- DeleteConditionalFormatRuleResponse
- AddProtectedRangeResponse
- AddChartResponse
- AddBandingResponse
- CreateDeveloperMetadataResponse
- UpdateDeveloperMetadataResponse
- DeleteDeveloperMetadataResponse
- AddDimensionGroupResponse
- DeleteDimensionGroupResponse
- TrimWhitespaceResponse
- DeleteDuplicatesResponse
- AddSlicerResponse
- AddDataSourceResponse
- UpdateDataSourceResponse
- RefreshDataSourceResponse
- RefreshDataSourceObjectExecutionStatus
- CancelDataSourceRefreshResponse
- CancelDataSourceRefreshStatus
- RefreshCancellationStatus
- RefreshCancellationState
- RefreshCancellationErrorCode
- רוצים לנסות?
הפעלת עדכון אחד או יותר בגיליון האלקטרוני.
כל request
מאומת לפני היישום. אם בקשה כלשהי אינה חוקית, הבקשה כולה תיכשל ולא יושם שום דבר.
בבקשות מסוימות יש replies
כדי לספק מידע על אופן היישום שלהן. התשובות ישקפו את הבקשות. לדוגמה, אם החלתם 4 עדכונים ובתגובה השלישית הייתה תשובה, התשובה תכלול 2 תשובות ריקות, התשובה עצמה ותשובה ריקה נוספת, בסדר הזה.
בשל אופן שיתוף הפעולה של גיליונות אלקטרוניים, לא בטוח שהגיליון האלקטרוני ישקף בדיוק את השינויים שביצעת לאחר השלמת התהליך. עם זאת, ניתן להבטיח שהעדכונים בבקשה יחולו יחד באופן אטומי. ייתכן שהשינויים שתבצעו ישתנו בהתאם לשינויים של שותפי עריכה. אם אין שותפי עריכה, השינויים שביצעתם יופיעו בגיליון האלקטרוני.
בקשת HTTP
POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:batchUpdate
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
spreadsheetId |
הגיליון האלקטרוני שעליו רוצים להחיל את העדכונים. |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"requests": [
{
object ( |
שדות | |
---|---|
requests[] |
רשימת העדכונים שיש להחיל על הגיליון האלקטרוני. הבקשות יטופלו לפי הסדר שבו הן צוינו. אם בקשה כלשהי לא חוקית, לא יישלחו בקשות. |
includeSpreadsheetInResponse |
הפונקציה קובעת אם תגובת העדכון צריכה לכלול את משאב הגיליון האלקטרוני. |
responseRanges[] |
הגבלת הטווחים שנכללים בגיליון האלקטרוני של התשובות. משמעות רק אם הערך של |
responseIncludeGridData |
הערך הוא True אם צריך להחזיר נתוני רשת. משמעות רק אם הערך של |
גוף התשובה
התשובה לעדכון בכמות גדולה של גיליון אלקטרוני.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "spreadsheetId": string, "replies": [ { object ( |
שדות | |
---|---|
spreadsheetId |
הגיליון האלקטרוני שעליו הוחלו העדכונים. |
replies[] |
התשובה לעדכונים. המערכת ממפה 1:1 עם העדכונים, אבל יכול להיות שהתשובות לחלק מהבקשות יהיו ריקות. |
updatedSpreadsheet |
הגיליון האלקטרוני אחרי החלת העדכונים. הערך הזה מוגדר רק אם הערך של |
היקפי ההרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/spreadsheets
מידע נוסף זמין במדריך להרשאות.