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)
  }
}
ช่อง
ฟิลด์ Union 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)

การตอบกลับจากการเพิ่ม Slicer

addDataSource

object (AddDataSourceResponse)

การตอบกลับจากการเพิ่มแหล่งข้อมูล

updateDataSource

object (UpdateDataSourceResponse)

การตอบกลับจากการอัปเดตแหล่งข้อมูล

refreshDataSource

object (RefreshDataSourceResponse)

การตอบกลับจากการรีเฟรชออบเจ็กต์แหล่งข้อมูล

cancelDataSourceRefresh

object (CancelDataSourceRefreshResponse)

การตอบกลับจากการยกเลิกการรีเฟรชออบเจ็กต์แหล่งข้อมูล

addTable

object (AddTableResponse)

การตอบกลับจากการเพิ่มตาราง

DataSourceObjectReference

การอ้างอิงถึงออบเจ็กต์แหล่งข้อมูล

การแสดง JSON 
{

  "sheetId": string,
  "chartId": integer,
  "dataSourceTableAnchorCell": {
    object (GridCoordinate)
  },
  "dataSourcePivotTableAnchorCell": {
    object (GridCoordinate)
  },
  "dataSourceFormulaCell": {
    object (GridCoordinate)
  }
}
ช่อง
ฟิลด์ Union 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,

  "oldRule": {
    object (ConditionalFormatRule)
  },
  "oldIndex": integer
}
ช่อง
newRule

object (ConditionalFormatRule)

กฎใหม่ที่แทนที่กฎเก่า (หากมีการแทนที่) หรือกฎที่ย้าย (หากมีการย้าย)

newIndex

integer

ดัชนีของกฎใหม่

ฟิลด์ Union 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

การตอบกลับจากการรีเฟรชออบเจ็กต์แหล่งข้อมูลอย่างน้อย 1 รายการ

การแสดง JSON 
{
  "statuses": [
    {
      object (RefreshDataSourceObjectExecutionStatus)
    }
  ]
}
ช่อง
statuses[]

object (RefreshDataSourceObjectExecutionStatus)

สถานะการรีเฟรชทั้งหมดสำหรับการอ้างอิงออบเจ็กต์แหล่งข้อมูลที่ระบุในคำขอ หากระบุ isAll ฟิลด์จะมีเฉพาะรายการที่มีสถานะเป็น "ล้มเหลว"

RefreshDataSourceObjectExecutionStatus

สถานะการดำเนินการของการรีเฟรชออบเจ็กต์แหล่งข้อมูล 1 รายการ

การแสดง JSON 
{
  "reference": {
    object (DataSourceObjectReference)
  },
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
ช่อง
reference

object (DataSourceObjectReference)

การอ้างอิงถึงออบเจ็กต์แหล่งข้อมูลที่กำลังรีเฟรช

dataExecutionStatus

object (DataExecutionStatus)

สถานะการเรียกใช้ข้อมูล

CancelDataSourceRefreshResponse

การตอบกลับจากการยกเลิกการรีเฟรชออบเจ็กต์แหล่งข้อมูลอย่างน้อย 1 รายการ

การแสดง 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 เพื่อยกเลิกการรีเฟรชออบเจ็กต์แหล่งข้อมูลอย่างน้อย 1 รายการโดยชัดแจ้ง

การแสดง JSON 
{
  "state": enum (RefreshCancellationState),
  "errorCode": enum (RefreshCancellationErrorCode)
}
ช่อง
state

enum (RefreshCancellationState)

สถานะของการเรียกเพื่อยกเลิกการรีเฟรชในชีต

errorCode

enum (RefreshCancellationErrorCode)

รหัสข้อผิดพลาด

RefreshCancellationState

การแจงนับสถานะการยกเลิกการรีเฟรช

Enum
REFRESH_CANCELLATION_STATE_UNSPECIFIED ค่าเริ่มต้น ไม่ต้องใช้
CANCEL_SUCCEEDED การเรียก API ไปยังชีตเพื่อยกเลิกการรีเฟรชสำเร็จแล้ว ซึ่งไม่ได้หมายความว่าการยกเลิกสำเร็จ แต่หมายความว่าการโทรสำเร็จ
CANCEL_FAILED การเรียก API ไปยังชีตเพื่อยกเลิกการรีเฟรชไม่สำเร็จ

RefreshCancellationErrorCode

การแจงนับรหัสข้อผิดพลาดในการยกเลิกการรีเฟรช

Enum
REFRESH_CANCELLATION_ERROR_CODE_UNSPECIFIED ค่าเริ่มต้น ไม่ต้องใช้
EXECUTION_NOT_FOUND ไม่พบการดำเนินการที่จะยกเลิกในเครื่องมือค้นหาหรือในชีต
CANCEL_PERMISSION_DENIED ผู้ใช้ไม่มีสิทธิ์ยกเลิกคำค้นหา
QUERY_EXECUTION_COMPLETED การดำเนินการค้นหาเสร็จสมบูรณ์แล้ว จึงยกเลิกไม่ได้
CONCURRENT_CANCELLATION มีการยกเลิกอื่นที่อยู่ระหว่างดำเนินการแล้ว
CANCEL_OTHER_ERROR ข้อผิดพลาดอื่นๆ ทั้งหมด

AddTableResponse

ผลลัพธ์ของการเพิ่มตาราง

การแสดง JSON 
{
  "table": {
    object (Table)
  }
}
ช่อง
table

object (Table)

เอาต์พุตเท่านั้น ตารางที่เพิ่ม