Requests

ส่งคำขอ

การอัปเดตรายการเดียวที่จะใช้กับเอกสาร

การแสดง JSON 
{

  // Union field request can be only one of the following:
  "replaceAllText": {
    object (ReplaceAllTextRequest)
  },
  "insertText": {
    object (InsertTextRequest)
  },
  "updateTextStyle": {
    object (UpdateTextStyleRequest)
  },
  "createParagraphBullets": {
    object (CreateParagraphBulletsRequest)
  },
  "deleteParagraphBullets": {
    object (DeleteParagraphBulletsRequest)
  },
  "createNamedRange": {
    object (CreateNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "updateParagraphStyle": {
    object (UpdateParagraphStyleRequest)
  },
  "deleteContentRange": {
    object (DeleteContentRangeRequest)
  },
  "insertInlineImage": {
    object (InsertInlineImageRequest)
  },
  "insertTable": {
    object (InsertTableRequest)
  },
  "insertTableRow": {
    object (InsertTableRowRequest)
  },
  "insertTableColumn": {
    object (InsertTableColumnRequest)
  },
  "deleteTableRow": {
    object (DeleteTableRowRequest)
  },
  "deleteTableColumn": {
    object (DeleteTableColumnRequest)
  },
  "insertPageBreak": {
    object (InsertPageBreakRequest)
  },
  "deletePositionedObject": {
    object (DeletePositionedObjectRequest)
  },
  "updateTableColumnProperties": {
    object (UpdateTableColumnPropertiesRequest)
  },
  "updateTableCellStyle": {
    object (UpdateTableCellStyleRequest)
  },
  "updateTableRowStyle": {
    object (UpdateTableRowStyleRequest)
  },
  "replaceImage": {
    object (ReplaceImageRequest)
  },
  "updateDocumentStyle": {
    object (UpdateDocumentStyleRequest)
  },
  "mergeTableCells": {
    object (MergeTableCellsRequest)
  },
  "unmergeTableCells": {
    object (UnmergeTableCellsRequest)
  },
  "createHeader": {
    object (CreateHeaderRequest)
  },
  "createFooter": {
    object (CreateFooterRequest)
  },
  "createFootnote": {
    object (CreateFootnoteRequest)
  },
  "replaceNamedRangeContent": {
    object (ReplaceNamedRangeContentRequest)
  },
  "updateSectionStyle": {
    object (UpdateSectionStyleRequest)
  },
  "insertSectionBreak": {
    object (InsertSectionBreakRequest)
  },
  "deleteHeader": {
    object (DeleteHeaderRequest)
  },
  "deleteFooter": {
    object (DeleteFooterRequest)
  },
  "pinTableHeaderRows": {
    object (PinTableHeaderRowsRequest)
  }
  // End of list of possible types for union field request.
}
ช่อง
ฟิลด์สหภาพ request คำขอที่เฉพาะเจาะจงที่จะใช้ ต้องมีฟิลด์เดียวเท่านั้น request ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
replaceAllText

object (ReplaceAllTextRequest)

แทนที่อินสแตนซ์ทั้งหมดของข้อความที่ระบุ

insertText

object (InsertTextRequest)

แทรกข้อความในตำแหน่งที่ระบุ

updateTextStyle

object (UpdateTextStyleRequest)

อัปเดตรูปแบบข้อความในช่วงที่ระบุ

createParagraphBullets

object (CreateParagraphBulletsRequest)

สร้างหัวข้อย่อยสำหรับย่อหน้า

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

ลบหัวข้อย่อยออกจากย่อหน้า

createNamedRange

object (CreateNamedRangeRequest)

สร้างช่วงที่มีชื่อ

deleteNamedRange

object (DeleteNamedRangeRequest)

ลบช่วงที่มีชื่อ

updateParagraphStyle

object (UpdateParagraphStyleRequest)

อัปเดตรูปแบบย่อหน้าในช่วงที่ระบุ

deleteContentRange

object (DeleteContentRangeRequest)

ลบเนื้อหาออกจากเอกสาร

insertInlineImage

object (InsertInlineImageRequest)

แทรกรูปภาพในบรรทัดในตำแหน่งที่ระบุ

insertTable

object (InsertTableRequest)

แทรกตารางในตำแหน่งที่ระบุ

insertTableRow

object (InsertTableRowRequest)

แทรกแถวว่างในตาราง

insertTableColumn

object (InsertTableColumnRequest)

แทรกคอลัมน์ว่างในตาราง

deleteTableRow

object (DeleteTableRowRequest)

ลบแถวออกจากตาราง

deleteTableColumn

object (DeleteTableColumnRequest)

ลบคอลัมน์ออกจากตาราง

insertPageBreak

object (InsertPageBreakRequest)

แทรกการแบ่งหน้าในตำแหน่งที่ระบุ

deletePositionedObject

object (DeletePositionedObjectRequest)

ลบออบเจ็กต์ที่จัดตำแหน่งแล้วออกจากเอกสาร

updateTableColumnProperties

object (UpdateTableColumnPropertiesRequest)

อัปเดตพร็อพเพอร์ตี้ของคอลัมน์ในตาราง

updateTableCellStyle

object (UpdateTableCellStyleRequest)

อัปเดตสไตล์ของเซลล์ตาราง

updateTableRowStyle

object (UpdateTableRowStyleRequest)

อัปเดตรูปแบบแถวในตาราง

replaceImage

object (ReplaceImageRequest)

แทนที่รูปภาพในเอกสาร

updateDocumentStyle

object (UpdateDocumentStyleRequest)

อัปเดตรูปแบบของเอกสาร

mergeTableCells

object (MergeTableCellsRequest)

ผสานเซลล์ในตาราง

unmergeTableCells

object (UnmergeTableCellsRequest)

เลิกผสานเซลล์ในตาราง

createHeader

object (CreateHeaderRequest)

สร้างส่วนหัว

createFootnote

object (CreateFootnoteRequest)

สร้างเชิงอรรถ

replaceNamedRangeContent

object (ReplaceNamedRangeContentRequest)

แทนที่เนื้อหาในช่วงที่ชื่อ

updateSectionStyle

object (UpdateSectionStyleRequest)

อัปเดตรูปแบบส่วนในช่วงที่ระบุ

insertSectionBreak

object (InsertSectionBreakRequest)

แทรกตัวแบ่งส่วนในตำแหน่งที่ระบุ

deleteHeader

object (DeleteHeaderRequest)

ลบส่วนหัวออกจากเอกสาร

pinTableHeaderRows

object (PinTableHeaderRowsRequest)

อัปเดตจำนวนแถวส่วนหัวที่ปักหมุดไว้ในตาราง

ReplaceAllTextRequest

แทนที่อินสแตนซ์ทั้งหมดของข้อความที่ตรงกับเกณฑ์ด้วย replace text

การแสดง JSON 
{
  "replaceText": string,
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field criteria can be only one of the following:
  "containsText": {
    object (SubstringMatchCriteria)
  }
  // End of list of possible types for union field criteria.
}
ช่อง
replaceText

string

ข้อความที่จะแทนที่ข้อความที่ตรงกัน

tabsCriteria

object (TabsCriteria)

ไม่บังคับ เกณฑ์ที่ใช้ระบุแท็บที่จะแทนที่

หากไม่ระบุ การเปลี่ยนทดแทนจะมีผลกับทุกแท็บ

ในเอกสารที่มีแท็บเดียว ให้ทำดังนี้

  • หากระบุ ต้องตรงกับรหัสของแท็บเดียว

  • หากไม่ระบุ การเปลี่ยนทดแทนจะมีผลกับแท็บเดี่ยว

ในเอกสารที่มีหลายแท็บ ให้ทำดังนี้

  • หากระบุไว้ การเปลี่ยนทดแทนจะมีผลกับแท็บที่ระบุ

  • หากไม่ระบุ การเปลี่ยนทดแทนจะมีผลกับทุกแท็บ

ฟิลด์สหภาพ criteria เกณฑ์ที่ใช้จับคู่ข้อความที่จะแทนที่ criteria ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
containsText

object (SubstringMatchCriteria)

ค้นหาข้อความในเอกสารที่ตรงกับสตริงย่อยนี้

SubstringMatchCriteria

เกณฑ์ที่ตรงกับสตริงข้อความที่เฉพาะเจาะจงในเอกสาร

การแสดง JSON 
{
  "text": string,
  "matchCase": boolean
}
ช่อง
text

string

ข้อความที่จะค้นหาในเอกสาร

matchCase

boolean

ระบุว่าการค้นหาควรคำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่หรือไม่

  • True : การค้นหาจะคำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่
  • False : การค้นหาจะไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่

TabsCriteria

เกณฑ์ที่ระบุแท็บที่เรียกใช้คําขอ

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

string

รายการรหัสแท็บที่เรียกใช้คําขอ

InsertTextRequest

แทรกข้อความในตำแหน่งที่ระบุ

การแสดง JSON 
{
  "text": string,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
ช่อง
text

string

ข้อความที่จะแทรก

การวางอักขระบรรทัดใหม่จะสร้าง Paragraph ใหม่โดยปริยายที่ดัชนีนั้น ระบบจะคัดลอกสไตล์ย่อหน้าของย่อหน้าใหม่จากย่อหน้า ณ ดัชนีการแทรกปัจจุบัน ซึ่งรวมถึงรายการและหัวข้อย่อย

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

ระบบจะนำอักขระควบคุมบางตัว (U+0000-U+0008, U+000C-U+001F) และอักขระจากพื้นที่ใช้งานส่วนตัวของ Unicode Basic Multilingual Plane (U+E000-U+F8FF) ออกจากข้อความที่แทรก

ฟิลด์สหภาพ insertion_location ตำแหน่งที่จะแทรกข้อความ insertion_location ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
location

object (Location)

แทรกข้อความที่ดัชนีที่ต้องการในเอกสาร

ข้อความต้องแทรกภายในขอบเขตของ Paragraph ที่มีอยู่ เช่น คุณจะแทรกข้อความที่ดัชนีเริ่มต้นของตารางไม่ได้ (กล่าวคือ ระหว่างตารางกับย่อหน้าก่อนหน้า) ข้อความต้องแทรกในย่อหน้าก่อนหน้า

endOfSegmentLocation

object (EndOfSegmentLocation)

แทรกข้อความที่ท้ายส่วนหัว ส่วนท้าย เชิงอรรถ หรือเนื้อหาเอกสาร

ตำแหน่ง

ตำแหน่งที่เจาะจงในเอกสาร

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

string

รหัสของส่วนหัว ส่วนท้าย หรือเชิงอรรถที่มีตำแหน่ง รหัสกลุ่มว่างหมายถึงเนื้อหาของเอกสาร

index

integer

ดัชนีฐาน 0 ในหน่วยโค้ด UTF-16

ดัชนีจะสัมพันธ์กับจุดเริ่มต้นของส่วนที่ระบุโดย segmentId

tabId

string

แท็บที่มีตำแหน่งอยู่ หากไม่ระบุ ระบบจะใช้คำขอกับแท็บแรก

ในเอกสารที่มีแท็บเดียว ให้ทำดังนี้

  • หากระบุ ต้องตรงกับรหัสของแท็บเดียว

  • หากไม่ระบุ คำขอจะมีผลกับแท็บเดียว

ในเอกสารที่มีหลายแท็บ ให้ทำดังนี้

  • หากระบุไว้ คำขอจะมีผลกับแท็บที่ระบุ

  • หากไม่ระบุ ค่าเริ่มต้นคือคำขอจะมีผลกับแท็บแรกในเอกสาร

EndOfSegmentLocation

ตำแหน่งที่ส่วนท้ายของเนื้อหา ส่วนหัว ส่วนท้าย หรือเชิงอรรถ ตำแหน่งอยู่ก่อนบรรทัดใหม่สุดท้ายในส่วนเอกสาร

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

string

รหัสของส่วนหัว ส่วนท้าย หรือเชิงอรรถที่มีตำแหน่ง รหัสกลุ่มว่างหมายถึงเนื้อหาของเอกสาร

tabId

string

แท็บที่มีตำแหน่งอยู่ หากไม่ระบุ ระบบจะใช้คำขอกับแท็บแรก

ในเอกสารที่มีแท็บเดียว ให้ทำดังนี้

  • หากระบุ ต้องตรงกับรหัสของแท็บเดียว

  • หากไม่ระบุ คำขอจะมีผลกับแท็บเดียว

ในเอกสารที่มีหลายแท็บ ให้ทำดังนี้

  • หากระบุไว้ คำขอจะมีผลกับแท็บที่ระบุ

  • หากไม่ระบุ ค่าเริ่มต้นคือคำขอจะมีผลกับแท็บแรกในเอกสาร

UpdateTextStyleRequest

อัปเดตการจัดรูปแบบข้อความ

การแสดง JSON 
{
  "textStyle": {
    object (TextStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}
ช่อง
textStyle

object (TextStyle)

รูปแบบที่จะตั้งค่าในข้อความ

หากค่าของสไตล์หนึ่งๆ ตรงกับค่าของสไตล์หลัก ระบบจะตั้งค่าสไตล์นั้นให้รับค่าจากสไตล์หลัก

การเปลี่ยนแปลงรูปแบบข้อความบางอย่างอาจทำให้เกิดการเปลี่ยนแปลงอื่นๆ เพื่อจำลองลักษณะการทำงานของเครื่องมือแก้ไขเอกสาร ดูข้อมูลเพิ่มเติมในเอกสารประกอบของ TextStyle

fields

string (FieldMask format)

ช่องที่ควรอัปเดต

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

เช่น หากต้องการอัปเดตรูปแบบข้อความเป็นแบบตัวหนา ให้ตั้งค่า fields เป็น "bold"

หากต้องการรีเซ็ตพร็อพเพอร์ตี้เป็นค่าเริ่มต้น ให้ใส่ชื่อช่องในมาสก์ช่อง แต่ไม่ต้องตั้งค่าช่อง

ฟิลด์สหภาพ insertion_location ประเภทของช่วงที่ใช้ซึ่งจะอัปเดตรูปแบบข้อความ insertion_location ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
range

object (Range)

ช่วงของข้อความที่จะจัดรูปแบบ

ระบบอาจขยายช่วงให้รวมบรรทัดใหม่ที่อยู่ติดกันด้วย

หากช่วงมีย่อหน้าที่เป็นของรายการทั้งหมด ระบบจะอัปเดตสัญลักษณ์หัวข้อของย่อหน้าด้วยรูปแบบข้อความที่ตรงกันด้วย

ไม่สามารถแทรกช่วงภายใน UpdateTextStyleRequest แบบสัมพัทธ์

CreateParagraphBulletsRequest

สร้างหัวข้อย่อยสำหรับย่อหน้าทั้งหมดที่ทับซ้อนกับช่วงที่กำหนด

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

หากย่อหน้าที่อยู่ก่อนหน้าย่อหน้าที่จะอัปเดตอยู่ในรายการที่มีค่าที่กำหนดไว้ล่วงหน้าที่ตรงกัน ระบบจะเพิ่มย่อหน้าที่จะอัปเดตลงในรายการก่อนหน้านั้น

การแสดง JSON 
{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
ช่อง
range

object (Range)

ช่วงที่จะใช้สัญลักษณ์หัวข้อย่อยที่กำหนดไว้ล่วงหน้า

bulletPreset

enum (BulletGlyphPreset)

ประเภทของสัญลักษณ์หัวข้อที่จะใช้

BulletGlyphPreset

รูปแบบที่กำหนดไว้ล่วงหน้าของสัญลักษณ์หัวข้อสำหรับรายการ

รูปแบบเหล่านี้ใช้สัญลักษณ์หัวข้อประเภทต่อไปนี้

  • ARROW : ลูกศรที่สอดคล้องกับ Code Point Unicode U+2794
  • ARROW3D : ลูกศรที่มีแรเงา 3 มิติ ซึ่งสอดคล้องกับ Code Point ของ Unicode U+27a2
  • CHECKBOX : สี่เหลี่ยมจัตุรัสกลวง ซึ่งสอดคล้องกับ Code Point Unicode U+274f
  • CIRCLE : วงกลมกลวงซึ่งสอดคล้องกับ Code Point Unicode U+25cb
  • DIAMOND : เพชรเต็มรูปแบบ ซึ่งสอดคล้องกับ Code Point Unicode U+25c6
  • DIAMONDX : เพชรที่มี "x" ซึ่งสอดคล้องกับ Code Point ของ Unicode U+2756
  • HOLLOWDIAMOND : ข้าวหลามตัดแบบโปร่ง ซึ่งสอดคล้องกับ Code Point ของ Unicode U+25c7
  • DISC : วงกลมตัน ซึ่งสอดคล้องกับ Code Point Unicode U+25cf
  • SQUARE : สี่เหลี่ยมจัตุรัสตัน ซึ่งสอดคล้องกับ Code Point Unicode U+25a0
  • STAR : ดาว ซึ่งสอดคล้องกับ Code Point Unicode U+2605
  • ALPHA : ตัวอักษรตัวพิมพ์เล็ก เช่น "a", "b" หรือ "c"
  • UPPERALPHA : ตัวอักษรพิมพ์ใหญ่ เช่น "ก" "ข" หรือ "ค"
  • DECIMAL : ตัวเลข เช่น "1", "2" หรือ "3"
  • ZERODECIMAL : ตัวเลขที่มี 0 นำหน้าตัวเลขหลักเดียว เช่น "01", "02" หรือ "03" ตัวเลขที่มีมากกว่า 1 หลักจะไม่ขึ้นต้นด้วย 0
  • ROMAN : ตัวเลขโรมันตัวพิมพ์เล็ก เช่น "i", "ii" หรือ "iii"
  • UPPERROMAN : ตัวเลขโรมันตัวพิมพ์ใหญ่ เช่น "I", "II" หรือ "III"
  • LEFTTRIANGLE : รูปสามเหลี่ยมชี้ไปทางซ้าย ซึ่งสอดคล้องกับ Code Point Unicode U+25c4
Enum
BULLET_GLYPH_PRESET_UNSPECIFIED ไม่ได้ระบุค่าที่กำหนดล่วงหน้าสำหรับสัญลักษณ์หัวข้อ
BULLET_DISC_CIRCLE_SQUARE รายการหัวข้อย่อยที่มีสัญลักษณ์หัวข้อย่อย DISC, CIRCLE และ SQUARE สำหรับรายการระดับการซ้อน 3 ระดับแรก
BULLET_DIAMONDX_ARROW3D_SQUARE รายการหัวข้อย่อยที่มีสัญลักษณ์หัวข้อย่อย DIAMONDX, ARROW3D และ SQUARE สำหรับรายการระดับการซ้อน 3 ระดับแรก
BULLET_CHECKBOX รายการที่มีหัวข้อย่อยซึ่งมีสัญลักษณ์หัวข้อย่อย CHECKBOX ในระดับการซ้อนรายการทั้งหมด
BULLET_ARROW_DIAMOND_DISC รายการหัวข้อย่อยที่มีสัญลักษณ์หัวข้อย่อย ARROW, DIAMOND และ DISC สำหรับรายการระดับการซ้อน 3 ระดับแรก
BULLET_STAR_CIRCLE_SQUARE รายการหัวข้อย่อยที่มีสัญลักษณ์หัวข้อย่อย STAR, CIRCLE และ SQUARE สำหรับรายการระดับการซ้อน 3 ระดับแรก
BULLET_ARROW3D_CIRCLE_SQUARE รายการหัวข้อย่อยที่มีสัญลักษณ์หัวข้อย่อย ARROW3D, CIRCLE และ SQUARE สำหรับรายการระดับการซ้อน 3 ระดับแรก
BULLET_LEFTTRIANGLE_DIAMOND_DISC รายการหัวข้อย่อยที่มีสัญลักษณ์หัวข้อย่อย LEFTTRIANGLE, DIAMOND และ DISC สำหรับรายการระดับการซ้อน 3 ระดับแรก
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE รายการหัวข้อย่อยที่มีสัญลักษณ์หัวข้อย่อย DIAMONDX, HOLLOWDIAMOND และ SQUARE สำหรับรายการระดับการซ้อน 3 ระดับแรก
BULLET_DIAMOND_CIRCLE_SQUARE รายการหัวข้อย่อยที่มีสัญลักษณ์หัวข้อย่อย DIAMOND, CIRCLE และ SQUARE สำหรับรายการระดับการซ้อน 3 ระดับแรก
NUMBERED_DECIMAL_ALPHA_ROMAN รายการลำดับเลขที่มีสัญลักษณ์ตัวเลข DECIMAL, ALPHA และ ROMAN สำหรับรายการระดับการซ้อน 3 ระดับแรก ตามด้วยเครื่องหมายจุด
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS รายการลำดับเลขที่มีสัญลักษณ์ตัวเลข DECIMAL, ALPHA และ ROMAN สำหรับรายการที่ซ้อนกัน 3 ระดับแรก ตามด้วยวงเล็บ
NUMBERED_DECIMAL_NESTED รายการที่มีลําดับเลขซึ่งมี DECIMAL สัญลักษณ์ตัวเลขคั่นด้วยจุด โดยที่แต่ละระดับการฝังจะใช้สัญลักษณ์ของระดับการฝังก่อนหน้าเป็นคำนำหน้า เช่น "1." '1.1.', '2.', '2.2.'
NUMBERED_UPPERALPHA_ALPHA_ROMAN รายการลำดับเลขที่มีสัญลักษณ์ตัวเลข UPPERALPHA, ALPHA และ ROMAN สำหรับรายการระดับการซ้อน 3 ระดับแรก ตามด้วยเครื่องหมายจุด
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL รายการลำดับเลขที่มีสัญลักษณ์ตัวเลข UPPERROMAN, UPPERALPHA และ DECIMAL สำหรับรายการระดับการซ้อน 3 ระดับแรก ตามด้วยเครื่องหมายจุด
NUMBERED_ZERODECIMAL_ALPHA_ROMAN รายการลำดับเลขที่มีสัญลักษณ์ตัวเลข ZERODECIMAL, ALPHA และ ROMAN สำหรับรายการระดับการซ้อน 3 ระดับแรก ตามด้วยเครื่องหมายจุด

DeleteParagraphBulletsRequest

ลบหัวข้อออกจากย่อหน้าทั้งหมดที่ทับซ้อนกับช่วงที่กำหนด

ระบบจะคงระดับการฝังของย่อหน้าแต่ละรายการไว้โดยเพิ่มการเยื้องไว้ที่ต้นของย่อหน้าที่เกี่ยวข้อง

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

object (Range)

ช่วงที่จะลบหัวข้อ

CreateNamedRangeRequest

สร้าง NamedRange ที่อ้างอิงช่วงที่กำหนด

การแสดง JSON 
{
  "name": string,
  "range": {
    object (Range)
  }
}
ช่อง
name

string

ชื่อของ NamedRange ชื่อไม่จำเป็นต้องไม่ซ้ำกัน

ชื่อต้องมีอักขระอย่างน้อย 1 ตัวและไม่เกิน 256 ตัว โดยวัดเป็นหน่วยโค้ด UTF-16

range

object (Range)

ช่วงที่จะใช้ชื่อ

DeleteNamedRangeRequest

ลบ NamedRange

การแสดง JSON 
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "name": string
  // End of list of possible types for union field named_range_reference.
}
ช่อง
tabsCriteria

object (TabsCriteria)

ไม่บังคับ เกณฑ์ที่ใช้ระบุแท็บที่ควรทำการลบช่วง หากไม่ระบุ ระบบจะลบช่วงในแท็บทั้งหมด

ในเอกสารที่มีแท็บเดียว ให้ทำดังนี้

  • หากระบุ ต้องตรงกับรหัสของแท็บเดียว

  • หากไม่ระบุ ระบบจะลบช่วงในแท็บเดียว

ในเอกสารที่มีหลายแท็บ ให้ทำดังนี้

  • หากระบุ การลบช่วงจะมีผลกับแท็บที่ระบุ

  • หากไม่ระบุ การดำเนินการลบช่วงจะมีผลกับทุกแท็บ

ฟิลด์สหภาพ named_range_reference ค่าที่กําหนดช่วงที่จะลบ ต้องตั้งค่าเพียงรายการเดียว named_range_reference ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
namedRangeId

string

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

name

string

ชื่อของช่วงที่จะลบ ระบบจะลบช่วงที่มีชื่อทั้งหมดที่มีชื่อดังกล่าว

UpdateParagraphStyleRequest

อัปเดตการจัดรูปแบบของย่อหน้าทั้งหมดที่ทับซ้อนกับช่วงที่กำหนด

การแสดง JSON 
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}
ช่อง
paragraphStyle

object (ParagraphStyle)

สไตล์ที่จะตั้งค่าในย่อหน้า

การเปลี่ยนแปลงรูปแบบย่อหน้าบางอย่างอาจทำให้เกิดการเปลี่ยนแปลงอื่นๆ เพื่อจำลองลักษณะการทำงานของเครื่องมือแก้ไขของ Google เอกสาร ดูข้อมูลเพิ่มเติมในเอกสารประกอบของ ParagraphStyle

fields

string (FieldMask format)

ช่องที่ควรอัปเดต

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

เช่น หากต้องการอัปเดตพร็อพเพอร์ตี้การจัดตำแหน่งของรูปแบบย่อหน้า ให้ตั้งค่า fields เป็น "alignment"

หากต้องการรีเซ็ตพร็อพเพอร์ตี้เป็นค่าเริ่มต้น ให้ใส่ชื่อช่องในมาสก์ช่อง แต่ไม่ต้องตั้งค่าช่อง

ฟิลด์สหภาพ insertion_location ประเภทของช่วงที่ใช้ซึ่งจะอัปเดตรูปแบบย่อหน้า insertion_location ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
range

object (Range)

ช่วงที่อยู่ซ้อนทับกับย่อหน้าที่จะจัดรูปแบบ

DeleteContentRangeRequest

ลบเนื้อหาออกจากเอกสาร

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

object (Range)

ช่วงของเนื้อหาที่จะลบ

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

การพยายามลบช่วงบางช่วงอาจส่งผลให้โครงสร้างเอกสารไม่ถูกต้อง ซึ่งในกรณีนี้ระบบจะแสดงข้อผิดพลาด 400 Bad Request

ตัวอย่างคำขอลบที่ไม่ถูกต้อง ได้แก่

  • การลบหน่วยโค้ด 1 หน่วยของคู่ตัวแทน
  • การลบอักขระขึ้นบรรทัดใหม่สุดท้ายของ Body, Header, Footer, Footnote, TableCell หรือ TableOfContents
  • การลบส่วนเริ่มต้นหรือส่วนท้ายของ Table, TableOfContents หรือ Equation โดยไม่ลบองค์ประกอบทั้งหมด
  • การลบอักขระขึ้นบรรทัดใหม่ก่อน Table, TableOfContents หรือ SectionBreak โดยไม่ลบองค์ประกอบ
  • การลบแถวหรือเซลล์แต่ละแถวของตาราง อนุญาตให้ลบเนื้อหาภายในเซลล์ตารางได้

InsertInlineImageRequest

แทรก InlineObject ที่มีรูปภาพในตำแหน่งที่ระบุ

การแสดง JSON 
{
  "uri": string,
  "objectSize": {
    object (Size)
  },

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
ช่อง
uri

string

URI ของรูปภาพ

ระบบจะดึงข้อมูลรูปภาพเพียงครั้งเดียว ณ เวลาแทรก และจะจัดเก็บสำเนาไว้เพื่อแสดงในเอกสาร รูปภาพต้องมีขนาดไม่เกิน 50 MB, ไม่เกิน 25 ล้านพิกเซล และต้องอยู่ในรูปแบบ PNG, JPEG หรือ GIF

URI ที่ระบุต้องเข้าถึงได้แบบสาธารณะและมีความยาวไม่เกิน 2 KB ระบบจะบันทึก URI ไว้กับรูปภาพและแสดงผ่านช่อง ImageProperties.content_uri

objectSize

object (Size)

ขนาดที่รูปภาพควรปรากฏในเอกสาร พร็อพเพอร์ตี้นี้เป็นค่าที่ไม่บังคับ และขนาดสุดท้ายของรูปภาพในเอกสารจะกำหนดโดยกฎต่อไปนี้ * หากไม่ได้ระบุทั้งความกว้างและความสูง ระบบจะคำนวณขนาดเริ่มต้นของรูปภาพตามความละเอียด * หากระบุมิติข้อมูลเพียง 1 รายการ ระบบจะคำนวณมิติข้อมูลอีกรายการหนึ่งเพื่อรักษาสัดส่วนภาพของรูปภาพ * หากระบุทั้งความกว้างและความสูง ระบบจะปรับขนาดรูปภาพให้พอดีกับขนาดที่ระบุโดยคงสัดส่วนการแสดงผลไว้

ฟิลด์สหภาพ insertion_location ตำแหน่งที่จะแทรกรูปภาพ insertion_location ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
location

object (Location)

แทรกรูปภาพตามดัชนีที่เจาะจงในเอกสาร

รูปภาพต้องแทรกภายในขอบเขตของ Paragraph ที่มีอยู่ เช่น แทรกที่ดัชนีเริ่มต้นของตารางไม่ได้ (เช่น ระหว่างตารางกับย่อหน้าก่อนหน้า)

ไม่สามารถแทรกรูปภาพในบรรทัดภายในเชิงอรรถหรือสมการ

endOfSegmentLocation

object (EndOfSegmentLocation)

แทรกข้อความที่ท้ายส่วนหัว ส่วนท้าย หรือเนื้อหาเอกสาร

ไม่สามารถแทรกรูปภาพในบรรทัดในเชิงอรรถ

InsertTableRequest

แทรกตารางในตำแหน่งที่ระบุ

ระบบจะแทรกอักขระบรรทัดใหม่ก่อนตารางที่แทรก

การแสดง JSON 
{
  "rows": integer,
  "columns": integer,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
ช่อง
rows

integer

จํานวนแถวในตาราง

columns

integer

จํานวนคอลัมน์ในตาราง

ฟิลด์สหภาพ insertion_location ตำแหน่งที่จะแทรกตาราง insertion_location ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
location

object (Location)

แทรกตารางที่ดัชนีโมเดลที่เฉพาะเจาะจง

ระบบจะแทรกอักขระบรรทัดใหม่ไว้ก่อนตารางที่แทรก ดังนั้นดัชนีเริ่มต้นของตารางจะอยู่ที่ดัชนีตำแหน่งที่ระบุ + 1

ตารางต้องแทรกภายในขอบเขตของ Paragraph ที่มีอยู่ เช่น ไม่สามารถแทรกที่ดัชนีเริ่มต้นของตาราง (เช่น ระหว่างตารางที่มีอยู่กับย่อหน้าก่อนหน้า)

ไม่สามารถแทรกตารางภายในเชิงอรรถหรือสมการ

endOfSegmentLocation

object (EndOfSegmentLocation)

แทรกตารางที่ท้ายส่วนหัว ส่วนท้าย หรือเนื้อหาเอกสารที่ระบุ ระบบจะแทรกอักขระบรรทัดใหม่ก่อนตารางที่แทรก

แทรกตารางภายในเชิงอรรถไม่ได้

InsertTableRowRequest

แทรกแถวว่างในตาราง

การแสดง JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}
ช่อง
tableCellLocation

object (TableCellLocation)

ตำแหน่งเซลล์ในตารางอ้างอิงที่จะแทรกแถว

ระบบจะแทรกแถวใหม่เหนือ (หรือใต้) แถวที่มีเซลล์อ้างอิง หากเซลล์อ้างอิงเป็นเซลล์ที่ผสาน ระบบจะแทรกแถวใหม่เหนือ (หรือใต้) เซลล์ที่ผสาน

insertBelow

boolean

เลือกว่าจะแทรกแถวใหม่ด้านล่างตำแหน่งเซลล์อ้างอิงหรือไม่

  • True : แทรกใต้เซลล์
  • False : แทรกเหนือเซลล์

TableCellLocation

ตำแหน่งของเซลล์เดียวภายในตาราง

การแสดง JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}
ช่อง
tableStartLocation

object (Location)

ตำแหน่งที่ตารางเริ่มต้นในเอกสาร

rowIndex

integer

ดัชนีแถวแบบนับจากศูนย์ เช่น แถวที่ 2 ในตารางจะมีดัชนีแถวเป็น 1

columnIndex

integer

ดัชนีคอลัมน์แบบ 0 เช่น คอลัมน์ที่ 2 ในตารางมีดัชนีคอลัมน์เป็น 1

InsertTableColumnRequest

แทรกคอลัมน์ว่างในตาราง

การแสดง JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}
ช่อง
tableCellLocation

object (TableCellLocation)

ตำแหน่งเซลล์ในตารางอ้างอิงที่จะแทรกคอลัมน์

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

insertRight

boolean

เลือกว่าจะแทรกคอลัมน์ใหม่ทางด้านขวาของตำแหน่งเซลล์อ้างอิงหรือไม่

  • True : แทรกทางด้านขวา
  • False : แทรกทางด้านซ้าย

DeleteTableRowRequest

ลบแถวออกจากตาราง

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

object (TableCellLocation)

ตำแหน่งเซลล์ในตารางอ้างอิงที่จะลบแถว

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

DeleteTableColumnRequest

ลบคอลัมน์ออกจากตาราง

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

object (TableCellLocation)

ตำแหน่งเซลล์ในตารางอ้างอิงที่จะลบคอลัมน์

ระบบจะลบคอลัมน์ที่เซลล์นี้ครอบคลุม หากเป็นเซลล์ที่ผสานซึ่งครอบคลุมหลายคอลัมน์ ระบบจะลบทุกคอลัมน์ที่เซลล์นั้นครอบคลุม หากไม่มีคอลัมน์เหลืออยู่ในตารางหลังจากการลบนี้ ระบบจะลบทั้งตาราง

InsertPageBreakRequest

แทรกการแบ่งหน้าตามด้วยบรรทัดใหม่ในตำแหน่งที่ระบุ

การแสดง JSON 
{

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
ช่อง
ฟิลด์สหภาพ insertion_location ตำแหน่งที่จะแทรกตัวแบ่งหน้า insertion_location ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
location

object (Location)

แทรกตัวแบ่งหน้า ณ ดัชนีที่เจาะจงในเอกสาร

ต้องแทรกการแบ่งหน้าภายในขอบเขตของParagraphที่มีอยู่ เช่น แทรกที่ดัชนีเริ่มต้นของตารางไม่ได้ (เช่น ระหว่างตารางกับย่อหน้าก่อนหน้า)

ไม่สามารถแทรกตัวแบ่งหน้าภายในตาราง สมการ เชิงอรรถ ส่วนหัว หรือส่วนท้าย เนื่องจากสามารถแทรกการแบ่งหน้าได้ภายในเนื้อหาเท่านั้น ช่อง segment ID จึงต้องว่างเปล่า

endOfSegmentLocation

object (EndOfSegmentLocation)

แทรกตัวแบ่งหน้าไว้ที่ท้ายเนื้อความของเอกสาร

คุณจะแทรกการแบ่งหน้าภายในเชิงอรรถ ส่วนหัว หรือท้ายกระดาษไม่ได้ เนื่องจากสามารถแทรกการแบ่งหน้าได้ภายในเนื้อหาเท่านั้น ช่อง segment ID จึงต้องว่างเปล่า

DeletePositionedObjectRequest

ลบ PositionedObject จากเอกสาร

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

string

รหัสของออบเจ็กต์ที่วางตำแหน่งไว้ซึ่งจะลบ

tabId

string

แท็บที่มีออบเจ็กต์ที่วางไว้เพื่อลบ หากไม่ระบุ ระบบจะใช้คำขอกับแท็บแรก

ในเอกสารที่มีแท็บเดียว ให้ทำดังนี้

  • หากระบุ ต้องตรงกับรหัสของแท็บเดียว

  • หากไม่ระบุ คำขอจะมีผลกับแท็บเดียว

ในเอกสารที่มีหลายแท็บ ให้ทำดังนี้

  • หากระบุไว้ คำขอจะมีผลกับแท็บที่ระบุ

  • หากไม่ระบุ ค่าเริ่มต้นคือคำขอจะมีผลกับแท็บแรกในเอกสาร

UpdateTableColumnPropertiesRequest

อัปเดต TableColumnProperties ของคอลัมน์ในตาราง

การแสดง JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}
ช่อง
tableStartLocation

object (Location)

ตำแหน่งที่ตารางเริ่มต้นในเอกสาร

columnIndices[]

integer

รายการดัชนีคอลัมน์แบบนับจาก 0 ที่ควรอัปเดตพร็อพเพอร์ตี้ หากไม่ระบุดัชนี ระบบจะอัปเดตทุกคอลัมน์

tableColumnProperties

object (TableColumnProperties)

พร็อพเพอร์ตี้ของคอลัมน์ตารางที่จะอัปเดต

หากค่าของ tableColumnProperties#width น้อยกว่า 5 จุด (5/72 นิ้ว) ระบบจะแสดงข้อผิดพลาด 400 Bad Request

fields

string (FieldMask format)

ช่องที่ควรอัปเดต

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

เช่น หากต้องการอัปเดตความกว้างของคอลัมน์ ให้ตั้งค่า fields เป็น "width"

UpdateTableCellStyleRequest

อัปเดตรูปแบบของช่วงเซลล์ตาราง

การแสดง JSON 
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "fields": string,

  // Union field cells can be only one of the following:
  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
  // End of list of possible types for union field cells.
}
ช่อง
tableCellStyle

object (TableCellStyle)

รูปแบบที่จะตั้งค่าในเซลล์ตาราง

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

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

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

ช่องที่ควรอัปเดต

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

เช่น หากต้องการอัปเดตสีพื้นหลังของเซลล์ตาราง ให้ตั้งค่า fields เป็น "backgroundColor"

หากต้องการรีเซ็ตพร็อพเพอร์ตี้เป็นค่าเริ่มต้น ให้ใส่ชื่อช่องในมาสก์ช่อง แต่ไม่ต้องตั้งค่าช่อง

ฟิลด์สหภาพ cells เซลล์ที่จะอัปเดต cells ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
tableRange

object (TableRange)

ช่วงของตารางที่แสดงชุดย่อยของตารางที่จะใช้การอัปเดต

tableStartLocation

object (Location)

ตำแหน่งที่ตารางเริ่มต้นในเอกสาร เมื่อระบุแล้ว การอัปเดตจะมีผลกับเซลล์ทั้งหมดในตาราง

TableRange

ช่วงตารางแสดงการอ้างอิงไปยังชุดย่อยของตาราง

โปรดทราบว่าเซลล์ที่ระบุโดยช่วงตารางไม่จำเป็นต้องเป็นรูปสี่เหลี่ยมผืนผ้า ตัวอย่างเช่น สมมติว่าเรามีตารางขนาด 3 x 3 ที่ผสานเซลล์ทั้งหมดของแถวสุดท้ายเข้าด้วยกัน ตารางจะมีลักษณะดังนี้ 

 [   ][   ][   ]
 [   ][   ][   ]
 [             ]

ช่วงตารางที่มีตำแหน่งเซลล์ในตาราง = (tableStartLocation, row = 0, column = 0), ช่วงแถว = 3 และช่วงคอลัมน์ = 2 จะระบุเซลล์ต่อไปนี้ 

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]
การแสดง JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
ช่อง
tableCellLocation

object (TableCellLocation)

ตำแหน่งเซลล์ที่ช่วงตารางเริ่มต้น

rowSpan

integer

ช่วงแถวของช่วงตาราง

columnSpan

integer

ช่วงคอลัมน์ของช่วงตาราง

UpdateTableRowStyleRequest

อัปเดต TableRowStyle แถวในตาราง

การแสดง JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}
ช่อง
tableStartLocation

