Requests

Yêu cầu

Một lần cập nhật để áp dụng cho một tài liệu.

Biểu diễn dưới dạng 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.
}
Trường
Trường hợp hợp nhất request. Yêu cầu cụ thể để áp dụng. Bạn phải liên kết đúng một trường. request chỉ có thể là một trong những giá trị sau:
replaceAllText

object (ReplaceAllTextRequest)

Thay thế tất cả các bản sao của văn bản đã chỉ định.

insertText

object (InsertTextRequest)

Chèn văn bản tại vị trí đã chỉ định.

updateTextStyle

object (UpdateTextStyleRequest)

Cập nhật kiểu văn bản tại phạm vi đã chỉ định.

createParagraphBullets

object (CreateParagraphBulletsRequest)

Tạo dấu đầu dòng cho các đoạn văn bản.

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

Xoá dấu đầu dòng khỏi các đoạn văn bản.

createNamedRange

object (CreateNamedRangeRequest)

Tạo một dải ô được đặt tên.

deleteNamedRange

object (DeleteNamedRangeRequest)

Xoá một dải ô được đặt tên.

updateParagraphStyle

object (UpdateParagraphStyleRequest)

Cập nhật kiểu đoạn ở dải ô được chỉ định.

deleteContentRange

object (DeleteContentRangeRequest)

Xoá nội dung khỏi tài liệu.

insertInlineImage

object (InsertInlineImageRequest)

Chèn hình ảnh cùng dòng tại vị trí đã chỉ định.

insertTable

object (InsertTableRequest)

Chèn bảng tại vị trí đã chỉ định.

insertTableRow

object (InsertTableRowRequest)

Chèn một hàng trống vào bảng.

insertTableColumn

object (InsertTableColumnRequest)

Chèn một cột trống vào bảng.

deleteTableRow

object (DeleteTableRowRequest)

Xoá một hàng khỏi bảng.

deleteTableColumn

object (DeleteTableColumnRequest)

Xoá một cột khỏi bảng.

insertPageBreak

object (InsertPageBreakRequest)

Chèn một dấu ngắt trang tại vị trí được chỉ định.

deletePositionedObject

object (DeletePositionedObjectRequest)

Xoá đối tượng đã định vị khỏi tài liệu.

updateTableColumnProperties

object (UpdateTableColumnPropertiesRequest)

Cập nhật các thuộc tính của cột trong bảng.

updateTableCellStyle

object (UpdateTableCellStyleRequest)

Cập nhật kiểu của các ô trong bảng.

updateTableRowStyle

object (UpdateTableRowStyleRequest)

Cập nhật kiểu hàng trong bảng.

replaceImage

object (ReplaceImageRequest)

Thay thế hình ảnh trong tài liệu.

updateDocumentStyle

object (UpdateDocumentStyleRequest)

Cập nhật kiểu của tài liệu.

mergeTableCells

object (MergeTableCellsRequest)

Hợp nhất các ô trong bảng.

unmergeTableCells

object (UnmergeTableCellsRequest)

Huỷ hợp nhất các ô trong bảng.

createHeader

object (CreateHeaderRequest)

Tạo tiêu đề.

createFootnote

object (CreateFootnoteRequest)

Tạo chú thích cuối trang.

replaceNamedRangeContent

object (ReplaceNamedRangeContentRequest)

Thay thế nội dung trong một dải ô được đặt tên.

updateSectionStyle

object (UpdateSectionStyleRequest)

Cập nhật kiểu mục của dải ô được chỉ định.

insertSectionBreak

object (InsertSectionBreakRequest)

Chèn dấu ngắt mục tại vị trí đã chỉ định.

deleteHeader

object (DeleteHeaderRequest)

Xoá tiêu đề khỏi tài liệu.

pinTableHeaderRows

object (PinTableHeaderRowsRequest)

Cập nhật số lượng hàng tiêu đề được ghim trong bảng.

ReplaceAllTextRequest

Thay thế tất cả các bản sao của văn bản khớp với một tiêu chí bằng replace text.

Biểu diễn dưới dạng 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.
}
Trường
replaceText

string

Văn bản sẽ thay thế văn bản đã khớp.

tabsCriteria

object (TabsCriteria)

Không bắt buộc. Tiêu chí dùng để chỉ định thẻ nào sẽ thay thế.

Nếu bạn bỏ qua, nội dung thay thế sẽ áp dụng cho tất cả thẻ.

Trong tài liệu chứa một thẻ duy nhất:

  • Nếu được cung cấp, phải khớp với mã của thẻ đơn.

  • Nếu bị bỏ qua, thì thay thế sẽ áp dụng cho thẻ số ít.

Trong một tài liệu chứa nhiều thẻ:

  • Nếu được cung cấp, nội dung thay thế sẽ áp dụng cho các thẻ được chỉ định.

  • Nếu bạn bỏ qua, nội dung thay thế sẽ áp dụng cho tất cả thẻ.

Trường kết hợp criteria. Tiêu chí được sử dụng để khớp văn bản cần thay thế. criteria chỉ có thể là một trong những giá trị sau:
containsText

object (SubstringMatchCriteria)

Tìm văn bản trong tài liệu khớp với chuỗi con này.

SubstringMatchCriteria

Một tiêu chí khớp với một chuỗi văn bản cụ thể trong tài liệu.

Biểu diễn dưới dạng JSON 
{
  "text": string,
  "matchCase": boolean
}
Trường
text

string

Văn bản cần tìm trong tài liệu.

matchCase

boolean

Cho biết liệu nội dung tìm kiếm có tuân theo cách viết hoa/viết thường hay không:

  • True: nội dung tìm kiếm có phân biệt chữ hoa chữ thường.
  • False : nội dung tìm kiếm không phân biệt chữ hoa chữ thường.

TabsCriteria

Tiêu chí chỉ định trong thẻ nào một yêu cầu sẽ thực thi.

Biểu diễn dưới dạng JSON 
{
  "tabIds": [
    string
  ]
}
Trường
tabIds[]

string

Danh sách mã thẻ mà yêu cầu thực thi.

InsertTextRequest

Chèn văn bản tại vị trí đã chỉ định.

Biểu diễn dưới dạng 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.
}
Trường
text

string

Văn bản sẽ được chèn.

Việc chèn ký tự dòng mới sẽ ngầm tạo một Paragraph mới tại chỉ mục đó. Kiểu đoạn văn của đoạn văn mới sẽ được sao chép từ đoạn văn tại chỉ mục chèn hiện tại, bao gồm cả danh sách và dấu đầu dòng.

Kiểu văn bản cho văn bản được chèn sẽ được xác định tự động, thường là giữ nguyên kiểu của văn bản lân cận. Trong hầu hết các trường hợp, kiểu văn bản cho văn bản được chèn sẽ khớp với văn bản ngay trước chỉ mục chèn.

