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)
  }
  // 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 משויכים.

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

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

ייצוג 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 הוא משתמע ואין לציין אותו. ניתן להשתמש ב-"*" כקצרים כדי לרשום את כל השדות.

עדכון המאפיין

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

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

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

טווח של מקור נתונים

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

חזרה על בקשה

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

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

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

מילוי אוטומטי

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

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

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

מקור ויעד

שילוב של טווח מקור ואיך להרחיב את המקור הזה.

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

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

הדבקת סוג

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

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

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

הדבקה אוריינטציה

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

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

בקשה למיזוג

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

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

object (GridRange)

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

mergeType

enum (MergeType)

אופן המיזוג של התאים.

סוג המיזוג

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

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

ביטול המיזוג של בקשה

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

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

object (GridRange)

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

עדכון BordersRequest

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

הגבול האנכי שיש להוסיף בטווח.

עדכון CEllsRequest

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

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

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

שדה איחוד area. עליך לכתוב את נתוני המיקום. יש להגדיר ערך אחד בלבד. area יכול להיות רק אחד מהבאים:
start

object (GridCoordinate)

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

range

object (GridRange)

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

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

הוספה של מסנן מסנן

מוסיף תצוגת מסנן.

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

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

ניקוי BasicFilterRequest

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

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

integer

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

מחיקת מאפיין של בקשה

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

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

object (DimensionRange)

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

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

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

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

integer

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

DeleteFilterViewRequest

מחיקת תצוגת סינון ספציפית.

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

integer

המזהה של המסנן למחיקה.

בקשה לסינון כפול

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

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

integer

המזהה של המסנן הכפול.

בקשה כפולה של Sheets

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

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

integer

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

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

insertSheetIndex

integer

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

newSheetId

integer

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

newSheetName

string

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

בקשת החלפה

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

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

שדה איחוד 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 היא לא נכונה, שתי השורות החדשות יהיו ירוקות (כי השורה אחרי נקודת הכניסה הייתה ירוקה).

InsertRangeRequest

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

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

object (GridRange)

הטווח שאליו יש להוסיף תאים חדשים.

shiftDimension

enum (Dimension)

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

בקשת מאפיין העברה

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

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

עדכון של מיקום אובייקט מוטמע

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

ייצוג 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 הוא משתמע ואין לציין אותו. ניתן להשתמש ב-"*" כקצרים כדי לרשום את כל השדות.

הדבקת בקשה לנתונים

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

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

בקשת TextToColumns

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

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

object (GridRange)

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

delimiter

string

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

delimiterType

enum (DelimiterType)

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

סוג מפריד

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

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

עדכון FilterFilterViewRequest

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

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

בקשת נספח

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

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

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

מיון מיון

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

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

object (GridRange)

הטווח למיון.

sortSpecs[]

object (SortSpec)

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

בקשה לאימות נתונים

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

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

המזהה של הטווח המוגן למחיקה.

בקשה לשינוי גודל אוטומטי של מאפיינים

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

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

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

הוספת תרשים

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

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

object (EmbeddedChart)

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

עדכוןChartChartSpecRequest

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

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

integer

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

spec

object (ChartSpec)

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

עדכון BandingRequest

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

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

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

עדכון DeveloperDeveloperMetadata

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

הטווח לביצוע אקראי.

הוספה של מאפיין GroupGroup

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

אם הטווח המבוקש הוא קבוצת-על של טווח של קבוצה G, העומק של 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 כוללת את העומק הגדול יותר מהעומק G והטווח כצומת של הטווחים. לדוגמה, קבוצה [B:D, עומק 1] + [C:E] מובילה לקבוצות [B:E, עומק 1] ו-[C:D, עומק 2].

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

object (DimensionRange)

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

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

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

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

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

object (DimensionRange)

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

עדכון של פרטי המאפיין

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

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

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

עדכון אובייקט מוטמעBorderRequest

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

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

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

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

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

object (DataSource)

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

עדכון של מקור נתונים

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

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

object (DataSource)

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

fields

string (FieldMask format)

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

DeleteDataSourceRequest

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

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

string

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

רענון DataSourceRequest

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

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

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

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

הפניות SourceSourceObject

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

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

object (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.