object (Location)

ตำแหน่งที่ตารางเริ่มต้นในเอกสาร

rowIndices[]

integer

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

tableRowStyle

object (TableRowStyle)

รูปแบบที่จะตั้งค่าในแถว

fields

string (FieldMask format)

ช่องที่ควรอัปเดต

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

เช่น หากต้องการอัปเดตความสูงขั้นต่ำของแถว ให้ตั้งค่า fields เป็น "minRowHeight"

ReplaceImageRequest

แทนที่รูปภาพเดิมด้วยรูปภาพใหม่

การแทนที่รูปภาพจะนำimage effectsออกจากรูปภาพที่มีอยู่บางส่วนเพื่อให้สอดคล้องกับลักษณะการทำงานของเครื่องมือแก้ไขเอกสาร

การแสดง JSON 
{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "tabId": string
}
ช่อง
imageObjectId

string

รหัสของรูปภาพที่มีอยู่ซึ่งจะถูกแทนที่ คุณสามารถดึงรหัสได้จากคำตอบของคำขอ GET

uri

string

URI ของรูปภาพใหม่

ระบบจะดึงข้อมูลรูปภาพเพียงครั้งเดียว ณ เวลาแทรก และจัดเก็บสำเนาไว้เพื่อแสดงในเอกสาร รูปภาพต้องมีขนาดไม่เกิน 50 MB, ไม่เกิน 25 เมกะพิกเซล และต้องอยู่ในรูปแบบ PNG, JPEG หรือ GIF