Một số ký tự điều khiển (U+0000-U+0008, U+000C-U+001F) và các ký tự trong Khu vực sử dụng riêng của máy bay đa ngôn ngữ cơ bản Unicode (U+E000-U+F8FF) sẽ bị loại bỏ khỏi văn bản được chèn.

Trường hợp hợp nhất insertion_location. Vị trí chèn văn bản. insertion_location chỉ có thể là một trong những giá trị sau:
location

object (Location)

Chèn văn bản tại một chỉ mục cụ thể trong tài liệu.

Văn bản phải được chèn vào trong ranh giới của một Paragraph hiện có. Ví dụ: không thể chèn văn bản vào chỉ mục bắt đầu của bảng (tức là giữa bảng và đoạn trước đó). Văn bản phải được chèn vào đoạn văn bản trước đó.

endOfSegmentLocation

object (EndOfSegmentLocation)

Chèn văn bản vào cuối đầu trang, chân trang, chú thích cuối trang hoặc nội dung tài liệu.

Vị trí

Một vị trí cụ thể trong tài liệu.

Biểu diễn dưới dạng JSON 
{
  "segmentId": string,
  "index": integer,
  "tabId": string
}
Trường
segmentId

string

Mã của tiêu đề, chân trang hoặc chú thích cuối trang chứa vị trí. Mã phân đoạn trống biểu thị phần nội dung của tài liệu.

index

integer

Chỉ mục bắt đầu từ 0, theo đơn vị mã UTF-16.

Chỉ mục này tương ứng với vị trí bắt đầu của đoạn do segmentId chỉ định.

tabId

string

Thẻ chứa vị trí. Khi bị bỏ qua, yêu cầu sẽ được áp dụng cho thẻ đầu tiên.

Trong tài liệu chỉ chứa một thẻ:

  • Nếu được cung cấp, phải khớp với mã của thẻ đơn.

  • Nếu bạn bỏ qua, yêu cầu này sẽ áp dụng cho thẻ số ít.

Trong một tài liệu chứa nhiều thẻ:

  • Nếu được cung cấp, yêu cầu sẽ áp dụng cho thẻ được chỉ định.

  • Nếu bạn bỏ qua, yêu cầu này sẽ áp dụng cho thẻ đầu tiên trong tài liệu.

EndOfSegmentLocation

Vị trí ở cuối phần nội dung, đầu trang, chân trang hoặc chú thích cuối trang. Vị trí này nằm ngay trước dòng mới cuối cùng trong phân đoạn tài liệu.

Biểu diễn dưới dạng JSON 
{
  "segmentId": string,
  "tabId": string
}
Trường
segmentId

string

Mã nhận dạng của đầu trang, chân trang hoặc chú thích cuối trang của vị trí đó. Mã phân đoạn trống biểu thị phần nội dung của tài liệu.

tabId

string

Thẻ chứa vị trí. Khi bị bỏ qua, yêu cầu sẽ được áp dụng cho thẻ đầu tiên.

Trong tài liệu chỉ chứa một thẻ:

  • Nếu được cung cấp, phải khớp với mã của thẻ đơn.

  • Nếu bạn bỏ qua, yêu cầu này sẽ áp dụng cho thẻ số ít.

Trong một tài liệu chứa nhiều thẻ:

  • Nếu được cung cấp, yêu cầu sẽ áp dụng cho thẻ được chỉ định.

  • Nếu bị bỏ qua, yêu cầu sẽ áp dụng cho thẻ đầu tiên trong tài liệu.

UpdateTextStyleRequest

Cập nhật kiểu văn bản.

Biểu diễn dưới dạng 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.
}
Trường
textStyle

object (TextStyle)

Các kiểu cần đặt trên văn bản.

Nếu giá trị của một kiểu cụ thể khớp với giá trị của kiểu mẹ, thì kiểu đó sẽ được thiết lập để kế thừa.

Một số thay đổi về kiểu văn bản có thể gây ra những thay đổi khác để phản ánh hành vi của Trình chỉnh sửa Tài liệu. Hãy xem tài liệu về TextStyle để biết thêm thông tin.

fields

string (FieldMask format)

Các trường cần cập nhật.

Bạn phải chỉ định ít nhất một trường. textStyle gốc được ngụ ý và không được chỉ định. Bạn có thể dùng một "*" để liệt kê mọi trường.

Ví dụ: để cập nhật kiểu văn bản thành in đậm, hãy đặt fields thành "bold".

Để đặt lại một thuộc tính về giá trị mặc định, hãy thêm tên trường vào mặt nạ trường nhưng để trống trường đó.

Trường hợp hợp nhất insertion_location. Loại dải ô được dùng để cập nhật kiểu văn bản. insertion_location chỉ có thể là một trong những giá trị sau:
range

object (Range)

Phạm vi văn bản cần định kiểu.

Dải ô có thể được mở rộng để bao gồm các dòng mới liền kề.

Nếu dải ô chứa toàn bộ một đoạn văn thuộc một danh sách, thì dấu đầu dòng của đoạn văn đó cũng được cập nhật bằng kiểu văn bản phù hợp.

Không thể chèn dải ô vào bên trong một UpdateTextStyleRequest tương đối.

CreateParagraphBulletsRequest

Tạo dấu đầu dòng cho tất cả các đoạn văn trùng lặp với dải ô đã cho.

Mức độ lồng nhau của mỗi đoạn văn sẽ được xác định bằng cách đếm các thẻ đầu dòng ở phía trước mỗi đoạn văn. Để tránh thừa khoảng trống giữa dấu đầu dòng và đoạn tương ứng, yêu cầu này sẽ xoá các thẻ ở đầu này. Thao tác này có thể thay đổi chỉ mục của các phần văn bản.

Nếu đoạn văn ngay trước các đoạn văn đang được cập nhật nằm trong danh sách có giá trị đặt trước phù hợp, thì các đoạn văn đang được cập nhật sẽ được thêm vào danh sách trước đó.

