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)
  },
  "cancelDataSourceRefresh": {
    object (CancelDataSourceRefreshRequest)
  }
  // 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)

ทำซ้ำเซลล์เดียวในช่วง

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 หรือ Delimited) ลงในชีต

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)

ตั้งค่าการตรวจสอบข้อมูลสำหรับเซลล์อย่างน้อย 1 เซลล์

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 รายการและ dbobject ที่เกี่ยวข้อง

cancelDataSourceRefresh

object (CancelDataSourceRefreshRequest)

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

UpdateSpreadsheetPropertiesRequest

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

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

object (SpreadsheetProperties)

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

fields

string (FieldMask format)

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

UpdateSheetPropertiesRequest

อัปเดตคุณสมบัติของชีตด้วยแอตทริบิวต์ที่ระบุ sheetId

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

object (SheetProperties)

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

fields

string (FieldMask format)

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

UpdateDimensionPropertiesRequest

อัปเดตพร็อพเพอร์ตี้ของมิติข้อมูลภายในช่วงที่ระบุ

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

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

DataSourceSheetDimensionRange

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

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

integer

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

columnReferences[]

object (DataSourceColumnReference)

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

UpdateNamedRangeRequest

อัปเดตคุณสมบัติของช่วงที่ตั้งชื่อด้วย namedRangeId

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

object (NamedRange)

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

fields

string (FieldMask format)

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

RepeatCellRequest

อัปเดตเซลล์ทั้งหมดในช่วงเป็นค่าในออบเจ็กต์เซลล์ที่ระบุ เฉพาะฟิลด์ที่แสดงรายการใน 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 เป็นคำโดยนัยและไม่ควรระบุ คำขอ "*" สามารถใช้เป็นช่องสั้นๆ สำหรับแสดงรายการทุกช่อง

AddNamedRangeRequest

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

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

object (NamedRange)

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

DeleteNamedRangeRequest

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

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

string

รหัสของช่วงที่ตั้งชื่อแล้วที่จะลบ

AddSheetRequest

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

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

object (SheetProperties)

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

DeleteSheetRequest

ลบชีตที่ขอ

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

integer

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

ถ้าแผ่นงานเป็น DATA_SOURCE ประเภท ที่เชื่อมโยง วันที่ DataSource จะถูกลบไปด้วย

AutoFillRequest

กรอกข้อมูลมากขึ้นตามข้อมูลที่มีอยู่

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

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

ฟิลด์ Union area พื้นที่ที่จะป้อนข้อความอัตโนมัติ area ต้องเป็นอย่างใดอย่างหนึ่งต่อไปนี้
range

object (GridRange)

ช่วงที่จะป้อนข้อความอัตโนมัติ วิธีนี้จะตรวจสอบช่วงและตรวจหาตำแหน่งที่มีข้อมูลและป้อนข้อมูลนั้นลงในช่วงที่เหลือโดยอัตโนมัติ

sourceAndDestination

object (SourceAndDestination)

พื้นที่ต้นทางและปลายทางที่จะป้อนข้อความอัตโนมัติ ซึ่งจะแสดงแหล่งที่มาของการป้อนข้อความอัตโนมัติและตำแหน่งที่จะขยายข้อมูลดังกล่าวอย่างชัดเจน

SourceAndDestination

ชุดค่าผสมของช่วงแหล่งที่มาและวิธีขยายแหล่งที่มานั้น

การแสดง JSON
{
  "source": {
    object (GridRange)
  },
  "dimension": enum (Dimension),
  "fillLength": integer
}
ช่อง
source

object (GridRange)

ตำแหน่งของข้อมูลที่จะใช้เป็นแหล่งที่มาของการป้อนข้อความอัตโนมัติ

dimension

enum (Dimension)

มิติข้อมูลที่ควรกรอกข้อมูล

fillLength

integer

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

CutPasteRequest

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

การแสดง JSON
{
  "source": {
    object (GridRange)
  },
  "destination": {
    object (GridCoordinate)
  },
  "pasteType": enum (PasteType)
}
ช่อง
source