URI ที่ระบุมีความยาวได้ไม่เกิน 2 KB ระบบจะบันทึก URI ไว้กับรูปภาพและแสดงผ่านช่อง ImageProperties.source_uri

imageReplaceMethod

enum (ImageReplaceMethod)

วิธีการเปลี่ยนทดแทน

tabId

string

แท็บที่มีรูปภาพที่จะแทนที่ หากไม่ระบุ ระบบจะใช้คำขอกับแท็บแรก

ในเอกสารที่มีแท็บเดียว ให้ทำดังนี้

  • หากระบุ ต้องตรงกับรหัสของแท็บเดียว

  • หากไม่ระบุ คำขอจะมีผลกับแท็บเดียว

ในเอกสารที่มีหลายแท็บ ให้ทำดังนี้

  • หากระบุไว้ คำขอจะมีผลกับแท็บที่ระบุ

  • หากไม่ระบุ ค่าเริ่มต้นคือคำขอจะมีผลกับแท็บแรกในเอกสาร

ImageReplaceMethod

วิธีการแทนที่รูปภาพ

Enum
IMAGE_REPLACE_METHOD_UNSPECIFIED ไม่ได้ระบุวิธีการแทนที่รูปภาพ ห้ามใช้ค่านี้
CENTER_CROP ปรับขนาดและจัดกึ่งกลางรูปภาพให้เต็มขอบเขตของรูปภาพต้นฉบับ ระบบอาจครอบตัดรูปภาพเพื่อให้พอดีกับขอบเขตของรูปภาพต้นฉบับ ขนาดที่แสดงผลของรูปภาพจะเหมือนกับรูปภาพต้นฉบับ