Biểu diễn dưới dạng JSON 
{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
Trường
range

object (Range)

Dải ô để áp dụng giá trị đặt trước cho dấu đầu dòng.

bulletPreset

enum (BulletGlyphPreset)

Các loại ký tự gạch đầu dòng sẽ được sử dụng.

BulletGlyphPreset

Mẫu đặt trước của ký hiệu dấu đầu dòng cho danh sách.

Các mẫu này sử dụng các loại dấu đầu dòng sau:

  • ARROW : Một mũi tên, tương ứng với điểm mã Unicode U+2794
  • ARROW3D : Một mũi tên được tô bóng 3D, tương ứng với điểm mã Unicode U+27a2
  • CHECKBOX: Hình vuông rỗng, tương ứng với điểm mã Unicode U+274f
  • CIRCLE: Một vòng tròn rỗng, tương ứng với một điểm mã Unicode U+25cb
  • DIAMOND : Một viên kim cương đặc, tương ứng với điểm mã Unicode U+25c6
  • DIAMONDX: Hình kim cương có dấu "x", tương ứng với điểm mã Unicode U+2756
  • HOLLOWDIAMOND: Hình thoi rỗng, tương ứng với điểm mã Unicode U+25c7
  • DISC: Một vòng tròn đặc, tương ứng với một điểm mã Unicode U+25cf
  • SQUARE: Hình vuông đặc, tương ứng với điểm mã Unicode U+25a0
  • STAR : Một ngôi sao, tương ứng với điểm mã Unicode U+2605
  • ALPHA: Một chữ cái viết thường, chẳng hạn như "a", "b" hoặc "c".
  • UPPERALPHA: Chữ hoa, chẳng hạn như "A", "B" hoặc "C".
  • DECIMAL : Một số, chẳng hạn như "1", "2" hoặc "3".
  • ZERODECIMAL : Một số có các số có một chữ số với tiền tố là số 0, chẳng hạn như "01", "02" hoặc "03". Số có nhiều chữ số không có tiền tố là số 0.
  • ROMAN: Chữ số La Mã viết thường, chẳng hạn như "i", "ii" hoặc "iii".
  • UPPERROMAN: Số La Mã viết hoa, chẳng hạn như "I", "II" hoặc "III".
  • LEFTTRIANGLE : Một hình tam giác trỏ sang trái, tương ứng với điểm mã Unicode U+25c4
Enum
BULLET_GLYPH_PRESET_UNSPECIFIED Bạn chưa chỉ định giá trị đặt trước cho ký tự dấu đầu dòng.
BULLET_DISC_CIRCLE_SQUARE Danh sách có dấu đầu dòng với ký tự dấu đầu dòng DISC, CIRCLE và SQUARE cho 3 cấp độ lồng ghép danh sách đầu tiên.
BULLET_DIAMONDX_ARROW3D_SQUARE Danh sách được đánh dấu đầu dòng có ký tự gạch đầu dòng DIAMONDX, ARROW3D và SQUARE cho 3 cấp độ lồng ghép danh sách đầu tiên.
BULLET_CHECKBOX Danh sách có dấu đầu dòng với ký tự dấu đầu dòng CHECKBOX cho tất cả các cấp độ lồng danh sách.
BULLET_ARROW_DIAMOND_DISC Danh sách có dấu đầu dòng với ký tự dấu đầu dòng ARROW, DIAMOND và DISC cho 3 cấp độ lồng ghép danh sách đầu tiên.
BULLET_STAR_CIRCLE_SQUARE Danh sách có dấu đầu dòng với ký tự dấu đầu dòng STAR, CIRCLE và SQUARE cho 3 cấp độ lồng ghép danh sách đầu tiên.
BULLET_ARROW3D_CIRCLE_SQUARE Danh sách được đánh dấu đầu dòng có ký tự gạch đầu dòng ARROW3D, CIRCLE và SQUARE cho 3 cấp độ lồng ghép danh sách đầu tiên.
BULLET_LEFTTRIANGLE_DIAMOND_DISC Danh sách có dấu đầu dòng với ký tự dấu đầu dòng LEFTTRIANGLE, DIAMOND và DISC cho 3 cấp độ lồng ghép danh sách đầu tiên.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE Danh sách có dấu đầu dòng với ký tự dấu đầu dòng DIAMONDX, HOLLOWDIAMOND và SQUARE cho 3 cấp độ lồng ghép danh sách đầu tiên.
BULLET_DIAMOND_CIRCLE_SQUARE Danh sách được đánh dấu đầu dòng có ký tự gạch đầu dòng DIAMOND, CIRCLE và SQUARE cho 3 cấp độ lồng ghép danh sách đầu tiên.
NUMBERED_DECIMAL_ALPHA_ROMAN Danh sách được đánh số bằng các ký tự số DECIMAL, ALPHA và ROMAN cho 3 cấp độ lồng ghép danh sách đầu tiên, theo sau là dấu chấm.
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS Danh sách được đánh số bằng các ký tự số DECIMAL, ALPHA và ROMAN cho 3 cấp độ lồng ghép danh sách đầu tiên, theo sau là dấu ngoặc đơn.
NUMBERED_DECIMAL_NESTED Danh sách được đánh số có các ký tự số DECIMAL được phân tách bằng dấu chấm, trong đó mỗi cấp lồng nhau sử dụng ký tự của cấp lồng nhau trước đó làm tiền tố. Ví dụ: "1.", '1.1.', '2.', '2.2.'.
NUMBERED_UPPERALPHA_ALPHA_ROMAN Danh sách được đánh số bằng các ký tự số UPPERALPHA, ALPHA và ROMAN cho 3 cấp độ lồng ghép danh sách đầu tiên, theo sau là dấu chấm.
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL Danh sách được đánh số bằng các ký tự số UPPERROMAN, UPPERALPHA và DECIMAL cho 3 cấp độ lồng ghép danh sách đầu tiên, theo sau là dấu chấm.
NUMBERED_ZERODECIMAL_ALPHA_ROMAN Danh sách được đánh số bằng các ký tự số ZERODECIMAL, ALPHA và ROMAN cho 3 cấp độ lồng ghép danh sách đầu tiên, theo sau là dấu chấm.

DeleteParagraphBulletsRequest

Xoá dấu đầu dòng khỏi tất cả các đoạn văn bản trùng lặp với dải ô đã cho.

Cấp độ lồng ghép của mỗi đoạn văn sẽ được giữ nguyên bằng cách thêm thụt lề vào đầu đoạn văn tương ứng.

Biểu diễn dưới dạng JSON 
{
  "range": {
    object (Range)
  }
}
Trường
range

object (Range)

Dải ô cần xoá dấu đầu dòng.

CreateNamedRangeRequest

Tạo một NamedRange tham chiếu đến dải ô đã cho.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "range": {
    object (Range)
  }
}
Trường
name

string

Tên của NamedRange. Tên không cần phải là duy nhất.

Tên phải có ít nhất 1 ký tự và không được có nhiều hơn 256 ký tự, được tính bằng đơn vị mã UTF-16.

range

object (Range)

Dải ô áp dụng tên.

DeleteNamedRangeRequest

Xoá một NamedRange.

Biểu diễn dưới dạng 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.
}
Trường
tabsCriteria

object (TabsCriteria)

Không bắt buộc. Tiêu chí dùng để chỉ định(các) thẻ mà thao tác xoá phạm vi sẽ diễn ra. Nếu bạn bỏ qua, thao tác xoá dải ô sẽ được áp dụng cho tất cả các thẻ.

