Method: spreadsheets.batchUpdate

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

כל request מאומת לפני שהוא מיושם. אם אחת מהבקשות לא תקינה, הבקשה כולה תיכשל ולא תתבצע אף פעולה.

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

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

בקשת HTTP

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

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

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

פרמטרים
spreadsheetId

string

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

גוף הבקשה

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

ייצוג ב-JSON 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "includeSpreadsheetInResponse": boolean,
  "responseRanges": [
    string
  ],
  "responseIncludeGridData": boolean
}
שדות
requests[]

object (Request)

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

boolean

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

string

מגביל את טווחי הנתונים שכלולים בגיליון האלקטרוני של התשובות. הערך רלוונטי רק אם הערך של includeSpreadsheetInResponse הוא 'true'.
responseIncludeGridData

boolean

הערך true אם צריך להחזיר נתוני רשת. הערך רלוונטי רק אם הערך של includeSpreadsheetInResponse הוא 'true'. המערכת מתעלמת מהפרמטר הזה אם הגדרתם מסכת שדה בבקשה.

גוף התשובה

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

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

ייצוג ב-JSON 
{
  "spreadsheetId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "updatedSpreadsheet": {
    object (Spreadsheet)
  }
}
שדות
spreadsheetId

string

גיליון האלקטרוני שבו הוחלו העדכונים.
replies[]

object (Response)

התשובה לעדכונים. התשובות ממופות 1:1 עם העדכונים, אבל יכול להיות שהתשובות לבקשות מסוימות יהיו ריקות.
updatedSpreadsheet

object (Spreadsheet)

הגיליון האלקטרוני אחרי החלת העדכונים. השדה הזה מוגדר רק אם הערך של BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response הוא true.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

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

בקשה

סוג אחד של עדכון שחלים על גיליון אלקטרוני.