UpdateDocumentStyleRequest

อัปเดต DocumentStyle

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

object (DocumentStyle)

รูปแบบที่จะตั้งค่าในเอกสาร

การเปลี่ยนแปลงรูปแบบเอกสารบางอย่างอาจทำให้เกิดการเปลี่ยนแปลงอื่นๆ เพื่อสะท้อนลักษณะการทำงานของเครื่องมือแก้ไขเอกสาร ดูข้อมูลเพิ่มเติมในเอกสารประกอบของ DocumentStyle

fields

string (FieldMask format)

ช่องที่ควรอัปเดต

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

เช่น หากต้องการอัปเดตพื้นหลัง ให้ตั้งค่า fields เป็น "background"

tabId

string

แท็บที่มีสไตล์ที่จะอัปเดต หากไม่ระบุ ค่านี้จะมีผลกับแท็บแรก

ในเอกสารที่มีแท็บเดียว ให้ทำดังนี้

  • หากระบุ ต้องตรงกับรหัสของแท็บเดียว

  • หากไม่ระบุ คำขอจะมีผลกับแท็บเดียว

ในเอกสารที่มีหลายแท็บ ให้ทำดังนี้

  • หากระบุไว้ คำขอจะมีผลกับแท็บที่ระบุ

  • หากไม่ได้ระบุ ข้อความขอจะมีผลกับแท็บแรกในเอกสาร