Trong tài liệu chứa một thẻ duy nhất:

  • Nếu được cung cấp, mã này phải khớp với mã của thẻ số ít.

  • Nếu bạn bỏ qua thuộc tính này, việc xoá dải ô sẽ áp dụng cho thẻ số ít.

Trong một tài liệu chứa nhiều thẻ:

  • Nếu được cung cấp, thao tác xoá dải ô sẽ áp dụng cho các thẻ đã chỉ định.

  • Nếu bạn không cung cấp, thao tác xoá dải ô sẽ áp dụng cho tất cả các thẻ.

Trường kết hợp named_range_reference. Giá trị xác định dải ô cần xoá. Bạn phải đặt đúng một giá trị. named_range_reference chỉ có thể là một trong những giá trị sau:
namedRangeId

string

Mã của dải ô được đặt tên cần xoá.

name

string

Tên của(các) dải ô cần xoá. Tất cả các dải ô được đặt tên có tên đã cho sẽ bị xóa.

UpdateParagraphStyleRequest

Cập nhật kiểu của tất cả các đoạn văn trùng lặp với phạm vi đã cho.

Biểu diễn dưới dạng 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.
}
Trường
paragraphStyle

object (ParagraphStyle)

Kiểu để đặt trên các đoạn văn bản.

Một số thay đổi về kiểu đoạn văn có thể gây ra các thay đổi khác để phản ánh hành vi của trình chỉnh sửa Tài liệu. Hãy xem tài liệu về ParagraphStyle để biết thêm thông tin.

fields

string (FieldMask format)

Các trường cần cập nhật.

Bạn phải chỉ định ít nhất một trường. paragraphStyle gốc được ngụ ý và không được chỉ định. Bạn có thể dùng một "*" để liệt kê mọi trường.

Ví dụ: để cập nhật thuộc tính căn chỉnh của kiểu đoạn văn, hãy đặt fields thành "alignment".

Để đặt lại một thuộc tính về giá trị mặc định, hãy thêm tên trường vào mặt nạ trường nhưng để trống trường đó.

Trường hợp hợp nhất insertion_location. Loại dải ô được dùng để cập nhật kiểu đoạn văn bản. insertion_location chỉ có thể là một trong những giá trị sau:
range

object (Range)

Dải ô trùng lặp với các đoạn văn bản cần định kiểu.

DeleteContentRangeRequest

Xoá nội dung khỏi tài liệu.

Biểu diễn dưới dạng JSON 
{
  "range": {
    object (Range)
  }
}
Trường
range

object (Range)

Phạm vi nội dung cần xoá.

Việc xoá văn bản nằm trên ranh giới của một đoạn văn có thể dẫn đến thay đổi đối với kiểu đoạn văn, danh sách, đối tượng được định vị và dấu trang khi hai đoạn văn được hợp nhất.

Việc cố gắng xoá một số dải ô nhất định có thể dẫn đến cấu trúc tài liệu không hợp lệ, trong trường hợp này, hệ thống sẽ trả về lỗi yêu cầu không hợp lệ 400.

Sau đây là một số ví dụ về yêu cầu xoá không hợp lệ:

InsertInlineImageRequest

Chèn một InlineObject chứa hình ảnh ở vị trí đã cho.

Biểu diễn dưới dạng 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.
}
Trường
uri

string

URI hình ảnh.

Hệ thống sẽ tìm nạp hình ảnh một lần tại thời điểm chèn và một bản sao sẽ được lưu trữ để hiển thị trong tài liệu. Hình ảnh phải có kích thước dưới 50 MB, không được vượt quá 25 megapixel và phải ở định dạng PNG, JPEG hoặc GIF.

URI được cung cấp phải có thể truy cập công khai và có độ dài tối đa là 2 kB. URI được lưu cùng với hình ảnh và hiển thị thông qua trường ImageProperties.content_uri.

objectSize

object (Size)

Kích thước mà hình ảnh sẽ hiển thị như trong tài liệu. Thuộc tính này là không bắt buộc và kích thước cuối cùng của hình ảnh trong tài liệu được xác định theo các quy tắc sau: * Nếu không chỉ định chiều rộng hoặc chiều cao, thì kích thước mặc định của hình ảnh sẽ được tính toán dựa trên độ phân giải của hình ảnh. * Nếu bạn chỉ định một kích thước, thì kích thước còn lại sẽ được tính để duy trì tỷ lệ khung hình của hình ảnh. * Nếu bạn chỉ định cả chiều rộng và chiều cao, hình ảnh sẽ được điều chỉnh theo tỷ lệ để vừa với kích thước được cung cấp trong khi vẫn giữ nguyên tỷ lệ khung hình.

Trường kết hợp insertion_location. Vị trí chèn hình ảnh. insertion_location chỉ có thể là một trong những giá trị sau:
location

object (Location)

Chèn hình ảnh vào một chỉ mục cụ thể trong tài liệu.

Hình ảnh phải được chèn vào trong giới hạn của một Paragraph hiện có. Ví dụ: bạn không thể chèn thẻ này tại chỉ mục bắt đầu của bảng (tức là giữa bảng và đoạn văn bản trước đó).

Không thể chèn hình ảnh cùng dòng vào chú thích cuối trang hoặc phương trình.

endOfSegmentLocation

object (EndOfSegmentLocation)

Chèn văn bản vào cuối đầu trang, chân trang hoặc phần nội dung tài liệu.

Không thể chèn hình ảnh nội tuyến vào chú thích cuối trang.

InsertTableRequest

Chèn một bảng ở vị trí đã chỉ định.

Một ký tự dòng mới sẽ được chèn trước bảng đã chèn.

Biểu diễn dưới dạng 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.
}
Trường
rows

integer

Số hàng trong bảng.

columns

integer

Số cột trong bảng.

Trường hợp hợp nhất insertion_location. Vị trí chèn bảng. insertion_location chỉ được có thể là một trong những trạng thái sau đây:
location

object (Location)

Chèn bảng tại một chỉ mục mô hình cụ thể.

Ký tự dòng mới sẽ được chèn trước bảng đã chèn, do đó, chỉ mục bắt đầu của bảng sẽ ở chỉ mục vị trí được chỉ định + 1.

Bạn phải chèn bảng vào trong giới hạn của một Paragraph hiện có. Ví dụ: bạn không thể chèn bảng ở chỉ mục bắt đầu của bảng (tức là giữa bảng hiện có và đoạn văn bản trước đó).

Không thể chèn bảng vào chú thích cuối trang hoặc phương trình.

endOfSegmentLocation

object (EndOfSegmentLocation)

Chèn bảng vào cuối đầu trang, chân trang hoặc nội dung tài liệu đã cho. Một ký tự dòng mới sẽ được chèn trước bảng đã chèn.

Không thể chèn bảng vào chú thích cuối trang.

InsertTableRowRequest

Chèn một hàng trống vào bảng.

Biểu diễn dưới dạng JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}
Trường
tableCellLocation