ייצוג ב-JSON 
{

  // Union field kind can be only one of the following:
  "updateSpreadsheetProperties": {
    object (UpdateSpreadsheetPropertiesRequest)
  },
  "updateSheetProperties": {
    object (UpdateSheetPropertiesRequest)
  },
  "updateDimensionProperties": {
    object (UpdateDimensionPropertiesRequest)
  },
  "updateNamedRange": {
    object (UpdateNamedRangeRequest)
  },
  "repeatCell": {
    object (RepeatCellRequest)
  },
  "addNamedRange": {
    object (AddNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "addSheet": {
    object (AddSheetRequest)
  },
  "deleteSheet": {
    object (DeleteSheetRequest)
  },
  "autoFill": {
    object (AutoFillRequest)
  },
  "cutPaste": {
    object (CutPasteRequest)
  },
  "copyPaste": {
    object (CopyPasteRequest)
  },
  "mergeCells": {
    object (MergeCellsRequest)
  },
  "unmergeCells": {
    object (UnmergeCellsRequest)
  },
  "updateBorders": {
    object (UpdateBordersRequest)
  },
  "updateCells": {
    object (UpdateCellsRequest)
  },
  "addFilterView": {
    object (AddFilterViewRequest)
  },
  "appendCells": {
    object (AppendCellsRequest)
  },
  "clearBasicFilter": {
    object (ClearBasicFilterRequest)
  },
  "deleteDimension": {
    object (DeleteDimensionRequest)
  },
  "deleteEmbeddedObject": {
    object (DeleteEmbeddedObjectRequest)
  },
  "deleteFilterView": {
    object (DeleteFilterViewRequest)
  },
  "duplicateFilterView": {
    object (DuplicateFilterViewRequest)
  },
  "duplicateSheet": {
    object (DuplicateSheetRequest)
  },
  "findReplace": {
    object (FindReplaceRequest)
  },
  "insertDimension": {
    object (InsertDimensionRequest)
  },
  "insertRange": {
    object (InsertRangeRequest)
  },
  "moveDimension": {
    object (MoveDimensionRequest)
  },
  "updateEmbeddedObjectPosition": {
    object (UpdateEmbeddedObjectPositionRequest)
  },
  "pasteData": {
    object (PasteDataRequest)
  },
  "textToColumns": {
    object (TextToColumnsRequest)
  },
  "updateFilterView": {
    object (UpdateFilterViewRequest)
  },
  "deleteRange": {
    object (DeleteRangeRequest)
  },
  "appendDimension": {
    object (AppendDimensionRequest)
  },
  "addConditionalFormatRule": {
    object (AddConditionalFormatRuleRequest)
  },
  "updateConditionalFormatRule": {
    object (UpdateConditionalFormatRuleRequest)
  },
  "deleteConditionalFormatRule": {
    object (DeleteConditionalFormatRuleRequest)
  },
  "sortRange": {
    object (SortRangeRequest)
  },
  "setDataValidation": {
    object (SetDataValidationRequest)
  },
  "setBasicFilter": {
    object (SetBasicFilterRequest)
  },
  "addProtectedRange": {
    object (AddProtectedRangeRequest)
  },
  "updateProtectedRange": {
    object (UpdateProtectedRangeRequest)
  },
  "deleteProtectedRange": {
    object (DeleteProtectedRangeRequest)
  },
  "autoResizeDimensions": {
    object (AutoResizeDimensionsRequest)
  },
  "addChart": {
    object (AddChartRequest)
  },
  "updateChartSpec": {
    object (UpdateChartSpecRequest)
  },
  "updateBanding": {
    object (UpdateBandingRequest)
  },
  "addBanding": {
    object (AddBandingRequest)
  },
  "deleteBanding": {
    object (DeleteBandingRequest)
  },
  "createDeveloperMetadata": {
    object (CreateDeveloperMetadataRequest)
  },
  "updateDeveloperMetadata": {
    object (UpdateDeveloperMetadataRequest)
  },
  "deleteDeveloperMetadata": {
    object (DeleteDeveloperMetadataRequest)
  },
  "randomizeRange": {
    object (RandomizeRangeRequest)
  },
  "addDimensionGroup": {
    object (AddDimensionGroupRequest)
  },
  "deleteDimensionGroup": {
    object (DeleteDimensionGroupRequest)
  },
  "updateDimensionGroup": {
    object (UpdateDimensionGroupRequest)
  },
  "trimWhitespace": {
    object (TrimWhitespaceRequest)
  },
  "deleteDuplicates": {
    object (DeleteDuplicatesRequest)
  },
  "updateEmbeddedObjectBorder": {
    object (UpdateEmbeddedObjectBorderRequest)
  },
  "addSlicer": {
    object (AddSlicerRequest)
  },
  "updateSlicerSpec": {
    object (UpdateSlicerSpecRequest)
  },
  "addDataSource": {
    object (AddDataSourceRequest)
  },
  "updateDataSource": {
    object (UpdateDataSourceRequest)
  },
  "deleteDataSource": {
    object (DeleteDataSourceRequest)
  },
  "refreshDataSource": {
    object (RefreshDataSourceRequest)
  },
  "cancelDataSourceRefresh": {
    object (CancelDataSourceRefreshRequest)
  },
  "addTable": {
    object (AddTableRequest)
  },
  "updateTable": {
    object (UpdateTableRequest)
  },
  "deleteTable": {
    object (DeleteTableRequest)
  }
  // End of list of possible types for union field kind.
}
שדות
שדה האיחוד kind. סוג העדכון. צריך למלא שדה אחד בדיוק. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות:
updateSpreadsheetProperties

object (UpdateSpreadsheetPropertiesRequest)

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

object (UpdateSheetPropertiesRequest)

עדכון המאפיינים של גיליון.
updateDimensionProperties

object (UpdateDimensionPropertiesRequest)

עדכון המאפיינים של המאפיינים.
updateNamedRange

object (UpdateNamedRangeRequest)

עדכון של טווח תאים בעל שם.
repeatCell

object (RepeatCellRequest)

הפונקציה חוזרת על תא יחיד בטווח.
addNamedRange

object (AddNamedRangeRequest)

הוספת טווח בעל שם.
deleteNamedRange

object (DeleteNamedRangeRequest)

מחיקה של טווח תאים בעל שם.
addSheet

object (AddSheetRequest)

הוספת גיליון.
deleteSheet

object (DeleteSheetRequest)

מחיקה של גיליון.
autoFill

object (AutoFillRequest)

מילוי אוטומטי של נתונים נוספים על סמך נתונים קיימים.
cutPaste

object (CutPasteRequest)

חיתוך נתונים מאזור אחד והדבקה שלהם באזור אחר.
copyPaste

object (CopyPasteRequest)

העתקת נתונים מאזור אחד והדבקתם באזור אחר.
mergeCells

object (MergeCellsRequest)

מיזוג תאים.
unmergeCells

object (UnmergeCellsRequest)

ביטול המיזוג של תאים.
updateBorders

object (UpdateBordersRequest)

עדכון הגבולות בטווח של תאים.
updateCells

object (UpdateCellsRequest)

עדכון של הרבה תאים בבת אחת.
addFilterView

object (AddFilterViewRequest)

הוספת תצוגת מסנן.
appendCells

object (AppendCellsRequest)

הוספת תאים אחרי השורה האחרונה שמכילה נתונים בגיליון.
clearBasicFilter

object (ClearBasicFilterRequest)

ניקוי המסנן הבסיסי בגיליון.
deleteDimension

object (DeleteDimensionRequest)

מחיקה של שורות או עמודות בגיליון.
deleteEmbeddedObject

object (DeleteEmbeddedObjectRequest)

מחיקה של אובייקט מוטמע (למשל תרשים או תמונה) בגיליון.
deleteFilterView

object (DeleteFilterViewRequest)

מחיקה של תצוגה מסוננת מהגיליון.
duplicateFilterView

object (DuplicateFilterViewRequest)

שכפול של תצוגת מסנן.
duplicateSheet

object (DuplicateSheetRequest)

שכפול של גיליון.
findReplace

object (FindReplaceRequest)

חיפוש והחלפה של מופעים של טקסט מסוים בטקסט אחר.
insertDimension

object (InsertDimensionRequest)

הוספת שורות או עמודות חדשות בגיליון.
insertRange

object (InsertRangeRequest)

הוספת תאים חדשים לגיליון, והזזת התאים הקיימים.
moveDimension

object (MoveDimensionRequest)

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

object (UpdateEmbeddedObjectPositionRequest)

עדכון המיקום של אובייקט מוטמע (למשל, תרשים או תמונה).
pasteData

object (PasteDataRequest)

הדבקת נתונים (HTML או מפורדים) בגיליון.
textToColumns

object (TextToColumnsRequest)

המרת עמודה של טקסט לעמודות רבות של טקסט.
updateFilterView

object (UpdateFilterViewRequest)

עדכון המאפיינים של תצוגה מסוננת.
deleteRange

object (DeleteRangeRequest)

מחיקת טווח של תאים מהגיליון, והזזה של התאים הנותרים.
appendDimension

object (AppendDimensionRequest)

הוספת מאפיינים לסוף הגיליון.
addConditionalFormatRule

object (AddConditionalFormatRuleRequest)

הוספת כלל חדש של עיצוב מותנה.
updateConditionalFormatRule

object (UpdateConditionalFormatRuleRequest)

עדכון של כלל קיים של עיצוב מותנה.
deleteConditionalFormatRule

object (DeleteConditionalFormatRuleRequest)

מחיקה של כלל קיים של עיצוב מותנה.
sortRange

object (SortRangeRequest)

מיון נתונים בטווח.
setDataValidation

object (SetDataValidationRequest)

הגדרת אימות נתונים לתא אחד או יותר.
setBasicFilter

object (SetBasicFilterRequest)

הגדרת המסנן הבסיסי בגיליון.
addProtectedRange

object (AddProtectedRangeRequest)

הוספת טווח תאים מוגן.
updateProtectedRange

object (UpdateProtectedRangeRequest)

עדכון של טווח תאים מוגן.
deleteProtectedRange

object (DeleteProtectedRangeRequest)

מחיקה של טווח תאים מוגן.
autoResizeDimensions

object (AutoResizeDimensionsRequest)

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

object (AddChartRequest)

הוספת תרשים.
updateChartSpec

object (UpdateChartSpecRequest)

עדכון המפרטים של תרשים.
updateBanding

object (UpdateBandingRequest)

עדכון טווח פסגות
addBanding

object (AddBandingRequest)

הוספת טווח חדש עם פס
deleteBanding

object (DeleteBandingRequest)

הסרת טווח עם פס מודגש
createDeveloperMetadata

object (CreateDeveloperMetadataRequest)

יצירת מטא-נתונים חדשים למפתחים
updateDeveloperMetadata

object (UpdateDeveloperMetadataRequest)

עדכון של רשומה קיימת של מטא-נתונים של מפתח
deleteDeveloperMetadata

object (DeleteDeveloperMetadataRequest)

מחיקת המטא-נתונים של המפתח
randomizeRange

object (RandomizeRangeRequest)

סידור אקראי של השורות בטווח.
addDimensionGroup

object (AddDimensionGroupRequest)

יצירת קבוצה בטווח שצוין.
deleteDimensionGroup

object (DeleteDimensionGroupRequest)

מחיקה של קבוצה בטווח שצוין.
updateDimensionGroup

object (UpdateDimensionGroupRequest)

עדכון המצב של הקבוצה שצוינה.
trimWhitespace

object (TrimWhitespaceRequest)

חיתוך תאים של רווחים לבנים (כמו רווחים, כרטיסיות או שורות חדשות).
deleteDuplicates

object (DeleteDuplicatesRequest)

הסרת שורות שמכילות ערכים כפולים בעמודות מסוימות בטווח תאים.
updateEmbeddedObjectBorder

object (UpdateEmbeddedObjectBorderRequest)

עדכון של גבול של אובייקט מוטמע.
addSlicer

object (AddSlicerRequest)

הוספת כלי סינון.
updateSlicerSpec

object (UpdateSlicerSpecRequest)

עדכון המפרטים של כלי החיתוך.
addDataSource

object (AddDataSourceRequest)

הוספת מקור נתונים.
updateDataSource

object (UpdateDataSourceRequest)

עדכון מקור נתונים.
deleteDataSource

object (DeleteDataSourceRequest)

מחיקה של מקור נתונים.
refreshDataSource

object (RefreshDataSourceRequest)

הפונקציה מרעננת מקור נתונים אחד או יותר ואובייקטים משויכים של db.
cancelDataSourceRefresh

object (CancelDataSourceRefreshRequest)

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

object (AddTableRequest)

הוספת טבלה.
updateTable

object (UpdateTableRequest)

עדכון טבלה.
deleteTable

object (DeleteTableRequest)

בקשה למחיקת טבלה.

UpdateSpreadsheetPropertiesRequest

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

ייצוג ב-JSON 
{
  "properties": {
    object (SpreadsheetProperties)
  },
  "fields": string
}
שדות
properties

object (SpreadsheetProperties)

המאפיינים שרוצים לעדכן.
fields

string (FieldMask format)

השדות שצריך לעדכן. צריך לציין שדה אחד לפחות. השורש 'properties' הוא מרומז ואין לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

UpdateSheetPropertiesRequest

עדכון המאפיינים של הגיליון באמצעות sheetId שצוין.

ייצוג ב-JSON 
{
  "properties": {
    object (SheetProperties)
  },
  "fields": string
}
שדות
properties

object (SheetProperties)

המאפיינים שרוצים לעדכן.
fields

string (FieldMask format)

השדות שצריך לעדכן. צריך לציין שדה אחד לפחות. השורש properties הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

UpdateDimensionPropertiesRequest

עדכון המאפיינים של המאפיינים בטווח שצוין.

ייצוג ב-JSON 
{
  "properties": {
    object (DimensionProperties)
  },
  "fields": string,

  // Union field dimension_range can be only one of the following:
  "range": {
    object (DimensionRange)
  },
  "dataSourceSheetRange": {
    object (DataSourceSheetDimensionRange)
  }
  // End of list of possible types for union field dimension_range.
}
שדות
properties

object (DimensionProperties)

הנכסים לעדכון.
fields

string (FieldMask format)

השדות שצריך לעדכן. צריך לציין שדה אחד לפחות. השורש properties הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.
שדה האיחוד dimension_range. טווח המאפיין. הערך של dimension_range יכול להיות רק אחת מהאפשרויות הבאות:
range

object (DimensionRange)

השורות או העמודות שרוצים לעדכן.
dataSourceSheetRange

object (DataSourceSheetDimensionRange)

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

DataSourceSheetDimensionRange

טווח לאורך מאפיין יחיד בגיליון DATA_SOURCE.

ייצוג ב-JSON 
{
  "sheetId": integer,
  "columnReferences": [
    {
      object (DataSourceColumnReference)
    }
  ]
}
שדות
sheetId

integer

המזהה של גיליון מקור הנתונים שבו נמצא הטווח.
columnReferences[]

object (DataSourceColumnReference)

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

UpdateNamedRangeRequest

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

ייצוג ב-JSON 
{
  "namedRange": {
    object (NamedRange)
  },
  "fields": string
}
שדות
namedRange

object (NamedRange)

טווח השמות שרוצים לעדכן עם המאפיינים החדשים.
fields

string (FieldMask format)

השדות שצריך לעדכן. צריך לציין שדה אחד לפחות. השורש namedRange הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

RepeatCellRequest

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

אם כותבים נוסחה בתא, הטווחים של הנוסחה יתעדכנו באופן אוטומטי לכל שדה בטווח. לדוגמה, אם כותבים תא עם הנוסחה =A1 בטווח B2:C4, התא B2 יהיה =A1, התא B3 יהיה =A2, התא B4 יהיה =A3, התא C2 יהיה =B1, התא C3 יהיה =B2 והתא C4 יהיה =B3.

כדי לשמור על טווחי הנוסחה כסטטיים, משתמשים באינדיקטור $. לדוגמה, משתמשים בנוסחה =$A$1 כדי למנוע את העלייה של השורה ושל העמודה.

ייצוג ב-JSON 
{
  "range": {
    object (GridRange)
  },
  "cell": {
    object (CellData)
  },
  "fields": string
}
שדות
range

object (GridRange)

הטווח שבו רוצים לחזור על התא.
cell

object (CellData)

הנתונים שרוצים לכתוב.
fields

string (FieldMask format)

השדות שצריך לעדכן. צריך לציין שדה אחד לפחות. השורש cell הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

AddNamedRangeRequest

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

ייצוג ב-JSON 
{
  "namedRange": {
    object (NamedRange)
  }
}
שדות
namedRange

object (NamedRange)

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

DeleteNamedRangeRequest

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

ייצוג ב-JSON 
{
  "namedRangeId": string
}
שדות
namedRangeId

string

המזהה של טווח התאים בעל השם שרוצים למחוק.

AddSheetRequest

הוספת גיליון חדש. כשמוסיפים גיליון באינדקס נתון, כל האינדקסים של הגיליונות הבאים עולים ב-1. כדי להוסיף גיליון אובייקטים, משתמשים במקום זאת ב-AddChartRequest ומציינים EmbeddedObjectPosition.sheetId או EmbeddedObjectPosition.newSheet.

ייצוג ב-JSON 
{
  "properties": {
    object (SheetProperties)
  }
}
שדות
properties

object (SheetProperties)

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

DeleteSheetRequest

מחיקה של הגיליון המבוקש.

ייצוג ב-JSON 
{
  "sheetId": integer
}
שדות
sheetId

integer

המזהה של הגיליון שרוצים למחוק.

אם הגיליון הוא מסוג DATA_SOURCE, גם ה-DataSource המשויך נמחק.

AutoFillRequest

מילוי נתונים נוספים על סמך נתונים קיימים.

ייצוג ב-JSON 
{
  "useAlternateSeries": boolean,

  // Union field area can be only one of the following:
  "range": {
    object (GridRange)
  },
  "sourceAndDestination": {
    object (SourceAndDestination)
  }
  // End of list of possible types for union field area.
}
שדות
useAlternateSeries

boolean

הערך True (נכון) אם צריך ליצור נתונים עם הסדרה 'חלופית'. משך הזמן משתנה בהתאם לסוג ולכמות של נתוני המקור.
שדה האיחוד area. האזור למילוי אוטומטי. הערך של area יכול להיות רק אחת מהאפשרויות הבאות:
range

object (GridRange)

הטווח למילוי אוטומטי. הפעולה הזו תבדוק את הטווח ותזהה את המיקום שיש בו נתונים, ותמילא את הנתונים האלה בשאר הטווח באופן אוטומטי.
sourceAndDestination

object (SourceAndDestination)

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

SourceAndDestination

שילוב של טווח מקור ואופן ההרחבה של המקור.

ייצוג ב-JSON 
{
  "source": {
    object (GridRange)
  },
  "dimension": enum (Dimension),
  "fillLength": integer
}
שדות
source

object (GridRange)

המיקום של הנתונים שישמשו כמקור למילוי האוטומטי.
dimension

enum (Dimension)

המאפיין שאליו צריך למלא את הנתונים.
fillLength

integer

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

CutPasteRequest

העברת נתונים מהמקור ליעד.

ייצוג ב-JSON 
{
  "source": {
    object (GridRange)
  },
  "destination": {
    object (GridCoordinate)
  },
  "pasteType": enum (PasteType)
}
שדות
source

object (GridRange)

נתוני המקור לחיתוך.
destination

object (GridCoordinate)

הקואורדינטה הימנית העליונה שבה צריך להדביק את הנתונים.
pasteType

enum (PasteType)

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

PasteType

איזה סוג נתונים צריך להדביק.

טיפוסים בני מנייה (enum)
PASTE_NORMAL הדבקת ערכים, נוסחאות, פורמטים ומיזוגים.
PASTE_VALUES מדביקים את הערכים בלבד, ללא פורמטים, נוסחאות או מיזוגים.
PASTE_FORMAT מדביקים את העיצוב ואת אימות הנתונים בלבד.
PASTE_NO_BORDERS כמו PASTE_NORMAL אבל בלי גבולות.
PASTE_FORMULA מדביקים את הנוסחאות בלבד.
PASTE_DATA_VALIDATION מדביקים רק את אימות הנתונים.
PASTE_CONDITIONAL_FORMATTING מדביקים רק את כללי העיצוב המותנה.

CopyPasteRequest

העתקת נתונים מהמקור ליעד.

ייצוג ב-JSON 
{
  "source": {
    object (GridRange)
  },
  "destination": {
    object (GridRange)
  },
  "pasteType": enum (PasteType),
  "pasteOrientation": enum (PasteOrientation)
}
שדות
source

object (GridRange)

טווח המקור להעתקה.
destination

object (GridRange)

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

enum (PasteType)

סוג הנתונים שרוצים להדביק.
pasteOrientation

enum (PasteOrientation)

איך הנתונים האלה צריכים להיות בכיוון כשמדביקים אותם.

PasteOrientation

איך מבצעים פעולת הדבקה.

טיפוסים בני מנייה (enum)
NORMAL מדביקים כרגיל.
TRANSPOSE הדבקה בטרנספוזיציה, שבה כל השורות הופכות לעמודות ולהפך.

MergeCellsRequest

מיזוג כל התאים בטווח.

ייצוג ב-JSON 
{
  "range": {
    object (GridRange)
  },
  "mergeType": enum (MergeType)
}
שדות
range

object (GridRange)

טווח התאים שרוצים למזג.
mergeType

enum (MergeType)

איך צריך למזג את התאים.

MergeType

סוג המיזוג שייווצר.

טיפוסים בני מנייה (enum)
MERGE_ALL יצירת מיזוג יחיד מהטווח
MERGE_COLUMNS יוצרים מיזוג לכל עמודה בטווח
MERGE_ROWS יצירת מיזוג לכל שורה בטווח

UnmergeCellsRequest

ביטול המיזוג של תאים בטווח הנתון.

ייצוג ב-JSON 
{
  "range": {
    object (GridRange)
  }
}
שדות
range

object (GridRange)

הטווח שבו צריך לבטל את המיזוג של כל התאים. אם הטווח כולל כמה מיזוגים, כל המיזוגים יבוטלו. הטווח לא יכול לחפוף באופן חלקי למיזוג כלשהו.

UpdateBordersRequest

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

  1. range: A1:A5 { top: RED, bottom: WHITE }
  2. range: A1:A5 { left: BLUE }

כתוצאה מכך, יהיו ל-A1:A5 גבולות של { top: RED, bottom: WHITE, left: BLUE }. כדי להסיר גבול, מגדירים את הסגנון באופן מפורש כ-NONE.

ייצוג ב-JSON 
{
  "range": {
    object (GridRange)
  },
  "top": {
    object (Border)
  },
  "bottom": {
    object (Border)
  },
  "left": {
    object (Border)
  },
  "right": {
    object (Border)
  },
  "innerHorizontal": {
    object (Border)
  },
  "innerVertical": {
    object (Border)
  }
}
שדות
range

object (GridRange)

הטווח שרוצים לעדכן את הגבולות שלו.
top

object (Border)

הגבול שיוצג בחלק העליון של הטווח.
bottom

object (Border)

הגבול שיוצג בתחתית הטווח.
left

object (Border)

הגבול שיוצג בצד ימין של הטווח.
right

object (Border)

הגבול שיוצג בצד שמאל של הטווח.
innerHorizontal

object (Border)

הגבול האנכי שיוצג בתוך הטווח.
innerVertical

object (Border)

הגבול האנכי שיוצג בתוך הטווח.

UpdateCellsRequest

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

ייצוג ב-JSON 
{
  "rows": [
    {
      object (RowData)
    }
  ],
  "fields": string,

  // Union field area can be only one of the following:
  "start": {
    object (GridCoordinate)
  },
  "range": {
    object (GridRange)
  }
  // End of list of possible types for union field area.
}
שדות
rows[]

object (RowData)

הנתונים שרוצים לכתוב.
fields

string (FieldMask format)

השדות של CellData שצריך לעדכן. צריך לציין שדה אחד לפחות. הבסיס הוא CellData.אין לציין את 'row.values'. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.
שדה האיחוד area. צריך לכתוב את נתוני המיקום. חובה להגדיר ערך אחד בלבד. הערך של area יכול להיות רק אחת מהאפשרויות הבאות:
start

object (GridCoordinate)

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

object (GridRange)

הטווח שאליו רוצים לכתוב נתונים.

אם הנתונים בשורות לא מכסים את כל הטווח המבוקש, השדות שתואמים לאלה שהוגדרו ב-fields יימחקו.

AddFilterViewRequest

הוספת תצוגת מסנן.

ייצוג ב-JSON 
{
  "filter": {
    object (FilterView)
  }
}
שדות
filter

object (FilterView)

המסנן שרוצים להוסיף. השדה filterViewId הוא אופציונלי. אם לא מגדירים מזהה, המערכת תיצור מזהה באופן אקראי. (אסור לציין את המזהה של מסנן שכבר קיים).

AppendCellsRequest

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

ייצוג ב-JSON 
{
  "sheetId": integer,
  "rows": [
    {
      object (RowData)
    }
  ],
  "fields": string,

  // Union field area can be only one of the following:
  "tableId": string
  // End of list of possible types for union field area.
}
שדות
sheetId

integer

מזהה הגיליון שאליו רוצים לצרף את הנתונים.
rows[]

object (RowData)

הנתונים שרוצים לצרף.
fields

string (FieldMask format)

השדות של CellData שצריך לעדכן. צריך לציין שדה אחד לפחות. הבסיס הוא CellData.אין לציין את 'row.values'. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.
שדה האיחוד area. צריך לכתוב את נתוני המיקום. הערך של area יכול להיות רק אחת מהאפשרויות הבאות:
tableId

string

המזהה של הטבלה שאליה רוצים לצרף נתונים. הנתונים יתווספו רק לגוף הטבלה.

השדה הזה מקבל עדיפות גם על פני השדה sheetId.

ClearBasicFilterRequest

ניקוי המסנן הבסיסי, אם קיים כזה בגיליון.

ייצוג ב-JSON 
{
  "sheetId": integer
}
שדות
sheetId

integer

מזהה הגיליון שבו צריך לנקות את המסנן הבסיסי.

DeleteDimensionRequest

המחיקה של המאפיינים מהגיליון.

ייצוג ב-JSON 
{
  "range": {
    object (DimensionRange)
  }
}
שדות
range

object (DimensionRange)

המאפיינים שרוצים למחוק מהגיליון.

DeleteEmbeddedObjectRequest

מחיקה של האובייקט המוטמע עם המזהה הנתון.

ייצוג ב-JSON 
{
  "objectId": integer
}
שדות
objectId

integer

המזהה של האובייקט המוטמע שרוצים למחוק.

DeleteFilterViewRequest

מחיקה של תצוגת סינון מסוימת.

ייצוג ב-JSON 
{
  "filterId": integer
}
שדות
filterId

integer

המזהה של המסנן שרוצים למחוק.

DuplicateFilterViewRequest

שכפול של תצוגת מסנן מסוימת.

ייצוג ב-JSON 
{
  "filterId": integer
}
שדות
filterId

integer

המזהה של המסנן שמבוצעת עבורו שכפול.

DuplicateSheetRequest

העתקה כפולה של תוכן גיליון.

ייצוג ב-JSON 
{
  "sourceSheetId": integer,
  "insertSheetIndex": integer,
  "newSheetId": integer,
  "newSheetName": string
}
שדות
sourceSheetId

integer

הגיליון שרוצים לשכפל.

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

integer

האינדקס שמתחיל ב-0 שבו צריך להוסיף את הגיליון החדש. האינדקס של כל הגיליונות אחרי זה יגדל.
newSheetId

integer

אם הוגדר, המזהה של הגיליון החדש. אם לא מגדירים את הפרמטר, המערכת בוחרת מזהה. אם מגדירים מזהה, הוא לא יכול להיות זהה למזהה של גיליון קיים. אם הוא מוגדר, הערך שלו חייב להיות לא שלילי.
newSheetName

string

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

FindReplaceRequest

חיפוש והחלפה של נתונים בתאים בטווח, בגיליון או בכל הגיליונות.

ייצוג ב-JSON 
{
  "find": string,
  "replacement": string,
  "matchCase": boolean,
  "matchEntireCell": boolean,
  "searchByRegex": boolean,
  "includeFormulas": boolean,

  // Union field scope can be only one of the following:
  "range": {
    object (GridRange)
  },
  "sheetId": integer,
  "allSheets": boolean
  // End of list of possible types for union field scope.
}
שדות
find

string

הערך שרוצים לחפש.
replacement

string

הערך שישמש כהחלפה.
matchCase

boolean

הערך TRUE אם החיפוש תלוי אותיות רישיות.
matchEntireCell

boolean

הערך True אם ערך החיפוש צריך להתאים לכל התא.
searchByRegex

boolean

הערך True מוחזר אם ערך החיפוש הוא ביטוי רגולרי. הביטוי הרגולרי וההחלפה צריכים לפעול בהתאם לכללי ה-regex של Java שמפורטים בכתובת https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html. מחרוזת ההחלפה יכולה להפנות לקבוצות תיעוד. לדוגמה, אם בתא אחד יש את התוכן "Google Sheets" ובתא אחר יש את התוכן "Google Docs", חיפוש של "o.* (.*)" עם החלפה של "$1 Rocks" ישנה את התוכן של התאים ל-"GSheets Rocks" ול-"GDocs Rocks", בהתאמה.
includeFormulas

boolean

הערך True (נכון) אם החיפוש צריך לכלול תאים עם נוסחאות. False כדי לדלג על תאים עם נוסחאות.
שדה האיחוד scope. ההיקף שבו מתבצע החיפוש/ההחלפה – צריך להגדיר רק היקף אחד. הערך של scope יכול להיות רק אחת מהאפשרויות הבאות:
range

object (GridRange)

הטווח שבו יתבצע החיפוש/ההחלפה.
sheetId

integer

הגיליון שבו יתבצע החיפוש/ההחלפה.
allSheets

boolean

הערך True מאפשר לבצע חיפוש והחלפה בכל הגיליונות.

InsertDimensionRequest

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

ייצוג ב-JSON 
{
  "range": {
    object (DimensionRange)
  },
  "inheritFromBefore": boolean
}
שדות
range

object (DimensionRange)

המאפיינים שרוצים להוסיף. גם אינדקס ההתחלה וגם אינדקס הסיום חייבים להיות מוגבלים.
inheritFromBefore

boolean

האם צריך להרחיב את מאפייני המאפיינים מהמאפיינים לפני או אחרי המאפיינים החדשים שהוכנסו. הערך True מאפשר לקבל בירושה מהמאפיינים שלפני (במקרה כזה, אינדקס ההתחלה חייב להיות גדול מ-0), והערך False מאפשר לקבל בירושה מהמאפיינים שאחרי.

לדוגמה, אם לשורה עם אינדקס 0 יש רקע אדום ולשורה עם אינדקס 1 יש רקע ירוק, הוספת 2 שורות באינדקס 1 יכולה לרשת את הרקע הירוק או האדום. אם הערך של inheritFromBefore הוא true, שתי השורות החדשות יהיו בצבע אדום (כי השורה שלפני נקודת ההוספה הייתה בצבע אדום). לעומת זאת, אם הערך של inheritFromBefore הוא false, שתי השורות החדשות יהיו בצבע ירוק (כי השורה שלאחר נקודת ההוספה הייתה בצבע ירוק).

InsertRangeRequest

הוספת תאים לטווח, והזזה של התאים הקיימים לצד או למטה.

ייצוג ב-JSON 
{
  "range": {
    object (GridRange)
  },
  "shiftDimension": enum (Dimension)
}
שדות
range

object (GridRange)

הטווח שאליו רוצים להוסיף תאים חדשים. הטווח מוגבל לגבולות הגיליון הנוכחי.
shiftDimension

enum (Dimension)

המאפיין שיזוז כשתוסיפו תאים. אם הערך הוא ROWS, התאים הקיימים יוזזו למטה. אם הערך הוא COLUMNS, התאים הקיימים יוזזו ימינה.

MoveDimensionRequest

העברה של שורה או עמודה אחת או יותר.

ייצוג ב-JSON 
{
  "source": {
    object (DimensionRange)
  },
  "destinationIndex": integer
}
שדות
source

object (DimensionRange)

מאפייני המקור שרוצים להעביר.
destinationIndex

integer

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

לדוגמה, אם A1..A5 של 0, 1, 2, 3, 4 רוצה להעביר את "1" ו-"2" בין "3" ל-"4", המקור יהיה ROWS [1..3) ואינדקס היעד יהיה "4" (האינדקס שמתחיל באפס של שורה 5). התוצאה הסופית תהיה A1..A5 מתוך 0, 3, 1, 2, 4.

UpdateEmbeddedObjectPositionRequest

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

ייצוג ב-JSON 
{
  "objectId": integer,
  "newPosition": {
    object (EmbeddedObjectPosition)
  },
  "fields": string
}
שדות
objectId

integer

המזהה של האובייקט שרוצים להעביר.
newPosition

object (EmbeddedObjectPosition)

מיקום מפורש שאליו רוצים להעביר את האובייקט המוטמע. אם הערך של newPosition.sheetId מוגדר, המערכת תיצור גיליון חדש עם המזהה הזה. אם הערך של newPosition.newSheet מוגדר כ-true, המערכת תיצור גיליון חדש עם מזהה שייבחר בשבילכם.
fields

string (FieldMask format)

השדות של OverlayPosition שצריך לעדכן כשמגדירים מיקום חדש. השדה הזה משמש רק אם השדה newPosition.overlayPosition מוגדר, ובמקרה כזה צריך לציין לפחות שדה אחד. השורש newPosition.overlayPosition הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

PasteDataRequest

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

ייצוג ב-JSON 
{
  "coordinate": {
    object (GridCoordinate)
  },
  "data": string,
  "type": enum (PasteType),

  // Union field kind can be only one of the following:
  "delimiter": string,
  "html": boolean
  // End of list of possible types for union field kind.
}
שדות
coordinate

object (GridCoordinate)

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

string

הנתונים להוספה.
type

enum (PasteType)

איך צריך להדביק את הנתונים.
שדה האיחוד kind. כדי לפרש את הנתונים, צריך להגדיר ערך אחד בלבד. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות:
delimiter

string

המפריד בנתונים.
html

boolean

הערך True מוחזר אם הנתונים הם בפורמט HTML.

TextToColumnsRequest

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

ייצוג ב-JSON 
{
  "source": {
    object (GridRange)
  },
  "delimiter": string,
  "delimiterType": enum (DelimiterType)
}
שדות
source

object (GridRange)

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

string

סוג המפריד שצריך להשתמש בו. משמש רק אם הערך של delimiterType הוא CUSTOM.
delimiterType

enum (DelimiterType)

סוג המפריד שצריך להשתמש בו.

DelimiterType

התו המפריד שבו רוצים לפצל.

טיפוסים בני מנייה (enum)
DELIMITER_TYPE_UNSPECIFIED ערך ברירת המחדל. אסור להשתמש בערך הזה.
COMMA ‎","‎
SEMICOLON ";"
PERIOD "."
SPACE " "
CUSTOM ערך מותאם אישית כפי שמוגדר ב-delimiter.
AUTODETECT זיהוי אוטומטי של עמודות.

UpdateFilterViewRequest

עדכון המאפיינים של תצוגת המסנן.

ייצוג ב-JSON 
{
  "filter": {
    object (FilterView)
  },
  "fields": string
}
שדות
filter

object (FilterView)

המאפיינים החדשים של תצוגת המסנן.
fields

string (FieldMask format)

השדות שצריך לעדכן. צריך לציין שדה אחד לפחות. השורש filter הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

DeleteRangeRequest

הפונקציה מוחקת טווח של תאים ומזיזה תאים אחרים לאזור שנמחק.

ייצוג ב-JSON 
{
  "range": {
    object (GridRange)
  },
  "shiftDimension": enum (Dimension)
}
שדות
range

object (GridRange)

טווח התאים שרוצים למחוק.
shiftDimension

enum (Dimension)

המאפיין שבו יתבצע החלפה של תאים שנמחקו. אם הערך הוא ROWS, התאים הקיימים יוזזו למעלה כדי להחליף את התאים שנמחקו. אם הערך הוא COLUMNS, התאים הקיימים יוזזו שמאלה כדי להחליף את התאים שנמחקו.

AppendDimensionRequest

הוספת שורות או עמודות לסוף גיליון.

ייצוג ב-JSON 
{
  "sheetId": integer,
  "dimension": enum (Dimension),
  "length": integer
}
שדות
sheetId

integer

הגיליון שאליו רוצים לצרף שורות או עמודות.
dimension

enum (Dimension)

האם צריך לצרף שורות או עמודות.
length

integer

מספר השורות או העמודות שרוצים לצרף.

AddConditionalFormatRuleRequest

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

ייצוג ב-JSON 
{
  "rule": {
    object (ConditionalFormatRule)
  },
  "index": integer
}
שדות
rule

object (ConditionalFormatRule)

הכלל שרוצים להוסיף.
index

integer

האינדקס (מספר המיקום) שמתחיל ב-0 שבו צריך להוסיף את הכלל.

UpdateConditionalFormatRuleRequest

עדכון כלל של עיצוב מותנה במדד הנתון, או העברת כלל של עיצוב מותנה למדד אחר.

ייצוג ב-JSON 
{
  "index": integer,
  "sheetId": integer,

  // Union field instruction can be only one of the following:
  "rule": {
    object (ConditionalFormatRule)
  },
  "newIndex": integer
  // End of list of possible types for union field instruction.
}
שדות
index

integer

האינדקס שמתחיל באפס של הכלל שרוצים להחליף או להעביר.
sheetId

integer

הגיליון של הכלל שרוצים להעביר. חובה אם newIndex מוגדר, לא בשימוש אחרת.
שדה האיחוד instruction. סוג העדכון שצריך להתבצע. הערך של instruction יכול להיות רק אחת מהאפשרויות הבאות:
rule

object (ConditionalFormatRule)

הכלל שצריך להחליף את הכלל במדד הנתון.
newIndex

integer

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

DeleteConditionalFormatRuleRequest

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

ייצוג ב-JSON 
{
  "index": integer,
  "sheetId": integer
}
שדות
index

integer

האינדקס שמתחיל ב-0 של הכלל שרוצים למחוק.
sheetId

integer

הגיליון שממנו הכלל נמחק.

SortRangeRequest

מיון הנתונים בשורות לפי סדר מיון לכל עמודה.

ייצוג ב-JSON 
{
  "range": {
    object (GridRange)
  },
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ]
}
שדות
range

object (GridRange)

הטווח למיון.
sortSpecs[]

object (SortSpec)

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

SetDataValidationRequest

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

ייצוג ב-JSON 
{
  "range": {
    object (GridRange)
  },
  "rule": {
    object (DataValidationRule)
  },
  "filteredRowsIncluded": boolean
}
שדות
range

object (GridRange)

הטווח שאליו צריך לחול כלל אימות הנתונים.
rule

object (DataValidationRule)

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

boolean

אופציונלי. אם הערך הוא true, כלל אימות הנתונים יחול גם על השורות המסוננות.

SetBasicFilterRequest

הגדרת המסנן הבסיסי שמשויך לגיליון.

ייצוג ב-JSON 
{
  "filter": {
    object (BasicFilter)
  }
}
שדות
filter

object (BasicFilter)

המסנן שרוצים להגדיר.

AddProtectedRangeRequest

הוספת טווח תאים מוגן חדש.

ייצוג ב-JSON 
{
  "protectedRange": {
    object (ProtectedRange)
  }
}
שדות
protectedRange

object (ProtectedRange)

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

UpdateProtectedRangeRequest

עדכון של טווח מוגן קיים באמצעות protectedRangeId שצוין.

ייצוג ב-JSON 
{
  "protectedRange": {
    object (ProtectedRange)
  },
  "fields": string
}
שדות
protectedRange

object (ProtectedRange)

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

string (FieldMask format)

השדות שצריך לעדכן. צריך לציין שדה אחד לפחות. השורש protectedRange הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

DeleteProtectedRangeRequest

מחיקה של טווח התאים המוגן עם המזהה שצוין.

ייצוג ב-JSON 
{
  "protectedRangeId": integer
}
שדות
protectedRangeId

integer

המזהה של טווח התאים המוגן שרוצים למחוק.

AutoResizeDimensionsRequest

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

ייצוג ב-JSON 
{

  // Union field dimension_range can be only one of the following:
  "dimensions": {
    object (DimensionRange)
  },
  "dataSourceSheetDimensions": {
    object (DataSourceSheetDimensionRange)
  }
  // End of list of possible types for union field dimension_range.
}
שדות
שדה האיחוד dimension_range. טווח המאפיין. הערך של dimension_range יכול להיות רק אחת מהאפשרויות הבאות:
dimensions

object (DimensionRange)

המאפיינים שרוצים לשנות את הגודל שלהם באופן אוטומטי.
dataSourceSheetDimensions

object (DataSourceSheetDimensionRange)

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

AddChartRequest

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

ייצוג ב-JSON 
{
  "chart": {
    object (EmbeddedChart)
  }
}
שדות
chart

object (EmbeddedChart)

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

UpdateChartSpecRequest

עדכון המפרטים של תרשים. (הפעולה הזו לא מעבירה או משנה את הגודל של התרשים. כדי להזיז או לשנות את הגודל של תרשים, משתמשים ב-UpdateEmbeddedObjectPositionRequest.)

ייצוג ב-JSON 
{
  "chartId": integer,
  "spec": {
    object (ChartSpec)
  }
}
שדות
chartId

integer

המזהה של התרשים שרוצים לעדכן.
spec

object (ChartSpec)

המפרט שרוצים להחיל על התרשים.

UpdateBandingRequest

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

ייצוג ב-JSON 
{
  "bandedRange": {
    object (BandedRange)
  },
  "fields": string
}
שדות
bandedRange

object (BandedRange)

טווח הפסים שרוצים לעדכן עם המאפיינים החדשים.
fields

string (FieldMask format)

השדות שצריך לעדכן. צריך לציין שדה אחד לפחות. השורש bandedRange הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

AddBandingRequest

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

ייצוג ב-JSON 
{
  "bandedRange": {
    object (BandedRange)
  }
}
שדות
bandedRange

object (BandedRange)

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

DeleteBandingRequest

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

ייצוג ב-JSON 
{
  "bandedRangeId": integer
}
שדות
bandedRangeId

integer

המזהה של טווח הפס למחיקה.

CreateDeveloperMetadataRequest

בקשה ליצירת מטא-נתונים של מפתח.

ייצוג ב-JSON 
{
  "developerMetadata": {
    object (DeveloperMetadata)
  }
}
שדות
developerMetadata

object (DeveloperMetadata)

המטא-נתונים של המפתח שרוצים ליצור.

UpdateDeveloperMetadataRequest

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

ייצוג ב-JSON 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "developerMetadata": {
    object (DeveloperMetadata)
  },
  "fields": string
}
שדות
dataFilters[]