MergeTableCellsRequest

ผสานเซลล์ใน Table

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

object (TableRange)

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

ระบบจะต่อข้อความในเซลล์ที่ผสานและจัดเก็บไว้ในเซลล์ "head" ของช่วง เซลล์นี้คือเซลล์ซ้ายบนของช่วงเมื่อทิศทางของเนื้อหาเป็นแบบซ้ายไปขวา และจะเป็นเซลล์ขวาบนของช่วงหากเป็นอย่างอื่น

หากช่วงไม่ใช่สี่เหลี่ยมผืนผ้า (ซึ่งอาจเกิดขึ้นในบางกรณีที่ช่วงครอบคลุมเซลล์ที่ผสานไว้แล้วหรือตารางไม่ใช่สี่เหลี่ยมผืนผ้า) ระบบจะแสดงข้อผิดพลาด 400 Bad Request

UnmergeTableCellsRequest

ยกเลิกการผสานเซลล์ใน Table

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

object (TableRange)

ช่วงตารางที่ระบุเซลล์ของตารางที่จะยกเลิกการผสาน

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

หากมีข้อความในเซลล์ที่ผสาน ข้อความจะยังคงอยู่ในเซลล์ "ส่วนหัว" ของบล็อกเซลล์ที่ไม่ได้ผสาน เซลล์ "head" คือเซลล์ซ้ายบนเมื่อทิศทางของเนื้อหาเป็นแบบซ้ายไปขวา และเซลล์ขวาบนเมื่อทิศทางของเนื้อหาเป็นแบบขวาไปซ้าย

