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.
}
ช่อง
ช่อง Union kind ชนิดของการอัปเดต ต้องป้อนเพียง 1 ช่องเท่านั้น kind ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
updateSpreadsheetProperties

object (UpdateSpreadsheetPropertiesRequest)

อัปเดตคุณสมบัติของสเปรดชีต

updateSheetProperties

object (UpdateSheetPropertiesRequest)

อัปเดตคุณสมบัติของชีต

updateDimensionProperties

object (UpdateDimensionPropertiesRequest)

อัปเดตคุณสมบัติของมิติข้อมูล

updateNamedRange

object (UpdateNamedRangeRequest)

อัปเดตช่วงที่มีชื่อ

repeatCell

object (RepeatCellRequest)

ซ้ํา 1 เซลล์ตลอดเวลา

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)

ปรับขนาดมิติข้อมูลอย่างน้อย 1 รายการโดยอัตโนมัติตามเนื้อหาของเซลล์ในมิติข้อมูลนั้น

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)

รีเฟรชแหล่งข้อมูลอย่างน้อย 1 รายการและ dbobjects ที่เกี่ยวข้อง

อัปเดตคําขอพร็อพเพอร์ตี้สเปรดชีต

อัปเดตคุณสมบัติของสเปรดชีต

การแสดง JSON
{
  "properties": {
    object (SpreadsheetProperties)
  },
  "fields": string
}
ช่อง
properties

object (SpreadsheetProperties)

พร็อพเพอร์ตี้ที่จะอัปเดต

fields

string (FieldMask format)

ช่องที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง รูท "พร็อพเพอร์ตี้" จะมีนัยโดยนัยและไม่ควรระบุ "*" เดี่ยวสามารถใช้เป็นชื่อสั้นๆ ในการแสดงช่องทุกช่อง

อัปเดต SheetPropertiesRequest

อัปเดตพร็อพเพอร์ตี้ของแผ่นงานด้วย sheetId ที่ระบุ

การแสดง JSON
{
  "properties": {
    object (SheetProperties)
  },
  "fields": string
}
ช่อง
properties

object (SheetProperties)

พร็อพเพอร์ตี้ที่จะอัปเดต

fields

string (FieldMask format)

ช่องที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง รูท 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)

ช่องที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง รูท properties โดยนัยและไม่ควรระบุ "*" เดี่ยวสามารถใช้เป็นชื่อสั้นๆ ในการแสดงช่องทุกช่อง

ช่อง Union dimension_range ช่วงมิติข้อมูล dimension_range ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
range

object (DimensionRange)

แถวหรือคอลัมน์ที่จะอัปเดต

dataSourceSheetRange

object (DataSourceSheetDimensionRange)

คอลัมน์ในชีตแหล่งข้อมูลที่จะอัปเดต

ช่วงมิติข้อมูลแผ่นงานแหล่งข้อมูล

ช่วงพร้อมกับมิติข้อมูลเดียวในชีต DATA_SOURCE

การแสดง JSON
{
  "sheetId": integer,
  "columnReferences": [
    {
      object (DataSourceColumnReference)
    }
  ]
}
ช่อง
sheetId

integer

รหัสของชีตแหล่งข้อมูลที่ช่วงเปิดอยู่

columnReferences[]

object (DataSourceColumnReference)

คอลัมน์ในชีตแหล่งข้อมูล

อัปเดตช่วงที่มีชื่อ

อัปเดตพร็อพเพอร์ตี้ของช่วงที่ตั้งชื่อด้วย namedRangeId ที่ระบุ

การแสดง JSON
{
  "namedRange": {
    object (NamedRange)
  },
  "fields": string
}
ช่อง
namedRange

object (NamedRange)

ช่วงที่ตั้งชื่อแล้วที่จะอัปเดตด้วยพร็อพเพอร์ตี้ใหม่

fields

string (FieldMask format)

ช่องที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง รูท namedRange โดยนัยและไม่ควรระบุ "*" เดี่ยวสามารถใช้เป็นชื่อสั้นๆ ในการแสดงช่องทุกช่อง

คําขอซ้ําของเซลล์

อัปเดตเซลล์ทั้งหมดในช่วงเป็นค่าในเซลล์ที่ระบุ ระบบจะอัปเดตเฉพาะช่องที่ระบุในช่อง fields เท่านั้น ส่วนช่องอื่นๆ จะไม่มีการเปลี่ยนแปลง

หากเขียนเซลล์ที่มีสูตร ช่วงของสูตรจะเพิ่มขึ้นโดยอัตโนมัติสําหรับแต่ละช่องในช่วงดังกล่าว เช่น หากเขียนเซลล์ที่มีสูตร =A1 ในช่วง B2:C4, B2 จะเป็น =A1, B3 จะเป็น =A2, B4 จะเป็น =A3, C2 จะเป็น =B1, C3 จะเป็น =B2, C4 จะเป็น =B3