object (DataFilter)

המסננים שתואמים לרשאות המטא-נתונים של המפתח שרוצים לעדכן.
developerMetadata

object (DeveloperMetadata)

הערך שאליו יתעדכנו כל המטא-נתונים שתואמים למסנני הנתונים.
fields

string (FieldMask format)

השדות שצריך לעדכן. צריך לציין שדה אחד לפחות. השורש developerMetadata הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

DeleteDeveloperMetadataRequest

בקשה למחיקת מטא-נתונים של מפתח.

ייצוג ב-JSON 
{
  "dataFilter": {
    object (DataFilter)
  }
}
שדות
dataFilter

object (DataFilter)

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

RandomizeRangeRequest

סידור אקראי של השורות בטווח.

ייצוג ב-JSON 
{
  "range": {
    object (GridRange)
  }
}
שדות
range

object (GridRange)

הטווח שרוצים לבצע בו רנדומיזציה.

AddDimensionGroupRequest

יצירת קבוצה בטווח שצוין.

אם הטווח המבוקש הוא קבוצת-על של הטווח של קבוצה קיימת G, עולים ב-1 בערך של העומק של G, והקבוצה החדשה G' תקבל את העומק של הקבוצה הזו. לדוגמה, הקבוצה [C:D, עומק 1] + [B:E] מניבה את הקבוצות [B:E, עומק 1] ו-[C:D, עומק 2]. אם הטווח המבוקש הוא קבוצת משנה של הטווח של קבוצה קיימת G, עומק הקבוצה החדשה G' יהיה גדול באחד מעומקו של G. לדוגמה, הקבוצה [B:E, עומק 1] + [C:D] מניבה את הקבוצות [B:E, עומק 1] ו-[C:D, עומק 2]. אם הטווח המבוקש מתחיל לפני הטווח של קבוצה קיימת G ומסתיים בטווח הזה, או מתחיל בטווח הזה ומסתיים אחריו, הטווח של הקבוצה הקיימת G הופך לאיחוד הטווחים, והקבוצה החדשה G' תהיה עמוקה יותר ב-1 מהקבוצה G, והטווח שלה יהיה החיתוך של הטווחים. לדוגמה, הקבוצה [B:D, עומק 1] + [C:E] מניבה את הקבוצות [B:E, עומק 1] ו-[C:D, עומק 2].