CreateHeaderRequest

สร้าง Header ระบบจะใช้ส่วนหัวใหม่กับ SectionStyle ที่ตำแหน่ง SectionBreak หากระบุไว้ ไม่เช่นนั้นระบบจะใช้กับ DocumentStyle

หากมีส่วนหัวประเภทที่ระบุอยู่แล้ว ระบบจะแสดงข้อผิดพลาด 400 Bad Request

การแสดง JSON 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
ช่อง
type

enum (HeaderFooterType)

ประเภทส่วนหัวที่จะสร้าง

sectionBreakLocation

object (Location)

ตำแหน่งของ SectionBreak ซึ่งเริ่มต้นส่วนส่วนหัวนี้ควรอยู่ หากไม่ได้ตั้งค่า "sectionBreakLocation" หรือหาก "sectionBreakLocation" อ้างอิงถึงส่วนแบ่งส่วนแรกในเนื้อหาเอกสาร ส่วนหัวจะมีผลกับ DocumentStyle

HeaderFooterType

ประเภทส่วนหัวและส่วนท้ายที่สร้างได้

Enum
DEFAULT ส่วนหัว/ส่วนท้ายเริ่มต้น

CreateFooterRequest

สร้าง Footer ระบบจะนำส่วนท้ายใหม่ไปใช้กับ SectionStyle ที่ตำแหน่งของ SectionBreak หากระบุไว้ ไม่เช่นนั้นระบบจะนำไปใช้กับ DocumentStyle

