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)
  },
  "insertPerson": {
    object (InsertPersonRequest)
  }
  // End of list of possible types for union field request.
}
ช่อง
ฟิลด์ Union 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)

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

insertPerson

object (InsertPersonRequest)

แท็กบุคคล

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,
  "searchByRegex": boolean
}
ช่อง
text

string

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

matchCase

boolean

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

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

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 (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"

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

ฟิลด์ Union 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 : สี่เหลี่ยมจัตุรัสกลวง ซึ่งสอดคล้องกับจุดโค้ด Unicode U+274f
  • CIRCLE : วงกลมกลวง ซึ่งสอดคล้องกับจุดโค้ด 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 : สี่เหลี่ยมทึบที่สอดคล้องกับจุดโค้ด 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" ระบบจะไม่เติม 0 หน้าตัวเลขที่มีมากกว่า 1 หลัก
  • 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 ค่าที่กำหนดช่วงที่จะลบ ต้องตั้งค่าอย่างใดอย่างหนึ่งเท่านั้น 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"

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

ฟิลด์ Union 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 ของรูปภาพ

ระบบจะดึงข้อมูลรูปภาพ 1 ครั้งในเวลาที่แทรก และจะจัดเก็บสำเนาไว้เพื่อแสดงภายในเอกสาร รูปภาพต้องมีขนาดไม่เกิน 50 MB มีความละเอียดไม่เกิน 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)

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

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

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

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

ฟิลด์ Union 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

ดัชนีคอลัมน์แบบ Zero-based เช่น คอลัมน์ที่ 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.
}
ช่อง
ฟิลด์ Union 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"

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

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

object (TableRange)

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

tableStartLocation

object (Location)

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

TableRange

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

โปรดทราบว่าเซลล์ที่ระบุโดยช่วงตารางไม่จำเป็นต้องเป็นรูปสี่เหลี่ยมผืนผ้า เช่น สมมติว่าเรามีตารางขนาด 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

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

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 ของรูปภาพใหม่

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

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

tabId

string

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

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

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

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

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

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

  • หากไม่ได้ระบุ ระบบจะใช้คำขอในแท็บแรกของเอกสาร

MergeTableCellsRequest

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

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

object (TableRange)

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

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

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

UnmergeTableCellsRequest

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

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

object (TableRange)

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

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

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

CreateHeaderRequest

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

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

การแสดง 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 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.
}
ช่อง
ฟิลด์ Union 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)

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

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

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

  • หากไม่ระบุ การแทนที่จะมีผลกับแท็บเอกพจน์

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

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

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

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

string

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

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

เช่น หากต้องการอัปเดตระยะขอบด้านซ้าย ให้ตั้งค่า 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)

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

ฟิลด์ Union 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 หมายความว่าไม่ได้ปักหมุดแถวใดเลย

InsertPersonRequest

แท็กบุคคล

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

  // 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.
}
ช่อง
personProperties

object (PersonProperties)

พร็อพเพอร์ตี้ของการพูดถึงบุคคลที่จะแทรก

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

object (Location)

แท็กบุคคลที่พูดถึงในดัชนีที่เฉพาะเจาะจงในเอกสาร

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

ไม่สามารถแท็กบุคคลภายในสมการ

endOfSegmentLocation

object (EndOfSegmentLocation)

แทรกการกล่าวถึงบุคคลที่ท้ายส่วนหัว ท้ายกระดาษ เชิงอรรถ หรือเนื้อหาของเอกสาร