ייצוג ב-JSON 
{
  "range": {
    object (DimensionRange)
  }
}
שדות
range

object (DimensionRange)

הטווח שבו רוצים ליצור קבוצה.

DeleteDimensionGroupRequest

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

לדוגמה, נניח שבגיליון יש קבוצה ברמה 1 על פני B:E וקבוצה ברמה 2 על פני C:D. אם מוחקים קבוצה ב-D:E, בגיליון נשארת קבוצה ברמה 1 ב-B:D וקבוצה ברמה 2 ב-C:C.

ייצוג ב-JSON 
{
  "range": {
    object (DimensionRange)
  }
}
שדות
range

object (DimensionRange)

הטווח של הקבוצה שרוצים למחוק.

UpdateDimensionGroupRequest

עדכון המצב של הקבוצה שצוינה.

ייצוג ב-JSON 
{
  "dimensionGroup": {
    object (DimensionGroup)
  },
  "fields": string
}
שדות
dimensionGroup

object (DimensionGroup)

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

string (FieldMask format)

השדות שצריך לעדכן. צריך לציין שדה אחד לפחות. השורש dimensionGroup הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

TrimWhitespaceRequest

חיתוך הרווחים הלבנים (כמו רווחים, טאבים או שורות חדשות) בכל תא בטווח שצוין. הבקשה הזו מסירה את כל הרווחים הלבנים מתחילת הטקסט של כל תא ומסופו, ומצמצמת כל רצף משנה של תווי רווח לבנים שנותרו לרווח יחיד. אם הטקסט שנחתך בתוצאה מתחיל בתווים '+' או '=', הטקסט יישאר כערך מחרוזת ולא יפורש כנוסחה.