object (GridRange)

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

destination

object (GridCoordinate)

พิกัดด้านซ้ายบนที่ควรวางข้อมูล

pasteType

enum (PasteType)

ประเภทข้อมูลที่จะวาง ระบบจะตัดข้อมูลต้นทางทั้งหมด ไม่ว่าจะวางข้อมูลใดก็ตาม

PasteType

ควรวางข้อมูลประเภทใด

Enum
PASTE_NORMAL วางค่า สูตร รูปแบบ และผสาน
PASTE_VALUES วางค่าเท่านั้น โดยไม่มีรูปแบบ สูตร หรือการผสาน
PASTE_FORMAT วางเฉพาะรูปแบบและการตรวจสอบข้อมูลเท่านั้น
PASTE_NO_BORDERS ชอบ PASTE_NORMAL แต่ไร้ขอบเขต
PASTE_FORMULA วางเฉพาะสูตร
PASTE_DATA_VALIDATION วางเฉพาะการตรวจสอบข้อมูล
PASTE_CONDITIONAL_FORMATTING วางเฉพาะกฎการจัดรูปแบบตามเงื่อนไข

CopyPasteRequest

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

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

ควรวางแนวทางข้อมูลนั้นอย่างไรเมื่อวาง

PasteOrientation

ควรดำเนินการวางอย่างไร

Enum
NORMAL วางตามปกติ
TRANSPOSE วางสลับตำแหน่ง โดยแถวทั้งหมดจะกลายเป็นคอลัมน์ และในทางกลับกัน

MergeCellsRequest

ผสานเซลล์ทั้งหมดในช่วง

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

object (GridRange)

ช่วงของเซลล์ที่จะผสาน

mergeType

enum (MergeType)

วิธีผสานเซลล์

MergeType

ประเภทการผสานที่จะสร้าง

Enum
MERGE_ALL สร้างการผสานรายการเดียวจากช่วง
MERGE_COLUMNS สร้างการผสานสำหรับแต่ละคอลัมน์ในช่วง
MERGE_ROWS สร้างการผสานสำหรับแต่ละแถวในช่วง

UnmergeCellsRequest

ยกเลิกการผสานเซลล์ในช่วงที่กำหนด

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

object (GridRange)

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

UpdateBordersRequest

อัปเดตเส้นขอบของช่วง หากไม่ได้ตั้งค่าฟิลด์ในคำขอ แสดงว่าขอบยังคงเป็นแบบเดิม ตัวอย่างเช่น มี UpdateBordersRequest ในลำดับต่อมาอีก 2 รายการ ดังนี้

  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 จะถูกล้าง

AddFilterViewRequest

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

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

object (FilterView)

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

AppendCellsRequest

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

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

integer

รหัสชีตที่จะต่อท้ายข้อมูล

rows[]

object (RowData)

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

fields

string (FieldMask format)

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

ClearBasicFilterRequest

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

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

integer

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

DeleteDimensionRequest

ลบมิติข้อมูลออกจากชีต

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

object (DimensionRange)

มิติข้อมูลที่จะลบออกจากชีต

DeleteEmbeddedObjectRequest

ลบวัตถุที่ฝังอยู่ซึ่งมีรหัสที่ระบุ

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

integer

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

DeleteFilterViewRequest

ลบมุมมองตัวกรองที่เฉพาะเจาะจง

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

integer

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

DuplicateFilterViewRequest

ทำซ้ำมุมมองตัวกรองที่กำหนด

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

ชื่อของชีตใหม่ หากเว้นว่างไว้ ระบบจะเลือกชื่อใหม่ให้คุณ

FindReplaceRequest

ค้นหาและแทนที่ข้อมูลในเซลล์ในช่วง แผ่นงาน หรือแผ่นงานทั้งหมด

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

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

ตั้งค่าจริงเพื่อค้นหา/แทนที่ชีตทั้งหมด

InsertDimensionRequest

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

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

object (DimensionRange)

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

inheritFromBefore

boolean

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

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

InsertRangeRequest

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

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

