Requests

Yêu cầu

Một bản cập nhật duy nhất để áp dụng cho 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)
  },
  "insertPerson": {
    object (InsertPersonRequest)
  }
  // End of list of possible types for union field request.
}
Trường
Trường nhóm request. Yêu cầu cụ thể cần áp dụng. Bạn phải điền đúng một trường. request chỉ có thể là một trong những trạng thái sau:
replaceAllText

object (ReplaceAllTextRequest)

Thay thế tất cả các trường hợp xuất hiện của văn bản đã chỉ định.

insertText

object (InsertTextRequest)

Chèn văn bản vào vị trí đã chỉ định.

updateTextStyle

object (UpdateTextStyleRequest)

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

createParagraphBullets

object (CreateParagraphBulletsRequest)

Tạo dấu đầu dòng cho đoạn văn.

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

Xoá dấu đầu dòng khỏi đoạn vă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 văn tại dải ô được chỉ định.

deleteContentRange

object (DeleteContentRangeRequest)

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

insertInlineImage

object (InsertInlineImageRequest)

Chèn một hình ảnh nội tuyến tại vị trí được chỉ định.

insertTable

object (InsertTableRequest)

Chèn một bảng tại vị trí được 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 dấu ngắt trang tại vị trí được chỉ định.

deletePositionedObject

object (DeletePositionedObjectRequest)

Xoá một đối tượng được đị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ế một 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 phần của dải ô được chỉ định.

insertSectionBreak

object (InsertSectionBreakRequest)

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

deleteHeader

object (DeleteHeaderRequest)

Xoá một 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.

insertPerson

object (InsertPersonRequest)

Chèn một lượt đề cập đến người dùng.

ReplaceAllTextRequest

Thay thế tất cả các trường hợp 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 trùng khớp.

tabsCriteria

object (TabsCriteria)

Không bắt buộc. Các tiêu chí dùng để chỉ định thẻ mà nội dung thay thế sẽ xuất hiện.

Nếu bạn bỏ qua tham số này, thì thao tác thay thế sẽ áp dụng cho tất cả các thẻ.

Trong tài liệu chỉ có một thẻ:

  • Nếu được cung cấp, mã này phải khớp với mã nhận dạng của thẻ đơn lẻ.

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

Trong một tài liệu có 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, thao tác thay thế sẽ áp dụng cho tất cả các thẻ.

Trường nhóm criteria. Tiêu chí dùng để so khớp văn bản cần thay thế. criteria chỉ có thể là một trong những trạng thái 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,
  "searchByRegex": 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 cụm từ tìm kiếm có phân biệt chữ hoa chữ thường hay không:

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

boolean

Không bắt buộc. True nếu giá trị tìm kiếm được coi là một biểu thức chính quy. Mọi dấu gạch chéo ngược trong mẫu đều phải được thoát.

  • True : văn bản tìm kiếm được coi là một biểu thức chính quy.
  • False: văn bản tìm kiếm được coi là một chuỗi con để so khớp.

TabsCriteria

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

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

string

Danh sách mã nhận dạng thẻ mà yêu cầu thực thi.

InsertTextRequest

Chèn văn bản vào 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à ký tự trong Vùng sử dụng riêng của Mặt phẳng đa ngôn ngữ cơ bản của Unicode (U+E000 – U+F8FF) sẽ bị xoá khỏi văn bản được chèn.

Trường nhóm insertion_location. Vị trí mà văn bản sẽ được chèn vào. insertion_location chỉ có thể là một trong những trạng thái sau:
location

object (Location)

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

Bạn phải chèn văn bản vào bên trong ranh giới của một Paragraph hiện có. Ví dụ: bạn 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 văn trước đó). Bạn phải chèn văn bản vào đoạn văn trước đó.

endOfSegmentLocation

object (EndOfSegmentLocation)

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

Thông tin 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ã nhận dạng của tiêu đề, chân trang hoặc chú thích mà vị trí nằm trong đó. Mã phân đoạn trống biểu thị nội dung của tài liệu.