ייצוג ב-JSON 
{
  "range": {
    object (GridRange)
  }
}
שדות
range

object (GridRange)

הטווח של התאים שרוצים לקצץ.

DeleteDuplicatesRequest

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

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

ייצוג ב-JSON 
{
  "range": {
    object (GridRange)
  },
  "comparisonColumns": [
    {
      object (DimensionRange)
    }
  ]
}
שדות
range

object (GridRange)

הטווח שממנו רוצים להסיר שורות כפולות.
comparisonColumns[]

object (DimensionRange)

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

UpdateEmbeddedObjectBorderRequest

עדכון מאפיין הגבול של אובייקט מוטמע.

ייצוג ב-JSON 
{
  "objectId": integer,
  "border": {
    object (EmbeddedObjectBorder)
  },
  "fields": string
}
שדות
objectId

integer

המזהה של האובייקט המוטמע שרוצים לעדכן.
border

object (EmbeddedObjectBorder)

הגבול שחלה על האובייקט המוטמע.
fields

string (FieldMask format)

השדות שצריך לעדכן. צריך לציין שדה אחד לפחות. השורש border הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

AddSlicerRequest

הוספת כלי חיתוך לגיליון בגיליון האלקטרוני.

ייצוג ב-JSON 
{
  "slicer": {
    object (Slicer)
  }
}
שדות
slicer