object (GridRange)

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

shiftDimension

enum (Dimension)

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

MoveDimensionRequest

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

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

object (DimensionRange)

มิติข้อมูลแหล่งที่มาที่จะย้าย

destinationIndex

integer

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

ตัวอย่างเช่น A1..A5 จาก วันที่ 0, 1, 2, 3, 4 และอยากย้าย "1" และ "2" ถึงระหว่าง "3" และ "4" แหล่งที่มาจะเป็น ROWS [1..3) และดัชนีปลายทางจะเป็น "4" (ดัชนีฐาน 0 ของแถว 5) ผลลัพธ์ที่ได้คือ A1..A5 จาก 0, 3, 1, 2, 4

UpdateEmbeddedObjectPositionRequest

อัปเดตตำแหน่งของวัตถุที่ฝัง (เช่น การย้ายหรือปรับขนาดแผนภูมิหรือรูปภาพ)

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

integer

รหัสของออบเจ็กต์ที่จะย้าย

newPosition

object (EmbeddedObjectPosition)

ตำแหน่งที่ชัดเจนสำหรับย้ายวัตถุที่ฝังไป ถ้า newPosition.sheetId แล้ว ระบบจะสร้างชีตใหม่ที่มีรหัสนั้นขึ้น ถ้า newPosition.newSheet ตั้งค่าเป็น "จริง" ระบบจะสร้างชีตใหม่พร้อมรหัสที่จะเลือกให้คุณ

fields

string (FieldMask format)

ฟิลด์ของ OverlayPosition ที่ควรอัปเดตเมื่อตั้งค่าตำแหน่งใหม่ ใช้เฉพาะเมื่อ newPosition.overlayPosition ได้รับการตั้งค่าแล้ว ซึ่งในกรณีนี้ต้องระบุอย่างน้อยหนึ่งฟิลด์ รูท newPosition.overlayPosition เป็นคำโดยนัยและไม่ควรระบุ คำขอ "*" สามารถใช้เป็นช่องสั้นๆ สำหรับแสดงรายการทุกช่อง

PasteDataRequest

จะแทรกข้อมูลในสเปรดชีตโดยเริ่มจากพิกัดที่ระบุ

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

TextToColumnsRequest

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

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

object (GridRange)

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

delimiter

string

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

delimiterType

enum (DelimiterType)

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

DelimiterType

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

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

UpdateFilterViewRequest

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

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

object (FilterView)

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

fields

string (FieldMask format)

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

DeleteRangeRequest

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

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

object (GridRange)

ช่วงของเซลล์ที่จะลบ

shiftDimension

enum (Dimension)

มิติข้อมูลที่จะแทนที่ด้วยเซลล์ที่ลบ ถ้า ROWS เซลล์ที่มีอยู่จะเลื่อนขึ้นเพื่อแทนที่เซลล์ที่ลบ ถ้า COLUMNS เซลล์ที่มีอยู่จะเลื่อนไปทางซ้ายเพื่อแทนที่เซลล์ที่ลบ

AppendDimensionRequest

เพิ่มแถวหรือคอลัมน์ต่อท้ายชีต

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

ดัชนีฐาน 0 ของกฎที่ควรแทนที่หรือย้าย

sheetId

integer

แผ่นงานของกฎที่จะย้าย ต้องระบุหาก newIndex ไม่ได้ตั้งค่าไว้ หรือไม่มีการใช้งาน

ฟิลด์ Union instruction ประเภทของการอัปเดตที่ควรเกิดขึ้น instruction ต้องเป็นอย่างใดอย่างหนึ่งต่อไปนี้
rule

object (ConditionalFormatRule)

กฎที่ควรแทนที่กฎในดัชนีที่ระบุ

newIndex

integer

ดัชนีใหม่ฐาน 0 ที่กฎควรถูกนำไปต่อท้าย

DeleteConditionalFormatRuleRequest

ลบกฎการจัดรูปแบบตามเงื่อนไขในดัชนีที่ระบุ กฎที่ตามมาทั้งหมด ก็ลดลง

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