index

integer

Chỉ mục dựa trên 0, tính bằng đơn vị mã UTF-16.

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

tabId

string

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

Trong tài liệu chỉ có một thẻ:

  • Nếu được cung cấp, mã này phải khớp với mã nhận dạng của thẻ đơn lẻ.

  • Nếu bỏ qua, yêu cầu sẽ áp dụng cho thẻ đơn.

Trong một tài liệu có 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 tham số này, yêu cầu sẽ áp dụng cho thẻ đầu tiên trong tài liệu.

EndOfSegmentLocation

Vị trí ở cuối nội dung, tiêu đề, chân trang hoặc chú thích cuối trang. Vị trí này nằm ngay trước dấu xuống dòng cuối cùng trong đ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 tiêu đề, chân trang hoặc chú thích mà vị trí nằm trong đó. Mã phân đoạn trống biểu thị nội dung của tài liệu.

tabId

string

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

Trong tài liệu chỉ có một thẻ:

  • Nếu được cung cấp, mã này phải khớp với mã nhận dạng của thẻ đơn lẻ.

  • Nếu bỏ qua, yêu cầu sẽ áp dụng cho thẻ đơn.

Trong một tài liệu có 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 tham số này, 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 chữ của 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 gốc, thì kiểu đó sẽ được đặt thành 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 cập nhật.

Bạn phải chỉ định ít nhất một trường. textStyle gốc được ngầm hiểu và không được chỉ định. Bạn có thể dùng một "*" làm ký hiệu viết tắ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 của thuộc tính đó vào mặt nạ trường nhưng để trống trường đó.

Trường nhóm 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 trạng thái sau:
range

object (Range)

Phạm vi văn bản cần tạo kiểu.

Phạm vi này 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 thuộc danh sách, thì dấu đầu dòng của đoạn đó cũng được cập nhật theo 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.

Cấp độ lồng của mỗi đoạn văn sẽ được xác định bằng cách đếm các ký tự tab ở đầu mỗi đoạn văn. Để tránh có quá nhiều khoảng trống giữa dấu đầu dòng và đoạn văn tương ứng, yêu cầu này sẽ xoá các dấu tab đầu dòng. Điều này có thể làm thay đổi chỉ mục của các phần trong 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 một danh sách có giá trị đặt sẵn 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 ô cần áp dụng giá trị đặt sẵn dấu đầu dòng.

bulletPreset

enum (BulletGlyphPreset)

Các loại biểu tượng dấu đầu dòng sẽ được dùng.

BulletGlyphPreset

Các mẫu biểu tượng dấu đầu dòng đặt sẵn cho danh sách.

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

  • ARROW : Mũi tên, tương ứng với điểm mã Unicode U+2794
  • ARROW3D : Mũi tên có hiệu ứng đổ bóng 3D, tương ứng với điểm mã Unicode U+27a2
  • CHECKBOX : Một 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 điểm mã Unicode U+25cb
  • DIAMOND : Một hình kim cương đặc, tương ứng với điểm mã Unicode U+25c6
  • DIAMONDX : Một viên 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 liền, tương ứng với điểm mã Unicode U+25cf
  • SQUARE : Một 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 : Một chữ cái viết 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 chữ số đơn được thêm tiền tố là số 0, chẳng hạn như "01", "02" hoặc "03". Các số có nhiều chữ số không có số 0 ở đầu.
  • ROMAN : Chữ số La Mã viết thường, chẳng hạn như "i", "ii" hoặc "iii".
  • UPPERROMAN : Một chữ số La Mã viết hoa, chẳng hạn như "I", "II" hoặc "III".
  • LEFTTRIANGLE : Hình tam giác chỉ 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 mẫu định sẵn cho biểu tượng dấu đầu dòng.