object (Slicer)

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

UpdateSlicerSpecRequest

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

ייצוג ב-JSON 
{
  "slicerId": integer,
  "spec": {
    object (SlicerSpec)
  },
  "fields": string
}
שדות
slicerId

integer

המזהה של כלי הסינון שרוצים לעדכן.
spec

object (SlicerSpec)

המפרט שרוצים להחיל על הכלי לחתימה.
fields

string (FieldMask format)

השדות שצריך לעדכן. צריך לציין שדה אחד לפחות. השורש SlicerSpec הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-'*' אחד כקיצור דרך להצגת כל השדות.

AddDataSourceRequest

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

אם מוסיפים מקור נתונים של BigQuery, צריך להוסיף לבקשה היקף הרשאה נוסף של OAuth‏ bigquery.readonly.

ייצוג ב-JSON 
{
  "dataSource": {
    object (DataSource)
  }
}
שדות
dataSource

object (DataSource)

מקור הנתונים שרוצים להוסיף.

UpdateDataSourceRequest

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

אם מעדכנים מקור נתונים של BigQuery, צריך להוסיף לבקשה היקף OAuth נוסף bigquery.readonly.

ייצוג ב-JSON 
{
  "dataSource": {
    object (DataSource)
  },
  "fields": string
}
שדות
dataSource

object (DataSource)

מקור הנתונים שרוצים לעדכן.
fields

string (FieldMask format)

השדות שצריך לעדכן. צריך לציין שדה אחד לפחות. השורש dataSource הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

DeleteDataSourceRequest

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

ייצוג ב-JSON 
{
  "dataSourceId": string
}
שדות
dataSourceId

string

המזהה של מקור הנתונים שרוצים למחוק.

RefreshDataSourceRequest

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

אם מרעננים מקור נתונים של BigQuery, צריך להוסיף לבקשה היקף OAuth נוסף bigquery.readonly.

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

ייצוג ב-JSON 
{
  "force": boolean,

  // Union field target can be only one of the following:
  "references": {
    object (DataSourceObjectReferences)
  },
  "dataSourceId": string,
  "isAll": boolean
  // End of list of possible types for union field target.
}
שדות
force

boolean

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

object (DataSourceObjectReferences)

הפניות לאובייקטים של מקורות נתונים שרוצים לרענן.
dataSourceId

string

הפניה ל-DataSource. אם מצוין, מתבצע רענון של כל האובייקטים שמשויכים למקור הנתונים.
isAll

boolean

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

DataSourceObjectReferences

רשימת הפניות לאובייקטים של מקורות נתונים.

ייצוג ב-JSON 
{
  "references": [
    {
      object (DataSourceObjectReference)
    }
  ]
}
שדות
references[]

object (DataSourceObjectReference)

קובצי העזר.

DataSourceObjectReference

הפניה לאובייקט של מקור נתונים.

ייצוג ב-JSON 
{

  // Union field value can be only one of the following:
  "sheetId": string,
  "chartId": integer,
  "dataSourceTableAnchorCell": {
    object (GridCoordinate)
  },
  "dataSourcePivotTableAnchorCell": {
    object (GridCoordinate)
  },
  "dataSourceFormulaCell": {
    object (GridCoordinate)
  }
  // End of list of possible types for union field value.
}
שדות
שדה האיחוד value. סוג קובץ העזר. הערך של value יכול להיות רק אחת מהאפשרויות הבאות:
sheetId

string