integer

ดัชนีฐาน 0 ของกฎที่จะถูกลบ

sheetId

integer

ชีตที่กำลังลบกฎอยู่

SortRangeRequest

จัดเรียงข้อมูลในแถวตามลำดับการจัดเรียงต่อคอลัมน์

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

object (GridRange)

ช่วงที่จะจัดเรียง

sortSpecs[]

object (SortSpec)

ลำดับการจัดเรียงต่อคอลัมน์ ระบบจะใช้ข้อกำหนดในภายหลังเมื่อค่าเท่ากันในข้อกำหนดก่อนหน้า

SetDataValidationRequest

ตั้งค่ากฎการตรวจสอบข้อมูลให้กับทุกเซลล์ในช่วง หากต้องการล้างการตรวจสอบในช่วง ให้เรียกใช้โดยไม่ต้องระบุกฎ

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

object (GridRange)

ช่วงที่กฎการตรวจสอบข้อมูลควรใช้

rule

object (DataValidationRule)

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

SetBasicFilterRequest

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

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

object (BasicFilter)

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

AddProtectedRangeRequest

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

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

object (ProtectedRange)

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

UpdateProtectedRangeRequest

อัปเดตช่วงที่ป้องกันที่มีอยู่ด้วยแอตทริบิวต์ protectedRangeId

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

object (ProtectedRange)

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

fields

string (FieldMask format)

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

DeleteProtectedRangeRequest

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

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

integer

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

AutoResizeDimensionsRequest

ปรับขนาดมิติข้อมูลอย่างน้อย 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)

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

AddChartRequest

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

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

object (EmbeddedChart)

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

UpdateChartSpecRequest

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

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

integer

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

spec

object (ChartSpec)

ข้อกำหนดที่จะนำไปใช้กับแผนภูมิ

UpdateBandingRequest

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

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

object (BandedRange)

ช่วงของแถบสีที่จะอัปเดตด้วยคุณสมบัติใหม่

fields

string (FieldMask format)

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

AddBandingRequest

เพิ่มช่วงของแถบสีใหม่ในสเปรดชีต

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

object (BandedRange)

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

DeleteBandingRequest

นำช่วงที่ตัดเป็นแถบสีที่มีรหัสที่กำหนดออกจากสเปรดชีต

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

integer

รหัสของช่วงที่รวมแถบสีที่จะลบ

CreateDeveloperMetadataRequest

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

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

object (DeveloperMetadata)

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

UpdateDeveloperMetadataRequest

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

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

object (DataFilter)

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

developerMetadata

object (DeveloperMetadata)

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

fields

string (FieldMask format)

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

DeleteDeveloperMetadataRequest

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

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

object (DataFilter)

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

RandomizeRangeRequest

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

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

object (GridRange)

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

AddDimensionGroupRequest

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

ถ้าช่วงที่ขอเป็นซูเปอร์เซ็ตของช่วงของกลุ่ม G ที่มีอยู่ ความลึกของ G จะเพิ่มขึ้น และของกลุ่ม G ใหม่นี้ มีความลึกของกลุ่มนั้น เช่น กลุ่ม [C:D, depth 1] + [B:E] จะทําให้กลุ่ม [B:E, depth 1] และ [C:D, depth 2] ถ้าช่วงที่ขอเป็นส่วนย่อยของช่วงของกลุ่ม G ที่มีอยู่แล้ว ความลึกของกลุ่มใหม่ G' มีค่ามากกว่าความลึกของ G เช่น กลุ่ม [B:E, ความลึก 1] + [C:D] จะให้ผลลัพธ์เป็นกลุ่ม [B:E, ความลึก 1] และ [C:D, ความลึก 2] หากช่วงที่ขอเริ่มต้นก่อนและสิ้นสุดภายใน หรือเริ่มต้นภายในและสิ้นสุดหลังจากช่วงของกลุ่ม G ที่มีอยู่ ช่วงของกลุ่ม G ที่มีอยู่จะกลายเป็นการรวมของช่วง และกลุ่มใหม่ G' มีความลึกที่มากกว่าความลึกของ G และเป็นจุดตัดของช่วง เช่น กลุ่ม [B:D, ความลึก 1] + [C:E] จะทำให้เกิดกลุ่ม [B:E, ความลึก 1] และ [C:D, ความลึก 2]

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