BULLET_DISC_CIRCLE_SQUARE Danh sách có dấu đầu dòng với các 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ó dấu đầu dòng với các ký tự dấu đầ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 các biểu tượng 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 các 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 các 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ó dấu đầu dòng với các ký tự dấu đầ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 các 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 các 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ó dấu đầu dòng với các ký tự dấu đầ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 Một danh sách được đánh số có 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 Một danh sách được đánh số có 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ố với các ký tự số DECIMAL được phân tách bằng dấu chấm, trong đó mỗi cấp độ lồng ghép sử dụng ký tự của cấp độ lồng ghép trước đó làm tiền tố. Ví dụ: "1.", '1.1.', '2.', '2.2.'.
NUMBERED_UPPERALPHA_ALPHA_ROMAN Một danh sách được đánh số có 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 Một danh sách được đánh số có 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 Một danh sách được đánh số có 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 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 quá 256 ký tự, được đo bằng đơn vị mã UTF-16.

range

object (Range)

Dải ô cần á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. Các tiêu chí dùng để chỉ định(các) thẻ mà bạn muốn xoá dải ô. Khi bị 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ỉ có một thẻ:

  • Nếu được cung cấp, mã này phải khớp với mã nhận dạng của thẻ đơn lẻ.

  • Nếu bạn bỏ qua, thao tác xoá dải ô sẽ áp dụng cho thẻ đơn.

Trong một tài liệu có nhiều thẻ:

  • Nếu được cung cấp, thao tác xoá dải ô sẽ áp dụng cho các thẻ được 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 nhóm named_range_reference. Giá trị xác định phạm vi hoặc các phạm vi cần xoá. Bạn phải đặt đúng một. named_range_reference chỉ có thể là một trong những trạng thái 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ả dải ô có tên được chỉ định sẽ bị xoá.

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)

Các kiểu cần đặt cho đoạn văn.

Một số thay đổi về kiểu đoạn vă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ề ParagraphStyle để 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. paragraphStyle gốc được ngầm hiểu và không được chỉ định. Bạn có thể dùng một "*" làm ký hiệu viết tắ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 của thuộc tính đó vào mặt nạ trường nhưng để trống trường đó.

Trường nhóm insertion_location. Loại phạm vi được dùng khi kiểu đoạn văn sẽ được cập nhật. insertion_location chỉ có thể là một trong những trạng thái sau:
range

object (Range)

Phạm vi trùng lặp với các đoạn văn bản cần tạo 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 vượt quá ranh giới đoạn có thể dẫn đến những thay đổi về kiểu đoạn, danh sách, đối tượng được định vị và dấu trang khi hai đoạn được hợp nhất.

Việc cố gắng xoá một số dải ô 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, lỗi 400 yêu cầu không hợp lệ sẽ được trả về.

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 tại 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 của hình ảnh.

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ó kích thước dưới 50 MB, không được vượt quá 25 megapixel và phải ở một trong các đị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. Chính 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ẽ xuất hiện trong tài liệu. Thuộc tính này 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 bạn không chỉ định chiều rộng và chiều cao, thì kích thước mặc định của hình ảnh sẽ được tính dựa trên độ phân giải của hình ảnh. * Nếu bạn chỉ định một phương diện thì phương diện còn lại sẽ được tính toán để 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, thì hình ảnh sẽ được điều chỉnh tỷ lệ cho phù hợp với kích thước đã cung cấp trong khi vẫn duy trì tỷ lệ khung hình.

Trường nhóm insertion_location. Vị trí mà hình ảnh sẽ được chèn vào. insertion_location chỉ có thể là một trong những trạng thái sau:
location

object (Location)

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

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

Bạn không thể chèn hình ảnh cùng dòng vào bên trong một chú thích hoặc phương trình.

endOfSegmentLocation

object (EndOfSegmentLocation)

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

Bạn không thể chèn hình ảnh cùng dòng vào bên trong một chú thích.

InsertTableRequest

Chèn một bảng tại vị trí được chỉ định.

