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 |
Trường | |
---|---|
Trường kết hợp
request . Yêu cầu cụ thể cần áp dụng. Bạn phải liên kết đúng một trường.
request
chỉ có thể là một trong các trạng thái sau:
|
|
replaceAllText
|
Thay thế tất cả các bản sao của văn bản đã chỉ định. |
insertText
|
Chèn văn bản tại vị trí đã chỉ định. |
updateTextStyle
|
Cập nhật kiểu văn bản ở dải ô được chỉ định. |
createParagraphBullets
|
Tạo dấu đầu dòng cho các đoạn văn bản. |
deleteParagraphBullets
|
Xoá dấu đầu dòng khỏi đoạn. |
createNamedRange
|
Tạo một dải ô được đặt tên. |
deleteNamedRange
|
Xoá một dải ô được đặt tên. |
updateParagraphStyle
|
Cập nhật kiểu đoạn văn tại dải ô được chỉ định. |
deleteContentRange
|
Xoá nội dung khỏi tài liệu. |
insertInlineImage
|
Chèn hình ảnh cùng dòng tại vị trí đã chỉ định. |
insertTable
|
Chèn một bảng ở vị trí đã chỉ định. |
insertTableRow
|
Chèn một hàng trống vào bảng. |
insertTableColumn
|
Chèn một cột trống vào bảng. |
deleteTableRow
|
Xoá một hàng khỏi bảng. |
deleteTableColumn
|
Xoá một cột khỏi bảng. |
insertPageBreak
|
Chèn một dấu ngắt trang tại vị trí được chỉ định. |
deletePositionedObject
|
Xoá đối tượng đã định vị khỏi tài liệu. |
updateTableColumnProperties
|
Cập nhật thuộc tính của các cột trong bảng. |
updateTableCellStyle
|
Cập nhật kiểu của các ô trong bảng. |
updateTableRowStyle
|
Cập nhật kiểu hàng trong bảng. |
replaceImage
|
Thay thế hình ảnh trong tài liệu. |
updateDocumentStyle
|
Cập nhật kiểu của tài liệu. |
mergeTableCells
|
Hợp nhất các ô trong bảng. |
unmergeTableCells
|
Huỷ hợp nhất các ô trong bảng. |
createHeader
|
Tạo tiêu đề. |
createFooter
|
Tạo chân trang. |
createFootnote
|
Tạo chú thích cuối trang. |
replaceNamedRangeContent
|
Thay thế nội dung trong dải ô được đặt tên. |
updateSectionStyle
|
Cập nhật kiểu mục của dải ô được chỉ định. |
insertSectionBreak
|
Chèn dấu ngắt mục tại vị trí đã chỉ định. |
deleteHeader
|
Xoá tiêu đề khỏi tài liệu. |
deleteFooter
|
Xoá một chân trang khỏi tài liệu. |
pinTableHeaderRows
|
Cập nhật số lượng hàng tiêu đề được ghim trong bảng. |
ReplaceAllTextRequest
Thay thế tất cả các lần xuất hiện của văn bản phù hợp với tiêu chí bằng
replace text
.
Biểu diễn dưới dạng JSON |
---|
{ "replaceText": string, "tabsCriteria": { object ( |
Trường | |
---|---|
replaceText
|
Văn bản sẽ thay thế văn bản phù hợp. |
tabsCriteria
|
Không bắt buộc. Tiêu chí dùng để chỉ định thẻ nào sẽ thay thế. Khi bị bỏ qua, thay thế sẽ áp dụng cho tất cả các thẻ. Trong tài liệu chỉ chứa một thẻ:
Trong một tài liệu chứa nhiều thẻ:
|
Trường kết hợp
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 loại sau:
|
|
containsText
|
Tìm văn bản trong tài liệu khớp với chuỗi con này. |
SubstringMatchCriteria
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
|
Văn bản cần tìm trong tài liệu. |
matchCase
|
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:
|
TabsCriteria
Tiêu chí chỉ định những thẻ nào sẽ thực thi một yêu cầu.
Biểu diễn dưới dạng JSON |
---|
{ "tabIds": [ string ] } |
Trường | |
---|---|
tabIds[]
|
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 |
Trường | |
---|---|
text
|
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 Kiểu văn bản cho văn bản được chèn sẽ được xác định tự động, thường giữ nguyên kiểu của văn bản bên cạnh. 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 Unicode Basic Multilingual Plane (U+E000-U+F8FF) sẽ bị xoá khỏi văn bản đã chèn. |
Trường hợp hợp nhất
insertion_location . Vị trí mà văn bản sẽ được chèn vào.
insertion_location
chỉ có thể là một trong các trạng thái sau:
|
|
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 |
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
|
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. |
index
|
Chỉ số bắt đầu từ 0, theo đơn vị mã UTF-16.
Chỉ mục tương ứng với đầu đoạn được chỉ định bởi
|
tabId
|
Thẻ chứa vị trí. Khi bạn 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ẻ:
Trong một tài liệu chứa nhiều thẻ:
|
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
|
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
|
Thẻ chứa vị trí. Khi bạn 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ẻ:
Trong một tài liệu chứa nhiều thẻ:
|
UpdateTextStyleRequest
Cập nhật kiểu văn bản.
Biểu diễn dưới dạng JSON |
---|
{ "textStyle": { object ( |
Trường | |
---|---|
textStyle
|
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 các thay đổi khác để phản ánh hành vi của trình chỉnh sửa Tài liệu. Xem tài liệu về
|
fields
|
Các trường cần cập nhật.
Bạn phải chỉ định ít nhất một trường.
Ví dụ: để cập nhật kiểu văn bản thành in đậm, hãy đặt
Để đặt lại một tài sản về giá trị mặc định, hãy đưa tên trường của tài sản đó vào mặt nạ trường nhưng không đặt 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 các trạng thái sau:
|
|
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. Bạn không thể chèn các dải ô 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 ghép của mỗi đoạn sẽ được xác định bằng cách đếm các thẻ ở đầu mỗi đoạ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. Điều này có thể làm 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 ( |
Trường | |
---|---|
range
|
Dải ô để áp dụng giá trị đặt trước cho dấu đầu dòng. |
bulletPreset
|
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.
Những mẫu này sử dụng các 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ó 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 thoi 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 điểm mã Unicode U+25cf -
SQUARE
: Một hình vuông đặc, tương ứng với một đ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, như "A", "B" hoặc "C". -
DECIMAL
: Một số, chẳng hạn như "1", "2" hoặc "3". -
ZERODECIMAL
: Số có tiền tố là số có một chữ số, 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
: Một chữ số la mã viết thường, 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
|
Chưa chỉ định giá trị đặt trước cho ký tự đầ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ó dấu đầu dòng chứa
DIAMONDX ,
ARROW3D
và
SQUARE
ký tự gạch đầu dòng 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 gồm
CHECKBOX
ký tự gạch đầu dòng cho tất cả các cấp độ lồng nhau của danh sách.
|
BULLET_ARROW_DIAMOND_DISC
|
Danh sách có dấu đầu dòng gồm
ARROW ,
DIAMOND
và
DISC
ký tự gạch đầu dòng 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 chứa
STAR ,
CIRCLE
và
SQUARE
ký tự gạch đầu dòng 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 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 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ó dấu đầu dòng với 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
|
Danh sách được đánh số có
DECIMAL ,
ALPHA
và
ROMAN
ký tự số 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ố có
DECIMAL ,
ALPHA
và
ROMAN
ký tự số cho 3 cấp độ lồng ghép danh sách đầu tiên, tiếp theo 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ố có
UPPERALPHA ,
ALPHA
và
ROMAN
ký tự số 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ố có
UPPERROMAN ,
UPPERALPHA
và
DECIMAL
ký tự số 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ố có
ZERODECIMAL ,
ALPHA
và
ROMAN
ký tự số 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.
Mức độ lồng ghép của mỗi đoạn sẽ được bảo toàn trực quan bằng cách thêm thụt lề vào đầu đoạn tương ứng.
Biểu diễn dưới dạng JSON |
---|
{
"range": {
object (
|
Trường | |
---|---|
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 (
|
Trường | |
---|---|
name
|
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
|
Dải ô áp dụng tên. |
DeleteNamedRangeRequest
Xoá một NamedRange
.
Biểu diễn dưới dạng JSON |
---|
{ "tabsCriteria": { object ( |
Trường | |
---|---|
tabsCriteria
|
Không bắt buộc. Tiêu chí dùng để chỉ định(các) thẻ nào sẽ bị xoá. Khi bạn bỏ qua, thao tác xoá dải ô sẽ áp dụng cho tất cả các thẻ. Trong tài liệu chỉ chứa một thẻ:
Trong một tài liệu chứa nhiều thẻ:
|
Trường hợp hợp nhất
named_range_reference . Giá trị xác định dải ô cần xoá. Bạn phải đặt chính xác một.
named_range_reference chỉ có thể là một trong những loại sau:
|
|
namedRangeId
|
Mã của dải ô được đặt tên cần xoá. |
name
|
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 ( |
Trường | |
---|---|
paragraphStyle
|
Kiểu cần đặt trên đoạ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ề |
fields
|
Các trường cần cập nhật.
Bạn phải chỉ định ít nhất một trường. Gốc
Ví dụ: để cập nhật thuộc tính căn chỉnh của kiểu đoạn văn bản, hãy đặt
Để đặt lại một tài sản về giá trị mặc định, hãy đưa tên trường của tài sản đó vào mặt nạ trường nhưng không đặt 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.
insertion_location
chỉ có thể là một trong các trạng thái sau:
|
|
range
|
Dải ô chồng chéo các đoạn vă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 (
|
Trường | |
---|---|
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. Một số ví dụ về yêu cầu xoá không hợp lệ bao gồm:
|
InsertInlineImageRequest
Chèn một
InlineObject
chứa hình ảnh tại một vị trí đã cho.
Biểu diễn dưới dạng JSON |
---|
{ "uri": string, "objectSize": { object ( |
Trường | |
---|---|
uri
|
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 nhỏ hơn 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. Bản thân URI được lưu cùng với hình ảnh và hiển thị thông qua
|
objectSize
|
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 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 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í sẽ chèn hình ảnh.
insertion_location chỉ có thể là một trong những loại sau:
|
|
location
|
Chèn hình ảnh tại 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 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
|
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 bảng tại 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 |
Trường | |
---|---|
rows
|
Số hàng trong bảng. |
columns
|
Số cột trong bảng. |
Trường kết hợp
insertion_location . Vị trí chèn bảng.
insertion_location
chỉ có thể là một trong các trạng thái sau:
|
|
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ảng phải được chèn bên trong ranh giới của bảng hiện có
Không thể chèn bảng vào chú thích cuối trang hoặc phương trình. |
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 (
|
Trường | |
---|---|
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 vào phía trên (hoặc bên dưới) hàng có ô tham chiếu. Nếu ô tham chiếu là một ô đã hợp nhất, một hàng mới sẽ được chèn vào phía trên (hoặc bên dưới) ô đã hợp nhất. |
insertBelow
|
Liệu có chèn hàng mới bên dưới vị trí ô tham chiếu hay không.
|
TableCellLocation
Vị trí của một ô trong bảng.
Biểu diễn dưới dạng JSON |
---|
{
"tableStartLocation": {
object (
|
Trường | |
---|---|
tableStartLocation
|
Vị trí nơi bảng bắt đầu trong tài liệu. |
rowIndex
|
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
|
Chỉ mục cột 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 (
|
Trường | |
---|---|
tableCellLocation
|
Vị trí ô trong bảng tham chiếu mà từ đó 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 chứa ô tham chiếu. Nếu ô tham chiếu là một ô đã hợp nhấ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
|
Liệu có chèn cột mới vào bên phải vị trí ô tham chiếu hay không.
|
DeleteTableRowRequest
Xoá một hàng khỏi bảng.
Biểu diễn dưới dạng JSON |
---|
{
"tableCellLocation": {
object (
|
Trường | |
---|---|
tableCellLocation
|
Vị trí ô trong bảng tham chiếu mà hàng sẽ bị xoá. Hàng kéo dài trong ô này sẽ bị xoá. Nếu đây là một ô được hợp nhất trải dài trên nhiều hàng, tất cả các hàng mà các hàng đó kéo dài sẽ bị xoá. Nếu không còn hàng nào trong bảng sau lần xoá này 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 (
|
Trường | |
---|---|
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à một ô được hợp nhất trải dài trên nhiều cột, tất cả các cột mà các ô này mở rộng sẽ bị xoá. Nếu không còn cột nào trong bảng sau khi bạn xoá thì toàn bộ bảng sẽ bị xoá. |
InsertPageBreakRequest
Chèn một dòng 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 |
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 loại sau:
|
|
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
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 bên trong phần nội dung, nên trường |
endOfSegmentLocation
|
Chèn ngắt trang vào cuối 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ì ngắt trang chỉ có thể được chèn bên trong phần nội dung, nên
|
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
|
Mã của đối tượng được định vị cần xoá. |
tabId
|
Thẻ chứa đối tượng đã đị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ẻ:
Trong một tài liệu chứa nhiều thẻ:
|
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 ( |
Trường | |
---|---|
tableStartLocation
|
Vị trí nơi bảng bắt đầu trong tài liệu. |
columnIndices[]
|
Danh sách các chỉ mục cột dựa trên 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
|
Các thuộc tính cột trong bảng cần cập nhật.
Nếu giá trị của
|
fields
|
Các trường cần cập nhật.
Bạn phải chỉ định ít nhất một trường.
Ví dụ: để cập nhật chiều rộng của cột, hãy đặt
|
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 ( |
Trường | |
---|---|
tableCellStyle
|
Kiểu để đặt trên các ô trong bảng. Khi cập nhật đường viền, nếu một ô có đường viền với một ô liền kề, 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:
|
fields
|
Các trường cần được cập nhật.
Bạn phải chỉ định ít nhất một trường.
Ví dụ: để cập nhật màu nền của ô trong bảng, hãy đặt
Để đặt lại một tài sản về giá trị mặc định, hãy đưa tên trường của tài sản đó vào mặt nạ trường nhưng không đặt trường đó. |
Trường hợp hợp nhất
cells . Các ô sẽ được cập nhật.
cells chỉ có thể là một trong những loại sau:
|
|
tableRange
|
Dải ô của 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
|
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 (
|
Trường | |
---|---|
tableCellLocation
|
Vị trí ô nơi dải ô của bảng bắt đầu. |
rowSpan
|
Độ dài hàng của dải ô của bảng. |
columnSpan
|
Số cột của dải ô trong bảng. |
UpdateTableRowStyleRequest
Cập nhật
TableRowStyle
hàng trong bảng.
Biểu diễn dưới dạng JSON |
---|
{ "tableStartLocation": { object ( |
Trường | |
---|---|
tableStartLocation
|
Vị trí nơi bảng bắt đầu trong tài liệu. |
rowIndices[]
|
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 không có chỉ mục nào được chỉ định, tất cả các hàng sẽ được cập nhật. |
tableRowStyle
|
Kiểu sẽ được đặt trên các hàng. |
fields
|
Các trường cần cập nhật.
Bạn phải chỉ định ít nhất một trường.
Ví dụ: để cập nhật chiều cao tối thiểu của hàng, hãy đặt |
ReplaceImageRequest
Thay thế hình ảnh hiện tại bằng hình ảnh mới.
Việc thay thế một hình ảnh sẽ xoá một số
image effects
từ 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 (
|
Trường | |
---|---|
imageObjectId
|
Mã của hình ảnh hiện có sẽ được thay thế. Mã nhận dạng có thể được truy xuất từ phản hồi của một yêu cầu nhận. |
uri
|
URI của hình ảnh mới. 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 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 đượ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 |
imageReplaceMethod
|
Phương thức thay thế. |
tabId
|
Thẻ chứa hình ảnh cần thay thế. Khi bạn 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ẻ:
Trong một tài liệu chứa nhiều thẻ:
|
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 theo tỷ lệ và căn giữa hình ảnh để lấp đầy các 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 (
|
Trường | |
---|---|
documentStyle
|
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ề |
fields
|
Các trường cần được cập nhật.
Bạn phải chỉ định ít nhất một trường. Gốc
Ví dụ: để cập nhật nền, hãy đặt
|
tabId
|
Thẻ chứa kiểu cần cập nhật. Khi bị bỏ qua, yêu cầu sẽ áp dụng cho thẻ đầu tiên. Trong tài liệu chỉ chứa một thẻ:
Trong một tài liệu chứa nhiều thẻ:
|
MergeTableCellsRequest
Hợp nhất các ô trong một
Table
.
Biểu diễn dưới dạng JSON |
---|
{
"tableRange": {
object (
|
Trường | |
---|---|
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 "phần đầu" ô của dải ô. Đây là ô phía trên 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 bên phải của dải ô nếu ngược lại. Nếu dải ô không phải là 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 là 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 ô trong
Table
.
Biểu diễn dưới dạng JSON |
---|
{
"tableRange": {
object (
|
Trường | |
---|---|
tableRange
|
Dải ô của bảng chỉ định các ô trong 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 ra 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ỳ ô đã hợp nhất nào, thì văn bản đó sẽ vẫn nằm trong "đầu" ô của khối kết quả gồm các ô chưa hợp nhất. Biểu tượng "đầu" ô là ô phía trên bên trái khi hướng nội dung là từ trái sang phải và là ô phía trên bên phải nếu không có hướng nội dung. |
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 thì 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ì 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 ( |
Trường | |
---|---|
type
|
Loại tiêu đề cần tạo. |
sectionBreakLocation
|
Vị trí của |
CreateFootnoteRequest
Tạo một
Footnote
và chèn một đoạn mã mới
FootnoteReference
tại vị trí đã cho.
Gói thuê bao mới
Footnote
phân đoạn sẽ chứa một dấu cách theo sau là một ký tự dòng mới.
Biểu diễn dưới dạng JSON |
---|
{ // Union field |
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 các trạng thái sau:
|
|
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 phần tham chiếu đến chú thích cuối trang vào bên trong giới hạn của thuộc tính hiện có
Bạn không thể chèn phần tham chiếu đến chú thích cuối trang vào bên trong một phương trình, đầu trang, chân trang hoặc chú thích cuối trang. Vì phần tham chiếu đến chú thích cuối trang chỉ có thể được chèn vào phần nội dung, nên
|
endOfSegmentLocation
|
Chèn phần tham chiếu đế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 tiêu đề, 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 |
ReplaceNamedRangeContentRequest
Thay thế nội dung của các thành phần được chỉ định
NamedRange
hoặc
NamedRanges
bằng nội dung thay thế cụ thể.
Xin lưu ý rằng mỗi người
NamedRange
có thể bao gồm nhiều lần gián đoạn
ranges
. 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 dẫn đến cấu trúc tài liệu không hợp lệ, thì 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 ( |
Trường | |
---|---|
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ỉ chứa một thẻ:
Trong một tài liệu chứa nhiều 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 các trạng thái sau:
|
|
text
|
Thay thế nội dung của(các) dải ô được đặt tên được chỉ định bằng văn bản đã cho. |
Trường kết hợp
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 các trạng thái sau:
|
|
namedRangeId
|
Mã của dải ô được đặt tên có nội dung sẽ bị 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
|
Tên của
Nếu có nhiều |
UpdateSectionStyleRequest
Cập nhật
SectionStyle
.
Biểu diễn dưới dạng JSON |
---|
{ "range": { object ( |
Trường | |
---|---|
range
|
Dải ô chồng chéo các phần cần tạo 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 |
sectionStyle
|
Các kiểu sẽ được đặt trên phần.
Một số thay đổi về kiểu của phầ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ề |
fields
|
Các trường cần cập nhật.
Bạn phải chỉ định ít nhất một trường. Gốc
Ví dụ: để cập nhật lề trái, hãy đặt
|
InsertSectionBreakRequest
Chèn dấu ngắt mục 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 ( |
Trường | |
---|---|
sectionType
|
Loại phần cần chèn. |
Trường hợp hợp nhất
insertion_location . Vị trí sẽ chèn điểm ngắt.
insertion_location
chỉ có thể là một trong các trạng thái sau:
|
|
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 ranh giới của thuộc tính hiện có
Bạn không thể chèn dấu ngắt mục vào trong bảng, phương trình, chú thích cuối trang, đầu trang hoặc chân trang. Vì dấu ngắt phần chỉ có thể được chèn vào trong phần nội dung, nên
|
endOfSegmentLocation
|
Chèn một dòng mới và ngắt phần ở cuối nội dung tài liệu.
Không thể chèn ngắt mục bên trong chú thích cuối trang, đầu trang hoặc chân trang. Do ngắt phần chỉ có thể được chèn vào trong phần nội dung, nên
|
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
|
Mã của tiêu đề cần xoá. Nếu tiêu đề này được xác định trên
|
tabId
|
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ẻ:
Trong một tài liệu chứa nhiều thẻ:
|
PinTableHeaderRowsRequest
Cập nhật số lượng hàng tiêu đề bảng đã ghim trong một bảng.
Biểu diễn dưới dạng JSON |
---|
{
"tableStartLocation": {
object (
|
Trường | |
---|---|
tableStartLocation
|
Vị trí nơi bảng bắt đầu trong tài liệu. |
pinnedHeaderRowsCount
|
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. |