הפניות לגיליון DATA_SOURCE.
chartId

integer

הפניות לתרשים של מקור נתונים.
dataSourceTableAnchorCell

object (GridCoordinate)

הפניות ל-DataSourceTable שמקובע לתא.
dataSourcePivotTableAnchorCell

object (GridCoordinate)

הפניות למקור נתונים PivotTable שמקובעות לתא.
dataSourceFormulaCell

object (GridCoordinate)

הפניות לתא שמכיל את הערך DataSourceFormula.

CancelDataSourceRefreshRequest

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

אם מבטלים רענון במקור נתונים של BigQuery, צריך להוסיף לבקשה היקף OAuth bigquery.readonly.

ייצוג ב-JSON 
{

  // Union field target can be only one of the following:
  "references": {
    object (DataSourceObjectReferences)
  },
  "dataSourceId": string,
  "isAll": boolean
  // End of list of possible types for union field target.
}
שדות
שדה האיחוד target. מציין מה לבטל. הערך של target יכול להיות רק אחת מהאפשרויות הבאות:
references

object (DataSourceObjectReferences)

הפניות לאובייקטים של מקורות נתונים שרוצים לבטל את הרענון שלהם.
dataSourceId

string

הפניה ל-DataSource. אם מצוין, מבטל את כל הרענונים של אובייקטים משויכים של מקור הנתונים הזה.
isAll

boolean

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

AddTableRequest

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

ייצוג ב-JSON 
{
  "table": {
    object (Table)
  }
}
שדות
table

object (Table)

חובה. הטבלה שרוצים להוסיף.

UpdateTableRequest

עדכון טבלה בגיליון האלקטרוני.

ייצוג ב-JSON 
{
  "table": {
    object (Table)
  },
  "fields": string
}
שדות
table

object (Table)

חובה. הטבלה שרוצים לעדכן.
fields

string (FieldMask format)

חובה. השדות שצריך לעדכן. צריך לציין שדה אחד לפחות. השורש table הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

DeleteTableRequest

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

ייצוג ב-JSON 
{
  "tableId": string
}
שדות
tableId

string

המזהה של הטבלה שרוצים למחוק.

תשובה

תשובה אחת מעדכון.

ייצוג ב-JSON 
{

  // Union field kind can be only one of the following:
  "addNamedRange": {
    object (AddNamedRangeResponse)
  },
  "addSheet": {
    object (AddSheetResponse)
  },
  "addFilterView": {
    object (AddFilterViewResponse)
  },
  "duplicateFilterView": {
    object (DuplicateFilterViewResponse)
  },
  "duplicateSheet": {
    object (DuplicateSheetResponse)
  },
  "findReplace": {
    object (FindReplaceResponse)
  },
  "updateEmbeddedObjectPosition": {
    object (UpdateEmbeddedObjectPositionResponse)
  },
  "updateConditionalFormatRule": {
    object (UpdateConditionalFormatRuleResponse)
  },
  "deleteConditionalFormatRule": {
    object (DeleteConditionalFormatRuleResponse)
  },
  "addProtectedRange": {
    object (AddProtectedRangeResponse)
  },
  "addChart": {
    object (AddChartResponse)
  },
  "addBanding": {
    object (AddBandingResponse)
  },
  "createDeveloperMetadata": {
    object (CreateDeveloperMetadataResponse)
  },
  "updateDeveloperMetadata": {
    object (UpdateDeveloperMetadataResponse)
  },
  "deleteDeveloperMetadata": {
    object (DeleteDeveloperMetadataResponse)
  },
  "addDimensionGroup": {
    object (AddDimensionGroupResponse)
  },
  "deleteDimensionGroup": {
    object (DeleteDimensionGroupResponse)
  },
  "trimWhitespace": {
    object (TrimWhitespaceResponse)
  },
  "deleteDuplicates": {
    object (DeleteDuplicatesResponse)
  },
  "addSlicer": {
    object (AddSlicerResponse)
  },
  "addDataSource": {
    object (AddDataSourceResponse)
  },
  "updateDataSource": {
    object (UpdateDataSourceResponse)
  },
  "refreshDataSource": {
    object (RefreshDataSourceResponse)
  },
  "cancelDataSourceRefresh": {
    object (CancelDataSourceRefreshResponse)
  }
  // End of list of possible types for union field kind.
}
שדות
שדה האיחוד kind. סוג התשובה. יכול להיות שלא יוגדרו שדות אם לא הייתה תשובה לבקשה. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות:
addNamedRange

object (AddNamedRangeResponse)

תשובה מהוספת טווח בעל שם.
addSheet

object (AddSheetResponse)

תשובה מהוספת גיליון.
addFilterView

object (AddFilterViewResponse)

תשובה מהוספת תצוגת מסנן.
duplicateFilterView

object (DuplicateFilterViewResponse)

תשובה על שכפול של תצוגת מסנן.
duplicateSheet

object (DuplicateSheetResponse)

תשובה מהכפילת גיליון.
findReplace

object (FindReplaceResponse)

תשובה מהפעלת חיפוש/החלפה.
updateEmbeddedObjectPosition

object (UpdateEmbeddedObjectPositionResponse)

תשובה מעדכון המיקום של אובייקט מוטמע.
updateConditionalFormatRule

object (UpdateConditionalFormatRuleResponse)

תשובה מעדכון של כלל עיצוב מותנה.
deleteConditionalFormatRule

object (DeleteConditionalFormatRuleResponse)

תשובה על מחיקת כלל של עיצוב מותנה.
addProtectedRange

object (AddProtectedRangeResponse)

תשובה מהוספת טווח מוגן.
addChart

object (AddChartResponse)

תשובה מהוספת תרשים.
addBanding

object (AddBandingResponse)

תשובה מהוספת טווח פס.
createDeveloperMetadata

object (CreateDeveloperMetadataResponse)

תשובה מהיצירה של רשומת מטא-נתונים של מפתח.
updateDeveloperMetadata

object (UpdateDeveloperMetadataResponse)

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

object (DeleteDeveloperMetadataResponse)

תשובה על מחיקה של רשומת מטא-נתונים של מפתח.
addDimensionGroup

object (AddDimensionGroupResponse)

תשובה מהוספת קבוצת מאפיינים.
deleteDimensionGroup

object (DeleteDimensionGroupResponse)

תשובה על מחיקה של קבוצת מאפיינים.
trimWhitespace

object (TrimWhitespaceResponse)

תשובה לאחר חיתוך של רווחים לבנים.
deleteDuplicates

object (DeleteDuplicatesResponse)

תשובה מהסרת שורות שמכילות ערכים כפולים.
addSlicer

object (AddSlicerResponse)

תשובה מהוספת חלוקה.
addDataSource

object (AddDataSourceResponse)

תשובה מהוספת מקור נתונים.
updateDataSource

object (UpdateDataSourceResponse)

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

object (RefreshDataSourceResponse)

תשובה מרענון אובייקטים במקור הנתונים.
cancelDataSourceRefresh

object (CancelDataSourceRefreshResponse)

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

AddNamedRangeResponse

התוצאה של הוספת טווח בעל שם.

ייצוג ב-JSON 
{
  "namedRange": {
    object (NamedRange)
  }
}
שדות
namedRange

object (NamedRange)

טווח התאים בעל השם שרוצים להוסיף.

AddSheetResponse

התוצאה של הוספת גיליון.

ייצוג ב-JSON 
{
  "properties": {
    object (SheetProperties)
  }
}
שדות
properties

object (SheetProperties)

המאפיינים של הגיליון החדש שנוסף.

AddFilterViewResponse

התוצאה של הוספת תצוגת מסנן.

ייצוג ב-JSON 
{
  "filter": {
    object (FilterView)
  }
}
שדות
filter

object (FilterView)

תצוגת המסנן החדשה שנוספה.

DuplicateFilterViewResponse

התוצאה של שכפול של תצוגת סינון.

ייצוג ב-JSON 
{
  "filter": {
    object (FilterView)
  }
}
שדות
filter

object (FilterView)

המסנן החדש שנוצר.

DuplicateSheetResponse

התוצאה של שכפול גיליון.

ייצוג ב-JSON 
{
  "properties": {
    object (SheetProperties)
  }
}
שדות
properties

object (SheetProperties)

המאפיינים של הגיליון המשוכפל.

FindReplaceResponse

התוצאה של החיפוש/ההחלפה.

ייצוג ב-JSON 
{
  "valuesChanged": integer,
  "formulasChanged": integer,
  "rowsChanged": integer,
  "sheetsChanged": integer,
  "occurrencesChanged": integer
}
שדות
valuesChanged

integer

מספר התאים שאינם נוסחאות השתנה.
formulasChanged

integer

מספר תאי הנוסחאות השתנה.
rowsChanged

integer

מספר השורות השתנה.
sheetsChanged

integer

מספר הגיליונות השתנה.
occurrencesChanged

integer

מספר הפעמים שהמילה מופיעה (יכול להיות שהיא מופיעה כמה פעמים בתא) השתנה. לדוגמה, אם מחליפים את "e" ב-"o" ב-"Google Sheets", התוצאה תהיה "3" כי "Google Sheets" -> "Googlo Shoots".