Một ký tự dòng mới sẽ được chèn trước bảng được 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 nhóm insertion_location. Vị trí mà bảng sẽ được chèn vào. insertion_location chỉ có thể là một trong những trạng thái sau:
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 được 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 bên trong ranh giới của một Paragraph hiện có. Ví dụ: bạn không thể chèn đối tượng này vào chỉ mục bắt đầu của bảng (tức là giữa một bảng hiện có và đoạn văn trước đó).

Không thể chèn bảng vào bên trong một chú thích hoặc phương trình.

endOfSegmentLocation

object (EndOfSegmentLocation)

Chèn bảng vào cuối tiêu đề, 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 được chèn.

Bạn không thể chèn bảng vào bên trong một chú thích.

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í ô tham chiếu trong bảng mà các hàng sẽ được chèn vào.

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

insertBelow

boolean

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í bắt đầu của bảng trong tài liệu.

rowIndex

integer

Chỉ mục hàng bắt đầu từ 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í ô tham chiếu trong bảng mà các cột sẽ được chèn vào.

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

insertRight

boolean

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í ô tham chiếu trong bảng mà hàng sẽ bị xoá.

Hàng mà ô này trải dài sẽ bị xoá. Nếu đây là một ô đã 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á, thì 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í ô tham chiếu trong bảng mà cột sẽ bị xoá.

Cột mà ô này trải dài sẽ bị xoá. Nếu đây là một ô đã hợp nhất trải dài trên nhiều cột, thì tất cả cá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á, thì toàn bộ bảng sẽ bị xoá.

InsertPageBreakRequest

Chèn dấu ngắt trang, sau đó là dấu xuống dòng tại vị trí được 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 nhóm insertion_location. Vị trí mà phần ngắt trang sẽ được chèn vào. insertion_location chỉ có thể là một trong những trạng thái sau:
location

object (Location)

Chèn dấu 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 bên trong ranh giới của một Paragraph hiện có. Ví dụ: bạn không thể chèn dấu ngắt dòng tại chỉ mục bắt đầu của bảng (tức là giữa bảng và đoạn văn trước đó).

Bạn 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ì dấu ngắt trang chỉ có thể được chèn vào bên trong nội dung, nên trường segment ID phải trống.

endOfSegmentLocation

object (EndOfSegmentLocation)

Chèn dấu ngắt trang vào cuối nội dung tài liệu.

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

DeletePositionedObjectRequest

Xoá một 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 được định vị cần xoá.

tabId

string

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

Trong tài liệu chỉ có một thẻ:

  • Nếu được cung cấp, mã này phải khớp với mã nhận dạng của thẻ đơn lẻ.

  • Nếu bỏ qua, yêu cầu sẽ áp dụng cho thẻ đơn.

Trong một tài liệu có 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 tham số này, 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 chỉ mục cột dựa trên số 0 mà 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ột của 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ì lỗi 400 yêu cầu không hợp lệ sẽ được trả về.

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. tableColumnProperties gốc được ngầm hiểu và không được chỉ định. Bạn có thể dùng một "*" làm ký hiệu viết tắ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 cần đặt cho các ô trong bảng.

Khi bạn cập nhật đường viền, nếu một ô dùng 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. Những đường viền được hợp nhất và không nhìn thấy sẽ không được cập nhật.

Vì việc cập nhật đường viền được chia sẻ bởi các ô liền kề trong cùng một yêu cầu có thể gây ra các bản cập nhật đường viền xung đột, nên các bản 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 cập nhật.

Bạn phải chỉ định ít nhất một trường. tableCellStyle gốc được ngầm hiểu và không được chỉ định. Bạn có thể dùng một "*" làm ký hiệu viết tắ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 của thuộc tính đó vào mặt nạ trường nhưng để trống trường đó.

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

object (TableRange)

Dải ô của bảng đại diện cho một phần của bảng mà các 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 ô bảng biểu thị một tham chiếu đến một tập hợp con của bảng.

Bạn cần lưu ý rằng các ô do một dải ô trong bảng chỉ định không nhất thiết phải tạo thành một 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: 

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