หากมีส่วนท้ายประเภทที่ระบุอยู่แล้ว ระบบจะแสดงข้อผิดพลาด 400 Bad Request

การแสดง JSON 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
ช่อง
type

enum (HeaderFooterType)

ประเภทของส่วนท้ายที่จะสร้าง

sectionBreakLocation

object (Location)

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

CreateFootnoteRequest

สร้างกลุ่ม Footnote และแทรก FootnoteReference ใหม่ลงในตำแหน่งที่ระบุ

กลุ่ม Footnote ใหม่จะมีเว้นวรรคตามด้วยอักขระขึ้นบรรทัดใหม่

การแสดง JSON 
{

  // Union field footnote_reference_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field footnote_reference_location.
}
ช่อง
ฟิลด์สหภาพ footnote_reference_location ตำแหน่งที่จะแทรกการอ้างอิงเชิงอรรถ footnote_reference_location ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
location

object (Location)

แทรกการอ้างอิงเชิงอรรถที่ดัชนีที่ต้องการในเอกสาร

ต้องแทรกการอ้างอิงเชิงอรรถภายในขอบเขตของ Paragraph ที่มีอยู่ เช่น แทรกที่ดัชนีเริ่มต้นของตารางไม่ได้ (เช่น ระหว่างตารางกับย่อหน้าก่อนหน้า)

คุณจะแทรกการอ้างอิงเชิงอรรถภายในสมการ ส่วนหัว ส่วนท้าย หรือเชิงอรรถไม่ได้ เนื่องจากสามารถแทรกการอ้างอิงเชิงอรรถในเนื้อหาได้เท่านั้น ช่อง segment ID จึงต้องว่างเปล่า

endOfSegmentLocation

object (EndOfSegmentLocation)

แทรกการอ้างอิงเชิงอรรถที่ท้ายเนื้อหาเอกสาร

คุณจะแทรกการอ้างอิงเชิงอรรถไว้ภายในส่วนหัว ส่วนท้าย หรือเชิงอรรถไม่ได้ เนื่องจากสามารถแทรกการอ้างอิงเชิงอรรถในเนื้อหาได้เท่านั้น ช่อง segment ID จึงต้องว่างเปล่า

ReplaceNamedRangeContentRequest

แทนที่เนื้อหาของ NamedRange ที่ระบุ หรือ NamedRanges ด้วยเนื้อหาที่ให้มา

โปรดทราบว่าบุคคลหนึ่ง NamedRange อาจประกอบด้วย ranges หลายรายการที่ตัดต่อกัน ในกรณีนี้ ระบบจะแทนที่เฉพาะเนื้อหาในช่วงแรก ระบบจะลบช่วงอื่นๆ และเนื้อหาของช่วงเหล่านั้น

ในกรณีที่การแทนที่หรือลบช่วงใดก็ตามจะทำให้โครงสร้างเอกสารไม่ถูกต้อง ระบบจะแสดงข้อผิดพลาด 400 Bad Request

การแสดง JSON 
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field replacement_content can be only one of the following:
  "text": string
  // End of list of possible types for union field replacement_content.

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "namedRangeName": string
  // End of list of possible types for union field named_range_reference.
}
ช่อง
tabsCriteria

object (TabsCriteria)

ไม่บังคับ เกณฑ์ที่ใช้ระบุแท็บที่จะแทนที่ หากไม่ระบุ การเปลี่ยนทดแทนจะมีผลกับทุกแท็บ

ในเอกสารที่มีแท็บเดียว ให้ทำดังนี้

  • หากระบุ ต้องตรงกับรหัสของแท็บเดียว

  • หากไม่ระบุ การเปลี่ยนทดแทนจะมีผลกับแท็บเดี่ยว

ในเอกสารที่มีหลายแท็บ ให้ทำดังนี้

  • หากระบุไว้ การเปลี่ยนทดแทนจะมีผลกับแท็บที่ระบุ

  • หากไม่ระบุ การเปลี่ยนทดแทนจะมีผลกับทุกแท็บ