object (DimensionRange)

ช่วงที่จะสร้างกลุ่ม

DeleteDimensionGroupRequest

ลบกลุ่มในช่วงที่ระบุโดยการลดความลึกของมิติข้อมูลในช่วง

เช่น สมมติว่าชีตมีกลุ่มความลึก 1 เหนือ B:E และกลุ่มความลึก 2 เหนือ C:D การลบกลุ่มที่อยู่บน D:E จะเป็นการออกจากชีตซึ่งมีกลุ่ม depth-1 บน B:D และกลุ่ม depth-2 บน C:C

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

object (DimensionRange)

ช่วงของกลุ่มที่จะลบ

UpdateDimensionGroupRequest

อัปเดตสถานะของกลุ่มที่ระบุ

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

object (DimensionGroup)

กลุ่มที่ควรอัปเดตสถานะ ช่วงและความลึกของกลุ่มควรระบุกลุ่มที่ถูกต้องในชีต รวมถึงช่องอื่นๆ ทั้งหมดที่มีการอัปเดต

fields

string (FieldMask format)

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

TrimWhitespaceRequest

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

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

object (GridRange)

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

DeleteDuplicatesRequest

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

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

การแสดง 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 เป็นคำโดยนัยและไม่ควรระบุ คำขอ "*" สามารถใช้เป็นช่องสั้นๆ สำหรับแสดงรายการทุกช่อง

AddSlicerRequest

เพิ่มตัวควบคุมตัวกรองไปยังชีตในสเปรดชีต

การแสดง 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 เป็นคำโดยนัยและไม่ควรระบุ สามารถใช้ "*"` เดียวเป็นคำสั้นสำหรับระบุทุกช่องได้

AddDataSourceRequest

เพิ่มแหล่งข้อมูล หลังจากเพิ่มแหล่งข้อมูลเรียบร้อยแล้ว การเชื่อมโยง DATA_SOURCE ระบบจะสร้างชีตและมีการเรียกใช้เพื่อรีเฟรชชีตเพื่ออ่านข้อมูลจากแหล่งข้อมูล

คำขอจำเป็นต้องมี bigquery.readonly ขอบเขต OAuth หากคุณกำลังเพิ่มแหล่งข้อมูล BigQuery

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

object (DataSource)

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

UpdateDataSourceRequest

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

คำขอจำเป็นต้องมี bigquery.readonly ขอบเขต OAuth หากคุณกำลังอัปเดตแหล่งข้อมูล BigQuery

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

object (DataSource)

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

fields

string (FieldMask format)

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

DeleteDataSourceRequest

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

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

string

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

RefreshDataSourceRequest

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

คำขอจำเป็นต้องมี bigquery.readonly ขอบเขต OAuth ในกรณีที่รีเฟรชแหล่งข้อมูล BigQuery

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

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

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

DataSourceObjectReferences

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

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

object (DataSourceObjectReference)

ข้อมูลอ้างอิง

CancelDataSourceRefreshRequest

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

คำขอจำเป็นต้องมี bigquery.readonly ขอบเขต OAuth หากคุณยกเลิกการรีเฟรชแหล่งข้อมูล BigQuery

การแสดง JSON
{

  // 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.
}
ช่อง
ฟิลด์ Union target ระบุสิ่งที่จะยกเลิก target ต้องเป็นอย่างใดอย่างหนึ่งต่อไปนี้
references

object (DataSourceObjectReferences)

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

dataSourceId

string

การอ้างถึง DataSource หากระบุ จะเป็นการยกเลิกการรีเฟรชออบเจ็กต์แหล่งข้อมูลที่เชื่อมโยงทั้งหมดสำหรับแหล่งข้อมูลนี้

isAll

boolean

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