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)

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

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

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

  • หากมี ต้องตรงกับรหัสของแท็บเอกพจน์

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

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

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

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

ฟิลด์ Union 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) ออกจากข้อความที่แทรก

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

เช่น หากต้องการอัปเดตรูปแบบข้อความเป็นแบบตัวหนา ให้ตั้งค่า 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 : ลูกศรที่สอดคล้องกับจุดรหัส Unicode U+2794
  • ARROW3D : ลูกศรที่มีแรเงา 3 มิติ ซึ่งสอดคล้องกับ Code Point ของ Unicode U+27a2
  • CHECKBOX : สี่เหลี่ยมจัตุรัสแบบโปร่ง ซึ่งตรงกับจุดรหัส Unicode U+274f
  • CIRCLE : วงกลมกลวงซึ่งสอดคล้องกับ Code Point Unicode U+25cb
  • DIAMOND : เพชรเต็มรูปแบบ ซึ่งสอดคล้องกับ Code Point Unicode U+25c6
  • DIAMONDX : เพชรที่มี "x" ซึ่งตรงกับจุดรหัส Unicode U+2756
  • HOLLOWDIAMOND : ข้าวหลามตัดแบบโปร่ง ซึ่งสอดคล้องกับ Code Point ของ Unicode U+25c7
  • DISC : วงกลมทึบ ซึ่งตรงกับจุดโค้ด Unicode U+25cf
  • SQUARE : สี่เหลี่ยมจัตุรัสทึบ ซึ่งตรงกับจุดโค้ด Unicode U+25a0
  • STAR : ดาว ซึ่งสอดคล้องกับ Code Point Unicode U+2605
  • ALPHA : ตัวอักษรพิมพ์เล็ก เช่น "a", "b" หรือ "c"
  • UPPERALPHA : ตัวอักษรพิมพ์ใหญ่ เช่น "A" "B" หรือ "C"
  • DECIMAL : ตัวเลข เช่น "1", "2" หรือ "3"
  • ZERODECIMAL : ตัวเลขที่มี 0 นำหน้า เช่น "01", "02" หรือ "03" ตัวเลขที่มีมากกว่า 1 หลักจะไม่ขึ้นต้นด้วย 0
  • ROMAN : ตัวเลขโรมันตัวพิมพ์เล็ก เช่น "i", "ii" หรือ "iii"
  • UPPERROMAN : ตัวเลขโรมันตัวพิมพ์ใหญ่ เช่น "I", "II" หรือ "III"
  • LEFTTRIANGLE : สามเหลี่ยมชี้ไปทางซ้าย สอดคล้องกับจุดโค้ด 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)

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

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

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

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

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

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

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

ฟิลด์ Union named_range_reference ค่าที่กำหนดช่วงหรือช่วงที่จะลบ ต้องตั้งค่าเพียง 1 รายการ 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)

รูปแบบที่จะกำหนดในย่อหน้า

การเปลี่ยนแปลงรูปแบบย่อหน้าบางอย่างอาจทำให้เกิดการเปลี่ยนแปลงอื่นๆ เพื่อจำลองการทำงานของเครื่องมือแก้ไขเอกสาร ดูเอกสารของ 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

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

  • การลบหน่วยโค้ด 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

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

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

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

ตัวอย่างเช่น หากต้องการอัปเดตความสูงขั้นต่ำของแถว ให้ตั้งค่า 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 คำขอที่ไม่ถูกต้อง

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

enum (HeaderFooterType)

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

sectionBreakLocation

object (Location)

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

HeaderFooterType

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

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

CreateFooterRequest

สร้าง Footer ส่วนท้ายใหม่จะใช้กับส่วน SectionStyle ณ สถานที่ตั้งของ SectionBreak หากระบุไว้ มิฉะนั้นจะใช้กับ DocumentStyle

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

การแสดง 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 คำขอที่ไม่ถูกต้อง

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

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

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

  • หากมี ต้องตรงกับรหัสของแท็บเอกพจน์

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

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

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

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

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

string

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

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

string

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

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

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

เช่น หากต้องการอัปเดตระยะขอบด้านซ้าย ให้ตั้งค่า 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 หมายความว่าระบบจะเลิกปักหมุดแถวทั้งหมด