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 כל שאר השגיאות.