Requests

בקשה

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

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

רענון של מקור נתונים אחד או יותר ו-dbobjects משויכים.

cancelDataSourceRefresh

object (CancelDataSourceRefreshRequest)

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

UpdateSpreadsheetPropertiesRequest

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

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

object (SpreadsheetProperties)

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

fields

string (FieldMask format)

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

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

הוספת גיליון חדש. כאשר מוסיפים גיליון לאינדקס נתון, כל האינדקסים של הגיליונות הבאים מתווספים. כדי להוסיף גיליון אובייקטים, משתמשים במקום זאת ב-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

אילו סוגי נתונים יש להדביק.

טיפוסים בני מנייה (enums)
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

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

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

MergeCellsRequest

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

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

object (GridRange)

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

mergeType

enum (MergeType)

האופן שבו צריך למזג את התאים.

MergeType

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

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

UnmergeCellsRequest

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

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

object (GridRange)

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

UpdateBordersRequest

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

  1. טווח: A1:A5 { top: RED, bottom: WHITE }
  2. טווח: 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
}
שדות
sheetId

integer

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

rows[]

object (RowData)

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

fields

string (FieldMask format)

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

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

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

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

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

טיפוסים בני מנייה (enums)
DELIMITER_TYPE_UNSPECIFIED ערך ברירת המחדל. אי אפשר להשתמש בערך הזה.
COMMA ","
SEMICOLON ";"
PERIOD "."
SPACE " "
CUSTOM ערך מותאם אישית כפי שמוגדר בתו מפריד.
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

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

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

object (ConditionalFormatRule)

הכלל שצריך להוסיף.

index

integer

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

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

האינדקס מבוסס-אפס של הכלל שיש למחוק.

sheetId

integer

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

SortRangeRequest

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

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

object (GridRange)

הטווח למיון.

sortSpecs[]

object (SortSpec)

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

SetDataValidationRequest

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

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

object (GridRange)

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

rule

object (DataValidationRule)

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

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. הקוראים חייבים לציין את המאפיינים שהם רוצים לעדכן בפרמטר של השדות, וגם לציין לפחות 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, העומק של G יגדל והעומק של קבוצה חדשה זו יהיה G' עבור הקבוצה. לדוגמה, קבוצה [C:D, עומק 1] + [B:E] תיצור קבוצות [B:E, עומק 1] ו-[C:D, עומק 2]. אם הטווח המבוקש הוא קבוצת משנה של הטווח בקבוצה G קיימת, העומק של קבוצה חדשה יהיה אחד גדול מהעומק של G. לדוגמה, קבוצה [B:E, עומק 1] + [C:D] תקבל תוצאות בקבוצות [B:E, עומק 1] ו-[C:D, עומק 2]. אם הטווח המבוקש מתחיל לפני ומסתיים בתוך, או מתחיל בתוך ומסתיים אחריו, הטווח של קבוצה קיימת G, אז הטווח של הקבוצה הקיימת G הופך לאיחוד של הטווחים, והקבוצה החדשה G' מכילה עומק אחד גדול יותר מהעומק של 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 משויך ומופעלת הפעלה לרענון הגיליון כדי לקרוא נתונים ממקור הנתונים. לבקשה נדרש היקף OAuth נוסף של bigquery.readonly.

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

object (DataSource)

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

UpdateDataSourceRequest

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

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

object (DataSource)

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

fields

string (FieldMask format)

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

DeleteDataSourceRequest

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

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

string

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

RefreshDataSourceRequest

רענון של אובייקט מקור נתונים אחד או יותר בגיליון האלקטרוני לפי ההפניות שצוינו. לבקשה נדרש היקף 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

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

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

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