Một dải ô trong bảng có vị trí ô trong bảng = (tableStartLocation, hàng = 0, cột = 0), khoảng hàng = 3 và khoảng 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í ô nơi bắt đầu phạm vi bảng.

rowSpan

integer

Khoảng hàng của dải ô trong bảng.

columnSpan

integer

Khoảng 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 các chỉ mục hàng bắt đầu từ 0 mà kiểu cần được cập nhật. Nếu bạn không chỉ định chỉ mục nào, thì tất cả các hàng sẽ được cập nhật.

tableRowStyle

object (TableRowStyle)

Kiểu cần đặt trên các hàng.

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. tableRowStyle gốc được ngầm hiểu và không được chỉ định. Bạn có thể dùng một "*" làm ký hiệu viết tắ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.

Khi bạn thay thế một hình ảnh, một số image effects sẽ bị xoá 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ã nhận dạng 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ó kích thước nhỏ hơn 50 MB, không được vượt quá 25 megapixel và phải ở định dạng PNG, JPEG hoặc GIF.

URI bạn cung cấp không được dài 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ế. Nếu bạn bỏ qua, yêu cầu sẽ được áp dụng cho thẻ đầu tiên.

Trong tài liệu chỉ có một thẻ:

  • Nếu được cung cấp, mã này phải khớp với mã nhận dạng của thẻ đơn lẻ.

  • Nếu bỏ qua, yêu cầu sẽ áp dụng cho thẻ đơn.

Trong một tài liệu có 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 tham số này, yêu cầu 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. Bạn 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 hiển thị 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 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ề DocumentStyle để 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. documentStyle gốc được ngầm hiểu và không được chỉ định. Bạn có thể dùng một "*" làm ký hiệu viết tắ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ị bỏ qua, yêu cầu sẽ áp dụng cho thẻ đầu tiên.

Trong tài liệu chỉ có một thẻ:

  • Nếu được cung cấp, mã này phải khớp với mã nhận dạng của thẻ đơn lẻ.

  • Nếu bỏ qua, yêu cầu sẽ áp dụng cho thẻ đơn.

Trong một tài liệu có 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 một 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ần hợp nhất trong bảng.

Mọi văn bản trong các ô đượ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 ô trong trường hợp khác.

Nếu dải ô không phải là hình chữ nhật (điều này 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 là hình chữ nhật), thì lỗi 400 bad request sẽ được trả về.

UnmergeTableCellsRequest

Huỷ hợp nhất các ô trong một 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ần tách trong bảng.

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

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 ô chưa 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 trong trường hợp khác.

CreateHeaderRequest

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

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

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 sẽ thuộc về. Nếu bạn chưa đặt "sectionBreakLocation" hoặc nếu bạn đặt "sectionBreakLocation" là dấu ngắt đoạ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 tiêu đề 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 mới sẽ được áp dụng cho DocumentStyle.

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

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 mà SectionStyle này thuộc về. Nếu bạn không đặt giá trị này hoặc giá trị này đề cập đến dấu ngắt phần đầ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.

Đoạn Footnote mới sẽ chứa một khoảng trắng, 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 nhóm 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 trạng thái sau:
location

object (Location)

Chèn phần tham chiếu đến 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 phần tham chiếu đến chú thích cuối trang vào bên trong ranh giới của một Paragraph hiện có. Ví dụ: bạn không thể chèn dấu ngắt dòng tại chỉ mục bắt đầu của bảng (tức là giữa bảng và đoạn văn trước đó).

Bạn không thể chèn phần tham chiếu đến chú thích cuối trang vào 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 chú thích vào phần nội dung, nên trường segment ID phải trống.

endOfSegmentLocation

object (EndOfSegmentLocation)

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

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