UpdateEmbeddedObjectPositionResponse

התוצאה של עדכון המיקום של אובייקט מוטמע.

ייצוג ב-JSON 
{
  "position": {
    object (EmbeddedObjectPosition)
  }
}
שדות
position

object (EmbeddedObjectPosition)

המיקום החדש של האובייקט המוטמע.

UpdateConditionalFormatRuleResponse

התוצאה של עדכון כלל של עיצוב מותנה.

ייצוג ב-JSON 
{
  "newRule": {
    object (ConditionalFormatRule)
  },
  "newIndex": integer,

  // Union field old_info can be only one of the following:
  "oldRule": {
    object (ConditionalFormatRule)
  },
  "oldIndex": integer
  // End of list of possible types for union field old_info.
}
שדות
newRule

object (ConditionalFormatRule)

הכלל החדש שהחלף את הכלל הישן (אם בוצעה החלפה) או הכלל שהועברו (אם בוצעה העברה)
newIndex

integer

האינדקס של הכלל החדש.
שדה האיחוד old_info. מידע על הכלל הקודם. הערך של old_info יכול להיות רק אחת מהאפשרויות הבאות:
oldRule

object (ConditionalFormatRule)

הכלל הישן (שנמחק). לא מוגדר אם כלל הועבר (כי הוא זהה ל-newRule).
oldIndex

integer

האינדקס הישן של הכלל. לא מוגדרת אם כלל הוחלף (כי הוא זהה ל-newIndex).

DeleteConditionalFormatRuleResponse

התוצאה של מחיקת כלל של עיצוב מותנה.

ייצוג ב-JSON 
{
  "rule": {
    object (ConditionalFormatRule)
  }
}
שדות
rule

object (ConditionalFormatRule)

הכלל שנמחק.

AddProtectedRangeResponse

התוצאה של הוספת טווח מוגן חדש.

ייצוג ב-JSON 
{
  "protectedRange": {
    object (ProtectedRange)
  }
}
שדות
protectedRange

object (ProtectedRange)

טווח התאים המוגן החדש שנוסף.

AddChartResponse

התוצאה של הוספת תרשים לגיליון אלקטרוני.

ייצוג ב-JSON 
{
  "chart": {
    object (EmbeddedChart)
  }
}
שדות
chart

object (EmbeddedChart)

התרשים החדש שנוסף.

AddBandingResponse

התוצאה של הוספת טווח פס.

ייצוג ב-JSON 
{
  "bandedRange": {
    object (BandedRange)
  }
}
שדות
bandedRange

object (BandedRange)

הטווח המחולק לפסים שנוסף.

CreateDeveloperMetadataResponse

התגובה מיצירת המטא-נתונים של המפתח.

ייצוג ב-JSON 
{
  "developerMetadata": {
    object (DeveloperMetadata)
  }
}
שדות
developerMetadata

object (DeveloperMetadata)

המטא-נתונים של המפתח שנוצרו.

UpdateDeveloperMetadataResponse

התשובה מהעדכון של מטא-נתוני המפתח.

ייצוג ב-JSON 
{
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ]
}
שדות
developerMetadata[]

object (DeveloperMetadata)

המטא-נתונים המעודכנים של המפתח.

DeleteDeveloperMetadataResponse

התשובה מהמחיקה של מטא-נתונים של מפתח.

ייצוג ב-JSON 
{
  "deletedDeveloperMetadata": [
    {
      object (DeveloperMetadata)
    }
  ]
}
שדות
deletedDeveloperMetadata[]

object (DeveloperMetadata)

המטא-נתונים שנמחקו.

AddDimensionGroupResponse

התוצאה של הוספת קבוצה.

ייצוג ב-JSON 
{
  "dimensionGroups": [
    {
      object (DimensionGroup)
    }
  ]
}
שדות
dimensionGroups[]

object (DimensionGroup)

כל הקבוצות של מאפיין מסוים אחרי שמוסיפים קבוצה למאפיין הזה.

DeleteDimensionGroupResponse

התוצאה של מחיקת קבוצה.

ייצוג ב-JSON 
{
  "dimensionGroups": [
    {
      object (DimensionGroup)
    }
  ]
}
שדות
dimensionGroups[]

object (DimensionGroup)

כל הקבוצות של מאפיין מסוים אחרי שמוחקים קבוצה מהמאפיין הזה.

TrimWhitespaceResponse

התוצאה של חיתוך רווחים לבנים בתאים.

ייצוג ב-JSON 
{
  "cellsChangedCount": integer
}
שדות
cellsChangedCount

integer

מספר התאים שהוסרו מהם רווחים לבנים.

DeleteDuplicatesResponse

התוצאה של הסרת כפילויות בטווח.

ייצוג ב-JSON 
{
  "duplicatesRemovedCount": integer
}
שדות
duplicatesRemovedCount

integer

מספר השורות הכפולות שהוסרו.

AddSlicerResponse

התוצאה של הוספת כלי חיתוך לגיליון אלקטרוני.

ייצוג ב-JSON 
{
  "slicer": {
    object (Slicer)
  }
}
שדות
slicer

object (Slicer)

כלי הסינון החדש שנוסף.

AddDataSourceResponse

התוצאה של הוספת מקור נתונים.

ייצוג ב-JSON 
{
  "dataSource": {
    object (DataSource)
  },
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
שדות
dataSource

object (DataSource)

מקור הנתונים שנוצר.
dataExecutionStatus

object (DataExecutionStatus)

סטטוס ביצוע הנתונים.

UpdateDataSourceResponse

התגובה מעדכון מקור הנתונים.

ייצוג ב-JSON 
{
  "dataSource": {
    object (DataSource)
  },
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
שדות
dataSource

object (DataSource)

מקור הנתונים המעודכן.
dataExecutionStatus

object (DataExecutionStatus)

סטטוס ביצוע הנתונים.

RefreshDataSourceResponse

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

ייצוג ב-JSON 
{
  "statuses": [
    {
      object (RefreshDataSourceObjectExecutionStatus)
    }
  ]
}
שדות
statuses[]

object (RefreshDataSourceObjectExecutionStatus)

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

RefreshDataSourceObjectExecutionStatus

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

ייצוג ב-JSON 
{
  "reference": {
    object (DataSourceObjectReference)
  },
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
שדות
reference

object (DataSourceObjectReference)

הפניה לאובייקט של מקור נתונים שמתרענן.
dataExecutionStatus

object (DataExecutionStatus)

סטטוס ביצוע הנתונים.

CancelDataSourceRefreshResponse

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

ייצוג ב-JSON 
{
  "statuses": [
    {
      object (CancelDataSourceRefreshStatus)
    }
  ]
}
שדות
statuses[]

object (CancelDataSourceRefreshStatus)

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

CancelDataSourceRefreshStatus

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

ייצוג ב-JSON 
{
  "reference": {
    object (DataSourceObjectReference)
  },
  "refreshCancellationStatus": {
    object (RefreshCancellationStatus)
  }
}
שדות
reference

object (DataSourceObjectReference)

הפניה לאובייקט של מקור הנתונים שהרענון שלו מבוטל.
refreshCancellationStatus

object (RefreshCancellationStatus)

סטטוס הביטול.

RefreshCancellationStatus

הסטטוס של ביטול הרענון.

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

ייצוג ב-JSON 
{
  "state": enum (RefreshCancellationState),
  "errorCode": enum (RefreshCancellationErrorCode)
}
שדות
state

enum (RefreshCancellationState)

הסטטוס של קריאה לביטול רענון ב-Sheets.
errorCode

enum (RefreshCancellationErrorCode)

קוד השגיאה.

RefreshCancellationState

ספירה של מצבי ביטול רענון.

טיפוסים בני מנייה (enum)
REFRESH_CANCELLATION_STATE_UNSPECIFIED ערך ברירת מחדל, אין להשתמש בו.
CANCEL_SUCCEEDED קריאת ה-API ל-Sheets לביטול רענון בוצעה בהצלחה. המשמעות היא שהשיחה בוצעה בהצלחה, ולא שהביטול בוצע בהצלחה.
CANCEL_FAILED קריאת ה-API ל-Sheets לביטול רענון נכשלה.

RefreshCancellationErrorCode

ספירה של קודי השגיאה של ביטול הרענון.

טיפוסים בני מנייה (enum)
REFRESH_CANCELLATION_ERROR_CODE_UNSPECIFIED ערך ברירת מחדל, אין להשתמש בו.
EXECUTION_NOT_FOUND ההפעלה שרוצים לבטל לא נמצאה במנוע השאילתות או ב-Sheets.
CANCEL_PERMISSION_DENIED למשתמש אין הרשאה לבטל את השאילתה.
QUERY_EXECUTION_COMPLETED ביצוע השאילתה כבר הושלם, ולכן לא ניתן היה לבטל אותה.
CONCURRENT_CANCELLATION כבר מתבצע ביטול אחר.
CANCEL_OTHER_ERROR כל שאר השגיאות.