object (TableCellLocation)

Vị trí ô trong bảng tham chiếu mà các hàng sẽ được chèn từ đó.

Một hàng mới sẽ được chèn phía trên (hoặc phía dưới) hàng chứa ô tham chiếu. Nếu ô tham chiếu là ô được hợp nhất, thì hàng mới sẽ được chèn phía trên (hoặc phía dưới) ô được hợp nhất.

insertBelow

boolean

Liệu có chèn hàng mới bên dưới vị trí ô tham chiếu hay không.

  • True : chèn bên dưới ô.
  • False: chèn phía trên ô.

TableCellLocation

Vị trí của một ô trong bảng.

Biểu diễn dưới dạng JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}
Trường
tableStartLocation

object (Location)

Vị trí nơi bảng bắt đầu trong tài liệu.

rowIndex

integer

Chỉ mục hàng dựa trên 0. Ví dụ: hàng thứ hai trong bảng có chỉ mục hàng là 1.

columnIndex

integer

Chỉ mục cột bắt đầu từ 0. Ví dụ: cột thứ hai trong bảng có chỉ mục cột là 1.

InsertTableColumnRequest

Chèn một cột trống vào bảng.

Biểu diễn dưới dạng JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}
Trường
tableCellLocation

object (TableCellLocation)

Vị trí ô trong bảng tham chiếu mà từ đó các cột sẽ được chèn.

Cột mới sẽ được chèn vào bên trái (hoặc bên phải) của cột chứa ô tham chiếu. Nếu ô tham chiếu là ô được hợp nhất, thì cột mới sẽ được chèn vào bên trái (hoặc bên phải) của ô được hợp nhất.

insertRight

boolean

Liệu có chèn cột mới vào bên phải vị trí ô tham chiếu hay không.

  • True: chèn sang phải.
  • False : chèn vào bên trái.

DeleteTableRowRequest

Xoá một hàng khỏi bảng.

Biểu diễn dưới dạng JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
Trường
tableCellLocation

object (TableCellLocation)

Vị trí ô trong bảng tham chiếu mà hàng sẽ được xoá.

Hàng mà ô này trải dài sẽ bị xoá. Nếu đây là ô hợp nhất trải dài trên nhiều hàng, thì tất cả các hàng mà ô đó trải dài sẽ bị xoá. Nếu không còn hàng nào trong bảng sau khi xoá, toàn bộ bảng sẽ bị xoá.

DeleteTableColumnRequest

Xoá một cột khỏi bảng.

Biểu diễn dưới dạng JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
Trường
tableCellLocation

object (TableCellLocation)

Vị trí ô trong bảng tham chiếu mà cột sẽ được xoá.

Cột trải rộng trong ô này sẽ bị xoá. Nếu đây là ô hợp nhất trải dài trên nhiều cột, thì tất cả cột mà ô đó trải dài sẽ bị xoá. Nếu không còn cột nào trong bảng sau khi xoá, toàn bộ bảng sẽ bị xoá.

InsertPageBreakRequest

Chèn ngắt trang theo sau là một dòng mới tại vị trí đã chỉ định.

Biểu diễn dưới dạng 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.
}
Trường
Trường hợp hợp nhất insertion_location. Vị trí sẽ chèn ngắt trang. insertion_location chỉ có thể là một trong những giá trị sau:
location

object (Location)

Chèn ngắt trang tại một chỉ mục cụ thể trong tài liệu.

Bạn phải chèn dấu ngắt trang vào trong giới hạn của một Paragraph hiện có. Ví dụ: bạn không thể chèn thẻ này tại chỉ mục bắt đầu của bảng (tức là giữa bảng và đoạn văn bản trước đó).

Không thể chèn dấu ngắt trang vào bên trong bảng, phương trình, chú thích cuối trang, tiêu đề hoặc chân trang. Vì bạn chỉ có thể chèn ngắt trang vào phần nội dung, nên trường segment ID phải trống.

endOfSegmentLocation

object (EndOfSegmentLocation)

Chèn ngắt trang ở cuối phần nội dung tài liệu.

Không thể chèn ngắt trang bên trong chú thích cuối trang, đầu trang hoặc chân trang. Vì bạn chỉ có thể chèn ngắt trang vào bên trong phần nội dung, nên trường segment ID phải trống.

DeletePositionedObjectRequest

Xoá PositionedObject khỏi tài liệu.

Biểu diễn dưới dạng JSON 
{
  "objectId": string,
  "tabId": string
}
Trường
objectId

string

Mã của đối tượng đã định vị cần xoá.

tabId

string

Thẻ chứa đối tượng được định vị cần xoá. Khi bị bỏ qua, yêu cầu sẽ được áp dụng cho thẻ đầu tiên.

Trong tài liệu chỉ chứa một thẻ:

  • Nếu được cung cấp, phải khớp với mã của thẻ đơn.

  • Nếu bạn bỏ qua, yêu cầu này sẽ áp dụng cho thẻ số ít.

Trong một tài liệu chứa nhiều thẻ:

  • Nếu được cung cấp, yêu cầu sẽ áp dụng cho thẻ được chỉ định.

  • Nếu bị bỏ qua, yêu cầu sẽ áp dụng cho thẻ đầu tiên trong tài liệu.

UpdateTableColumnPropertiesRequest

Cập nhật TableColumnProperties của các cột trong bảng.

Biểu diễn dưới dạng JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}
Trường
tableStartLocation

object (Location)

Vị trí bắt đầu của bảng trong tài liệu.

columnIndices[]

integer

Danh sách các chỉ mục cột dựa trên số 0 có thuộc tính cần được cập nhật. Nếu bạn không chỉ định chỉ mục nào, tất cả các cột sẽ được cập nhật.

tableColumnProperties

object (TableColumnProperties)

Các thuộc tính của cột trong bảng cần cập nhật.

Nếu giá trị của tableColumnProperties#width nhỏ hơn 5 điểm (5/72 inch), thì hệ thống sẽ trả về lỗi 400 yêu cầu không hợp lệ.

fields

string (FieldMask format)

Các trường cần cập nhật.

Bạn phải chỉ định ít nhất một trường. tableColumnProperties gốc được ngụ ý và không được chỉ định. Bạn có thể dùng một "*" để liệt kê mọi trường.

Ví dụ: để cập nhật chiều rộng cột, hãy đặt fields thành "width".

UpdateTableCellStyleRequest

Cập nhật kiểu của một dải ô trong bảng.

Biểu diễn dưới dạng 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.
}
Trường
tableCellStyle

object (TableCellStyle)

Kiểu để đặt trên các ô trong bảng.

Khi cập nhật đường viền, nếu một ô có chung đường viền với một ô liền kề, thì thuộc tính đường viền tương ứng của ô liền kề cũng sẽ được cập nhật. Các đường viền được hợp nhất và ẩn sẽ không được cập nhật.

