Requests

בקשה

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

ייצוג ב-JSON 
{

  "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)
  }
}
שדות
שדה איחוד 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)

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

cancelDataSourceRefresh

object (CancelDataSourceRefreshRequest)

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

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,

  "range": {
    object (DimensionRange)
  },
  "dataSourceSheetRange": {
    object (DataSourceSheetDimensionRange)
  }
}
שדות
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,

  "range": {
    object (GridRange)
  },
  "sourceAndDestination": {
    object (SourceAndDestination)
  }
}
שדות
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. טווח: 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,

  "start": {
    object (GridCoordinate)
  },
  "range": {
    object (GridRange)
  }
}
שדות
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,

  "tableId": string
}
שדות
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 משוכפל ומשויך לעותק החדש של הגיליון. לא מופעלת הרצת נתונים, וגם נתוני הרשת של הגיליון הזה מועתקים, אבל הם זמינים רק אחרי שבקשת Batch מסתיימת.

insertSheetIndex

integer

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

newSheetId

integer

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

newSheetName

string

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

FindReplaceRequest

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

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

  "range": {
    object (GridRange)
  },
  "sheetId": integer,
  "allSheets": boolean
}
שדות
find

string

הערך לחיפוש.

replacement

string

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

matchCase

boolean

‫True אם החיפוש תלוי אותיות רישיות.

matchEntireCell

boolean

הפונקציה מחזירה True אם ערך החיפוש צריך להתאים לכל התא.

searchByRegex

boolean

הערך True אם ערך החיפוש הוא ביטוי רגולרי. הביטוי הרגולרי וההחלפה צריכים להתאים לכללי הביטוי הרגולרי של 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, התאים הקיימים יוזזו למטה. ‫If 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),

  "delimiter": string,
  "html": boolean
}
שדות
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 ערך מותאם אישית כפי שמוגדר בתו המפריד.
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

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

UpdateConditionalFormatRuleRequest

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

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

  "rule": {
    object (ConditionalFormatRule)
  },
  "newIndex": integer
}
שדות
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 
{

  "dimensions": {
    object (DimensionRange)
  },
  "dataSourceSheetDimensions": {
    object (DataSourceSheetDimensionRange)
  }
}
שדות
שדה איחוד 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, העומק של G גדל והעומק של הקבוצה החדשה G' זהה לעומק של הקבוצה הקיימת. לדוגמה, קבוצה [C:D, ‏ depth 1] + [B:E] יוצרת קבוצות [B:E, ‏ depth 1] ו- [C:D, ‏ depth 2]. אם הטווח המבוקש הוא קבוצת משנה של הטווח של קבוצה קיימת G, אז העומק של הקבוצה החדשה G' יהיה גדול ב-1 מהעומק של G. לדוגמה, קבוצה [B:E, depth 1] + [C:D] יוצרת את הקבוצות [B:E, depth 1] ו-[C:D, depth 2]. אם הטווח המבוקש מתחיל לפני הטווח של קבוצה קיימת G ומסתיים בתוכו, או מתחיל בתוך הטווח של קבוצה קיימת 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 ומופעלת הרצה לרענון הגיליון כדי לקרוא נתונים ממקור הנתונים.

אם מוסיפים מקור נתונים של 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

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

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

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

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

  "references": {
    object (DataSourceObjectReferences)
  },
  "dataSourceId": string,
  "isAll": boolean
}
שדות
force

boolean

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

שדה איחוד target. מציין מה לרענן. ‫target יכול להיות רק אחד מהבאים:
references

object (DataSourceObjectReferences)

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

dataSourceId

string

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

isAll

boolean

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

DataSourceObjectReferences

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

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

object (DataSourceObjectReference)

ההפניות.

CancelDataSourceRefreshRequest

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

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

ייצוג JSON 
{

  "references": {
    object (DataSourceObjectReferences)
  },
  "dataSourceId": string,
  "isAll": boolean
}
שדות
שדה איחוד 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

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