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.
}
ช่อง
ช่อง Union request คําขอเฉพาะที่ใช้ ต้องป้อนเพียง 1 ช่องเท่านั้น 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)

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

คําขอแทนที่ข้อความทั้งหมด

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

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

  // 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

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

ช่อง Union criteria เกณฑ์ที่ใช้ในการจับคู่ข้อความเพื่อแทนที่ criteria ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
containsText

object (SubstringMatchCriteria)

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

สตริงย่อยของเกณฑ์

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

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

string

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

matchCase

boolean

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

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

ใส่ข้อความคําขอ

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

การแสดง 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 (U+E000-U+F8FF) จะถูกตัดออกจากข้อความที่แทรก

ช่อง Union insertion_location ตําแหน่งที่จะแทรกข้อความ insertion_location ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
location

object (Location)

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

ตำแหน่ง

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

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

string

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

index

integer

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

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

ตําแหน่งสิ้นสุดของกลุ่ม

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

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

string

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

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

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

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

หากต้องการรีเซ็ตพร็อพเพอร์ตี้เป็นค่าเริ่มต้น ให้ใส่ชื่อของช่องนั้นไว้ในมาสก์ของช่องโดยไม่ต้องตั้งค่าใดๆ

ช่อง Union insertion_location ประเภทของช่วงที่ใช้อัปเดตรูปแบบข้อความ insertion_location ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
range

object (Range)

ช่วงของข้อความเพื่อจัดรูปแบบ

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

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

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

CreateParagraphBulletsRequest

สร้างหัวข้อย่อยของทุกย่อหน้าที่ซ้อนทับกับช่วงที่ระบุ

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

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

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

object (Range)

ช่วงที่จะใช้ค่าที่กําหนดล่วงหน้าของหัวข้อย่อย

bulletPreset

enum (BulletGlyphPreset)

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

ค่าที่กําหนดล่วงหน้าของ BulletGlyph

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

รูปแบบเหล่านี้ใช้หัวข้อย่อยต่อไปนี้

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

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

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

ระดับที่ซ้อนกันของแต่ละย่อหน้าจะถูกเก็บรักษาไว้ด้วยการเพิ่มการเยื้องที่จุดเริ่มต้นของย่อหน้านั้นๆ

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

object (Range)

ช่วงที่จะลบสัญลักษณ์หัวข้อย่อย

สร้างช่วงชื่อคําขอ

สร้าง NamedRange ที่อ้างอิงช่วงที่ระบุ

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

string

ชื่อของ NamedRange โดยชื่อไม่จําเป็นต้องซ้ํากัน

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

range

object (Range)

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

ลบช่วงชื่อ

ลบ NamedRange

การแสดง JSON
{

  // 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.
}
ช่อง
ช่อง Union named_range_reference ค่าที่จะเป็นตัวกําหนดช่วงหรือลบ ต้องตั้งค่าอย่างใดอย่างหนึ่งเท่านั้น named_range_reference ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
namedRangeId

string

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

name

string

ชื่อของช่วงที่จะลบ ช่วงที่มีชื่อทั้งหมดที่มีชื่อตามที่กําหนดจะถูกลบออก

อัปเดตลักษณะของย่อหน้า

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

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

หากต้องการรีเซ็ตพร็อพเพอร์ตี้เป็นค่าเริ่มต้น ให้ใส่ชื่อของช่องนั้นไว้ในมาสก์ของช่องโดยไม่ต้องตั้งค่าใดๆ

ช่อง Union insertion_location ประเภทของช่วงที่ใช้อัปเดตรูปแบบย่อหน้า insertion_location ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
range

object (Range)

ช่วงจะซ้อนทับกันของย่อหน้า

ลบเนื้อหาของช่วงเนื้อหา

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

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

object (Range)

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

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

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

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

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

แทรกรูปภาพในบรรทัด

แทรก 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 รูปภาพ

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

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

objectSize

object (Size)

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

ช่อง Union insertion_location ตําแหน่งที่จะแทรกรูปภาพ insertion_location ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
location

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

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

แทรกตาราง

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

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

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

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

ช่อง Union insertion_location ตําแหน่งที่จะแทรกตาราง insertion_location ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
location

object (Location)

แทรกตารางที่ดัชนีโมเดลที่ระบุ

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

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

แทรกแถวในตารางคําขอ

แทรกแถวที่ว่างเปล่าลงในตาราง

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

object (TableCellLocation)

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

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

insertBelow

boolean

แทรกแถวใหม่ใต้ตําแหน่งของเซลล์อ้างอิงหรือไม่

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

ตําแหน่งเซลล์ตาราง

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

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

object (Location)

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

rowIndex

integer

ดัชนีแถวที่เป็นศูนย์ ตัวอย่างเช่น แถวที่สองในตารางมีดัชนีแถวเป็น 1

columnIndex

integer

ดัชนีคอลัมน์ฐาน 0 ตัวอย่างเช่น คอลัมน์ที่สองในตารางมีดัชนีคอลัมน์เป็น 1

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

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

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