Do việc cập nhật đường viền được các ô liền kề chia sẻ trong cùng một yêu cầu có thể gây ra xung đột cập nhật đường viền, nên các cập nhật đường viền được áp dụng theo thứ tự sau:

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

Các trường cần cập nhật.

Bạn phải chỉ định ít nhất một trường. tableCellStyle gốc được ngụ ý và không được chỉ định. Bạn có thể dùng một "*" để liệt kê mọi trường.

Ví dụ: để cập nhật màu nền của ô trong bảng, hãy đặt fields thành "backgroundColor".

Để đặt lại một thuộc tính về giá trị mặc định, hãy thêm tên trường vào mặt nạ trường nhưng để trống trường đó.

Trường kết hợp cells. Các ô sẽ được cập nhật. cells chỉ có thể là một trong những giá trị sau:
tableRange

object (TableRange)

Phạm vi bảng đại diện cho tập hợp con của bảng mà nội dung cập nhật được áp dụng.

tableStartLocation

object (Location)

Vị trí bắt đầu của bảng trong tài liệu. Khi được chỉ định, nội dung cập nhật sẽ được áp dụng cho tất cả các ô trong bảng.

TableRange

Dải ô của bảng đại diện cho một tham chiếu đến một tập hợp con của bảng.

Xin lưu ý rằng các ô do dải ô chỉ định không nhất thiết phải tạo thành hình chữ nhật. Ví dụ: giả sử chúng ta có một bảng 3 x 3, trong đó tất cả các ô của hàng cuối cùng được hợp nhất với nhau. Bảng sẽ có dạng như sau: 

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

Dải ô bảng có vị trí ô trong bảng = (tableStartLocation, hàng = 0, cột = 0), span hàng = 3 và span cột = 2 chỉ định các ô sau: 

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]
Biểu diễn dưới dạng JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
Trường
tableCellLocation

object (TableCellLocation)

Vị trí ô bắt đầu của dải ô bảng.

rowSpan

integer

Số hàng của dải ô bảng.

columnSpan

integer

Số cột của dải ô trong bảng.

UpdateTableRowStyleRequest

Cập nhật TableRowStyle của các hàng trong bảng.

Biểu diễn dưới dạng JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}
Trường
tableStartLocation

object (Location)

Vị trí bắt đầu của bảng trong tài liệu.

rowIndices[]

integer

Danh sách chỉ mục hàng dựa trên 0 có kiểu cần được cập nhật. Nếu bạn không chỉ định chỉ mục nào, tất cả các hàng sẽ được cập nhật.

tableRowStyle

object (TableRowStyle)

Kiểu sẽ được đặt trên các hàng.

fields

string (FieldMask format)

Các trường cần cập nhật.

Bạn phải chỉ định ít nhất một trường. tableRowStyle gốc được ngụ ý và không được chỉ định. Bạn có thể dùng một "*" để liệt kê mọi trường.

Ví dụ: để cập nhật chiều cao tối thiểu của hàng, hãy đặt fields thành "minRowHeight".

ReplaceImageRequest

Thay thế hình ảnh hiện có bằng hình ảnh mới.

Việc thay thế hình ảnh sẽ xoá một số image effects khỏi hình ảnh hiện có để phản ánh hành vi của trình chỉnh sửa Tài liệu.

Biểu diễn dưới dạng JSON 
{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "tabId": string
}
Trường
imageObjectId

string

Mã của hình ảnh hiện có sẽ được thay thế. Bạn có thể truy xuất mã nhận dạng từ phản hồi của một yêu cầu get.

uri

string

URI của hình ảnh mới.

Hình ảnh được tìm nạp một lần tại thời điểm chèn và một bản sao được lưu trữ để hiển thị bên trong tài liệu. Hình ảnh phải có dung lượng dưới 50 MB, không được vượt quá 25 megapixel và phải ở định dạng PNG, JPEG hoặc GIF.

URI được cung cấp không được vượt quá 2 KB. URI được lưu cùng với hình ảnh và hiển thị thông qua trường ImageProperties.source_uri.

imageReplaceMethod

enum (ImageReplaceMethod)

Phương thức thay thế.

tabId

string

Thẻ chứa hình ảnh cần thay thế. Khi bị bỏ qua, yêu cầu sẽ được áp dụng cho thẻ đầu tiên.

Trong tài liệu chỉ chứa một thẻ:

  • Nếu được cung cấp, phải khớp với mã của thẻ đơn.

  • Nếu bạn bỏ qua, yêu cầu này sẽ áp dụng cho thẻ số ít.

Trong một tài liệu chứa nhiều thẻ:

  • Nếu được cung cấp, yêu cầu sẽ áp dụng cho thẻ được chỉ định.

  • Nếu bạn bỏ qua, yêu cầu này sẽ áp dụng cho thẻ đầu tiên trong tài liệu.

ImageReplaceMethod

Phương thức thay thế hình ảnh.

Enum
IMAGE_REPLACE_METHOD_UNSPECIFIED Phương thức thay thế hình ảnh chưa được chỉ định. Không được sử dụng giá trị này.
CENTER_CROP Điều chỉnh tỷ lệ và căn giữa hình ảnh để lấp đầy ranh giới của hình ảnh gốc. Hình ảnh có thể bị cắt để lấp đầy ranh giới của hình ảnh gốc. Kích thước kết xuất của hình ảnh sẽ giống với hình ảnh gốc.

UpdateDocumentStyleRequest

Cập nhật DocumentStyle.

Biểu diễn dưới dạng JSON 
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string,
  "tabId": string
}
Trường
documentStyle

object (DocumentStyle)

Các kiểu cần đặt trên tài liệu.

Một số thay đổi về kiểu tài liệu có thể gây ra các thay đổi khác để phản ánh hành vi của trình chỉnh sửa Tài liệu. Hãy xem tài liệu về DocumentStyle để biết thêm thông tin.

fields

string (FieldMask format)

Các trường cần cập nhật.

Bạn phải chỉ định ít nhất một trường. documentStyle gốc đã được ngụ ý và không được chỉ định. Bạn có thể dùng một "*" để liệt kê mọi trường.

Ví dụ: để cập nhật nền, hãy đặt fields thành "background".

tabId

string

Thẻ chứa kiểu cần cập nhật. Nếu bạn bỏ qua, yêu cầu này sẽ áp dụng cho thẻ đầu tiên.

Trong một tài liệu chứa một thẻ duy nhất:

  • Nếu được cung cấp, phải khớp với mã của thẻ đơn.

  • Nếu bạn bỏ qua, yêu cầu này sẽ áp dụng cho thẻ số ít.

Trong một tài liệu chứa nhiều thẻ:

  • Nếu được cung cấp, yêu cầu sẽ áp dụng cho thẻ được chỉ định.

  • Nếu không được cung cấp, yêu cầu sẽ áp dụng cho thẻ đầu tiên trong tài liệu.