ฟิลด์สหภาพ replacement_content เนื้อหาที่จะแทนที่เนื้อหาที่มีอยู่ของช่วงที่มีชื่อ replacement_content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
text

string

แทนที่เนื้อหาของช่วงที่มีชื่อที่ระบุด้วยข้อความที่ระบุ

ฟิลด์สหภาพ named_range_reference การอ้างอิงถึงช่วงที่มีชื่อซึ่งเนื้อหาจะถูกแทนที่ named_range_reference ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
namedRangeId

string

รหัสของช่วงที่มีชื่อซึ่งเนื้อหาจะถูกแทนที่

หากไม่มีช่วงที่มีชื่อซึ่งมีรหัสที่ระบุ ระบบจะแสดงข้อผิดพลาด 400 Bad Request

namedRangeName

string

ชื่อของผู้ใช้ NamedRanges ที่จะแทนที่เนื้อหา

หากมีไฟล์ named ranges หลายรายการที่มีชื่อเดียวกัน ระบบจะแทนที่เนื้อหาของไฟล์แต่ละรายการ หากไม่มีช่วงที่มีชื่อซึ่งมีชื่อที่ระบุไว้ คำขอจะดำเนินการไม่ได้

UpdateSectionStyleRequest

อัปเดต SectionStyle

การแสดง JSON 
{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}
ช่อง
range

object (Range)

ช่วงที่จะจัดรูปแบบซึ่งซ้อนทับกับส่วน

เนื่องจากสามารถแทรกการแบ่งส่วนได้ภายในเนื้อหาเท่านั้น ช่อง segment ID จึงต้องว่างเปล่า

sectionStyle

object (SectionStyle)

สไตล์ที่จะตั้งค่าในส่วน

การเปลี่ยนแปลงรูปแบบของส่วนบางอย่างอาจทำให้เกิดการเปลี่ยนแปลงอื่นๆ เพื่อจำลองลักษณะการทำงานของเครื่องมือแก้ไขเอกสาร ดูข้อมูลเพิ่มเติมในเอกสารประกอบของ SectionStyle

fields

string (FieldMask format)

ช่องที่ควรอัปเดต

ต้องระบุฟิลด์อย่างน้อย 1 ช่อง ระบบจะนําราก sectionStyle มาใช้โดยปริยายและไม่ต้องระบุ "*" 1 ตัวสามารถใช้เป็นอักษรย่อสำหรับแสดงรายการช่องทั้งหมด

เช่น หากต้องการอัปเดตระยะขอบด้านซ้าย ให้ตั้งค่า fields เป็น "marginLeft"

InsertSectionBreakRequest

แทรกตัวแบ่งส่วนในตำแหน่งที่ระบุ

ระบบจะแทรกอักขระบรรทัดใหม่ก่อนตัวแบ่งส่วน

การแสดง JSON 
{
  "sectionType": enum (SectionType),

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
ช่อง
sectionType

enum (SectionType)

ประเภทของส่วนที่จะแทรก

ฟิลด์สหภาพ insertion_location ตำแหน่งที่จะแทรกช่วงพัก insertion_location ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
location

object (Location)

แทรกบรรทัดใหม่และส่วนแบ่งที่ดัชนีที่เฉพาะเจาะจงในเอกสาร

ต้องแทรกส่วนแบ่งภายในขอบเขตของ Paragraph ที่มีอยู่ เช่น แทรกที่ดัชนีเริ่มต้นของตารางไม่ได้ (เช่น ระหว่างตารางกับย่อหน้าก่อนหน้า)

ไม่สามารถแทรกการแบ่งส่วนภายในตาราง สมการ เชิงอรรถ ส่วนหัว หรือท้ายกระดาษ เนื่องจากสามารถแทรกการแบ่งส่วนได้ภายในเนื้อหาเท่านั้น ช่อง segment ID จึงต้องว่างเปล่า

endOfSegmentLocation

object (EndOfSegmentLocation)

แทรกบรรทัดใหม่และส่วนแบ่งที่ท้ายเนื้อหาเอกสาร

คุณจะแทรกการแบ่งส่วนภายในเชิงอรรถ ส่วนหัว หรือท้ายกระดาษไม่ได้ เนื่องจากสามารถแทรกการแบ่งส่วนได้ภายในเนื้อหาเท่านั้น ช่อง segment ID จึงต้องว่างเปล่า

DeleteHeaderRequest

ลบ Header จากเอกสาร

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

string

รหัสของส่วนหัวที่จะลบ หากมีการกําหนดส่วนหัวนี้ใน DocumentStyle ระบบจะนำการอ้างอิงส่วนหัวนี้ออก ส่งผลให้ไม่มีส่วนหัวประเภทนั้นในส่วนแรกของเอกสาร หากมีการกําหนดส่วนหัวนี้ใน SectionStyle ระบบจะนำการอ้างอิงส่วนหัวนี้ออกและส่วนหัวประเภทนั้นจะต่อจากส่วนก่อนหน้า

tabId

string

แท็บที่มีส่วนหัวที่จะลบ หากไม่ระบุ ระบบจะใช้คำขอกับแท็บแรก

ในเอกสารที่มีแท็บเดียว ให้ทำดังนี้

  • หากระบุ ต้องตรงกับรหัสของแท็บเดียว

  • หากไม่ระบุ คำขอจะมีผลกับแท็บเดียว

ในเอกสารที่มีหลายแท็บ ให้ทำดังนี้

  • หากระบุไว้ คำขอจะมีผลกับแท็บที่ระบุ

  • หากไม่ระบุ ค่าเริ่มต้นคือคำขอจะมีผลกับแท็บแรกในเอกสาร

DeleteFooterRequest

ลบ Footer จากเอกสาร

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

string

รหัสของส่วนท้ายที่จะลบ หากมีการกําหนดส่วนท้ายนี้ใน DocumentStyle ระบบจะนำการอ้างอิงส่วนท้ายนี้ออก ส่งผลให้ส่วนท้ายประเภทนั้นไม่มีในส่วนแรกของเอกสาร หากมีการกําหนดส่วนท้ายนี้ใน SectionStyle ระบบจะนำการอ้างอิงส่วนท้ายนี้ออกและส่วนท้ายประเภทนั้นจะแสดงต่อจากส่วนก่อนหน้า

tabId

string

แท็บที่มีส่วนท้ายที่ต้องการลบ หากไม่ระบุ ระบบจะใช้คำขอกับแท็บแรก

ในเอกสารที่มีแท็บเดียว ให้ทำดังนี้

  • หากระบุ ต้องตรงกับรหัสของแท็บเดียว

  • หากไม่ระบุ คำขอจะมีผลกับแท็บเดียว

ในเอกสารที่มีหลายแท็บ ให้ทำดังนี้

  • หากระบุไว้ คำขอจะมีผลกับแท็บที่ระบุ

  • หากไม่ระบุ ค่าเริ่มต้นคือคำขอจะมีผลกับแท็บแรกในเอกสาร

PinTableHeaderRowsRequest

อัปเดตจำนวนแถวส่วนหัวของตารางที่ปักหมุดไว้ในตาราง

การแสดง JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}
ช่อง
tableStartLocation

object (Location)

ตำแหน่งที่ตารางเริ่มต้นในเอกสาร

pinnedHeaderRowsCount

integer

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