Responses

תשובה

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

ייצוג JSON 
{

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

object (AddNamedRangeResponse)

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

addSheet

object (AddSheetResponse)

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

addFilterView

object (AddFilterViewResponse)

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

duplicateFilterView

object (DuplicateFilterViewResponse)

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

duplicateSheet

object (DuplicateSheetResponse)

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

findReplace

object (FindReplaceResponse)

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

updateEmbeddedObjectPosition

object (UpdateEmbeddedObjectPositionResponse)

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

updateConditionalFormatRule

object (UpdateConditionalFormatRuleResponse)

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

deleteConditionalFormatRule

object (DeleteConditionalFormatRuleResponse)

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

addProtectedRange

object (AddProtectedRangeResponse)

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

addChart

object (AddChartResponse)

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

addBanding

object (AddBandingResponse)

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

createDeveloperMetadata

object (CreateDeveloperMetadataResponse)

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

updateDeveloperMetadata

object (UpdateDeveloperMetadataResponse)

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

deleteDeveloperMetadata

object (DeleteDeveloperMetadataResponse)

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

addDimensionGroup

object (AddDimensionGroupResponse)

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

deleteDimensionGroup

object (DeleteDimensionGroupResponse)

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

trimWhitespace

object (TrimWhitespaceResponse)

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

deleteDuplicates

object (DeleteDuplicatesResponse)

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

addSlicer

object (AddSlicerResponse)

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

addDataSource

object (AddDataSourceResponse)

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

updateDataSource

object (UpdateDataSourceResponse)

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

refreshDataSource

object (RefreshDataSourceResponse)

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

cancelDataSourceRefresh

object (CancelDataSourceRefreshResponse)

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

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.

AddNamedRangeResponse

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

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

object (NamedRange)

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

AddSheetResponse

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

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

object (SheetProperties)

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

AddFilterViewResponse

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

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

object (FilterView)

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

DuplicateFilterViewResponse

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

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

object (FilterView)

המסנן החדש שיצרתם.

DuplicateSheetResponse

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

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

object (SheetProperties)

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

FindReplaceResponse

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

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

integer

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

formulasChanged

integer

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

rowsChanged

integer

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

sheetsChanged

integer

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

occurrencesChanged

integer

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

UpdateEmbeddedObjectPositionResponse

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

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

object (EmbeddedObjectPosition)

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

UpdateConditionalFormatRuleResponse

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

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

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

object (ConditionalFormatRule)

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

newIndex

integer

האינדקס של הכלל החדש.

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

object (ConditionalFormatRule)

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

oldIndex

integer

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

DeleteConditionalFormatRuleResponse

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

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

object (ConditionalFormatRule)

הכלל שנמחק.

AddProtectedRangeResponse

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

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

object (ProtectedRange)

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

AddChartResponse

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

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

object (EmbeddedChart)

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

AddBandingResponse

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

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

object (BandedRange)

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

CreateDeveloperMetadataResponse

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

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

object (DeveloperMetadata)

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

UpdateDeveloperMetadataResponse

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

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

object (DeveloperMetadata)

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

DeleteDeveloperMetadataResponse

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

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

object (DeveloperMetadata)

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

AddDimensionGroupResponse

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

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

object (DimensionGroup)

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

DeleteDimensionGroupResponse

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

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

object (DimensionGroup)

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

TrimWhitespaceResponse

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

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

integer

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

DeleteDuplicatesResponse

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

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

integer

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

AddSlicerResponse

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

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

object (Slicer)

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

AddDataSourceResponse

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

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

object (DataSource)

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

dataExecutionStatus

object (DataExecutionStatus)

סטטוס הפעלת הנתונים.

UpdateDataSourceResponse

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

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

object (DataSource)

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

dataExecutionStatus

object (DataExecutionStatus)

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

RefreshDataSourceResponse

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

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

object (RefreshDataSourceObjectExecutionStatus)

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

RefreshDataSourceObjectExecutionStatus

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

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

object (DataSourceObjectReference)

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

dataExecutionStatus

object (DataExecutionStatus)

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

CancelDataSourceRefreshResponse

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

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

object (CancelDataSourceRefreshStatus)

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

CancelDataSourceRefreshStatus

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

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

object (DataSourceObjectReference)

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

refreshCancellationStatus

object (RefreshCancellationStatus)

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

RefreshCancellationStatus

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

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

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

enum (RefreshCancellationState)

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

errorCode

enum (RefreshCancellationErrorCode)

קוד השגיאה.

RefreshCancellationState

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

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

RefreshCancellationErrorCode

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

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