MergeTableCellsRequest

Hợp nhất các ô trong Table.

Biểu diễn dưới dạng JSON 
{
  "tableRange": {
    object (TableRange)
  }
}
Trường
tableRange

object (TableRange)

Dải ô của bảng chỉ định những ô của bảng cần hợp nhất.

Mọi văn bản trong các ô đang được hợp nhất sẽ được nối và lưu trữ trong ô "đầu" của dải ô. Đây là ô trên cùng bên trái của dải ô khi hướng nội dung là từ trái sang phải và là ô trên cùng bên phải của dải ô nếu không.

Nếu dải ô không phải hình chữ nhật (có thể xảy ra trong một số trường hợp khi dải ô bao gồm các ô đã được hợp nhất hoặc khi bảng không phải hình chữ nhật), thì lỗi yêu cầu không hợp lệ 400 sẽ được trả về.

UnmergeTableCellsRequest

Huỷ hợp nhất các ô trong Table.

Biểu diễn dưới dạng JSON 
{
  "tableRange": {
    object (TableRange)
  }
}
Trường
tableRange

object (TableRange)

Dải ô của bảng chỉ định những ô của bảng cần huỷ hợp nhất.

Tất cả các ô đã hợp nhất trong dải ô này sẽ được tách ra và các ô đã tách sẽ không bị ảnh hưởng. Nếu dải ô không có ô nào được hợp nhất, yêu cầu sẽ không có tác dụng gì.

Nếu có văn bản trong bất kỳ ô nào đã hợp nhất, văn bản đó sẽ vẫn nằm trong ô "đầu" của khối ô không hợp nhất thu được. Ô "đầu" là ô trên cùng bên trái khi hướng nội dung là từ trái sang phải và là ô trên cùng bên phải nếu không.

CreateHeaderRequest

Tạo một Header. Tiêu đề mới sẽ được áp dụng cho SectionStyle tại vị trí của SectionBreak nếu được chỉ định, nếu không thì tiêu đề mới sẽ được áp dụng cho DocumentStyle.

Nếu tiêu đề thuộc loại đã chỉ định đã tồn tại, hệ thống sẽ trả về lỗi yêu cầu không hợp lệ 400.

Biểu diễn dưới dạng JSON 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Trường
type

enum (HeaderFooterType)

Loại tiêu đề cần tạo.

sectionBreakLocation

object (Location)

Vị trí của SectionBreak bắt đầu phần mà tiêu đề này thuộc về. Nếu "sectionBreakLocation" không được đặt hoặc nếu quy tắc này đề cập đến điểm ngắt phần đầu tiên trong nội dung tài liệu, thì tiêu đề sẽ áp dụng cho DocumentStyle

HeaderFooterType

Các loại đầu trang và chân trang có thể được tạo.

Enum
DEFAULT Đầu trang/chân trang mặc định.

CreateFooterRequest

Tạo một Footer. Chân trang mới được áp dụng cho SectionStyle tại vị trí của SectionBreak nếu được chỉ định, nếu không thì chân trang sẽ được áp dụng cho DocumentStyle.

Nếu chân trang thuộc loại đã chỉ định đã tồn tại, hệ thống sẽ trả về lỗi yêu cầu không hợp lệ 400.

Biểu diễn dưới dạng JSON 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Trường
type

enum (HeaderFooterType)

Loại chân trang cần tạo.

sectionBreakLocation

object (Location)

Vị trí của SectionBreak ngay trước phần có SectionStyle mà chân trang này thuộc về. Nếu bạn không đặt thuộc tính này hoặc thuộc tính này tham chiếu đến dấu ngắt mục đầu tiên trong tài liệu, thì chân trang sẽ áp dụng cho kiểu tài liệu.

CreateFootnoteRequest

Tạo một phân khúc Footnote và chèn một FootnoteReference mới vào phân khúc đó tại vị trí đã cho.

Phân đoạn Footnote mới sẽ chứa một dấu cách, theo sau là ký tự dòng mới.

Biểu diễn dưới dạng 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.
}
Trường
Trường kết hợp footnote_reference_location. Vị trí chèn phần tham chiếu đến chú thích cuối trang. footnote_reference_location chỉ có thể là một trong những giá trị sau:
location

object (Location)

Chèn tham chiếu chú thích cuối trang tại một chỉ mục cụ thể trong tài liệu.

Bạn phải chèn tham chiếu chú thích cuối trang vào trong giới hạn của một Paragraph hiện có. Ví dụ: bạn không thể chèn thẻ này tại chỉ mục bắt đầu của bảng (tức là giữa bảng và đoạn văn bản trước đó).

Không thể chèn phần tham chiếu đến chú thích cuối trang vào trong một phương trình, đầu trang, chân trang hoặc chú thích cuối trang. Vì bạn chỉ có thể chèn tệp đối chiếu chú thích cuối trang vào phần nội dung, nên trường segment ID phải trống.

endOfSegmentLocation

object (EndOfSegmentLocation)

Chèn nội dung tham chiếu chú thích cuối trang vào cuối nội dung tài liệu.

Không thể chèn phần tham chiếu đến chú thích cuối trang vào trong đầu trang, chân trang hoặc chú thích cuối trang. Vì nội dung tham chiếu đến chú thích cuối trang chỉ có thể chèn vào phần nội dung, nên trường segment ID phải được để trống.

ReplaceNamedRangeContentRequest

Thay thế nội dung của NamedRange hoặc NamedRanges được chỉ định bằng nội dung thay thế nhất định.

Xin lưu ý rằng một NamedRange riêng lẻ có thể bao gồm nhiều ranges không liên tục. Trong trường hợp này, chỉ nội dung trong dải ô đầu tiên được thay thế. Các dải ô khác và nội dung của các dải ô đó sẽ bị xoá.

Trong trường hợp việc thay thế hoặc xoá bất kỳ dải ô nào sẽ dẫn đến cấu trúc tài liệu không hợp lệ, lỗi yêu cầu không hợp lệ 400 sẽ được trả về.

Biểu diễn dưới dạng 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.
}
Trường
tabsCriteria

object (TabsCriteria)

Không bắt buộc. Tiêu chí dùng để chỉ định thẻ nào sẽ thay thế. Nếu bạn bỏ qua, nội dung thay thế sẽ áp dụng cho tất cả thẻ.

Trong tài liệu chứa một thẻ duy nhất:

  • Nếu được cung cấp, phải khớp với mã của thẻ đơn.

  • Nếu bị bỏ qua, thì thay thế sẽ áp dụng cho thẻ số ít.

Trong một tài liệu chứa nhiều thẻ:

  • Nếu được cung cấp, nội dung thay thế sẽ áp dụng cho các thẻ được chỉ định.

  • Nếu bạn bỏ qua, nội dung thay thế sẽ áp dụng cho tất cả thẻ.