หากต้องการให้ช่วงของสูตรคงที่ ให้ใช้ตัวบ่งชี้ $ เช่น ใช้สูตร =$A$1 เพื่อป้องกันไม่ให้ทั้งแถวและคอลัมน์เพิ่มขึ้น

การแสดง JSON
{
  "range": {
    object (GridRange)
  },
  "cell": {
    object (CellData)
  },
  "fields": string
}
ช่อง
range

object (GridRange)

ช่วงที่จะทําซ้ําเซลล์

cell

object (CellData)

ข้อมูลที่จะเขียน

fields

string (FieldMask format)

ช่องที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง รูท cell โดยนัยและไม่ควรระบุ "*" เดี่ยวสามารถใช้เป็นชื่อสั้นๆ ในการแสดงช่องทุกช่อง

เพิ่มช่วงชื่อ

เพิ่มช่วงที่มีชื่อในสเปรดชีต

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

object (NamedRange)

ช่วงที่ตั้งชื่อที่จะเพิ่ม ช่อง namedRangeId เป็นช่องที่ไม่บังคับ หากไม่ได้ตั้งค่าไว้ ระบบจะสร้างรหัสแบบสุ่ม (เป็นข้อผิดพลาดที่จะระบุรหัสของช่วงที่มีอยู่แล้ว)

ลบช่วงชื่อ

นําช่วงที่มีชื่อซึ่งมีรหัสที่ระบุออกจากสเปรดชีต

การแสดง JSON
{
  "namedRangeId": string
}
ช่อง
namedRangeId

string

รหัสของช่วงที่ตั้งชื่อเพื่อลบ

เพิ่มแผ่นงาน

เพิ่มแผ่นงานใหม่ เมื่อมีการเพิ่มแผ่นงานที่ดัชนีหนึ่งๆ ระบบจะเพิ่มดัชนีของแผ่นงานที่ตามมาทั้งหมด หากต้องการเพิ่มแผ่นงานออบเจ็กต์ ให้ใช้ AddChartRequest แทนและระบุ EmbeddedObjectPosition.sheetId หรือ EmbeddedObjectPosition.newSheet

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

object (SheetProperties)

พร็อพเพอร์ตี้ที่ชีตใหม่ควรมี พร็อพเพอร์ตี้ทั้งหมดเป็นตัวเลือก ช่อง sheetId เป็นช่องที่ไม่บังคับ หากไม่ได้ตั้งค่าไว้ ระบบจะสร้างรหัสแบบสุ่ม (ข้อผิดพลาดในการระบุรหัสของแผ่นงานที่มีอยู่แล้ว)

ลบแผ่นงาน

ลบแผ่นงานที่ขอ

การแสดง 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

"จริง" หากเราควรสร้างข้อมูลด้วยชุด "alternate" ซึ่งจะแตกต่างกันไปตามประเภทของข้อมูลต้นฉบับ

ช่อง Union 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

จํานวนแถวหรือคอลัมน์ที่ควรกรอกข้อมูล จํานวนบวกจะขยายเกินแถวสุดท้ายหรือคอลัมน์สุดท้ายของแหล่งที่มา จํานวนลบจะขยายก่อนแถวแรกหรือคอลัมน์แรกของแหล่งที่มา

ตัดคําขอวาง

ย้ายข้อมูลจากต้นทางไปยังปลายทาง

การแสดง 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 วางเฉพาะกฎการจัดรูปแบบตามเงื่อนไขเท่านั้น

คัดลอกและวางคําขอ

คัดลอกข้อมูลจากต้นทางไปยังปลายทาง

การแสดง 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)

ช่วงที่จะยกเลิกการผสานเซลล์ทั้งหมด ถ้าช่วงนั้นครอบคลุมการผสานหลายรายการ ระบบจะยกเลิกการผสานทั้งหมด ช่วงต้องไม่ครอบคลุมเพียงบางส่วน

UpdateBordersRequest

อัปเดตเส้นขอบของช่วง ถ้าไม่ได้ตั้งค่าฟิลด์ในคําขอ นั่นหมายความว่าเส้นขอบยังคงเป็นอย่างเดิม ตัวอย่างเช่นกับ 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)

เส้นขอบแนวตั้งที่จะวางในช่วง

UpdateCellsRequest

อัปเดตเซลล์ทั้งหมดในช่วงด้วยข้อมูลใหม่

การแสดง 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)

ช่องของ CellData ที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง รูทคือ CellData ไม่ควรระบุ "row.values" "*" เดี่ยวสามารถใช้เป็นชื่อสั้นๆ ในการแสดงช่องทุกช่อง

