Permintaan
Satu update yang akan diterapkan ke dokumen.
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union
request . Permintaan khusus yang akan diterapkan. Hanya satu kolom yang wajib diisi.
request
hanya dapat berupa salah satu dari hal berikut:
|
|
replaceAllText
|
Mengganti semua instance teks yang ditentukan. |
insertText
|
Menyisipkan teks di lokasi yang ditentukan. |
updateTextStyle
|
Memperbarui gaya teks di rentang yang ditentukan. |
createParagraphBullets
|
Membuat poin untuk paragraf. |
deleteParagraphBullets
|
Menghapus butir dari paragraf. |
createNamedRange
|
Membuat rentang bernama. |
deleteNamedRange
|
Menghapus rentang bernama. |
updateParagraphStyle
|
Memperbarui gaya paragraf pada rentang yang ditentukan. |
deleteContentRange
|
Menghapus konten dari dokumen. |
insertInlineImage
|
Menyisipkan gambar sisipan di lokasi yang ditentukan. |
insertTable
|
Menyisipkan tabel di lokasi yang ditentukan. |
insertTableRow
|
Menyisipkan baris kosong ke dalam tabel. |
insertTableColumn
|
Menyisipkan kolom kosong ke dalam tabel. |
deleteTableRow
|
Menghapus baris dari tabel. |
deleteTableColumn
|
Menghapus kolom dari tabel. |
insertPageBreak
|
Menyisipkan batas halaman di lokasi yang ditentukan. |
deletePositionedObject
|
Menghapus objek yang diposisikan dari dokumen. |
updateTableColumnProperties
|
Memperbarui properti kolom dalam tabel. |
updateTableCellStyle
|
Memperbarui gaya sel tabel. |
updateTableRowStyle
|
Memperbarui gaya baris dalam tabel. |
replaceImage
|
Mengganti gambar dalam dokumen. |
updateDocumentStyle
|
Memperbarui gaya dokumen. |
mergeTableCells
|
Menggabungkan sel dalam tabel. |
unmergeTableCells
|
Memisahkan sel dalam tabel. |
createHeader
|
Membuat header. |
createFooter
|
Membuat footer. |
createFootnote
|
Membuat catatan kaki. |
replaceNamedRangeContent
|
Mengganti konten dalam rentang bernama. |
updateSectionStyle
|
Memperbarui gaya bagian rentang yang ditentukan. |
insertSectionBreak
|
Menyisipkan batas bagian di lokasi yang ditentukan. |
deleteHeader
|
Menghapus header dari dokumen. |
deleteFooter
|
Menghapus footer dari dokumen. |
pinTableHeaderRows
|
Memperbarui jumlah baris header yang disematkan dalam tabel. |
ReplaceAllTextRequest
Mengganti semua teks yang cocok dengan kriteria dengan
replace text
.
Representasi JSON |
---|
{ "replaceText": string, "tabsCriteria": { object ( |
Kolom | |
---|---|
replaceText
|
Teks yang akan menggantikan teks yang cocok. |
tabsCriteria
|
Opsional. Kriteria yang digunakan untuk menentukan di tab mana penggantian terjadi. Jika dihilangkan, penggantian berlaku untuk semua tab. Dalam dokumen yang berisi satu tab:
Dalam dokumen yang berisi beberapa tab:
|
Kolom union
criteria . Kriteria yang digunakan untuk mencocokkan teks yang akan diganti.
criteria
hanya dapat berupa salah satu dari hal berikut:
|
|
containsText
|
Menemukan teks dalam dokumen yang cocok dengan substring ini. |
SubstringMatchCriteria
Kriteria yang cocok dengan {i>string<i} teks tertentu dalam dokumen.
Representasi JSON |
---|
{ "text": string, "matchCase": boolean } |
Kolom | |
---|---|
text
|
Teks yang akan ditelusuri dalam dokumen. |
matchCase
|
Menunjukkan apakah penelusuran harus mematuhi huruf besar/kecil:
|
TabsCriteria
Kriteria yang menentukan tab tempat permintaan dijalankan.
Representasi JSON |
---|
{ "tabIds": [ string ] } |
Kolom | |
---|---|
tabIds[]
|
Daftar ID tab tempat permintaan dijalankan. |
InsertTextRequest
Menyisipkan teks di lokasi yang ditentukan.
Representasi JSON |
---|
{ "text": string, // Union field |
Kolom | |
---|---|
text
|
Teks yang akan disisipkan.
Menyisipkan karakter baris baru secara implisit akan membuat baris baru
Gaya teks untuk teks yang disisipkan akan ditentukan secara otomatis, umumnya mempertahankan gaya teks di dekatnya. Umumnya, gaya teks untuk teks yang disisipkan akan cocok dengan teks persis sebelum indeks penyisipan. Beberapa karakter kontrol (U+0000-U+0008, U+000C-U+001F) dan karakter dari Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) akan dihilangkan dari teks yang disisipkan. |
Kolom union
insertion_location . Lokasi tempat teks akan disisipkan.
insertion_location
hanya dapat berupa salah satu dari hal berikut:
|
|
location
|
Menyisipkan teks pada indeks tertentu dalam dokumen.
Teks harus disisipkan dalam batas yang ada
|
endOfSegmentLocation
|
Menyisipkan teks di akhir header, footer, catatan kaki, atau isi dokumen. |
Lokasi
Lokasi tertentu dalam dokumen.
Representasi JSON |
---|
{ "segmentId": string, "index": integer, "tabId": string } |
Kolom | |
---|---|
segmentId
|
ID header, footer, atau catatan kaki tempat lokasi berada. ID segmen kosong menandakan isi dokumen. |
index
|
Indeks berbasis nol, dalam unit kode UTF-16.
Indeks relatif terhadap awal segmen yang ditetapkan oleh
|
tabId
|
Tab tempat lokasi berada. Jika dihilangkan, permintaan akan diterapkan ke tab pertama. Dalam dokumen yang berisi satu tab:
Dalam dokumen yang berisi beberapa tab:
|
EndOfSegmentLocation
Lokasi di akhir isi, header, footer, atau catatan kaki. Lokasi berada tepat sebelum baris baru terakhir dalam segmen dokumen.
Representasi JSON |
---|
{ "segmentId": string, "tabId": string } |
Kolom | |
---|---|
segmentId
|
ID header, footer, atau catatan kaki tempat lokasi berada. ID segmen kosong menandakan isi dokumen. |
tabId
|
Tab tempat lokasi berada. Jika dihilangkan, permintaan akan diterapkan ke tab pertama. Dalam dokumen yang berisi satu tab:
Dalam dokumen yang berisi beberapa tab:
|
UpdateTextStyleRequest
Perbarui gaya visual teks.
Representasi JSON |
---|
{ "textStyle": { object ( |
Kolom | |
---|---|
textStyle
|
Gaya yang akan ditetapkan pada teks. Jika nilai untuk gaya tertentu cocok dengan gaya induk, gaya tersebut akan ditetapkan untuk diwariskan.
Perubahan gaya teks tertentu dapat menyebabkan perubahan lain yang dapat mencerminkan perilaku editor Dokumen. Lihat dokumentasi tentang
|
fields
|
Kolom yang harus diperbarui.
Setidaknya satu kolom harus ditentukan. Akar
Misalnya, untuk memperbarui gaya teks menjadi tebal, atur
Untuk mereset properti ke nilai defaultnya, sertakan nama kolomnya di mask kolom, tetapi jangan tetapkan kolom itu sendiri. |
Kolom union
insertion_location . Jenis rentang yang digunakan untuk memperbarui gaya teks.
insertion_location
hanya dapat berupa salah satu dari hal berikut:
|
|
range
|
Rentang teks yang akan ditata gayanya. Rentang ini dapat diperluas untuk menyertakan baris baru yang bersebelahan. Jika rentang sepenuhnya berisi paragraf yang termasuk dalam daftar, poin paragraf juga diperbarui dengan gaya teks yang cocok. Rentang tidak dapat disisipkan di dalam UpdateTextStyleRequest relatif. |
CreateParagraphBulletsRequest
Membuat poin untuk semua paragraf yang tumpang-tindih dengan rentang yang ditentukan.
Tingkat bertingkat setiap paragraf akan ditentukan dengan menghitung tab utama di depan setiap paragraf. Untuk menghindari spasi berlebih antara butir dan paragraf yang sesuai, tab utama ini akan dihapus oleh permintaan ini. Ini dapat mengubah indeks bagian-bagian teks.
Jika paragraf tepat sebelum paragraf diperbarui berada dalam daftar dengan preset yang cocok, paragraf yang diperbarui akan ditambahkan ke daftar sebelumnya.
Representasi JSON |
---|
{ "range": { object ( |
Kolom | |
---|---|
range
|
Rentang tempat preset butir akan diterapkan. |
bulletPreset
|
Jenis bullet glyph yang akan digunakan. |
BulletGlyphPreset
Pola preset bullet glyph untuk daftar.
Pola-pola ini menggunakan jenis butir berikut:
-
ARROW
: Tanda panah, yang sesuai dengan titik kode Unicode U+2794 -
ARROW3D
: Tanda panah dengan bayangan 3D, sesuai dengan titik kode Unicode U+27a2 -
CHECKBOX
: Persegi berongga yang sesuai dengan titik kode Unicode U+274f -
CIRCLE
: Lingkaran kosong, yang sesuai dengan titik kode Unicode U+25cb -
DIAMOND
: Berlian solid, sesuai dengan poin kode Unicode U+25c6 -
DIAMONDX
: Berlian dengan 'x', yang sesuai dengan titik kode Unicode U+2756 -
HOLLOWDIAMOND
: Berlian berongga, sesuai dengan titik kode Unicode U+25c7 -
DISC
: Lingkaran solid, sesuai dengan titik kode Unicode U+25cf -
SQUARE
: Persegi solid, yang sesuai dengan titik kode Unicode U+25a0 -
STAR
: Bintang, yang sesuai dengan titik kode Unicode U+2605 -
ALPHA
: Huruf kecil, seperti 'a', 'b', atau 'c'. -
UPPERALPHA
: Huruf besar, seperti 'A', 'B', atau 'C'. -
DECIMAL
: Angka, seperti '1', '2', atau '3'. -
ZERODECIMAL
: Angka dengan angka nol yang diawali dengan angka nol, seperti '01', '02', atau '03'. Angka yang memiliki lebih dari satu digit tidak diawali dengan angka nol. -
ROMAN
: Angka romawi kecil, seperti 'i', 'ii', atau 'iii'. -
UPPERROMAN
: Angka romawi besar, seperti 'I', 'II', atau 'III'. -
LEFTTRIANGLE
: Segitiga mengarah ke kiri, sesuai dengan titik kode Unicode U+25c4
Enum | |
---|---|
BULLET_GLYPH_PRESET_UNSPECIFIED
|
Preset glyph butir tidak ditentukan. |
BULLET_DISC_CIRCLE_SQUARE
|
Daftar berbutir dengan
DISC ,
CIRCLE
dan
SQUARE
glyph butir untuk 3 tingkat penyusunan daftar pertama.
|
BULLET_DIAMONDX_ARROW3D_SQUARE
|
Daftar berbutir dengan
DIAMONDX ,
ARROW3D
dan
SQUARE
glyph butir untuk 3 tingkat penyusunan daftar pertama.
|
BULLET_CHECKBOX
|
Daftar berbutir dengan
CHECKBOX
glyph butir untuk semua tingkat susunan daftar.
|
BULLET_ARROW_DIAMOND_DISC
|
Daftar berbutir dengan
ARROW ,
DIAMOND
dan
DISC
glyph butir untuk 3 tingkat penyusunan daftar pertama.
|
BULLET_STAR_CIRCLE_SQUARE
|
Daftar berbutir dengan
STAR ,
CIRCLE
dan
SQUARE
glyph butir untuk 3 tingkat penyusunan daftar pertama.
|
BULLET_ARROW3D_CIRCLE_SQUARE
|
Daftar berbutir dengan
ARROW3D ,
CIRCLE
dan
SQUARE
glyph butir untuk 3 tingkat penyusunan daftar pertama.
|
BULLET_LEFTTRIANGLE_DIAMOND_DISC
|
Daftar berbutir dengan
LEFTTRIANGLE ,
DIAMOND
dan
DISC
glyph butir untuk 3 tingkat penyusunan daftar pertama.
|
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE
|
Daftar berbutir dengan
DIAMONDX ,
HOLLOWDIAMOND
dan
SQUARE
glyph butir untuk 3 tingkat penyusunan daftar pertama.
|
BULLET_DIAMOND_CIRCLE_SQUARE
|
Daftar berbutir dengan
DIAMOND ,
CIRCLE
dan
SQUARE
glyph butir untuk 3 tingkat penyusunan daftar pertama.
|
NUMBERED_DECIMAL_ALPHA_ROMAN
|
Daftar bernomor dengan
DECIMAL ,
ALPHA
dan
ROMAN
glyph numerik untuk 3 tingkat penyusunan daftar pertama, diikuti dengan titik.
|
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS
|
Daftar bernomor dengan
DECIMAL ,
ALPHA
dan
ROMAN
glyph numerik untuk 3 tingkat penyusunan daftar pertama, diikuti dengan tanda kurung.
|
NUMBERED_DECIMAL_NESTED
|
Daftar bernomor dengan
DECIMAL
glyph numerik yang dipisahkan oleh titik, yang masing-masing tingkatannya menggunakan glyph tingkat bertingkat sebelumnya sebagai awalan. Misalnya: '1.', '1.1.', "2". '2.2.'.
|
NUMBERED_UPPERALPHA_ALPHA_ROMAN
|
Daftar bernomor dengan
UPPERALPHA ,
ALPHA
dan
ROMAN
glyph numerik untuk 3 tingkat penyusunan daftar pertama, diikuti dengan titik.
|
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL
|
Daftar bernomor dengan
UPPERROMAN ,
UPPERALPHA
dan
DECIMAL
glyph numerik untuk 3 tingkat penyusunan daftar pertama, diikuti dengan titik.
|
NUMBERED_ZERODECIMAL_ALPHA_ROMAN
|
Daftar bernomor dengan
ZERODECIMAL ,
ALPHA
dan
ROMAN
glyph numerik untuk 3 tingkat penyusunan daftar pertama, diikuti dengan titik.
|
DeleteParagraphBulletsRequest
Menghapus poin dari semua paragraf yang tumpang-tindih dengan rentang yang ditentukan.
Tingkat bertingkat setiap paragraf akan dipertahankan secara visual dengan menambahkan indentasi ke awal paragraf yang sesuai.
Representasi JSON |
---|
{
"range": {
object (
|
Kolom | |
---|---|
range
|
Rentang untuk menghapus butir. |
CreateNamedRangeRequest
Membuat
NamedRange
merujuk ke rentang yang diberikan.
Representasi JSON |
---|
{
"name": string,
"range": {
object (
|
Kolom | |
---|---|
name
|
Nama NamedRange. Nama tidak harus unik. Nama harus memiliki minimal 1 karakter dan tidak lebih dari 256 karakter, yang diukur dalam unit kode UTF-16. |
range
|
Rentang untuk menerapkan nama. |
DeleteNamedRangeRequest
Menghapus
NamedRange
.
Representasi JSON |
---|
{ "tabsCriteria": { object ( |
Kolom | |
---|---|
tabsCriteria
|
Opsional. Kriteria yang digunakan untuk menentukan di tab mana penghapusan rentang harus terjadi. Jika dihilangkan, penghapusan rentang akan diterapkan ke semua tab. Dalam dokumen yang berisi satu tab:
Dalam dokumen yang berisi beberapa tab:
|
Kolom union
named_range_reference . Nilai yang menentukan rentang atau rentang yang akan dihapus. Hanya satu harus ditetapkan.
named_range_reference
hanya dapat berupa salah satu dari hal berikut:
|
|
namedRangeId
|
ID rentang bernama yang akan dihapus. |
name
|
Nama rentang yang akan dihapus. Semua rentang bernama yang memiliki nama tertentu akan dihapus. |
UpdateParagraphStyleRequest
Perbarui gaya semua paragraf yang tumpang-tindih dengan rentang tertentu.
Representasi JSON |
---|
{ "paragraphStyle": { object ( |
Kolom | |
---|---|
paragraphStyle
|
Gaya yang akan ditetapkan pada paragraf.
Perubahan gaya paragraf tertentu dapat menyebabkan perubahan lain guna mencerminkan perilaku editor Dokumen. Lihat dokumentasi tentang
|
fields
|
Kolom yang harus diperbarui.
Setidaknya satu kolom harus ditentukan. Akar
Misalnya, untuk memperbarui properti perataan gaya paragraf, tetapkan
Untuk mereset properti ke nilai defaultnya, sertakan nama kolomnya di mask kolom, tetapi jangan tetapkan kolom itu sendiri. |
Kolom union
insertion_location . Jenis rentang yang digunakan untuk memperbarui gaya paragraf.
insertion_location
hanya dapat berupa salah satu dari hal berikut:
|
|
range
|
Rentang tumpang-tindih dengan paragraf yang akan ditata gayanya. |
DeleteContentRangeRequest
Menghapus konten dari dokumen.
Representasi JSON |
---|
{
"range": {
object (
|
Kolom | |
---|---|
range
|
Rentang konten yang akan dihapus. Menghapus teks yang melintasi batas paragraf dapat menyebabkan perubahan pada gaya paragraf, daftar, objek yang diposisikan, dan bookmark saat dua paragraf digabungkan. Upaya menghapus rentang tertentu dapat mengakibatkan struktur dokumen yang tidak valid, yang dalam hal ini ditunjukkan kesalahan permintaan buruk 400. Beberapa contoh permintaan penghapusan yang tidak valid meliputi:
|
InsertInlineImageRequest
Menyisipkan
InlineObject
yang berisi gambar di lokasi yang diberikan.
Representasi JSON |
---|
{ "uri": string, "objectSize": { object ( |
Kolom | |
---|---|
uri
|
URI gambar. Gambar diambil satu kali pada waktu penyisipan dan salinannya disimpan untuk ditampilkan di dalam dokumen. Gambar harus berukuran kurang dari 50 MB, tidak boleh lebih dari 25 megapiksel, dan harus dalam format PNG, JPEG, atau GIF.
URI yang disediakan harus dapat diakses secara publik dan panjangnya maksimal 2 kB. URI itu sendiri disimpan bersama gambar, dan diekspos melalui
|
objectSize
|
Ukuran gambar yang seharusnya terlihat dalam dokumen. Properti ini bersifat opsional dan ukuran akhir gambar dalam dokumen ditentukan berdasarkan aturan berikut: * Jika lebar atau tinggi tidak ditentukan, ukuran default gambar akan dihitung berdasarkan resolusinya. * Jika satu dimensi ditentukan, dimensi lainnya akan dihitung untuk mempertahankan rasio aspek gambar. * Jika lebar dan tinggi ditetapkan, gambar akan diskalakan agar sesuai dengan dimensi yang disediakan, dengan tetap mempertahankan rasio aspeknya. |
Kolom union
insertion_location . Lokasi tempat gambar akan dimasukkan.
insertion_location
hanya dapat berupa salah satu dari hal berikut:
|
|
location
|
Menyisipkan gambar pada indeks tertentu dalam dokumen.
Gambar harus dimasukkan ke dalam batas yang ada
Gambar inline tidak dapat disisipkan di dalam catatan kaki atau persamaan. |
endOfSegmentLocation
|
Menyisipkan teks di akhir header, footer, atau badan dokumen. Gambar inline tidak dapat disisipkan di dalam catatan kaki. |
InsertTableRequest
Menyisipkan tabel di lokasi yang ditentukan.
Karakter baris baru akan disisipkan sebelum tabel yang disisipkan.
Representasi JSON |
---|
{ "rows": integer, "columns": integer, // Union field |
Kolom | |
---|---|
rows
|
Jumlah baris dalam tabel. |
columns
|
Jumlah kolom di tabel. |
Kolom union
insertion_location . Lokasi tempat tabel akan dimasukkan.
insertion_location
hanya dapat berupa salah satu dari hal berikut:
|
|
location
|
Menyisipkan tabel pada indeks model tertentu. Karakter baris baru akan disisipkan sebelum tabel yang disisipkan, sehingga indeks awal tabel akan berada pada indeks lokasi yang ditentukan + 1.
Tabel harus dimasukkan ke dalam batas yang ada
Tabel tidak dapat disisipkan di dalam catatan kaki atau persamaan. |
endOfSegmentLocation
|
Menyisipkan tabel di akhir header, footer, atau isi dokumen yang ditentukan. Karakter baris baru akan disisipkan sebelum tabel yang disisipkan. Tabel tidak dapat disisipkan di dalam catatan kaki. |
InsertTableRowRequest
Menyisipkan baris kosong ke dalam tabel.
Representasi JSON |
---|
{
"tableCellLocation": {
object (
|
Kolom | |
---|---|
tableCellLocation
|
Lokasi sel tabel referensi tempat baris akan disisipkan. Baris baru akan disisipkan di atas (atau di bawah) baris tempat sel referensi berada. Jika sel referensi adalah sel yang digabungkan, baris baru akan disisipkan di atas (atau di bawah) sel yang digabungkan. |
insertBelow
|
Apakah akan menyisipkan baris baru di bawah lokasi sel referensi.
|
TableCellLocation
Lokasi satu sel dalam tabel.
Representasi JSON |
---|
{
"tableStartLocation": {
object (
|
Kolom | |
---|---|
tableStartLocation
|
Lokasi tempat tabel dimulai dalam dokumen. |
rowIndex
|
Indeks baris berbasis nol. Misalnya, baris kedua dalam tabel memiliki indeks baris 1. |
columnIndex
|
Indeks kolom berbasis nol. Misalnya, kolom kedua dalam tabel memiliki indeks kolom 1. |
InsertTableColumnRequest
Menyisipkan kolom kosong ke dalam tabel.
Representasi JSON |
---|
{
"tableCellLocation": {
object (
|
Kolom | |
---|---|
tableCellLocation
|
Lokasi sel tabel referensi tempat kolom akan disisipkan. Kolom baru akan disisipkan di sebelah kiri (atau kanan) kolom tempat sel referensi berada. Jika sel referensi adalah sel yang digabungkan, kolom baru akan disisipkan di sebelah kiri (atau kanan) sel yang digabungkan. |
insertRight
|
Apakah akan menyisipkan kolom baru di sebelah kanan lokasi sel referensi.
|
DeleteTableRowRequest
Menghapus baris dari tabel.
Representasi JSON |
---|
{
"tableCellLocation": {
object (
|
Kolom | |
---|---|
tableCellLocation
|
Lokasi sel tabel referensi tempat baris akan dihapus. Baris yang dicakup sel ini akan dihapus. Jika ini adalah sel gabungan yang mencakup beberapa baris, semua baris yang mencakup sel tersebut akan dihapus. Jika tidak ada baris yang tersisa pada tabel setelah penghapusan ini, seluruh tabel akan dihapus. |
DeleteTableColumnRequest
Menghapus kolom dari tabel.
Representasi JSON |
---|
{
"tableCellLocation": {
object (
|
Kolom | |
---|---|
tableCellLocation
|
Lokasi sel tabel referensi tempat kolom akan dihapus. Kolom yang dicakup sel ini akan dihapus. Jika ini adalah sel gabungan yang mencakup beberapa kolom, semua kolom yang mencakup sel tersebut akan dihapus. Jika tidak ada kolom yang tersisa pada tabel setelah penghapusan ini, seluruh tabel akan dihapus. |
InsertPageBreakRequest
Menyisipkan batas halaman yang diikuti dengan baris baru di lokasi yang ditentukan.
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union
insertion_location . Lokasi tempat batas halaman akan disisipkan.
insertion_location
hanya dapat berupa salah satu dari hal berikut:
|
|
location
|
Menyisipkan batas halaman pada indeks tertentu dalam dokumen.
Batas halaman harus dimasukkan ke dalam batas yang ada
Batas halaman tidak dapat disisipkan di dalam tabel, persamaan, catatan kaki, header, atau footer. Karena batas halaman hanya dapat dimasukkan ke dalam isi,
|
endOfSegmentLocation
|
Menyisipkan batas halaman di akhir isi dokumen.
Batas halaman tidak dapat disisipkan di dalam catatan kaki, header, atau footer. Karena batas halaman hanya dapat dimasukkan ke dalam isi,
|
DeletePositionedObjectRequest
Menghapus
PositionedObject
dari dokumen.
Representasi JSON |
---|
{ "objectId": string, "tabId": string } |
Kolom | |
---|---|
objectId
|
ID objek yang diposisikan akan dihapus. |
tabId
|
Tab tempat objek yang diposisikan untuk dihapus berada. Jika dihilangkan, permintaan akan diterapkan ke tab pertama. Dalam dokumen yang berisi satu tab:
Dalam dokumen yang berisi beberapa tab:
|
UpdateTableColumnPropertiesRequest
Memperbarui
TableColumnProperties
kolom di sebuah tabel.
Representasi JSON |
---|
{ "tableStartLocation": { object ( |
Kolom | |
---|---|
tableStartLocation
|
Lokasi tempat tabel dimulai dalam dokumen. |
columnIndices[]
|
Daftar indeks kolom berbasis nol yang propertinya harus diperbarui. Jika tidak ada indeks yang ditentukan, semua kolom akan diperbarui. |
tableColumnProperties
|
Properti kolom tabel yang akan diperbarui.
Jika nilai
|
fields
|
Kolom yang harus diperbarui.
Setidaknya satu kolom harus ditentukan. Akar
Misalnya untuk memperbarui lebar kolom, atur
|
UpdateTableCellStyleRequest
Memperbarui gaya rentang sel tabel.
Representasi JSON |
---|
{ "tableCellStyle": { object ( |
Kolom | |
---|---|
tableCellStyle
|
Gaya yang akan ditetapkan pada sel tabel. Saat memperbarui batas, jika sel berbagi batas dengan sel yang bersebelahan, properti batas yang sesuai dengan sel yang bersebelahan juga akan diperbarui. Batas yang digabungkan dan tidak terlihat tidak diperbarui. Karena memperbarui batas yang dibagi oleh sel berdekatan dalam permintaan yang sama dapat menyebabkan pembaruan perbatasan yang bertentangan, pembaruan batas diterapkan dalam urutan berikut:
|
fields
|
Kolom yang harus diperbarui.
Setidaknya satu kolom harus ditentukan. Akar
Misalnya, untuk memperbarui warna latar belakang sel tabel, setel
Untuk mereset properti ke nilai defaultnya, sertakan nama kolomnya di mask kolom, tetapi jangan tetapkan kolom itu sendiri. |
Kolom union
cells . Sel yang akan diupdate.
cells
hanya dapat berupa salah satu dari hal berikut:
|
|
tableRange
|
Rentang tabel yang mewakili subset tabel tempat update diterapkan. |
tableStartLocation
|
Lokasi tempat tabel dimulai dalam dokumen. Jika ditentukan, pembaruan akan diterapkan ke semua sel dalam tabel. |
TableRange
Rentang tabel mewakili referensi ke subkumpulan tabel.
Penting untuk diperhatikan bahwa sel yang ditentukan oleh rentang tabel tidak selalu berbentuk persegi panjang. Misalnya, katakanlah kita memiliki tabel 3 x 3 di mana semua sel dari baris terakhir digabungkan. Tabelnya akan terlihat seperti ini:
[ ][ ][ ]
[ ][ ][ ]
[ ]
Rentang tabel dengan lokasi sel tabel = (tableStartLocation, baris = 0, kolom = 0), span baris = 3 dan span kolom = 2 menentukan sel-sel berikut:
[ x ][ x ][ ]
[ x ][ x ][ ]
[ x x x ]
Representasi JSON |
---|
{
"tableCellLocation": {
object (
|
Kolom | |
---|---|
tableCellLocation
|
Lokasi sel tempat rentang tabel dimulai. |
rowSpan
|
Rentang baris pada rentang tabel. |
columnSpan
|
Rentang kolom untuk rentang tabel. |
UpdateTableRowStyleRequest
Memperbarui
TableRowStyle
baris dalam tabel.
Representasi JSON |
---|
{ "tableStartLocation": { object ( |
Kolom | |
---|---|
tableStartLocation
|
Lokasi tempat tabel dimulai dalam dokumen. |
rowIndices[]
|
Daftar indeks baris berbasis nol yang gayanya harus diperbarui. Jika tidak ada indeks yang ditentukan, semua baris akan diperbarui. |
tableRowStyle
|
Gaya yang akan ditetapkan pada baris. |
fields
|
Kolom yang harus diperbarui.
Setidaknya satu kolom harus ditentukan. Akar
Misalnya untuk memperbarui tinggi baris minimum, setel
|
ReplaceImageRequest
Mengganti gambar yang ada dengan gambar baru.
Mengganti gambar akan menghapus beberapa
image effects
dari gambar yang ada untuk mencerminkan perilaku editor Dokumen.
Representasi JSON |
---|
{
"imageObjectId": string,
"uri": string,
"imageReplaceMethod": enum (
|
Kolom | |
---|---|
imageObjectId
|
ID gambar yang ada yang akan diganti. ID ini dapat diambil dari respons permintaan get. |
uri
|
URI gambar baru. Gambar diambil satu kali pada waktu penyisipan dan salinannya disimpan untuk ditampilkan di dalam dokumen. Gambar harus berukuran kurang dari 50 MB, tidak boleh lebih dari 25 megapiksel, dan harus dalam format PNG, JPEG, atau GIF.
URI yang diberikan tidak boleh melebihi 2 KB. URI disimpan bersama gambar, dan diekspos melalui
|
imageReplaceMethod
|
Metode penggantian. |
tabId
|
Tab tempat gambar yang akan diganti berada. Jika dihilangkan, permintaan akan diterapkan ke tab pertama. Dalam dokumen yang berisi satu tab:
Dalam dokumen yang berisi beberapa tab:
|
ImageReplaceMethod
Metode penggantian gambar.
Enum | |
---|---|
IMAGE_REPLACE_METHOD_UNSPECIFIED
|
Metode penggantian gambar tidak ditentukan. Nilai ini tidak boleh digunakan. |
CENTER_CROP
|
Menskalakan dan menempatkan gambar di tengah untuk mengisi batas-batas gambar asli. Gambar mungkin akan dipangkas agar dapat mengisi batas gambar asli. Ukuran gambar yang dirender akan sama dengan gambar asli. |
UpdateDocumentStyleRequest
Memperbarui
DocumentStyle
.
Representasi JSON |
---|
{
"documentStyle": {
object (
|
Kolom | |
---|---|
documentStyle
|
Gaya yang akan ditetapkan pada dokumen.
Perubahan gaya dokumen tertentu dapat menyebabkan perubahan lain guna mencerminkan perilaku editor Dokumen. Lihat dokumentasi tentang
|
fields
|
Kolom yang harus diperbarui.
Setidaknya satu kolom harus ditentukan. Akar
Misalnya, untuk memperbarui latar belakang, setel
|
tabId
|
Tab yang berisi gaya yang akan diperbarui. Jika dihilangkan, permintaan berlaku untuk tab pertama. Dalam dokumen yang berisi satu tab:
Dalam dokumen yang berisi beberapa tab:
|
MergeTableCellsRequest
Menggabungkan sel
Table
.
Representasi JSON |
---|
{
"tableRange": {
object (
|
Kolom | |
---|---|
tableRange
|
Rentang tabel yang menentukan sel tabel yang akan digabungkan. Semua teks dalam sel yang digabungkan akan digabungkan dan disimpan dalam "head" sel rentang tersebut. Elemen ini adalah sel kiri atas rentang jika arah konten dari kiri ke kanan, dan sel kanan atas rentang jika sebaliknya. Jika rentangnya bukan persegi panjang (yang dapat terjadi dalam beberapa kasus di mana rentang mencakup sel yang sudah digabungkan atau jika tabel bukan persegi panjang), pesan error permintaan buruk 400 akan ditampilkan. |
UnmergeTableCellsRequest
Memisahkan sel dalam
Table
.
Representasi JSON |
---|
{
"tableRange": {
object (
|
Kolom | |
---|---|
tableRange
|
Rentang tabel yang menentukan sel tabel yang akan dipisahkan. Semua sel gabungan dalam rentang ini akan dipisahkan, dan sel yang sudah dipisahkan tidak akan terpengaruh. Jika rentang tidak memiliki sel yang digabungkan, permintaan tidak akan melakukan apa pun. Jika terdapat teks di salah satu sel yang digabungkan, teks akan tetap berada di "head" dari blok sel yang terpisah yang dihasilkan. "Kepala" sel merupakan sel kiri atas jika arah konten dari kiri ke kanan, dan kanan atas jika sebaliknya. |
CreateHeaderRequest
Membuat
Header
. {i>Header<i} baru diterapkan ke
SectionStyle
di lokasi
SectionBreak
jika ditentukan. Jika tidak, maka akan diterapkan ke
DocumentStyle
.
Jika header jenis yang ditentukan sudah ada, pesan error 400 bad request akan ditampilkan.
Representasi JSON |
---|
{ "type": enum ( |
Kolom | |
---|---|
type
|
Jenis header yang akan dibuat. |
sectionBreakLocation
|
Lokasi
|
CreateFootnoteRequest
Membuat
Footnote
membuat segmen dan menyisipkan
FootnoteReference
ke lokasi tersebut di lokasi yang diberikan.
Yang baru
Footnote
segmen berisi spasi diikuti dengan sebuah karakter baris baru.
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union
footnote_reference_location . Lokasi untuk menyisipkan referensi catatan kaki.
footnote_reference_location
hanya dapat berupa salah satu dari hal berikut:
|
|
location
|
Menyisipkan referensi catatan kaki pada indeks tertentu dalam dokumen.
Referensi catatan kaki harus dimasukkan di dalam batas-batas yang ada
Referensi catatan kaki tidak dapat disisipkan di dalam persamaan, header, footer, atau catatan kaki. Karena referensi catatan kaki hanya
dapat dimasukkan ke dalam isi, maka
|
endOfSegmentLocation
|
Menyisipkan referensi catatan kaki di akhir isi dokumen.
Referensi catatan kaki tidak dapat disisipkan di dalam header, footer, atau catatan kaki. Karena referensi catatan kaki hanya
dapat dimasukkan ke dalam isi, maka
|
ReplaceNamedRangeContentRequest
Mengganti konten yang ditentukan
NamedRange
atau
NamedRanges
dengan konten pengganti yang diberikan.
Perhatikan bahwa individu
NamedRange
dapat terdiri dari beberapa jaringan
ranges
. Dalam hal ini, hanya konten dalam rentang pertama yang akan diganti. Rentang lainnya beserta kontennya akan dihapus.
Jika mengganti atau menghapus rentang akan menyebabkan struktur dokumen yang tidak valid, error permintaan buruk 400 akan ditampilkan.
Representasi JSON |
---|
{ "tabsCriteria": { object ( |
Kolom | |
---|---|
tabsCriteria
|
Opsional. Kriteria yang digunakan untuk menentukan di tab mana penggantian terjadi. Jika dihilangkan, penggantian berlaku untuk semua tab. Dalam dokumen yang berisi satu tab:
Dalam dokumen yang berisi beberapa tab:
|
Kolom union
replacement_content . Konten untuk mengganti konten yang ada dari rentang bernama.
replacement_content
hanya dapat berupa salah satu dari hal berikut:
|
|
text
|
Mengganti konten rentang bernama yang ditentukan dengan teks yang ditentukan. |
Kolom union
named_range_reference . Referensi ke rentang bernama yang kontennya akan diganti.
named_range_reference
hanya dapat berupa salah satu dari hal berikut:
|
|
namedRangeId
|
ID rentang bernama yang kontennya akan diganti. Jika tidak ada rentang bernama dengan ID yang diberikan, pesan error 400 bad request akan muncul. |
namedRangeName
|
Nama
Jika ada beberapa
|
UpdateSectionStyleRequest
Memperbarui
SectionStyle
.
Representasi JSON |
---|
{ "range": { object ( |
Kolom | |
---|---|
range
|
Rentang tumpang-tindih dengan bagian yang akan ditata gayanya.
Karena batas bagian hanya bisa disisipkan ke dalam isi,
|
sectionStyle
|
Gaya yang akan ditetapkan pada bagian tersebut.
Perubahan gaya bagian tertentu dapat menyebabkan perubahan lain guna mencerminkan perilaku editor Dokumen. Lihat dokumentasi tentang
|
fields
|
Kolom yang harus diperbarui.
Setidaknya satu kolom harus ditentukan. Akar
Misalnya untuk memperbarui margin kiri, atur
|
InsertSectionBreakRequest
Menyisipkan batas bagian di lokasi yang ditentukan.
Karakter baris baru akan disisipkan sebelum batas bagian.
Representasi JSON |
---|
{ "sectionType": enum ( |
Kolom | |
---|---|
sectionType
|
Jenis bagian yang akan disisipkan. |
Kolom union
insertion_location . Lokasi tempat jeda akan disisipkan.
insertion_location
hanya dapat berupa salah satu dari hal berikut:
|
|
location
|
Menyisipkan baris baru dan batas bagian pada indeks tertentu dalam dokumen.
Batas bagian harus disisipkan ke dalam batas-batas yang ada
Batas bagian tidak dapat disisipkan di dalam tabel, persamaan, catatan kaki, header, atau footer. Karena batas bagian hanya bisa dimasukkan ke dalam isi,
|
endOfSegmentLocation
|
Menyisipkan baris baru dan batas bagian di akhir isi dokumen.
Batas bagian tidak dapat disisipkan di dalam catatan kaki, header, atau footer. Karena batas bagian hanya bisa disisipkan ke dalam isi,
|
DeleteHeaderRequest
Menghapus
Header
dari dokumen.
Representasi JSON |
---|
{ "headerId": string, "tabId": string } |
Kolom | |
---|---|
headerId
|
ID header yang akan dihapus. Jika {i>header<i} ini
ditentukan pada
|
tabId
|
Tab yang berisi header yang akan dihapus. Jika dihilangkan, permintaan akan diterapkan ke tab pertama. Dalam dokumen yang berisi satu tab:
Dalam dokumen yang berisi beberapa tab:
|
PinTableHeaderRowsRequest
Memperbarui jumlah baris header tabel yang disematkan dalam tabel.
Representasi JSON |
---|
{
"tableStartLocation": {
object (
|
Kolom | |
---|---|
tableStartLocation
|
Lokasi tempat tabel dimulai dalam dokumen. |
pinnedHeaderRowsCount
|
Jumlah baris tabel yang akan disematkan, dengan 0 menyiratkan bahwa semua baris dilepas sematannya. |