Trường hợp hợp nhất replacement_content. Nội dung thay thế nội dung hiện có của dải ô được đặt tên. replacement_content chỉ có thể là một trong những giá trị sau:
text

string

Thay thế nội dung của(các) dải ô được đặt tên đã chỉ định bằng văn bản đã cho.

Trường hợp hợp nhất named_range_reference. Tham chiếu đến(các) dải ô được đặt tên có nội dung sẽ được thay thế. named_range_reference chỉ được có thể là một trong những trạng thái sau đây:
namedRangeId

string

Mã nhận dạng của dải ô được đặt tên có nội dung sẽ được thay thế.

Nếu không có dải ô được đặt tên có mã nhận dạng đã cho, thì hệ thống sẽ trả về lỗi yêu cầu không hợp lệ 400.

namedRangeName

string

Tên của NamedRanges có nội dung sẽ được thay thế.

Nếu có nhiều named ranges có tên đã cho, thì nội dung của mỗi named ranges sẽ được thay thế. Nếu không có dải ô được đặt tên nào có tên đã cho, thì yêu cầu sẽ không hoạt động.

UpdateSectionStyleRequest

Cập nhật SectionStyle.

Biểu diễn dưới dạng JSON 
{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}
Trường
range

object (Range)

Dải ô trùng lặp với các mục cần định kiểu.

Vì bạn chỉ có thể chèn dấu ngắt phần bên trong phần nội dung, nên trường segment ID phải trống.

sectionStyle

object (SectionStyle)

Kiểu sẽ được đặt trên mục.

Một số thay đổi về kiểu mục nhất định có thể gây ra các thay đổi khác để phản ánh hành vi của trình chỉnh sửa Tài liệu. Hãy xem tài liệu về SectionStyle để biết thêm thông tin.

fields

string (FieldMask format)

Các trường cần được cập nhật.

Bạn phải chỉ định ít nhất một trường. sectionStyle gốc được ngụ ý và không được chỉ định. Bạn có thể dùng một "*" để liệt kê mọi trường.

Ví dụ: để cập nhật lề trái, hãy đặt fields thành "marginLeft".

InsertSectionBreakRequest

Chèn một dấu ngắt phần tại vị trí đã cho.

Một ký tự dòng mới sẽ được chèn vào trước dấu ngắt mục.

Biểu diễn dưới dạng 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.
}
Trường
sectionType

enum (SectionType)

Loại phần cần chèn.

Trường hợp hợp nhất insertion_location. Vị trí chèn dấu ngắt. insertion_location chỉ có thể là một trong những giá trị sau:
location

object (Location)

Chèn dòng mới và ngắt phần tại một chỉ mục cụ thể trong tài liệu.

Bạn phải chèn dấu ngắt mục bên trong giới hạn của Paragraph hiện có. Ví dụ: không thể chèn vào chỉ mục bắt đầu của bảng (tức là giữa bảng và đoạn trước của bảng).

Không thể chèn dấu ngắt phần bên trong bảng, phương trình, chú thích cuối trang, tiêu đề hoặc chân trang. Vì bạn chỉ có thể chèn các dấu ngắt phần bên trong phần nội dung, nên trường segment ID phải trống.

endOfSegmentLocation

object (EndOfSegmentLocation)

Chèn dòng mới và ngắt phần ở cuối phần nội dung của tài liệu.

Không thể chèn dấu ngắt phần bên trong chú thích cuối trang, đầu trang hoặc chân trang. Vì bạn chỉ có thể chèn dấu ngắt phần bên trong phần nội dung, nên trường segment ID phải trống.

DeleteHeaderRequest

Xoá một Header khỏi tài liệu.

Biểu diễn dưới dạng JSON 
{
  "headerId": string,
  "tabId": string
}
Trường
headerId

string

Mã của tiêu đề cần xoá. Nếu tiêu đề này được xác định trên DocumentStyle, thì tham chiếu đến tiêu đề này sẽ bị xoá, dẫn đến không có tiêu đề thuộc loại đó cho phần đầu tiên của tài liệu. Nếu tiêu đề này được xác định trên SectionStyle, thì tham chiếu đến tiêu đề này sẽ bị xoá và tiêu đề của loại đó sẽ tiếp tục từ phần trước.

tabId

string

Thẻ chứa tiêu đề cần xoá. Khi bị bỏ qua, yêu cầu sẽ được áp dụng cho thẻ đầu tiên.

Trong tài liệu chỉ chứa một thẻ:

  • Nếu được cung cấp, phải khớp với mã của thẻ đơn.

  • Nếu bạn bỏ qua, yêu cầu này sẽ áp dụng cho thẻ số ít.

Trong một tài liệu chứa nhiều thẻ:

  • Nếu được cung cấp, yêu cầu sẽ áp dụng cho thẻ được chỉ định.

  • Nếu bạn bỏ qua, yêu cầu này sẽ áp dụng cho thẻ đầu tiên trong tài liệu.

DeleteFooterRequest

Xoá một Footer khỏi tài liệu.

Biểu diễn dưới dạng JSON 
{
  "footerId": string,
  "tabId": string
}
Trường
footerId

string

Mã của chân trang cần xoá. Nếu chân trang này được xác định trên DocumentStyle, thì tệp tham chiếu đến chân trang này sẽ bị xoá, dẫn đến không có chân trang thuộc loại đó cho phần đầu tiên của tài liệu. Nếu chân trang này được xác định trên SectionStyle, thì tham chiếu đến chân trang này sẽ bị xoá và chân trang của loại đó sẽ tiếp tục từ phần trước.

tabId

string

Thẻ chứa chân trang cần xoá. Khi bị bỏ qua, yêu cầu sẽ được áp dụng cho thẻ đầu tiên.

Trong tài liệu chỉ chứa một thẻ:

  • Nếu được cung cấp, phải khớp với mã của thẻ đơn.

  • Nếu bạn bỏ qua, yêu cầu này sẽ áp dụng cho thẻ số ít.

Trong một tài liệu chứa nhiều thẻ:

  • Nếu được cung cấp, yêu cầu sẽ áp dụng cho thẻ được chỉ định.

  • Nếu bị bỏ qua, yêu cầu sẽ áp dụng cho thẻ đầu tiên trong tài liệu.

PinTableHeaderRowsRequest

Cập nhật số lượng hàng tiêu đề bảng được ghim trong bảng.

Biểu diễn dưới dạng JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}
Trường
tableStartLocation

object (Location)

Vị trí nơi bảng bắt đầu trong tài liệu.

pinnedHeaderRowsCount

integer

Số lượng hàng trong bảng cần ghim, trong đó 0 có nghĩa là tất cả các hàng đều bị bỏ ghim.