ช่อง Union area ควรเขียนข้อมูลตําแหน่ง ต้องตั้งค่า 1 ค่าเท่านั้น area ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
start

object (GridCoordinate)

พิกัดเพื่อเริ่มเขียนข้อมูล ระบบอาจเขียนจํานวนแถวและคอลัมน์จํานวนมาก (รวมถึงจํานวนคอลัมน์ต่อแถวที่ต่างกัน)

range

object (GridRange)

ช่วงที่จะเขียนข้อมูล

หากข้อมูลในแถวไม่ครอบคลุมช่วงที่ขอทั้งหมด ระบบจะล้างข้อมูลช่องที่ตรงกับที่ตั้งค่าไว้ใน fields

เพิ่มมุมมองตัวกรอง

เพิ่มมุมมองตัวกรอง

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

object (FilterView)

ตัวกรองที่จะเพิ่ม ช่อง filterViewId เป็นช่องที่ไม่บังคับ หากไม่ได้ตั้งค่าไว้ ระบบจะสร้างรหัสแบบสุ่ม (ข้อผิดพลาดในการระบุรหัสของตัวกรองที่มีอยู่แล้ว)

ขอต่อท้ายเซลล์

เพิ่มเซลล์ใหม่หลังแถวสุดท้ายที่มีข้อมูลในแผ่นงาน แทรกแถวใหม่ลงในแผ่นงานหากจําเป็น

การแสดง JSON
{
  "sheetId": integer,
  "rows": [
    {
      object (RowData)
    }
  ],
  "fields": string
}
ช่อง
sheetId

integer

รหัสแผ่นงานที่จะต่อท้ายข้อมูล

rows[]

object (RowData)

ข้อมูลที่จะต่อท้าย

fields

string (FieldMask format)

ช่องของ CellData ที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง รูทคือ CellData ไม่ควรระบุ "row.values" "*" เดี่ยวสามารถใช้เป็นชื่อสั้นๆ ในการแสดงช่องทุกช่อง

ล้างคําขอพื้นฐาน

ล้างตัวกรองพื้นฐาน หากมีในชีต

การแสดง JSON
{
  "sheetId": integer
}
ช่อง
sheetId

integer

รหัสแผ่นงานที่ควรล้างตัวกรองพื้นฐาน

ลบส่วนข้อมูล

ลบมิติข้อมูลจากแผ่นงาน

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

object (DimensionRange)

ขนาดที่จะลบจากแผ่นงาน

ลบวัตถุแบบฝัง

ลบออบเจ็กต์ที่ฝังด้วยรหัสที่ระบุ

การแสดง JSON
{
  "objectId": integer
}
ช่อง
objectId

integer

รหัสของออบเจ็กต์ที่ฝังที่จะลบ

ลบคําขอตัวกรอง

ลบมุมมองตัวกรองที่ต้องการ

การแสดง JSON
{
  "filterId": integer
}
ช่อง
filterId

integer

รหัสของตัวกรองที่จะลบ

คําขอมุมมองตัวกรองซ้ํา

ทําซ้ํามุมมองตัวกรองที่ต้องการ

การแสดง JSON
{
  "filterId": integer
}
ช่อง
filterId

integer

รหัสของตัวกรองที่ซ้ํา

DuplicateSheetRequest

ทําซ้ําเนื้อหาของแผ่นงาน

การแสดง JSON
{
  "sourceSheetId": integer,
  "insertSheetIndex": integer,
  "newSheetId": integer,
  "newSheetName": string
}
ช่อง
sourceSheetId

integer

แผ่นงานที่จะทําซ้ํา

หากชีตต้นทางเป็นประเภท DATA_SOURCE การสํารอง DataSource จะทําซ้ําและเชื่อมโยงกับสําเนาใหม่ของชีตนั้น ไม่มีการเรียกใช้ข้อมูล ระบบจะคัดลอกข้อมูลตารางของชีตนี้ด้วย แต่จะสามารถใช้ได้เมื่อคําขอแบบกลุ่มเสร็จสิ้นเท่านั้น

insertSheetIndex

integer

ดัชนีแบบ 0 ที่ควรจะแทรกแผ่นงานใหม่ ดัชนีของชีตทั้งหมดเพิ่มขึ้นเรื่อยๆ

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

จริงถ้าการค้นหามีการพิจารณาตัวพิมพ์เล็กและตัวพิมพ์ใหญ่

matchEntireCell

boolean

เป็นจริงถ้าค่าการค้นหาควรตรงกับทั้งเซลล์

searchByRegex

boolean

