Responses

תשובה

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

ייצוג ב-JSON 
{

  "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)
  },
  "addTable": {
    object (AddTableResponse)
  },
  "insertComment": {
    object (InsertCommentResponse)
  },
  "addCommentReply": {
    object (AddCommentReplyResponse)
  }
}
שדות
סוג התשובה. יכול להיות שלא מוגדרים שדות אם לא הייתה תשובה לבקשה. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
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)

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

addTable

object (AddTableResponse)

תשובה שמתקבלת אחרי הוספת טבלה.

insertComment

object (InsertCommentResponse)

התוצאה של יצירת תגובה.

addCommentReply

object (AddCommentReplyResponse)

התוצאה של יצירת תשובה.

סוף השדות הבלעדיים.

DataSourceObjectReference

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

ייצוג ב-JSON 
{

  "sheetId": string,
  "chartId": integer,
  "dataSourceTableAnchorCell": {
    object (GridCoordinate)
  },
  "dataSourcePivotTableAnchorCell": {
    object (GridCoordinate)
  },
  "dataSourceFormulaCell": {
    object (GridCoordinate)
  }
}
שדות
סוג ההפניה. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
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,

  "oldRule": {
    object (ConditionalFormatRule)
  },
  "oldIndex": integer
}
שדות
newRule

object (ConditionalFormatRule)

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

newIndex

integer

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

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

AddTableResponse

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

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

object (Table)

פלט בלבד. הטבלה שנוספה.

InsertCommentResponse

התוצאה של יצירת תגובה.

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

object (CommentThread)

שרשור התגובות החדש שנוסף.

AddCommentReplyResponse

התוצאה של יצירת תשובה.

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

object (Post)

התשובה החדשה שנוספה Post.