ReplaceNamedRangeContentRequest

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

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 sẽ được thay thế. Các dải ô khác và nội dung trong đó 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ệ, thì lỗi 400 yêu cầu không hợp lệ 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. Các tiêu chí dùng để chỉ định thẻ mà nội dung thay thế sẽ xuất hiện. Nếu bạn bỏ qua tham số này, thì thao tác thay thế sẽ áp dụng cho tất cả các thẻ.

Trong tài liệu chỉ có một thẻ:

  • Nếu được cung cấp, mã này phải khớp với mã nhận dạng của thẻ đơn lẻ.

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

Trong một tài liệu có 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, thao tác thay thế sẽ áp dụng cho tất cả các thẻ.

Trường nhóm replacement_content. Nội dung sẽ 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 trạng thái sau:
text

string

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

Trường nhóm 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ó thể là một trong những trạng thái sau:
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 nào có mã nhận dạng đã cho, thì lỗi 400 yêu cầu không hợp lệ sẽ được trả về.

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ê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 ô chồng lên các phần cần tạo kiểu.

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

sectionStyle

object (SectionStyle)

Các kiểu cần đặt trên phần.

Một số thay đổi về kiểu phầ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ề 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ầm hiểu và không được chỉ định. Bạn có thể dùng một "*" làm ký hiệu viết tắ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 dấu ngắt đoạn tại vị trí đã cho.

Ký tự dòng mới sẽ được chèn trước dấu ngắt phần.

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 nhóm insertion_location. Vị trí chèn điểm ngắt. insertion_location chỉ có thể là một trong những trạng thái sau:
location

object (Location)

Chèn một dòng mới và một dấu 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 đoạn trong phạm vi của một Paragraph hiện có. Ví dụ: bạn không thể chèn dấu ngắt dòng tại chỉ mục bắt đầu của bảng (tức là giữa bảng và đoạn văn trước đó).

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

Bạn không thể chèn dấu ngắt đoạn bên trong chú thích, tiêu đề hoặc chân trang. Vì bạn chỉ có thể chèn dấu ngắt phần vào bên trong 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ì thông tin tham chiếu đến tiêu đề này sẽ bị xoá, dẫn đến việc 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ì thông tin tham chiếu đến tiêu đề này sẽ bị xoá và tiêu đề của loại đó hiện được tiếp tục từ phần trước.

tabId

string

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

Trong tài liệu chỉ có một thẻ:

  • Nếu được cung cấp, mã này phải khớp với mã nhận dạng của thẻ đơn lẻ.

  • Nếu bỏ qua, yêu cầu sẽ áp dụng cho thẻ đơn.

Trong một tài liệu có 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 tham số này, yêu cầu 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ã nhận dạng của chân trang cần xoá. Nếu chân trang này được xác định trên DocumentStyle, thì thông tin tham chiếu đến chân trang này sẽ bị xoá, dẫn đến việc 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 một SectionStyle, thì thông tin 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á. Nếu bạn bỏ qua, yêu cầu sẽ được áp dụng cho thẻ đầu tiên.

Trong tài liệu chỉ có một thẻ:

  • Nếu được cung cấp, mã này phải khớp với mã nhận dạng của thẻ đơn lẻ.

  • Nếu bỏ qua, yêu cầu sẽ áp dụng cho thẻ đơn.

Trong một tài liệu có 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 tham số này, 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 đề đượ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í bắt đầu của bảng 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 không được ghim.

InsertPersonRequest

Chèn một lượt đề cập đến người dùng.

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

object (PersonProperties)

Các thuộc tính của phần đề cập đến người cần chèn.

Trường nhóm insertion_location. Vị trí mà tên người dùng được đề cập sẽ xuất hiện. insertion_location chỉ có thể là một trong những trạng thái sau:
location

object (Location)

Chèn thông tin đề cập đến người dùng tại một chỉ mục cụ thể trong tài liệu.

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

Bạn không thể chèn tên người dùng được đề cập vào trong phương trình.

endOfSegmentLocation

object (EndOfSegmentLocation)

Chèn thông tin đề cập đến người vào cuối tiêu đề, chân trang, chú thích hoặc nội dung tài liệu.