เป็นจริงหากค่าการค้นหาเป็นนิพจน์ทั่วไป นิพจน์ทั่วไปและการแทนที่ควรเป็นไปตามกฎ regex ของ Java ที่ 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

จริง หากการค้นหาควรมีเซลล์ที่มีสูตรอยู่ด้วย เท็จ เพื่อข้ามเซลล์ที่มีสูตร

ช่อง Union scope ขอบเขตที่จะต้องค้นหา/แทนที่ ต้องตั้งค่า หนึ่งและหนึ่งรายการเท่านั้น scope ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
range

object (GridRange)

ช่วงที่จะหา/แทนที่

sheetId

integer

ชีตเพื่อค้นหา/แทนที่

allSheets

boolean

True เพื่อค้นหา/แทนที่แผ่นงานทั้งหมด

ใส่มิติข้อมูล

แทรกแถวหรือคอลัมน์ในแผ่นงานที่ดัชนีหนึ่งๆ

การแสดง JSON
{
  "range": {
    object (DimensionRange)
  },
  "inheritFromBefore": boolean
}
ช่อง
range

object (DimensionRange)

ขนาดที่จะแทรก ต้องเชื่อมโยงทั้งดัชนีเริ่มต้นและสิ้นสุด

inheritFromBefore

boolean

ควรขยายคุณสมบัติของมิติข้อมูลจากมิติข้อมูลก่อนหรือหลังมิติข้อมูลที่แทรกใหม่ "จริง" เพื่อรับค่าจากมิติข้อมูลก่อน (ซึ่งดัชนีเริ่มต้นต้องมากกว่า 0) และ "เท็จ" เพื่อรับค่าจากมิติข้อมูลภายหลัง

ตัวอย่างเช่น หากดัชนีแถว 0 มีพื้นหลังสีแดง และดัชนีแถว 1 มีพื้นหลังสีเขียว การแทรก 2 แถวที่ดัชนี 1 ก็อาจสืบทอดพื้นหลังสีเขียวหรือสีแดงได้ หาก inheritFromBefore เป็นจริง แถวใหม่ 2 แถวจะเป็นสีแดง (เนื่องจากแถวก่อนจุดแทรกจะเป็นสีแดง) ขณะที่ inheritFromBefore เป็นเท็จ แถวใหม่ 2 แถวจะเป็นสีเขียว (เนื่องจากแถวหลังจุดแทรกเป็นสีเขียว)

แทรกช่วงคําขอ

แทรกเซลล์เป็นช่วงโดยเลื่อนเซลล์ที่มีอยู่ขึ้นหรือลง

การแสดง JSON
{
  "range": {
    object (GridRange)
  },
  "shiftDimension": enum (Dimension)
}
ช่อง
range

object (GridRange)

ช่วงที่จะแทรกเซลล์ใหม่

shiftDimension

enum (Dimension)

มิติข้อมูลที่จะเปลี่ยนไปเมื่อแทรกเซลล์ หากเป็น ROWS ระบบจะเลื่อนเซลล์ที่มีอยู่ลง หากเป็น COLUMNS เซลล์ที่มีอยู่จะเลื่อนไปทางขวา

ย้ายคําขอส่วนข้อมูล

ย้ายแถวหรือคอลัมน์อย่างน้อย 1 รายการ

การแสดง JSON
{
  "source": {
    object (DimensionRange)
  },
  "destinationIndex": integer
}
ช่อง
source

object (DimensionRange)

ขนาดต้นทางที่จะย้าย

destinationIndex

integer

ดัชนีเริ่มต้นแบบ 0 ของตําแหน่งต้นทางที่ย้ายข้อมูลต้นทางโดยอิงตามพิกัดก่อนที่ข้อมูลแหล่งที่มาจะถูกนําออกจากตารางกริด ข้อมูลที่มีอยู่จะถูกเลื่อนขึ้นหรือลง (ขึ้นอยู่กับมิติข้อมูล) เพื่อให้มีที่ว่างสําหรับมิติข้อมูลที่ย้าย มิติข้อมูลแหล่งที่มาจะถูกนําออกจากตารางกริด ข้อมูลจึงอาจอยู่ในดัชนีซึ่งต่างจากที่ระบุไว้

เช่น เมื่อให้ A1..A5 จาก 0, 1, 2, 3, 4 แล้วและต้องการย้าย "1" ไป "2" ระหว่าง "3" และ "4" แหล่งที่มาจะเป็น ROWS [1..3) และดัชนีปลายทางจะเป็น "4" (ดัชนีฐาน 0 ของแถว 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 เป็น "จริง" ระบบจะสร้างแผ่นงานใหม่พร้อมรหัสที่ระบบเลือกให้คุณ

fields

string (FieldMask format)

ช่องของ OverlayPosition ที่ควรอัปเดตเมื่อตั้งค่าตําแหน่งใหม่ ใช้เมื่อตั้งค่า newPosition.overlayPosition เท่านั้น โดยต้องระบุอย่างน้อย 1 ช่อง รูท 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)