object (TableCellLocation)

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

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

insertRight

boolean

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

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

ลบตารางคําขอ

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

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

object (TableCellLocation)

ตําแหน่งของเซลล์ตารางอ้างอิงซึ่งแถวจะถูกลบ

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

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

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

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

object (TableCellLocation)

ตําแหน่งของเซลล์ตารางอ้างอิงซึ่งคอลัมน์จะถูกลบ

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

แทรกตัวแบ่งหน้า

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

การแสดง 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.
}
ช่อง
ช่อง Union insertion_location ตําแหน่งที่จะแทรกตัวแบ่งหน้า insertion_location ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
location

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

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

ลบคําขอตําแหน่ง

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

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

string

รหัสของรายการที่วางตําแหน่งที่จะลบ

อัปเดตคุณสมบัติของคอลัมน์ในตาราง

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

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

object (Location)

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

columnIndices[]

integer

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

tableColumnProperties

object (TableColumnProperties)

คุณสมบัติของคอลัมน์ในตารางที่จะอัปเดต

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

fields

string (FieldMask format)

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

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

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

UpdateRequestCellStyleRequest

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

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

หากต้องการรีเซ็ตพร็อพเพอร์ตี้เป็นค่าเริ่มต้น ให้ใส่ชื่อของช่องนั้นไว้ในมาสก์ของช่องโดยไม่ต้องตั้งค่าใดๆ

ช่อง Union cells เซลล์ที่จะอัปเดต cells ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
tableRange

object (TableRange)

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

tableStartLocation

object (Location)

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

ช่วงตาราง

ช่วงตารางจะหมายถึงการอ้างอิงชุดย่อยของตาราง

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

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

ช่วงตารางที่มีตําแหน่งเซลล์ตาราง = (tableStartLocation, แถว = 0, คอลัมน์ = 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

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

อัปเดตคําขอแถวของตาราง

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

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

object (Location)

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

rowIndices[]

integer

รายการดัชนีแถวตามศูนย์ที่ควรมีการอัปเดตรูปแบบ หากไม่มีการระบุดัชนี แถวทั้งหมดจะได้รับการอัปเดต

tableRowStyle

object (TableRowStyle)

รูปแบบที่จะกําหนดในแถว

fields

string (FieldMask format)

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

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

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

แทนที่คําขอรูปภาพ

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

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

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

string

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

uri

string

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

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

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

imageReplaceMethod

enum (ImageReplaceMethod)

วิธีการแทนที่

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

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

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

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

อัปเดต DocumentStyle

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

object (DocumentStyle)

รูปแบบที่จะกําหนดในเอกสาร

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

fields

string (FieldMask format)

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

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

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

คําขอผสานตารางเซลล์

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

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

object (TableRange)

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

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

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

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

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

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

object (TableRange)

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

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

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

สร้างส่วนหัวของคําขอ

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

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

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

enum (HeaderFooterType)

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

sectionBreakLocation

object (Location)

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

ประเภทส่วนหัวอาหาร

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

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

สร้างคําขอส่วนท้าย

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

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

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

enum (HeaderFooterType)

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

sectionBreakLocation

object (Location)

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

สร้างคําขอเชิงอรรถ

สร้างกลุ่ม 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.
}
ช่อง
ช่อง Union footnote_reference_location ตําแหน่งที่จะแทรกการอ้างอิงเชิงอรรถ footnote_reference_location ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
location

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

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

แทนที่ช่วงเนื้อหาที่ส่งคําขอ

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

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

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

การแสดง JSON
{

  // 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.
}
ช่อง
ช่อง Union replacement_content เนื้อหาที่จะแทนที่เนื้อหาที่มีอยู่ของช่วงที่ตั้งชื่อด้วย replacement_content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
text

string

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

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

string

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

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

namedRangeName

string

ชื่อของ NamedRanges ที่จะมีการแทนที่เนื้อหา

หากมี named ranges หลายรายการที่ใช้ชื่อที่ระบุ ระบบจะแทนที่เนื้อหาของแต่ละรายการ หากไม่มีช่วงที่มีชื่อที่มีชื่อดังกล่าว คําขอจะเป็นไม่มีการดําเนินการ

อัปเดตส่วนรูปแบบส่วน

อัปเดต 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"

แทรกตัวแบ่งส่วน

แทรกตัวแบ่งส่วนในตําแหน่งที่กําหนด

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

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

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

ช่อง Union insertion_location ตําแหน่งที่จะแทรกตัวแบ่ง insertion_location ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
location

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

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

ลบส่วนหัวของคําขอ

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

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

string

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

ลบคําขออาหาร

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

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

string

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

PinTableHeaderRowsRequest

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

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

object (Location)

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

pinnedHeaderRowsCount

integer

จํานวนแถวในตารางที่จะตรึง โดย 0 บ่งบอกว่าไม่ได้ตรึงแถวทั้งหมด