วิธีวางข้อมูล

ช่อง Union kind วิธีตีความข้อมูลจะต้องกําหนดค่าเพียงค่าเดียว kind ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
delimiter

string

ตัวคั่นในข้อมูล

html

boolean

เป็นจริงหากข้อมูลเป็น HTML

คําขอไปยังคอลัมน์ข้อความ

แบ่งคอลัมน์ข้อความออกเป็นหลายคอลัมน์ โดยอิงตามตัวคั่นในเซลล์แต่ละเซลล์

การแสดง JSON
{
  "source": {
    object (GridRange)
  },
  "delimiter": string,
  "delimiterType": enum (DelimiterType)
}
ช่อง
source

object (GridRange)

ช่วงข้อมูลต้นทาง ซึ่งต้องครอบคลุมเพียง 1 คอลัมน์เท่านั้น

delimiter

string

ตัวคั่นที่จะใช้ ใช้เฉพาะเมื่อ delimiterType เท่ากับ CUSTOM

delimiterType

enum (DelimiterType)

ประเภทตัวคั่นที่จะใช้

ประเภทตัวคั่น

ตัวคั่นที่จะแยก

Enum
DELIMITER_TYPE_UNSPECIFIED ค่าเริ่มต้น และต้องไม่ใช้ค่านี้
COMMA "
SEMICOLON ";"
PERIOD "
SPACE " "
CUSTOM ค่าที่กําหนดเองตามที่กําหนดไว้ในตัวคั่น
AUTODETECT ตรวจหาคอลัมน์โดยอัตโนมัติ

อัปเดตคําขอมุมมองตัวกรอง

อัปเดตพร็อพเพอร์ตี้ของมุมมองตัวกรอง

การแสดง JSON
{
  "filter": {
    object (FilterView)
  },
  "fields": string
}
ช่อง
filter

object (FilterView)

พร็อพเพอร์ตี้ใหม่ของมุมมองตัวกรอง

fields

string (FieldMask format)

ช่องที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง รูท filter โดยนัยและไม่ควรระบุ "*" เดี่ยวสามารถใช้เป็นชื่อสั้นๆ ในการแสดงช่องทุกช่อง

ลบช่วงคําขอ

ลบช่วงของเซลล์โดยเลื่อนเซลล์อื่นๆ เข้าไปในพื้นที่ที่ลบ

การแสดง 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

ดัชนีแบบ 0 ที่ควรแทรกกฎ

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 ไว้ มิเช่นนั้นจะไม่ได้ใช้

ช่อง Union 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)

กฎการตรวจสอบข้อมูลที่จะตั้งค่าเป็นเซลล์แต่ละเซลล์ในช่วงนั้นๆ หรือเว้นว่างไว้เพื่อล้างการตรวจสอบข้อมูลในช่วงนั้นๆ

ตั้งค่าคําขอพื้นฐาน

ตั้งค่าตัวกรองพื้นฐานที่เชื่อมโยงกับแผ่นงาน

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

object (BasicFilter)

ตัวกรองที่จะตั้งค่า

เพิ่มช่วงที่มีการป้องกัน

เพิ่มช่วงที่มีการป้องกันใหม่

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

object (ProtectedRange)

ช่วงที่มีการป้องกันที่จะเพิ่ม ช่อง protectedRangeId เป็นช่องที่ไม่บังคับ หากไม่ได้ตั้งค่าไว้ ระบบจะสร้างรหัสแบบสุ่ม (เป็นข้อผิดพลาดที่จะระบุรหัสของช่วงที่มีอยู่แล้ว)

UpdateProtectedRangeRequest

อัปเดตช่วงที่มีการป้องกันที่มีอยู่ด้วย protectedRangeId ที่ระบุ

การแสดง JSON
{
  "protectedRange": {
    object (ProtectedRange)
  },
  "fields": string
}
ช่อง
protectedRange

object (ProtectedRange)

ช่วงที่ป้องกันให้อัปเดตด้วยพร็อพเพอร์ตี้ใหม่

fields

string (FieldMask format)

ช่องที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง รูท protectedRange โดยนัยและไม่ควรระบุ "*" เดี่ยวสามารถใช้เป็นชื่อสั้นๆ ในการแสดงช่องทุกช่อง

ลบช่วงที่มีการป้องกัน

ลบช่วงที่ป้องกันด้วยรหัสที่กําหนด

การแสดง JSON
{
  "protectedRangeId": integer
}
ช่อง
protectedRangeId

integer

รหัสของช่วงที่ป้องกันที่จะลบ

ปรับขนาดมิติข้อมูลอัตโนมัติ

ปรับขนาดมิติข้อมูลอย่างน้อย 1 รายการโดยอัตโนมัติตามเนื้อหาของเซลล์ในมิติข้อมูลนั้น

การแสดง 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.
}
ช่อง
ช่อง Union dimension_range ช่วงมิติข้อมูล dimension_range ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
dimensions

object (DimensionRange)

ขนาดที่ต้องการปรับขนาดโดยอัตโนมัติ

dataSourceSheetDimensions

object (DataSourceSheetDimensionRange)

มิติข้อมูลในชีตแหล่งข้อมูลเพื่อปรับขนาดโดยอัตโนมัติ

เพิ่มคําขอแผนภูมิ

เพิ่มแผนภูมิลงในแผ่นงานในสเปรดชีต

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

object (EmbeddedChart)

แผนภูมิที่ควรเพิ่มลงในสเปรดชีต รวมถึงตําแหน่งที่จะวาง ช่อง chartId เป็นช่องที่ไม่บังคับ หากไม่ได้ตั้งค่าไว้ ระบบจะสร้างรหัสแบบสุ่ม (ข้อผิดพลาดในการระบุ ID ของวัตถุที่ฝังไว้ที่มีอยู่แล้ว)

UpdateChartSpecRequest

อัปเดตข้อกําหนดของแผนภูมิ (การดําเนินการนี้จะไม่ย้ายหรือปรับขนาดแผนภูมิ) หากต้องการย้ายหรือปรับขนาดแผนภูมิ ให้ใช้ UpdateEmbeddedObjectPositionRequest)

การแสดง JSON
{
  "chartId": integer,
  "spec": {
    object (ChartSpec)
  }
}
ช่อง
chartId

integer

รหัสของแผนภูมิที่จะอัปเดต

spec

object (ChartSpec)

ข้อกําหนดในการใช้กับแผนภูมิ

อัปเดตคําขอใช้แบนด์วิดท์

อัปเดตคุณสมบัติของช่วงย่านความถี่ที่ระบุ

การแสดง JSON
{
  "bandedRange": {
    object (BandedRange)
  },
  "fields": string
}
ช่อง
bandedRange

object (BandedRange)

ช่วงความถี่เพื่ออัปเดตด้วยพร็อพเพอร์ตี้ใหม่

fields

string (FieldMask format)

ช่องที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง รูท bandedRange โดยนัยและไม่ควรระบุ "*" เดี่ยวสามารถใช้เป็นชื่อสั้นๆ ในการแสดงช่องทุกช่อง

เพิ่มคําขอใช้แบนด์วิดท์

เพิ่มช่วงย่านความถี่ใหม่ในสเปรดชีต

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

object (BandedRange)

ช่วงคลื่นความถี่ที่จะเพิ่ม ช่อง bandedRangeId เป็นช่องที่ไม่บังคับ หากไม่ได้ตั้งค่าไว้ ระบบจะสร้างรหัสแบบสุ่ม (เป็นข้อผิดพลาดที่จะระบุรหัสของช่วงที่มีอยู่แล้ว)

ลบคําขอ Bandand

ลบช่วงแถบด้วยรหัสที่กําหนดจากสเปรดชีต

การแสดง JSON
{
  "bandedRangeId": integer
}
ช่อง
bandedRangeId

integer

รหัสของช่วงแบนด์วิดท์ที่จะลบ

สร้างคําขอข้อมูลเมตาของนักพัฒนาซอฟต์แวร์

คําขอสร้างข้อมูลเมตาของนักพัฒนาซอฟต์แวร์

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

object (DeveloperMetadata)

ข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ที่จะสร้าง

คําขอข้อมูลเมตาของนักพัฒนาซอฟต์แวร์

คําขออัปเดตพร็อพเพอร์ตี้ของข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ อัปเดตพร็อพเพอร์ตี้ของข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ที่ตัวกรองเลือกเป็นค่าที่ระบุไว้ในทรัพยากร DeveloperMetadata ผู้โทรต้องระบุพร็อพเพอร์ตี้ที่ต้องการอัปเดตในพารามิเตอร์ของช่อง รวมทั้งระบุ DataFilter อย่างน้อย 1 รายการที่ตรงกับข้อมูลเมตาที่ต้องการอัปเดต

การแสดง JSON
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "developerMetadata": {
    object (DeveloperMetadata)
  },
  "fields": string
}
ช่อง
dataFilters[]

object (DataFilter)

ตัวกรองที่ตรงกับรายการข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ที่จะอัปเดต

developerMetadata

object (DeveloperMetadata)

ค่าที่ข้อมูลเมตาที่ตรงกันโดยตัวกรองข้อมูลจะได้รับการอัปเดต

fields

string (FieldMask format)

ช่องที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง รูท developerMetadata โดยนัยและไม่ควรระบุ "*" เดี่ยวสามารถใช้เป็นชื่อสั้นๆ ในการแสดงช่องทุกช่อง

ลบคําขอข้อมูลเมตาของนักพัฒนาซอฟต์แวร์

คําขอลบข้อมูลเมตาของนักพัฒนาซอฟต์แวร์

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

object (DataFilter)

ตัวกรองข้อมูลที่อธิบายเกณฑ์ที่ใช้เลือกรายการข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ที่จะลบ

RandomizeRangeRequest

สุ่มลําดับของแถวในช่วง

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

object (GridRange)

ช่วงที่จะสุ่ม

เพิ่มมิติข้อมูลกลุ่ม

สร้างกลุ่มในช่วงที่ระบุ

ถ้าช่วงที่ขอเป็นค่าเกินช่วงของกลุ่ม G ที่มีอยู่แล้ว ความลึกของ G จะเพิ่มขึ้น และ G กลุ่มใหม่จะมีความลึกของกลุ่มนั้น ตัวอย่างเช่น กลุ่ม [C:D, ความลึก 1] + [B:E] จะส่งผลให้เกิดกลุ่ม [B:E, ความลึก 1] และ [C:D, ความลึก 2] หากช่วงที่ขอมาเป็นชุดย่อยของช่วงกลุ่ม G ที่มีอยู่ ความลึกของกลุ่ม G ใหม่จะมากกว่าความลึกของ G หนึ่งกลุ่ม ตัวอย่างเช่น กลุ่ม [B:E, depth 1] + [C:D] จะส่งผลให้เกิดกลุ่ม [B:E, depth 1] และ [C:D, depth 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)

ช่องที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง รูท dimensionGroup โดยนัยและไม่ควรระบุ "*" เดี่ยวสามารถใช้เป็นชื่อสั้นๆ ในการแสดงช่องทุกช่อง

ขอ TrimWhitespace

ตัดการเว้นวรรค (เช่น เว้นวรรค แท็บ หรือบรรทัดใหม่) ในทุกเซลล์ในช่วงที่ระบุ คําขอนี้จะนําช่องว่างทั้งหมดออกจากจุดเริ่มต้นและจุดสิ้นสุดของข้อความของแต่ละเซลล์ และลดผลลัพธ์ย่อยของอักขระเว้นวรรคที่เหลือให้เหลือเพียงเว้นวรรคเดียว หากข้อความที่ตัดมาขึ้นต้นด้วยอักขระ "+" หรือ "=' ข้อความจะยังคงเป็นค่าสตริงและไม่ตีความว่าเป็นสูตร

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

object (GridRange)

ช่วงที่จะตัดเซลล์

ลบคําขอที่ซ้ํากัน

ลบแถวที่อยู่ในช่วงนี้ซึ่งมีค่าในคอลัมน์ที่ระบุ ซึ่งซ้ํากับค่าในแถวก่อนหน้า แถวที่มีค่าเหมือนกัน แต่มีตัวอักษรพิมพ์เล็กพิมพ์ใหญ่ การจัดรูปแบบ หรือสูตรต่างกันจะถือว่าเป็นรายการที่ซ้ํากัน

คําขอนี้จะนําแถวที่ซ้ํากันที่ซ่อนไว้ออกจากมุมมองด้วย (เช่น เนื่องจากตัวกรอง) เมื่อนํารายการที่ซ้ําออก อินสแตนซ์แรกของการสแกนแถวที่ซ้ํากันแต่ละรายการจากบนลงล่างจะอยู่ในช่วงที่ระบุ ระบบจะไม่นําเนื้อหาที่อยู่นอกช่วงที่ระบุออก และแถวที่พิจารณาแล้วว่าซ้ํากันไม่จําเป็นต้องอยู่ติดกันในช่วง

การแสดง JSON
{
  "range": {
    object (GridRange)
  },
  "comparisonColumns": [
    {
      object (DimensionRange)
    }
  ]
}
ช่อง
range

object (GridRange)

ช่วงที่จะนําแถวที่ซ้ํากันออก

comparisonColumns[]

object (DimensionRange)

คอลัมน์ในช่วงที่จะวิเคราะห์เพื่อหาค่าที่ซ้ํากัน หากไม่ได้เลือกคอลัมน์ ระบบจะวิเคราะห์คอลัมน์ทั้งหมดเพื่อหารายการที่ซ้ํากัน

UpdateEmbeddedObjectBorderRequest

อัปเดตคุณสมบัติเส้นขอบของวัตถุที่ฝังไว้

การแสดง JSON
{
  "objectId": integer,
  "border": {
    object (EmbeddedObjectBorder)
  },
  "fields": string
}
ช่อง
objectId

integer

รหัสของออบเจ็กต์ที่ฝังเพื่ออัปเดต

border

object (EmbeddedObjectBorder)

เส้นขอบที่ใช้กับวัตถุที่ฝัง

fields

string (FieldMask format)

ช่องที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง รูท border โดยนัยและไม่ควรระบุ "*" เดี่ยวสามารถใช้เป็นชื่อสั้นๆ ในการแสดงช่องทุกช่อง

เพิ่ม SlicerRequest

เพิ่มตัวควบคุมตัวกรองลงในแผ่นงานในสเปรดชีต

การแสดง 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)

ช่องที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง รูท SlicerSpec โดยนัยและไม่ควรระบุ เครื่องหมาย "*" เดี่ยวสามารถใช้เป็นชื่อสั้นๆ เพื่อแสดงรายการทุกช่อง

คําขอเพิ่มแหล่งข้อมูล

เพิ่มแหล่งข้อมูล หลังจากเพิ่มแหล่งข้อมูลเรียบร้อยแล้ว ระบบจะสร้างชีต DATA_SOURCE ที่เกี่ยวข้องและทริกเกอร์การดําเนินการเพื่อรีเฟรชชีตเพื่ออ่านข้อมูลจากแหล่งข้อมูล คําขอต้องมีขอบเขต OAuth เพิ่มเติม bigquery.readonly รายการ

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

object (DataSource)

แหล่งข้อมูลที่จะเพิ่ม

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

อัปเดตแหล่งข้อมูล หลังจากอัปเดตแหล่งข้อมูลเรียบร้อยแล้ว ระบบจะทริกเกอร์การดําเนินการเพื่อรีเฟรชชีต DATA_SOURCE ที่เชื่อมโยงเพื่ออ่านข้อมูลจากแหล่งข้อมูลที่อัปเดตแล้ว คําขอต้องมีขอบเขต OAuth เพิ่มเติม bigquery.readonly รายการ

การแสดง JSON
{
  "dataSource": {
    object (DataSource)
  },
  "fields": string
}
ช่อง
dataSource

object (DataSource)

แหล่งข้อมูลที่จะอัปเดต

fields

string (FieldMask format)

ช่องที่ควรอัปเดต ต้องระบุอย่างน้อย 1 ช่อง รูท dataSource โดยนัยและไม่ควรระบุ "*" เดี่ยวสามารถใช้เป็นชื่อสั้นๆ ในการแสดงช่องทุกช่อง

ลบแหล่งข้อมูล

ลบแหล่งข้อมูล คําขอจะลบชีตแหล่งข้อมูลที่เกี่ยวข้องและยกเลิกการลิงก์ออบเจ็กต์แหล่งข้อมูลที่เชื่อมโยงทั้งหมดด้วย

การแสดง JSON
{
  "dataSourceId": string
}
ช่อง
dataSourceId

string

รหัสของแหล่งข้อมูลที่จะลบ

RefreshDataSourceRequest

รีเฟรชออบเจ็กต์แหล่งข้อมูลอย่างน้อย 1 รายการในสเปรดชีตตามข้อมูลอ้างอิงที่ระบุ คําขอต้องมีขอบเขต OAuth เพิ่มเติม bigquery.readonly รายการ

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

การแสดง 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

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

ช่อง Union target ระบุสิ่งที่จะรีเฟรช target ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
references

object (DataSourceObjectReferences)

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

dataSourceId

string

อ้างอิง DataSource หากระบุไว้ จะรีเฟรชออบเจ็กต์แหล่งข้อมูลที่เกี่ยวข้องทั้งหมดสําหรับแหล่งข้อมูลนั้น

isAll

boolean

รีเฟรชออบเจ็กต์แหล่งข้อมูลที่มีอยู่ทั้งหมดในสเปรดชีต

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

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

การแสดง 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.
}
ช่อง
ช่อง Union value ประเภทข้อมูลอ้างอิง value ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
sheetId

string

การอ้างอิงไปยังชีต DATA_SOURCE

chartId

integer

การอ้างอิงไปยังแผนภูมิแหล่งข้อมูล

dataSourceTableAnchorCell

object (GridCoordinate)

อ้างอิงไปยัง DataSourceTable ที่เซลล์

dataSourcePivotTableAnchorCell

object (GridCoordinate)

การอ้างอิงแหล่งข้อมูล PivotTable ที่ตรึงอยู่ที่เซลล์

dataSourceFormulaCell

object (GridCoordinate)

อ้างอิงไปยังเซลล์ที่มี DataSourceFormula